Class ListSpacesRequest.Builder (0.11.0)

public static final class ListSpacesRequest.Builder extends GeneratedMessageV3.Builder<ListSpacesRequest.Builder> implements ListSpacesRequestOrBuilder

A request to list the spaces the caller is a member of.

Protobuf type google.chat.v1.ListSpacesRequest

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

build()

public ListSpacesRequest build()
Returns
Type Description
ListSpacesRequest

buildPartial()

public ListSpacesRequest buildPartial()
Returns
Type Description
ListSpacesRequest

clear()

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

clearField(Descriptors.FieldDescriptor field)

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

clearFilter()

public ListSpacesRequest.Builder clearFilter()

Optional. A query filter.

You can filter spaces by the space type (space_type).

To filter by space type, you must specify valid enum value, such as SPACE or GROUP_CHAT (the space_type can't be SPACE_TYPE_UNSPECIFIED). To query for multiple space types, use the OR operator.

For example, the following queries are valid:

` space_type = "SPACE" spaceType = "GROUP_CHAT" OR spaceType = "DIRECT_MESSAGE"

Invalid queries are rejected by the server with an INVALID_ARGUMENT` error.

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

Returns
Type Description
ListSpacesRequest.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

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

clearPageSize()

public ListSpacesRequest.Builder clearPageSize()

Optional. The maximum number of spaces to return. The service might return fewer than this value.

If unspecified, at most 100 spaces are returned.

The maximum value is 1000. If you use a value more than 1000, it's automatically changed to 1000.

Negative values return an INVALID_ARGUMENT error.

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

Returns
Type Description
ListSpacesRequest.Builder

This builder for chaining.

clearPageToken()

public ListSpacesRequest.Builder clearPageToken()

Optional. A page token, received from a previous list spaces call. Provide this parameter to retrieve the subsequent page.

When paginating, the filter value should match the call that provided the page token. Passing a different value may lead to unexpected results.

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

Returns
Type Description
ListSpacesRequest.Builder

This builder for chaining.

clone()

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

getDefaultInstanceForType()

public ListSpacesRequest getDefaultInstanceForType()
Returns
Type Description
ListSpacesRequest

getDescriptorForType()

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

getFilter()

public String getFilter()

Optional. A query filter.

You can filter spaces by the space type (space_type).

To filter by space type, you must specify valid enum value, such as SPACE or GROUP_CHAT (the space_type can't be SPACE_TYPE_UNSPECIFIED). To query for multiple space types, use the OR operator.

For example, the following queries are valid:

` space_type = "SPACE" spaceType = "GROUP_CHAT" OR spaceType = "DIRECT_MESSAGE"

Invalid queries are rejected by the server with an INVALID_ARGUMENT` error.

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

Returns
Type Description
String

The filter.

getFilterBytes()

public ByteString getFilterBytes()

Optional. A query filter.

You can filter spaces by the space type (space_type).

To filter by space type, you must specify valid enum value, such as SPACE or GROUP_CHAT (the space_type can't be SPACE_TYPE_UNSPECIFIED). To query for multiple space types, use the OR operator.

For example, the following queries are valid:

` space_type = "SPACE" spaceType = "GROUP_CHAT" OR spaceType = "DIRECT_MESSAGE"

Invalid queries are rejected by the server with an INVALID_ARGUMENT` error.

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

Returns
Type Description
ByteString

The bytes for filter.

getPageSize()

public int getPageSize()

Optional. The maximum number of spaces to return. The service might return fewer than this value.

If unspecified, at most 100 spaces are returned.

The maximum value is 1000. If you use a value more than 1000, it's automatically changed to 1000.

Negative values return an INVALID_ARGUMENT error.

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

Returns
Type Description
int

The pageSize.

getPageToken()

public String getPageToken()

Optional. A page token, received from a previous list spaces call. Provide this parameter to retrieve the subsequent page.

When paginating, the filter value should match the call that provided the page token. Passing a different value may lead to unexpected results.

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

Returns
Type Description
String

The pageToken.

getPageTokenBytes()

public ByteString getPageTokenBytes()

Optional. A page token, received from a previous list spaces call. Provide this parameter to retrieve the subsequent page.

When paginating, the filter value should match the call that provided the page token. Passing a different value may lead to unexpected results.

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

Returns
Type Description
ByteString

The bytes for pageToken.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(ListSpacesRequest other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeUnknownFields(UnknownFieldSet unknownFields)

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

setField(Descriptors.FieldDescriptor field, Object value)

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

setFilter(String value)

public ListSpacesRequest.Builder setFilter(String value)

Optional. A query filter.

You can filter spaces by the space type (space_type).

To filter by space type, you must specify valid enum value, such as SPACE or GROUP_CHAT (the space_type can't be SPACE_TYPE_UNSPECIFIED). To query for multiple space types, use the OR operator.

For example, the following queries are valid:

` space_type = "SPACE" spaceType = "GROUP_CHAT" OR spaceType = "DIRECT_MESSAGE"

Invalid queries are rejected by the server with an INVALID_ARGUMENT` error.

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

Parameter
Name Description
value String

The filter to set.

Returns
Type Description
ListSpacesRequest.Builder

This builder for chaining.

setFilterBytes(ByteString value)

public ListSpacesRequest.Builder setFilterBytes(ByteString value)

Optional. A query filter.

You can filter spaces by the space type (space_type).

To filter by space type, you must specify valid enum value, such as SPACE or GROUP_CHAT (the space_type can't be SPACE_TYPE_UNSPECIFIED). To query for multiple space types, use the OR operator.

For example, the following queries are valid:

` space_type = "SPACE" spaceType = "GROUP_CHAT" OR spaceType = "DIRECT_MESSAGE"

Invalid queries are rejected by the server with an INVALID_ARGUMENT` error.

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

Parameter
Name Description
value ByteString

The bytes for filter to set.

Returns
Type Description
ListSpacesRequest.Builder

This builder for chaining.

setPageSize(int value)

public ListSpacesRequest.Builder setPageSize(int value)

Optional. The maximum number of spaces to return. The service might return fewer than this value.

If unspecified, at most 100 spaces are returned.

The maximum value is 1000. If you use a value more than 1000, it's automatically changed to 1000.

Negative values return an INVALID_ARGUMENT error.

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

Parameter
Name Description
value int

The pageSize to set.

Returns
Type Description
ListSpacesRequest.Builder

This builder for chaining.

setPageToken(String value)

public ListSpacesRequest.Builder setPageToken(String value)

Optional. A page token, received from a previous list spaces call. Provide this parameter to retrieve the subsequent page.

When paginating, the filter value should match the call that provided the page token. Passing a different value may lead to unexpected results.

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

Parameter
Name Description
value String

The pageToken to set.

Returns
Type Description
ListSpacesRequest.Builder

This builder for chaining.

setPageTokenBytes(ByteString value)

public ListSpacesRequest.Builder setPageTokenBytes(ByteString value)

Optional. A page token, received from a previous list spaces call. Provide this parameter to retrieve the subsequent page.

When paginating, the filter value should match the call that provided the page token. Passing a different value may lead to unexpected results.

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

Parameter
Name Description
value ByteString

The bytes for pageToken to set.

Returns
Type Description
ListSpacesRequest.Builder

This builder for chaining.

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

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

setUnknownFields(UnknownFieldSet unknownFields)

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