Package com.google.cloud.dialogflow.v2

Class AutomatedAgentConfig

  • All Implemented Interfaces:
    AutomatedAgentConfigOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    public final class AutomatedAgentConfig
extends com.google.protobuf.GeneratedMessageV3
implements AutomatedAgentConfigOrBuilder
     Defines the Automated Agent to connect to a conversation.
    Protobuf type google.cloud.dialogflow.v2.AutomatedAgentConfig
    See Also:
    Serialized Form

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  AutomatedAgentConfig.Builder
      Defines the Automated Agent to connect to a conversation.

      • 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 AGENT_FIELD_NUMBER  
      static int SESSION_TTL_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()

      • internalGetFieldAccessorTable

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

      • getAgent

        public String getAgent()
         Required. ID of the Dialogflow agent environment to use.

 This project needs to either be the same project as the conversation or you
 need to grant `service-<Conversation Project
 Number>@gcp-sa-dialogflow.iam.gserviceaccount.com` the `Dialogflow API
 Service Agent` role in this project.

 - For ES agents, use format: `projects/<Project ID>/locations/<Location
 ID>/agent/environments/<Environment ID or '-'>`. If environment is not
 specified, the default `draft` environment is used. Refer to
 [DetectIntentRequest](/dialogflow/docs/reference/rpc/google.cloud.dialogflow.v2#google.cloud.dialogflow.v2.DetectIntentRequest)
 for more details.

 - For CX agents, use format `projects/<Project ID>/locations/<Location
 ID>/agents/<Agent ID>/environments/<Environment ID
 or '-'>`. If environment is not specified, the default `draft` environment
 is used.
        string agent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
        Specified by:
        getAgent in interface AutomatedAgentConfigOrBuilder
        Returns:
        The agent.

      • getAgentBytes

        public com.google.protobuf.ByteString getAgentBytes()
         Required. ID of the Dialogflow agent environment to use.

 This project needs to either be the same project as the conversation or you
 need to grant `service-<Conversation Project
 Number>@gcp-sa-dialogflow.iam.gserviceaccount.com` the `Dialogflow API
 Service Agent` role in this project.

 - For ES agents, use format: `projects/<Project ID>/locations/<Location
 ID>/agent/environments/<Environment ID or '-'>`. If environment is not
 specified, the default `draft` environment is used. Refer to
 [DetectIntentRequest](/dialogflow/docs/reference/rpc/google.cloud.dialogflow.v2#google.cloud.dialogflow.v2.DetectIntentRequest)
 for more details.

 - For CX agents, use format `projects/<Project ID>/locations/<Location
 ID>/agents/<Agent ID>/environments/<Environment ID
 or '-'>`. If environment is not specified, the default `draft` environment
 is used.
        string agent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
        Specified by:
        getAgentBytes in interface AutomatedAgentConfigOrBuilder
        Returns:
        The bytes for agent.

      • hasSessionTtl

        public boolean hasSessionTtl()
         Optional. Sets Dialogflow CX session life time.
 By default, a Dialogflow CX session remains active and its data is stored
 for 30 minutes after the last request is sent for the session. This value
 should be no longer than 1 day.
        .google.protobuf.Duration session_ttl = 3 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        hasSessionTtl in interface AutomatedAgentConfigOrBuilder
        Returns:
        Whether the sessionTtl field is set.

      • getSessionTtl

        public com.google.protobuf.Duration getSessionTtl()
         Optional. Sets Dialogflow CX session life time.
 By default, a Dialogflow CX session remains active and its data is stored
 for 30 minutes after the last request is sent for the session. This value
 should be no longer than 1 day.
        .google.protobuf.Duration session_ttl = 3 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getSessionTtl in interface AutomatedAgentConfigOrBuilder
        Returns:
        The sessionTtl.

      • getSessionTtlOrBuilder

        public com.google.protobuf.DurationOrBuilder getSessionTtlOrBuilder()
         Optional. Sets Dialogflow CX session life time.
 By default, a Dialogflow CX session remains active and its data is stored
 for 30 minutes after the last request is sent for the session. This value
 should be no longer than 1 day.
        .google.protobuf.Duration session_ttl = 3 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getSessionTtlOrBuilder in interface AutomatedAgentConfigOrBuilder

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • newBuilderForType

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

      • toBuilder

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

      • newBuilderForType

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

      • getParserForType

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