com.google.cloud.dialogflow.cx.v3beta1.ConversationOrBuilder 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-cx-v3beta1 Show documentation
Show all versions of proto-google-cloud-dialogflow-cx-v3beta1 Show documentation
PROTO library for proto-google-cloud-dialogflow-cx-v3beta1
The newest version!
/*
* 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/cx/v3beta1/conversation_history.proto
// Protobuf Java Version: 3.25.5
package com.google.cloud.dialogflow.cx.v3beta1;
public interface ConversationOrBuilder
extends
// @@protoc_insertion_point(interface_extends:google.cloud.dialogflow.cx.v3beta1.Conversation)
com.google.protobuf.MessageOrBuilder {
/**
*
*
*
* Identifier. The identifier of the conversation.
* If conversation ID is reused, interactions happened later than 48 hours of
* the conversation's create time will be ignored. Format:
* `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/conversations/<ConversationID>`
*
*
* string name = 1 [(.google.api.field_behavior) = IDENTIFIER];
*
* @return The name.
*/
java.lang.String getName();
/**
*
*
*
* Identifier. The identifier of the conversation.
* If conversation ID is reused, interactions happened later than 48 hours of
* the conversation's create time will be ignored. Format:
* `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/conversations/<ConversationID>`
*
*
* string name = 1 [(.google.api.field_behavior) = IDENTIFIER];
*
* @return The bytes for name.
*/
com.google.protobuf.ByteString getNameBytes();
/**
*
*
*
* The type of the conversation.
*
*
* .google.cloud.dialogflow.cx.v3beta1.Conversation.Type type = 2;
*
* @return The enum numeric value on the wire for type.
*/
int getTypeValue();
/**
*
*
*
* The type of the conversation.
*
*
* .google.cloud.dialogflow.cx.v3beta1.Conversation.Type type = 2;
*
* @return The type.
*/
com.google.cloud.dialogflow.cx.v3beta1.Conversation.Type getType();
/**
*
*
*
* The language of the conversation, which is the language of the first
* request in the conversation.
*
*
* string language_code = 3;
*
* @return The languageCode.
*/
java.lang.String getLanguageCode();
/**
*
*
*
* The language of the conversation, which is the language of the first
* request in the conversation.
*
*
* string language_code = 3;
*
* @return The bytes for languageCode.
*/
com.google.protobuf.ByteString getLanguageCodeBytes();
/**
*
*
*
* Start time of the conversation, which is the time of the first request of
* the conversation.
*
*
* .google.protobuf.Timestamp start_time = 4;
*
* @return Whether the startTime field is set.
*/
boolean hasStartTime();
/**
*
*
*
* Start time of the conversation, which is the time of the first request of
* the conversation.
*
*
* .google.protobuf.Timestamp start_time = 4;
*
* @return The startTime.
*/
com.google.protobuf.Timestamp getStartTime();
/**
*
*
*
* Start time of the conversation, which is the time of the first request of
* the conversation.
*
*
* .google.protobuf.Timestamp start_time = 4;
*/
com.google.protobuf.TimestampOrBuilder getStartTimeOrBuilder();
/**
*
*
*
* Duration of the conversation.
*
*
* .google.protobuf.Duration duration = 5;
*
* @return Whether the duration field is set.
*/
boolean hasDuration();
/**
*
*
*
* Duration of the conversation.
*
*
* .google.protobuf.Duration duration = 5;
*
* @return The duration.
*/
com.google.protobuf.Duration getDuration();
/**
*
*
*
* Duration of the conversation.
*
*
* .google.protobuf.Duration duration = 5;
*/
com.google.protobuf.DurationOrBuilder getDurationOrBuilder();
/**
*
*
*
* Conversation metrics.
*
*
* .google.cloud.dialogflow.cx.v3beta1.Conversation.Metrics metrics = 6;
*
* @return Whether the metrics field is set.
*/
boolean hasMetrics();
/**
*
*
*
* Conversation metrics.
*
*
* .google.cloud.dialogflow.cx.v3beta1.Conversation.Metrics metrics = 6;
*
* @return The metrics.
*/
com.google.cloud.dialogflow.cx.v3beta1.Conversation.Metrics getMetrics();
/**
*
*
*
* Conversation metrics.
*
*
* .google.cloud.dialogflow.cx.v3beta1.Conversation.Metrics metrics = 6;
*/
com.google.cloud.dialogflow.cx.v3beta1.Conversation.MetricsOrBuilder getMetricsOrBuilder();
/**
*
*
*
* All the matched [Intent][google.cloud.dialogflow.cx.v3beta1.Intent] in the
* conversation. Only `name` and `display_name` are filled in this message.
*
*
* repeated .google.cloud.dialogflow.cx.v3beta1.Intent intents = 7;
*/
java.util.List getIntentsList();
/**
*
*
*
* All the matched [Intent][google.cloud.dialogflow.cx.v3beta1.Intent] in the
* conversation. Only `name` and `display_name` are filled in this message.
*
*
* repeated .google.cloud.dialogflow.cx.v3beta1.Intent intents = 7;
*/
com.google.cloud.dialogflow.cx.v3beta1.Intent getIntents(int index);
/**
*
*
*
* All the matched [Intent][google.cloud.dialogflow.cx.v3beta1.Intent] in the
* conversation. Only `name` and `display_name` are filled in this message.
*
*
* repeated .google.cloud.dialogflow.cx.v3beta1.Intent intents = 7;
*/
int getIntentsCount();
/**
*
*
*
* All the matched [Intent][google.cloud.dialogflow.cx.v3beta1.Intent] in the
* conversation. Only `name` and `display_name` are filled in this message.
*
*
* repeated .google.cloud.dialogflow.cx.v3beta1.Intent intents = 7;
*/
java.util.List
getIntentsOrBuilderList();
/**
*
*
*
* All the matched [Intent][google.cloud.dialogflow.cx.v3beta1.Intent] in the
* conversation. Only `name` and `display_name` are filled in this message.
*
*
* repeated .google.cloud.dialogflow.cx.v3beta1.Intent intents = 7;
*/
com.google.cloud.dialogflow.cx.v3beta1.IntentOrBuilder getIntentsOrBuilder(int index);
/**
*
*
*
* All the [Flow][google.cloud.dialogflow.cx.v3beta1.Flow] the conversation
* has went through. Only `name` and `display_name` are filled in this
* message.
*
*
* repeated .google.cloud.dialogflow.cx.v3beta1.Flow flows = 8;
*/
java.util.List getFlowsList();
/**
*
*
*
* All the [Flow][google.cloud.dialogflow.cx.v3beta1.Flow] the conversation
* has went through. Only `name` and `display_name` are filled in this
* message.
*
*
* repeated .google.cloud.dialogflow.cx.v3beta1.Flow flows = 8;
*/
com.google.cloud.dialogflow.cx.v3beta1.Flow getFlows(int index);
/**
*
*
*
* All the [Flow][google.cloud.dialogflow.cx.v3beta1.Flow] the conversation
* has went through. Only `name` and `display_name` are filled in this
* message.
*
*
* repeated .google.cloud.dialogflow.cx.v3beta1.Flow flows = 8;
*/
int getFlowsCount();
/**
*
*
*
* All the [Flow][google.cloud.dialogflow.cx.v3beta1.Flow] the conversation
* has went through. Only `name` and `display_name` are filled in this
* message.
*
*
* repeated .google.cloud.dialogflow.cx.v3beta1.Flow flows = 8;
*/
java.util.List
getFlowsOrBuilderList();
/**
*
*
*
* All the [Flow][google.cloud.dialogflow.cx.v3beta1.Flow] the conversation
* has went through. Only `name` and `display_name` are filled in this
* message.
*
*
* repeated .google.cloud.dialogflow.cx.v3beta1.Flow flows = 8;
*/
com.google.cloud.dialogflow.cx.v3beta1.FlowOrBuilder getFlowsOrBuilder(int index);
/**
*
*
*
* All the [Page][google.cloud.dialogflow.cx.v3beta1.Page] the conversation
* has went through. Only `name` and `display_name` are filled in this
* message.
*
*
* repeated .google.cloud.dialogflow.cx.v3beta1.Page pages = 9;
*/
java.util.List getPagesList();
/**
*
*
*
* All the [Page][google.cloud.dialogflow.cx.v3beta1.Page] the conversation
* has went through. Only `name` and `display_name` are filled in this
* message.
*
*
* repeated .google.cloud.dialogflow.cx.v3beta1.Page pages = 9;
*/
com.google.cloud.dialogflow.cx.v3beta1.Page getPages(int index);
/**
*
*
*
* All the [Page][google.cloud.dialogflow.cx.v3beta1.Page] the conversation
* has went through. Only `name` and `display_name` are filled in this
* message.
*
*
* repeated .google.cloud.dialogflow.cx.v3beta1.Page pages = 9;
*/
int getPagesCount();
/**
*
*
*
* All the [Page][google.cloud.dialogflow.cx.v3beta1.Page] the conversation
* has went through. Only `name` and `display_name` are filled in this
* message.
*
*
* repeated .google.cloud.dialogflow.cx.v3beta1.Page pages = 9;
*/
java.util.List
getPagesOrBuilderList();
/**
*
*
*
* All the [Page][google.cloud.dialogflow.cx.v3beta1.Page] the conversation
* has went through. Only `name` and `display_name` are filled in this
* message.
*
*
* repeated .google.cloud.dialogflow.cx.v3beta1.Page pages = 9;
*/
com.google.cloud.dialogflow.cx.v3beta1.PageOrBuilder getPagesOrBuilder(int index);
/**
*
*
*
* Interactions of the conversation.
* Only populated for `GetConversation` and empty for `ListConversations`.
*
*
* repeated .google.cloud.dialogflow.cx.v3beta1.Conversation.Interaction interactions = 10;
*
*/
java.util.List
getInteractionsList();
/**
*
*
*
* Interactions of the conversation.
* Only populated for `GetConversation` and empty for `ListConversations`.
*
*
* repeated .google.cloud.dialogflow.cx.v3beta1.Conversation.Interaction interactions = 10;
*
*/
com.google.cloud.dialogflow.cx.v3beta1.Conversation.Interaction getInteractions(int index);
/**
*
*
*
* Interactions of the conversation.
* Only populated for `GetConversation` and empty for `ListConversations`.
*
*
* repeated .google.cloud.dialogflow.cx.v3beta1.Conversation.Interaction interactions = 10;
*
*/
int getInteractionsCount();
/**
*
*
*
* Interactions of the conversation.
* Only populated for `GetConversation` and empty for `ListConversations`.
*
*
* repeated .google.cloud.dialogflow.cx.v3beta1.Conversation.Interaction interactions = 10;
*
*/
java.util.List
getInteractionsOrBuilderList();
/**
*
*
*
* Interactions of the conversation.
* Only populated for `GetConversation` and empty for `ListConversations`.
*
*
* repeated .google.cloud.dialogflow.cx.v3beta1.Conversation.Interaction interactions = 10;
*
*/
com.google.cloud.dialogflow.cx.v3beta1.Conversation.InteractionOrBuilder getInteractionsOrBuilder(
int index);
/**
*
*
*
* Environment of the conversation.
* Only `name` and `display_name` are filled in this message.
*
*
* .google.cloud.dialogflow.cx.v3beta1.Environment environment = 11;
*
* @return Whether the environment field is set.
*/
boolean hasEnvironment();
/**
*
*
*
* Environment of the conversation.
* Only `name` and `display_name` are filled in this message.
*
*
* .google.cloud.dialogflow.cx.v3beta1.Environment environment = 11;
*
* @return The environment.
*/
com.google.cloud.dialogflow.cx.v3beta1.Environment getEnvironment();
/**
*
*
*
* Environment of the conversation.
* Only `name` and `display_name` are filled in this message.
*
*
* .google.cloud.dialogflow.cx.v3beta1.Environment environment = 11;
*/
com.google.cloud.dialogflow.cx.v3beta1.EnvironmentOrBuilder getEnvironmentOrBuilder();
/**
*
*
*
* Flow versions used in the conversation.
*
*
* map<string, int64> flow_versions = 12;
*/
int getFlowVersionsCount();
/**
*
*
*
* Flow versions used in the conversation.
*
*
* map<string, int64> flow_versions = 12;
*/
boolean containsFlowVersions(java.lang.String key);
/** Use {@link #getFlowVersionsMap()} instead. */
@java.lang.Deprecated
java.util.Map getFlowVersions();
/**
*
*
*
* Flow versions used in the conversation.
*
*
* map<string, int64> flow_versions = 12;
*/
java.util.Map getFlowVersionsMap();
/**
*
*
*
* Flow versions used in the conversation.
*
*
* map<string, int64> flow_versions = 12;
*/
long getFlowVersionsOrDefault(java.lang.String key, long defaultValue);
/**
*
*
*
* Flow versions used in the conversation.
*
*
* map<string, int64> flow_versions = 12;
*/
long getFlowVersionsOrThrow(java.lang.String key);
}