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

Inherits:
Object
  • Object
show all
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 collapse

Instance Attribute Details

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

Returns:

  • (::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/")



111
112
113
114
 
# File 'proto_docs/google/monitoring/v3/metric_service.rb', line 111

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]



111
112
113
114
 
# File 'proto_docs/google/monitoring/v3/metric_service.rb', line 111

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

#page_size ⇒ ::Integer

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.

Returns:

  • (::Integer) —

    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.



111
112
113
114
 
# File 'proto_docs/google/monitoring/v3/metric_service.rb', line 111

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

#page_token ⇒ ::String

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

Returns:

  • (::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.



111
112
113
114
 
# File 'proto_docs/google/monitoring/v3/metric_service.rb', line 111

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