Class: Google::Cloud::Monitoring::V3::ListServicesRequest

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/monitoring/v3/service_service.rb

Overview

The ListServices request.

Instance Attribute Summary collapse

Instance Attribute Details

#filter ⇒ ::String

Returns A filter specifying what Services to return. The filter supports filtering on a particular service-identifier type or one of its attributes.

To filter on a particular service-identifier type, the identifier_case refers to which option in the identifier field is populated. For example, the filter identifier_case = "CUSTOM" would match all services with a value for the custom field. Valid options include "CUSTOM", "APP_ENGINE", "MESH_ISTIO", and the other options listed at https://cloud.google.com/monitoring/api/ref_v3/rest/v3/services#Service

To filter on an attribute of a service-identifier type, apply the filter name by using the snake case of the service-identifier type and the attribute of that service-identifier type, and join the two with a period. For example, to filter by the meshUid field of the MeshIstio service-identifier type, you must filter on mesh_istio.mesh_uid = "123" to match all services with mesh UID "123". Service-identifier types and their attributes are described at https://cloud.google.com/monitoring/api/ref_v3/rest/v3/services#Service.

Returns:

  • (::String) —

    A filter specifying what Services to return. The filter supports filtering on a particular service-identifier type or one of its attributes.

    To filter on a particular service-identifier type, the identifier_case refers to which option in the identifier field is populated. For example, the filter identifier_case = "CUSTOM" would match all services with a value for the custom field. Valid options include "CUSTOM", "APP_ENGINE", "MESH_ISTIO", and the other options listed at https://cloud.google.com/monitoring/api/ref_v3/rest/v3/services#Service

    To filter on an attribute of a service-identifier type, apply the filter name by using the snake case of the service-identifier type and the attribute of that service-identifier type, and join the two with a period. For example, to filter by the meshUid field of the MeshIstio service-identifier type, you must filter on mesh_istio.mesh_uid = "123" to match all services with mesh UID "123". Service-identifier types and their attributes are described at https://cloud.google.com/monitoring/api/ref_v3/rest/v3/services#Service



93
94
95
96
 
# File 'proto_docs/google/monitoring/v3/service_service.rb', line 93

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

#page_size ⇒ ::Integer

Returns A non-negative number that is the maximum number of results to return. When 0, use default page size.

Returns:

  • (::Integer) —

    A non-negative number that is the maximum number of results to return. When 0, use default page size.



93
94
95
96
 
# File 'proto_docs/google/monitoring/v3/service_service.rb', line 93

class ListServicesRequest
  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.



93
94
95
96
 
# File 'proto_docs/google/monitoring/v3/service_service.rb', line 93

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

#parent ⇒ ::String

Returns Required. Resource name of the parent containing the listed services, either a project or a Monitoring Metrics Scope. The formats are:

projects/[PROJECT_ID_OR_NUMBER]
workspaces/[HOST_PROJECT_ID_OR_NUMBER].

Returns:

  • (::String) —

    Required. Resource name of the parent containing the listed services, either a project or a Monitoring Metrics Scope. The formats are:

    projects/[PROJECT_ID_OR_NUMBER]
workspaces/[HOST_PROJECT_ID_OR_NUMBER]



93
94
95
96
 
# File 'proto_docs/google/monitoring/v3/service_service.rb', line 93

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