Documentation

Google_Service_CloudMonitoring_Resource_MetricDescriptors extends Google_Service_Resource
in package

The "metricDescriptors" collection of methods.

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

Table of Contents

$client  : Google_Client
$methods  : array<string|int, mixed>
$resourceName  : string
$rootUrl  : string
$serviceName  : string
$servicePath  : string
$stackParameters  : mixed
__construct()  : mixed
call()  : Google_Http_Request|expectedClass
TODO: This function needs simplifying.
create()  : Google_Service_CloudMonitoring_MetricDescriptor
Create a new metric. (metricDescriptors.create)
createRequestUri()  : string
Parse/expand request parameters and create a fully qualified request uri.
delete()  : Google_Service_CloudMonitoring_DeleteMetricDescriptorResponse
Delete an existing metric. (metricDescriptors.delete)
listMetricDescriptors()  : Google_Service_CloudMonitoring_ListMetricDescriptorsResponse
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)
convertToArrayAndStripNulls()  : mixed

Properties

$methods

private array<string|int, mixed> $methods

$resourceName

private string $resourceName

$serviceName

private string $serviceName

$servicePath

private string $servicePath

$stackParameters

private mixed $stackParameters = array('alt' => array('type' => 'string', 'location' => 'query'), 'fields' => array('type' => 'string', 'location' => 'query'), 'trace' => array('type' => 'string', 'location' => 'query'), 'userIp' => array('type' => 'string', 'location' => 'query'), 'quotaUser' => array('type' => 'string', 'location' => 'query'), 'data' => array('type' => 'string', 'location' => 'body'), 'mimeType' => array('type' => 'string', 'location' => 'header'), 'uploadType' => array('type' => 'string', 'location' => 'query'), 'mediaUpload' => array('type' => 'complex', 'location' => 'query'), 'prettyPrint' => array('type' => 'string', 'location' => 'query'))

Methods

__construct()

public __construct(mixed $service, mixed $serviceName, mixed $resourceName, mixed $resource) : mixed
Parameters
$service : mixed
$serviceName : mixed
$resourceName : mixed
$resource : mixed
Return values
mixed —

call()

TODO: This function needs simplifying.

public call( $name,  $arguments[,  $expectedClass = null ]) : Google_Http_Request|expectedClass
Parameters
$name :
$arguments :
$expectedClass : = null
  • optional, the expected class name
Tags
throws
Google_Exception
Return values
Google_Http_Request|expectedClass —

create()

Create a new metric. (metricDescriptors.create)

public create(string $project, Google_Service_CloudMonitoring_MetricDescriptor $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_CloudMonitoring_MetricDescriptor
Parameters
$project : string

The project id. The value can be the numeric project ID or string-based project name.

$postBody : Google_Service_CloudMonitoring_MetricDescriptor
$optParams : array<string|int, mixed> = array()

Optional parameters.

Return values
Google_Service_CloudMonitoring_MetricDescriptor —

createRequestUri()

Parse/expand request parameters and create a fully qualified request uri.

public createRequestUri(string $restPath, array<string|int, mixed> $params) : string
Parameters
$restPath : string
$params : array<string|int, mixed>
Tags
static
Return values
string —

$requestUrl

delete()

Delete an existing metric. (metricDescriptors.delete)

public delete(string $project, string $metric[, array<string|int, mixed> $optParams = array() ]) : Google_Service_CloudMonitoring_DeleteMetricDescriptorResponse
Parameters
$project : string

The project ID to which the metric belongs.

$metric : string

Name of the metric.

$optParams : array<string|int, mixed> = array()

Optional parameters.

Return values
Google_Service_CloudMonitoring_DeleteMetricDescriptorResponse —

listMetricDescriptors()

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)

public listMetricDescriptors(string $project[, array<string|int, mixed> $optParams = array() ]) : Google_Service_CloudMonitoring_ListMetricDescriptorsResponse
Parameters
$project : string

The project id. The value can be the numeric project ID or string-based project name.

$optParams : array<string|int, mixed> = array()

Optional parameters.

Tags
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 —

convertToArrayAndStripNulls()

protected convertToArrayAndStripNulls(mixed $o) : mixed
Parameters
$o : mixed
Return values
mixed —

Search results