class ListMetricDescriptorsRequest extends Message

The ListMetricDescriptors request.

Protobuf type Google\Monitoring\V3\ListMetricDescriptorsRequest

Methods

__construct()

No description

string
getName()

The project on which to execute the request. The format is "projects/{project_id_or_number}".

setName(string $var)

The project on which to execute the request. The format is "projects/{project_id_or_number}".

string
getFilter()

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

setFilter(string $var)

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

int
getPageSize()

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

setPageSize(int $var)

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

string
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.

setPageToken(string $var)

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.

Details

at line 52
__construct()

at line 64
string getName()

The project on which to execute the request. The format is "projects/{project_id_or_number}".

Generated from protobuf field string name = 5;

Return Value

string

at line 76
setName(string $var)

The project on which to execute the request. The format is "projects/{project_id_or_number}".

Generated from protobuf field string name = 5;

Parameters

string $var

at line 94
string 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;

Return Value

string

at line 111
setFilter(string $var)

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;

Parameters

string $var

at line 123
int getPageSize()

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

Generated from protobuf field int32 page_size = 3;

Return Value

int

at line 134
setPageSize(int $var)

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

Generated from protobuf field int32 page_size = 3;

Parameters

int $var

at line 148
string 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;

Return Value

string

at line 161
setPageToken(string $var)

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;

Parameters

string $var