Package com.google.cloud.dialogflow.v2

Class SessionEntityType

  • All Implemented Interfaces:
    SessionEntityTypeOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    public final class SessionEntityType
extends com.google.protobuf.GeneratedMessageV3
implements SessionEntityTypeOrBuilder
     A session represents a conversation between a Dialogflow agent and an
 end-user. You can create special entities, called session entities, during a
 session. Session entities can extend or replace custom entity types and only
 exist during the session that they were created for. All session data,
 including session entities, is stored by Dialogflow for 20 minutes.

 For more information, see the [session entity
 guide](https://cloud.google.com/dialogflow/docs/entities-session).
    Protobuf type google.cloud.dialogflow.v2.SessionEntityType
    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()
         Required. The unique identifier of this session entity type. Format:
 `projects/<Project ID>/agent/sessions/<Session ID>/entityTypes/<Entity Type
 Display Name>`, or `projects/<Project ID>/agent/environments/<Environment
 ID>/users/<User ID>/sessions/<Session ID>/entityTypes/<Entity Type Display
 Name>`.
 If `Environment ID` is not specified, we assume default 'draft'
 environment. If `User ID` is not specified, we assume default '-' user.

 `<Entity Type Display Name>` must be the display name of an existing entity
 type in the same agent that will be overridden or supplemented.
        string name = 1 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getName in interface SessionEntityTypeOrBuilder
        Returns:
        The name.

      • getNameBytes

        public com.google.protobuf.ByteString getNameBytes()
         Required. The unique identifier of this session entity type. Format:
 `projects/<Project ID>/agent/sessions/<Session ID>/entityTypes/<Entity Type
 Display Name>`, or `projects/<Project ID>/agent/environments/<Environment
 ID>/users/<User ID>/sessions/<Session ID>/entityTypes/<Entity Type Display
 Name>`.
 If `Environment ID` is not specified, we assume default 'draft'
 environment. If `User ID` is not specified, we assume default '-' user.

 `<Entity Type Display Name>` must be the display name of an existing entity
 type in the same agent that will be overridden or supplemented.
        string name = 1 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getNameBytes in interface SessionEntityTypeOrBuilder
        Returns:
        The bytes for name.

      • getEntityOverrideModeValue

        public int getEntityOverrideModeValue()
         Required. Indicates whether the additional data should override or
 supplement the custom entity type definition.
        .google.cloud.dialogflow.v2.SessionEntityType.EntityOverrideMode entity_override_mode = 2 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getEntityOverrideModeValue in interface SessionEntityTypeOrBuilder
        Returns:
        The enum numeric value on the wire for entityOverrideMode.

      • getEntityOverrideMode

        public SessionEntityType.EntityOverrideMode getEntityOverrideMode()
         Required. Indicates whether the additional data should override or
 supplement the custom entity type definition.
        .google.cloud.dialogflow.v2.SessionEntityType.EntityOverrideMode entity_override_mode = 2 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getEntityOverrideMode in interface SessionEntityTypeOrBuilder
        Returns:
        The entityOverrideMode.

      • getEntitiesList

        public List<EntityType.Entity> getEntitiesList()
         Required. The collection of entities associated with this session entity
 type.
        repeated .google.cloud.dialogflow.v2.EntityType.Entity entities = 3 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getEntitiesList in interface SessionEntityTypeOrBuilder

      • getEntitiesCount

        public int getEntitiesCount()
         Required. The collection of entities associated with this session entity
 type.
        repeated .google.cloud.dialogflow.v2.EntityType.Entity entities = 3 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getEntitiesCount in interface SessionEntityTypeOrBuilder

      • getEntities

        public EntityType.Entity getEntities​(int index)
         Required. The collection of entities associated with this session entity
 type.
        repeated .google.cloud.dialogflow.v2.EntityType.Entity entities = 3 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getEntities in interface SessionEntityTypeOrBuilder

      • getEntitiesOrBuilder

        public EntityType.EntityOrBuilder getEntitiesOrBuilder​(int index)
         Required. The collection of entities associated with this session entity
 type.
        repeated .google.cloud.dialogflow.v2.EntityType.Entity entities = 3 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getEntitiesOrBuilder in interface SessionEntityTypeOrBuilder

      • 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 SessionEntityType parseFrom​(ByteBuffer data)
                                   throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static SessionEntityType parseFrom​(ByteBuffer data,
                                          com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                   throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static SessionEntityType parseFrom​(com.google.protobuf.ByteString data)
                                   throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static SessionEntityType parseFrom​(com.google.protobuf.ByteString data,
                                          com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                   throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static SessionEntityType parseFrom​(byte[] data)
                                   throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static SessionEntityType parseFrom​(byte[] data,
                                          com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                   throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static SessionEntityType parseFrom​(com.google.protobuf.CodedInputStream input,
                                          com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                   throws IOException
        Throws:
        IOException

      • newBuilderForType

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

      • toBuilder

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

      • newBuilderForType

        protected SessionEntityType.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • getParserForType

        public com.google.protobuf.Parser<SessionEntityType> 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 SessionEntityType getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder