Class ListCustomEmojisRequest.Builder (0.27.0)

public static final class ListCustomEmojisRequest.Builder extends GeneratedMessageV3.Builder<ListCustomEmojisRequest.Builder> implements ListCustomEmojisRequestOrBuilder

A request to return a list of custom emojis.

Protobuf type google.chat.v1.ListCustomEmojisRequest

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

build()

public ListCustomEmojisRequest build()
Returns
Type Description
ListCustomEmojisRequest

buildPartial()

public ListCustomEmojisRequest buildPartial()
Returns
Type Description
ListCustomEmojisRequest

clear()

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

clearField(Descriptors.FieldDescriptor field)

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

clearFilter()

public ListCustomEmojisRequest.Builder clearFilter()

Optional. A query filter.

Supports filtering by creator.

To filter by creator, you must specify a valid value. Currently only creator("users/me") and NOT creator("users/me") are accepted to filter custom emojis by whether they were created by the calling user or not.

For example, the following query returns custom emojis created by the caller: ` creator("users/me")

Invalid queries are rejected with an INVALID_ARGUMENT` error.

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

Returns
Type Description
ListCustomEmojisRequest.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

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

clearPageSize()

public ListCustomEmojisRequest.Builder clearPageSize()

Optional. The maximum number of custom emojis returned. The service can return fewer custom emojis than this value. If unspecified, the default value is 25. The maximum value is 200; values above 200 are changed to 200.

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

Returns
Type Description
ListCustomEmojisRequest.Builder

This builder for chaining.

clearPageToken()

public ListCustomEmojisRequest.Builder clearPageToken()

Optional. (If resuming from a previous query.)

A page token received from a previous list custom emoji call. Provide this to retrieve the subsequent page.

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

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

Returns
Type Description
ListCustomEmojisRequest.Builder

This builder for chaining.

clone()

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

getDefaultInstanceForType()

public ListCustomEmojisRequest getDefaultInstanceForType()
Returns
Type Description
ListCustomEmojisRequest

getDescriptorForType()

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

getFilter()

public String getFilter()

Optional. A query filter.

Supports filtering by creator.

To filter by creator, you must specify a valid value. Currently only creator("users/me") and NOT creator("users/me") are accepted to filter custom emojis by whether they were created by the calling user or not.

For example, the following query returns custom emojis created by the caller: ` creator("users/me")

Invalid queries are rejected 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.

Supports filtering by creator.

To filter by creator, you must specify a valid value. Currently only creator("users/me") and NOT creator("users/me") are accepted to filter custom emojis by whether they were created by the calling user or not.

For example, the following query returns custom emojis created by the caller: ` creator("users/me")

Invalid queries are rejected 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 custom emojis returned. The service can return fewer custom emojis than this value. If unspecified, the default value is 25. The maximum value is 200; values above 200 are changed to 200.

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

Returns
Type Description
int

The pageSize.

getPageToken()

public String getPageToken()

Optional. (If resuming from a previous query.)

A page token received from a previous list custom emoji call. Provide this to retrieve the subsequent page.

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

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

Returns
Type Description
String

The pageToken.

getPageTokenBytes()

public ByteString getPageTokenBytes()

Optional. (If resuming from a previous query.)

A page token received from a previous list custom emoji call. Provide this to retrieve the subsequent page.

When paginating, the filter value should match the call that provided the page token. Passing a different value might 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(ListCustomEmojisRequest other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeUnknownFields(UnknownFieldSet unknownFields)

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

setField(Descriptors.FieldDescriptor field, Object value)

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

setFilter(String value)

public ListCustomEmojisRequest.Builder setFilter(String value)

Optional. A query filter.

Supports filtering by creator.

To filter by creator, you must specify a valid value. Currently only creator("users/me") and NOT creator("users/me") are accepted to filter custom emojis by whether they were created by the calling user or not.

For example, the following query returns custom emojis created by the caller: ` creator("users/me")

Invalid queries are rejected 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
ListCustomEmojisRequest.Builder

This builder for chaining.

setFilterBytes(ByteString value)

public ListCustomEmojisRequest.Builder setFilterBytes(ByteString value)

Optional. A query filter.

Supports filtering by creator.

To filter by creator, you must specify a valid value. Currently only creator("users/me") and NOT creator("users/me") are accepted to filter custom emojis by whether they were created by the calling user or not.

For example, the following query returns custom emojis created by the caller: ` creator("users/me")

Invalid queries are rejected 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
ListCustomEmojisRequest.Builder

This builder for chaining.

setPageSize(int value)

public ListCustomEmojisRequest.Builder setPageSize(int value)

Optional. The maximum number of custom emojis returned. The service can return fewer custom emojis than this value. If unspecified, the default value is 25. The maximum value is 200; values above 200 are changed to 200.

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

Parameter
Name Description
value int

The pageSize to set.

Returns
Type Description
ListCustomEmojisRequest.Builder

This builder for chaining.

setPageToken(String value)

public ListCustomEmojisRequest.Builder setPageToken(String value)

Optional. (If resuming from a previous query.)

A page token received from a previous list custom emoji call. Provide this to retrieve the subsequent page.

When paginating, the filter value should match the call that provided the page token. Passing a different value might 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
ListCustomEmojisRequest.Builder

This builder for chaining.

setPageTokenBytes(ByteString value)

public ListCustomEmojisRequest.Builder setPageTokenBytes(ByteString value)

Optional. (If resuming from a previous query.)

A page token received from a previous list custom emoji call. Provide this to retrieve the subsequent page.

When paginating, the filter value should match the call that provided the page token. Passing a different value might 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
ListCustomEmojisRequest.Builder

This builder for chaining.

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

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

setUnknownFields(UnknownFieldSet unknownFields)

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