Documentation

Google_Service_Monitoring_Resource_ProjectsMetricDescriptors extends Google_Service_Resource
in package

The "metricDescriptors" collection of methods.

Typical usage is: $monitoringService = new Google_Service_Monitoring(...); $metricDescriptors = $monitoringService->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_Monitoring_MetricDescriptor
Creates a new metric descriptor. User-created metric descriptors define custom metrics (https://cloud.google.com/monitoring/custom-metrics).
createRequestUri()  : string
Parse/expand request parameters and create a fully qualified request uri.
delete()  : Google_Service_Monitoring_MonitoringEmpty
Deletes a metric descriptor. Only user-created custom metrics (https://cloud.google.com/monitoring/custom-metrics) can be deleted.
get()  : Google_Service_Monitoring_MetricDescriptor
Gets a single metric descriptor. This method does not require a Workspace.
listProjectsMetricDescriptors()  : Google_Service_Monitoring_ListMetricDescriptorsResponse
Lists metric descriptors that match a filter. This method does not require a Workspace. (metricDescriptors.listProjectsMetricDescriptors)
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()

Creates a new metric descriptor. User-created metric descriptors define custom metrics (https://cloud.google.com/monitoring/custom-metrics).

public create(string $name, Google_Service_Monitoring_MetricDescriptor $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Monitoring_MetricDescriptor

(metricDescriptors.create)

Parameters
$name : string

Required. The project on which to execute the request. The format is: projects/[PROJECT_ID_OR_NUMBER]

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

Optional parameters.

Return values
Google_Service_Monitoring_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()

Deletes a metric descriptor. Only user-created custom metrics (https://cloud.google.com/monitoring/custom-metrics) can be deleted.

public delete(string $name[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Monitoring_MonitoringEmpty

(metricDescriptors.delete)

Parameters
$name : string

Required. The metric descriptor on which to execute the request. The format is: projects/[PROJECT_ID_OR_NUMBER]/metricDescriptors/[METRIC_ID] An example of [METRIC_ID] is: "custom.googleapis.com/my_test_metric".

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

Optional parameters.

Return values
Google_Service_Monitoring_MonitoringEmpty —

get()

Gets a single metric descriptor. This method does not require a Workspace.

public get(string $name[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Monitoring_MetricDescriptor

(metricDescriptors.get)

Parameters
$name : string

Required. The metric descriptor on which to execute the request. The format is: projects/[PROJECT_ID_OR_NUMBER]/metricDescriptors/[METRIC_ID] An example value of [METRIC_ID] is "compute.googleapis.com/instance/disk/read_bytes_count".

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

Optional parameters.

Return values
Google_Service_Monitoring_MetricDescriptor —

listProjectsMetricDescriptors()

Lists metric descriptors that match a filter. This method does not require a Workspace. (metricDescriptors.listProjectsMetricDescriptors)

public listProjectsMetricDescriptors(string $name[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Monitoring_ListMetricDescriptorsResponse
Parameters
$name : string

Required. The project on which to execute the request. The format is: projects/[PROJECT_ID_OR_NUMBER]

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

Optional parameters.

Tags
opt_param

string filter If this field is empty, all custom and system- defined metric descriptors are returned. Otherwise, the filter (https://cloud.google.com/monitoring/api/v3/filters) specifies which metric descriptors are to be returned. For example, the following filter matches all custom metrics (https://cloud.google.com/monitoring/custom-metrics): metric.type = starts_with("custom.googleapis.com/")

opt_param

int pageSize A positive number that is the maximum number of results to return.

opt_param

string pageToken If this field is not empty then it must contain the nextPageToken value returned by a previous call to this method. Using this field causes the method to return additional results from the previous method call.

Return values
Google_Service_Monitoring_ListMetricDescriptorsResponse —

convertToArrayAndStripNulls()

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

Search results