Class ListNamespacesRequest.Builder (2.47.0)

public static final class ListNamespacesRequest.Builder extends GeneratedMessageV3.Builder<ListNamespacesRequest.Builder> implements ListNamespacesRequestOrBuilder

The request message for RegistrationService.ListNamespaces.

Protobuf type google.cloud.servicedirectory.v1beta1.ListNamespacesRequest

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

build()

public ListNamespacesRequest build()
Returns
Type Description
ListNamespacesRequest

buildPartial()

public ListNamespacesRequest buildPartial()
Returns
Type Description
ListNamespacesRequest

clear()

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

clearField(Descriptors.FieldDescriptor field)

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

clearFilter()

public ListNamespacesRequest.Builder clearFilter()

Optional. The filter to list results by.

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

  • <field> can be name, labels.<key> for map field, or attributes.<field> for attributes 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:

  • labels.owner returns namespaces that have a label with the key owner, this is the same as labels:owner

  • labels.owner=sd returns namespaces that have key/value owner=sd
  • name>projects/my-project/locations/us-east1/namespaces/namespace-c returns namespaces that have name that is alphabetically later than the string, so "namespace-e" is returned but "namespace-a" is not
  • labels.owner!=sd AND labels.foo=bar returns namespaces 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 namespace doesn't have a field called "doesnotexist". Since the filter does not match any namespaces, it returns no results
  • attributes.managed_registration=true returns namespaces 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
ListNamespacesRequest.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

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

clearOrderBy()

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

This builder for chaining.

clearPageSize()

public ListNamespacesRequest.Builder clearPageSize()

Optional. The maximum number of items to return. The default value is 100.

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

Returns
Type Description
ListNamespacesRequest.Builder

This builder for chaining.

clearPageToken()

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

This builder for chaining.

clearParent()

public ListNamespacesRequest.Builder clearParent()

Required. The resource name of the project and location whose namespaces you'd like to list.

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

Returns
Type Description
ListNamespacesRequest.Builder

This builder for chaining.

clone()

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

getDefaultInstanceForType()

public ListNamespacesRequest getDefaultInstanceForType()
Returns
Type Description
ListNamespacesRequest

getDescriptorForType()

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

getFilter()

public String getFilter()

Optional. The filter to list results by.

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

  • <field> can be name, labels.<key> for map field, or attributes.<field> for attributes 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:

  • labels.owner returns namespaces that have a label with the key owner, this is the same as labels:owner

  • labels.owner=sd returns namespaces that have key/value owner=sd
  • name>projects/my-project/locations/us-east1/namespaces/namespace-c returns namespaces that have name that is alphabetically later than the string, so "namespace-e" is returned but "namespace-a" is not
  • labels.owner!=sd AND labels.foo=bar returns namespaces 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 namespace doesn't have a field called "doesnotexist". Since the filter does not match any namespaces, it returns no results
  • attributes.managed_registration=true returns namespaces 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, labels.<key> for map field, or attributes.<field> for attributes 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:

  • labels.owner returns namespaces that have a label with the key owner, this is the same as labels:owner

  • labels.owner=sd returns namespaces that have key/value owner=sd
  • name>projects/my-project/locations/us-east1/namespaces/namespace-c returns namespaces that have name that is alphabetically later than the string, so "namespace-e" is returned but "namespace-a" is not
  • labels.owner!=sd AND labels.foo=bar returns namespaces 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 namespace doesn't have a field called "doesnotexist". Since the filter does not match any namespaces, it returns no results
  • attributes.managed_registration=true returns namespaces 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. The default value is 100.

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 project and location whose namespaces 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 project and location whose namespaces 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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(ListNamespacesRequest other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeUnknownFields(UnknownFieldSet unknownFields)

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

setField(Descriptors.FieldDescriptor field, Object value)

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

setFilter(String value)

public ListNamespacesRequest.Builder setFilter(String value)

Optional. The filter to list results by.

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

  • <field> can be name, labels.<key> for map field, or attributes.<field> for attributes 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:

  • labels.owner returns namespaces that have a label with the key owner, this is the same as labels:owner

  • labels.owner=sd returns namespaces that have key/value owner=sd
  • name>projects/my-project/locations/us-east1/namespaces/namespace-c returns namespaces that have name that is alphabetically later than the string, so "namespace-e" is returned but "namespace-a" is not
  • labels.owner!=sd AND labels.foo=bar returns namespaces 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 namespace doesn't have a field called "doesnotexist". Since the filter does not match any namespaces, it returns no results
  • attributes.managed_registration=true returns namespaces 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
ListNamespacesRequest.Builder

This builder for chaining.

setFilterBytes(ByteString value)

public ListNamespacesRequest.Builder setFilterBytes(ByteString value)

Optional. The filter to list results by.

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

  • <field> can be name, labels.<key> for map field, or attributes.<field> for attributes 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:

  • labels.owner returns namespaces that have a label with the key owner, this is the same as labels:owner

  • labels.owner=sd returns namespaces that have key/value owner=sd
  • name>projects/my-project/locations/us-east1/namespaces/namespace-c returns namespaces that have name that is alphabetically later than the string, so "namespace-e" is returned but "namespace-a" is not
  • labels.owner!=sd AND labels.foo=bar returns namespaces 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 namespace doesn't have a field called "doesnotexist". Since the filter does not match any namespaces, it returns no results
  • attributes.managed_registration=true returns namespaces 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
ListNamespacesRequest.Builder

This builder for chaining.

setOrderBy(String value)

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

This builder for chaining.

setOrderByBytes(ByteString value)

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

This builder for chaining.

setPageSize(int value)

public ListNamespacesRequest.Builder setPageSize(int value)

Optional. The maximum number of items to return. The default value is 100.

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

Parameter
Name Description
value int

The pageSize to set.

Returns
Type Description
ListNamespacesRequest.Builder

This builder for chaining.

setPageToken(String value)

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

This builder for chaining.

setPageTokenBytes(ByteString value)

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

This builder for chaining.

setParent(String value)

public ListNamespacesRequest.Builder setParent(String value)

Required. The resource name of the project and location whose namespaces 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
ListNamespacesRequest.Builder

This builder for chaining.

setParentBytes(ByteString value)

public ListNamespacesRequest.Builder setParentBytes(ByteString value)

Required. The resource name of the project and location whose namespaces 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
ListNamespacesRequest.Builder

This builder for chaining.

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

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

setUnknownFields(UnknownFieldSet unknownFields)

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