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 \ V3Methods
__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. The default and maximum value is 10,000. If a page_size <= 0 or > 10,000 is submitted, will instead return a maximum of 10,000 results. |
↳ page_token |
string
If this field is not empty then it must contain the |
getName
Required. The project on which to execute the request. The format is: projects/[PROJECT_ID_OR_NUMBER]
| Returns | |
|---|---|
| Type | Description |
string |
|
setName
Required. The project on which to execute the request. The format is: projects/[PROJECT_ID_OR_NUMBER]
| 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/")
| 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/")
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getPageSize
A positive number that is the maximum number of results to return. The default and maximum value is 10,000. If a page_size <= 0 or > 10,000 is submitted, will instead return a maximum of 10,000 results.
| Returns | |
|---|---|
| Type | Description |
int |
|
setPageSize
A positive number that is the maximum number of results to return. The default and maximum value is 10,000. If a page_size <= 0 or > 10,000 is submitted, will instead return a maximum of 10,000 results.
| 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.
| 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.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
static::build
| Parameter | |
|---|---|
| Name | Description |
name |
string
Required. The project on which to execute the request. The format is: projects/[PROJECT_ID_OR_NUMBER] |
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Monitoring\V3\ListMetricDescriptorsRequest |
|