Class ListServicesRequest.Builder (2.5.0)

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

The request message for RegistrationService.ListServices.

Protobuf type google.cloud.servicedirectory.v1.ListServicesRequest

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public ListServicesRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
ListServicesRequest.Builder
Overrides

build()

public ListServicesRequest build()
Returns
TypeDescription
ListServicesRequest

buildPartial()

public ListServicesRequest buildPartial()
Returns
TypeDescription
ListServicesRequest

clear()

public ListServicesRequest.Builder clear()
Returns
TypeDescription
ListServicesRequest.Builder
Overrides

clearField(Descriptors.FieldDescriptor field)

public ListServicesRequest.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
ListServicesRequest.Builder
Overrides

clearFilter()

public ListServicesRequest.Builder clearFilter()

Optional. The filter to list result 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 label 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-east/namespaces/my-namespace/services/service-c" returns Services that have name that is alphabetically later than the string, so "service-e" will be returned but "service-a" will not be.
  • "metadata.owner!=sd AND metadata.foo=bar" returns Services that have "owner" in label 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.

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

Returns
TypeDescription
ListServicesRequest.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public ListServicesRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
ListServicesRequest.Builder
Overrides

clearOrderBy()

public ListServicesRequest.Builder clearOrderBy()

Optional. The order to list result by.

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

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

This builder for chaining.

clearParent()

public ListServicesRequest.Builder clearParent()

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

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

Returns
TypeDescription
ListServicesRequest.Builder

This builder for chaining.

clone()

public ListServicesRequest.Builder clone()
Returns
TypeDescription
ListServicesRequest.Builder
Overrides

getDefaultInstanceForType()

public ListServicesRequest getDefaultInstanceForType()
Returns
TypeDescription
ListServicesRequest

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

getFilter()

public String getFilter()

Optional. The filter to list result 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 label 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-east/namespaces/my-namespace/services/service-c" returns Services that have name that is alphabetically later than the string, so "service-e" will be returned but "service-a" will not be.
  • "metadata.owner!=sd AND metadata.foo=bar" returns Services that have "owner" in label 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.

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

Returns
TypeDescription
String

The filter.

getFilterBytes()

public ByteString getFilterBytes()

Optional. The filter to list result 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 label 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-east/namespaces/my-namespace/services/service-c" returns Services that have name that is alphabetically later than the string, so "service-e" will be returned but "service-a" will not be.
  • "metadata.owner!=sd AND metadata.foo=bar" returns Services that have "owner" in label 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.

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

Returns
TypeDescription
ByteString

The bytes for filter.

getOrderBy()

public String getOrderBy()

Optional. The order to list result by.

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

Returns
TypeDescription
String

The orderBy.

getOrderByBytes()

public ByteString getOrderByBytes()

Optional. The order to list result by.

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

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
ByteString

The bytes for pageToken.

getParent()

public String getParent()

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

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

Returns
TypeDescription
String

The parent.

getParentBytes()

public ByteString getParentBytes()

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

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

Returns
TypeDescription
ByteString

The bytes for parent.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFrom(ListServicesRequest other)

public ListServicesRequest.Builder mergeFrom(ListServicesRequest other)
Parameter
NameDescription
otherListServicesRequest
Returns
TypeDescription
ListServicesRequest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public ListServicesRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ListServicesRequest.Builder
Overrides Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public ListServicesRequest.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
ListServicesRequest.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final ListServicesRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
ListServicesRequest.Builder
Overrides

setField(Descriptors.FieldDescriptor field, Object value)

public ListServicesRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
ListServicesRequest.Builder
Overrides

setFilter(String value)

public ListServicesRequest.Builder setFilter(String value)

Optional. The filter to list result 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 label 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-east/namespaces/my-namespace/services/service-c" returns Services that have name that is alphabetically later than the string, so "service-e" will be returned but "service-a" will not be.
  • "metadata.owner!=sd AND metadata.foo=bar" returns Services that have "owner" in label 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.

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

Parameter
NameDescription
valueString

The filter to set.

Returns
TypeDescription
ListServicesRequest.Builder

This builder for chaining.

setFilterBytes(ByteString value)

public ListServicesRequest.Builder setFilterBytes(ByteString value)

Optional. The filter to list result 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 label 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-east/namespaces/my-namespace/services/service-c" returns Services that have name that is alphabetically later than the string, so "service-e" will be returned but "service-a" will not be.
  • "metadata.owner!=sd AND metadata.foo=bar" returns Services that have "owner" in label 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.

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

Parameter
NameDescription
valueByteString

The bytes for filter to set.

Returns
TypeDescription
ListServicesRequest.Builder

This builder for chaining.

setOrderBy(String value)

public ListServicesRequest.Builder setOrderBy(String value)

Optional. The order to list result by.

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

Parameter
NameDescription
valueString

The orderBy to set.

Returns
TypeDescription
ListServicesRequest.Builder

This builder for chaining.

setOrderByBytes(ByteString value)

public ListServicesRequest.Builder setOrderByBytes(ByteString value)

Optional. The order to list result by.

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

Parameter
NameDescription
valueByteString

The bytes for orderBy to set.

Returns
TypeDescription
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
NameDescription
valueint

The pageSize to set.

Returns
TypeDescription
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
NameDescription
valueString

The pageToken to set.

Returns
TypeDescription
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
NameDescription
valueByteString

The bytes for pageToken to set.

Returns
TypeDescription
ListServicesRequest.Builder

This builder for chaining.

setParent(String value)

public ListServicesRequest.Builder setParent(String value)

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

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

Parameter
NameDescription
valueString

The parent to set.

Returns
TypeDescription
ListServicesRequest.Builder

This builder for chaining.

setParentBytes(ByteString value)

public ListServicesRequest.Builder setParentBytes(ByteString value)

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

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

Parameter
NameDescription
valueByteString

The bytes for parent to set.

Returns
TypeDescription
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
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
ListServicesRequest.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final ListServicesRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
ListServicesRequest.Builder
Overrides