Interface ConversationProfileOrBuilder (4.34.0)

Version 4.34.0

• 4.59.0 (latest)
• 4.58.0
• 4.57.0
• 4.55.0
• 4.54.0
• 4.53.0
• 4.52.0
• 4.51.0
• 4.50.0
• 4.49.0
• 4.48.0
• 4.47.0
• 4.46.0
• 4.45.0
• 4.43.0
• 4.42.0
• 4.41.0
• 4.40.0
• 4.39.0
• 4.38.0
• 4.37.0
• 4.36.0
• 4.35.0
• 4.34.0
• 4.33.0
• 4.30.0
• 4.29.0
• 4.28.0
• 4.27.0
• 4.26.0
• 4.25.0
• 4.24.0
• 4.23.0
• 4.22.0
• 4.21.0
• 4.20.0
• 4.19.0
• 4.18.0
• 4.17.0
• 4.15.0
• 4.14.0
• 4.13.0
• 4.12.0
• 4.11.0
• 4.10.0
• 4.9.1
• 4.8.6
• 4.7.5
• 4.6.0
• 4.5.11
• 4.4.0
• 4.3.1

public interface ConversationProfileOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getAutomatedAgentConfig()

public abstract AutomatedAgentConfig getAutomatedAgentConfig()

Configuration for an automated agent to use with this profile.

.google.cloud.dialogflow.v2beta1.AutomatedAgentConfig automated_agent_config = 3;

Returns
Type	Description
AutomatedAgentConfig	The automatedAgentConfig.

getAutomatedAgentConfigOrBuilder()

public abstract AutomatedAgentConfigOrBuilder getAutomatedAgentConfigOrBuilder()

Configuration for an automated agent to use with this profile.

.google.cloud.dialogflow.v2beta1.AutomatedAgentConfig automated_agent_config = 3;

Returns
Type	Description
AutomatedAgentConfigOrBuilder

getCreateTime()

public abstract Timestamp getCreateTime()

Output only. Create time of the conversation profile.

.google.protobuf.Timestamp create_time = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
Timestamp	The createTime.

getCreateTimeOrBuilder()

public abstract TimestampOrBuilder getCreateTimeOrBuilder()

Output only. Create time of the conversation profile.

.google.protobuf.Timestamp create_time = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
TimestampOrBuilder

getDisplayName()

public abstract String getDisplayName()

Required. Human readable name for this profile. Max length 1024 bytes.

string display_name = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
String	The displayName.

getDisplayNameBytes()

public abstract ByteString getDisplayNameBytes()

Required. Human readable name for this profile. Max length 1024 bytes.

string display_name = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
ByteString	The bytes for displayName.

getHumanAgentAssistantConfig()

public abstract HumanAgentAssistantConfig getHumanAgentAssistantConfig()

Configuration for agent assistance to use with this profile.

.google.cloud.dialogflow.v2beta1.HumanAgentAssistantConfig human_agent_assistant_config = 4;

Returns
Type	Description
HumanAgentAssistantConfig	The humanAgentAssistantConfig.

getHumanAgentAssistantConfigOrBuilder()

public abstract HumanAgentAssistantConfigOrBuilder getHumanAgentAssistantConfigOrBuilder()

Configuration for agent assistance to use with this profile.

.google.cloud.dialogflow.v2beta1.HumanAgentAssistantConfig human_agent_assistant_config = 4;

Returns
Type	Description
HumanAgentAssistantConfigOrBuilder

getHumanAgentHandoffConfig()

public abstract 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.v2beta1.HumanAgentHandoffConfig human_agent_handoff_config = 5;

Returns
Type	Description
HumanAgentHandoffConfig	The humanAgentHandoffConfig.

getHumanAgentHandoffConfigOrBuilder()

public abstract 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.v2beta1.HumanAgentHandoffConfig human_agent_handoff_config = 5;

Returns
Type	Description
HumanAgentHandoffConfigOrBuilder

getLanguageCode()

public abstract 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 language tag. Example: "en-US".

string language_code = 10;

Returns
Type	Description
String	The languageCode.

getLanguageCodeBytes()

public abstract 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 language tag. Example: "en-US".

string language_code = 10;

Returns
Type	Description
ByteString	The bytes for languageCode.

getLoggingConfig()

public abstract LoggingConfig getLoggingConfig()

Configuration for logging conversation lifecycle events.

.google.cloud.dialogflow.v2beta1.LoggingConfig logging_config = 7;

Returns
Type	Description
LoggingConfig	The loggingConfig.

getLoggingConfigOrBuilder()

public abstract LoggingConfigOrBuilder getLoggingConfigOrBuilder()

Configuration for logging conversation lifecycle events.

.google.cloud.dialogflow.v2beta1.LoggingConfig logging_config = 7;

Returns
Type	Description
LoggingConfigOrBuilder

getName()

public abstract String getName()

The unique identifier of this conversation profile. Format: projects/<Project ID>/locations/<Location ID>/conversationProfiles/<Conversation Profile ID>.

string name = 1;

Returns
Type	Description
String	The name.

getNameBytes()

public abstract ByteString getNameBytes()

The unique identifier of this conversation profile. Format: projects/<Project ID>/locations/<Location ID>/conversationProfiles/<Conversation Profile ID>.

string name = 1;

Returns
Type	Description
ByteString	The bytes for name.

getNewMessageEventNotificationConfig()

public abstract NotificationConfig getNewMessageEventNotificationConfig()

Configuration for publishing new message events. Event will be sent in format of ConversationEvent

.google.cloud.dialogflow.v2beta1.NotificationConfig new_message_event_notification_config = 8;

Returns
Type	Description
NotificationConfig	The newMessageEventNotificationConfig.

getNewMessageEventNotificationConfigOrBuilder()

