Package com.google.cloud.dialogflow.v2

Class ConversationProfile

  • All Implemented Interfaces:
    ConversationProfileOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    public final class ConversationProfile
extends com.google.protobuf.GeneratedMessageV3
implements ConversationProfileOrBuilder
     Defines the services to connect to incoming Dialogflow conversations.
    Protobuf type google.cloud.dialogflow.v2.ConversationProfile
    See Also:
    Serialized Form

    • Field Detail

      • DISPLAY_NAME_FIELD_NUMBER

        public static final int DISPLAY_NAME_FIELD_NUMBER
        See Also:
        Constant Field Values

      • CREATE_TIME_FIELD_NUMBER

        public static final int CREATE_TIME_FIELD_NUMBER
        See Also:
        Constant Field Values

      • UPDATE_TIME_FIELD_NUMBER

        public static final int UPDATE_TIME_FIELD_NUMBER
        See Also:
        Constant Field Values

      • AUTOMATED_AGENT_CONFIG_FIELD_NUMBER

        public static final int AUTOMATED_AGENT_CONFIG_FIELD_NUMBER
        See Also:
        Constant Field Values

      • HUMAN_AGENT_ASSISTANT_CONFIG_FIELD_NUMBER

        public static final int HUMAN_AGENT_ASSISTANT_CONFIG_FIELD_NUMBER
        See Also:
        Constant Field Values

      • HUMAN_AGENT_HANDOFF_CONFIG_FIELD_NUMBER

        public static final int HUMAN_AGENT_HANDOFF_CONFIG_FIELD_NUMBER
        See Also:
        Constant Field Values

      • NOTIFICATION_CONFIG_FIELD_NUMBER

        public static final int NOTIFICATION_CONFIG_FIELD_NUMBER
        See Also:
        Constant Field Values

      • LOGGING_CONFIG_FIELD_NUMBER

        public static final int LOGGING_CONFIG_FIELD_NUMBER
        See Also:
        Constant Field Values

      • NEW_MESSAGE_EVENT_NOTIFICATION_CONFIG_FIELD_NUMBER

        public static final int NEW_MESSAGE_EVENT_NOTIFICATION_CONFIG_FIELD_NUMBER
        See Also:
        Constant Field Values

      • STT_CONFIG_FIELD_NUMBER

        public static final int STT_CONFIG_FIELD_NUMBER
        See Also:
        Constant Field Values

      • LANGUAGE_CODE_FIELD_NUMBER

        public static final int LANGUAGE_CODE_FIELD_NUMBER
        See Also:
        Constant Field Values

      • SECURITY_SETTINGS_FIELD_NUMBER

        public static final int SECURITY_SETTINGS_FIELD_NUMBER
        See Also:
        Constant Field Values

      • TTS_CONFIG_FIELD_NUMBER

        public static final int TTS_CONFIG_FIELD_NUMBER
        See Also:
        Constant Field Values

    • 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 this conversation profile.
 Format: `projects/<Project ID>/locations/<Location
 ID>/conversationProfiles/<Conversation Profile ID>`.
        string name = 1;
        Specified by:
        getName in interface ConversationProfileOrBuilder
        Returns:
        The name.

      • getNameBytes

        public com.google.protobuf.ByteString getNameBytes()
         The unique identifier of this conversation profile.
 Format: `projects/<Project ID>/locations/<Location
 ID>/conversationProfiles/<Conversation Profile ID>`.
        string name = 1;
        Specified by:
        getNameBytes in interface ConversationProfileOrBuilder
        Returns:
        The bytes for name.

      • getDisplayName

        public String getDisplayName()
         Required. Human readable name for this profile. Max length 1024 bytes.
        string display_name = 2 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getDisplayName in interface ConversationProfileOrBuilder
        Returns:
        The displayName.

      • getDisplayNameBytes

        public com.google.protobuf.ByteString getDisplayNameBytes()
         Required. Human readable name for this profile. Max length 1024 bytes.
        string display_name = 2 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getDisplayNameBytes in interface ConversationProfileOrBuilder
        Returns:
        The bytes for displayName.

      • hasCreateTime

        public boolean hasCreateTime()
         Output only. Create time of the conversation profile.
        .google.protobuf.Timestamp create_time = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        hasCreateTime in interface ConversationProfileOrBuilder
        Returns:
        Whether the createTime field is set.

      • getCreateTime

        public com.google.protobuf.Timestamp getCreateTime()
         Output only. Create time of the conversation profile.
        .google.protobuf.Timestamp create_time = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getCreateTime in interface ConversationProfileOrBuilder
        Returns:
        The createTime.

      • getCreateTimeOrBuilder

        public com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()
         Output only. Create time of the conversation profile.
        .google.protobuf.Timestamp create_time = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getCreateTimeOrBuilder in interface ConversationProfileOrBuilder

      • hasUpdateTime

        public boolean hasUpdateTime()
         Output only. Update time of the conversation profile.
        .google.protobuf.Timestamp update_time = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        hasUpdateTime in interface ConversationProfileOrBuilder
        Returns:
        Whether the updateTime field is set.

      • getUpdateTime

        public com.google.protobuf.Timestamp getUpdateTime()
         Output only. Update time of the conversation profile.
        .google.protobuf.Timestamp update_time = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getUpdateTime in interface ConversationProfileOrBuilder
        Returns:
        The updateTime.

      • getUpdateTimeOrBuilder

        public com.google.protobuf.TimestampOrBuilder getUpdateTimeOrBuilder()
         Output only. Update time of the conversation profile.
        .google.protobuf.Timestamp update_time = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getUpdateTimeOrBuilder in interface ConversationProfileOrBuilder

      • hasAutomatedAgentConfig

        public boolean hasAutomatedAgentConfig()
         Configuration for an automated agent to use with this profile.
        .google.cloud.dialogflow.v2.AutomatedAgentConfig automated_agent_config = 3;
        Specified by:
        hasAutomatedAgentConfig in interface ConversationProfileOrBuilder
        Returns:
        Whether the automatedAgentConfig field is set.

      • hasHumanAgentAssistantConfig

        public boolean hasHumanAgentAssistantConfig()
         Configuration for agent assistance to use with this profile.
        .google.cloud.dialogflow.v2.HumanAgentAssistantConfig human_agent_assistant_config = 4;
        Specified by:
        hasHumanAgentAssistantConfig in interface ConversationProfileOrBuilder
        Returns:
        Whether the humanAgentAssistantConfig field is set.

      • hasHumanAgentHandoffConfig

        public boolean hasHumanAgentHandoffConfig()
         Configuration for connecting to a live agent.

 Currently, this feature is not general available, please contact Google
 to get access.
        .google.cloud.dialogflow.v2.HumanAgentHandoffConfig human_agent_handoff_config = 5;
        Specified by:
        hasHumanAgentHandoffConfig in interface ConversationProfileOrBuilder
        Returns:
        Whether the humanAgentHandoffConfig field is set.

      • getHumanAgentHandoffConfig

        public HumanAgentHandoffConfig getHumanAgentHandoffConfig()
         Configuration for connecting to a live agent.

 Currently, this feature is not general available, please contact Google
 to get access.
        .google.cloud.dialogflow.v2.HumanAgentHandoffConfig human_agent_handoff_config = 5;
        Specified by:
        getHumanAgentHandoffConfig in interface ConversationProfileOrBuilder
        Returns:
        The humanAgentHandoffConfig.

      • hasNotificationConfig

        public boolean hasNotificationConfig()
         Configuration for publishing conversation lifecycle events.
        .google.cloud.dialogflow.v2.NotificationConfig notification_config = 6;
        Specified by:
        hasNotificationConfig in interface ConversationProfileOrBuilder
        Returns:
        Whether the notificationConfig field is set.

      • hasLoggingConfig

        public boolean hasLoggingConfig()
         Configuration for logging conversation lifecycle events.
        .google.cloud.dialogflow.v2.LoggingConfig logging_config = 7;
        Specified by:
        hasLoggingConfig in interface ConversationProfileOrBuilder
        Returns:
        Whether the loggingConfig field is set.

      • hasNewMessageEventNotificationConfig

        public boolean hasNewMessageEventNotificationConfig()
         Configuration for publishing new message events. Event will be sent in
 format of [ConversationEvent][google.cloud.dialogflow.v2.ConversationEvent]
        .google.cloud.dialogflow.v2.NotificationConfig new_message_event_notification_config = 8;
        Specified by:
        hasNewMessageEventNotificationConfig in interface ConversationProfileOrBuilder
        Returns:
        Whether the newMessageEventNotificationConfig field is set.

      • getNewMessageEventNotificationConfig

        public NotificationConfig getNewMessageEventNotificationConfig()
         Configuration for publishing new message events. Event will be sent in
 format of [ConversationEvent][google.cloud.dialogflow.v2.ConversationEvent]
        .google.cloud.dialogflow.v2.NotificationConfig new_message_event_notification_config = 8;
        Specified by:
        getNewMessageEventNotificationConfig in interface ConversationProfileOrBuilder
        Returns:
        The newMessageEventNotificationConfig.

      • hasSttConfig

        public boolean hasSttConfig()
         Settings for speech transcription.
        .google.cloud.dialogflow.v2.SpeechToTextConfig stt_config = 9;
        Specified by:
        hasSttConfig in interface ConversationProfileOrBuilder
        Returns:
        Whether the sttConfig field is set.

      • getLanguageCode

        public String getLanguageCode()
         Language code for the conversation profile. If not specified, the language
 is en-US. Language at ConversationProfile should be set for all non en-US
 languages.
 This should be a [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt)
 language tag. Example: "en-US".
        string language_code = 10;
        Specified by:
        getLanguageCode in interface ConversationProfileOrBuilder
        Returns:
        The languageCode.

      • getLanguageCodeBytes

        public com.google.protobuf.ByteString getLanguageCodeBytes()
         Language code for the conversation profile. If not specified, the language
 is en-US. Language at ConversationProfile should be set for all non en-US
 languages.
 This should be a [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt)
 language tag. Example: "en-US".
        string language_code = 10;
        Specified by:
        getLanguageCodeBytes in interface ConversationProfileOrBuilder
        Returns:
        The bytes for languageCode.

      • getTimeZone

        public String getTimeZone()
         The time zone of this conversational profile from the
 [time zone database](https://www.iana.org/time-zones), e.g.,
 America/New_York, Europe/Paris. Defaults to America/New_York.
        string time_zone = 14;
        Specified by:
        getTimeZone in interface ConversationProfileOrBuilder
        Returns:
        The timeZone.

      • getTimeZoneBytes

        public com.google.protobuf.ByteString getTimeZoneBytes()
         The time zone of this conversational profile from the
 [time zone database](https://www.iana.org/time-zones), e.g.,
 America/New_York, Europe/Paris. Defaults to America/New_York.
        string time_zone = 14;
        Specified by:
        getTimeZoneBytes in interface ConversationProfileOrBuilder
        Returns:
        The bytes for timeZone.

      • getSecuritySettings

        public String getSecuritySettings()
         Name of the CX SecuritySettings reference for the agent.
 Format: `projects/<Project ID>/locations/<Location
 ID>/securitySettings/<Security Settings ID>`.
        string security_settings = 13 [(.google.api.resource_reference) = { ... }
        Specified by:
        getSecuritySettings in interface ConversationProfileOrBuilder
        Returns:
        The securitySettings.

      • getSecuritySettingsBytes

        public com.google.protobuf.ByteString getSecuritySettingsBytes()
         Name of the CX SecuritySettings reference for the agent.
 Format: `projects/<Project ID>/locations/<Location
 ID>/securitySettings/<Security Settings ID>`.
        string security_settings = 13 [(.google.api.resource_reference) = { ... }
        Specified by:
        getSecuritySettingsBytes in interface ConversationProfileOrBuilder
        Returns:
        The bytes for securitySettings.

      • hasTtsConfig

        public boolean hasTtsConfig()
         Configuration for Text-to-Speech synthesization.

 Used by Phone Gateway to specify synthesization options. If agent defines
 synthesization options as well, agent settings overrides the option here.
        .google.cloud.dialogflow.v2.SynthesizeSpeechConfig tts_config = 18;
        Specified by:
        hasTtsConfig in interface ConversationProfileOrBuilder
        Returns:
        Whether the ttsConfig field is set.

      • getTtsConfig

        public SynthesizeSpeechConfig getTtsConfig()
         Configuration for Text-to-Speech synthesization.

 Used by Phone Gateway to specify synthesization options. If agent defines
 synthesization options as well, agent settings overrides the option here.
        .google.cloud.dialogflow.v2.SynthesizeSpeechConfig tts_config = 18;
        Specified by:
        getTtsConfig in interface ConversationProfileOrBuilder
        Returns:
        The ttsConfig.

      • getTtsConfigOrBuilder

        public SynthesizeSpeechConfigOrBuilder getTtsConfigOrBuilder()
         Configuration for Text-to-Speech synthesization.

 Used by Phone Gateway to specify synthesization options. If agent defines
 synthesization options as well, agent settings overrides the option here.
        .google.cloud.dialogflow.v2.SynthesizeSpeechConfig tts_config = 18;
        Specified by:
        getTtsConfigOrBuilder in interface ConversationProfileOrBuilder

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • newBuilderForType

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

      • toBuilder

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

      • newBuilderForType

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

      • getParserForType

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