com.google.cloud.dialogflow.v2

Class EntityType

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

com.google.cloud.dialogflow.v2.EntityType

All Implemented Interfaces:

EntityTypeOrBuilder, Message, MessageLite, MessageLiteOrBuilder, MessageOrBuilder, Serializable

public final class EntityType
extends GeneratedMessageV3
implements EntityTypeOrBuilder

 Each intent parameter has a type, called the entity type, which dictates
 exactly how data from an end-user expression is extracted.
 Dialogflow provides predefined system entities that can match many common
 types of data. For example, there are system entities for matching dates,
 times, colors, email addresses, and so on. You can also create your own
 custom entities for matching custom data. For example, you could define a
 vegetable entity that can match the types of vegetables available for
 purchase with a grocery store agent.
 For more information, see the
 [Entity guide](https://cloud.google.com/dialogflow/docs/entities-overview).
 

Protobuf type google.cloud.dialogflow.v2.EntityType

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	EntityType.AutoExpansionMode Represents different entity type expansion modes.
static class	EntityType.Builder Each intent parameter has a type, called the entity type, which dictates exactly how data from an end-user expression is extracted.
static class	EntityType.Entity An **entity entry** for an associated entity type.
static interface	EntityType.EntityOrBuilder
static class	EntityType.Kind Represents kinds of entities.

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

GeneratedMessageV3.BuilderParent, GeneratedMessageV3.ExtendableBuilder<MessageType extends GeneratedMessageV3.ExtendableMessage,BuilderType extends GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, GeneratedMessageV3.ExtendableMessage<MessageType extends GeneratedMessageV3.ExtendableMessage>, GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends GeneratedMessageV3.ExtendableMessage>, GeneratedMessageV3.FieldAccessorTable, GeneratedMessageV3.UnusedPrivateParameter

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields

Modifier and Type	Field and Description
static int	AUTO_EXPANSION_MODE_FIELD_NUMBER
static int	DISPLAY_NAME_FIELD_NUMBER
static int	ENABLE_FUZZY_EXTRACTION_FIELD_NUMBER
static int	ENTITIES_FIELD_NUMBER
static int	KIND_FIELD_NUMBER
static int	NAME_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
EntityType.AutoExpansionMode	getAutoExpansionMode() Optional.
int	getAutoExpansionModeValue() Optional.
static EntityType	getDefaultInstance()
EntityType	getDefaultInstanceForType()
static Descriptors.Descriptor	getDescriptor()
String	getDisplayName() Required.
ByteString	getDisplayNameBytes() Required.
boolean	getEnableFuzzyExtraction() Optional.
EntityType.Entity	getEntities(int index) Optional.
int	getEntitiesCount() Optional.
List<EntityType.Entity>	getEntitiesList() Optional.
EntityType.EntityOrBuilder	getEntitiesOrBuilder(int index) Optional.
List<? extends EntityType.EntityOrBuilder>	getEntitiesOrBuilderList() Optional.
EntityType.Kind	getKind() Required.
int	getKindValue() Required.
String	getName() The unique identifier of the entity type.
ByteString	getNameBytes() The unique identifier of the entity type.
Parser<EntityType>	getParserForType()
int	getSerializedSize()
UnknownFieldSet	getUnknownFields()
int	hashCode()
protected GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static EntityType.Builder	newBuilder()
static EntityType.Builder	newBuilder(EntityType prototype)
EntityType.Builder	newBuilderForType()
protected EntityType.Builder	newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
static EntityType	parseDelimitedFrom(InputStream input)
static EntityType	parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
static EntityType	parseFrom(byte[] data)
static EntityType	parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
static EntityType	parseFrom(ByteBuffer data)
static EntityType	parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
static EntityType	parseFrom(ByteString data)
static EntityType	parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
static EntityType	parseFrom(CodedInputStream input)
static EntityType	parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
static EntityType	parseFrom(InputStream input)
static EntityType	parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
static Parser<EntityType>	parser()
EntityType.Builder	toBuilder()
void	writeTo(CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, makeExtensionsImmutable, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER

See Also:

Constant Field Values

DISPLAY_NAME_FIELD_NUMBER

public static final int DISPLAY_NAME_FIELD_NUMBER

See Also:

Constant Field Values

KIND_FIELD_NUMBER

public static final int KIND_FIELD_NUMBER

See Also:

Constant Field Values

AUTO_EXPANSION_MODE_FIELD_NUMBER

public static final int AUTO_EXPANSION_MODE_FIELD_NUMBER

See Also:

Constant Field Values

ENTITIES_FIELD_NUMBER

public static final int ENTITIES_FIELD_NUMBER

See Also:

Constant Field Values

ENABLE_FUZZY_EXTRACTION_FIELD_NUMBER

public static final int ENABLE_FUZZY_EXTRACTION_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

newInstance

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:

newInstance in class GeneratedMessageV3

getUnknownFields

public final UnknownFieldSet getUnknownFields()

Specified by:

getUnknownFields in interface MessageOrBuilder

Overrides:

getUnknownFields in class GeneratedMessageV3

getDescriptor

public static final Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class GeneratedMessageV3

getName

public String getName()

 The unique identifier of the entity type.
 Required for [EntityTypes.UpdateEntityType][google.cloud.dialogflow.v2.EntityTypes.UpdateEntityType] and
 [EntityTypes.BatchUpdateEntityTypes][google.cloud.dialogflow.v2.EntityTypes.BatchUpdateEntityTypes] methods.
 Format: `projects/<Project ID>/agent/entityTypes/<Entity Type ID>`.
 

string name = 1;

Specified by:

getName in interface EntityTypeOrBuilder

Returns:

The name.

getNameBytes

public ByteString getNameBytes()

 The unique identifier of the entity type.
 Required for [EntityTypes.UpdateEntityType][google.cloud.dialogflow.v2.EntityTypes.UpdateEntityType] and
 [EntityTypes.BatchUpdateEntityTypes][google.cloud.dialogflow.v2.EntityTypes.BatchUpdateEntityTypes] methods.
 Format: `projects/<Project ID>/agent/entityTypes/<Entity Type ID>`.
 

string name = 1;

Specified by:

getNameBytes in interface EntityTypeOrBuilder

Returns:

The bytes for name.

getDisplayName

public String getDisplayName()

 Required. The name of the entity type.
 

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

Specified by:

getDisplayName in interface EntityTypeOrBuilder

Returns:

The displayName.

getDisplayNameBytes

public ByteString getDisplayNameBytes()

 Required. The name of the entity type.
 

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

Specified by:

getDisplayNameBytes in interface EntityTypeOrBuilder

Returns:

The bytes for displayName.

getKindValue

public int getKindValue()

 Required. Indicates the kind of entity type.
 

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

Specified by:

getKindValue in interface EntityTypeOrBuilder

Returns:

The enum numeric value on the wire for kind.

getKind

public EntityType.Kind getKind()

 Required. Indicates the kind of entity type.
 

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

Specified by:

getKind in interface EntityTypeOrBuilder

Returns:

The kind.

getAutoExpansionModeValue

public int getAutoExpansionModeValue()

 Optional. Indicates whether the entity type can be automatically
 expanded.
 

.google.cloud.dialogflow.v2.EntityType.AutoExpansionMode auto_expansion_mode = 4 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

getAutoExpansionModeValue in interface EntityTypeOrBuilder

Returns:

The enum numeric value on the wire for autoExpansionMode.

getAutoExpansionMode

public EntityType.AutoExpansionMode getAutoExpansionMode()

 Optional. Indicates whether the entity type can be automatically
 expanded.
 

.google.cloud.dialogflow.v2.EntityType.AutoExpansionMode auto_expansion_mode = 4 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

getAutoExpansionMode in interface EntityTypeOrBuilder

Returns:

The autoExpansionMode.

getEntitiesList

public List<EntityType.Entity> getEntitiesList()

 Optional. The collection of entity entries associated with the entity type.
 

repeated .google.cloud.dialogflow.v2.EntityType.Entity entities = 6 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

getEntitiesList in interface EntityTypeOrBuilder

getEntitiesOrBuilderList

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

 Optional. The collection of entity entries associated with the entity type.
 

repeated .google.cloud.dialogflow.v2.EntityType.Entity entities = 6 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

getEntitiesOrBuilderList in interface EntityTypeOrBuilder

getEntitiesCount

public int getEntitiesCount()

 Optional. The collection of entity entries associated with the entity type.
 

repeated .google.cloud.dialogflow.v2.EntityType.Entity entities = 6 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

getEntitiesCount in interface EntityTypeOrBuilder

getEntities

public EntityType.Entity getEntities(int index)

 Optional. The collection of entity entries associated with the entity type.
 

repeated .google.cloud.dialogflow.v2.EntityType.Entity entities = 6 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

getEntities in interface EntityTypeOrBuilder

getEntitiesOrBuilder

public EntityType.EntityOrBuilder getEntitiesOrBuilder(int index)

 Optional. The collection of entity entries associated with the entity type.
 

repeated .google.cloud.dialogflow.v2.EntityType.Entity entities = 6 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

getEntitiesOrBuilder in interface EntityTypeOrBuilder

getEnableFuzzyExtraction

public boolean getEnableFuzzyExtraction()

 Optional. Enables fuzzy entity extraction during classification.
 

bool enable_fuzzy_extraction = 7 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

getEnableFuzzyExtraction in interface EntityTypeOrBuilder

Returns:

The enableFuzzyExtraction.

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface MessageLiteOrBuilder

Overrides:

isInitialized in class GeneratedMessageV3

writeTo

public void writeTo(CodedOutputStream output)
             throws IOException

Specified by:

writeTo in interface MessageLite

Overrides:

writeTo in class GeneratedMessageV3

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface MessageLite

Overrides:

getSerializedSize in class GeneratedMessageV3

equals

public boolean equals(Object obj)

Specified by:

equals in interface Message

Overrides:

equals in class AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface Message

Overrides:

hashCode in class AbstractMessage

parseFrom

public static EntityType parseFrom(ByteBuffer data)
                            throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static EntityType parseFrom(ByteBuffer data,
                                   ExtensionRegistryLite extensionRegistry)
                            throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static EntityType parseFrom(ByteString data)
                            throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static EntityType parseFrom(ByteString data,
                                   ExtensionRegistryLite extensionRegistry)
                            throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static EntityType parseFrom(byte[] data)
                            throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static EntityType parseFrom(byte[] data,
                                   ExtensionRegistryLite extensionRegistry)
                            throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static EntityType parseFrom(InputStream input)
                            throws IOException

Throws:

IOException

parseFrom

public static EntityType parseFrom(InputStream input,
                                   ExtensionRegistryLite extensionRegistry)
                            throws IOException

Throws:

IOException

parseDelimitedFrom

public static EntityType parseDelimitedFrom(InputStream input)
                                     throws IOException

Throws:

IOException

parseDelimitedFrom

public static EntityType parseDelimitedFrom(InputStream input,
                                            ExtensionRegistryLite extensionRegistry)
                                     throws IOException

Throws:

IOException

parseFrom

public static EntityType parseFrom(CodedInputStream input)
                            throws IOException

Throws:

IOException

parseFrom

public static EntityType parseFrom(CodedInputStream input,
                                   ExtensionRegistryLite extensionRegistry)
                            throws IOException

Throws:

IOException

newBuilderForType

public EntityType.Builder newBuilderForType()

Specified by:

newBuilderForType in interface Message

Specified by:

newBuilderForType in interface MessageLite

newBuilder

public static EntityType.Builder newBuilder()

newBuilder

public static EntityType.Builder newBuilder(EntityType prototype)

toBuilder

public EntityType.Builder toBuilder()

Specified by:

toBuilder in interface Message

Specified by:

toBuilder in interface MessageLite

newBuilderForType

protected EntityType.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class GeneratedMessageV3

getDefaultInstance

public static EntityType getDefaultInstance()

parser

public static Parser<EntityType> parser()

getParserForType

public Parser<EntityType> getParserForType()

Specified by:

getParserForType in interface Message

Specified by:

getParserForType in interface MessageLite

Overrides:

getParserForType in class GeneratedMessageV3

getDefaultInstanceForType

public EntityType getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface MessageOrBuilder