249 lines
11 KiB
Protocol Buffer
249 lines
11 KiB
Protocol Buffer
// Copyright 2020 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
|
|
//
|
|
// http://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.
|
|
|
|
syntax = "proto3";
|
|
|
|
package google.cloud.dialogflow.cx.v3;
|
|
|
|
import "google/api/annotations.proto";
|
|
import "google/api/client.proto";
|
|
import "google/api/field_behavior.proto";
|
|
import "google/api/resource.proto";
|
|
import "google/cloud/dialogflow/cx/v3/page.proto";
|
|
import "google/protobuf/empty.proto";
|
|
import "google/protobuf/field_mask.proto";
|
|
|
|
option cc_enable_arenas = true;
|
|
option csharp_namespace = "Google.Cloud.Dialogflow.Cx.V3";
|
|
option go_package = "google.golang.org/genproto/googleapis/cloud/dialogflow/cx/v3;cx";
|
|
option java_multiple_files = true;
|
|
option java_outer_classname = "TransitionRouteGroupProto";
|
|
option java_package = "com.google.cloud.dialogflow.cx.v3";
|
|
option objc_class_prefix = "DF";
|
|
|
|
// Service for managing [TransitionRouteGroups][google.cloud.dialogflow.cx.v3.TransitionRouteGroup].
|
|
service TransitionRouteGroups {
|
|
option (google.api.default_host) = "dialogflow.googleapis.com";
|
|
option (google.api.oauth_scopes) =
|
|
"https://www.googleapis.com/auth/cloud-platform,"
|
|
"https://www.googleapis.com/auth/dialogflow";
|
|
|
|
// Returns the list of all transition route groups in the specified flow.
|
|
rpc ListTransitionRouteGroups(ListTransitionRouteGroupsRequest) returns (ListTransitionRouteGroupsResponse) {
|
|
option (google.api.http) = {
|
|
get: "/v3/{parent=projects/*/locations/*/agents/*/flows/*}/transitionRouteGroups"
|
|
};
|
|
option (google.api.method_signature) = "parent";
|
|
}
|
|
|
|
// Retrieves the specified [TransitionRouteGroup][google.cloud.dialogflow.cx.v3.TransitionRouteGroup].
|
|
rpc GetTransitionRouteGroup(GetTransitionRouteGroupRequest) returns (TransitionRouteGroup) {
|
|
option (google.api.http) = {
|
|
get: "/v3/{name=projects/*/locations/*/agents/*/flows/*/transitionRouteGroups/*}"
|
|
};
|
|
option (google.api.method_signature) = "name";
|
|
}
|
|
|
|
// Creates an [TransitionRouteGroup][google.cloud.dialogflow.cx.v3.TransitionRouteGroup] in the specified flow.
|
|
rpc CreateTransitionRouteGroup(CreateTransitionRouteGroupRequest) returns (TransitionRouteGroup) {
|
|
option (google.api.http) = {
|
|
post: "/v3/{parent=projects/*/locations/*/agents/*/flows/*}/transitionRouteGroups"
|
|
body: "transition_route_group"
|
|
};
|
|
option (google.api.method_signature) = "parent,transition_route_group";
|
|
}
|
|
|
|
// Updates the specified [TransitionRouteGroup][google.cloud.dialogflow.cx.v3.TransitionRouteGroup].
|
|
rpc UpdateTransitionRouteGroup(UpdateTransitionRouteGroupRequest) returns (TransitionRouteGroup) {
|
|
option (google.api.http) = {
|
|
patch: "/v3/{transition_route_group.name=projects/*/locations/*/agents/*/flows/*/transitionRouteGroups/*}"
|
|
body: "transition_route_group"
|
|
};
|
|
option (google.api.method_signature) = "transition_route_group,update_mask";
|
|
}
|
|
|
|
// Deletes the specified [TransitionRouteGroup][google.cloud.dialogflow.cx.v3.TransitionRouteGroup].
|
|
rpc DeleteTransitionRouteGroup(DeleteTransitionRouteGroupRequest) returns (google.protobuf.Empty) {
|
|
option (google.api.http) = {
|
|
delete: "/v3/{name=projects/*/locations/*/agents/*/flows/*/transitionRouteGroups/*}"
|
|
};
|
|
option (google.api.method_signature) = "name";
|
|
}
|
|
}
|
|
|
|
// An TransitionRouteGroup represents a group of
|
|
// [`TransitionRoutes`][google.cloud.dialogflow.cx.v3.TransitionRoute] to be used by a [Page][google.cloud.dialogflow.cx.v3.Page].
|
|
message TransitionRouteGroup {
|
|
option (google.api.resource) = {
|
|
type: "dialogflow.googleapis.com/TransitionRouteGroup"
|
|
pattern: "projects/{project}/locations/{location}/agents/{agent}/flows/{flow}/transitionRouteGroups/{transition_route_group}"
|
|
};
|
|
|
|
// The unique identifier of the transition route group.
|
|
// [TransitionRouteGroups.CreateTransitionRouteGroup][google.cloud.dialogflow.cx.v3.TransitionRouteGroups.CreateTransitionRouteGroup] populates the name
|
|
// automatically.
|
|
// Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
|
|
// ID>/flows/<Flow ID>/transitionRouteGroups/<Transition Route Group ID>`.
|
|
string name = 1;
|
|
|
|
// Required. The human-readable name of the transition route group, unique within
|
|
// the [Agent][google.cloud.dialogflow.cx.v3.Agent]. The display name can be no longer than 30 characters.
|
|
string display_name = 2 [(google.api.field_behavior) = REQUIRED];
|
|
|
|
// Transition routes associated with the [TransitionRouteGroup][google.cloud.dialogflow.cx.v3.TransitionRouteGroup].
|
|
// Duplicate transition routes (i.e. using the same
|
|
// [`intent`][google.cloud.dialogflow.cx.v3.TransitionRoute.intent]) are not allowed.
|
|
//
|
|
// Note that the [`name`][google.cloud.dialogflow.cx.v3.TransitionRoute.name] field is not used in the
|
|
// transition route group scope.
|
|
repeated TransitionRoute transition_routes = 5;
|
|
}
|
|
|
|
// The request message for [TransitionRouteGroups.ListTransitionRouteGroups][google.cloud.dialogflow.cx.v3.TransitionRouteGroups.ListTransitionRouteGroups].
|
|
message ListTransitionRouteGroupsRequest {
|
|
// Required. The flow to list all transition route groups for.
|
|
// Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
|
|
// ID>/flows/<Flow ID>`.
|
|
string parent = 1 [
|
|
(google.api.field_behavior) = REQUIRED,
|
|
(google.api.resource_reference) = {
|
|
child_type: "dialogflow.googleapis.com/TransitionRouteGroup"
|
|
}
|
|
];
|
|
|
|
// The maximum number of items to return in a single page. By default 100 and
|
|
// at most 1000.
|
|
int32 page_size = 2;
|
|
|
|
// The next_page_token value returned from a previous list request.
|
|
string page_token = 3;
|
|
|
|
// The language to list transition route groups for. The field
|
|
// [`messages`][TransitionRoute.trigger_fulfillment.messages] in
|
|
// [TransitionRoute][google.cloud.dialogflow.cx.v3.TransitionRoute] is language dependent.
|
|
//
|
|
// If not specified, the agent's default language is used.
|
|
// [Many
|
|
// languages](https://cloud.google.com/dialogflow/docs/reference/language)
|
|
// are supported.
|
|
// Note: languages must be enabled in the agent before they can be used.
|
|
string language_code = 4;
|
|
}
|
|
|
|
// The response message for [TransitionRouteGroups.ListTransitionRouteGroups][google.cloud.dialogflow.cx.v3.TransitionRouteGroups.ListTransitionRouteGroups].
|
|
message ListTransitionRouteGroupsResponse {
|
|
// The list of transition route groups. There will be a maximum number of
|
|
// items returned based on the page_size field in the request. The list may in
|
|
// some cases be empty or contain fewer entries than page_size even if this
|
|
// isn't the last page.
|
|
repeated TransitionRouteGroup transition_route_groups = 1;
|
|
|
|
// Token to retrieve the next page of results, or empty if there are no more
|
|
// results in the list.
|
|
string next_page_token = 2;
|
|
}
|
|
|
|
// The request message for [TransitionRouteGroups.GetTransitionRouteGroup][google.cloud.dialogflow.cx.v3.TransitionRouteGroups.GetTransitionRouteGroup].
|
|
message GetTransitionRouteGroupRequest {
|
|
// Required. The name of the [TransitionRouteGroup][google.cloud.dialogflow.cx.v3.TransitionRouteGroup].
|
|
// Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
|
|
// ID>/flows/<Flow ID>/transitionRouteGroups/<Transition Route Group ID>`.
|
|
string name = 1 [
|
|
(google.api.field_behavior) = REQUIRED,
|
|
(google.api.resource_reference) = {
|
|
type: "dialogflow.googleapis.com/TransitionRouteGroup"
|
|
}
|
|
];
|
|
|
|
// The language to list transition route groups for. The field
|
|
// [`messages`][TransitionRoute.trigger_fulfillment.messages] in
|
|
// [TransitionRoute][google.cloud.dialogflow.cx.v3.TransitionRoute] is language dependent.
|
|
//
|
|
// If not specified, the agent's default language is used.
|
|
// [Many
|
|
// languages](https://cloud.google.com/dialogflow/docs/reference/language)
|
|
// are supported.
|
|
// Note: languages must be enabled in the agent before they can be used.
|
|
string language_code = 2;
|
|
}
|
|
|
|
// The request message for [TransitionRouteGroups.CreateTransitionRouteGroup][google.cloud.dialogflow.cx.v3.TransitionRouteGroups.CreateTransitionRouteGroup].
|
|
message CreateTransitionRouteGroupRequest {
|
|
// Required. The flow to create an [TransitionRouteGroup][google.cloud.dialogflow.cx.v3.TransitionRouteGroup] for.
|
|
// Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
|
|
// ID>/flows/<Flow ID>`.
|
|
string parent = 1 [
|
|
(google.api.field_behavior) = REQUIRED,
|
|
(google.api.resource_reference) = {
|
|
child_type: "dialogflow.googleapis.com/TransitionRouteGroup"
|
|
}
|
|
];
|
|
|
|
// Required. The transition route group to create.
|
|
TransitionRouteGroup transition_route_group = 2 [(google.api.field_behavior) = REQUIRED];
|
|
|
|
// The language to list transition route groups for. The field
|
|
// [`messages`][TransitionRoute.trigger_fulfillment.messages] in
|
|
// [TransitionRoute][google.cloud.dialogflow.cx.v3.TransitionRoute] is language dependent.
|
|
//
|
|
// If not specified, the agent's default language is used.
|
|
// [Many
|
|
// languages](https://cloud.google.com/dialogflow/docs/reference/language)
|
|
// are supported.
|
|
// Note: languages must be enabled in the agent before they can be used.
|
|
string language_code = 3;
|
|
}
|
|
|
|
// The request message for [TransitionRouteGroups.UpdateTransitionRouteGroup][google.cloud.dialogflow.cx.v3.TransitionRouteGroups.UpdateTransitionRouteGroup].
|
|
message UpdateTransitionRouteGroupRequest {
|
|
// Required. The transition route group to update.
|
|
TransitionRouteGroup transition_route_group = 1 [(google.api.field_behavior) = REQUIRED];
|
|
|
|
// The mask to control which fields get updated.
|
|
google.protobuf.FieldMask update_mask = 2;
|
|
|
|
// The language to list transition route groups for. The field
|
|
// [`messages`][TransitionRoute.trigger_fulfillment.messages] in
|
|
// [TransitionRoute][google.cloud.dialogflow.cx.v3.TransitionRoute] is language dependent.
|
|
//
|
|
// If not specified, the agent's default language is used.
|
|
// [Many
|
|
// languages](https://cloud.google.com/dialogflow/docs/reference/language)
|
|
// are supported.
|
|
// Note: languages must be enabled in the agent before they can be used.
|
|
string language_code = 3;
|
|
}
|
|
|
|
// The request message for [TransitionRouteGroups.DeleteTransitionRouteGroup][google.cloud.dialogflow.cx.v3.TransitionRouteGroups.DeleteTransitionRouteGroup].
|
|
message DeleteTransitionRouteGroupRequest {
|
|
// Required. The name of the [TransitionRouteGroup][google.cloud.dialogflow.cx.v3.TransitionRouteGroup] to delete.
|
|
// Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
|
|
// ID>/flows/<Flow ID>/transitionRouteGroups/<Transition Route Group ID>`.
|
|
string name = 1 [
|
|
(google.api.field_behavior) = REQUIRED,
|
|
(google.api.resource_reference) = {
|
|
type: "dialogflow.googleapis.com/TransitionRouteGroup"
|
|
}
|
|
];
|
|
|
|
// This field has no effect for transition route group that no page is using.
|
|
// If the transition route group is referenced by any page:
|
|
//
|
|
// * If `force` is set to false, an error will be returned with message
|
|
// indicating pages that reference the transition route group.
|
|
// * If `force` is set to true, Dialogflow will remove the transition route
|
|
// group, as well as any reference to it.
|
|
bool force = 2;
|
|
}
|