// Copyright 2023 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;

option cc_enable_arenas = true;
option csharp_namespace = "Google.Cloud.Dialogflow.Cx.V3";
option go_package = "cloud.google.com/go/dialogflow/cx/apiv3/cxpb;cxpb";
option java_multiple_files = true;
option java_outer_classname = "DataStoreConnectionProto";
option java_package = "com.google.cloud.dialogflow.cx.v3";
option objc_class_prefix = "DF";
option ruby_package = "Google::Cloud::Dialogflow::CX::V3";

// A data store connection. It represents a data store in Discovery Engine and
// the type of the contents it contains.
message DataStoreConnection {
  // The type of the connected data store.
  DataStoreType data_store_type = 1;

  // The full name of the referenced data store.
  // Formats:
  // `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`
  // `projects/{project}/locations/{location}/dataStores/{data_store}`
  string data_store = 2;
}

// Type of a data store.
// Determines how search is performed in the data store.
enum DataStoreType {
  // Not specified. This value indicates that the data store type is not
  // specified, so it will not be used during search.
  DATA_STORE_TYPE_UNSPECIFIED = 0;

  // A data store that contains public web content.
  PUBLIC_WEB = 1;

  // A data store that contains unstructured private data.
  UNSTRUCTURED = 2;

  // A data store that contains structured data (for example FAQ).
  STRUCTURED = 3;
}
