Class CustomEmoji.Builder (0.27.0)

public static final class CustomEmoji.Builder extends GeneratedMessageV3.Builder<CustomEmoji.Builder> implements CustomEmojiOrBuilder

Represents a custom emoji.

Protobuf type google.chat.v1.CustomEmoji

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

build()

public CustomEmoji build()
Returns
Type Description
CustomEmoji

buildPartial()

public CustomEmoji buildPartial()
Returns
Type Description
CustomEmoji

clear()

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

clearEmojiName()

public CustomEmoji.Builder clearEmojiName()

Optional. Immutable. User-provided name for the custom emoji, which is unique within the organization.

Required when the custom emoji is created, output only otherwise.

Emoji names must start and end with colons, must be lowercase and can only contain alphanumeric characters, hyphens, and underscores. Hyphens and underscores should be used to separate words and cannot be used consecutively.

Example: :valid-emoji-name:

string emoji_name = 3 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
CustomEmoji.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

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

clearName()

public CustomEmoji.Builder clearName()

Identifier. The resource name of the custom emoji, assigned by the server.

Format: customEmojis/{customEmoji}

string name = 2 [(.google.api.field_behavior) = IDENTIFIER];

Returns
Type Description
CustomEmoji.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

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

clearPayload()

public CustomEmoji.Builder clearPayload()

Optional. Input only. Payload data. Required when the custom emoji is created.

.google.chat.v1.CustomEmoji.CustomEmojiPayload payload = 5 [(.google.api.field_behavior) = INPUT_ONLY, (.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
CustomEmoji.Builder

clearTemporaryImageUri()

public CustomEmoji.Builder clearTemporaryImageUri()

Output only. A temporary image URL for the custom emoji, valid for at least 10 minutes. Note that this is not populated in the response when the custom emoji is created.

string temporary_image_uri = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
CustomEmoji.Builder

This builder for chaining.

clearUid()

public CustomEmoji.Builder clearUid()

Output only. Unique key for the custom emoji resource.

string uid = 1 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.field_info) = { ... }

Returns
Type Description
CustomEmoji.Builder

This builder for chaining.

clone()

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

getDefaultInstanceForType()

public CustomEmoji getDefaultInstanceForType()
Returns
Type Description
CustomEmoji

getDescriptorForType()

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

getEmojiName()

public String getEmojiName()

Optional. Immutable. User-provided name for the custom emoji, which is unique within the organization.

Required when the custom emoji is created, output only otherwise.

Emoji names must start and end with colons, must be lowercase and can only contain alphanumeric characters, hyphens, and underscores. Hyphens and underscores should be used to separate words and cannot be used consecutively.

Example: :valid-emoji-name:

string emoji_name = 3 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
String

The emojiName.

getEmojiNameBytes()

public ByteString getEmojiNameBytes()

Optional. Immutable. User-provided name for the custom emoji, which is unique within the organization.

Required when the custom emoji is created, output only otherwise.

Emoji names must start and end with colons, must be lowercase and can only contain alphanumeric characters, hyphens, and underscores. Hyphens and underscores should be used to separate words and cannot be used consecutively.

Example: :valid-emoji-name:

string emoji_name = 3 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
ByteString

The bytes for emojiName.

getName()

public String getName()

Identifier. The resource name of the custom emoji, assigned by the server.

Format: customEmojis/{customEmoji}

string name = 2 [(.google.api.field_behavior) = IDENTIFIER];

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

Identifier. The resource name of the custom emoji, assigned by the server.

Format: customEmojis/{customEmoji}

string name = 2 [(.google.api.field_behavior) = IDENTIFIER];

Returns
Type Description
ByteString

The bytes for name.

getPayload()

public CustomEmoji.CustomEmojiPayload getPayload()

Optional. Input only. Payload data. Required when the custom emoji is created.

.google.chat.v1.CustomEmoji.CustomEmojiPayload payload = 5 [(.google.api.field_behavior) = INPUT_ONLY, (.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
CustomEmoji.CustomEmojiPayload

The payload.

getPayloadBuilder()

public CustomEmoji.CustomEmojiPayload.Builder getPayloadBuilder()

Optional. Input only. Payload data. Required when the custom emoji is created.

.google.chat.v1.CustomEmoji.CustomEmojiPayload payload = 5 [(.google.api.field_behavior) = INPUT_ONLY, (.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
CustomEmoji.CustomEmojiPayload.Builder

getPayloadOrBuilder()

public CustomEmoji.CustomEmojiPayloadOrBuilder getPayloadOrBuilder()

Optional. Input only. Payload data. Required when the custom emoji is created.

.google.chat.v1.CustomEmoji.CustomEmojiPayload payload = 5 [(.google.api.field_behavior) = INPUT_ONLY, (.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
CustomEmoji.CustomEmojiPayloadOrBuilder

getTemporaryImageUri()

public String getTemporaryImageUri()

Output only. A temporary image URL for the custom emoji, valid for at least 10 minutes. Note that this is not populated in the response when the custom emoji is created.

string temporary_image_uri = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The temporaryImageUri.

getTemporaryImageUriBytes()

public ByteString getTemporaryImageUriBytes()

Output only. A temporary image URL for the custom emoji, valid for at least 10 minutes. Note that this is not populated in the response when the custom emoji is created.

string temporary_image_uri = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for temporaryImageUri.

getUid()

public String getUid()

Output only. Unique key for the custom emoji resource.

string uid = 1 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.field_info) = { ... }

Returns
Type Description
String

The uid.

getUidBytes()

public ByteString getUidBytes()

Output only. Unique key for the custom emoji resource.

string uid = 1 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.field_info) = { ... }

Returns
Type Description
ByteString

The bytes for uid.

hasPayload()

public boolean hasPayload()

Optional. Input only. Payload data. Required when the custom emoji is created.

.google.chat.v1.CustomEmoji.CustomEmojiPayload payload = 5 [(.google.api.field_behavior) = INPUT_ONLY, (.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the payload field is set.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(CustomEmoji other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergePayload(CustomEmoji.CustomEmojiPayload value)

public CustomEmoji.Builder mergePayload(CustomEmoji.CustomEmojiPayload value)

Optional. Input only. Payload data. Required when the custom emoji is created.

.google.chat.v1.CustomEmoji.CustomEmojiPayload payload = 5 [(.google.api.field_behavior) = INPUT_ONLY, (.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value CustomEmoji.CustomEmojiPayload
Returns
Type Description
CustomEmoji.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

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

setEmojiName(String value)

public CustomEmoji.Builder setEmojiName(String value)

Optional. Immutable. User-provided name for the custom emoji, which is unique within the organization.

Required when the custom emoji is created, output only otherwise.

Emoji names must start and end with colons, must be lowercase and can only contain alphanumeric characters, hyphens, and underscores. Hyphens and underscores should be used to separate words and cannot be used consecutively.

Example: :valid-emoji-name:

string emoji_name = 3 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = IMMUTABLE];

Parameter
Name Description
value String

The emojiName to set.

Returns
Type Description
CustomEmoji.Builder

This builder for chaining.

setEmojiNameBytes(ByteString value)

public CustomEmoji.Builder setEmojiNameBytes(ByteString value)

Optional. Immutable. User-provided name for the custom emoji, which is unique within the organization.

Required when the custom emoji is created, output only otherwise.

Emoji names must start and end with colons, must be lowercase and can only contain alphanumeric characters, hyphens, and underscores. Hyphens and underscores should be used to separate words and cannot be used consecutively.

Example: :valid-emoji-name:

string emoji_name = 3 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = IMMUTABLE];

Parameter
Name Description
value ByteString

The bytes for emojiName to set.

Returns
Type Description
CustomEmoji.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

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

setName(String value)

public CustomEmoji.Builder setName(String value)

Identifier. The resource name of the custom emoji, assigned by the server.

Format: customEmojis/{customEmoji}

string name = 2 [(.google.api.field_behavior) = IDENTIFIER];

Parameter
Name Description
value String

The name to set.

Returns
Type Description
CustomEmoji.Builder

This builder for chaining.

setNameBytes(ByteString value)

public CustomEmoji.Builder setNameBytes(ByteString value)

Identifier. The resource name of the custom emoji, assigned by the server.

Format: customEmojis/{customEmoji}

string name = 2 [(.google.api.field_behavior) = IDENTIFIER];

Parameter
Name Description
value ByteString

The bytes for name to set.

Returns
Type Description
CustomEmoji.Builder

This builder for chaining.

setPayload(CustomEmoji.CustomEmojiPayload value)

public CustomEmoji.Builder setPayload(CustomEmoji.CustomEmojiPayload value)

Optional. Input only. Payload data. Required when the custom emoji is created.

.google.chat.v1.CustomEmoji.CustomEmojiPayload payload = 5 [(.google.api.field_behavior) = INPUT_ONLY, (.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value CustomEmoji.CustomEmojiPayload
Returns
Type Description
CustomEmoji.Builder

setPayload(CustomEmoji.CustomEmojiPayload.Builder builderForValue)

public CustomEmoji.Builder setPayload(CustomEmoji.CustomEmojiPayload.Builder builderForValue)

Optional. Input only. Payload data. Required when the custom emoji is created.

.google.chat.v1.CustomEmoji.CustomEmojiPayload payload = 5 [(.google.api.field_behavior) = INPUT_ONLY, (.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
builderForValue CustomEmoji.CustomEmojiPayload.Builder
Returns
Type Description
CustomEmoji.Builder

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

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

setTemporaryImageUri(String value)

public CustomEmoji.Builder setTemporaryImageUri(String value)

Output only. A temporary image URL for the custom emoji, valid for at least 10 minutes. Note that this is not populated in the response when the custom emoji is created.

string temporary_image_uri = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value String

The temporaryImageUri to set.

Returns
Type Description
CustomEmoji.Builder

This builder for chaining.

setTemporaryImageUriBytes(ByteString value)

public CustomEmoji.Builder setTemporaryImageUriBytes(ByteString value)

Output only. A temporary image URL for the custom emoji, valid for at least 10 minutes. Note that this is not populated in the response when the custom emoji is created.

string temporary_image_uri = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value ByteString

The bytes for temporaryImageUri to set.

Returns
Type Description
CustomEmoji.Builder

This builder for chaining.

setUid(String value)

public CustomEmoji.Builder setUid(String value)

Output only. Unique key for the custom emoji resource.

string uid = 1 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.field_info) = { ... }

Parameter
Name Description
value String

The uid to set.

Returns
Type Description
CustomEmoji.Builder

This builder for chaining.

setUidBytes(ByteString value)

public CustomEmoji.Builder setUidBytes(ByteString value)

Output only. Unique key for the custom emoji resource.

string uid = 1 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.field_info) = { ... }

Parameter
Name Description
value ByteString

The bytes for uid to set.

Returns
Type Description
CustomEmoji.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

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