xref: /aosp_15_r20/external/googleapis/google/cloud/discoveryengine/v1alpha/acl_config_service.proto (revision d5c09012810ac0c9f33fe448fb6da8260d444cc9)
1// Copyright 2022 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.discoveryengine.v1alpha;
18
19import "google/api/annotations.proto";
20import "google/api/client.proto";
21import "google/api/field_behavior.proto";
22import "google/api/resource.proto";
23import "google/cloud/discoveryengine/v1alpha/acl_config.proto";
24
25option csharp_namespace = "Google.Cloud.DiscoveryEngine.V1Alpha";
26option go_package = "cloud.google.com/go/discoveryengine/apiv1alpha/discoveryenginepb;discoveryenginepb";
27option java_multiple_files = true;
28option java_outer_classname = "AclConfigServiceProto";
29option java_package = "com.google.cloud.discoveryengine.v1alpha";
30option objc_class_prefix = "DISCOVERYENGINE";
31option php_namespace = "Google\\Cloud\\DiscoveryEngine\\V1alpha";
32option ruby_package = "Google::Cloud::DiscoveryEngine::V1alpha";
33
34// Service for managing Acl Configuration.
35service AclConfigService {
36  option (google.api.default_host) = "discoveryengine.googleapis.com";
37  option (google.api.oauth_scopes) =
38      "https://www.googleapis.com/auth/cloud-platform";
39
40  // Default Acl Configuration for use in a location of a customer's project.
41  // Updates will only reflect to new data stores. Existing data stores will
42  // still use the old value.
43  rpc UpdateAclConfig(UpdateAclConfigRequest) returns (AclConfig) {
44    option (google.api.http) = {
45      patch: "/v1alpha/{acl_config.name=projects/*/locations/*/aclConfig}"
46      body: "acl_config"
47    };
48  }
49
50  // Gets the [AclConfig][google.cloud.discoveryengine.v1alpha.AclConfig].
51  rpc GetAclConfig(GetAclConfigRequest) returns (AclConfig) {
52    option (google.api.http) = {
53      get: "/v1alpha/{name=projects/*/locations/*/aclConfig}"
54    };
55    option (google.api.method_signature) = "name";
56  }
57}
58
59// Request message for GetAclConfigRequest method.
60message GetAclConfigRequest {
61  // Required. Resource name of
62  // [AclConfig][google.cloud.discoveryengine.v1alpha.AclConfig], such as
63  // `projects/*/locations/*/aclConfig`.
64  //
65  // If the caller does not have permission to access the
66  // [AclConfig][google.cloud.discoveryengine.v1alpha.AclConfig], regardless of
67  // whether or not it exists, a PERMISSION_DENIED error is returned.
68  string name = 1 [
69    (google.api.field_behavior) = REQUIRED,
70    (google.api.resource_reference) = {
71      type: "discoveryengine.googleapis.com/AclConfig"
72    }
73  ];
74}
75
76// Request message for UpdateAclConfig method.
77message UpdateAclConfigRequest {
78  AclConfig acl_config = 1 [(google.api.field_behavior) = REQUIRED];
79}
80