Class ListServicesRequest.Builder (2.29.0)

Version 2.29.0

• 2.54.0 (latest)
• 2.53.0
• 2.52.0
• 2.50.0
• 2.49.0
• 2.48.0
• 2.47.0
• 2.46.0
• 2.45.0
• 2.44.0
• 2.43.0
• 2.42.0
• 2.41.0
• 2.40.0
• 2.38.0
• 2.37.0
• 2.36.0
• 2.35.0
• 2.34.0
• 2.33.0
• 2.32.0
• 2.31.0
• 2.30.0
• 2.29.0
• 2.28.0
• 2.25.0
• 2.24.0
• 2.23.0
• 2.22.0
• 2.21.0
• 2.20.0
• 2.19.0
• 2.18.0
• 2.17.0
• 2.16.0
• 2.15.0
• 2.14.0
• 2.13.0
• 2.12.0
• 2.10.0
• 2.9.0
• 2.8.0
• 2.7.0
• 2.6.0
• 2.5.0
• 2.4.5
• 2.2.7

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

The request message for RegistrationService.ListServices.

Protobuf type google.cloud.servicedirectory.v1beta1.ListServicesRequest

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > ListServicesRequest.Builder

Implements

ListServicesRequestOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessageV3.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.clear()

GeneratedMessageV3.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.clone()

GeneratedMessageV3.Builder.getAllFields()

GeneratedMessageV3.Builder.getDescriptorForType()

GeneratedMessageV3.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.getParentForChildren()

GeneratedMessageV3.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()

GeneratedMessageV3.Builder.getUnknownFields()

GeneratedMessageV3.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.internalGetFieldAccessorTable()

GeneratedMessageV3.Builder.internalGetMapField(int)

GeneratedMessageV3.Builder.internalGetMutableMapField(int)

GeneratedMessageV3.Builder.isClean()

GeneratedMessageV3.Builder.isInitialized()

GeneratedMessageV3.Builder.markClean()

GeneratedMessageV3.Builder.mergeUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)

GeneratedMessageV3.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.onBuilt()

GeneratedMessageV3.Builder.onChanged()

com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessageV3.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)

GeneratedMessageV3.Builder.setUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.setUnknownFieldsProto3(UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

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

GeneratedMessageV3.Builder<BuilderType>.addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

GeneratedMessageV3.Builder<BuilderType>.clear()

clearField(Descriptors.FieldDescriptor field)

public ListServicesRequest.Builder clearField(Descriptors.FieldDescriptor field)

Parameter
Name	Description
field	FieldDescriptor

Returns
Type	Description
ListServicesRequest.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearField(Descriptors.FieldDescriptor field)

clearFilter()

public ListServicesRequest.Builder clearFilter()

Optional. The filter to list results by.

General filter string syntax: <field> <operator> <value> (<logical connector>)

• <field> can be name or metadata.<key> for map field
• <operator> can be <, >, <=, >=, !=, =, :. Of which : means HAS, and is roughly the same as =
• <value> must be the same data type as field

• <logical connector> can be AND, OR, NOT

  Examples of valid filters:

• metadata.owner returns services that have a metadata with the key owner, this is the same as metadata:owner

• metadata.protocol=gRPC returns services that have key/value protocol=gRPC * name>projects/my-project/locations/us-east1/namespaces/my-namespace/services/service-c returns services that have name that is alphabetically later than the string, so "service-e" is returned but "service-a" is not
• metadata.owner!=sd AND metadata.foo=bar returns services that have owner in metadata key but value is not sd AND have key/value foo=bar
• doesnotexist.foo=bar returns an empty list. Note that service doesn't have a field called "doesnotexist". Since the filter does not match any services, it returns no results

• attributes.managed_registration=true returns services that are managed by a GCP product or service

  For more information about filtering, see API Filtering.

string filter = 4 [(.google.api.field_behavior) = OPTIONAL];

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

GeneratedMessageV3.Builder<BuilderType>.clearOneof(Descriptors.OneofDescriptor oneof)

clearOrderBy()

public ListServicesRequest.Builder clearOrderBy()

Optional. The order to list results by.

General order_by string syntax: <field> (<asc|desc>) (,)

• <field> allows value: name

• <asc|desc> ascending or descending order by <field>. If this is left blank, asc is used

  Note that an empty order_by string results in default order, which is order by name in ascending order.

string order_by = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
ListServicesRequest.Builder	This builder for chaining.

clearPageSize()

public ListServicesRequest.Builder clearPageSize()

Optional. The maximum number of items to return.

int32 page_size = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
ListServicesRequest.Builder	This builder for chaining.

clearPageToken()

public ListServicesRequest.Builder clearPageToken()

Optional. The next_page_token value returned from a previous List request, if any.

string page_token = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
ListServicesRequest.Builder	This builder for chaining.

clearParent()

public ListServicesRequest.Builder clearParent()

Required. The resource name of the namespace whose services you'd like to list.

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

GeneratedMessageV3.Builder<BuilderType>.clone()

getDefaultInstanceForType()

public ListServicesRequest getDefaultInstanceForType()

Returns
Type	Description
ListServicesRequest

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns
Type	Description
Descriptor

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

getFilter()

public String getFilter()

Optional. The filter to list results by.

General filter string syntax: <field> <operator> <value> (<logical connector>)

• <field> can be name or metadata.<key> for map field
• <operator> can be <, >, <=, >=, !=, =, :. Of which : means HAS, and is roughly the same as =
• <value> must be the same data type as field

• <logical connector> can be AND, OR, NOT

  Examples of valid filters:

• metadata.owner returns services that have a metadata with the key owner, this is the same as metadata:owner

• metadata.protocol=gRPC returns services that have key/value protocol=gRPC * name>projects/my-project/locations/us-east1/namespaces/my-namespace/services/service-c returns services that have name that is alphabetically later than the string, so "service-e" is returned but "service-a" is not
• metadata.owner!=sd AND metadata.foo=bar returns services that have owner in metadata key but value is not sd AND have key/value foo=bar
• doesnotexist.foo=bar returns an empty list. Note that service doesn't have a field called "doesnotexist". Since the filter does not match any services, it returns no results

• attributes.managed_registration=true returns services that are managed by a GCP product or service

  For more information about filtering, see API Filtering.

string filter = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
String	The filter.

getFilterBytes()

public ByteString getFilterBytes()

Optional. The filter to list results by.

General filter string syntax: <field> <operator> <value> (<logical connector>)

• <field> can be name or metadata.<key> for map field
• <operator> can be <, >, <=, >=, !=, =, :. Of which : means HAS, and is roughly the same as =
• <value> must be the same data type as field

• <logical connector> can be AND, OR, NOT

  Examples of valid filters:

• metadata.owner returns services that have a metadata with the key owner, this is the same as metadata:owner

• metadata.protocol=gRPC returns services that have key/value protocol=gRPC * name>projects/my-project/locations/us-east1/namespaces/my-namespace/services/service-c returns services that have name that is alphabetically later than the string, so "service-e" is returned but "service-a" is not
• metadata.owner!=sd AND metadata.foo=bar returns services that have owner in metadata key but value is not sd AND have key/value foo=bar
• doesnotexist.foo=bar returns an empty list. Note that service doesn't have a field called "doesnotexist". Since the filter does not match any services, it returns no results

• attributes.managed_registration=true returns services that are managed by a GCP product or service

  For more information about filtering, see API Filtering.

string filter = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
ByteString	The bytes for filter.

getOrderBy()

public String getOrderBy()

Optional. The order to list results by.

General order_by string syntax: <field> (<asc|desc>) (,)

• <field> allows value: name

• <asc|desc> ascending or descending order by <field>. If this is left blank, asc is used

  Note that an empty order_by string results in default order, which is order by name in ascending order.

string order_by = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
String	The orderBy.

getOrderByBytes()

public ByteString getOrderByBytes()

Optional. The order to list results by.

General order_by string syntax: <field> (<asc|desc>) (,)

• <field> allows value: name

• <asc|desc> ascending or descending order by <field>. If this is left blank, asc is used

  Note that an empty order_by string results in default order, which is order by name in ascending order.

string order_by = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
ByteString	The bytes for orderBy.

getPageSize()

public int getPageSize()

Optional. The maximum number of items to return.

int32 page_size = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
int	The pageSize.

getPageToken()

public String getPageToken()

Optional. The next_page_token value returned from a previous List request, if any.

string page_token = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
String	The pageToken.

getPageTokenBytes()

public ByteString getPageTokenBytes()

Optional. The next_page_token value returned from a previous List request, if any.

string page_token = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
ByteString	The bytes for pageToken.

getParent()

public String getParent()

Required. The resource name of the namespace whose services you'd like to list.

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

Returns
Type	Description
String	The parent.

getParentBytes()

public ByteString getParentBytes()

Required. The resource name of the namespace whose services you'd like to list.

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

GeneratedMessageV3.Builder<BuilderType>.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessageV3.Builder<BuilderType>.isInitialized()

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

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Exceptions
Type	Description
IOException

mergeFrom(Message other)

public ListServicesRequest.Builder mergeFrom(Message other)

Parameter
Name	Description
other	Message

Returns
Type	Description
ListServicesRequest.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

mergeUnknownFields(UnknownFieldSet unknownFields)

public final ListServicesRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
unknownFields	UnknownFieldSet

Returns
Type	Description
ListServicesRequest.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.mergeUnknownFields(UnknownFieldSet unknownFields)

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

GeneratedMessageV3.Builder<BuilderType>.setField(Descriptors.FieldDescriptor field, Object value)

setFilter(String value)

public ListServicesRequest.Builder setFilter(String value)

Optional. The filter to list results by.

General filter string syntax: <field> <operator> <value> (<logical connector>)

• <field> can be name or metadata.<key> for map field
• <operator> can be <, >, <=, >=, !=, =, :. Of which : means HAS, and is roughly the same as =
• <value> must be the same data type as field

• <logical connector> can be AND, OR, NOT

  Examples of valid filters:

• metadata.owner returns services that have a metadata with the key owner, this is the same as metadata:owner

• metadata.protocol=gRPC returns services that have key/value protocol=gRPC * name>projects/my-project/locations/us-east1/namespaces/my-namespace/services/service-c returns services that have name that is alphabetically later than the string, so "service-e" is returned but "service-a" is not
• metadata.owner!=sd AND metadata.foo=bar returns services that have owner in metadata key but value is not sd AND have key/value foo=bar
• doesnotexist.foo=bar returns an empty list. Note that service doesn't have a field called "doesnotexist". Since the filter does not match any services, it returns no results

• attributes.managed_registration=true returns services that are managed by a GCP product or service

  For more information about filtering, see API Filtering.

string filter = 4 [(.google.api.field_behavior) = OPTIONAL];

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)

Optional. The filter to list results by.

General filter string syntax: <field> <operator> <value> (<logical connector>)

• <field> can be name or metadata.<key> for map field
• <operator> can be <, >, <=, >=, !=, =, :. Of which : means HAS, and is roughly the same as =
• <value> must be the same data type as field

• <logical connector> can be AND, OR, NOT

  Examples of valid filters:

• metadata.owner returns services that have a metadata with the key owner, this is the same as metadata:owner

• metadata.protocol=gRPC returns services that have key/value protocol=gRPC * name>projects/my-project/locations/us-east1/namespaces/my-namespace/services/service-c returns services that have name that is alphabetically later than the string, so "service-e" is returned but "service-a" is not
• metadata.owner!=sd AND metadata.foo=bar returns services that have owner in metadata key but value is not sd AND have key/value foo=bar
• doesnotexist.foo=bar returns an empty list. Note that service doesn't have a field called "doesnotexist". Since the filter does not match any services, it returns no results

• attributes.managed_registration=true returns services that are managed by a GCP product or service

  For more information about filtering, see API Filtering.

string filter = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
value	ByteString The bytes for filter to set.

Returns
Type	Description
ListServicesRequest.Builder	This builder for chaining.

setOrderBy(String value)

public ListServicesRequest.Builder setOrderBy(String value)

Optional. The order to list results by.

General order_by string syntax: <field> (<asc|desc>) (,)

• <field> allows value: name

• <asc|desc> ascending or descending order by <field>. If this is left blank, asc is used

  Note that an empty order_by string results in default order, which is order by name in ascending order.

string order_by = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
value	String The orderBy to set.

Returns
Type	Description
ListServicesRequest.Builder	This builder for chaining.

setOrderByBytes(ByteString value)

public ListServicesRequest.Builder setOrderByBytes(ByteString value)

Optional. The order to list results by.

General order_by string syntax: <field> (<asc|desc>) (,)

• <field> allows value: name

• <asc|desc> ascending or descending order by <field>. If this is left blank, asc is used

  Note that an empty order_by string results in default order, which is order by name in ascending order.

string order_by = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
value	ByteString The bytes for orderBy to set.

Returns
Type	Description
ListServicesRequest.Builder	This builder for chaining.

setPageSize(int value)

public ListServicesRequest.Builder setPageSize(int value)

Optional. The maximum number of items to return.

int32 page_size = 2 [(.google.api.field_behavior) = OPTIONAL];

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)

Optional. The next_page_token value returned from a previous List request, if any.

string page_token = 3 [(.google.api.field_behavior) = OPTIONAL];

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)

Optional. The next_page_token value returned from a previous List request, if any.

string page_token = 3 [(.google.api.field_behavior) = OPTIONAL];

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. The resource name of the namespace whose services you'd like to list.

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. The resource name of the namespace whose services you'd like to list.

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

GeneratedMessageV3.Builder<BuilderType>.setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

setUnknownFields(UnknownFieldSet unknownFields)

public final ListServicesRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
unknownFields	UnknownFieldSet

Returns
Type	Description
ListServicesRequest.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setUnknownFields(UnknownFieldSet unknownFields)