public static final class ListCustomEmojisRequest.Builder extends GeneratedMessage.Builder<ListCustomEmojisRequest.Builder> implements ListCustomEmojisRequestOrBuilderA request to return a list of custom emojis.
Protobuf type google.chat.v1.ListCustomEmojisRequest
Inheritance
java.lang.Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessage.Builder > ListCustomEmojisRequest.BuilderImplements
ListCustomEmojisRequestOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
Methods
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 |
|
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. |
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. |
getDefaultInstanceForType()
public ListCustomEmojisRequest getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
ListCustomEmojisRequest |
|
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
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 GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
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 |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
mergeFrom(Message other)
public ListCustomEmojisRequest.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other |
Message |
| Returns | |
|---|---|
| Type | Description |
ListCustomEmojisRequest.Builder |
|
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 |
StringThe 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 |
ByteStringThe 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 |
intThe 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 |
StringThe 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 |
ByteStringThe bytes for pageToken to set. |
| Returns | |
|---|---|
| Type | Description |
ListCustomEmojisRequest.Builder |
This builder for chaining. |