Moodle PHP Documentation 4.3
Moodle 4.3.5 (Build: 20240610) (7dcfaa79f78)
Google_Service_CloudMonitoring_MetricDescriptors_Resource Class Reference

The "metricDescriptors" collection of methods. More...

Inheritance diagram for Google_Service_CloudMonitoring_MetricDescriptors_Resource:
Google_Service_Resource

Public Member Functions

 call ($name, $arguments, $expected_class=null)
 TODO: This function needs simplifying.
 
 create ($project, Google_Service_CloudMonitoring_MetricDescriptor $postBody, $optParams=array())
 Create a new metric.
 
 delete ($project, $metric, $optParams=array())
 Delete an existing metric.
 
 listMetricDescriptors ($project, $optParams=array())
 List metric descriptors that match the query.
 

Protected Member Functions

 convertToArrayAndStripNulls ($o)
 

Detailed Description

The "metricDescriptors" collection of methods.

Typical usage is: $cloudmonitoringService = new Google_Service_CloudMonitoring(...); $metricDescriptors = $cloudmonitoringService->metricDescriptors;

Member Function Documentation

◆ call()

Google_Service_Resource::call ( $name,
$arguments,
$expected_class = null )
inherited

TODO: This function needs simplifying.

Parameters
$name
$arguments
$expected_class- optional, the expected class name
Return values
Google_Http_Request|expected_class
Exceptions
Google_Exception

◆ create()

Google_Service_CloudMonitoring_MetricDescriptors_Resource::create ( $project,
Google_Service_CloudMonitoring_MetricDescriptor $postBody,
$optParams = array() )

Create a new metric.

(metricDescriptors.create)

Parameters
string$projectThe project id. The value can be the numeric project ID or string-based project name.
Google_MetricDescriptor$postBody
array$optParamsOptional parameters.
Return values
Google_Service_CloudMonitoring_MetricDescriptor

◆ delete()

Google_Service_CloudMonitoring_MetricDescriptors_Resource::delete ( $project,
$metric,
$optParams = array() )

Delete an existing metric.

(metricDescriptors.delete)

Parameters
string$projectThe project ID to which the metric belongs.
string$metricName of the metric.
array$optParamsOptional parameters.
Return values
Google_Service_CloudMonitoring_DeleteMetricDescriptorResponse

◆ listMetricDescriptors()

Google_Service_CloudMonitoring_MetricDescriptors_Resource::listMetricDescriptors ( $project,
$optParams = array() )

List metric descriptors that match the query.

If the query is not set, then all of the metric descriptors will be returned. Large responses will be paginated, use the nextPageToken returned in the response to request subsequent pages of results by setting the pageToken query parameter to the value of the nextPageToken. (metricDescriptors.listMetricDescriptors)

Parameters
string$projectThe project id. The value can be the numeric project ID or string-based project name.
array$optParamsOptional parameters.

@opt_param int count Maximum number of metric descriptors per page. Used for pagination. If not specified, count = 100. @opt_param string pageToken The pagination token, which is used to page through large result sets. Set this value to the value of the nextPageToken to retrieve the next page of results. @opt_param string query The query used to search against existing metrics. Separate keywords with a space; the service joins all keywords with AND, meaning that all keywords must match for a metric to be returned. If this field is omitted, all metrics are returned. If an empty string is passed with this field, no metrics are returned.

Return values
Google_Service_CloudMonitoring_ListMetricDescriptorsResponse

The documentation for this class was generated from the following file: