google-cloud-chronicle-v1 0.a → 0.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/.yardopts +12 -0
- data/AUTHENTICATION.md +122 -0
- data/README.md +154 -8
- data/lib/google/cloud/chronicle/v1/data_access_control_pb.rb +67 -0
- data/lib/google/cloud/chronicle/v1/data_access_control_service/client.rb +1414 -0
- data/lib/google/cloud/chronicle/v1/data_access_control_service/credentials.rb +47 -0
- data/lib/google/cloud/chronicle/v1/data_access_control_service/paths.rb +94 -0
- data/lib/google/cloud/chronicle/v1/data_access_control_service/rest/client.rb +1318 -0
- data/lib/google/cloud/chronicle/v1/data_access_control_service/rest/service_stub.rb +695 -0
- data/lib/google/cloud/chronicle/v1/data_access_control_service/rest.rb +53 -0
- data/lib/google/cloud/chronicle/v1/data_access_control_service.rb +56 -0
- data/lib/google/cloud/chronicle/v1/data_access_control_services_pb.rb +76 -0
- data/lib/google/cloud/chronicle/v1/entity_pb.rb +62 -0
- data/lib/google/cloud/chronicle/v1/entity_service/client.rb +891 -0
- data/lib/google/cloud/chronicle/v1/entity_service/credentials.rb +47 -0
- data/lib/google/cloud/chronicle/v1/entity_service/paths.rb +73 -0
- data/lib/google/cloud/chronicle/v1/entity_service/rest/client.rb +830 -0
- data/lib/google/cloud/chronicle/v1/entity_service/rest/service_stub.rb +388 -0
- data/lib/google/cloud/chronicle/v1/entity_service/rest.rb +52 -0
- data/lib/google/cloud/chronicle/v1/entity_service.rb +55 -0
- data/lib/google/cloud/chronicle/v1/entity_services_pb.rb +54 -0
- data/lib/google/cloud/chronicle/v1/instance_pb.rb +48 -0
- data/lib/google/cloud/chronicle/v1/instance_service/client.rb +464 -0
- data/lib/google/cloud/chronicle/v1/instance_service/credentials.rb +47 -0
- data/lib/google/cloud/chronicle/v1/instance_service/paths.rb +52 -0
- data/lib/google/cloud/chronicle/v1/instance_service/rest/client.rb +431 -0
- data/lib/google/cloud/chronicle/v1/instance_service/rest/service_stub.rb +142 -0
- data/lib/google/cloud/chronicle/v1/instance_service/rest.rb +52 -0
- data/lib/google/cloud/chronicle/v1/instance_service.rb +55 -0
- data/lib/google/cloud/chronicle/v1/instance_services_pb.rb +45 -0
- data/lib/google/cloud/chronicle/v1/reference_list_pb.rb +61 -0
- data/lib/google/cloud/chronicle/v1/reference_list_service/client.rb +792 -0
- data/lib/google/cloud/chronicle/v1/reference_list_service/credentials.rb +47 -0
- data/lib/google/cloud/chronicle/v1/reference_list_service/paths.rb +73 -0
- data/lib/google/cloud/chronicle/v1/reference_list_service/rest/client.rb +738 -0
- data/lib/google/cloud/chronicle/v1/reference_list_service/rest/service_stub.rb +327 -0
- data/lib/google/cloud/chronicle/v1/reference_list_service/rest.rb +52 -0
- data/lib/google/cloud/chronicle/v1/reference_list_service.rb +55 -0
- data/lib/google/cloud/chronicle/v1/reference_list_services_pb.rb +51 -0
- data/lib/google/cloud/chronicle/v1/rest.rb +41 -0
- data/lib/google/cloud/chronicle/v1/rule_pb.rb +85 -0
- data/lib/google/cloud/chronicle/v1/rule_service/client.rb +1674 -0
- data/lib/google/cloud/chronicle/v1/rule_service/credentials.rb +47 -0
- data/lib/google/cloud/chronicle/v1/rule_service/operations.rb +813 -0
- data/lib/google/cloud/chronicle/v1/rule_service/paths.rb +159 -0
- data/lib/google/cloud/chronicle/v1/rule_service/rest/client.rb +1564 -0
- data/lib/google/cloud/chronicle/v1/rule_service/rest/operations.rb +914 -0
- data/lib/google/cloud/chronicle/v1/rule_service/rest/service_stub.rb +817 -0
- data/lib/google/cloud/chronicle/v1/rule_service/rest.rb +53 -0
- data/lib/google/cloud/chronicle/v1/rule_service.rb +56 -0
- data/lib/google/cloud/chronicle/v1/rule_services_pb.rb +70 -0
- data/lib/google/cloud/chronicle/v1/version.rb +7 -2
- data/lib/google/cloud/chronicle/v1.rb +49 -0
- data/lib/google-cloud-chronicle-v1.rb +21 -0
- data/proto_docs/README.md +4 -0
- data/proto_docs/google/api/client.rb +473 -0
- data/proto_docs/google/api/field_behavior.rb +85 -0
- data/proto_docs/google/api/launch_stage.rb +71 -0
- data/proto_docs/google/api/resource.rb +227 -0
- data/proto_docs/google/cloud/chronicle/v1/data_access_control.rb +364 -0
- data/proto_docs/google/cloud/chronicle/v1/entity.rb +210 -0
- data/proto_docs/google/cloud/chronicle/v1/instance.rb +47 -0
- data/proto_docs/google/cloud/chronicle/v1/reference_list.rb +232 -0
- data/proto_docs/google/cloud/chronicle/v1/rule.rb +701 -0
- data/proto_docs/google/longrunning/operations.rb +173 -0
- data/proto_docs/google/protobuf/any.rb +145 -0
- data/proto_docs/google/protobuf/duration.rb +98 -0
- data/proto_docs/google/protobuf/empty.rb +34 -0
- data/proto_docs/google/protobuf/field_mask.rb +229 -0
- data/proto_docs/google/protobuf/timestamp.rb +127 -0
- data/proto_docs/google/rpc/status.rb +48 -0
- data/proto_docs/google/type/interval.rb +45 -0
- metadata +110 -10
@@ -0,0 +1,1318 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
# Copyright 2025 Google LLC
|
4
|
+
#
|
5
|
+
# Licensed under the Apache License, Version 2.0 (the "License");
|
6
|
+
# you may not use this file except in compliance with the License.
|
7
|
+
# You may obtain a copy of the License at
|
8
|
+
#
|
9
|
+
# https://www.apache.org/licenses/LICENSE-2.0
|
10
|
+
#
|
11
|
+
# Unless required by applicable law or agreed to in writing, software
|
12
|
+
# distributed under the License is distributed on an "AS IS" BASIS,
|
13
|
+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
14
|
+
# See the License for the specific language governing permissions and
|
15
|
+
# limitations under the License.
|
16
|
+
|
17
|
+
# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
|
18
|
+
|
19
|
+
require "google/cloud/errors"
|
20
|
+
require "google/cloud/chronicle/v1/data_access_control_pb"
|
21
|
+
require "google/cloud/chronicle/v1/data_access_control_service/rest/service_stub"
|
22
|
+
|
23
|
+
module Google
|
24
|
+
module Cloud
|
25
|
+
module Chronicle
|
26
|
+
module V1
|
27
|
+
module DataAccessControlService
|
28
|
+
module Rest
|
29
|
+
##
|
30
|
+
# REST client for the DataAccessControlService service.
|
31
|
+
#
|
32
|
+
# DataAccessControlService exposes resources and endpoints related to data
|
33
|
+
# access control.
|
34
|
+
#
|
35
|
+
class Client
|
36
|
+
# @private
|
37
|
+
API_VERSION = ""
|
38
|
+
|
39
|
+
# @private
|
40
|
+
DEFAULT_ENDPOINT_TEMPLATE = "chronicle.$UNIVERSE_DOMAIN$"
|
41
|
+
|
42
|
+
include Paths
|
43
|
+
|
44
|
+
# @private
|
45
|
+
attr_reader :data_access_control_service_stub
|
46
|
+
|
47
|
+
##
|
48
|
+
# Configure the DataAccessControlService Client class.
|
49
|
+
#
|
50
|
+
# See {::Google::Cloud::Chronicle::V1::DataAccessControlService::Rest::Client::Configuration}
|
51
|
+
# for a description of the configuration fields.
|
52
|
+
#
|
53
|
+
# @example
|
54
|
+
#
|
55
|
+
# # Modify the configuration for all DataAccessControlService clients
|
56
|
+
# ::Google::Cloud::Chronicle::V1::DataAccessControlService::Rest::Client.configure do |config|
|
57
|
+
# config.timeout = 10.0
|
58
|
+
# end
|
59
|
+
#
|
60
|
+
# @yield [config] Configure the Client client.
|
61
|
+
# @yieldparam config [Client::Configuration]
|
62
|
+
#
|
63
|
+
# @return [Client::Configuration]
|
64
|
+
#
|
65
|
+
def self.configure
|
66
|
+
@configure ||= begin
|
67
|
+
namespace = ["Google", "Cloud", "Chronicle", "V1"]
|
68
|
+
parent_config = while namespace.any?
|
69
|
+
parent_name = namespace.join "::"
|
70
|
+
parent_const = const_get parent_name
|
71
|
+
break parent_const.configure if parent_const.respond_to? :configure
|
72
|
+
namespace.pop
|
73
|
+
end
|
74
|
+
default_config = Client::Configuration.new parent_config
|
75
|
+
|
76
|
+
default_config.rpcs.create_data_access_label.timeout = 60.0
|
77
|
+
|
78
|
+
default_config.rpcs.get_data_access_label.timeout = 60.0
|
79
|
+
default_config.rpcs.get_data_access_label.retry_policy = {
|
80
|
+
initial_delay: 1.0, max_delay: 60.0, multiplier: 1.3, retry_codes: [14]
|
81
|
+
}
|
82
|
+
|
83
|
+
default_config.rpcs.list_data_access_labels.timeout = 60.0
|
84
|
+
default_config.rpcs.list_data_access_labels.retry_policy = {
|
85
|
+
initial_delay: 1.0, max_delay: 60.0, multiplier: 1.3, retry_codes: [14]
|
86
|
+
}
|
87
|
+
|
88
|
+
default_config.rpcs.update_data_access_label.timeout = 60.0
|
89
|
+
|
90
|
+
default_config.rpcs.delete_data_access_label.timeout = 60.0
|
91
|
+
|
92
|
+
default_config.rpcs.create_data_access_scope.timeout = 60.0
|
93
|
+
|
94
|
+
default_config.rpcs.get_data_access_scope.timeout = 60.0
|
95
|
+
default_config.rpcs.get_data_access_scope.retry_policy = {
|
96
|
+
initial_delay: 1.0, max_delay: 60.0, multiplier: 1.3, retry_codes: [14]
|
97
|
+
}
|
98
|
+
|
99
|
+
default_config.rpcs.list_data_access_scopes.timeout = 60.0
|
100
|
+
default_config.rpcs.list_data_access_scopes.retry_policy = {
|
101
|
+
initial_delay: 1.0, max_delay: 60.0, multiplier: 1.3, retry_codes: [14]
|
102
|
+
}
|
103
|
+
|
104
|
+
default_config.rpcs.update_data_access_scope.timeout = 60.0
|
105
|
+
|
106
|
+
default_config.rpcs.delete_data_access_scope.timeout = 60.0
|
107
|
+
|
108
|
+
default_config
|
109
|
+
end
|
110
|
+
yield @configure if block_given?
|
111
|
+
@configure
|
112
|
+
end
|
113
|
+
|
114
|
+
##
|
115
|
+
# Configure the DataAccessControlService Client instance.
|
116
|
+
#
|
117
|
+
# The configuration is set to the derived mode, meaning that values can be changed,
|
118
|
+
# but structural changes (adding new fields, etc.) are not allowed. Structural changes
|
119
|
+
# should be made on {Client.configure}.
|
120
|
+
#
|
121
|
+
# See {::Google::Cloud::Chronicle::V1::DataAccessControlService::Rest::Client::Configuration}
|
122
|
+
# for a description of the configuration fields.
|
123
|
+
#
|
124
|
+
# @yield [config] Configure the Client client.
|
125
|
+
# @yieldparam config [Client::Configuration]
|
126
|
+
#
|
127
|
+
# @return [Client::Configuration]
|
128
|
+
#
|
129
|
+
def configure
|
130
|
+
yield @config if block_given?
|
131
|
+
@config
|
132
|
+
end
|
133
|
+
|
134
|
+
##
|
135
|
+
# The effective universe domain
|
136
|
+
#
|
137
|
+
# @return [String]
|
138
|
+
#
|
139
|
+
def universe_domain
|
140
|
+
@data_access_control_service_stub.universe_domain
|
141
|
+
end
|
142
|
+
|
143
|
+
##
|
144
|
+
# Create a new DataAccessControlService REST client object.
|
145
|
+
#
|
146
|
+
# @example
|
147
|
+
#
|
148
|
+
# # Create a client using the default configuration
|
149
|
+
# client = ::Google::Cloud::Chronicle::V1::DataAccessControlService::Rest::Client.new
|
150
|
+
#
|
151
|
+
# # Create a client using a custom configuration
|
152
|
+
# client = ::Google::Cloud::Chronicle::V1::DataAccessControlService::Rest::Client.new do |config|
|
153
|
+
# config.timeout = 10.0
|
154
|
+
# end
|
155
|
+
#
|
156
|
+
# @yield [config] Configure the DataAccessControlService client.
|
157
|
+
# @yieldparam config [Client::Configuration]
|
158
|
+
#
|
159
|
+
def initialize
|
160
|
+
# Create the configuration object
|
161
|
+
@config = Configuration.new Client.configure
|
162
|
+
|
163
|
+
# Yield the configuration if needed
|
164
|
+
yield @config if block_given?
|
165
|
+
|
166
|
+
# Create credentials
|
167
|
+
credentials = @config.credentials
|
168
|
+
# Use self-signed JWT if the endpoint is unchanged from default,
|
169
|
+
# but only if the default endpoint does not have a region prefix.
|
170
|
+
enable_self_signed_jwt = @config.endpoint.nil? ||
|
171
|
+
(@config.endpoint == Configuration::DEFAULT_ENDPOINT &&
|
172
|
+
!@config.endpoint.split(".").first.include?("-"))
|
173
|
+
credentials ||= Credentials.default scope: @config.scope,
|
174
|
+
enable_self_signed_jwt: enable_self_signed_jwt
|
175
|
+
if credentials.is_a?(::String) || credentials.is_a?(::Hash)
|
176
|
+
credentials = Credentials.new credentials, scope: @config.scope
|
177
|
+
end
|
178
|
+
|
179
|
+
@quota_project_id = @config.quota_project
|
180
|
+
@quota_project_id ||= credentials.quota_project_id if credentials.respond_to? :quota_project_id
|
181
|
+
|
182
|
+
@data_access_control_service_stub = ::Google::Cloud::Chronicle::V1::DataAccessControlService::Rest::ServiceStub.new(
|
183
|
+
endpoint: @config.endpoint,
|
184
|
+
endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
|
185
|
+
universe_domain: @config.universe_domain,
|
186
|
+
credentials: credentials,
|
187
|
+
logger: @config.logger
|
188
|
+
)
|
189
|
+
|
190
|
+
@data_access_control_service_stub.logger(stub: true)&.info do |entry|
|
191
|
+
entry.set_system_name
|
192
|
+
entry.set_service
|
193
|
+
entry.message = "Created client for #{entry.service}"
|
194
|
+
entry.set_credentials_fields credentials
|
195
|
+
entry.set "customEndpoint", @config.endpoint if @config.endpoint
|
196
|
+
entry.set "defaultTimeout", @config.timeout if @config.timeout
|
197
|
+
entry.set "quotaProject", @quota_project_id if @quota_project_id
|
198
|
+
end
|
199
|
+
end
|
200
|
+
|
201
|
+
##
|
202
|
+
# The logger used for request/response debug logging.
|
203
|
+
#
|
204
|
+
# @return [Logger]
|
205
|
+
#
|
206
|
+
def logger
|
207
|
+
@data_access_control_service_stub.logger
|
208
|
+
end
|
209
|
+
|
210
|
+
# Service calls
|
211
|
+
|
212
|
+
##
|
213
|
+
# Creates a data access label.
|
214
|
+
# Data access labels are applied to incoming event data and selected in data
|
215
|
+
# access scopes (another resource), and only users with scopes containing the
|
216
|
+
# label can see data with that label. Currently, the data access label
|
217
|
+
# resource only includes custom labels, which are labels that correspond
|
218
|
+
# to UDM queries over event data.
|
219
|
+
#
|
220
|
+
# @overload create_data_access_label(request, options = nil)
|
221
|
+
# Pass arguments to `create_data_access_label` via a request object, either of type
|
222
|
+
# {::Google::Cloud::Chronicle::V1::CreateDataAccessLabelRequest} or an equivalent Hash.
|
223
|
+
#
|
224
|
+
# @param request [::Google::Cloud::Chronicle::V1::CreateDataAccessLabelRequest, ::Hash]
|
225
|
+
# A request object representing the call parameters. Required. To specify no
|
226
|
+
# parameters, or to keep all the default parameter values, pass an empty Hash.
|
227
|
+
# @param options [::Gapic::CallOptions, ::Hash]
|
228
|
+
# Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
|
229
|
+
#
|
230
|
+
# @overload create_data_access_label(parent: nil, data_access_label: nil, data_access_label_id: nil)
|
231
|
+
# Pass arguments to `create_data_access_label` via keyword arguments. Note that at
|
232
|
+
# least one keyword argument is required. To specify no parameters, or to keep all
|
233
|
+
# the default parameter values, pass an empty Hash as a request object (see above).
|
234
|
+
#
|
235
|
+
# @param parent [::String]
|
236
|
+
# Required. The parent resource where this Data Access Label will be created.
|
237
|
+
# Format: `projects/{project}/locations/{location}/instances/{instance}`
|
238
|
+
# @param data_access_label [::Google::Cloud::Chronicle::V1::DataAccessLabel, ::Hash]
|
239
|
+
# Required. Data access label to create.
|
240
|
+
# @param data_access_label_id [::String]
|
241
|
+
# Required. The ID to use for the data access label, which will become the
|
242
|
+
# label's display name and the final component of the label's resource name.
|
243
|
+
# The maximum number of characters should be 63. Regex pattern is as per AIP:
|
244
|
+
# https://google.aip.dev/122#resource-id-segments
|
245
|
+
# @yield [result, operation] Access the result along with the TransportOperation object
|
246
|
+
# @yieldparam result [::Google::Cloud::Chronicle::V1::DataAccessLabel]
|
247
|
+
# @yieldparam operation [::Gapic::Rest::TransportOperation]
|
248
|
+
#
|
249
|
+
# @return [::Google::Cloud::Chronicle::V1::DataAccessLabel]
|
250
|
+
#
|
251
|
+
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
252
|
+
#
|
253
|
+
# @example Basic example
|
254
|
+
# require "google/cloud/chronicle/v1"
|
255
|
+
#
|
256
|
+
# # Create a client object. The client can be reused for multiple calls.
|
257
|
+
# client = Google::Cloud::Chronicle::V1::DataAccessControlService::Rest::Client.new
|
258
|
+
#
|
259
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
260
|
+
# request = Google::Cloud::Chronicle::V1::CreateDataAccessLabelRequest.new
|
261
|
+
#
|
262
|
+
# # Call the create_data_access_label method.
|
263
|
+
# result = client.create_data_access_label request
|
264
|
+
#
|
265
|
+
# # The returned object is of type Google::Cloud::Chronicle::V1::DataAccessLabel.
|
266
|
+
# p result
|
267
|
+
#
|
268
|
+
def create_data_access_label request, options = nil
|
269
|
+
raise ::ArgumentError, "request must be provided" if request.nil?
|
270
|
+
|
271
|
+
request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Chronicle::V1::CreateDataAccessLabelRequest
|
272
|
+
|
273
|
+
# Converts hash and nil to an options object
|
274
|
+
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
|
275
|
+
|
276
|
+
# Customize the options with defaults
|
277
|
+
call_metadata = @config.rpcs.create_data_access_label.metadata.to_h
|
278
|
+
|
279
|
+
# Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
|
280
|
+
call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
|
281
|
+
lib_name: @config.lib_name, lib_version: @config.lib_version,
|
282
|
+
gapic_version: ::Google::Cloud::Chronicle::V1::VERSION,
|
283
|
+
transports_version_send: [:rest]
|
284
|
+
|
285
|
+
call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
|
286
|
+
call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
287
|
+
|
288
|
+
options.apply_defaults timeout: @config.rpcs.create_data_access_label.timeout,
|
289
|
+
metadata: call_metadata,
|
290
|
+
retry_policy: @config.rpcs.create_data_access_label.retry_policy
|
291
|
+
|
292
|
+
options.apply_defaults timeout: @config.timeout,
|
293
|
+
metadata: @config.metadata,
|
294
|
+
retry_policy: @config.retry_policy
|
295
|
+
|
296
|
+
@data_access_control_service_stub.create_data_access_label request, options do |result, operation|
|
297
|
+
yield result, operation if block_given?
|
298
|
+
end
|
299
|
+
rescue ::Gapic::Rest::Error => e
|
300
|
+
raise ::Google::Cloud::Error.from_error(e)
|
301
|
+
end
|
302
|
+
|
303
|
+
##
|
304
|
+
# Gets a data access label.
|
305
|
+
#
|
306
|
+
# @overload get_data_access_label(request, options = nil)
|
307
|
+
# Pass arguments to `get_data_access_label` via a request object, either of type
|
308
|
+
# {::Google::Cloud::Chronicle::V1::GetDataAccessLabelRequest} or an equivalent Hash.
|
309
|
+
#
|
310
|
+
# @param request [::Google::Cloud::Chronicle::V1::GetDataAccessLabelRequest, ::Hash]
|
311
|
+
# A request object representing the call parameters. Required. To specify no
|
312
|
+
# parameters, or to keep all the default parameter values, pass an empty Hash.
|
313
|
+
# @param options [::Gapic::CallOptions, ::Hash]
|
314
|
+
# Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
|
315
|
+
#
|
316
|
+
# @overload get_data_access_label(name: nil)
|
317
|
+
# Pass arguments to `get_data_access_label` via keyword arguments. Note that at
|
318
|
+
# least one keyword argument is required. To specify no parameters, or to keep all
|
319
|
+
# the default parameter values, pass an empty Hash as a request object (see above).
|
320
|
+
#
|
321
|
+
# @param name [::String]
|
322
|
+
# Required. The ID of the data access label to retrieve.
|
323
|
+
# Format:
|
324
|
+
# `projects/{project}/locations/{location}/instances/{instance}/dataAccessLabels/{data_access_label}`
|
325
|
+
# @yield [result, operation] Access the result along with the TransportOperation object
|
326
|
+
# @yieldparam result [::Google::Cloud::Chronicle::V1::DataAccessLabel]
|
327
|
+
# @yieldparam operation [::Gapic::Rest::TransportOperation]
|
328
|
+
#
|
329
|
+
# @return [::Google::Cloud::Chronicle::V1::DataAccessLabel]
|
330
|
+
#
|
331
|
+
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
332
|
+
#
|
333
|
+
# @example Basic example
|
334
|
+
# require "google/cloud/chronicle/v1"
|
335
|
+
#
|
336
|
+
# # Create a client object. The client can be reused for multiple calls.
|
337
|
+
# client = Google::Cloud::Chronicle::V1::DataAccessControlService::Rest::Client.new
|
338
|
+
#
|
339
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
340
|
+
# request = Google::Cloud::Chronicle::V1::GetDataAccessLabelRequest.new
|
341
|
+
#
|
342
|
+
# # Call the get_data_access_label method.
|
343
|
+
# result = client.get_data_access_label request
|
344
|
+
#
|
345
|
+
# # The returned object is of type Google::Cloud::Chronicle::V1::DataAccessLabel.
|
346
|
+
# p result
|
347
|
+
#
|
348
|
+
def get_data_access_label request, options = nil
|
349
|
+
raise ::ArgumentError, "request must be provided" if request.nil?
|
350
|
+
|
351
|
+
request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Chronicle::V1::GetDataAccessLabelRequest
|
352
|
+
|
353
|
+
# Converts hash and nil to an options object
|
354
|
+
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
|
355
|
+
|
356
|
+
# Customize the options with defaults
|
357
|
+
call_metadata = @config.rpcs.get_data_access_label.metadata.to_h
|
358
|
+
|
359
|
+
# Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
|
360
|
+
call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
|
361
|
+
lib_name: @config.lib_name, lib_version: @config.lib_version,
|
362
|
+
gapic_version: ::Google::Cloud::Chronicle::V1::VERSION,
|
363
|
+
transports_version_send: [:rest]
|
364
|
+
|
365
|
+
call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
|
366
|
+
call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
367
|
+
|
368
|
+
options.apply_defaults timeout: @config.rpcs.get_data_access_label.timeout,
|
369
|
+
metadata: call_metadata,
|
370
|
+
retry_policy: @config.rpcs.get_data_access_label.retry_policy
|
371
|
+
|
372
|
+
options.apply_defaults timeout: @config.timeout,
|
373
|
+
metadata: @config.metadata,
|
374
|
+
retry_policy: @config.retry_policy
|
375
|
+
|
376
|
+
@data_access_control_service_stub.get_data_access_label request, options do |result, operation|
|
377
|
+
yield result, operation if block_given?
|
378
|
+
end
|
379
|
+
rescue ::Gapic::Rest::Error => e
|
380
|
+
raise ::Google::Cloud::Error.from_error(e)
|
381
|
+
end
|
382
|
+
|
383
|
+
##
|
384
|
+
# Lists all data access labels for the customer.
|
385
|
+
#
|
386
|
+
# @overload list_data_access_labels(request, options = nil)
|
387
|
+
# Pass arguments to `list_data_access_labels` via a request object, either of type
|
388
|
+
# {::Google::Cloud::Chronicle::V1::ListDataAccessLabelsRequest} or an equivalent Hash.
|
389
|
+
#
|
390
|
+
# @param request [::Google::Cloud::Chronicle::V1::ListDataAccessLabelsRequest, ::Hash]
|
391
|
+
# A request object representing the call parameters. Required. To specify no
|
392
|
+
# parameters, or to keep all the default parameter values, pass an empty Hash.
|
393
|
+
# @param options [::Gapic::CallOptions, ::Hash]
|
394
|
+
# Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
|
395
|
+
#
|
396
|
+
# @overload list_data_access_labels(parent: nil, page_size: nil, page_token: nil, filter: nil)
|
397
|
+
# Pass arguments to `list_data_access_labels` via keyword arguments. Note that at
|
398
|
+
# least one keyword argument is required. To specify no parameters, or to keep all
|
399
|
+
# the default parameter values, pass an empty Hash as a request object (see above).
|
400
|
+
#
|
401
|
+
# @param parent [::String]
|
402
|
+
# Required. The parent resource where this data access label will be created.
|
403
|
+
# Format: `projects/{project}/locations/{location}/instances/{instance}`
|
404
|
+
# @param page_size [::Integer]
|
405
|
+
# The maximum number of data access labels to return. The service may return
|
406
|
+
# fewer than this value. If unspecified, at most 100 data access labels will
|
407
|
+
# be returned. The maximum value is 1000; values above 1000 will be coerced
|
408
|
+
# to 1000.
|
409
|
+
# @param page_token [::String]
|
410
|
+
# A page token, received from a previous `ListDataAccessLabelsRequest` call.
|
411
|
+
# Provide this to retrieve the subsequent page.
|
412
|
+
# @param filter [::String]
|
413
|
+
# Optional. A filter which should follow the guidelines of AIP-160.
|
414
|
+
# Supports filtering on all fieds of DataAccessLabel and all operations as
|
415
|
+
# mentioned in https://google.aip.dev/160.
|
416
|
+
# example filter: "create_time greater than \"2023-04-21T11:30:00-04:00\" OR
|
417
|
+
# display_name:\"-21-1\"".
|
418
|
+
# @yield [result, operation] Access the result along with the TransportOperation object
|
419
|
+
# @yieldparam result [::Gapic::Rest::PagedEnumerable<::Google::Cloud::Chronicle::V1::DataAccessLabel>]
|
420
|
+
# @yieldparam operation [::Gapic::Rest::TransportOperation]
|
421
|
+
#
|
422
|
+
# @return [::Gapic::Rest::PagedEnumerable<::Google::Cloud::Chronicle::V1::DataAccessLabel>]
|
423
|
+
#
|
424
|
+
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
425
|
+
#
|
426
|
+
# @example Basic example
|
427
|
+
# require "google/cloud/chronicle/v1"
|
428
|
+
#
|
429
|
+
# # Create a client object. The client can be reused for multiple calls.
|
430
|
+
# client = Google::Cloud::Chronicle::V1::DataAccessControlService::Rest::Client.new
|
431
|
+
#
|
432
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
433
|
+
# request = Google::Cloud::Chronicle::V1::ListDataAccessLabelsRequest.new
|
434
|
+
#
|
435
|
+
# # Call the list_data_access_labels method.
|
436
|
+
# result = client.list_data_access_labels request
|
437
|
+
#
|
438
|
+
# # The returned object is of type Gapic::PagedEnumerable. You can iterate
|
439
|
+
# # over elements, and API calls will be issued to fetch pages as needed.
|
440
|
+
# result.each do |item|
|
441
|
+
# # Each element is of type ::Google::Cloud::Chronicle::V1::DataAccessLabel.
|
442
|
+
# p item
|
443
|
+
# end
|
444
|
+
#
|
445
|
+
def list_data_access_labels request, options = nil
|
446
|
+
raise ::ArgumentError, "request must be provided" if request.nil?
|
447
|
+
|
448
|
+
request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Chronicle::V1::ListDataAccessLabelsRequest
|
449
|
+
|
450
|
+
# Converts hash and nil to an options object
|
451
|
+
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
|
452
|
+
|
453
|
+
# Customize the options with defaults
|
454
|
+
call_metadata = @config.rpcs.list_data_access_labels.metadata.to_h
|
455
|
+
|
456
|
+
# Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
|
457
|
+
call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
|
458
|
+
lib_name: @config.lib_name, lib_version: @config.lib_version,
|
459
|
+
gapic_version: ::Google::Cloud::Chronicle::V1::VERSION,
|
460
|
+
transports_version_send: [:rest]
|
461
|
+
|
462
|
+
call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
|
463
|
+
call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
464
|
+
|
465
|
+
options.apply_defaults timeout: @config.rpcs.list_data_access_labels.timeout,
|
466
|
+
metadata: call_metadata,
|
467
|
+
retry_policy: @config.rpcs.list_data_access_labels.retry_policy
|
468
|
+
|
469
|
+
options.apply_defaults timeout: @config.timeout,
|
470
|
+
metadata: @config.metadata,
|
471
|
+
retry_policy: @config.retry_policy
|
472
|
+
|
473
|
+
@data_access_control_service_stub.list_data_access_labels request, options do |result, operation|
|
474
|
+
result = ::Gapic::Rest::PagedEnumerable.new @data_access_control_service_stub, :list_data_access_labels, "data_access_labels", request, result, options
|
475
|
+
yield result, operation if block_given?
|
476
|
+
throw :response, result
|
477
|
+
end
|
478
|
+
rescue ::Gapic::Rest::Error => e
|
479
|
+
raise ::Google::Cloud::Error.from_error(e)
|
480
|
+
end
|
481
|
+
|
482
|
+
##
|
483
|
+
# Updates a data access label.
|
484
|
+
#
|
485
|
+
# @overload update_data_access_label(request, options = nil)
|
486
|
+
# Pass arguments to `update_data_access_label` via a request object, either of type
|
487
|
+
# {::Google::Cloud::Chronicle::V1::UpdateDataAccessLabelRequest} or an equivalent Hash.
|
488
|
+
#
|
489
|
+
# @param request [::Google::Cloud::Chronicle::V1::UpdateDataAccessLabelRequest, ::Hash]
|
490
|
+
# A request object representing the call parameters. Required. To specify no
|
491
|
+
# parameters, or to keep all the default parameter values, pass an empty Hash.
|
492
|
+
# @param options [::Gapic::CallOptions, ::Hash]
|
493
|
+
# Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
|
494
|
+
#
|
495
|
+
# @overload update_data_access_label(data_access_label: nil, update_mask: nil)
|
496
|
+
# Pass arguments to `update_data_access_label` via keyword arguments. Note that at
|
497
|
+
# least one keyword argument is required. To specify no parameters, or to keep all
|
498
|
+
# the default parameter values, pass an empty Hash as a request object (see above).
|
499
|
+
#
|
500
|
+
# @param data_access_label [::Google::Cloud::Chronicle::V1::DataAccessLabel, ::Hash]
|
501
|
+
# Required. The data access label to update.
|
502
|
+
#
|
503
|
+
# The label's `name` field is used to identify the label to update.
|
504
|
+
# Format:
|
505
|
+
# `projects/{project}/locations/{location}/instances/{instance}/dataAccessLabels/{data_access_label}`
|
506
|
+
# @param update_mask [::Google::Protobuf::FieldMask, ::Hash]
|
507
|
+
# The list of fields to update. If not included, all fields with a non-empty
|
508
|
+
# value will be overwritten. Currently, only the description and definition
|
509
|
+
# fields are supported for update; an update call that attempts to update any
|
510
|
+
# other fields will return INVALID_ARGUMENT.
|
511
|
+
# @yield [result, operation] Access the result along with the TransportOperation object
|
512
|
+
# @yieldparam result [::Google::Cloud::Chronicle::V1::DataAccessLabel]
|
513
|
+
# @yieldparam operation [::Gapic::Rest::TransportOperation]
|
514
|
+
#
|
515
|
+
# @return [::Google::Cloud::Chronicle::V1::DataAccessLabel]
|
516
|
+
#
|
517
|
+
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
518
|
+
#
|
519
|
+
# @example Basic example
|
520
|
+
# require "google/cloud/chronicle/v1"
|
521
|
+
#
|
522
|
+
# # Create a client object. The client can be reused for multiple calls.
|
523
|
+
# client = Google::Cloud::Chronicle::V1::DataAccessControlService::Rest::Client.new
|
524
|
+
#
|
525
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
526
|
+
# request = Google::Cloud::Chronicle::V1::UpdateDataAccessLabelRequest.new
|
527
|
+
#
|
528
|
+
# # Call the update_data_access_label method.
|
529
|
+
# result = client.update_data_access_label request
|
530
|
+
#
|
531
|
+
# # The returned object is of type Google::Cloud::Chronicle::V1::DataAccessLabel.
|
532
|
+
# p result
|
533
|
+
#
|
534
|
+
def update_data_access_label request, options = nil
|
535
|
+
raise ::ArgumentError, "request must be provided" if request.nil?
|
536
|
+
|
537
|
+
request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Chronicle::V1::UpdateDataAccessLabelRequest
|
538
|
+
|
539
|
+
# Converts hash and nil to an options object
|
540
|
+
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
|
541
|
+
|
542
|
+
# Customize the options with defaults
|
543
|
+
call_metadata = @config.rpcs.update_data_access_label.metadata.to_h
|
544
|
+
|
545
|
+
# Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
|
546
|
+
call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
|
547
|
+
lib_name: @config.lib_name, lib_version: @config.lib_version,
|
548
|
+
gapic_version: ::Google::Cloud::Chronicle::V1::VERSION,
|
549
|
+
transports_version_send: [:rest]
|
550
|
+
|
551
|
+
call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
|
552
|
+
call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
553
|
+
|
554
|
+
options.apply_defaults timeout: @config.rpcs.update_data_access_label.timeout,
|
555
|
+
metadata: call_metadata,
|
556
|
+
retry_policy: @config.rpcs.update_data_access_label.retry_policy
|
557
|
+
|
558
|
+
options.apply_defaults timeout: @config.timeout,
|
559
|
+
metadata: @config.metadata,
|
560
|
+
retry_policy: @config.retry_policy
|
561
|
+
|
562
|
+
@data_access_control_service_stub.update_data_access_label request, options do |result, operation|
|
563
|
+
yield result, operation if block_given?
|
564
|
+
end
|
565
|
+
rescue ::Gapic::Rest::Error => e
|
566
|
+
raise ::Google::Cloud::Error.from_error(e)
|
567
|
+
end
|
568
|
+
|
569
|
+
##
|
570
|
+
# Deletes a data access label. When a label is deleted, new
|
571
|
+
# data that enters in the system will not receive the label, but the label
|
572
|
+
# will not be removed from old data that still refers to it.
|
573
|
+
#
|
574
|
+
# @overload delete_data_access_label(request, options = nil)
|
575
|
+
# Pass arguments to `delete_data_access_label` via a request object, either of type
|
576
|
+
# {::Google::Cloud::Chronicle::V1::DeleteDataAccessLabelRequest} or an equivalent Hash.
|
577
|
+
#
|
578
|
+
# @param request [::Google::Cloud::Chronicle::V1::DeleteDataAccessLabelRequest, ::Hash]
|
579
|
+
# A request object representing the call parameters. Required. To specify no
|
580
|
+
# parameters, or to keep all the default parameter values, pass an empty Hash.
|
581
|
+
# @param options [::Gapic::CallOptions, ::Hash]
|
582
|
+
# Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
|
583
|
+
#
|
584
|
+
# @overload delete_data_access_label(name: nil)
|
585
|
+
# Pass arguments to `delete_data_access_label` via keyword arguments. Note that at
|
586
|
+
# least one keyword argument is required. To specify no parameters, or to keep all
|
587
|
+
# the default parameter values, pass an empty Hash as a request object (see above).
|
588
|
+
#
|
589
|
+
# @param name [::String]
|
590
|
+
# Required. The ID of the data access label to delete.
|
591
|
+
# Format:
|
592
|
+
# `projects/{project}/locations/{location}/instances/{instance}/dataAccessLabels/{data_access_label}`
|
593
|
+
# @yield [result, operation] Access the result along with the TransportOperation object
|
594
|
+
# @yieldparam result [::Google::Protobuf::Empty]
|
595
|
+
# @yieldparam operation [::Gapic::Rest::TransportOperation]
|
596
|
+
#
|
597
|
+
# @return [::Google::Protobuf::Empty]
|
598
|
+
#
|
599
|
+
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
600
|
+
#
|
601
|
+
# @example Basic example
|
602
|
+
# require "google/cloud/chronicle/v1"
|
603
|
+
#
|
604
|
+
# # Create a client object. The client can be reused for multiple calls.
|
605
|
+
# client = Google::Cloud::Chronicle::V1::DataAccessControlService::Rest::Client.new
|
606
|
+
#
|
607
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
608
|
+
# request = Google::Cloud::Chronicle::V1::DeleteDataAccessLabelRequest.new
|
609
|
+
#
|
610
|
+
# # Call the delete_data_access_label method.
|
611
|
+
# result = client.delete_data_access_label request
|
612
|
+
#
|
613
|
+
# # The returned object is of type Google::Protobuf::Empty.
|
614
|
+
# p result
|
615
|
+
#
|
616
|
+
def delete_data_access_label request, options = nil
|
617
|
+
raise ::ArgumentError, "request must be provided" if request.nil?
|
618
|
+
|
619
|
+
request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Chronicle::V1::DeleteDataAccessLabelRequest
|
620
|
+
|
621
|
+
# Converts hash and nil to an options object
|
622
|
+
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
|
623
|
+
|
624
|
+
# Customize the options with defaults
|
625
|
+
call_metadata = @config.rpcs.delete_data_access_label.metadata.to_h
|
626
|
+
|
627
|
+
# Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
|
628
|
+
call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
|
629
|
+
lib_name: @config.lib_name, lib_version: @config.lib_version,
|
630
|
+
gapic_version: ::Google::Cloud::Chronicle::V1::VERSION,
|
631
|
+
transports_version_send: [:rest]
|
632
|
+
|
633
|
+
call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
|
634
|
+
call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
635
|
+
|
636
|
+
options.apply_defaults timeout: @config.rpcs.delete_data_access_label.timeout,
|
637
|
+
metadata: call_metadata,
|
638
|
+
retry_policy: @config.rpcs.delete_data_access_label.retry_policy
|
639
|
+
|
640
|
+
options.apply_defaults timeout: @config.timeout,
|
641
|
+
metadata: @config.metadata,
|
642
|
+
retry_policy: @config.retry_policy
|
643
|
+
|
644
|
+
@data_access_control_service_stub.delete_data_access_label request, options do |result, operation|
|
645
|
+
yield result, operation if block_given?
|
646
|
+
end
|
647
|
+
rescue ::Gapic::Rest::Error => e
|
648
|
+
raise ::Google::Cloud::Error.from_error(e)
|
649
|
+
end
|
650
|
+
|
651
|
+
##
|
652
|
+
# Creates a data access scope.
|
653
|
+
# Data access scope is a combination of allowed and denied labels attached
|
654
|
+
# to a permission group. If a scope has allowed labels A and B and denied
|
655
|
+
# labels C and D, then the group of people attached to the scope
|
656
|
+
# will have permissions to see all events labeled with A or B (or both) and
|
657
|
+
# not labeled with either C or D.
|
658
|
+
#
|
659
|
+
# @overload create_data_access_scope(request, options = nil)
|
660
|
+
# Pass arguments to `create_data_access_scope` via a request object, either of type
|
661
|
+
# {::Google::Cloud::Chronicle::V1::CreateDataAccessScopeRequest} or an equivalent Hash.
|
662
|
+
#
|
663
|
+
# @param request [::Google::Cloud::Chronicle::V1::CreateDataAccessScopeRequest, ::Hash]
|
664
|
+
# A request object representing the call parameters. Required. To specify no
|
665
|
+
# parameters, or to keep all the default parameter values, pass an empty Hash.
|
666
|
+
# @param options [::Gapic::CallOptions, ::Hash]
|
667
|
+
# Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
|
668
|
+
#
|
669
|
+
# @overload create_data_access_scope(parent: nil, data_access_scope: nil, data_access_scope_id: nil)
|
670
|
+
# Pass arguments to `create_data_access_scope` via keyword arguments. Note that at
|
671
|
+
# least one keyword argument is required. To specify no parameters, or to keep all
|
672
|
+
# the default parameter values, pass an empty Hash as a request object (see above).
|
673
|
+
#
|
674
|
+
# @param parent [::String]
|
675
|
+
# Required. The parent resource where this Data Access Scope will be created.
|
676
|
+
# Format: `projects/{project}/locations/{location}/instances/{instance}`
|
677
|
+
# @param data_access_scope [::Google::Cloud::Chronicle::V1::DataAccessScope, ::Hash]
|
678
|
+
# Required. Data access scope to create.
|
679
|
+
# @param data_access_scope_id [::String]
|
680
|
+
# Required. The user provided scope id which will become the last part of the
|
681
|
+
# name of the scope resource. Needs to be compliant with
|
682
|
+
# https://google.aip.dev/122
|
683
|
+
# @yield [result, operation] Access the result along with the TransportOperation object
|
684
|
+
# @yieldparam result [::Google::Cloud::Chronicle::V1::DataAccessScope]
|
685
|
+
# @yieldparam operation [::Gapic::Rest::TransportOperation]
|
686
|
+
#
|
687
|
+
# @return [::Google::Cloud::Chronicle::V1::DataAccessScope]
|
688
|
+
#
|
689
|
+
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
690
|
+
#
|
691
|
+
# @example Basic example
|
692
|
+
# require "google/cloud/chronicle/v1"
|
693
|
+
#
|
694
|
+
# # Create a client object. The client can be reused for multiple calls.
|
695
|
+
# client = Google::Cloud::Chronicle::V1::DataAccessControlService::Rest::Client.new
|
696
|
+
#
|
697
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
698
|
+
# request = Google::Cloud::Chronicle::V1::CreateDataAccessScopeRequest.new
|
699
|
+
#
|
700
|
+
# # Call the create_data_access_scope method.
|
701
|
+
# result = client.create_data_access_scope request
|
702
|
+
#
|
703
|
+
# # The returned object is of type Google::Cloud::Chronicle::V1::DataAccessScope.
|
704
|
+
# p result
|
705
|
+
#
|
706
|
+
def create_data_access_scope request, options = nil
|
707
|
+
raise ::ArgumentError, "request must be provided" if request.nil?
|
708
|
+
|
709
|
+
request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Chronicle::V1::CreateDataAccessScopeRequest
|
710
|
+
|
711
|
+
# Converts hash and nil to an options object
|
712
|
+
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
|
713
|
+
|
714
|
+
# Customize the options with defaults
|
715
|
+
call_metadata = @config.rpcs.create_data_access_scope.metadata.to_h
|
716
|
+
|
717
|
+
# Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
|
718
|
+
call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
|
719
|
+
lib_name: @config.lib_name, lib_version: @config.lib_version,
|
720
|
+
gapic_version: ::Google::Cloud::Chronicle::V1::VERSION,
|
721
|
+
transports_version_send: [:rest]
|
722
|
+
|
723
|
+
call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
|
724
|
+
call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
725
|
+
|
726
|
+
options.apply_defaults timeout: @config.rpcs.create_data_access_scope.timeout,
|
727
|
+
metadata: call_metadata,
|
728
|
+
retry_policy: @config.rpcs.create_data_access_scope.retry_policy
|
729
|
+
|
730
|
+
options.apply_defaults timeout: @config.timeout,
|
731
|
+
metadata: @config.metadata,
|
732
|
+
retry_policy: @config.retry_policy
|
733
|
+
|
734
|
+
@data_access_control_service_stub.create_data_access_scope request, options do |result, operation|
|
735
|
+
yield result, operation if block_given?
|
736
|
+
end
|
737
|
+
rescue ::Gapic::Rest::Error => e
|
738
|
+
raise ::Google::Cloud::Error.from_error(e)
|
739
|
+
end
|
740
|
+
|
741
|
+
##
|
742
|
+
# Retrieves an existing data access scope.
|
743
|
+
#
|
744
|
+
# @overload get_data_access_scope(request, options = nil)
|
745
|
+
# Pass arguments to `get_data_access_scope` via a request object, either of type
|
746
|
+
# {::Google::Cloud::Chronicle::V1::GetDataAccessScopeRequest} or an equivalent Hash.
|
747
|
+
#
|
748
|
+
# @param request [::Google::Cloud::Chronicle::V1::GetDataAccessScopeRequest, ::Hash]
|
749
|
+
# A request object representing the call parameters. Required. To specify no
|
750
|
+
# parameters, or to keep all the default parameter values, pass an empty Hash.
|
751
|
+
# @param options [::Gapic::CallOptions, ::Hash]
|
752
|
+
# Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
|
753
|
+
#
|
754
|
+
# @overload get_data_access_scope(name: nil)
|
755
|
+
# Pass arguments to `get_data_access_scope` via keyword arguments. Note that at
|
756
|
+
# least one keyword argument is required. To specify no parameters, or to keep all
|
757
|
+
# the default parameter values, pass an empty Hash as a request object (see above).
|
758
|
+
#
|
759
|
+
# @param name [::String]
|
760
|
+
# Required. The ID of the data access scope to retrieve.
|
761
|
+
# Format:
|
762
|
+
# `projects/{project}/locations/{location}/instances/{instance}/dataAccessScopes/{data_access_scope}`
|
763
|
+
# @yield [result, operation] Access the result along with the TransportOperation object
|
764
|
+
# @yieldparam result [::Google::Cloud::Chronicle::V1::DataAccessScope]
|
765
|
+
# @yieldparam operation [::Gapic::Rest::TransportOperation]
|
766
|
+
#
|
767
|
+
# @return [::Google::Cloud::Chronicle::V1::DataAccessScope]
|
768
|
+
#
|
769
|
+
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
770
|
+
#
|
771
|
+
# @example Basic example
|
772
|
+
# require "google/cloud/chronicle/v1"
|
773
|
+
#
|
774
|
+
# # Create a client object. The client can be reused for multiple calls.
|
775
|
+
# client = Google::Cloud::Chronicle::V1::DataAccessControlService::Rest::Client.new
|
776
|
+
#
|
777
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
778
|
+
# request = Google::Cloud::Chronicle::V1::GetDataAccessScopeRequest.new
|
779
|
+
#
|
780
|
+
# # Call the get_data_access_scope method.
|
781
|
+
# result = client.get_data_access_scope request
|
782
|
+
#
|
783
|
+
# # The returned object is of type Google::Cloud::Chronicle::V1::DataAccessScope.
|
784
|
+
# p result
|
785
|
+
#
|
786
|
+
def get_data_access_scope request, options = nil
|
787
|
+
raise ::ArgumentError, "request must be provided" if request.nil?
|
788
|
+
|
789
|
+
request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Chronicle::V1::GetDataAccessScopeRequest
|
790
|
+
|
791
|
+
# Converts hash and nil to an options object
|
792
|
+
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
|
793
|
+
|
794
|
+
# Customize the options with defaults
|
795
|
+
call_metadata = @config.rpcs.get_data_access_scope.metadata.to_h
|
796
|
+
|
797
|
+
# Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
|
798
|
+
call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
|
799
|
+
lib_name: @config.lib_name, lib_version: @config.lib_version,
|
800
|
+
gapic_version: ::Google::Cloud::Chronicle::V1::VERSION,
|
801
|
+
transports_version_send: [:rest]
|
802
|
+
|
803
|
+
call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
|
804
|
+
call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
805
|
+
|
806
|
+
options.apply_defaults timeout: @config.rpcs.get_data_access_scope.timeout,
|
807
|
+
metadata: call_metadata,
|
808
|
+
retry_policy: @config.rpcs.get_data_access_scope.retry_policy
|
809
|
+
|
810
|
+
options.apply_defaults timeout: @config.timeout,
|
811
|
+
metadata: @config.metadata,
|
812
|
+
retry_policy: @config.retry_policy
|
813
|
+
|
814
|
+
@data_access_control_service_stub.get_data_access_scope request, options do |result, operation|
|
815
|
+
yield result, operation if block_given?
|
816
|
+
end
|
817
|
+
rescue ::Gapic::Rest::Error => e
|
818
|
+
raise ::Google::Cloud::Error.from_error(e)
|
819
|
+
end
|
820
|
+
|
821
|
+
##
|
822
|
+
# Lists all existing data access scopes for the customer.
|
823
|
+
#
|
824
|
+
# @overload list_data_access_scopes(request, options = nil)
|
825
|
+
# Pass arguments to `list_data_access_scopes` via a request object, either of type
|
826
|
+
# {::Google::Cloud::Chronicle::V1::ListDataAccessScopesRequest} or an equivalent Hash.
|
827
|
+
#
|
828
|
+
# @param request [::Google::Cloud::Chronicle::V1::ListDataAccessScopesRequest, ::Hash]
|
829
|
+
# A request object representing the call parameters. Required. To specify no
|
830
|
+
# parameters, or to keep all the default parameter values, pass an empty Hash.
|
831
|
+
# @param options [::Gapic::CallOptions, ::Hash]
|
832
|
+
# Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
|
833
|
+
#
|
834
|
+
# @overload list_data_access_scopes(parent: nil, page_size: nil, page_token: nil, filter: nil)
|
835
|
+
# Pass arguments to `list_data_access_scopes` via keyword arguments. Note that at
|
836
|
+
# least one keyword argument is required. To specify no parameters, or to keep all
|
837
|
+
# the default parameter values, pass an empty Hash as a request object (see above).
|
838
|
+
#
|
839
|
+
# @param parent [::String]
|
840
|
+
# Required. The parent resource where this data access scope will be created.
|
841
|
+
# Format: `projects/{project}/locations/{location}/instances/{instance}`
|
842
|
+
# @param page_size [::Integer]
|
843
|
+
# The maximum number of data access scopes to return. The service may return
|
844
|
+
# fewer than this value. If unspecified, at most 100 data access scopes will
|
845
|
+
# be returned. The maximum value is 1000; values above 1000 will be coerced
|
846
|
+
# to 1000.
|
847
|
+
# @param page_token [::String]
|
848
|
+
# A page token, received from a previous `ListDataAccessScopesRequest` call.
|
849
|
+
# Provide this to retrieve the subsequent page.
|
850
|
+
# @param filter [::String]
|
851
|
+
# Optional. A filter which should follow the guidelines of AIP-160.
|
852
|
+
# Supports filtering on all fieds of DataAccessScope and all operations as
|
853
|
+
# mentioned in https://google.aip.dev/160.
|
854
|
+
# example filter: "create_time greater than \"2023-04-21T11:30:00-04:00\" OR
|
855
|
+
# display_name:\"-21-1\"".
|
856
|
+
# @yield [result, operation] Access the result along with the TransportOperation object
|
857
|
+
# @yieldparam result [::Gapic::Rest::PagedEnumerable<::Google::Cloud::Chronicle::V1::DataAccessScope>]
|
858
|
+
# @yieldparam operation [::Gapic::Rest::TransportOperation]
|
859
|
+
#
|
860
|
+
# @return [::Gapic::Rest::PagedEnumerable<::Google::Cloud::Chronicle::V1::DataAccessScope>]
|
861
|
+
#
|
862
|
+
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
863
|
+
#
|
864
|
+
# @example Basic example
|
865
|
+
# require "google/cloud/chronicle/v1"
|
866
|
+
#
|
867
|
+
# # Create a client object. The client can be reused for multiple calls.
|
868
|
+
# client = Google::Cloud::Chronicle::V1::DataAccessControlService::Rest::Client.new
|
869
|
+
#
|
870
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
871
|
+
# request = Google::Cloud::Chronicle::V1::ListDataAccessScopesRequest.new
|
872
|
+
#
|
873
|
+
# # Call the list_data_access_scopes method.
|
874
|
+
# result = client.list_data_access_scopes request
|
875
|
+
#
|
876
|
+
# # The returned object is of type Gapic::PagedEnumerable. You can iterate
|
877
|
+
# # over elements, and API calls will be issued to fetch pages as needed.
|
878
|
+
# result.each do |item|
|
879
|
+
# # Each element is of type ::Google::Cloud::Chronicle::V1::DataAccessScope.
|
880
|
+
# p item
|
881
|
+
# end
|
882
|
+
#
|
883
|
+
def list_data_access_scopes request, options = nil
|
884
|
+
raise ::ArgumentError, "request must be provided" if request.nil?
|
885
|
+
|
886
|
+
request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Chronicle::V1::ListDataAccessScopesRequest
|
887
|
+
|
888
|
+
# Converts hash and nil to an options object
|
889
|
+
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
|
890
|
+
|
891
|
+
# Customize the options with defaults
|
892
|
+
call_metadata = @config.rpcs.list_data_access_scopes.metadata.to_h
|
893
|
+
|
894
|
+
# Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
|
895
|
+
call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
|
896
|
+
lib_name: @config.lib_name, lib_version: @config.lib_version,
|
897
|
+
gapic_version: ::Google::Cloud::Chronicle::V1::VERSION,
|
898
|
+
transports_version_send: [:rest]
|
899
|
+
|
900
|
+
call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
|
901
|
+
call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
902
|
+
|
903
|
+
options.apply_defaults timeout: @config.rpcs.list_data_access_scopes.timeout,
|
904
|
+
metadata: call_metadata,
|
905
|
+
retry_policy: @config.rpcs.list_data_access_scopes.retry_policy
|
906
|
+
|
907
|
+
options.apply_defaults timeout: @config.timeout,
|
908
|
+
metadata: @config.metadata,
|
909
|
+
retry_policy: @config.retry_policy
|
910
|
+
|
911
|
+
@data_access_control_service_stub.list_data_access_scopes request, options do |result, operation|
|
912
|
+
result = ::Gapic::Rest::PagedEnumerable.new @data_access_control_service_stub, :list_data_access_scopes, "data_access_scopes", request, result, options
|
913
|
+
yield result, operation if block_given?
|
914
|
+
throw :response, result
|
915
|
+
end
|
916
|
+
rescue ::Gapic::Rest::Error => e
|
917
|
+
raise ::Google::Cloud::Error.from_error(e)
|
918
|
+
end
|
919
|
+
|
920
|
+
##
|
921
|
+
# Updates a data access scope.
|
922
|
+
#
|
923
|
+
# @overload update_data_access_scope(request, options = nil)
|
924
|
+
# Pass arguments to `update_data_access_scope` via a request object, either of type
|
925
|
+
# {::Google::Cloud::Chronicle::V1::UpdateDataAccessScopeRequest} or an equivalent Hash.
|
926
|
+
#
|
927
|
+
# @param request [::Google::Cloud::Chronicle::V1::UpdateDataAccessScopeRequest, ::Hash]
|
928
|
+
# A request object representing the call parameters. Required. To specify no
|
929
|
+
# parameters, or to keep all the default parameter values, pass an empty Hash.
|
930
|
+
# @param options [::Gapic::CallOptions, ::Hash]
|
931
|
+
# Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
|
932
|
+
#
|
933
|
+
# @overload update_data_access_scope(data_access_scope: nil, update_mask: nil)
|
934
|
+
# Pass arguments to `update_data_access_scope` via keyword arguments. Note that at
|
935
|
+
# least one keyword argument is required. To specify no parameters, or to keep all
|
936
|
+
# the default parameter values, pass an empty Hash as a request object (see above).
|
937
|
+
#
|
938
|
+
# @param data_access_scope [::Google::Cloud::Chronicle::V1::DataAccessScope, ::Hash]
|
939
|
+
# Required. The data access scope to update.
|
940
|
+
#
|
941
|
+
# The scope's `name` field is used to identify the scope to update.
|
942
|
+
# Format:
|
943
|
+
# `projects/{project}/locations/{location}/instances/{instance}/dataAccessScopes/{data_access_scope}`
|
944
|
+
# @param update_mask [::Google::Protobuf::FieldMask, ::Hash]
|
945
|
+
# The list of fields to update. If not included, all fields with a non-empty
|
946
|
+
# value will be overwritten. Currently, only the description, the allowed
|
947
|
+
# and denied labels list fields are supported for update;
|
948
|
+
# an update call that attempts to update any
|
949
|
+
# other fields will return INVALID_ARGUMENT.
|
950
|
+
# @yield [result, operation] Access the result along with the TransportOperation object
|
951
|
+
# @yieldparam result [::Google::Cloud::Chronicle::V1::DataAccessScope]
|
952
|
+
# @yieldparam operation [::Gapic::Rest::TransportOperation]
|
953
|
+
#
|
954
|
+
# @return [::Google::Cloud::Chronicle::V1::DataAccessScope]
|
955
|
+
#
|
956
|
+
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
957
|
+
#
|
958
|
+
# @example Basic example
|
959
|
+
# require "google/cloud/chronicle/v1"
|
960
|
+
#
|
961
|
+
# # Create a client object. The client can be reused for multiple calls.
|
962
|
+
# client = Google::Cloud::Chronicle::V1::DataAccessControlService::Rest::Client.new
|
963
|
+
#
|
964
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
965
|
+
# request = Google::Cloud::Chronicle::V1::UpdateDataAccessScopeRequest.new
|
966
|
+
#
|
967
|
+
# # Call the update_data_access_scope method.
|
968
|
+
# result = client.update_data_access_scope request
|
969
|
+
#
|
970
|
+
# # The returned object is of type Google::Cloud::Chronicle::V1::DataAccessScope.
|
971
|
+
# p result
|
972
|
+
#
|
973
|
+
def update_data_access_scope request, options = nil
|
974
|
+
raise ::ArgumentError, "request must be provided" if request.nil?
|
975
|
+
|
976
|
+
request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Chronicle::V1::UpdateDataAccessScopeRequest
|
977
|
+
|
978
|
+
# Converts hash and nil to an options object
|
979
|
+
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
|
980
|
+
|
981
|
+
# Customize the options with defaults
|
982
|
+
call_metadata = @config.rpcs.update_data_access_scope.metadata.to_h
|
983
|
+
|
984
|
+
# Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
|
985
|
+
call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
|
986
|
+
lib_name: @config.lib_name, lib_version: @config.lib_version,
|
987
|
+
gapic_version: ::Google::Cloud::Chronicle::V1::VERSION,
|
988
|
+
transports_version_send: [:rest]
|
989
|
+
|
990
|
+
call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
|
991
|
+
call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
992
|
+
|
993
|
+
options.apply_defaults timeout: @config.rpcs.update_data_access_scope.timeout,
|
994
|
+
metadata: call_metadata,
|
995
|
+
retry_policy: @config.rpcs.update_data_access_scope.retry_policy
|
996
|
+
|
997
|
+
options.apply_defaults timeout: @config.timeout,
|
998
|
+
metadata: @config.metadata,
|
999
|
+
retry_policy: @config.retry_policy
|
1000
|
+
|
1001
|
+
@data_access_control_service_stub.update_data_access_scope request, options do |result, operation|
|
1002
|
+
yield result, operation if block_given?
|
1003
|
+
end
|
1004
|
+
rescue ::Gapic::Rest::Error => e
|
1005
|
+
raise ::Google::Cloud::Error.from_error(e)
|
1006
|
+
end
|
1007
|
+
|
1008
|
+
##
|
1009
|
+
# Deletes a data access scope.
|
1010
|
+
#
|
1011
|
+
# @overload delete_data_access_scope(request, options = nil)
|
1012
|
+
# Pass arguments to `delete_data_access_scope` via a request object, either of type
|
1013
|
+
# {::Google::Cloud::Chronicle::V1::DeleteDataAccessScopeRequest} or an equivalent Hash.
|
1014
|
+
#
|
1015
|
+
# @param request [::Google::Cloud::Chronicle::V1::DeleteDataAccessScopeRequest, ::Hash]
|
1016
|
+
# A request object representing the call parameters. Required. To specify no
|
1017
|
+
# parameters, or to keep all the default parameter values, pass an empty Hash.
|
1018
|
+
# @param options [::Gapic::CallOptions, ::Hash]
|
1019
|
+
# Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
|
1020
|
+
#
|
1021
|
+
# @overload delete_data_access_scope(name: nil)
|
1022
|
+
# Pass arguments to `delete_data_access_scope` via keyword arguments. Note that at
|
1023
|
+
# least one keyword argument is required. To specify no parameters, or to keep all
|
1024
|
+
# the default parameter values, pass an empty Hash as a request object (see above).
|
1025
|
+
#
|
1026
|
+
# @param name [::String]
|
1027
|
+
# Required. The ID of the data access scope to delete.
|
1028
|
+
# Format:
|
1029
|
+
# `projects/{project}/locations/{location}/instances/{instance}/dataAccessScopes/{data_access_scope}`
|
1030
|
+
# @yield [result, operation] Access the result along with the TransportOperation object
|
1031
|
+
# @yieldparam result [::Google::Protobuf::Empty]
|
1032
|
+
# @yieldparam operation [::Gapic::Rest::TransportOperation]
|
1033
|
+
#
|
1034
|
+
# @return [::Google::Protobuf::Empty]
|
1035
|
+
#
|
1036
|
+
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
1037
|
+
#
|
1038
|
+
# @example Basic example
|
1039
|
+
# require "google/cloud/chronicle/v1"
|
1040
|
+
#
|
1041
|
+
# # Create a client object. The client can be reused for multiple calls.
|
1042
|
+
# client = Google::Cloud::Chronicle::V1::DataAccessControlService::Rest::Client.new
|
1043
|
+
#
|
1044
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
1045
|
+
# request = Google::Cloud::Chronicle::V1::DeleteDataAccessScopeRequest.new
|
1046
|
+
#
|
1047
|
+
# # Call the delete_data_access_scope method.
|
1048
|
+
# result = client.delete_data_access_scope request
|
1049
|
+
#
|
1050
|
+
# # The returned object is of type Google::Protobuf::Empty.
|
1051
|
+
# p result
|
1052
|
+
#
|
1053
|
+
def delete_data_access_scope request, options = nil
|
1054
|
+
raise ::ArgumentError, "request must be provided" if request.nil?
|
1055
|
+
|
1056
|
+
request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Chronicle::V1::DeleteDataAccessScopeRequest
|
1057
|
+
|
1058
|
+
# Converts hash and nil to an options object
|
1059
|
+
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
|
1060
|
+
|
1061
|
+
# Customize the options with defaults
|
1062
|
+
call_metadata = @config.rpcs.delete_data_access_scope.metadata.to_h
|
1063
|
+
|
1064
|
+
# Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
|
1065
|
+
call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
|
1066
|
+
lib_name: @config.lib_name, lib_version: @config.lib_version,
|
1067
|
+
gapic_version: ::Google::Cloud::Chronicle::V1::VERSION,
|
1068
|
+
transports_version_send: [:rest]
|
1069
|
+
|
1070
|
+
call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
|
1071
|
+
call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
1072
|
+
|
1073
|
+
options.apply_defaults timeout: @config.rpcs.delete_data_access_scope.timeout,
|
1074
|
+
metadata: call_metadata,
|
1075
|
+
retry_policy: @config.rpcs.delete_data_access_scope.retry_policy
|
1076
|
+
|
1077
|
+
options.apply_defaults timeout: @config.timeout,
|
1078
|
+
metadata: @config.metadata,
|
1079
|
+
retry_policy: @config.retry_policy
|
1080
|
+
|
1081
|
+
@data_access_control_service_stub.delete_data_access_scope request, options do |result, operation|
|
1082
|
+
yield result, operation if block_given?
|
1083
|
+
end
|
1084
|
+
rescue ::Gapic::Rest::Error => e
|
1085
|
+
raise ::Google::Cloud::Error.from_error(e)
|
1086
|
+
end
|
1087
|
+
|
1088
|
+
##
|
1089
|
+
# Configuration class for the DataAccessControlService REST API.
|
1090
|
+
#
|
1091
|
+
# This class represents the configuration for DataAccessControlService REST,
|
1092
|
+
# providing control over timeouts, retry behavior, logging, transport
|
1093
|
+
# parameters, and other low-level controls. Certain parameters can also be
|
1094
|
+
# applied individually to specific RPCs. See
|
1095
|
+
# {::Google::Cloud::Chronicle::V1::DataAccessControlService::Rest::Client::Configuration::Rpcs}
|
1096
|
+
# for a list of RPCs that can be configured independently.
|
1097
|
+
#
|
1098
|
+
# Configuration can be applied globally to all clients, or to a single client
|
1099
|
+
# on construction.
|
1100
|
+
#
|
1101
|
+
# @example
|
1102
|
+
#
|
1103
|
+
# # Modify the global config, setting the timeout for
|
1104
|
+
# # create_data_access_label to 20 seconds,
|
1105
|
+
# # and all remaining timeouts to 10 seconds.
|
1106
|
+
# ::Google::Cloud::Chronicle::V1::DataAccessControlService::Rest::Client.configure do |config|
|
1107
|
+
# config.timeout = 10.0
|
1108
|
+
# config.rpcs.create_data_access_label.timeout = 20.0
|
1109
|
+
# end
|
1110
|
+
#
|
1111
|
+
# # Apply the above configuration only to a new client.
|
1112
|
+
# client = ::Google::Cloud::Chronicle::V1::DataAccessControlService::Rest::Client.new do |config|
|
1113
|
+
# config.timeout = 10.0
|
1114
|
+
# config.rpcs.create_data_access_label.timeout = 20.0
|
1115
|
+
# end
|
1116
|
+
#
|
1117
|
+
# @!attribute [rw] endpoint
|
1118
|
+
# A custom service endpoint, as a hostname or hostname:port. The default is
|
1119
|
+
# nil, indicating to use the default endpoint in the current universe domain.
|
1120
|
+
# @return [::String,nil]
|
1121
|
+
# @!attribute [rw] credentials
|
1122
|
+
# Credentials to send with calls. You may provide any of the following types:
|
1123
|
+
# * (`String`) The path to a service account key file in JSON format
|
1124
|
+
# * (`Hash`) A service account key as a Hash
|
1125
|
+
# * (`Google::Auth::Credentials`) A googleauth credentials object
|
1126
|
+
# (see the [googleauth docs](https://rubydoc.info/gems/googleauth/Google/Auth/Credentials))
|
1127
|
+
# * (`Signet::OAuth2::Client`) A signet oauth2 client object
|
1128
|
+
# (see the [signet docs](https://rubydoc.info/gems/signet/Signet/OAuth2/Client))
|
1129
|
+
# * (`nil`) indicating no credentials
|
1130
|
+
#
|
1131
|
+
# Warning: If you accept a credential configuration (JSON file or Hash) from an
|
1132
|
+
# external source for authentication to Google Cloud, you must validate it before
|
1133
|
+
# providing it to a Google API client library. Providing an unvalidated credential
|
1134
|
+
# configuration to Google APIs can compromise the security of your systems and data.
|
1135
|
+
# For more information, refer to [Validate credential configurations from external
|
1136
|
+
# sources](https://cloud.google.com/docs/authentication/external/externally-sourced-credentials).
|
1137
|
+
# @return [::Object]
|
1138
|
+
# @!attribute [rw] scope
|
1139
|
+
# The OAuth scopes
|
1140
|
+
# @return [::Array<::String>]
|
1141
|
+
# @!attribute [rw] lib_name
|
1142
|
+
# The library name as recorded in instrumentation and logging
|
1143
|
+
# @return [::String]
|
1144
|
+
# @!attribute [rw] lib_version
|
1145
|
+
# The library version as recorded in instrumentation and logging
|
1146
|
+
# @return [::String]
|
1147
|
+
# @!attribute [rw] timeout
|
1148
|
+
# The call timeout in seconds.
|
1149
|
+
# @return [::Numeric]
|
1150
|
+
# @!attribute [rw] metadata
|
1151
|
+
# Additional headers to be sent with the call.
|
1152
|
+
# @return [::Hash{::Symbol=>::String}]
|
1153
|
+
# @!attribute [rw] retry_policy
|
1154
|
+
# The retry policy. The value is a hash with the following keys:
|
1155
|
+
# * `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
|
1156
|
+
# * `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
|
1157
|
+
# * `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
|
1158
|
+
# * `:retry_codes` (*type:* `Array<String>`) - The error codes that should
|
1159
|
+
# trigger a retry.
|
1160
|
+
# @return [::Hash]
|
1161
|
+
# @!attribute [rw] quota_project
|
1162
|
+
# A separate project against which to charge quota.
|
1163
|
+
# @return [::String]
|
1164
|
+
# @!attribute [rw] universe_domain
|
1165
|
+
# The universe domain within which to make requests. This determines the
|
1166
|
+
# default endpoint URL. The default value of nil uses the environment
|
1167
|
+
# universe (usually the default "googleapis.com" universe).
|
1168
|
+
# @return [::String,nil]
|
1169
|
+
# @!attribute [rw] logger
|
1170
|
+
# A custom logger to use for request/response debug logging, or the value
|
1171
|
+
# `:default` (the default) to construct a default logger, or `nil` to
|
1172
|
+
# explicitly disable logging.
|
1173
|
+
# @return [::Logger,:default,nil]
|
1174
|
+
#
|
1175
|
+
class Configuration
|
1176
|
+
extend ::Gapic::Config
|
1177
|
+
|
1178
|
+
# @private
|
1179
|
+
# The endpoint specific to the default "googleapis.com" universe. Deprecated.
|
1180
|
+
DEFAULT_ENDPOINT = "chronicle.googleapis.com"
|
1181
|
+
|
1182
|
+
config_attr :endpoint, nil, ::String, nil
|
1183
|
+
config_attr :credentials, nil do |value|
|
1184
|
+
allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Google::Auth::BaseClient, ::Signet::OAuth2::Client, nil]
|
1185
|
+
allowed.any? { |klass| klass === value }
|
1186
|
+
end
|
1187
|
+
config_attr :scope, nil, ::String, ::Array, nil
|
1188
|
+
config_attr :lib_name, nil, ::String, nil
|
1189
|
+
config_attr :lib_version, nil, ::String, nil
|
1190
|
+
config_attr :timeout, nil, ::Numeric, nil
|
1191
|
+
config_attr :metadata, nil, ::Hash, nil
|
1192
|
+
config_attr :retry_policy, nil, ::Hash, ::Proc, nil
|
1193
|
+
config_attr :quota_project, nil, ::String, nil
|
1194
|
+
config_attr :universe_domain, nil, ::String, nil
|
1195
|
+
config_attr :logger, :default, ::Logger, nil, :default
|
1196
|
+
|
1197
|
+
# @private
|
1198
|
+
def initialize parent_config = nil
|
1199
|
+
@parent_config = parent_config unless parent_config.nil?
|
1200
|
+
|
1201
|
+
yield self if block_given?
|
1202
|
+
end
|
1203
|
+
|
1204
|
+
##
|
1205
|
+
# Configurations for individual RPCs
|
1206
|
+
# @return [Rpcs]
|
1207
|
+
#
|
1208
|
+
def rpcs
|
1209
|
+
@rpcs ||= begin
|
1210
|
+
parent_rpcs = nil
|
1211
|
+
parent_rpcs = @parent_config.rpcs if defined?(@parent_config) && @parent_config.respond_to?(:rpcs)
|
1212
|
+
Rpcs.new parent_rpcs
|
1213
|
+
end
|
1214
|
+
end
|
1215
|
+
|
1216
|
+
##
|
1217
|
+
# Configuration RPC class for the DataAccessControlService API.
|
1218
|
+
#
|
1219
|
+
# Includes fields providing the configuration for each RPC in this service.
|
1220
|
+
# Each configuration object is of type `Gapic::Config::Method` and includes
|
1221
|
+
# the following configuration fields:
|
1222
|
+
#
|
1223
|
+
# * `timeout` (*type:* `Numeric`) - The call timeout in seconds
|
1224
|
+
# * `metadata` (*type:* `Hash{Symbol=>String}`) - Additional headers
|
1225
|
+
# * `retry_policy (*type:* `Hash`) - The retry policy. The policy fields
|
1226
|
+
# include the following keys:
|
1227
|
+
# * `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
|
1228
|
+
# * `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
|
1229
|
+
# * `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
|
1230
|
+
# * `:retry_codes` (*type:* `Array<String>`) - The error codes that should
|
1231
|
+
# trigger a retry.
|
1232
|
+
#
|
1233
|
+
class Rpcs
|
1234
|
+
##
|
1235
|
+
# RPC-specific configuration for `create_data_access_label`
|
1236
|
+
# @return [::Gapic::Config::Method]
|
1237
|
+
#
|
1238
|
+
attr_reader :create_data_access_label
|
1239
|
+
##
|
1240
|
+
# RPC-specific configuration for `get_data_access_label`
|
1241
|
+
# @return [::Gapic::Config::Method]
|
1242
|
+
#
|
1243
|
+
attr_reader :get_data_access_label
|
1244
|
+
##
|
1245
|
+
# RPC-specific configuration for `list_data_access_labels`
|
1246
|
+
# @return [::Gapic::Config::Method]
|
1247
|
+
#
|
1248
|
+
attr_reader :list_data_access_labels
|
1249
|
+
##
|
1250
|
+
# RPC-specific configuration for `update_data_access_label`
|
1251
|
+
# @return [::Gapic::Config::Method]
|
1252
|
+
#
|
1253
|
+
attr_reader :update_data_access_label
|
1254
|
+
##
|
1255
|
+
# RPC-specific configuration for `delete_data_access_label`
|
1256
|
+
# @return [::Gapic::Config::Method]
|
1257
|
+
#
|
1258
|
+
attr_reader :delete_data_access_label
|
1259
|
+
##
|
1260
|
+
# RPC-specific configuration for `create_data_access_scope`
|
1261
|
+
# @return [::Gapic::Config::Method]
|
1262
|
+
#
|
1263
|
+
attr_reader :create_data_access_scope
|
1264
|
+
##
|
1265
|
+
# RPC-specific configuration for `get_data_access_scope`
|
1266
|
+
# @return [::Gapic::Config::Method]
|
1267
|
+
#
|
1268
|
+
attr_reader :get_data_access_scope
|
1269
|
+
##
|
1270
|
+
# RPC-specific configuration for `list_data_access_scopes`
|
1271
|
+
# @return [::Gapic::Config::Method]
|
1272
|
+
#
|
1273
|
+
attr_reader :list_data_access_scopes
|
1274
|
+
##
|
1275
|
+
# RPC-specific configuration for `update_data_access_scope`
|
1276
|
+
# @return [::Gapic::Config::Method]
|
1277
|
+
#
|
1278
|
+
attr_reader :update_data_access_scope
|
1279
|
+
##
|
1280
|
+
# RPC-specific configuration for `delete_data_access_scope`
|
1281
|
+
# @return [::Gapic::Config::Method]
|
1282
|
+
#
|
1283
|
+
attr_reader :delete_data_access_scope
|
1284
|
+
|
1285
|
+
# @private
|
1286
|
+
def initialize parent_rpcs = nil
|
1287
|
+
create_data_access_label_config = parent_rpcs.create_data_access_label if parent_rpcs.respond_to? :create_data_access_label
|
1288
|
+
@create_data_access_label = ::Gapic::Config::Method.new create_data_access_label_config
|
1289
|
+
get_data_access_label_config = parent_rpcs.get_data_access_label if parent_rpcs.respond_to? :get_data_access_label
|
1290
|
+
@get_data_access_label = ::Gapic::Config::Method.new get_data_access_label_config
|
1291
|
+
list_data_access_labels_config = parent_rpcs.list_data_access_labels if parent_rpcs.respond_to? :list_data_access_labels
|
1292
|
+
@list_data_access_labels = ::Gapic::Config::Method.new list_data_access_labels_config
|
1293
|
+
update_data_access_label_config = parent_rpcs.update_data_access_label if parent_rpcs.respond_to? :update_data_access_label
|
1294
|
+
@update_data_access_label = ::Gapic::Config::Method.new update_data_access_label_config
|
1295
|
+
delete_data_access_label_config = parent_rpcs.delete_data_access_label if parent_rpcs.respond_to? :delete_data_access_label
|
1296
|
+
@delete_data_access_label = ::Gapic::Config::Method.new delete_data_access_label_config
|
1297
|
+
create_data_access_scope_config = parent_rpcs.create_data_access_scope if parent_rpcs.respond_to? :create_data_access_scope
|
1298
|
+
@create_data_access_scope = ::Gapic::Config::Method.new create_data_access_scope_config
|
1299
|
+
get_data_access_scope_config = parent_rpcs.get_data_access_scope if parent_rpcs.respond_to? :get_data_access_scope
|
1300
|
+
@get_data_access_scope = ::Gapic::Config::Method.new get_data_access_scope_config
|
1301
|
+
list_data_access_scopes_config = parent_rpcs.list_data_access_scopes if parent_rpcs.respond_to? :list_data_access_scopes
|
1302
|
+
@list_data_access_scopes = ::Gapic::Config::Method.new list_data_access_scopes_config
|
1303
|
+
update_data_access_scope_config = parent_rpcs.update_data_access_scope if parent_rpcs.respond_to? :update_data_access_scope
|
1304
|
+
@update_data_access_scope = ::Gapic::Config::Method.new update_data_access_scope_config
|
1305
|
+
delete_data_access_scope_config = parent_rpcs.delete_data_access_scope if parent_rpcs.respond_to? :delete_data_access_scope
|
1306
|
+
@delete_data_access_scope = ::Gapic::Config::Method.new delete_data_access_scope_config
|
1307
|
+
|
1308
|
+
yield self if block_given?
|
1309
|
+
end
|
1310
|
+
end
|
1311
|
+
end
|
1312
|
+
end
|
1313
|
+
end
|
1314
|
+
end
|
1315
|
+
end
|
1316
|
+
end
|
1317
|
+
end
|
1318
|
+
end
|