Cloud Monitoring V3 API - Class Google::Cloud::Monitoring::V3::ListMetricDescriptorsRequest (v1.0.0)

Reference documentation and code samples for the Cloud Monitoring V3 API class Google::Cloud::Monitoring::V3::ListMetricDescriptorsRequest.

The ListMetricDescriptors request.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#filter

def filter() -> ::String
Returns
  • (::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/")

#filter=

def filter=(value) -> ::String
Parameter
  • value (::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/")
Returns
  • (::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/")

#name

def name() -> ::String
Returns
  • (::String) —

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

    projects/[PROJECT_ID_OR_NUMBER]

#name=

def name=(value) -> ::String
Parameter
  • value (::String) —

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

    projects/[PROJECT_ID_OR_NUMBER]
Returns
  • (::String) —

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

    projects/[PROJECT_ID_OR_NUMBER]

#page_size

def page_size() -> ::Integer
Returns
  • (::Integer) — 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_size=

def page_size=(value) -> ::Integer
Parameter
  • value (::Integer) — 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
  • (::Integer) — 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

def page_token() -> ::String
Returns
  • (::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.

#page_token=

def page_token=(value) -> ::String
Parameter
  • value (::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.
Returns
  • (::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.