public abstract NotificationConfigOrBuilder getNewMessageEventNotificationConfigOrBuilder()

Configuration for publishing new message events. Event will be sent in format of ConversationEvent

.google.cloud.dialogflow.v2beta1.NotificationConfig new_message_event_notification_config = 8;

Returns
Type	Description
NotificationConfigOrBuilder

getNotificationConfig()

public abstract NotificationConfig getNotificationConfig()

Configuration for publishing conversation lifecycle events.

.google.cloud.dialogflow.v2beta1.NotificationConfig notification_config = 6;

Returns
Type	Description
NotificationConfig	The notificationConfig.

getNotificationConfigOrBuilder()

public abstract NotificationConfigOrBuilder getNotificationConfigOrBuilder()

Configuration for publishing conversation lifecycle events.

.google.cloud.dialogflow.v2beta1.NotificationConfig notification_config = 6;

Returns
Type	Description
NotificationConfigOrBuilder

getSecuritySettings()

public abstract 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
Type	Description
String	The securitySettings.

getSecuritySettingsBytes()

public abstract 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
Type	Description
ByteString	The bytes for securitySettings.

getSttConfig()

public abstract SpeechToTextConfig getSttConfig()

Settings for speech transcription.

.google.cloud.dialogflow.v2beta1.SpeechToTextConfig stt_config = 9;

Returns
Type	Description
SpeechToTextConfig	The sttConfig.

getSttConfigOrBuilder()

public abstract SpeechToTextConfigOrBuilder getSttConfigOrBuilder()

Settings for speech transcription.

.google.cloud.dialogflow.v2beta1.SpeechToTextConfig stt_config = 9;

Returns
Type	Description
SpeechToTextConfigOrBuilder

getTimeZone()

public abstract String getTimeZone()

The time zone of this conversational profile from the time zone database, e.g., America/New_York, Europe/Paris. Defaults to America/New_York.

string time_zone = 14;

Returns
Type	Description
String	The timeZone.

getTimeZoneBytes()

public abstract ByteString getTimeZoneBytes()

The time zone of this conversational profile from the time zone database, e.g., America/New_York, Europe/Paris. Defaults to America/New_York.

string time_zone = 14;

Returns
Type	Description
ByteString	The bytes for timeZone.

getTtsConfig()

public abstract 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.v2beta1.SynthesizeSpeechConfig tts_config = 18;

Returns
Type	Description
SynthesizeSpeechConfig	The ttsConfig.

getTtsConfigOrBuilder()

public abstract 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.v2beta1.SynthesizeSpeechConfig tts_config = 18;

Returns
Type	Description
SynthesizeSpeechConfigOrBuilder

getUpdateTime()

public abstract Timestamp getUpdateTime()

Output only. Update time of the conversation profile.

.google.protobuf.Timestamp update_time = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
Timestamp	The updateTime.

getUpdateTimeOrBuilder()

public abstract TimestampOrBuilder getUpdateTimeOrBuilder()

Output only. Update time of the conversation profile.

.google.protobuf.Timestamp update_time = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
TimestampOrBuilder

hasAutomatedAgentConfig()

public abstract boolean hasAutomatedAgentConfig()

Configuration for an automated agent to use with this profile.

.google.cloud.dialogflow.v2beta1.AutomatedAgentConfig automated_agent_config = 3;

Returns
Type	Description
boolean	Whether the automatedAgentConfig field is set.

hasCreateTime()

public abstract boolean hasCreateTime()

Output only. Create time of the conversation profile.

.google.protobuf.Timestamp create_time = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
boolean	Whether the createTime field is set.

hasHumanAgentAssistantConfig()

public abstract boolean hasHumanAgentAssistantConfig()

Configuration for agent assistance to use with this profile.

.google.cloud.dialogflow.v2beta1.HumanAgentAssistantConfig human_agent_assistant_config = 4;

Returns
Type	Description
boolean	Whether the humanAgentAssistantConfig field is set.

hasHumanAgentHandoffConfig()

public abstract 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.v2beta1.HumanAgentHandoffConfig human_agent_handoff_config = 5;

Returns
Type	Description
boolean	Whether the humanAgentHandoffConfig field is set.

hasLoggingConfig()

public abstract boolean hasLoggingConfig()

Configuration for logging conversation lifecycle events.

.google.cloud.dialogflow.v2beta1.LoggingConfig logging_config = 7;

Returns
Type	Description
boolean	Whether the loggingConfig field is set.

hasNewMessageEventNotificationConfig()

public abstract boolean hasNewMessageEventNotificationConfig()

Configuration for publishing new message events. Event will be sent in format of ConversationEvent

.google.cloud.dialogflow.v2beta1.NotificationConfig new_message_event_notification_config = 8;

Returns
Type	Description
boolean	Whether the newMessageEventNotificationConfig field is set.

hasNotificationConfig()

public abstract boolean hasNotificationConfig()

Configuration for publishing conversation lifecycle events.

.google.cloud.dialogflow.v2beta1.NotificationConfig notification_config = 6;

Returns
Type	Description
boolean	Whether the notificationConfig field is set.

hasSttConfig()

public abstract boolean hasSttConfig()

Settings for speech transcription.

.google.cloud.dialogflow.v2beta1.SpeechToTextConfig stt_config = 9;

Returns
Type	Description
boolean	Whether the sttConfig field is set.

hasTtsConfig()

public abstract 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.v2beta1.SynthesizeSpeechConfig tts_config = 18;

Returns
Type	Description
boolean	Whether the ttsConfig field is set.

hasUpdateTime()

public abstract boolean hasUpdateTime()

Output only. Update time of the conversation profile.

.google.protobuf.Timestamp update_time = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
boolean	Whether the updateTime field is set.