Stackdriver Monitoring V3 Client - Class ListMetricDescriptorsRequest (1.2.2)

Reference documentation and code samples for the Stackdriver Monitoring V3 Client class ListMetricDescriptorsRequest.

The ListMetricDescriptors request.

Generated from protobuf message google.monitoring.v3.ListMetricDescriptorsRequest

Methods

__construct

Constructor.

Parameters
Name
Description
data
array

Optional. Data for populating the Message object.

↳ name
string

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

↳ filter
string

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

↳ page_size
int

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

↳ page_token
string

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.

getName

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

Generated from protobuf field string name = 5 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {

Returns
Type
Description
string

setName

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

Generated from protobuf field string name = 5 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getFilter

If this field is empty, all custom and system-defined metric descriptors are returned.

Otherwise, the filter specifies which metric descriptors are to be returned. For example, the following filter matches all custom metrics : metric.type = starts_with("custom.googleapis.com/")

Generated from protobuf field string filter = 2;

Returns
Type
Description
string

setFilter

If this field is empty, all custom and system-defined metric descriptors are returned.

Otherwise, the filter specifies which metric descriptors are to be returned. For example, the following filter matches all custom metrics : metric.type = starts_with("custom.googleapis.com/")

Generated from protobuf field string filter = 2;

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getPageSize

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

Generated from protobuf field int32 page_size = 3;

Returns
Type
Description
int

setPageSize

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

Generated from protobuf field int32 page_size = 3;

Parameter
Name
Description
var
int
Returns
Type
Description
$this

getPageToken

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.

Generated from protobuf field string page_token = 4;

Returns
Type
Description
string

setPageToken

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.

Generated from protobuf field string page_token = 4;

Parameter
Name
Description
var
string
Returns
Type
Description
$this
Create a Mobile Website
View Site in Mobile | Classic
Share by: