Cloud Monitoring V3 API - Class Google::Cloud::Monitoring::V3::ListServicesRequest (v0.17.0)

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

The ListServices request.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#filter

def filter() -> ::String
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

#filter=

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

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

#page_size

def page_size() -> ::Integer
Returns
  • (::Integer) — A non-negative number that is the maximum number of results to return. When 0, use default page size.

#page_size=

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

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

#parent

def parent() -> ::String
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]

#parent=

def parent=(value) -> ::String
Parameter
  • value (::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]
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]