Stackdriver Monitoring V3 Client - Class ListMetricDescriptorsRequest (1.7.0)

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

The ListMetricDescriptors request.

Generated from protobuf message google.monitoring.v3.ListMetricDescriptorsRequest

Namespace

Google \ Cloud \ Monitoring \ V3

Methods

__construct

Constructor.

Parameters
NameDescription
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]

Returns
TypeDescription
string

setName

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

Parameter
NameDescription
var string
Returns
TypeDescription
$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/")

Returns
TypeDescription
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/")

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getPageSize

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

Returns
TypeDescription
int

setPageSize

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

Parameter
NameDescription
var int
Returns
TypeDescription
$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.

Returns
TypeDescription
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.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

static::build

Parameter
NameDescription
name string

Required. The project on which to execute the request. The format is:

projects/[PROJECT_ID_OR_NUMBER]

Returns
TypeDescription
Google\Cloud\Monitoring\V3\ListMetricDescriptorsRequest