com.google.cloud.dialogflow.v2.ConversationProfileOrBuilder Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of proto-google-cloud-dialogflow-v2 Show documentation
Show all versions of proto-google-cloud-dialogflow-v2 Show documentation
PROTO library for proto-google-cloud-dialogflow-v2
/*
* Copyright 2024 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
// Generated by the protocol buffer compiler. DO NOT EDIT!
// source: google/cloud/dialogflow/v2/conversation_profile.proto
// Protobuf Java Version: 3.25.4
package com.google.cloud.dialogflow.v2;
public interface ConversationProfileOrBuilder
extends
// @@protoc_insertion_point(interface_extends:google.cloud.dialogflow.v2.ConversationProfile)
com.google.protobuf.MessageOrBuilder {
/**
*
*
*
* The unique identifier of this conversation profile.
* Format: `projects/<Project ID>/locations/<Location
* ID>/conversationProfiles/<Conversation Profile ID>`.
*
*
* string name = 1;
*
* @return The name.
*/
java.lang.String getName();
/**
*
*
*
* The unique identifier of this conversation profile.
* Format: `projects/<Project ID>/locations/<Location
* ID>/conversationProfiles/<Conversation Profile ID>`.
*
*
* string name = 1;
*
* @return The bytes for name.
*/
com.google.protobuf.ByteString getNameBytes();
/**
*
*
*
* Required. Human readable name for this profile. Max length 1024 bytes.
*
*
* string display_name = 2 [(.google.api.field_behavior) = REQUIRED];
*
* @return The displayName.
*/
java.lang.String getDisplayName();
/**
*
*
*
* Required. Human readable name for this profile. Max length 1024 bytes.
*
*
* string display_name = 2 [(.google.api.field_behavior) = REQUIRED];
*
* @return The bytes for displayName.
*/
com.google.protobuf.ByteString getDisplayNameBytes();
/**
*
*
*
* Output only. Create time of the conversation profile.
*
*
* .google.protobuf.Timestamp create_time = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*
* @return Whether the createTime field is set.
*/
boolean hasCreateTime();
/**
*
*
*
* Output only. Create time of the conversation profile.
*
*
* .google.protobuf.Timestamp create_time = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*
* @return The createTime.
*/
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];
*
*/
com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder();
/**
*
*
*
* Output only. Update time of the conversation profile.
*
*
* .google.protobuf.Timestamp update_time = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*
* @return Whether the updateTime field is set.
*/
boolean hasUpdateTime();
/**
*
*
*
* Output only. Update time of the conversation profile.
*
*
* .google.protobuf.Timestamp update_time = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*
* @return The updateTime.
*/
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];
*
*/
com.google.protobuf.TimestampOrBuilder getUpdateTimeOrBuilder();
/**
*
*
*
* Configuration for an automated agent to use with this profile.
*
*
* .google.cloud.dialogflow.v2.AutomatedAgentConfig automated_agent_config = 3;
*
* @return Whether the automatedAgentConfig field is set.
*/
boolean hasAutomatedAgentConfig();
/**
*
*
*
* Configuration for an automated agent to use with this profile.
*
*
* .google.cloud.dialogflow.v2.AutomatedAgentConfig automated_agent_config = 3;
*
* @return The automatedAgentConfig.
*/
com.google.cloud.dialogflow.v2.AutomatedAgentConfig getAutomatedAgentConfig();
/**
*
*
*
* Configuration for an automated agent to use with this profile.
*
*
* .google.cloud.dialogflow.v2.AutomatedAgentConfig automated_agent_config = 3;
*/
com.google.cloud.dialogflow.v2.AutomatedAgentConfigOrBuilder getAutomatedAgentConfigOrBuilder();
/**
*
*
*
* Configuration for agent assistance to use with this profile.
*
*
* .google.cloud.dialogflow.v2.HumanAgentAssistantConfig human_agent_assistant_config = 4;
*
*
* @return Whether the humanAgentAssistantConfig field is set.
*/
boolean hasHumanAgentAssistantConfig();
/**
*
*
*
* Configuration for agent assistance to use with this profile.
*
*
* .google.cloud.dialogflow.v2.HumanAgentAssistantConfig human_agent_assistant_config = 4;
*
*
* @return The humanAgentAssistantConfig.
*/
com.google.cloud.dialogflow.v2.HumanAgentAssistantConfig getHumanAgentAssistantConfig();
/**
*
*
*
* Configuration for agent assistance to use with this profile.
*
*
* .google.cloud.dialogflow.v2.HumanAgentAssistantConfig human_agent_assistant_config = 4;
*
*/
com.google.cloud.dialogflow.v2.HumanAgentAssistantConfigOrBuilder
getHumanAgentAssistantConfigOrBuilder();
/**
*
*
*
* 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;
*
*
* @return Whether the humanAgentHandoffConfig field is set.
*/
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;
*
*
* @return The humanAgentHandoffConfig.
*/
com.google.cloud.dialogflow.v2.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;
*
*/
com.google.cloud.dialogflow.v2.HumanAgentHandoffConfigOrBuilder
getHumanAgentHandoffConfigOrBuilder();
/**
*
*
*
* Configuration for publishing conversation lifecycle events.
*
*
* .google.cloud.dialogflow.v2.NotificationConfig notification_config = 6;
*
* @return Whether the notificationConfig field is set.
*/
boolean hasNotificationConfig();
/**
*
*
*
* Configuration for publishing conversation lifecycle events.
*
*
* .google.cloud.dialogflow.v2.NotificationConfig notification_config = 6;
*
* @return The notificationConfig.
*/
com.google.cloud.dialogflow.v2.NotificationConfig getNotificationConfig();
/**
*
*
*
* Configuration for publishing conversation lifecycle events.
*
*
* .google.cloud.dialogflow.v2.NotificationConfig notification_config = 6;
*/
com.google.cloud.dialogflow.v2.NotificationConfigOrBuilder getNotificationConfigOrBuilder();
/**
*
*
*
* Configuration for logging conversation lifecycle events.
*
*
* .google.cloud.dialogflow.v2.LoggingConfig logging_config = 7;
*
* @return Whether the loggingConfig field is set.
*/
boolean hasLoggingConfig();
/**
*
*
*
* Configuration for logging conversation lifecycle events.
*
*
* .google.cloud.dialogflow.v2.LoggingConfig logging_config = 7;
*
* @return The loggingConfig.
*/
com.google.cloud.dialogflow.v2.LoggingConfig getLoggingConfig();
/**
*
*
*
* Configuration for logging conversation lifecycle events.
*
*
* .google.cloud.dialogflow.v2.LoggingConfig logging_config = 7;
*/
com.google.cloud.dialogflow.v2.LoggingConfigOrBuilder getLoggingConfigOrBuilder();
/**
*
*
*
* 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;
*
*
* @return Whether the newMessageEventNotificationConfig field is set.
*/
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;
*
*
* @return The newMessageEventNotificationConfig.
*/
com.google.cloud.dialogflow.v2.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;
*
*/
com.google.cloud.dialogflow.v2.NotificationConfigOrBuilder
getNewMessageEventNotificationConfigOrBuilder();
/**
*
*
*
* Settings for speech transcription.
*
*
* .google.cloud.dialogflow.v2.SpeechToTextConfig stt_config = 9;
*
* @return Whether the sttConfig field is set.
*/
boolean hasSttConfig();
/**
*
*
*
* Settings for speech transcription.
*
*
* .google.cloud.dialogflow.v2.SpeechToTextConfig stt_config = 9;
*
* @return The sttConfig.
*/
com.google.cloud.dialogflow.v2.SpeechToTextConfig getSttConfig();
/**
*
*
*
* Settings for speech transcription.
*
*
* .google.cloud.dialogflow.v2.SpeechToTextConfig stt_config = 9;
*/
com.google.cloud.dialogflow.v2.SpeechToTextConfigOrBuilder getSttConfigOrBuilder();
/**
*
*
*
* 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;
*
* @return The languageCode.
*/
java.lang.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;
*
* @return The bytes for languageCode.
*/
com.google.protobuf.ByteString getLanguageCodeBytes();
/**
*
*
*
* 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;
*
* @return The timeZone.
*/
java.lang.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;
*
* @return The bytes for timeZone.
*/
com.google.protobuf.ByteString getTimeZoneBytes();
/**
*
*
*
* 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) = { ... }
*
* @return The securitySettings.
*/
java.lang.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) = { ... }
*
* @return The bytes for securitySettings.
*/
com.google.protobuf.ByteString getSecuritySettingsBytes();
/**
*
*
*
* 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;
*
* @return Whether the ttsConfig field is set.
*/
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;
*
* @return The ttsConfig.
*/
com.google.cloud.dialogflow.v2.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;
*/
com.google.cloud.dialogflow.v2.SynthesizeSpeechConfigOrBuilder getTtsConfigOrBuilder();
}