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.
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
Optional. 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
Optional. 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
Optional. 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.
↳ active_only
bool
Optional. If true, only metrics and monitored resource types that have recent data (within roughly 25 hours) will be included in the response. - If a metric descriptor enumerates monitored resource types, only the monitored resource types for which the metric type has recent data will be included in the returned metric descriptor, and if none of them have recent data, the metric descriptor will not be returned. - If a metric descriptor does not enumerate the compatible monitored resource types, it will be returned only if the metric type has recent data for some monitored resource type. The returned descriptor will not enumerate any monitored resource types.
getName
Required. The project on which to execute the request. The format is: projects/[PROJECT_ID_OR_NUMBER]
string
setName
Required. The project on which to execute the request. The format is: projects/[PROJECT_ID_OR_NUMBER]
var
string
$this
getFilter
Optional. 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/")
string
setFilter
Optional. 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/")
var
string
$this
getPageSize
Optional. 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.
int
setPageSize
Optional. 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.
var
int
$this
getPageToken
Optional. 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.
string
setPageToken
Optional. 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.
var
string
$this
getActiveOnly
Optional. If true, only metrics and monitored resource types that have recent data (within roughly 25 hours) will be included in the response.
- If a metric descriptor enumerates monitored resource types, only the
monitored resource types for which the metric type has recent data will
be included in the returned metric descriptor, and if none of them have
recent data, the metric descriptor will not be returned.
- If a metric descriptor does not enumerate the compatible monitored resource types, it will be returned only if the metric type has recent data for some monitored resource type. The returned descriptor will not enumerate any monitored resource types.
bool
setActiveOnly
Optional. If true, only metrics and monitored resource types that have recent data (within roughly 25 hours) will be included in the response.
- If a metric descriptor enumerates monitored resource types, only the
monitored resource types for which the metric type has recent data will
be included in the returned metric descriptor, and if none of them have
recent data, the metric descriptor will not be returned.
- If a metric descriptor does not enumerate the compatible monitored resource types, it will be returned only if the metric type has recent data for some monitored resource type. The returned descriptor will not enumerate any monitored resource types.
var
bool
$this
static::build
name
string
Required. The project on which to execute the request. The format is:
projects/[PROJECT_ID_OR_NUMBER]
