Package com.google.cloud.dialogflow.v2beta1

Class 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 type google.cloud.dialogflow.v2beta1.EntityType
    See Also:
    Serialized Form

    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.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 class com.google.protobuf.GeneratedMessageV3

      • getName

        public String getName()
         The unique identifier of the entity type.
 Required for
 [EntityTypes.UpdateEntityType][google.cloud.dialogflow.v2beta1.EntityTypes.UpdateEntityType]
 and
 [EntityTypes.BatchUpdateEntityTypes][google.cloud.dialogflow.v2beta1.EntityTypes.BatchUpdateEntityTypes]
 methods. Supported formats:
 - `projects/<Project ID>/agent/entityTypes/<Entity Type ID>`
 - `projects/<Project ID>/locations/<Location ID>/agent/entityTypes/<Entity
   Type ID>`
        string name = 1;
        Specified by:
        getName in interface EntityTypeOrBuilder
        Returns:
        The name.

      • getNameBytes

        public com.google.protobuf.ByteString getNameBytes()
         The unique identifier of the entity type.
 Required for
 [EntityTypes.UpdateEntityType][google.cloud.dialogflow.v2beta1.EntityTypes.UpdateEntityType]
 and
 [EntityTypes.BatchUpdateEntityTypes][google.cloud.dialogflow.v2beta1.EntityTypes.BatchUpdateEntityTypes]
 methods. Supported formats:
 - `projects/<Project ID>/agent/entityTypes/<Entity Type ID>`
 - `projects/<Project ID>/locations/<Location 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 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 interface EntityTypeOrBuilder
        Returns:
        The bytes for displayName.

      • getKindValue

        public int getKindValue()
         Required. Indicates the kind of entity type.
        .google.cloud.dialogflow.v2beta1.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.v2beta1.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.v2beta1.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.v2beta1.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.v2beta1.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.v2beta1.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.v2beta1.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.v2beta1.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.v2beta1.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 com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3

      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
             throws IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        IOException

      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessageV3

      • equals

        public boolean equals​(Object obj)
        Specified by:
        equals in interface com.google.protobuf.Message
        Overrides:
        equals in class com.google.protobuf.AbstractMessage

      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface com.google.protobuf.Message
        Overrides:
        hashCode in class com.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​(com.google.protobuf.CodedInputStream input,
                                   com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                            throws IOException
        Throws:
        IOException

      • newBuilderForType

        public EntityType.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite

      • toBuilder

        public EntityType.Builder toBuilder()
        Specified by:
        toBuilder in interface com.google.protobuf.Message
        Specified by:
        toBuilder in interface com.google.protobuf.MessageLite

      • newBuilderForType

        protected EntityType.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.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 interface com.google.protobuf.Message
        Specified by:
        getParserForType in interface com.google.protobuf.MessageLite
        Overrides:
        getParserForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstanceForType

        public EntityType getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder