Package 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
,com.google.protobuf.Message
,com.google.protobuf.MessageLite
,com.google.protobuf.MessageLiteOrBuilder
,com.google.protobuf.MessageOrBuilder
,Serializable
public final class EntityType extends com.google.protobuf.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 typegoogle.cloud.dialogflow.v2.EntityType
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class 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
com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter
-
-
Field Summary
Fields Modifier and Type Field 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
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
equals(Object obj)
EntityType.AutoExpansionMode
getAutoExpansionMode()
Optional.int
getAutoExpansionModeValue()
Optional.static EntityType
getDefaultInstance()
EntityType
getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor
getDescriptor()
String
getDisplayName()
Required.com.google.protobuf.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.com.google.protobuf.ByteString
getNameBytes()
The unique identifier of the entity type.com.google.protobuf.Parser<EntityType>
getParserForType()
int
getSerializedSize()
int
hashCode()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable
internalGetFieldAccessorTable()
boolean
isInitialized()
static EntityType.Builder
newBuilder()
static EntityType.Builder
newBuilder(EntityType prototype)
EntityType.Builder
newBuilderForType()
protected EntityType.Builder
newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object
newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static EntityType
parseDelimitedFrom(InputStream input)
static EntityType
parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static EntityType
parseFrom(byte[] data)
static EntityType
parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static EntityType
parseFrom(com.google.protobuf.ByteString data)
static EntityType
parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static EntityType
parseFrom(com.google.protobuf.CodedInputStream input)
static EntityType
parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static EntityType
parseFrom(InputStream input)
static EntityType
parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static EntityType
parseFrom(ByteBuffer data)
static EntityType
parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<EntityType>
parser()
EntityType.Builder
toBuilder()
void
writeTo(com.google.protobuf.CodedOutputStream output)
-
Methods inherited from class com.google.protobuf.GeneratedMessageV3
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, 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
-
-
-
-
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(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
- Overrides:
newInstance
in classcom.google.protobuf.GeneratedMessageV3
-
getDescriptor
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
-
internalGetFieldAccessorTable
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
- Specified by:
internalGetFieldAccessorTable
in classcom.google.protobuf.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 interfaceEntityTypeOrBuilder
- Returns:
- The name.
-
getNameBytes
public com.google.protobuf.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 interfaceEntityTypeOrBuilder
- 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 interfaceEntityTypeOrBuilder
- Returns:
- The displayName.
-
getDisplayNameBytes
public com.google.protobuf.ByteString getDisplayNameBytes()
Required. The name of the entity type.
string display_name = 2 [(.google.api.field_behavior) = REQUIRED];
- Specified by:
getDisplayNameBytes
in interfaceEntityTypeOrBuilder
- 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 interfaceEntityTypeOrBuilder
- 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 interfaceEntityTypeOrBuilder
- 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 interfaceEntityTypeOrBuilder
- 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 interfaceEntityTypeOrBuilder
- 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 interfaceEntityTypeOrBuilder
-
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 interfaceEntityTypeOrBuilder
-
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 interfaceEntityTypeOrBuilder
-
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 interfaceEntityTypeOrBuilder
-
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 interfaceEntityTypeOrBuilder
-
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 interfaceEntityTypeOrBuilder
- Returns:
- The enableFuzzyExtraction.
-
isInitialized
public final boolean isInitialized()
- Specified by:
isInitialized
in interfacecom.google.protobuf.MessageLiteOrBuilder
- Overrides:
isInitialized
in classcom.google.protobuf.GeneratedMessageV3
-
writeTo
public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
- Specified by:
writeTo
in interfacecom.google.protobuf.MessageLite
- Overrides:
writeTo
in classcom.google.protobuf.GeneratedMessageV3
- Throws:
IOException
-
getSerializedSize
public int getSerializedSize()
- Specified by:
getSerializedSize
in interfacecom.google.protobuf.MessageLite
- Overrides:
getSerializedSize
in classcom.google.protobuf.GeneratedMessageV3
-
equals
public boolean equals(Object obj)
- Specified by:
equals
in interfacecom.google.protobuf.Message
- Overrides:
equals
in classcom.google.protobuf.AbstractMessage
-
hashCode
public int hashCode()
- Specified by:
hashCode
in interfacecom.google.protobuf.Message
- Overrides:
hashCode
in classcom.google.protobuf.AbstractMessage
-
parseFrom
public static EntityType parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static EntityType parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static EntityType parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static EntityType parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static EntityType parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static EntityType parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static EntityType parseFrom(InputStream input) throws IOException
- Throws:
IOException
-
parseFrom
public static EntityType parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
- Throws:
IOException
-
parseDelimitedFrom
public static EntityType parseDelimitedFrom(InputStream input) throws IOException
- Throws:
IOException
-
parseDelimitedFrom
public static EntityType parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
- Throws:
IOException
-
parseFrom
public static EntityType parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
- Throws:
IOException
-
parseFrom
public static EntityType parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
- Throws:
IOException
-
newBuilderForType
public EntityType.Builder newBuilderForType()
- Specified by:
newBuilderForType
in interfacecom.google.protobuf.Message
- Specified by:
newBuilderForType
in interfacecom.google.protobuf.MessageLite
-
newBuilder
public static EntityType.Builder newBuilder()
-
newBuilder
public static EntityType.Builder newBuilder(EntityType prototype)
-
toBuilder
public EntityType.Builder toBuilder()
- Specified by:
toBuilder
in interfacecom.google.protobuf.Message
- Specified by:
toBuilder
in interfacecom.google.protobuf.MessageLite
-
newBuilderForType
protected EntityType.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
- Specified by:
newBuilderForType
in classcom.google.protobuf.GeneratedMessageV3
-
getDefaultInstance
public static EntityType getDefaultInstance()
-
parser
public static com.google.protobuf.Parser<EntityType> parser()
-
getParserForType
public com.google.protobuf.Parser<EntityType> getParserForType()
- Specified by:
getParserForType
in interfacecom.google.protobuf.Message
- Specified by:
getParserForType
in interfacecom.google.protobuf.MessageLite
- Overrides:
getParserForType
in classcom.google.protobuf.GeneratedMessageV3
-
getDefaultInstanceForType
public EntityType getDefaultInstanceForType()
- Specified by:
getDefaultInstanceForType
in interfacecom.google.protobuf.MessageLiteOrBuilder
- Specified by:
getDefaultInstanceForType
in interfacecom.google.protobuf.MessageOrBuilder
-
-