Class ListServicesRequest.Builder (3.46.0)

public static final class ListServicesRequest.Builder extends GeneratedMessageV3.Builder<ListServicesRequest.Builder> implements ListServicesRequestOrBuilder

The ListServices request.

Protobuf type google.monitoring.v3.ListServicesRequest

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public ListServicesRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
ListServicesRequest.Builder
Overrides

build()

public ListServicesRequest build()
Returns
Type Description
ListServicesRequest

buildPartial()

public ListServicesRequest buildPartial()
Returns
Type Description
ListServicesRequest

clear()

public ListServicesRequest.Builder clear()
Returns
Type Description
ListServicesRequest.Builder
Overrides

clearField(Descriptors.FieldDescriptor field)

public ListServicesRequest.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
ListServicesRequest.Builder
Overrides

clearFilter()

public ListServicesRequest.Builder clearFilter()

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

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public ListServicesRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
ListServicesRequest.Builder
Overrides

clearPageSize()

public ListServicesRequest.Builder clearPageSize()

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

This builder for chaining.

clearPageToken()

public ListServicesRequest.Builder clearPageToken()

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

This builder for chaining.

clearParent()

public ListServicesRequest.Builder clearParent()

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

This builder for chaining.

clone()

public ListServicesRequest.Builder clone()
Returns
Type Description
ListServicesRequest.Builder
Overrides

getDefaultInstanceForType()

public ListServicesRequest getDefaultInstanceForType()
Returns
Type Description
ListServicesRequest

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getFilter()

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

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(ListServicesRequest other)

public ListServicesRequest.Builder mergeFrom(ListServicesRequest other)
Parameter
Name Description
other ListServicesRequest
Returns
Type Description
ListServicesRequest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public ListServicesRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ListServicesRequest.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public ListServicesRequest.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
ListServicesRequest.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final ListServicesRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
ListServicesRequest.Builder
Overrides

setField(Descriptors.FieldDescriptor field, Object value)

public ListServicesRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
ListServicesRequest.Builder
Overrides

setFilter(String value)

public ListServicesRequest.Builder setFilter(String value)

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;

Parameter
Name Description
value String

The filter to set.

Returns
Type Description
ListServicesRequest.Builder

This builder for chaining.

setFilterBytes(ByteString value)

public ListServicesRequest.Builder setFilterBytes(ByteString value)

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;

Parameter
Name Description
value ByteString

The bytes for filter to set.

Returns
Type Description
ListServicesRequest.Builder

This builder for chaining.

setPageSize(int value)

public ListServicesRequest.Builder setPageSize(int value)

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

int32 page_size = 3;

Parameter
Name Description
value int

The pageSize to set.

Returns
Type Description
ListServicesRequest.Builder

This builder for chaining.

setPageToken(String value)

public ListServicesRequest.Builder setPageToken(String value)

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;

Parameter
Name Description
value String

The pageToken to set.

Returns
Type Description
ListServicesRequest.Builder

This builder for chaining.

setPageTokenBytes(ByteString value)

public ListServicesRequest.Builder setPageTokenBytes(ByteString value)

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;

Parameter
Name Description
value ByteString

The bytes for pageToken to set.

Returns
Type Description
ListServicesRequest.Builder

This builder for chaining.

setParent(String value)

public ListServicesRequest.Builder setParent(String value)

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) = { ... }

Parameter
Name Description
value String

The parent to set.

Returns
Type Description
ListServicesRequest.Builder

This builder for chaining.

setParentBytes(ByteString value)

public ListServicesRequest.Builder setParentBytes(ByteString value)

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) = { ... }

Parameter
Name Description
value ByteString

The bytes for parent to set.

Returns
Type Description
ListServicesRequest.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public ListServicesRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
ListServicesRequest.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final ListServicesRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
ListServicesRequest.Builder
Overrides