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

Inherits:

Object

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

Extended by:

Protobuf::MessageExts::ClassMethods

Includes:

Protobuf::MessageExts

Defined in:

proto_docs/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

  Required.

• #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 'proto_docs/google/monitoring/v3/metric_service.rb', line 106

class ListMetricDescriptorsRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#name ⇒ ::String

Returns 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]
  

# File 'proto_docs/google/monitoring/v3/metric_service.rb', line 106

class ListMetricDescriptorsRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
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 'proto_docs/google/monitoring/v3/metric_service.rb', line 106

class ListMetricDescriptorsRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
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 'proto_docs/google/monitoring/v3/metric_service.rb', line 106

class ListMetricDescriptorsRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end