com.google.cloud.dialogflow.cx.v3beta1.FlowOrBuilder 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
/*
* 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/flow.proto
// Protobuf Java Version: 3.25.5
package com.google.cloud.dialogflow.cx.v3beta1;
public interface FlowOrBuilder
extends
// @@protoc_insertion_point(interface_extends:google.cloud.dialogflow.cx.v3beta1.Flow)
com.google.protobuf.MessageOrBuilder {
/**
*
*
*
* The unique identifier of the flow.
* Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
* ID>/flows/<Flow ID>`.
*
*
* string name = 1;
*
* @return The name.
*/
java.lang.String getName();
/**
*
*
*
* The unique identifier of the flow.
* Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
* ID>/flows/<Flow ID>`.
*
*
* string name = 1;
*
* @return The bytes for name.
*/
com.google.protobuf.ByteString getNameBytes();
/**
*
*
*
* Required. The human-readable name of the flow.
*
*
* string display_name = 2 [(.google.api.field_behavior) = REQUIRED];
*
* @return The displayName.
*/
java.lang.String getDisplayName();
/**
*
*
*
* Required. The human-readable name of the flow.
*
*
* string display_name = 2 [(.google.api.field_behavior) = REQUIRED];
*
* @return The bytes for displayName.
*/
com.google.protobuf.ByteString getDisplayNameBytes();
/**
*
*
*
* The description of the flow. The maximum length is 500 characters. If
* exceeded, the request is rejected.
*
*
* string description = 3;
*
* @return The description.
*/
java.lang.String getDescription();
/**
*
*
*
* The description of the flow. The maximum length is 500 characters. If
* exceeded, the request is rejected.
*
*
* string description = 3;
*
* @return The bytes for description.
*/
com.google.protobuf.ByteString getDescriptionBytes();
/**
*
*
*
* A flow's transition routes serve two purposes:
*
* * They are responsible for matching the user's first utterances in the
* flow.
* * They are inherited by every page's [transition
* routes][Page.transition_routes] and can support use cases such as the user
* saying "help" or "can I talk to a human?", which can be handled in a common
* way regardless of the current page. Transition routes defined in the page
* have higher priority than those defined in the flow.
*
* TransitionRoutes are evalauted in the following order:
*
* * TransitionRoutes with intent specified.
* * TransitionRoutes with only condition specified.
*
* TransitionRoutes with intent specified are inherited by pages in the flow.
*
*
* repeated .google.cloud.dialogflow.cx.v3beta1.TransitionRoute transition_routes = 4;
*
*/
java.util.List getTransitionRoutesList();
/**
*
*
*
* A flow's transition routes serve two purposes:
*
* * They are responsible for matching the user's first utterances in the
* flow.
* * They are inherited by every page's [transition
* routes][Page.transition_routes] and can support use cases such as the user
* saying "help" or "can I talk to a human?", which can be handled in a common
* way regardless of the current page. Transition routes defined in the page
* have higher priority than those defined in the flow.
*
* TransitionRoutes are evalauted in the following order:
*
* * TransitionRoutes with intent specified.
* * TransitionRoutes with only condition specified.
*
* TransitionRoutes with intent specified are inherited by pages in the flow.
*
*
* repeated .google.cloud.dialogflow.cx.v3beta1.TransitionRoute transition_routes = 4;
*
*/
com.google.cloud.dialogflow.cx.v3beta1.TransitionRoute getTransitionRoutes(int index);
/**
*
*
*
* A flow's transition routes serve two purposes:
*
* * They are responsible for matching the user's first utterances in the
* flow.
* * They are inherited by every page's [transition
* routes][Page.transition_routes] and can support use cases such as the user
* saying "help" or "can I talk to a human?", which can be handled in a common
* way regardless of the current page. Transition routes defined in the page
* have higher priority than those defined in the flow.
*
* TransitionRoutes are evalauted in the following order:
*
* * TransitionRoutes with intent specified.
* * TransitionRoutes with only condition specified.
*
* TransitionRoutes with intent specified are inherited by pages in the flow.
*
*
* repeated .google.cloud.dialogflow.cx.v3beta1.TransitionRoute transition_routes = 4;
*
*/
int getTransitionRoutesCount();
/**
*
*
*
* A flow's transition routes serve two purposes:
*
* * They are responsible for matching the user's first utterances in the
* flow.
* * They are inherited by every page's [transition
* routes][Page.transition_routes] and can support use cases such as the user
* saying "help" or "can I talk to a human?", which can be handled in a common
* way regardless of the current page. Transition routes defined in the page
* have higher priority than those defined in the flow.
*
* TransitionRoutes are evalauted in the following order:
*
* * TransitionRoutes with intent specified.
* * TransitionRoutes with only condition specified.
*
* TransitionRoutes with intent specified are inherited by pages in the flow.
*
*
* repeated .google.cloud.dialogflow.cx.v3beta1.TransitionRoute transition_routes = 4;
*
*/
java.util.List
getTransitionRoutesOrBuilderList();
/**
*
*
*
* A flow's transition routes serve two purposes:
*
* * They are responsible for matching the user's first utterances in the
* flow.
* * They are inherited by every page's [transition
* routes][Page.transition_routes] and can support use cases such as the user
* saying "help" or "can I talk to a human?", which can be handled in a common
* way regardless of the current page. Transition routes defined in the page
* have higher priority than those defined in the flow.
*
* TransitionRoutes are evalauted in the following order:
*
* * TransitionRoutes with intent specified.
* * TransitionRoutes with only condition specified.
*
* TransitionRoutes with intent specified are inherited by pages in the flow.
*
*
* repeated .google.cloud.dialogflow.cx.v3beta1.TransitionRoute transition_routes = 4;
*
*/
com.google.cloud.dialogflow.cx.v3beta1.TransitionRouteOrBuilder getTransitionRoutesOrBuilder(
int index);
/**
*
*
*
* A flow's event handlers serve two purposes:
*
* * They are responsible for handling events (e.g. no match,
* webhook errors) in the flow.
* * They are inherited by every page's [event
* handlers][Page.event_handlers], which can be used to handle common events
* regardless of the current page. Event handlers defined in the page
* have higher priority than those defined in the flow.
*
* Unlike
* [transition_routes][google.cloud.dialogflow.cx.v3beta1.Flow.transition_routes],
* these handlers are evaluated on a first-match basis. The first one that
* matches the event get executed, with the rest being ignored.
*
*
* repeated .google.cloud.dialogflow.cx.v3beta1.EventHandler event_handlers = 10;
*/
java.util.List getEventHandlersList();
/**
*
*
*
* A flow's event handlers serve two purposes:
*
* * They are responsible for handling events (e.g. no match,
* webhook errors) in the flow.
* * They are inherited by every page's [event
* handlers][Page.event_handlers], which can be used to handle common events
* regardless of the current page. Event handlers defined in the page
* have higher priority than those defined in the flow.
*
* Unlike
* [transition_routes][google.cloud.dialogflow.cx.v3beta1.Flow.transition_routes],
* these handlers are evaluated on a first-match basis. The first one that
* matches the event get executed, with the rest being ignored.
*
*
* repeated .google.cloud.dialogflow.cx.v3beta1.EventHandler event_handlers = 10;
*/
com.google.cloud.dialogflow.cx.v3beta1.EventHandler getEventHandlers(int index);
/**
*
*
*
* A flow's event handlers serve two purposes:
*
* * They are responsible for handling events (e.g. no match,
* webhook errors) in the flow.
* * They are inherited by every page's [event
* handlers][Page.event_handlers], which can be used to handle common events
* regardless of the current page. Event handlers defined in the page
* have higher priority than those defined in the flow.
*
* Unlike
* [transition_routes][google.cloud.dialogflow.cx.v3beta1.Flow.transition_routes],
* these handlers are evaluated on a first-match basis. The first one that
* matches the event get executed, with the rest being ignored.
*
*
* repeated .google.cloud.dialogflow.cx.v3beta1.EventHandler event_handlers = 10;
*/
int getEventHandlersCount();
/**
*
*
*
* A flow's event handlers serve two purposes:
*
* * They are responsible for handling events (e.g. no match,
* webhook errors) in the flow.
* * They are inherited by every page's [event
* handlers][Page.event_handlers], which can be used to handle common events
* regardless of the current page. Event handlers defined in the page
* have higher priority than those defined in the flow.
*
* Unlike
* [transition_routes][google.cloud.dialogflow.cx.v3beta1.Flow.transition_routes],
* these handlers are evaluated on a first-match basis. The first one that
* matches the event get executed, with the rest being ignored.
*
*
* repeated .google.cloud.dialogflow.cx.v3beta1.EventHandler event_handlers = 10;
*/
java.util.List
getEventHandlersOrBuilderList();
/**
*
*
*
* A flow's event handlers serve two purposes:
*
* * They are responsible for handling events (e.g. no match,
* webhook errors) in the flow.
* * They are inherited by every page's [event
* handlers][Page.event_handlers], which can be used to handle common events
* regardless of the current page. Event handlers defined in the page
* have higher priority than those defined in the flow.
*
* Unlike
* [transition_routes][google.cloud.dialogflow.cx.v3beta1.Flow.transition_routes],
* these handlers are evaluated on a first-match basis. The first one that
* matches the event get executed, with the rest being ignored.
*
*
* repeated .google.cloud.dialogflow.cx.v3beta1.EventHandler event_handlers = 10;
*/
com.google.cloud.dialogflow.cx.v3beta1.EventHandlerOrBuilder getEventHandlersOrBuilder(int index);
/**
*
*
*
* A flow's transition route group serve two purposes:
*
* * They are responsible for matching the user's first utterances in the
* flow.
* * They are inherited by every page's [transition
* route groups][Page.transition_route_groups]. Transition route groups
* defined in the page have higher priority than those defined in the flow.
*
* Format:`projects/<Project ID>/locations/<Location ID>/agents/<Agent
* ID>/flows/<Flow ID>/transitionRouteGroups/<TransitionRouteGroup ID>`
* or `projects/<Project ID>/locations/<Location ID>/agents/<Agent
* ID>/transitionRouteGroups/<TransitionRouteGroup ID>` for agent-level
* groups.
*
*
* repeated string transition_route_groups = 15 [(.google.api.resource_reference) = { ... }
*
*
* @return A list containing the transitionRouteGroups.
*/
java.util.List getTransitionRouteGroupsList();
/**
*
*
*
* A flow's transition route group serve two purposes:
*
* * They are responsible for matching the user's first utterances in the
* flow.
* * They are inherited by every page's [transition
* route groups][Page.transition_route_groups]. Transition route groups
* defined in the page have higher priority than those defined in the flow.
*
* Format:`projects/<Project ID>/locations/<Location ID>/agents/<Agent
* ID>/flows/<Flow ID>/transitionRouteGroups/<TransitionRouteGroup ID>`
* or `projects/<Project ID>/locations/<Location ID>/agents/<Agent
* ID>/transitionRouteGroups/<TransitionRouteGroup ID>` for agent-level
* groups.
*
*
* repeated string transition_route_groups = 15 [(.google.api.resource_reference) = { ... }
*
*
* @return The count of transitionRouteGroups.
*/
int getTransitionRouteGroupsCount();
/**
*
*
*
* A flow's transition route group serve two purposes:
*
* * They are responsible for matching the user's first utterances in the
* flow.
* * They are inherited by every page's [transition
* route groups][Page.transition_route_groups]. Transition route groups
* defined in the page have higher priority than those defined in the flow.
*
* Format:`projects/<Project ID>/locations/<Location ID>/agents/<Agent
* ID>/flows/<Flow ID>/transitionRouteGroups/<TransitionRouteGroup ID>`
* or `projects/<Project ID>/locations/<Location ID>/agents/<Agent
* ID>/transitionRouteGroups/<TransitionRouteGroup ID>` for agent-level
* groups.
*
*
* repeated string transition_route_groups = 15 [(.google.api.resource_reference) = { ... }
*
*
* @param index The index of the element to return.
* @return The transitionRouteGroups at the given index.
*/
java.lang.String getTransitionRouteGroups(int index);
/**
*
*
*
* A flow's transition route group serve two purposes:
*
* * They are responsible for matching the user's first utterances in the
* flow.
* * They are inherited by every page's [transition
* route groups][Page.transition_route_groups]. Transition route groups
* defined in the page have higher priority than those defined in the flow.
*
* Format:`projects/<Project ID>/locations/<Location ID>/agents/<Agent
* ID>/flows/<Flow ID>/transitionRouteGroups/<TransitionRouteGroup ID>`
* or `projects/<Project ID>/locations/<Location ID>/agents/<Agent
* ID>/transitionRouteGroups/<TransitionRouteGroup ID>` for agent-level
* groups.
*
*
* repeated string transition_route_groups = 15 [(.google.api.resource_reference) = { ... }
*
*
* @param index The index of the value to return.
* @return The bytes of the transitionRouteGroups at the given index.
*/
com.google.protobuf.ByteString getTransitionRouteGroupsBytes(int index);
/**
*
*
*
* NLU related settings of the flow.
*
*
* .google.cloud.dialogflow.cx.v3beta1.NluSettings nlu_settings = 11;
*
* @return Whether the nluSettings field is set.
*/
boolean hasNluSettings();
/**
*
*
*
* NLU related settings of the flow.
*
*
* .google.cloud.dialogflow.cx.v3beta1.NluSettings nlu_settings = 11;
*
* @return The nluSettings.
*/
com.google.cloud.dialogflow.cx.v3beta1.NluSettings getNluSettings();
/**
*
*
*
* NLU related settings of the flow.
*
*
* .google.cloud.dialogflow.cx.v3beta1.NluSettings nlu_settings = 11;
*/
com.google.cloud.dialogflow.cx.v3beta1.NluSettingsOrBuilder getNluSettingsOrBuilder();
/**
*
*
*
* Hierarchical advanced settings for this flow. The settings exposed at the
* lower level overrides the settings exposed at the higher level.
*
*
* .google.cloud.dialogflow.cx.v3beta1.AdvancedSettings advanced_settings = 14;
*
* @return Whether the advancedSettings field is set.
*/
boolean hasAdvancedSettings();
/**
*
*
*
* Hierarchical advanced settings for this flow. The settings exposed at the
* lower level overrides the settings exposed at the higher level.
*
*
* .google.cloud.dialogflow.cx.v3beta1.AdvancedSettings advanced_settings = 14;
*
* @return The advancedSettings.
*/
com.google.cloud.dialogflow.cx.v3beta1.AdvancedSettings getAdvancedSettings();
/**
*
*
*
* Hierarchical advanced settings for this flow. The settings exposed at the
* lower level overrides the settings exposed at the higher level.
*
*
* .google.cloud.dialogflow.cx.v3beta1.AdvancedSettings advanced_settings = 14;
*/
com.google.cloud.dialogflow.cx.v3beta1.AdvancedSettingsOrBuilder getAdvancedSettingsOrBuilder();
/**
*
*
*
* Optional. Knowledge connector configuration.
*
*
*
* .google.cloud.dialogflow.cx.v3beta1.KnowledgeConnectorSettings knowledge_connector_settings = 18 [(.google.api.field_behavior) = OPTIONAL];
*
*
* @return Whether the knowledgeConnectorSettings field is set.
*/
boolean hasKnowledgeConnectorSettings();
/**
*
*
*
* Optional. Knowledge connector configuration.
*
*
*
* .google.cloud.dialogflow.cx.v3beta1.KnowledgeConnectorSettings knowledge_connector_settings = 18 [(.google.api.field_behavior) = OPTIONAL];
*
*
* @return The knowledgeConnectorSettings.
*/
com.google.cloud.dialogflow.cx.v3beta1.KnowledgeConnectorSettings getKnowledgeConnectorSettings();
/**
*
*
*
* Optional. Knowledge connector configuration.
*
*
*
* .google.cloud.dialogflow.cx.v3beta1.KnowledgeConnectorSettings knowledge_connector_settings = 18 [(.google.api.field_behavior) = OPTIONAL];
*
*/
com.google.cloud.dialogflow.cx.v3beta1.KnowledgeConnectorSettingsOrBuilder
getKnowledgeConnectorSettingsOrBuilder();
/**
*
*
*
* Optional. Multi-lingual agent settings for this flow.
*
*
*
* .google.cloud.dialogflow.cx.v3beta1.Flow.MultiLanguageSettings multi_language_settings = 28 [(.google.api.field_behavior) = OPTIONAL];
*
*
* @return Whether the multiLanguageSettings field is set.
*/
boolean hasMultiLanguageSettings();
/**
*
*
*
* Optional. Multi-lingual agent settings for this flow.
*
*
*
* .google.cloud.dialogflow.cx.v3beta1.Flow.MultiLanguageSettings multi_language_settings = 28 [(.google.api.field_behavior) = OPTIONAL];
*
*
* @return The multiLanguageSettings.
*/
com.google.cloud.dialogflow.cx.v3beta1.Flow.MultiLanguageSettings getMultiLanguageSettings();
/**
*
*
*
* Optional. Multi-lingual agent settings for this flow.
*
*
*
* .google.cloud.dialogflow.cx.v3beta1.Flow.MultiLanguageSettings multi_language_settings = 28 [(.google.api.field_behavior) = OPTIONAL];
*
*/
com.google.cloud.dialogflow.cx.v3beta1.Flow.MultiLanguageSettingsOrBuilder
getMultiLanguageSettingsOrBuilder();
/**
*
*
*
* Indicates whether the flow is locked for changes. If the flow is locked,
* modifications to the flow will be rejected.
*
*
* bool locked = 30;
*
* @return The locked.
*/
boolean getLocked();
}