Class: Google::Monitoring::V3::ListMetricDescriptorsRequest

Inherits:

Object

• Object
• Google::Monitoring::V3::ListMetricDescriptorsRequest

Defined in:

lib/google/cloud/monitoring/v3/doc/google/monitoring/v3/metric_service.rb

Overview

The +ListMetricDescriptors+ request.

Instance Attribute Summary

• #filter ⇒ String

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

• #name ⇒ String

  The project on which to execute the request.

• #page_size ⇒ Integer

  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.

Instance Attribute Details

#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/")

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

# File 'lib/google/cloud/monitoring/v3/doc/google/monitoring/v3/metric_service.rb', line 86

class ListMetricDescriptorsRequest; end

#name ⇒ String

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

Returns:

• (String) —

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

# File 'lib/google/cloud/monitoring/v3/doc/google/monitoring/v3/metric_service.rb', line 86

class ListMetricDescriptorsRequest; end

#page_size ⇒ Integer

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

Returns:

• (Integer) —

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

# File 'lib/google/cloud/monitoring/v3/doc/google/monitoring/v3/metric_service.rb', line 86

class ListMetricDescriptorsRequest; end

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

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.

# File 'lib/google/cloud/monitoring/v3/doc/google/monitoring/v3/metric_service.rb', line 86

class ListMetricDescriptorsRequest; end