@google-cloud/discoveryengine 2.2.0 → 2.4.0

package/build/protos/google/cloud/discoveryengine/v1beta/session_service.proto

@@ -0,0 +1,128 @@
+// Copyright 2025 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.discoveryengine.v1beta;
+
+import "google/api/annotations.proto";
+import "google/api/client.proto";
+import "google/api/field_behavior.proto";
+import "google/api/resource.proto";
+import "google/cloud/discoveryengine/v1beta/conversational_search_service.proto";
+import "google/cloud/discoveryengine/v1beta/session.proto";
+import "google/protobuf/empty.proto";
+
+option csharp_namespace = "Google.Cloud.DiscoveryEngine.V1Beta";
+option go_package = "cloud.google.com/go/discoveryengine/apiv1beta/discoveryenginepb;discoveryenginepb";
+option java_multiple_files = true;
+option java_outer_classname = "SessionServiceProto";
+option java_package = "com.google.cloud.discoveryengine.v1beta";
+option objc_class_prefix = "DISCOVERYENGINE";
+option php_namespace = "Google\\Cloud\\DiscoveryEngine\\V1beta";
+option ruby_package = "Google::Cloud::DiscoveryEngine::V1beta";
+
+// Service for managing Sessions and Session-related resources.
+service SessionService {
+  option (google.api.default_host) = "discoveryengine.googleapis.com";
+  option (google.api.oauth_scopes) =
+      "https://www.googleapis.com/auth/cloud-platform";
+
+  // Creates a Session.
+  //
+  // If the [Session][google.cloud.discoveryengine.v1beta.Session] to create
+  // already exists, an ALREADY_EXISTS error is returned.
+  rpc CreateSession(CreateSessionRequest) returns (Session) {
+    option (google.api.http) = {
+      post: "/v1beta/{parent=projects/*/locations/*/dataStores/*}/sessions"
+      body: "session"
+      additional_bindings {
+        post: "/v1beta/{parent=projects/*/locations/*/collections/*/dataStores/*}/sessions"
+        body: "session"
+      }
+      additional_bindings {
+        post: "/v1beta/{parent=projects/*/locations/*/collections/*/engines/*}/sessions"
+        body: "session"
+      }
+    };
+    option (google.api.method_signature) = "parent,session";
+  }
+
+  // Deletes a Session.
+  //
+  // If the [Session][google.cloud.discoveryengine.v1beta.Session] to delete
+  // does not exist, a NOT_FOUND error is returned.
+  rpc DeleteSession(DeleteSessionRequest) returns (google.protobuf.Empty) {
+    option (google.api.http) = {
+      delete: "/v1beta/{name=projects/*/locations/*/dataStores/*/sessions/*}"
+      additional_bindings {
+        delete: "/v1beta/{name=projects/*/locations/*/collections/*/dataStores/*/sessions/*}"
+      }
+      additional_bindings {
+        delete: "/v1beta/{name=projects/*/locations/*/collections/*/engines/*/sessions/*}"
+      }
+    };
+    option (google.api.method_signature) = "name";
+  }
+
+  // Updates a Session.
+  //
+  // [Session][google.cloud.discoveryengine.v1beta.Session] action type cannot
+  // be changed. If the [Session][google.cloud.discoveryengine.v1beta.Session]
+  // to update does not exist, a NOT_FOUND error is returned.
+  rpc UpdateSession(UpdateSessionRequest) returns (Session) {
+    option (google.api.http) = {
+      patch: "/v1beta/{session.name=projects/*/locations/*/dataStores/*/sessions/*}"
+      body: "session"
+      additional_bindings {
+        patch: "/v1beta/{session.name=projects/*/locations/*/collections/*/dataStores/*/sessions/*}"
+        body: "session"
+      }
+      additional_bindings {
+        patch: "/v1beta/{session.name=projects/*/locations/*/collections/*/engines/*/sessions/*}"
+        body: "session"
+      }
+    };
+    option (google.api.method_signature) = "session,update_mask";
+  }
+
+  // Gets a Session.
+  rpc GetSession(GetSessionRequest) returns (Session) {
+    option (google.api.http) = {
+      get: "/v1beta/{name=projects/*/locations/*/dataStores/*/sessions/*}"
+      additional_bindings {
+        get: "/v1beta/{name=projects/*/locations/*/collections/*/dataStores/*/sessions/*}"
+      }
+      additional_bindings {
+        get: "/v1beta/{name=projects/*/locations/*/collections/*/engines/*/sessions/*}"
+      }
+    };
+    option (google.api.method_signature) = "name";
+  }
+
+  // Lists all Sessions by their parent
+  // [DataStore][google.cloud.discoveryengine.v1beta.DataStore].
+  rpc ListSessions(ListSessionsRequest) returns (ListSessionsResponse) {
+    option (google.api.http) = {
+      get: "/v1beta/{parent=projects/*/locations/*/dataStores/*}/sessions"
+      additional_bindings {
+        get: "/v1beta/{parent=projects/*/locations/*/collections/*/dataStores/*}/sessions"
+      }
+      additional_bindings {
+        get: "/v1beta/{parent=projects/*/locations/*/collections/*/engines/*}/sessions"
+      }
+    };
+    option (google.api.method_signature) = "parent";
+  }
+}