Package com.google.cloud.dialogflow.v2

Interface ConversationProfileOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
ConversationProfile, ConversationProfile.Builder
@Generated public interface ConversationProfileOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Details

    • getName

      String getName()
       The unique identifier of this conversation profile.
 Format: `projects/<Project ID>/locations/<Location
 ID>/conversationProfiles/<Conversation Profile ID>`.
      string name = 1;
      Returns:
      The name.

    • getNameBytes

      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;
      Returns:
      The bytes for name.

    • getDisplayName

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

    • getDisplayNameBytes

      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];
      Returns:
      The bytes for displayName.

    • hasCreateTime

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

    • getCreateTime

      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];
      Returns:
      The createTime.

    • getCreateTimeOrBuilder

      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];

    • hasUpdateTime

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

    • getUpdateTime

      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];
      Returns:
      The updateTime.

    • getUpdateTimeOrBuilder

      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];

    • hasAutomatedAgentConfig

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

    • getAutomatedAgentConfig

      AutomatedAgentConfig getAutomatedAgentConfig()
       Configuration for an automated agent to use with this profile.
      .google.cloud.dialogflow.v2.AutomatedAgentConfig automated_agent_config = 3;
      Returns:
      The automatedAgentConfig.

    • getAutomatedAgentConfigOrBuilder

      AutomatedAgentConfigOrBuilder getAutomatedAgentConfigOrBuilder()
       Configuration for an automated agent to use with this profile.
      .google.cloud.dialogflow.v2.AutomatedAgentConfig automated_agent_config = 3;

    • hasHumanAgentAssistantConfig

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

    • getHumanAgentAssistantConfig

      HumanAgentAssistantConfig getHumanAgentAssistantConfig()
       Configuration for agent assistance to use with this profile.
      .google.cloud.dialogflow.v2.HumanAgentAssistantConfig human_agent_assistant_config = 4;
      Returns:
      The humanAgentAssistantConfig.

    • getHumanAgentAssistantConfigOrBuilder

      HumanAgentAssistantConfigOrBuilder getHumanAgentAssistantConfigOrBuilder()
       Configuration for agent assistance to use with this profile.
      .google.cloud.dialogflow.v2.HumanAgentAssistantConfig human_agent_assistant_config = 4;

    • hasHumanAgentHandoffConfig

      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;
      Returns:
      Whether the humanAgentHandoffConfig field is set.

    • getHumanAgentHandoffConfig

      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;
      Returns:
      The humanAgentHandoffConfig.

    • getHumanAgentHandoffConfigOrBuilder

      HumanAgentHandoffConfigOrBuilder getHumanAgentHandoffConfigOrBuilder()
       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;

    • hasNotificationConfig

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

    • getNotificationConfig

      NotificationConfig getNotificationConfig()
       Configuration for publishing conversation lifecycle events.
      .google.cloud.dialogflow.v2.NotificationConfig notification_config = 6;
      Returns:
      The notificationConfig.

    • getNotificationConfigOrBuilder

      NotificationConfigOrBuilder getNotificationConfigOrBuilder()
       Configuration for publishing conversation lifecycle events.
      .google.cloud.dialogflow.v2.NotificationConfig notification_config = 6;

    • hasLoggingConfig

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

    • getLoggingConfig

      LoggingConfig getLoggingConfig()
       Configuration for logging conversation lifecycle events.
      .google.cloud.dialogflow.v2.LoggingConfig logging_config = 7;
      Returns:
      The loggingConfig.

    • getLoggingConfigOrBuilder

      LoggingConfigOrBuilder getLoggingConfigOrBuilder()
       Configuration for logging conversation lifecycle events.
      .google.cloud.dialogflow.v2.LoggingConfig logging_config = 7;

    • hasNewMessageEventNotificationConfig

      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;
      Returns:
      Whether the newMessageEventNotificationConfig field is set.

    • getNewMessageEventNotificationConfig

      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;
      Returns:
      The newMessageEventNotificationConfig.

    • getNewMessageEventNotificationConfigOrBuilder

      NotificationConfigOrBuilder getNewMessageEventNotificationConfigOrBuilder()
       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;

    • hasNewRecognitionResultNotificationConfig

      boolean hasNewRecognitionResultNotificationConfig()
       Optional. Configuration for publishing transcription intermediate results.
 Event will be sent in format of
 [ConversationEvent][google.cloud.dialogflow.v2.ConversationEvent]. If
 configured, the following information will be populated as
 [ConversationEvent][google.cloud.dialogflow.v2.ConversationEvent] Pub/Sub
 message attributes:
 - "participant_id"
 - "participant_role"
 - "message_id"
      .google.cloud.dialogflow.v2.NotificationConfig new_recognition_result_notification_config = 21 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      Whether the newRecognitionResultNotificationConfig field is set.

    • getNewRecognitionResultNotificationConfig

      NotificationConfig getNewRecognitionResultNotificationConfig()
       Optional. Configuration for publishing transcription intermediate results.
 Event will be sent in format of
 [ConversationEvent][google.cloud.dialogflow.v2.ConversationEvent]. If
 configured, the following information will be populated as
 [ConversationEvent][google.cloud.dialogflow.v2.ConversationEvent] Pub/Sub
 message attributes:
 - "participant_id"
 - "participant_role"
 - "message_id"
      .google.cloud.dialogflow.v2.NotificationConfig new_recognition_result_notification_config = 21 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The newRecognitionResultNotificationConfig.

    • getNewRecognitionResultNotificationConfigOrBuilder

      NotificationConfigOrBuilder getNewRecognitionResultNotificationConfigOrBuilder()
       Optional. Configuration for publishing transcription intermediate results.
 Event will be sent in format of
 [ConversationEvent][google.cloud.dialogflow.v2.ConversationEvent]. If
 configured, the following information will be populated as
 [ConversationEvent][google.cloud.dialogflow.v2.ConversationEvent] Pub/Sub
 message attributes:
 - "participant_id"
 - "participant_role"
 - "message_id"
      .google.cloud.dialogflow.v2.NotificationConfig new_recognition_result_notification_config = 21 [(.google.api.field_behavior) = OPTIONAL];

    • hasSttConfig

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

    • getSttConfig

      SpeechToTextConfig getSttConfig()
       Settings for speech transcription.
      .google.cloud.dialogflow.v2.SpeechToTextConfig stt_config = 9;
      Returns:
      The sttConfig.

    • getSttConfigOrBuilder

      SpeechToTextConfigOrBuilder getSttConfigOrBuilder()
       Settings for speech transcription.
      .google.cloud.dialogflow.v2.SpeechToTextConfig stt_config = 9;

    • getLanguageCode

      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;
      Returns:
      The languageCode.

    • getLanguageCodeBytes

      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;
      Returns:
      The bytes for languageCode.

    • getTimeZone

      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;
      Returns:
      The timeZone.

    • getTimeZoneBytes

      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;
      Returns:
      The bytes for timeZone.

    • getSecuritySettings

      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) = { ... }
      Returns:
      The securitySettings.

    • getSecuritySettingsBytes

      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) = { ... }
      Returns:
      The bytes for securitySettings.

    • hasTtsConfig

      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;
      Returns:
      Whether the ttsConfig field is set.

    • getTtsConfig

      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;
      Returns:
      The ttsConfig.

    • getTtsConfigOrBuilder

      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;