Class SessionInfo

  • All Implemented Interfaces:
    SessionInfoOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

    public final class SessionInfo
    extends com.google.protobuf.GeneratedMessageV3
    implements SessionInfoOrBuilder
     Represents session information communicated to and from the webhook.
     
    Protobuf type google.cloud.dialogflow.cx.v3.SessionInfo
    See Also:
    Serialized Form
    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  SessionInfo.Builder
      Represents session information communicated to and from the webhook.
      • 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
      • Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

        com.google.protobuf.AbstractMessageLite.InternalOneOfEnum
    • Field Summary

      Fields 
      Modifier and Type Field Description
      static int PARAMETERS_FIELD_NUMBER  
      static int SESSION_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 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()
      • internalGetMapField

        protected com.google.protobuf.MapField internalGetMapField​(int number)
        Overrides:
        internalGetMapField in class com.google.protobuf.GeneratedMessageV3
      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3
      • getSession

        public String getSession()
         Always present for
         [WebhookRequest][google.cloud.dialogflow.cx.v3.WebhookRequest]. Ignored for
         [WebhookResponse][google.cloud.dialogflow.cx.v3.WebhookResponse]. The
         unique identifier of the
         [session][google.cloud.dialogflow.cx.v3.DetectIntentRequest.session]. This
         field can be used by the webhook to identify a session.
         Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
         ID>/sessions/<Session ID>` or `projects/<Project ID>/locations/<Location
         ID>/agents/<Agent ID>/environments/<Environment ID>/sessions/<Session ID>`
         if environment is specified.
         
        string session = 1 [(.google.api.resource_reference) = { ... }
        Specified by:
        getSession in interface SessionInfoOrBuilder
        Returns:
        The session.
      • getSessionBytes

        public com.google.protobuf.ByteString getSessionBytes()
         Always present for
         [WebhookRequest][google.cloud.dialogflow.cx.v3.WebhookRequest]. Ignored for
         [WebhookResponse][google.cloud.dialogflow.cx.v3.WebhookResponse]. The
         unique identifier of the
         [session][google.cloud.dialogflow.cx.v3.DetectIntentRequest.session]. This
         field can be used by the webhook to identify a session.
         Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
         ID>/sessions/<Session ID>` or `projects/<Project ID>/locations/<Location
         ID>/agents/<Agent ID>/environments/<Environment ID>/sessions/<Session ID>`
         if environment is specified.
         
        string session = 1 [(.google.api.resource_reference) = { ... }
        Specified by:
        getSessionBytes in interface SessionInfoOrBuilder
        Returns:
        The bytes for session.
      • getParametersCount

        public int getParametersCount()
        Description copied from interface: SessionInfoOrBuilder
         Optional for
         [WebhookRequest][google.cloud.dialogflow.cx.v3.WebhookRequest]. Optional
         for [WebhookResponse][google.cloud.dialogflow.cx.v3.WebhookResponse]. All
         parameters collected from forms and intents during the session. Parameters
         can be created, updated, or removed by the webhook. To remove a parameter
         from the session, the webhook should explicitly set the parameter value to
         null in [WebhookResponse][google.cloud.dialogflow.cx.v3.WebhookResponse].
         The map is keyed by parameters' display names.
         
        map<string, .google.protobuf.Value> parameters = 2;
        Specified by:
        getParametersCount in interface SessionInfoOrBuilder
      • containsParameters

        public boolean containsParameters​(String key)
         Optional for
         [WebhookRequest][google.cloud.dialogflow.cx.v3.WebhookRequest]. Optional
         for [WebhookResponse][google.cloud.dialogflow.cx.v3.WebhookResponse]. All
         parameters collected from forms and intents during the session. Parameters
         can be created, updated, or removed by the webhook. To remove a parameter
         from the session, the webhook should explicitly set the parameter value to
         null in [WebhookResponse][google.cloud.dialogflow.cx.v3.WebhookResponse].
         The map is keyed by parameters' display names.
         
        map<string, .google.protobuf.Value> parameters = 2;
        Specified by:
        containsParameters in interface SessionInfoOrBuilder
      • getParametersMap

        public Map<String,​com.google.protobuf.Value> getParametersMap()
         Optional for
         [WebhookRequest][google.cloud.dialogflow.cx.v3.WebhookRequest]. Optional
         for [WebhookResponse][google.cloud.dialogflow.cx.v3.WebhookResponse]. All
         parameters collected from forms and intents during the session. Parameters
         can be created, updated, or removed by the webhook. To remove a parameter
         from the session, the webhook should explicitly set the parameter value to
         null in [WebhookResponse][google.cloud.dialogflow.cx.v3.WebhookResponse].
         The map is keyed by parameters' display names.
         
        map<string, .google.protobuf.Value> parameters = 2;
        Specified by:
        getParametersMap in interface SessionInfoOrBuilder
      • getParametersOrDefault

        public com.google.protobuf.Value getParametersOrDefault​(String key,
                                                                com.google.protobuf.Value defaultValue)
         Optional for
         [WebhookRequest][google.cloud.dialogflow.cx.v3.WebhookRequest]. Optional
         for [WebhookResponse][google.cloud.dialogflow.cx.v3.WebhookResponse]. All
         parameters collected from forms and intents during the session. Parameters
         can be created, updated, or removed by the webhook. To remove a parameter
         from the session, the webhook should explicitly set the parameter value to
         null in [WebhookResponse][google.cloud.dialogflow.cx.v3.WebhookResponse].
         The map is keyed by parameters' display names.
         
        map<string, .google.protobuf.Value> parameters = 2;
        Specified by:
        getParametersOrDefault in interface SessionInfoOrBuilder
      • getParametersOrThrow

        public com.google.protobuf.Value getParametersOrThrow​(String key)
         Optional for
         [WebhookRequest][google.cloud.dialogflow.cx.v3.WebhookRequest]. Optional
         for [WebhookResponse][google.cloud.dialogflow.cx.v3.WebhookResponse]. All
         parameters collected from forms and intents during the session. Parameters
         can be created, updated, or removed by the webhook. To remove a parameter
         from the session, the webhook should explicitly set the parameter value to
         null in [WebhookResponse][google.cloud.dialogflow.cx.v3.WebhookResponse].
         The map is keyed by parameters' display names.
         
        map<string, .google.protobuf.Value> parameters = 2;
        Specified by:
        getParametersOrThrow in interface SessionInfoOrBuilder
      • 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 SessionInfo parseFrom​(ByteBuffer data)
                                     throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

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

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

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

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

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

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

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

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

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

        public static SessionInfo getDefaultInstance()
      • parser

        public static com.google.protobuf.Parser<SessionInfo> parser()
      • getParserForType

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