xref: /aosp_15_r20/external/googleapis/google/cloud/dialogflow/cx/v3/data_store_connection.proto (revision d5c09012810ac0c9f33fe448fb6da8260d444cc9)
1// Copyright 2023 Google LLC
2//
3// Licensed under the Apache License, Version 2.0 (the "License");
4// you may not use this file except in compliance with the License.
5// You may obtain a copy of the License at
6//
7//     http://www.apache.org/licenses/LICENSE-2.0
8//
9// Unless required by applicable law or agreed to in writing, software
10// distributed under the License is distributed on an "AS IS" BASIS,
11// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12// See the License for the specific language governing permissions and
13// limitations under the License.
14
15syntax = "proto3";
16
17package google.cloud.dialogflow.cx.v3;
18
19option cc_enable_arenas = true;
20option csharp_namespace = "Google.Cloud.Dialogflow.Cx.V3";
21option go_package = "cloud.google.com/go/dialogflow/cx/apiv3/cxpb;cxpb";
22option java_multiple_files = true;
23option java_outer_classname = "DataStoreConnectionProto";
24option java_package = "com.google.cloud.dialogflow.cx.v3";
25option objc_class_prefix = "DF";
26option ruby_package = "Google::Cloud::Dialogflow::CX::V3";
27
28// A data store connection. It represents a data store in Discovery Engine and
29// the type of the contents it contains.
30message DataStoreConnection {
31  // The type of the connected data store.
32  DataStoreType data_store_type = 1;
33
34  // The full name of the referenced data store.
35  // Formats:
36  // `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`
37  // `projects/{project}/locations/{location}/dataStores/{data_store}`
38  string data_store = 2;
39}
40
41// Type of a data store.
42// Determines how search is performed in the data store.
43enum DataStoreType {
44  // Not specified. This value indicates that the data store type is not
45  // specified, so it will not be used during search.
46  DATA_STORE_TYPE_UNSPECIFIED = 0;
47
48  // A data store that contains public web content.
49  PUBLIC_WEB = 1;
50
51  // A data store that contains unstructured private data.
52  UNSTRUCTURED = 2;
53
54  // A data store that contains structured data (for example FAQ).
55  STRUCTURED = 3;
56}
57