Class EntityType.Entity.Builder (0.38.0) 

public static final class EntityType.Entity.Builder extends GeneratedMessageV3.Builder<EntityType.Entity.Builder> implements EntityType.EntityOrBuilder

An entity entry for an associated entity type.

Protobuf type google.cloud.dialogflow.cx.v3.EntityType.Entity

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > EntityType.Entity.Builder

Static Methods

getDescriptor()

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

Methods

addAllSynonyms(Iterable<String> values)

public EntityType.Entity.Builder addAllSynonyms(Iterable<String> values)

Required. A collection of value synonyms. For example, if the entity type is vegetable, and value is scallions, a synonym could be green onions.

For KIND_LIST entity types:

  • This collection must contain exactly one synonym equal to value.

repeated string synonyms = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
values Iterable<String>

The synonyms to add.
Returns
Type Description
EntityType.Entity.Builder

This builder for chaining.

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

addSynonyms(String value)

public EntityType.Entity.Builder addSynonyms(String value)

Required. A collection of value synonyms. For example, if the entity type is vegetable, and value is scallions, a synonym could be green onions.

For KIND_LIST entity types:

  • This collection must contain exactly one synonym equal to value.

repeated string synonyms = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value String

The synonyms to add.
Returns
Type Description
EntityType.Entity.Builder

This builder for chaining.

addSynonymsBytes(ByteString value)

public EntityType.Entity.Builder addSynonymsBytes(ByteString value)

Required. A collection of value synonyms. For example, if the entity type is vegetable, and value is scallions, a synonym could be green onions.

For KIND_LIST entity types:

  • This collection must contain exactly one synonym equal to value.

repeated string synonyms = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value ByteString

The bytes of the synonyms to add.
Returns
Type Description
EntityType.Entity.Builder

This builder for chaining.

build()

public EntityType.Entity build()
Returns
Type Description
EntityType.Entity

buildPartial()

public EntityType.Entity buildPartial()
Returns
Type Description
EntityType.Entity

clear()

public EntityType.Entity.Builder clear()
Returns
Type Description
EntityType.Entity.Builder
Overrides

clearField(Descriptors.FieldDescriptor field)

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

clearOneof(Descriptors.OneofDescriptor oneof)

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

clearSynonyms()

public EntityType.Entity.Builder clearSynonyms()

Required. A collection of value synonyms. For example, if the entity type is vegetable, and value is scallions, a synonym could be green onions.

For KIND_LIST entity types:

  • This collection must contain exactly one synonym equal to value.

repeated string synonyms = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
EntityType.Entity.Builder

This builder for chaining.

clearValue()

public EntityType.Entity.Builder clearValue()

Required. The primary value associated with this entity entry. For example, if the entity type is vegetable, the value could be scallions.

For KIND_MAP entity types:

  • A canonical value to be used in place of synonyms.

    For KIND_LIST entity types:

  • A string that can contain references to other entity types (with or without aliases).

string value = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
EntityType.Entity.Builder

This builder for chaining.

clone()

public EntityType.Entity.Builder clone()
Returns
Type Description
EntityType.Entity.Builder
Overrides

getDefaultInstanceForType()

public EntityType.Entity getDefaultInstanceForType()
Returns
Type Description
EntityType.Entity

getDescriptorForType()

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

getSynonyms(int index)

public String getSynonyms(int index)

Required. A collection of value synonyms. For example, if the entity type is vegetable, and value is scallions, a synonym could be green onions.

For KIND_LIST entity types:

  • This collection must contain exactly one synonym equal to value.

repeated string synonyms = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
index int

The index of the element to return.
Returns
Type Description
String

The synonyms at the given index.

getSynonymsBytes(int index)

public ByteString getSynonymsBytes(int index)

Required. A collection of value synonyms. For example, if the entity type is vegetable, and value is scallions, a synonym could be green onions.

For KIND_LIST entity types:

  • This collection must contain exactly one synonym equal to value.

repeated string synonyms = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
index int

The index of the value to return.
Returns
Type Description
ByteString

The bytes of the synonyms at the given index.

getSynonymsCount()

public int getSynonymsCount()

Required. A collection of value synonyms. For example, if the entity type is vegetable, and value is scallions, a synonym could be green onions.

For KIND_LIST entity types:

  • This collection must contain exactly one synonym equal to value.

repeated string synonyms = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
int

The count of synonyms.

getSynonymsList()

public ProtocolStringList getSynonymsList()

Required. A collection of value synonyms. For example, if the entity type is vegetable, and value is scallions, a synonym could be green onions.

For KIND_LIST entity types:

  • This collection must contain exactly one synonym equal to value.

repeated string synonyms = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ProtocolStringList

A list containing the synonyms.

getValue()

public String getValue()

Required. The primary value associated with this entity entry. For example, if the entity type is vegetable, the value could be scallions.

For KIND_MAP entity types:

  • A canonical value to be used in place of synonyms.

    For KIND_LIST entity types:

  • A string that can contain references to other entity types (with or without aliases).

string value = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The value.

getValueBytes()

public ByteString getValueBytes()

Required. The primary value associated with this entity entry. For example, if the entity type is vegetable, the value could be scallions.

For KIND_MAP entity types:

  • A canonical value to be used in place of synonyms.

    For KIND_LIST entity types:

  • A string that can contain references to other entity types (with or without aliases).

string value = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for value.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(EntityType.Entity other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeUnknownFields(UnknownFieldSet unknownFields)

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

setField(Descriptors.FieldDescriptor field, Object value)

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

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

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

setSynonyms(int index, String value)

public EntityType.Entity.Builder setSynonyms(int index, String value)

Required. A collection of value synonyms. For example, if the entity type is vegetable, and value is scallions, a synonym could be green onions.

For KIND_LIST entity types:

  • This collection must contain exactly one synonym equal to value.

repeated string synonyms = 2 [(.google.api.field_behavior) = REQUIRED];

Parameters
Name Description
index int

The index to set the value at.
value String

The synonyms to set.
Returns
Type Description
EntityType.Entity.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

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

setValue(String value)

public EntityType.Entity.Builder setValue(String value)

Required. The primary value associated with this entity entry. For example, if the entity type is vegetable, the value could be scallions.

For KIND_MAP entity types:

  • A canonical value to be used in place of synonyms.

    For KIND_LIST entity types:

  • A string that can contain references to other entity types (with or without aliases).

string value = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value String

The value to set.
Returns
Type Description
EntityType.Entity.Builder

This builder for chaining.

setValueBytes(ByteString value)

public EntityType.Entity.Builder setValueBytes(ByteString value)

Required. The primary value associated with this entity entry. For example, if the entity type is vegetable, the value could be scallions.

For KIND_MAP entity types:

  • A canonical value to be used in place of synonyms.

    For KIND_LIST entity types:

  • A string that can contain references to other entity types (with or without aliases).

string value = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value ByteString

The bytes for value to set.
Returns
Type Description
EntityType.Entity.Builder

This builder for chaining.