Class ConversationProfile (4.59.0) 

public final class ConversationProfile extends GeneratedMessageV3 implements ConversationProfileOrBuilder

Defines the services to connect to incoming Dialogflow conversations.

Protobuf type google.cloud.dialogflow.v2beta1.ConversationProfile

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > ConversationProfile

Static Fields

AUTOMATED_AGENT_CONFIG_FIELD_NUMBER

public static final int AUTOMATED_AGENT_CONFIG_FIELD_NUMBER
Field Value
Type Description
int

CREATE_TIME_FIELD_NUMBER

public static final int CREATE_TIME_FIELD_NUMBER
Field Value
Type Description
int

DISPLAY_NAME_FIELD_NUMBER

public static final int DISPLAY_NAME_FIELD_NUMBER
Field Value
Type Description
int

HUMAN_AGENT_ASSISTANT_CONFIG_FIELD_NUMBER

public static final int HUMAN_AGENT_ASSISTANT_CONFIG_FIELD_NUMBER
Field Value
Type Description
int

HUMAN_AGENT_HANDOFF_CONFIG_FIELD_NUMBER

public static final int HUMAN_AGENT_HANDOFF_CONFIG_FIELD_NUMBER
Field Value
Type Description
int

LANGUAGE_CODE_FIELD_NUMBER

public static final int LANGUAGE_CODE_FIELD_NUMBER
Field Value
Type Description
int

LOGGING_CONFIG_FIELD_NUMBER

public static final int LOGGING_CONFIG_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

NEW_MESSAGE_EVENT_NOTIFICATION_CONFIG_FIELD_NUMBER

public static final int NEW_MESSAGE_EVENT_NOTIFICATION_CONFIG_FIELD_NUMBER
Field Value
Type Description
int

NOTIFICATION_CONFIG_FIELD_NUMBER

public static final int NOTIFICATION_CONFIG_FIELD_NUMBER
Field Value
Type Description
int

SECURITY_SETTINGS_FIELD_NUMBER

public static final int SECURITY_SETTINGS_FIELD_NUMBER
Field Value
Type Description
int

STT_CONFIG_FIELD_NUMBER

public static final int STT_CONFIG_FIELD_NUMBER
Field Value
Type Description
int

TIME_ZONE_FIELD_NUMBER

public static final int TIME_ZONE_FIELD_NUMBER
Field Value
Type Description
int

TTS_CONFIG_FIELD_NUMBER

public static final int TTS_CONFIG_FIELD_NUMBER
Field Value
Type Description
int

UPDATE_TIME_FIELD_NUMBER

public static final int UPDATE_TIME_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static ConversationProfile getDefaultInstance()
Returns
Type Description
ConversationProfile

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static ConversationProfile.Builder newBuilder()
Returns
Type Description
ConversationProfile.Builder

newBuilder(ConversationProfile prototype)

public static ConversationProfile.Builder newBuilder(ConversationProfile prototype)
Parameter
Name Description
prototype ConversationProfile
Returns
Type Description
ConversationProfile.Builder

parseDelimitedFrom(InputStream input)

public static ConversationProfile parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
ConversationProfile
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ConversationProfile parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ConversationProfile
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static ConversationProfile parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
ConversationProfile
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static ConversationProfile parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ConversationProfile
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static ConversationProfile parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
ConversationProfile
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static ConversationProfile parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ConversationProfile
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static ConversationProfile parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
ConversationProfile
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static ConversationProfile parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ConversationProfile
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static ConversationProfile parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
ConversationProfile
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ConversationProfile parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ConversationProfile
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static ConversationProfile parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
ConversationProfile
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static ConversationProfile parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ConversationProfile
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<ConversationProfile> parser()
Returns
Type Description
Parser<ConversationProfile>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getAutomatedAgentConfig()

public 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 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 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 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

getDefaultInstanceForType()

public ConversationProfile getDefaultInstanceForType()
Returns
Type Description
ConversationProfile

getDisplayName()

public 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 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 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 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 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 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 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 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 LoggingConfig getLoggingConfig()

Configuration for logging conversation lifecycle events.

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

Returns
Type Description
LoggingConfig

The loggingConfig.

getLoggingConfigOrBuilder()

public LoggingConfigOrBuilder getLoggingConfigOrBuilder()

Configuration for logging conversation lifecycle events.

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

Returns
Type Description
LoggingConfigOrBuilder

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;

Returns
Type Description
String

The name.

getNameBytes()

public 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 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 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 NotificationConfig getNotificationConfig()

Configuration for publishing conversation lifecycle events.

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

Returns
Type Description
NotificationConfig

The notificationConfig.

getNotificationConfigOrBuilder()

public NotificationConfigOrBuilder getNotificationConfigOrBuilder()

Configuration for publishing conversation lifecycle events.

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

Returns
Type Description
NotificationConfigOrBuilder

getParserForType()

public Parser<ConversationProfile> getParserForType()
Returns
Type Description
Parser<ConversationProfile>
Overrides

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) = { ... }

Returns
Type Description
String

The securitySettings.

getSecuritySettingsBytes()

public 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.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getSttConfig()

public SpeechToTextConfig getSttConfig()

Settings for speech transcription.

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

Returns
Type Description
SpeechToTextConfig

The sttConfig.

getSttConfigOrBuilder()

public SpeechToTextConfigOrBuilder getSttConfigOrBuilder()

Settings for speech transcription.

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

Returns
Type Description
SpeechToTextConfigOrBuilder

getTimeZone()

public 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public ConversationProfile.Builder newBuilderForType()
Returns
Type Description
ConversationProfile.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected ConversationProfile.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
ConversationProfile.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public ConversationProfile.Builder toBuilder()
Returns
Type Description
ConversationProfile.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException