Class EntityType.Builder (0.65.0) 

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

Entities are extracted from user input and represent parameters that are meaningful to your application. For example, a date range, a proper name such as a geographic location or landmark, and so on. Entities represent actionable data for your application.

When you define an entity, you can also include synonyms that all map to that entity. For example, "soft drink", "soda", "pop", and so on.

There are three types of entities:

  • System - entities that are defined by the Dialogflow API for common data types such as date, time, currency, and so on. A system entity is represented by the EntityType type.

  • Custom - entities that are defined by you that represent actionable data that is meaningful to your application. For example, you could define a pizza.sauce entity for red or white pizza sauce, a pizza.cheese entity for the different types of cheese on a pizza, a pizza.topping entity for different toppings, and so on. A custom entity is represented by the EntityType type.

  • User - entities that are built for an individual user such as favorites, preferences, playlists, and so on. A user entity is represented by the SessionEntityType type.

    For more information about entity types, see the Dialogflow documentation.

Protobuf type google.cloud.dialogflow.cx.v3beta1.EntityType

Inheritance

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

Implements

EntityTypeOrBuilder

Static Methods

getDescriptor()

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

Methods

addAllEntities(Iterable<? extends EntityType.Entity> values)

public EntityType.Builder addAllEntities(Iterable<? extends EntityType.Entity> values)

The collection of entity entries associated with the entity type.

repeated .google.cloud.dialogflow.cx.v3beta1.EntityType.Entity entities = 5;

Parameter
Name Description
values Iterable<? extends com.google.cloud.dialogflow.cx.v3beta1.EntityType.Entity>
Returns
Type Description
EntityType.Builder

addAllExcludedPhrases(Iterable<? extends EntityType.ExcludedPhrase> values)

public EntityType.Builder addAllExcludedPhrases(Iterable<? extends EntityType.ExcludedPhrase> values)

Collection of exceptional words and phrases that shouldn't be matched. For example, if you have a size entity type with entry giant(an adjective), you might consider adding giants(a noun) as an exclusion. If the kind of entity type is KIND_MAP, then the phrases specified by entities and excluded phrases should be mutually exclusive.

repeated .google.cloud.dialogflow.cx.v3beta1.EntityType.ExcludedPhrase excluded_phrases = 6;

Parameter
Name Description
values Iterable<? extends com.google.cloud.dialogflow.cx.v3beta1.EntityType.ExcludedPhrase>
Returns
Type Description
EntityType.Builder

addEntities(EntityType.Entity value)

public EntityType.Builder addEntities(EntityType.Entity value)

The collection of entity entries associated with the entity type.

repeated .google.cloud.dialogflow.cx.v3beta1.EntityType.Entity entities = 5;

Parameter
Name Description
value EntityType.Entity
Returns
Type Description
EntityType.Builder

addEntities(EntityType.Entity.Builder builderForValue)

public EntityType.Builder addEntities(EntityType.Entity.Builder builderForValue)

The collection of entity entries associated with the entity type.

repeated .google.cloud.dialogflow.cx.v3beta1.EntityType.Entity entities = 5;

Parameter
Name Description
builderForValue EntityType.Entity.Builder
Returns
Type Description
EntityType.Builder

addEntities(int index, EntityType.Entity value)

public EntityType.Builder addEntities(int index, EntityType.Entity value)

The collection of entity entries associated with the entity type.

repeated .google.cloud.dialogflow.cx.v3beta1.EntityType.Entity entities = 5;

Parameters
Name Description
index int
value EntityType.Entity
Returns
Type Description
EntityType.Builder

addEntities(int index, EntityType.Entity.Builder builderForValue)

public EntityType.Builder addEntities(int index, EntityType.Entity.Builder builderForValue)

The collection of entity entries associated with the entity type.

repeated .google.cloud.dialogflow.cx.v3beta1.EntityType.Entity entities = 5;

Parameters
Name Description
index int
builderForValue EntityType.Entity.Builder
Returns
Type Description
EntityType.Builder

addEntitiesBuilder()

public EntityType.Entity.Builder addEntitiesBuilder()

The collection of entity entries associated with the entity type.

repeated .google.cloud.dialogflow.cx.v3beta1.EntityType.Entity entities = 5;

Returns
Type Description
EntityType.Entity.Builder

addEntitiesBuilder(int index)

public EntityType.Entity.Builder addEntitiesBuilder(int index)

The collection of entity entries associated with the entity type.

repeated .google.cloud.dialogflow.cx.v3beta1.EntityType.Entity entities = 5;

Parameter
Name Description
index int
Returns
Type Description
EntityType.Entity.Builder

addExcludedPhrases(EntityType.ExcludedPhrase value)

public EntityType.Builder addExcludedPhrases(EntityType.ExcludedPhrase value)

Collection of exceptional words and phrases that shouldn't be matched. For example, if you have a size entity type with entry giant(an adjective), you might consider adding giants(a noun) as an exclusion. If the kind of entity type is KIND_MAP, then the phrases specified by entities and excluded phrases should be mutually exclusive.

repeated .google.cloud.dialogflow.cx.v3beta1.EntityType.ExcludedPhrase excluded_phrases = 6;

Parameter
Name Description
value EntityType.ExcludedPhrase
Returns
Type Description
EntityType.Builder

addExcludedPhrases(EntityType.ExcludedPhrase.Builder builderForValue)

public EntityType.Builder addExcludedPhrases(EntityType.ExcludedPhrase.Builder builderForValue)

Collection of exceptional words and phrases that shouldn't be matched. For example, if you have a size entity type with entry giant(an adjective), you might consider adding giants(a noun) as an exclusion. If the kind of entity type is KIND_MAP, then the phrases specified by entities and excluded phrases should be mutually exclusive.

repeated .google.cloud.dialogflow.cx.v3beta1.EntityType.ExcludedPhrase excluded_phrases = 6;

Parameter
Name Description
builderForValue EntityType.ExcludedPhrase.Builder
Returns
Type Description
EntityType.Builder

addExcludedPhrases(int index, EntityType.ExcludedPhrase value)

public EntityType.Builder addExcludedPhrases(int index, EntityType.ExcludedPhrase value)

Collection of exceptional words and phrases that shouldn't be matched. For example, if you have a size entity type with entry giant(an adjective), you might consider adding giants(a noun) as an exclusion. If the kind of entity type is KIND_MAP, then the phrases specified by entities and excluded phrases should be mutually exclusive.

repeated .google.cloud.dialogflow.cx.v3beta1.EntityType.ExcludedPhrase excluded_phrases = 6;

Parameters
Name Description
index int
value EntityType.ExcludedPhrase
Returns
Type Description
EntityType.Builder

addExcludedPhrases(int index, EntityType.ExcludedPhrase.Builder builderForValue)

public EntityType.Builder addExcludedPhrases(int index, EntityType.ExcludedPhrase.Builder builderForValue)

Collection of exceptional words and phrases that shouldn't be matched. For example, if you have a size entity type with entry giant(an adjective), you might consider adding giants(a noun) as an exclusion. If the kind of entity type is KIND_MAP, then the phrases specified by entities and excluded phrases should be mutually exclusive.

repeated .google.cloud.dialogflow.cx.v3beta1.EntityType.ExcludedPhrase excluded_phrases = 6;

Parameters
Name Description
index int
builderForValue EntityType.ExcludedPhrase.Builder
Returns
Type Description
EntityType.Builder

addExcludedPhrasesBuilder()

public EntityType.ExcludedPhrase.Builder addExcludedPhrasesBuilder()

Collection of exceptional words and phrases that shouldn't be matched. For example, if you have a size entity type with entry giant(an adjective), you might consider adding giants(a noun) as an exclusion. If the kind of entity type is KIND_MAP, then the phrases specified by entities and excluded phrases should be mutually exclusive.

repeated .google.cloud.dialogflow.cx.v3beta1.EntityType.ExcludedPhrase excluded_phrases = 6;

Returns
Type Description
EntityType.ExcludedPhrase.Builder

addExcludedPhrasesBuilder(int index)

public EntityType.ExcludedPhrase.Builder addExcludedPhrasesBuilder(int index)

Collection of exceptional words and phrases that shouldn't be matched. For example, if you have a size entity type with entry giant(an adjective), you might consider adding giants(a noun) as an exclusion. If the kind of entity type is KIND_MAP, then the phrases specified by entities and excluded phrases should be mutually exclusive.

repeated .google.cloud.dialogflow.cx.v3beta1.EntityType.ExcludedPhrase excluded_phrases = 6;

Parameter
Name Description
index int
Returns
Type Description
EntityType.ExcludedPhrase.Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

build()

public EntityType build()
Returns
Type Description
EntityType

buildPartial()

public EntityType buildPartial()
Returns
Type Description
EntityType

clear()

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

clearAutoExpansionMode()

public EntityType.Builder clearAutoExpansionMode()

Indicates whether the entity type can be automatically expanded.

.google.cloud.dialogflow.cx.v3beta1.EntityType.AutoExpansionMode auto_expansion_mode = 4;

Returns
Type Description
EntityType.Builder

This builder for chaining.

clearDisplayName()

public EntityType.Builder clearDisplayName()

Required. The human-readable name of the entity type, unique within the agent.

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

Returns
Type Description
EntityType.Builder

This builder for chaining.

clearEnableFuzzyExtraction()

public EntityType.Builder clearEnableFuzzyExtraction()

Enables fuzzy entity extraction during classification.

bool enable_fuzzy_extraction = 7;

Returns
Type Description
EntityType.Builder

This builder for chaining.

clearEntities()

public EntityType.Builder clearEntities()

The collection of entity entries associated with the entity type.

repeated .google.cloud.dialogflow.cx.v3beta1.EntityType.Entity entities = 5;

Returns
Type Description
EntityType.Builder

clearExcludedPhrases()

public EntityType.Builder clearExcludedPhrases()

Collection of exceptional words and phrases that shouldn't be matched. For example, if you have a size entity type with entry giant(an adjective), you might consider adding giants(a noun) as an exclusion. If the kind of entity type is KIND_MAP, then the phrases specified by entities and excluded phrases should be mutually exclusive.

repeated .google.cloud.dialogflow.cx.v3beta1.EntityType.ExcludedPhrase excluded_phrases = 6;

Returns
Type Description
EntityType.Builder

clearField(Descriptors.FieldDescriptor field)

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

clearKind()

public EntityType.Builder clearKind()

Required. Indicates the kind of entity type.

.google.cloud.dialogflow.cx.v3beta1.EntityType.Kind kind = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
EntityType.Builder

This builder for chaining.

clearName()

public EntityType.Builder clearName()

The unique identifier of the entity type. Required for EntityTypes.UpdateEntityType. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/entityTypes/<EntityTypeID>.

string name = 1;

Returns
Type Description
EntityType.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

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

clearRedact()

public EntityType.Builder clearRedact()

Indicates whether parameters of the entity type should be redacted in log. If redaction is enabled, page parameters and intent parameters referring to the entity type will be replaced by parameter name during logging.

bool redact = 9;

Returns
Type Description
EntityType.Builder

This builder for chaining.

clone()

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

getAutoExpansionMode()

public EntityType.AutoExpansionMode getAutoExpansionMode()

Indicates whether the entity type can be automatically expanded.

.google.cloud.dialogflow.cx.v3beta1.EntityType.AutoExpansionMode auto_expansion_mode = 4;

Returns
Type Description
EntityType.AutoExpansionMode

The autoExpansionMode.

getAutoExpansionModeValue()

public int getAutoExpansionModeValue()

Indicates whether the entity type can be automatically expanded.

.google.cloud.dialogflow.cx.v3beta1.EntityType.AutoExpansionMode auto_expansion_mode = 4;

Returns
Type Description
int

The enum numeric value on the wire for autoExpansionMode.

getDefaultInstanceForType()

public EntityType getDefaultInstanceForType()
Returns
Type Description
EntityType

getDescriptorForType()

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

getDisplayName()

public String getDisplayName()

Required. The human-readable name of the entity type, unique within the agent.

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

Returns
Type Description
String

The displayName.

getDisplayNameBytes()

public ByteString getDisplayNameBytes()

Required. The human-readable name of the entity type, unique within the agent.

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

Returns
Type Description
ByteString

The bytes for displayName.

getEnableFuzzyExtraction()

public boolean getEnableFuzzyExtraction()

Enables fuzzy entity extraction during classification.

bool enable_fuzzy_extraction = 7;

Returns
Type Description
boolean

The enableFuzzyExtraction.

getEntities(int index)

public EntityType.Entity getEntities(int index)

The collection of entity entries associated with the entity type.

repeated .google.cloud.dialogflow.cx.v3beta1.EntityType.Entity entities = 5;

Parameter
Name Description
index int
Returns
Type Description
EntityType.Entity

getEntitiesBuilder(int index)

public EntityType.Entity.Builder getEntitiesBuilder(int index)

The collection of entity entries associated with the entity type.

repeated .google.cloud.dialogflow.cx.v3beta1.EntityType.Entity entities = 5;

Parameter
Name Description
index int
Returns
Type Description
EntityType.Entity.Builder

getEntitiesBuilderList()

public List<EntityType.Entity.Builder> getEntitiesBuilderList()

The collection of entity entries associated with the entity type.

repeated .google.cloud.dialogflow.cx.v3beta1.EntityType.Entity entities = 5;

Returns
Type Description
List<Builder>

getEntitiesCount()

public int getEntitiesCount()

The collection of entity entries associated with the entity type.

repeated .google.cloud.dialogflow.cx.v3beta1.EntityType.Entity entities = 5;

Returns
Type Description
int

getEntitiesList()

public List<EntityType.Entity> getEntitiesList()

The collection of entity entries associated with the entity type.

repeated .google.cloud.dialogflow.cx.v3beta1.EntityType.Entity entities = 5;

Returns
Type Description
List<Entity>

getEntitiesOrBuilder(int index)

public EntityType.EntityOrBuilder getEntitiesOrBuilder(int index)

The collection of entity entries associated with the entity type.

repeated .google.cloud.dialogflow.cx.v3beta1.EntityType.Entity entities = 5;

Parameter
Name Description
index int
Returns
Type Description
EntityType.EntityOrBuilder

getEntitiesOrBuilderList()

public List<? extends EntityType.EntityOrBuilder> getEntitiesOrBuilderList()

The collection of entity entries associated with the entity type.

repeated .google.cloud.dialogflow.cx.v3beta1.EntityType.Entity entities = 5;

Returns
Type Description
List<? extends com.google.cloud.dialogflow.cx.v3beta1.EntityType.EntityOrBuilder>

getExcludedPhrases(int index)

public EntityType.ExcludedPhrase getExcludedPhrases(int index)

Collection of exceptional words and phrases that shouldn't be matched. For example, if you have a size entity type with entry giant(an adjective), you might consider adding giants(a noun) as an exclusion. If the kind of entity type is KIND_MAP, then the phrases specified by entities and excluded phrases should be mutually exclusive.

repeated .google.cloud.dialogflow.cx.v3beta1.EntityType.ExcludedPhrase excluded_phrases = 6;

Parameter
Name Description
index int
Returns
Type Description
EntityType.ExcludedPhrase

getExcludedPhrasesBuilder(int index)

