Interface ListServicesRequestOrBuilder (3.44.0) 

public interface ListServicesRequestOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getFilter()

public abstract String getFilter()

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

string filter = 2;

Returns
Type Description
String

The filter.

getFilterBytes()

public abstract ByteString getFilterBytes()

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

string filter = 2;

Returns
Type Description
ByteString

The bytes for filter.

getPageSize()

public abstract int getPageSize()

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

int32 page_size = 3;

Returns
Type Description
int

The pageSize.

getPageToken()

public abstract String getPageToken()

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.

string page_token = 4;

Returns
Type Description
String

The pageToken.

getPageTokenBytes()

public abstract ByteString getPageTokenBytes()

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.

string page_token = 4;

Returns
Type Description
ByteString

The bytes for pageToken.

getParent()

public abstract String getParent()

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]

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
String

The parent.

getParentBytes()

public abstract ByteString getParentBytes()

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]

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for parent.