com.google.cloud.dialogflow.cx.v3beta1.PageOrBuilder 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/page.proto
// Protobuf Java Version: 3.25.5
package com.google.cloud.dialogflow.cx.v3beta1;
public interface PageOrBuilder
extends
// @@protoc_insertion_point(interface_extends:google.cloud.dialogflow.cx.v3beta1.Page)
com.google.protobuf.MessageOrBuilder {
/**
*
*
*
* The unique identifier of the page.
* Required for the
* [Pages.UpdatePage][google.cloud.dialogflow.cx.v3beta1.Pages.UpdatePage]
* method.
* [Pages.CreatePage][google.cloud.dialogflow.cx.v3beta1.Pages.CreatePage]
* populates the name automatically.
* Format:
* `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>/pages/<PageID>`.
*
*
* string name = 1;
*
* @return The name.
*/
java.lang.String getName();
/**
*
*
*
* The unique identifier of the page.
* Required for the
* [Pages.UpdatePage][google.cloud.dialogflow.cx.v3beta1.Pages.UpdatePage]
* method.
* [Pages.CreatePage][google.cloud.dialogflow.cx.v3beta1.Pages.CreatePage]
* populates the name automatically.
* Format:
* `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>/pages/<PageID>`.
*
*
* string name = 1;
*
* @return The bytes for name.
*/
com.google.protobuf.ByteString getNameBytes();
/**
*
*
*
* Required. The human-readable name of the page, unique within 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 page, unique within 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 page. The maximum length is 500 characters.
*
*
* string description = 19;
*
* @return The description.
*/
java.lang.String getDescription();
/**
*
*
*
* The description of the page. The maximum length is 500 characters.
*
*
* string description = 19;
*
* @return The bytes for description.
*/
com.google.protobuf.ByteString getDescriptionBytes();
/**
*
*
*
* The fulfillment to call when the session is entering the page.
*
*
* .google.cloud.dialogflow.cx.v3beta1.Fulfillment entry_fulfillment = 7;
*
* @return Whether the entryFulfillment field is set.
*/
boolean hasEntryFulfillment();
/**
*
*
*
* The fulfillment to call when the session is entering the page.
*
*
* .google.cloud.dialogflow.cx.v3beta1.Fulfillment entry_fulfillment = 7;
*
* @return The entryFulfillment.
*/
com.google.cloud.dialogflow.cx.v3beta1.Fulfillment getEntryFulfillment();
/**
*
*
*
* The fulfillment to call when the session is entering the page.
*
*
* .google.cloud.dialogflow.cx.v3beta1.Fulfillment entry_fulfillment = 7;
*/
com.google.cloud.dialogflow.cx.v3beta1.FulfillmentOrBuilder getEntryFulfillmentOrBuilder();
/**
*
*
*
* The form associated with the page, used for collecting parameters
* relevant to the page.
*
*
* .google.cloud.dialogflow.cx.v3beta1.Form form = 4;
*
* @return Whether the form field is set.
*/
boolean hasForm();
/**
*
*
*
* The form associated with the page, used for collecting parameters
* relevant to the page.
*
*
* .google.cloud.dialogflow.cx.v3beta1.Form form = 4;
*
* @return The form.
*/
com.google.cloud.dialogflow.cx.v3beta1.Form getForm();
/**
*
*
*
* The form associated with the page, used for collecting parameters
* relevant to the page.
*
*
* .google.cloud.dialogflow.cx.v3beta1.Form form = 4;
*/
com.google.cloud.dialogflow.cx.v3beta1.FormOrBuilder getFormOrBuilder();
/**
*
*
*
* Ordered list of
* [`TransitionRouteGroups`][google.cloud.dialogflow.cx.v3beta1.TransitionRouteGroup]
* added to the page. Transition route groups must be unique within a page. If
* the page links both flow-level transition route groups and agent-level
* transition route groups, the flow-level ones will have higher priority and
* will be put before the agent-level ones.
*
* * If multiple transition routes within a page scope refer to the same
* intent, then the precedence order is: page's transition route -> page's
* transition route group -> flow's transition routes.
*
* * If multiple transition route groups within a page contain the same
* intent, then the first group in the ordered list takes precedence.
*
* Format:`projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>/transitionRouteGroups/<TransitionRouteGroupID>`
* or
* `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/transitionRouteGroups/<TransitionRouteGroupID>`
* for agent-level groups.
*
*
* repeated string transition_route_groups = 11 [(.google.api.resource_reference) = { ... }
*
*
* @return A list containing the transitionRouteGroups.
*/
java.util.List getTransitionRouteGroupsList();
/**
*
*
*
* Ordered list of
* [`TransitionRouteGroups`][google.cloud.dialogflow.cx.v3beta1.TransitionRouteGroup]
* added to the page. Transition route groups must be unique within a page. If
* the page links both flow-level transition route groups and agent-level
* transition route groups, the flow-level ones will have higher priority and
* will be put before the agent-level ones.
*
* * If multiple transition routes within a page scope refer to the same
* intent, then the precedence order is: page's transition route -> page's
* transition route group -> flow's transition routes.
*
* * If multiple transition route groups within a page contain the same
* intent, then the first group in the ordered list takes precedence.
*
* Format:`projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>/transitionRouteGroups/<TransitionRouteGroupID>`
* or
* `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/transitionRouteGroups/<TransitionRouteGroupID>`
* for agent-level groups.
*
*
* repeated string transition_route_groups = 11 [(.google.api.resource_reference) = { ... }
*
*
* @return The count of transitionRouteGroups.
*/
int getTransitionRouteGroupsCount();
/**
*
*
*
* Ordered list of
* [`TransitionRouteGroups`][google.cloud.dialogflow.cx.v3beta1.TransitionRouteGroup]
* added to the page. Transition route groups must be unique within a page. If
* the page links both flow-level transition route groups and agent-level
* transition route groups, the flow-level ones will have higher priority and
* will be put before the agent-level ones.
*
* * If multiple transition routes within a page scope refer to the same
* intent, then the precedence order is: page's transition route -> page's
* transition route group -> flow's transition routes.
*
* * If multiple transition route groups within a page contain the same
* intent, then the first group in the ordered list takes precedence.
*
* Format:`projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>/transitionRouteGroups/<TransitionRouteGroupID>`
* or
* `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/transitionRouteGroups/<TransitionRouteGroupID>`
* for agent-level groups.
*
*
* repeated string transition_route_groups = 11 [(.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);
/**
*
*
*
* Ordered list of
* [`TransitionRouteGroups`][google.cloud.dialogflow.cx.v3beta1.TransitionRouteGroup]
* added to the page. Transition route groups must be unique within a page. If
* the page links both flow-level transition route groups and agent-level
* transition route groups, the flow-level ones will have higher priority and
* will be put before the agent-level ones.
*
* * If multiple transition routes within a page scope refer to the same
* intent, then the precedence order is: page's transition route -> page's
* transition route group -> flow's transition routes.
*
* * If multiple transition route groups within a page contain the same
* intent, then the first group in the ordered list takes precedence.
*
* Format:`projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>/transitionRouteGroups/<TransitionRouteGroupID>`
* or
* `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/transitionRouteGroups/<TransitionRouteGroupID>`
* for agent-level groups.
*
*
* repeated string transition_route_groups = 11 [(.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);
/**
*
*
*
* A list of transitions for the transition rules of this page.
* They route the conversation to another page in the same flow, or another
* flow.
*
* When we are in a certain page, the TransitionRoutes are evalauted in the
* following order:
*
* * TransitionRoutes defined in the page with intent specified.
* * TransitionRoutes defined in the
* [transition route
* groups][google.cloud.dialogflow.cx.v3beta1.Page.transition_route_groups]
* with intent specified.
* * TransitionRoutes defined in flow with intent specified.
* * TransitionRoutes defined in the
* [transition route
* groups][google.cloud.dialogflow.cx.v3beta1.Flow.transition_route_groups]
* with intent specified.
* * TransitionRoutes defined in the page with only condition specified.
* * TransitionRoutes defined in the
* [transition route
* groups][google.cloud.dialogflow.cx.v3beta1.Page.transition_route_groups]
* with only condition specified.
*
*
* repeated .google.cloud.dialogflow.cx.v3beta1.TransitionRoute transition_routes = 9;
*
*/
java.util.List getTransitionRoutesList();
/**
*
*
*
* A list of transitions for the transition rules of this page.
* They route the conversation to another page in the same flow, or another
* flow.
*
* When we are in a certain page, the TransitionRoutes are evalauted in the
* following order:
*
* * TransitionRoutes defined in the page with intent specified.
* * TransitionRoutes defined in the
* [transition route
* groups][google.cloud.dialogflow.cx.v3beta1.Page.transition_route_groups]
* with intent specified.
* * TransitionRoutes defined in flow with intent specified.
* * TransitionRoutes defined in the
* [transition route
* groups][google.cloud.dialogflow.cx.v3beta1.Flow.transition_route_groups]
* with intent specified.
* * TransitionRoutes defined in the page with only condition specified.
* * TransitionRoutes defined in the
* [transition route
* groups][google.cloud.dialogflow.cx.v3beta1.Page.transition_route_groups]
* with only condition specified.
*
*
* repeated .google.cloud.dialogflow.cx.v3beta1.TransitionRoute transition_routes = 9;
*
*/
com.google.cloud.dialogflow.cx.v3beta1.TransitionRoute getTransitionRoutes(int index);
/**
*
*
*
* A list of transitions for the transition rules of this page.
* They route the conversation to another page in the same flow, or another
* flow.
*
* When we are in a certain page, the TransitionRoutes are evalauted in the
* following order:
*
* * TransitionRoutes defined in the page with intent specified.
* * TransitionRoutes defined in the
* [transition route
* groups][google.cloud.dialogflow.cx.v3beta1.Page.transition_route_groups]
* with intent specified.
* * TransitionRoutes defined in flow with intent specified.
* * TransitionRoutes defined in the
* [transition route
* groups][google.cloud.dialogflow.cx.v3beta1.Flow.transition_route_groups]
* with intent specified.
* * TransitionRoutes defined in the page with only condition specified.
* * TransitionRoutes defined in the
* [transition route
* groups][google.cloud.dialogflow.cx.v3beta1.Page.transition_route_groups]
* with only condition specified.
*
*
* repeated .google.cloud.dialogflow.cx.v3beta1.TransitionRoute transition_routes = 9;
*
*/
int getTransitionRoutesCount();
/**
*
*
*
* A list of transitions for the transition rules of this page.
* They route the conversation to another page in the same flow, or another
* flow.
*
* When we are in a certain page, the TransitionRoutes are evalauted in the
* following order:
*
* * TransitionRoutes defined in the page with intent specified.
* * TransitionRoutes defined in the
* [transition route
* groups][google.cloud.dialogflow.cx.v3beta1.Page.transition_route_groups]
* with intent specified.
* * TransitionRoutes defined in flow with intent specified.
* * TransitionRoutes defined in the
* [transition route
* groups][google.cloud.dialogflow.cx.v3beta1.Flow.transition_route_groups]
* with intent specified.
* * TransitionRoutes defined in the page with only condition specified.
* * TransitionRoutes defined in the
* [transition route
* groups][google.cloud.dialogflow.cx.v3beta1.Page.transition_route_groups]
* with only condition specified.
*
*
* repeated .google.cloud.dialogflow.cx.v3beta1.TransitionRoute transition_routes = 9;
*
*/
java.util.List
getTransitionRoutesOrBuilderList();
/**
*
*
*
* A list of transitions for the transition rules of this page.
* They route the conversation to another page in the same flow, or another
* flow.
*
* When we are in a certain page, the TransitionRoutes are evalauted in the
* following order:
*
* * TransitionRoutes defined in the page with intent specified.
* * TransitionRoutes defined in the
* [transition route
* groups][google.cloud.dialogflow.cx.v3beta1.Page.transition_route_groups]
* with intent specified.
* * TransitionRoutes defined in flow with intent specified.
* * TransitionRoutes defined in the
* [transition route
* groups][google.cloud.dialogflow.cx.v3beta1.Flow.transition_route_groups]
* with intent specified.
* * TransitionRoutes defined in the page with only condition specified.
* * TransitionRoutes defined in the
* [transition route
* groups][google.cloud.dialogflow.cx.v3beta1.Page.transition_route_groups]
* with only condition specified.
*
*
* repeated .google.cloud.dialogflow.cx.v3beta1.TransitionRoute transition_routes = 9;
*
*/
com.google.cloud.dialogflow.cx.v3beta1.TransitionRouteOrBuilder getTransitionRoutesOrBuilder(
int index);
/**
*
*
*
* Handlers associated with the page to handle events such as webhook errors,
* no match or no input.
*
*
* repeated .google.cloud.dialogflow.cx.v3beta1.EventHandler event_handlers = 10;
*/
java.util.List getEventHandlersList();
/**
*
*
*
* Handlers associated with the page to handle events such as webhook errors,
* no match or no input.
*
*
* repeated .google.cloud.dialogflow.cx.v3beta1.EventHandler event_handlers = 10;
*/
com.google.cloud.dialogflow.cx.v3beta1.EventHandler getEventHandlers(int index);
/**
*
*
*
* Handlers associated with the page to handle events such as webhook errors,
* no match or no input.
*
*
* repeated .google.cloud.dialogflow.cx.v3beta1.EventHandler event_handlers = 10;
*/
int getEventHandlersCount();
/**
*
*
*
* Handlers associated with the page to handle events such as webhook errors,
* no match or no input.
*
*
* repeated .google.cloud.dialogflow.cx.v3beta1.EventHandler event_handlers = 10;
*/
java.util.List
getEventHandlersOrBuilderList();
/**
*
*
*
* Handlers associated with the page to handle events such as webhook errors,
* no match or no input.
*
*
* repeated .google.cloud.dialogflow.cx.v3beta1.EventHandler event_handlers = 10;
*/
com.google.cloud.dialogflow.cx.v3beta1.EventHandlerOrBuilder getEventHandlersOrBuilder(int index);
/**
*
*
*
* Hierarchical advanced settings for this page. The settings exposed at the
* lower level overrides the settings exposed at the higher level.
*
*
* .google.cloud.dialogflow.cx.v3beta1.AdvancedSettings advanced_settings = 13;
*
* @return Whether the advancedSettings field is set.
*/
boolean hasAdvancedSettings();
/**
*
*
*
* Hierarchical advanced settings for this page. The settings exposed at the
* lower level overrides the settings exposed at the higher level.
*
*
* .google.cloud.dialogflow.cx.v3beta1.AdvancedSettings advanced_settings = 13;
*
* @return The advancedSettings.
*/
com.google.cloud.dialogflow.cx.v3beta1.AdvancedSettings getAdvancedSettings();
/**
*
*
*
* Hierarchical advanced settings for this page. The settings exposed at the
* lower level overrides the settings exposed at the higher level.
*
*
* .google.cloud.dialogflow.cx.v3beta1.AdvancedSettings advanced_settings = 13;
*/
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();
}