public EntityType.ExcludedPhrase.Builder getExcludedPhrasesBuilder(int index)

Collection of exceptional words and phrases that shouldn't be matched. For example, if you have a size entity type with entry giant(an adjective), you might consider adding giants(a noun) as an exclusion. If the kind of entity type is KIND_MAP, then the phrases specified by entities and excluded phrases should be mutually exclusive.

repeated .google.cloud.dialogflow.cx.v3beta1.EntityType.ExcludedPhrase excluded_phrases = 6;

Parameter
Name Description
index int
Returns
Type Description
EntityType.ExcludedPhrase.Builder

getExcludedPhrasesBuilderList()

public List<EntityType.ExcludedPhrase.Builder> getExcludedPhrasesBuilderList()

Collection of exceptional words and phrases that shouldn't be matched. For example, if you have a size entity type with entry giant(an adjective), you might consider adding giants(a noun) as an exclusion. If the kind of entity type is KIND_MAP, then the phrases specified by entities and excluded phrases should be mutually exclusive.

repeated .google.cloud.dialogflow.cx.v3beta1.EntityType.ExcludedPhrase excluded_phrases = 6;

Returns
Type Description
List<Builder>

getExcludedPhrasesCount()

public int getExcludedPhrasesCount()

Collection of exceptional words and phrases that shouldn't be matched. For example, if you have a size entity type with entry giant(an adjective), you might consider adding giants(a noun) as an exclusion. If the kind of entity type is KIND_MAP, then the phrases specified by entities and excluded phrases should be mutually exclusive.

repeated .google.cloud.dialogflow.cx.v3beta1.EntityType.ExcludedPhrase excluded_phrases = 6;

Returns
Type Description
int

getExcludedPhrasesList()

public List<EntityType.ExcludedPhrase> getExcludedPhrasesList()

Collection of exceptional words and phrases that shouldn't be matched. For example, if you have a size entity type with entry giant(an adjective), you might consider adding giants(a noun) as an exclusion. If the kind of entity type is KIND_MAP, then the phrases specified by entities and excluded phrases should be mutually exclusive.

repeated .google.cloud.dialogflow.cx.v3beta1.EntityType.ExcludedPhrase excluded_phrases = 6;

Returns
Type Description
List<ExcludedPhrase>

getExcludedPhrasesOrBuilder(int index)

public EntityType.ExcludedPhraseOrBuilder getExcludedPhrasesOrBuilder(int index)

Collection of exceptional words and phrases that shouldn't be matched. For example, if you have a size entity type with entry giant(an adjective), you might consider adding giants(a noun) as an exclusion. If the kind of entity type is KIND_MAP, then the phrases specified by entities and excluded phrases should be mutually exclusive.

repeated .google.cloud.dialogflow.cx.v3beta1.EntityType.ExcludedPhrase excluded_phrases = 6;

Parameter
Name Description
index int
Returns
Type Description
EntityType.ExcludedPhraseOrBuilder

getExcludedPhrasesOrBuilderList()

public List<? extends EntityType.ExcludedPhraseOrBuilder> getExcludedPhrasesOrBuilderList()

Collection of exceptional words and phrases that shouldn't be matched. For example, if you have a size entity type with entry giant(an adjective), you might consider adding giants(a noun) as an exclusion. If the kind of entity type is KIND_MAP, then the phrases specified by entities and excluded phrases should be mutually exclusive.

repeated .google.cloud.dialogflow.cx.v3beta1.EntityType.ExcludedPhrase excluded_phrases = 6;

Returns
Type Description
List<? extends com.google.cloud.dialogflow.cx.v3beta1.EntityType.ExcludedPhraseOrBuilder>

getKind()

public EntityType.Kind getKind()

Required. Indicates the kind of entity type.

.google.cloud.dialogflow.cx.v3beta1.EntityType.Kind kind = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
EntityType.Kind

The kind.

getKindValue()

public int getKindValue()

Required. Indicates the kind of entity type.

.google.cloud.dialogflow.cx.v3beta1.EntityType.Kind kind = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
int

The enum numeric value on the wire for kind.

getName()

public String getName()

The unique identifier of the entity type. Required for EntityTypes.UpdateEntityType. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/entityTypes/<EntityTypeID>.

string name = 1;

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

The unique identifier of the entity type. Required for EntityTypes.UpdateEntityType. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/entityTypes/<EntityTypeID>.

string name = 1;

Returns
Type Description
ByteString

The bytes for name.

getRedact()

public boolean getRedact()

Indicates whether parameters of the entity type should be redacted in log. If redaction is enabled, page parameters and intent parameters referring to the entity type will be replaced by parameter name during logging.

bool redact = 9;

Returns
Type Description
boolean

The redact.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(EntityType other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeUnknownFields(UnknownFieldSet unknownFields)

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

removeEntities(int index)

public EntityType.Builder removeEntities(int index)

The collection of entity entries associated with the entity type.

repeated .google.cloud.dialogflow.cx.v3beta1.EntityType.Entity entities = 5;

Parameter
Name Description
index int
Returns
Type Description
EntityType.Builder

removeExcludedPhrases(int index)

public EntityType.Builder removeExcludedPhrases(int index)

Collection of exceptional words and phrases that shouldn't be matched. For example, if you have a size entity type with entry giant(an adjective), you might consider adding giants(a noun) as an exclusion. If the kind of entity type is KIND_MAP, then the phrases specified by entities and excluded phrases should be mutually exclusive.

repeated .google.cloud.dialogflow.cx.v3beta1.EntityType.ExcludedPhrase excluded_phrases = 6;

Parameter
Name Description
index int
Returns
Type Description
EntityType.Builder

setAutoExpansionMode(EntityType.AutoExpansionMode value)

public EntityType.Builder setAutoExpansionMode(EntityType.AutoExpansionMode value)

Indicates whether the entity type can be automatically expanded.

.google.cloud.dialogflow.cx.v3beta1.EntityType.AutoExpansionMode auto_expansion_mode = 4;

Parameter
Name Description
value EntityType.AutoExpansionMode

The autoExpansionMode to set.
Returns
Type Description
EntityType.Builder

This builder for chaining.

setAutoExpansionModeValue(int value)

public EntityType.Builder setAutoExpansionModeValue(int value)

Indicates whether the entity type can be automatically expanded.

.google.cloud.dialogflow.cx.v3beta1.EntityType.AutoExpansionMode auto_expansion_mode = 4;

Parameter
Name Description
value int

The enum numeric value on the wire for autoExpansionMode to set.
Returns
Type Description
EntityType.Builder

This builder for chaining.

setDisplayName(String value)

public EntityType.Builder setDisplayName(String value)

Required. The human-readable name of the entity type, unique within the agent.

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

Parameter
Name Description
value String

The displayName to set.
Returns
Type Description
EntityType.Builder

This builder for chaining.

setDisplayNameBytes(ByteString value)

public EntityType.Builder setDisplayNameBytes(ByteString value)

Required. The human-readable name of the entity type, unique within the agent.

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

Parameter
Name Description
value ByteString

The bytes for displayName to set.
Returns
Type Description
EntityType.Builder

This builder for chaining.

setEnableFuzzyExtraction(boolean value)

public EntityType.Builder setEnableFuzzyExtraction(boolean value)

Enables fuzzy entity extraction during classification.

bool enable_fuzzy_extraction = 7;

Parameter
Name Description
value boolean

The enableFuzzyExtraction to set.
Returns
Type Description
EntityType.Builder

This builder for chaining.

setEntities(int index, EntityType.Entity value)

public EntityType.Builder setEntities(int index, EntityType.Entity value)

The collection of entity entries associated with the entity type.

repeated .google.cloud.dialogflow.cx.v3beta1.EntityType.Entity entities = 5;

Parameters
Name Description
index int
value EntityType.Entity
Returns
Type Description
EntityType.Builder

setEntities(int index, EntityType.Entity.Builder builderForValue)

public EntityType.Builder setEntities(int index, EntityType.Entity.Builder builderForValue)

The collection of entity entries associated with the entity type.

repeated .google.cloud.dialogflow.cx.v3beta1.EntityType.Entity entities = 5;

Parameters
Name Description
index int
builderForValue EntityType.Entity.Builder
Returns
Type Description
EntityType.Builder

setExcludedPhrases(int index, EntityType.ExcludedPhrase value)

public EntityType.Builder setExcludedPhrases(int index, EntityType.ExcludedPhrase value)

Collection of exceptional words and phrases that shouldn't be matched. For example, if you have a size entity type with entry giant(an adjective), you might consider adding giants(a noun) as an exclusion. If the kind of entity type is KIND_MAP, then the phrases specified by entities and excluded phrases should be mutually exclusive.

repeated .google.cloud.dialogflow.cx.v3beta1.EntityType.ExcludedPhrase excluded_phrases = 6;

Parameters
Name Description
index int
value EntityType.ExcludedPhrase
Returns
Type Description
EntityType.Builder

setExcludedPhrases(int index, EntityType.ExcludedPhrase.Builder builderForValue)

public EntityType.Builder setExcludedPhrases(int index, EntityType.ExcludedPhrase.Builder builderForValue)

Collection of exceptional words and phrases that shouldn't be matched. For example, if you have a size entity type with entry giant(an adjective), you might consider adding giants(a noun) as an exclusion. If the kind of entity type is KIND_MAP, then the phrases specified by entities and excluded phrases should be mutually exclusive.

repeated .google.cloud.dialogflow.cx.v3beta1.EntityType.ExcludedPhrase excluded_phrases = 6;

Parameters
Name Description
index int
builderForValue EntityType.ExcludedPhrase.Builder
Returns
Type Description
EntityType.Builder

setField(Descriptors.FieldDescriptor field, Object value)

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

setKind(EntityType.Kind value)

public EntityType.Builder setKind(EntityType.Kind value)

Required. Indicates the kind of entity type.

.google.cloud.dialogflow.cx.v3beta1.EntityType.Kind kind = 3 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value EntityType.Kind

The kind to set.
Returns
Type Description
EntityType.Builder

This builder for chaining.

setKindValue(int value)

public EntityType.Builder setKindValue(int value)

Required. Indicates the kind of entity type.

.google.cloud.dialogflow.cx.v3beta1.EntityType.Kind kind = 3 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value int

The enum numeric value on the wire for kind to set.
Returns
Type Description
EntityType.Builder

This builder for chaining.

setName(String value)

public EntityType.Builder setName(String value)

The unique identifier of the entity type. Required for EntityTypes.UpdateEntityType. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/entityTypes/<EntityTypeID>.

string name = 1;

Parameter
Name Description
value String

The name to set.
Returns
Type Description
EntityType.Builder

This builder for chaining.

setNameBytes(ByteString value)

public EntityType.Builder setNameBytes(ByteString value)

The unique identifier of the entity type. Required for EntityTypes.UpdateEntityType. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/entityTypes/<EntityTypeID>.

string name = 1;

Parameter
Name Description
value ByteString

The bytes for name to set.
Returns
Type Description
EntityType.Builder

This builder for chaining.

setRedact(boolean value)

public EntityType.Builder setRedact(boolean value)

Indicates whether parameters of the entity type should be redacted in log. If redaction is enabled, page parameters and intent parameters referring to the entity type will be replaced by parameter name during logging.

bool redact = 9;

Parameter
Name Description
value boolean

The redact to set.
Returns
Type Description
EntityType.Builder

This builder for chaining.

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

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

setUnknownFields(UnknownFieldSet unknownFields)

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