google-cloud-storage-control-v2 1.12.0 → 1.13.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/lib/google/cloud/storage/control/v2/storage_control/client.rb +578 -29
- data/lib/google/cloud/storage/control/v2/storage_control/paths.rb +19 -0
- data/lib/google/cloud/storage/control/v2/storage_control/rest/client.rb +784 -17
- data/lib/google/cloud/storage/control/v2/storage_control/rest/operations.rb +929 -0
- data/lib/google/cloud/storage/control/v2/storage_control/rest/service_stub.rb +430 -0
- data/lib/google/cloud/storage/control/v2/storage_control/rest.rb +1 -0
- data/lib/google/cloud/storage/control/v2/version.rb +1 -1
- data/lib/google/storage/control/v2/storage_control_pb.rb +13 -1
- data/lib/google/storage/control/v2/storage_control_services_pb.rb +14 -3
- data/proto_docs/google/storage/control/v2/storage_control.rb +314 -44
- metadata +2 -1
|
@@ -75,59 +75,89 @@ module Google
|
|
|
75
75
|
|
|
76
76
|
default_config.timeout = 60.0
|
|
77
77
|
|
|
78
|
+
default_config.rpcs.create_folder.timeout = 60.0
|
|
79
|
+
default_config.rpcs.create_folder.retry_policy = {
|
|
80
|
+
initial_delay: 1.0, max_delay: 60.0, multiplier: 2, retry_codes: [8, 14, 13, 2]
|
|
81
|
+
}
|
|
82
|
+
|
|
83
|
+
default_config.rpcs.get_folder.timeout = 60.0
|
|
84
|
+
default_config.rpcs.get_folder.retry_policy = {
|
|
85
|
+
initial_delay: 1.0, max_delay: 60.0, multiplier: 2, retry_codes: [8, 14, 13, 2]
|
|
86
|
+
}
|
|
87
|
+
|
|
88
|
+
default_config.rpcs.list_folders.timeout = 60.0
|
|
89
|
+
default_config.rpcs.list_folders.retry_policy = {
|
|
90
|
+
initial_delay: 1.0, max_delay: 60.0, multiplier: 2, retry_codes: [8, 14, 13, 2]
|
|
91
|
+
}
|
|
92
|
+
|
|
93
|
+
default_config.rpcs.rename_folder.timeout = 60.0
|
|
94
|
+
default_config.rpcs.rename_folder.retry_policy = {
|
|
95
|
+
initial_delay: 1.0, max_delay: 60.0, multiplier: 2, retry_codes: [8, 14, 13, 2]
|
|
96
|
+
}
|
|
97
|
+
|
|
98
|
+
default_config.rpcs.delete_folder_recursive.timeout = 60.0
|
|
99
|
+
default_config.rpcs.delete_folder_recursive.retry_policy = {
|
|
100
|
+
initial_delay: 1.0, max_delay: 60.0, multiplier: 2, retry_codes: [8, 14, 13, 2]
|
|
101
|
+
}
|
|
102
|
+
|
|
103
|
+
default_config.rpcs.get_storage_layout.timeout = 60.0
|
|
104
|
+
default_config.rpcs.get_storage_layout.retry_policy = {
|
|
105
|
+
initial_delay: 1.0, max_delay: 60.0, multiplier: 2, retry_codes: [8, 14, 13, 2]
|
|
106
|
+
}
|
|
107
|
+
|
|
78
108
|
default_config.rpcs.get_project_intelligence_config.timeout = 60.0
|
|
79
109
|
default_config.rpcs.get_project_intelligence_config.retry_policy = {
|
|
80
|
-
initial_delay: 1.0, max_delay: 60.0, multiplier: 2, retry_codes: [8, 14,
|
|
110
|
+
initial_delay: 1.0, max_delay: 60.0, multiplier: 2, retry_codes: [8, 14, 13, 2]
|
|
81
111
|
}
|
|
82
112
|
|
|
83
113
|
default_config.rpcs.update_project_intelligence_config.timeout = 60.0
|
|
84
114
|
default_config.rpcs.update_project_intelligence_config.retry_policy = {
|
|
85
|
-
initial_delay: 1.0, max_delay: 60.0, multiplier: 2, retry_codes: [8, 14,
|
|
115
|
+
initial_delay: 1.0, max_delay: 60.0, multiplier: 2, retry_codes: [8, 14, 13, 2]
|
|
86
116
|
}
|
|
87
117
|
|
|
88
118
|
default_config.rpcs.get_folder_intelligence_config.timeout = 60.0
|
|
89
119
|
default_config.rpcs.get_folder_intelligence_config.retry_policy = {
|
|
90
|
-
initial_delay: 1.0, max_delay: 60.0, multiplier: 2, retry_codes: [8, 14,
|
|
120
|
+
initial_delay: 1.0, max_delay: 60.0, multiplier: 2, retry_codes: [8, 14, 13, 2]
|
|
91
121
|
}
|
|
92
122
|
|
|
93
123
|
default_config.rpcs.update_folder_intelligence_config.timeout = 60.0
|
|
94
124
|
default_config.rpcs.update_folder_intelligence_config.retry_policy = {
|
|
95
|
-
initial_delay: 1.0, max_delay: 60.0, multiplier: 2, retry_codes: [8, 14,
|
|
125
|
+
initial_delay: 1.0, max_delay: 60.0, multiplier: 2, retry_codes: [8, 14, 13, 2]
|
|
96
126
|
}
|
|
97
127
|
|
|
98
128
|
default_config.rpcs.get_organization_intelligence_config.timeout = 60.0
|
|
99
129
|
default_config.rpcs.get_organization_intelligence_config.retry_policy = {
|
|
100
|
-
initial_delay: 1.0, max_delay: 60.0, multiplier: 2, retry_codes: [8, 14,
|
|
130
|
+
initial_delay: 1.0, max_delay: 60.0, multiplier: 2, retry_codes: [8, 14, 13, 2]
|
|
101
131
|
}
|
|
102
132
|
|
|
103
133
|
default_config.rpcs.update_organization_intelligence_config.timeout = 60.0
|
|
104
134
|
default_config.rpcs.update_organization_intelligence_config.retry_policy = {
|
|
105
|
-
initial_delay: 1.0, max_delay: 60.0, multiplier: 2, retry_codes: [8, 14,
|
|
135
|
+
initial_delay: 1.0, max_delay: 60.0, multiplier: 2, retry_codes: [8, 14, 13, 2]
|
|
106
136
|
}
|
|
107
137
|
|
|
108
138
|
default_config.rpcs.get_intelligence_finding.timeout = 60.0
|
|
109
139
|
default_config.rpcs.get_intelligence_finding.retry_policy = {
|
|
110
|
-
initial_delay: 1.0, max_delay: 60.0, multiplier: 2, retry_codes: [8, 14,
|
|
140
|
+
initial_delay: 1.0, max_delay: 60.0, multiplier: 2, retry_codes: [8, 14, 13, 2]
|
|
111
141
|
}
|
|
112
142
|
|
|
113
143
|
default_config.rpcs.list_intelligence_findings.timeout = 60.0
|
|
114
144
|
default_config.rpcs.list_intelligence_findings.retry_policy = {
|
|
115
|
-
initial_delay: 1.0, max_delay: 60.0, multiplier: 2, retry_codes: [8, 14,
|
|
145
|
+
initial_delay: 1.0, max_delay: 60.0, multiplier: 2, retry_codes: [8, 14, 13, 2]
|
|
116
146
|
}
|
|
117
147
|
|
|
118
148
|
default_config.rpcs.summarize_intelligence_findings.timeout = 60.0
|
|
119
149
|
default_config.rpcs.summarize_intelligence_findings.retry_policy = {
|
|
120
|
-
initial_delay: 1.0, max_delay: 60.0, multiplier: 2, retry_codes: [8, 14,
|
|
150
|
+
initial_delay: 1.0, max_delay: 60.0, multiplier: 2, retry_codes: [8, 14, 13, 2]
|
|
121
151
|
}
|
|
122
152
|
|
|
123
153
|
default_config.rpcs.get_intelligence_finding_revision.timeout = 60.0
|
|
124
154
|
default_config.rpcs.get_intelligence_finding_revision.retry_policy = {
|
|
125
|
-
initial_delay: 1.0, max_delay: 60.0, multiplier: 2, retry_codes: [8, 14,
|
|
155
|
+
initial_delay: 1.0, max_delay: 60.0, multiplier: 2, retry_codes: [8, 14, 13, 2]
|
|
126
156
|
}
|
|
127
157
|
|
|
128
158
|
default_config.rpcs.list_intelligence_finding_revisions.timeout = 60.0
|
|
129
159
|
default_config.rpcs.list_intelligence_finding_revisions.retry_policy = {
|
|
130
|
-
initial_delay: 1.0, max_delay: 60.0, multiplier: 2, retry_codes: [8, 14,
|
|
160
|
+
initial_delay: 1.0, max_delay: 60.0, multiplier: 2, retry_codes: [8, 14, 13, 2]
|
|
131
161
|
}
|
|
132
162
|
|
|
133
163
|
default_config
|
|
@@ -204,6 +234,13 @@ module Google
|
|
|
204
234
|
@quota_project_id = @config.quota_project
|
|
205
235
|
@quota_project_id ||= credentials.quota_project_id if credentials.respond_to? :quota_project_id
|
|
206
236
|
|
|
237
|
+
@operations_client = ::Google::Cloud::Storage::Control::V2::StorageControl::Rest::Operations.new do |config|
|
|
238
|
+
config.credentials = credentials
|
|
239
|
+
config.quota_project = @quota_project_id
|
|
240
|
+
config.endpoint = @config.endpoint
|
|
241
|
+
config.universe_domain = @config.universe_domain
|
|
242
|
+
end
|
|
243
|
+
|
|
207
244
|
@storage_control_stub = ::Google::Cloud::Storage::Control::V2::StorageControl::Rest::ServiceStub.new(
|
|
208
245
|
endpoint: @config.endpoint,
|
|
209
246
|
endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
|
|
@@ -223,6 +260,13 @@ module Google
|
|
|
223
260
|
end
|
|
224
261
|
end
|
|
225
262
|
|
|
263
|
+
##
|
|
264
|
+
# Get the associated client for long-running operations.
|
|
265
|
+
#
|
|
266
|
+
# @return [::Google::Cloud::Storage::Control::V2::StorageControl::Rest::Operations]
|
|
267
|
+
#
|
|
268
|
+
attr_reader :operations_client
|
|
269
|
+
|
|
226
270
|
##
|
|
227
271
|
# The logger used for request/response debug logging.
|
|
228
272
|
#
|
|
@@ -234,6 +278,680 @@ module Google
|
|
|
234
278
|
|
|
235
279
|
# Service calls
|
|
236
280
|
|
|
281
|
+
##
|
|
282
|
+
# Creates a new folder. This operation is only applicable to a hierarchical
|
|
283
|
+
# namespace enabled bucket.
|
|
284
|
+
#
|
|
285
|
+
# @overload create_folder(request, options = nil)
|
|
286
|
+
# Pass arguments to `create_folder` via a request object, either of type
|
|
287
|
+
# {::Google::Cloud::Storage::Control::V2::CreateFolderRequest} or an equivalent Hash.
|
|
288
|
+
#
|
|
289
|
+
# @param request [::Google::Cloud::Storage::Control::V2::CreateFolderRequest, ::Hash]
|
|
290
|
+
# A request object representing the call parameters. Required. To specify no
|
|
291
|
+
# parameters, or to keep all the default parameter values, pass an empty Hash.
|
|
292
|
+
# @param options [::Gapic::CallOptions, ::Hash]
|
|
293
|
+
# Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
|
|
294
|
+
#
|
|
295
|
+
# @overload create_folder(parent: nil, folder: nil, folder_id: nil, recursive: nil, request_id: nil)
|
|
296
|
+
# Pass arguments to `create_folder` via keyword arguments. Note that at
|
|
297
|
+
# least one keyword argument is required. To specify no parameters, or to keep all
|
|
298
|
+
# the default parameter values, pass an empty Hash as a request object (see above).
|
|
299
|
+
#
|
|
300
|
+
# @param parent [::String]
|
|
301
|
+
# Required. Name of the bucket in which the folder will reside. The bucket
|
|
302
|
+
# must be a hierarchical namespace enabled bucket.
|
|
303
|
+
# @param folder [::Google::Cloud::Storage::Control::V2::Folder, ::Hash]
|
|
304
|
+
# Required. Properties of the new folder being created.
|
|
305
|
+
# The bucket and name of the folder are specified in the parent and folder_id
|
|
306
|
+
# fields, respectively. Populating those fields in `folder` will result in an
|
|
307
|
+
# error.
|
|
308
|
+
# @param folder_id [::String]
|
|
309
|
+
# Required. The full name of a folder, including all its parent folders.
|
|
310
|
+
# Folders use single '/' characters as a delimiter.
|
|
311
|
+
# The folder_id must end with a slash.
|
|
312
|
+
# For example, the folder_id of "books/biographies/" would create a new
|
|
313
|
+
# "biographies/" folder under the "books/" folder.
|
|
314
|
+
# @param recursive [::Boolean]
|
|
315
|
+
# Optional. If true, parent folder doesn't have to be present and all missing
|
|
316
|
+
# ancestor folders will be created atomically.
|
|
317
|
+
# @param request_id [::String]
|
|
318
|
+
# Optional. A unique identifier for this request. UUID is the recommended
|
|
319
|
+
# format, but other formats are still accepted.
|
|
320
|
+
# @yield [result, operation] Access the result along with the TransportOperation object
|
|
321
|
+
# @yieldparam result [::Google::Cloud::Storage::Control::V2::Folder]
|
|
322
|
+
# @yieldparam operation [::Gapic::Rest::TransportOperation]
|
|
323
|
+
#
|
|
324
|
+
# @return [::Google::Cloud::Storage::Control::V2::Folder]
|
|
325
|
+
#
|
|
326
|
+
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
|
327
|
+
#
|
|
328
|
+
# @example Basic example
|
|
329
|
+
# require "google/cloud/storage/control/v2"
|
|
330
|
+
#
|
|
331
|
+
# # Create a client object. The client can be reused for multiple calls.
|
|
332
|
+
# client = Google::Cloud::Storage::Control::V2::StorageControl::Rest::Client.new
|
|
333
|
+
#
|
|
334
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
|
335
|
+
# request = Google::Cloud::Storage::Control::V2::CreateFolderRequest.new
|
|
336
|
+
#
|
|
337
|
+
# # Call the create_folder method.
|
|
338
|
+
# result = client.create_folder request
|
|
339
|
+
#
|
|
340
|
+
# # The returned object is of type Google::Cloud::Storage::Control::V2::Folder.
|
|
341
|
+
# p result
|
|
342
|
+
#
|
|
343
|
+
def create_folder request, options = nil
|
|
344
|
+
raise ::ArgumentError, "request must be provided" if request.nil?
|
|
345
|
+
|
|
346
|
+
request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Storage::Control::V2::CreateFolderRequest
|
|
347
|
+
|
|
348
|
+
# Converts hash and nil to an options object
|
|
349
|
+
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
|
|
350
|
+
|
|
351
|
+
# Customize the options with defaults
|
|
352
|
+
call_metadata = @config.rpcs.create_folder.metadata.to_h
|
|
353
|
+
|
|
354
|
+
# Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
|
|
355
|
+
call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
|
|
356
|
+
lib_name: @config.lib_name, lib_version: @config.lib_version,
|
|
357
|
+
gapic_version: ::Google::Cloud::Storage::Control::V2::VERSION,
|
|
358
|
+
transports_version_send: [:rest]
|
|
359
|
+
|
|
360
|
+
call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
|
|
361
|
+
call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
|
362
|
+
|
|
363
|
+
options.apply_defaults timeout: @config.rpcs.create_folder.timeout,
|
|
364
|
+
metadata: call_metadata,
|
|
365
|
+
retry_policy: @config.rpcs.create_folder.retry_policy
|
|
366
|
+
|
|
367
|
+
options.apply_defaults timeout: @config.timeout,
|
|
368
|
+
metadata: @config.metadata,
|
|
369
|
+
retry_policy: @config.retry_policy
|
|
370
|
+
|
|
371
|
+
@storage_control_stub.create_folder request, options do |result, operation|
|
|
372
|
+
yield result, operation if block_given?
|
|
373
|
+
end
|
|
374
|
+
rescue ::Gapic::Rest::Error => e
|
|
375
|
+
raise ::Google::Cloud::Error.from_error(e)
|
|
376
|
+
end
|
|
377
|
+
|
|
378
|
+
##
|
|
379
|
+
# Permanently deletes an empty folder. This operation is only applicable to a
|
|
380
|
+
# hierarchical namespace enabled bucket.
|
|
381
|
+
#
|
|
382
|
+
# @overload delete_folder(request, options = nil)
|
|
383
|
+
# Pass arguments to `delete_folder` via a request object, either of type
|
|
384
|
+
# {::Google::Cloud::Storage::Control::V2::DeleteFolderRequest} or an equivalent Hash.
|
|
385
|
+
#
|
|
386
|
+
# @param request [::Google::Cloud::Storage::Control::V2::DeleteFolderRequest, ::Hash]
|
|
387
|
+
# A request object representing the call parameters. Required. To specify no
|
|
388
|
+
# parameters, or to keep all the default parameter values, pass an empty Hash.
|
|
389
|
+
# @param options [::Gapic::CallOptions, ::Hash]
|
|
390
|
+
# Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
|
|
391
|
+
#
|
|
392
|
+
# @overload delete_folder(name: nil, if_metageneration_match: nil, if_metageneration_not_match: nil, request_id: nil)
|
|
393
|
+
# Pass arguments to `delete_folder` via keyword arguments. Note that at
|
|
394
|
+
# least one keyword argument is required. To specify no parameters, or to keep all
|
|
395
|
+
# the default parameter values, pass an empty Hash as a request object (see above).
|
|
396
|
+
#
|
|
397
|
+
# @param name [::String]
|
|
398
|
+
# Required. Name of the folder.
|
|
399
|
+
# Format: `projects/{project}/buckets/{bucket}/folders/{folder}`
|
|
400
|
+
# @param if_metageneration_match [::Integer]
|
|
401
|
+
# Makes the operation only succeed conditional on whether the folder's
|
|
402
|
+
# current metageneration matches the given value.
|
|
403
|
+
# @param if_metageneration_not_match [::Integer]
|
|
404
|
+
# Makes the operation only succeed conditional on whether the folder's
|
|
405
|
+
# current metageneration does not match the given value.
|
|
406
|
+
# @param request_id [::String]
|
|
407
|
+
# Optional. A unique identifier for this request. UUID is the recommended
|
|
408
|
+
# format, but other formats are still accepted.
|
|
409
|
+
# @yield [result, operation] Access the result along with the TransportOperation object
|
|
410
|
+
# @yieldparam result [::Google::Protobuf::Empty]
|
|
411
|
+
# @yieldparam operation [::Gapic::Rest::TransportOperation]
|
|
412
|
+
#
|
|
413
|
+
# @return [::Google::Protobuf::Empty]
|
|
414
|
+
#
|
|
415
|
+
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
|
416
|
+
#
|
|
417
|
+
# @example Basic example
|
|
418
|
+
# require "google/cloud/storage/control/v2"
|
|
419
|
+
#
|
|
420
|
+
# # Create a client object. The client can be reused for multiple calls.
|
|
421
|
+
# client = Google::Cloud::Storage::Control::V2::StorageControl::Rest::Client.new
|
|
422
|
+
#
|
|
423
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
|
424
|
+
# request = Google::Cloud::Storage::Control::V2::DeleteFolderRequest.new
|
|
425
|
+
#
|
|
426
|
+
# # Call the delete_folder method.
|
|
427
|
+
# result = client.delete_folder request
|
|
428
|
+
#
|
|
429
|
+
# # The returned object is of type Google::Protobuf::Empty.
|
|
430
|
+
# p result
|
|
431
|
+
#
|
|
432
|
+
def delete_folder request, options = nil
|
|
433
|
+
raise ::ArgumentError, "request must be provided" if request.nil?
|
|
434
|
+
|
|
435
|
+
request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Storage::Control::V2::DeleteFolderRequest
|
|
436
|
+
|
|
437
|
+
# Converts hash and nil to an options object
|
|
438
|
+
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
|
|
439
|
+
|
|
440
|
+
# Customize the options with defaults
|
|
441
|
+
call_metadata = @config.rpcs.delete_folder.metadata.to_h
|
|
442
|
+
|
|
443
|
+
# Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
|
|
444
|
+
call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
|
|
445
|
+
lib_name: @config.lib_name, lib_version: @config.lib_version,
|
|
446
|
+
gapic_version: ::Google::Cloud::Storage::Control::V2::VERSION,
|
|
447
|
+
transports_version_send: [:rest]
|
|
448
|
+
|
|
449
|
+
call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
|
|
450
|
+
call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
|
451
|
+
|
|
452
|
+
options.apply_defaults timeout: @config.rpcs.delete_folder.timeout,
|
|
453
|
+
metadata: call_metadata,
|
|
454
|
+
retry_policy: @config.rpcs.delete_folder.retry_policy
|
|
455
|
+
|
|
456
|
+
options.apply_defaults timeout: @config.timeout,
|
|
457
|
+
metadata: @config.metadata,
|
|
458
|
+
retry_policy: @config.retry_policy
|
|
459
|
+
|
|
460
|
+
@storage_control_stub.delete_folder request, options do |result, operation|
|
|
461
|
+
yield result, operation if block_given?
|
|
462
|
+
end
|
|
463
|
+
rescue ::Gapic::Rest::Error => e
|
|
464
|
+
raise ::Google::Cloud::Error.from_error(e)
|
|
465
|
+
end
|
|
466
|
+
|
|
467
|
+
##
|
|
468
|
+
# Returns metadata for the specified folder. This operation is only
|
|
469
|
+
# applicable to a hierarchical namespace enabled bucket.
|
|
470
|
+
#
|
|
471
|
+
# @overload get_folder(request, options = nil)
|
|
472
|
+
# Pass arguments to `get_folder` via a request object, either of type
|
|
473
|
+
# {::Google::Cloud::Storage::Control::V2::GetFolderRequest} or an equivalent Hash.
|
|
474
|
+
#
|
|
475
|
+
# @param request [::Google::Cloud::Storage::Control::V2::GetFolderRequest, ::Hash]
|
|
476
|
+
# A request object representing the call parameters. Required. To specify no
|
|
477
|
+
# parameters, or to keep all the default parameter values, pass an empty Hash.
|
|
478
|
+
# @param options [::Gapic::CallOptions, ::Hash]
|
|
479
|
+
# Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
|
|
480
|
+
#
|
|
481
|
+
# @overload get_folder(name: nil, if_metageneration_match: nil, if_metageneration_not_match: nil, request_id: nil)
|
|
482
|
+
# Pass arguments to `get_folder` via keyword arguments. Note that at
|
|
483
|
+
# least one keyword argument is required. To specify no parameters, or to keep all
|
|
484
|
+
# the default parameter values, pass an empty Hash as a request object (see above).
|
|
485
|
+
#
|
|
486
|
+
# @param name [::String]
|
|
487
|
+
# Required. Name of the folder.
|
|
488
|
+
# Format: `projects/{project}/buckets/{bucket}/folders/{folder}`
|
|
489
|
+
# @param if_metageneration_match [::Integer]
|
|
490
|
+
# Makes the operation only succeed conditional on whether the folder's
|
|
491
|
+
# current metageneration matches the given value.
|
|
492
|
+
# @param if_metageneration_not_match [::Integer]
|
|
493
|
+
# Makes the operation only succeed conditional on whether the folder's
|
|
494
|
+
# current metageneration does not match the given value.
|
|
495
|
+
# @param request_id [::String]
|
|
496
|
+
# Optional. A unique identifier for this request. UUID is the recommended
|
|
497
|
+
# format, but other formats are still accepted.
|
|
498
|
+
# @yield [result, operation] Access the result along with the TransportOperation object
|
|
499
|
+
# @yieldparam result [::Google::Cloud::Storage::Control::V2::Folder]
|
|
500
|
+
# @yieldparam operation [::Gapic::Rest::TransportOperation]
|
|
501
|
+
#
|
|
502
|
+
# @return [::Google::Cloud::Storage::Control::V2::Folder]
|
|
503
|
+
#
|
|
504
|
+
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
|
505
|
+
#
|
|
506
|
+
# @example Basic example
|
|
507
|
+
# require "google/cloud/storage/control/v2"
|
|
508
|
+
#
|
|
509
|
+
# # Create a client object. The client can be reused for multiple calls.
|
|
510
|
+
# client = Google::Cloud::Storage::Control::V2::StorageControl::Rest::Client.new
|
|
511
|
+
#
|
|
512
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
|
513
|
+
# request = Google::Cloud::Storage::Control::V2::GetFolderRequest.new
|
|
514
|
+
#
|
|
515
|
+
# # Call the get_folder method.
|
|
516
|
+
# result = client.get_folder request
|
|
517
|
+
#
|
|
518
|
+
# # The returned object is of type Google::Cloud::Storage::Control::V2::Folder.
|
|
519
|
+
# p result
|
|
520
|
+
#
|
|
521
|
+
def get_folder request, options = nil
|
|
522
|
+
raise ::ArgumentError, "request must be provided" if request.nil?
|
|
523
|
+
|
|
524
|
+
request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Storage::Control::V2::GetFolderRequest
|
|
525
|
+
|
|
526
|
+
# Converts hash and nil to an options object
|
|
527
|
+
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
|
|
528
|
+
|
|
529
|
+
# Customize the options with defaults
|
|
530
|
+
call_metadata = @config.rpcs.get_folder.metadata.to_h
|
|
531
|
+
|
|
532
|
+
# Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
|
|
533
|
+
call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
|
|
534
|
+
lib_name: @config.lib_name, lib_version: @config.lib_version,
|
|
535
|
+
gapic_version: ::Google::Cloud::Storage::Control::V2::VERSION,
|
|
536
|
+
transports_version_send: [:rest]
|
|
537
|
+
|
|
538
|
+
call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
|
|
539
|
+
call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
|
540
|
+
|
|
541
|
+
options.apply_defaults timeout: @config.rpcs.get_folder.timeout,
|
|
542
|
+
metadata: call_metadata,
|
|
543
|
+
retry_policy: @config.rpcs.get_folder.retry_policy
|
|
544
|
+
|
|
545
|
+
options.apply_defaults timeout: @config.timeout,
|
|
546
|
+
metadata: @config.metadata,
|
|
547
|
+
retry_policy: @config.retry_policy
|
|
548
|
+
|
|
549
|
+
@storage_control_stub.get_folder request, options do |result, operation|
|
|
550
|
+
yield result, operation if block_given?
|
|
551
|
+
end
|
|
552
|
+
rescue ::Gapic::Rest::Error => e
|
|
553
|
+
raise ::Google::Cloud::Error.from_error(e)
|
|
554
|
+
end
|
|
555
|
+
|
|
556
|
+
##
|
|
557
|
+
# Retrieves a list of folders. This operation is only applicable to a
|
|
558
|
+
# hierarchical namespace enabled bucket.
|
|
559
|
+
#
|
|
560
|
+
# @overload list_folders(request, options = nil)
|
|
561
|
+
# Pass arguments to `list_folders` via a request object, either of type
|
|
562
|
+
# {::Google::Cloud::Storage::Control::V2::ListFoldersRequest} or an equivalent Hash.
|
|
563
|
+
#
|
|
564
|
+
# @param request [::Google::Cloud::Storage::Control::V2::ListFoldersRequest, ::Hash]
|
|
565
|
+
# A request object representing the call parameters. Required. To specify no
|
|
566
|
+
# parameters, or to keep all the default parameter values, pass an empty Hash.
|
|
567
|
+
# @param options [::Gapic::CallOptions, ::Hash]
|
|
568
|
+
# Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
|
|
569
|
+
#
|
|
570
|
+
# @overload list_folders(parent: nil, page_size: nil, page_token: nil, prefix: nil, delimiter: nil, lexicographic_start: nil, lexicographic_end: nil, request_id: nil)
|
|
571
|
+
# Pass arguments to `list_folders` via keyword arguments. Note that at
|
|
572
|
+
# least one keyword argument is required. To specify no parameters, or to keep all
|
|
573
|
+
# the default parameter values, pass an empty Hash as a request object (see above).
|
|
574
|
+
#
|
|
575
|
+
# @param parent [::String]
|
|
576
|
+
# Required. Name of the bucket in which to look for folders. The bucket must
|
|
577
|
+
# be a hierarchical namespace enabled bucket.
|
|
578
|
+
# @param page_size [::Integer]
|
|
579
|
+
# Optional. Maximum number of folders to return in a single response. The
|
|
580
|
+
# service will use this parameter or 1,000 items, whichever is smaller.
|
|
581
|
+
# @param page_token [::String]
|
|
582
|
+
# Optional. A previously-returned page token representing part of the larger
|
|
583
|
+
# set of results to view.
|
|
584
|
+
# @param prefix [::String]
|
|
585
|
+
# Optional. Filter results to folders whose names begin with this prefix.
|
|
586
|
+
# If set, the value must either be an empty string or end with a '/'.
|
|
587
|
+
# @param delimiter [::String]
|
|
588
|
+
# Optional. If set, returns results in a directory-like mode. The results
|
|
589
|
+
# will only include folders that either exactly match the above prefix, or
|
|
590
|
+
# are one level below the prefix. The only supported value is '/'.
|
|
591
|
+
# @param lexicographic_start [::String]
|
|
592
|
+
# Optional. Filter results to folders whose names are lexicographically equal
|
|
593
|
+
# to or after lexicographic_start. If lexicographic_end is also set, the
|
|
594
|
+
# folders listed have names between lexicographic_start (inclusive) and
|
|
595
|
+
# lexicographic_end (exclusive).
|
|
596
|
+
# @param lexicographic_end [::String]
|
|
597
|
+
# Optional. Filter results to folders whose names are lexicographically
|
|
598
|
+
# before lexicographic_end. If lexicographic_start is also set, the folders
|
|
599
|
+
# listed have names between lexicographic_start (inclusive) and
|
|
600
|
+
# lexicographic_end (exclusive).
|
|
601
|
+
# @param request_id [::String]
|
|
602
|
+
# Optional. A unique identifier for this request. UUID is the recommended
|
|
603
|
+
# format, but other formats are still accepted.
|
|
604
|
+
# @yield [result, operation] Access the result along with the TransportOperation object
|
|
605
|
+
# @yieldparam result [::Gapic::Rest::PagedEnumerable<::Google::Cloud::Storage::Control::V2::Folder>]
|
|
606
|
+
# @yieldparam operation [::Gapic::Rest::TransportOperation]
|
|
607
|
+
#
|
|
608
|
+
# @return [::Gapic::Rest::PagedEnumerable<::Google::Cloud::Storage::Control::V2::Folder>]
|
|
609
|
+
#
|
|
610
|
+
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
|
611
|
+
#
|
|
612
|
+
# @example Basic example
|
|
613
|
+
# require "google/cloud/storage/control/v2"
|
|
614
|
+
#
|
|
615
|
+
# # Create a client object. The client can be reused for multiple calls.
|
|
616
|
+
# client = Google::Cloud::Storage::Control::V2::StorageControl::Rest::Client.new
|
|
617
|
+
#
|
|
618
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
|
619
|
+
# request = Google::Cloud::Storage::Control::V2::ListFoldersRequest.new
|
|
620
|
+
#
|
|
621
|
+
# # Call the list_folders method.
|
|
622
|
+
# result = client.list_folders request
|
|
623
|
+
#
|
|
624
|
+
# # The returned object is of type Gapic::PagedEnumerable. You can iterate
|
|
625
|
+
# # over elements, and API calls will be issued to fetch pages as needed.
|
|
626
|
+
# result.each do |item|
|
|
627
|
+
# # Each element is of type ::Google::Cloud::Storage::Control::V2::Folder.
|
|
628
|
+
# p item
|
|
629
|
+
# end
|
|
630
|
+
#
|
|
631
|
+
def list_folders request, options = nil
|
|
632
|
+
raise ::ArgumentError, "request must be provided" if request.nil?
|
|
633
|
+
|
|
634
|
+
request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Storage::Control::V2::ListFoldersRequest
|
|
635
|
+
|
|
636
|
+
# Converts hash and nil to an options object
|
|
637
|
+
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
|
|
638
|
+
|
|
639
|
+
# Customize the options with defaults
|
|
640
|
+
call_metadata = @config.rpcs.list_folders.metadata.to_h
|
|
641
|
+
|
|
642
|
+
# Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
|
|
643
|
+
call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
|
|
644
|
+
lib_name: @config.lib_name, lib_version: @config.lib_version,
|
|
645
|
+
gapic_version: ::Google::Cloud::Storage::Control::V2::VERSION,
|
|
646
|
+
transports_version_send: [:rest]
|
|
647
|
+
|
|
648
|
+
call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
|
|
649
|
+
call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
|
650
|
+
|
|
651
|
+
options.apply_defaults timeout: @config.rpcs.list_folders.timeout,
|
|
652
|
+
metadata: call_metadata,
|
|
653
|
+
retry_policy: @config.rpcs.list_folders.retry_policy
|
|
654
|
+
|
|
655
|
+
options.apply_defaults timeout: @config.timeout,
|
|
656
|
+
metadata: @config.metadata,
|
|
657
|
+
retry_policy: @config.retry_policy
|
|
658
|
+
|
|
659
|
+
@storage_control_stub.list_folders request, options do |result, operation|
|
|
660
|
+
result = ::Gapic::Rest::PagedEnumerable.new @storage_control_stub, :list_folders, "folders", request, result, options
|
|
661
|
+
yield result, operation if block_given?
|
|
662
|
+
throw :response, result
|
|
663
|
+
end
|
|
664
|
+
rescue ::Gapic::Rest::Error => e
|
|
665
|
+
raise ::Google::Cloud::Error.from_error(e)
|
|
666
|
+
end
|
|
667
|
+
|
|
668
|
+
##
|
|
669
|
+
# Renames a source folder to a destination folder. This operation is only
|
|
670
|
+
# applicable to a hierarchical namespace enabled bucket. During a rename, the
|
|
671
|
+
# source and destination folders are locked until the long running operation
|
|
672
|
+
# completes.
|
|
673
|
+
#
|
|
674
|
+
# @overload rename_folder(request, options = nil)
|
|
675
|
+
# Pass arguments to `rename_folder` via a request object, either of type
|
|
676
|
+
# {::Google::Cloud::Storage::Control::V2::RenameFolderRequest} or an equivalent Hash.
|
|
677
|
+
#
|
|
678
|
+
# @param request [::Google::Cloud::Storage::Control::V2::RenameFolderRequest, ::Hash]
|
|
679
|
+
# A request object representing the call parameters. Required. To specify no
|
|
680
|
+
# parameters, or to keep all the default parameter values, pass an empty Hash.
|
|
681
|
+
# @param options [::Gapic::CallOptions, ::Hash]
|
|
682
|
+
# Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
|
|
683
|
+
#
|
|
684
|
+
# @overload rename_folder(name: nil, destination_folder_id: nil, if_metageneration_match: nil, if_metageneration_not_match: nil, request_id: nil)
|
|
685
|
+
# Pass arguments to `rename_folder` via keyword arguments. Note that at
|
|
686
|
+
# least one keyword argument is required. To specify no parameters, or to keep all
|
|
687
|
+
# the default parameter values, pass an empty Hash as a request object (see above).
|
|
688
|
+
#
|
|
689
|
+
# @param name [::String]
|
|
690
|
+
# Required. Name of the source folder being renamed.
|
|
691
|
+
# Format: `projects/{project}/buckets/{bucket}/folders/{folder}`
|
|
692
|
+
# @param destination_folder_id [::String]
|
|
693
|
+
# Required. The destination folder ID, e.g. `foo/bar/`.
|
|
694
|
+
# @param if_metageneration_match [::Integer]
|
|
695
|
+
# Makes the operation only succeed conditional on whether the source
|
|
696
|
+
# folder's current metageneration matches the given value.
|
|
697
|
+
# @param if_metageneration_not_match [::Integer]
|
|
698
|
+
# Makes the operation only succeed conditional on whether the source
|
|
699
|
+
# folder's current metageneration does not match the given value.
|
|
700
|
+
# @param request_id [::String]
|
|
701
|
+
# Optional. A unique identifier for this request. UUID is the recommended
|
|
702
|
+
# format, but other formats are still accepted. This request is only
|
|
703
|
+
# idempotent if a `request_id` is provided.
|
|
704
|
+
# @yield [result, operation] Access the result along with the TransportOperation object
|
|
705
|
+
# @yieldparam result [::Gapic::Operation]
|
|
706
|
+
# @yieldparam operation [::Gapic::Rest::TransportOperation]
|
|
707
|
+
#
|
|
708
|
+
# @return [::Gapic::Operation]
|
|
709
|
+
#
|
|
710
|
+
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
|
711
|
+
#
|
|
712
|
+
# @example Basic example
|
|
713
|
+
# require "google/cloud/storage/control/v2"
|
|
714
|
+
#
|
|
715
|
+
# # Create a client object. The client can be reused for multiple calls.
|
|
716
|
+
# client = Google::Cloud::Storage::Control::V2::StorageControl::Rest::Client.new
|
|
717
|
+
#
|
|
718
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
|
719
|
+
# request = Google::Cloud::Storage::Control::V2::RenameFolderRequest.new
|
|
720
|
+
#
|
|
721
|
+
# # Call the rename_folder method.
|
|
722
|
+
# result = client.rename_folder request
|
|
723
|
+
#
|
|
724
|
+
# # The returned object is of type Gapic::Operation. You can use it to
|
|
725
|
+
# # check the status of an operation, cancel it, or wait for results.
|
|
726
|
+
# # Here is how to wait for a response.
|
|
727
|
+
# result.wait_until_done! timeout: 60
|
|
728
|
+
# if result.response?
|
|
729
|
+
# p result.response
|
|
730
|
+
# else
|
|
731
|
+
# puts "No response received."
|
|
732
|
+
# end
|
|
733
|
+
#
|
|
734
|
+
def rename_folder request, options = nil
|
|
735
|
+
raise ::ArgumentError, "request must be provided" if request.nil?
|
|
736
|
+
|
|
737
|
+
request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Storage::Control::V2::RenameFolderRequest
|
|
738
|
+
|
|
739
|
+
# Converts hash and nil to an options object
|
|
740
|
+
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
|
|
741
|
+
|
|
742
|
+
# Customize the options with defaults
|
|
743
|
+
call_metadata = @config.rpcs.rename_folder.metadata.to_h
|
|
744
|
+
|
|
745
|
+
# Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
|
|
746
|
+
call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
|
|
747
|
+
lib_name: @config.lib_name, lib_version: @config.lib_version,
|
|
748
|
+
gapic_version: ::Google::Cloud::Storage::Control::V2::VERSION,
|
|
749
|
+
transports_version_send: [:rest]
|
|
750
|
+
|
|
751
|
+
call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
|
|
752
|
+
call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
|
753
|
+
|
|
754
|
+
options.apply_defaults timeout: @config.rpcs.rename_folder.timeout,
|
|
755
|
+
metadata: call_metadata,
|
|
756
|
+
retry_policy: @config.rpcs.rename_folder.retry_policy
|
|
757
|
+
|
|
758
|
+
options.apply_defaults timeout: @config.timeout,
|
|
759
|
+
metadata: @config.metadata,
|
|
760
|
+
retry_policy: @config.retry_policy
|
|
761
|
+
|
|
762
|
+
@storage_control_stub.rename_folder request, options do |result, operation|
|
|
763
|
+
result = ::Gapic::Operation.new result, @operations_client, options: options
|
|
764
|
+
yield result, operation if block_given?
|
|
765
|
+
throw :response, result
|
|
766
|
+
end
|
|
767
|
+
rescue ::Gapic::Rest::Error => e
|
|
768
|
+
raise ::Google::Cloud::Error.from_error(e)
|
|
769
|
+
end
|
|
770
|
+
|
|
771
|
+
##
|
|
772
|
+
# Deletes a folder recursively. This operation is only applicable to a
|
|
773
|
+
# hierarchical namespace enabled bucket.
|
|
774
|
+
#
|
|
775
|
+
# @overload delete_folder_recursive(request, options = nil)
|
|
776
|
+
# Pass arguments to `delete_folder_recursive` via a request object, either of type
|
|
777
|
+
# {::Google::Cloud::Storage::Control::V2::DeleteFolderRecursiveRequest} or an equivalent Hash.
|
|
778
|
+
#
|
|
779
|
+
# @param request [::Google::Cloud::Storage::Control::V2::DeleteFolderRecursiveRequest, ::Hash]
|
|
780
|
+
# A request object representing the call parameters. Required. To specify no
|
|
781
|
+
# parameters, or to keep all the default parameter values, pass an empty Hash.
|
|
782
|
+
# @param options [::Gapic::CallOptions, ::Hash]
|
|
783
|
+
# Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
|
|
784
|
+
#
|
|
785
|
+
# @overload delete_folder_recursive(name: nil, if_metageneration_match: nil, if_metageneration_not_match: nil, request_id: nil)
|
|
786
|
+
# Pass arguments to `delete_folder_recursive` via keyword arguments. Note that at
|
|
787
|
+
# least one keyword argument is required. To specify no parameters, or to keep all
|
|
788
|
+
# the default parameter values, pass an empty Hash as a request object (see above).
|
|
789
|
+
#
|
|
790
|
+
# @param name [::String]
|
|
791
|
+
# Required. Name of the folder being deleted, however all of its contents
|
|
792
|
+
# will be deleted too. Format:
|
|
793
|
+
# `projects/{project}/buckets/{bucket}/folders/{folder}`
|
|
794
|
+
# @param if_metageneration_match [::Integer]
|
|
795
|
+
# Optional. Makes the operation only succeed conditional on whether the root
|
|
796
|
+
# folder's current metageneration matches the given value.
|
|
797
|
+
# @param if_metageneration_not_match [::Integer]
|
|
798
|
+
# Optional. Makes the operation only succeed conditional on whether the root
|
|
799
|
+
# folder's current metageneration does not match the given value.
|
|
800
|
+
# @param request_id [::String]
|
|
801
|
+
# Optional. A unique identifier for this request. UUID is the recommended
|
|
802
|
+
# format, but other formats are still accepted.
|
|
803
|
+
# @yield [result, operation] Access the result along with the TransportOperation object
|
|
804
|
+
# @yieldparam result [::Gapic::Operation]
|
|
805
|
+
# @yieldparam operation [::Gapic::Rest::TransportOperation]
|
|
806
|
+
#
|
|
807
|
+
# @return [::Gapic::Operation]
|
|
808
|
+
#
|
|
809
|
+
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
|
810
|
+
#
|
|
811
|
+
# @example Basic example
|
|
812
|
+
# require "google/cloud/storage/control/v2"
|
|
813
|
+
#
|
|
814
|
+
# # Create a client object. The client can be reused for multiple calls.
|
|
815
|
+
# client = Google::Cloud::Storage::Control::V2::StorageControl::Rest::Client.new
|
|
816
|
+
#
|
|
817
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
|
818
|
+
# request = Google::Cloud::Storage::Control::V2::DeleteFolderRecursiveRequest.new
|
|
819
|
+
#
|
|
820
|
+
# # Call the delete_folder_recursive method.
|
|
821
|
+
# result = client.delete_folder_recursive request
|
|
822
|
+
#
|
|
823
|
+
# # The returned object is of type Gapic::Operation. You can use it to
|
|
824
|
+
# # check the status of an operation, cancel it, or wait for results.
|
|
825
|
+
# # Here is how to wait for a response.
|
|
826
|
+
# result.wait_until_done! timeout: 60
|
|
827
|
+
# if result.response?
|
|
828
|
+
# p result.response
|
|
829
|
+
# else
|
|
830
|
+
# puts "No response received."
|
|
831
|
+
# end
|
|
832
|
+
#
|
|
833
|
+
def delete_folder_recursive request, options = nil
|
|
834
|
+
raise ::ArgumentError, "request must be provided" if request.nil?
|
|
835
|
+
|
|
836
|
+
request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Storage::Control::V2::DeleteFolderRecursiveRequest
|
|
837
|
+
|
|
838
|
+
# Converts hash and nil to an options object
|
|
839
|
+
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
|
|
840
|
+
|
|
841
|
+
# Customize the options with defaults
|
|
842
|
+
call_metadata = @config.rpcs.delete_folder_recursive.metadata.to_h
|
|
843
|
+
|
|
844
|
+
# Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
|
|
845
|
+
call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
|
|
846
|
+
lib_name: @config.lib_name, lib_version: @config.lib_version,
|
|
847
|
+
gapic_version: ::Google::Cloud::Storage::Control::V2::VERSION,
|
|
848
|
+
transports_version_send: [:rest]
|
|
849
|
+
|
|
850
|
+
call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
|
|
851
|
+
call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
|
852
|
+
|
|
853
|
+
options.apply_defaults timeout: @config.rpcs.delete_folder_recursive.timeout,
|
|
854
|
+
metadata: call_metadata,
|
|
855
|
+
retry_policy: @config.rpcs.delete_folder_recursive.retry_policy
|
|
856
|
+
|
|
857
|
+
options.apply_defaults timeout: @config.timeout,
|
|
858
|
+
metadata: @config.metadata,
|
|
859
|
+
retry_policy: @config.retry_policy
|
|
860
|
+
|
|
861
|
+
@storage_control_stub.delete_folder_recursive request, options do |result, operation|
|
|
862
|
+
result = ::Gapic::Operation.new result, @operations_client, options: options
|
|
863
|
+
yield result, operation if block_given?
|
|
864
|
+
throw :response, result
|
|
865
|
+
end
|
|
866
|
+
rescue ::Gapic::Rest::Error => e
|
|
867
|
+
raise ::Google::Cloud::Error.from_error(e)
|
|
868
|
+
end
|
|
869
|
+
|
|
870
|
+
##
|
|
871
|
+
# Returns the storage layout configuration for a given bucket.
|
|
872
|
+
#
|
|
873
|
+
# @overload get_storage_layout(request, options = nil)
|
|
874
|
+
# Pass arguments to `get_storage_layout` via a request object, either of type
|
|
875
|
+
# {::Google::Cloud::Storage::Control::V2::GetStorageLayoutRequest} or an equivalent Hash.
|
|
876
|
+
#
|
|
877
|
+
# @param request [::Google::Cloud::Storage::Control::V2::GetStorageLayoutRequest, ::Hash]
|
|
878
|
+
# A request object representing the call parameters. Required. To specify no
|
|
879
|
+
# parameters, or to keep all the default parameter values, pass an empty Hash.
|
|
880
|
+
# @param options [::Gapic::CallOptions, ::Hash]
|
|
881
|
+
# Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
|
|
882
|
+
#
|
|
883
|
+
# @overload get_storage_layout(name: nil, prefix: nil, request_id: nil)
|
|
884
|
+
# Pass arguments to `get_storage_layout` via keyword arguments. Note that at
|
|
885
|
+
# least one keyword argument is required. To specify no parameters, or to keep all
|
|
886
|
+
# the default parameter values, pass an empty Hash as a request object (see above).
|
|
887
|
+
#
|
|
888
|
+
# @param name [::String]
|
|
889
|
+
# Required. The name of the StorageLayout resource.
|
|
890
|
+
# Format: `projects/{project}/buckets/{bucket}/storageLayout`
|
|
891
|
+
# @param prefix [::String]
|
|
892
|
+
# An optional prefix used for permission check. It is useful when the caller
|
|
893
|
+
# only has limited permissions under a specific prefix.
|
|
894
|
+
# @param request_id [::String]
|
|
895
|
+
# Optional. A unique identifier for this request. UUID is the recommended
|
|
896
|
+
# format, but other formats are still accepted.
|
|
897
|
+
# @yield [result, operation] Access the result along with the TransportOperation object
|
|
898
|
+
# @yieldparam result [::Google::Cloud::Storage::Control::V2::StorageLayout]
|
|
899
|
+
# @yieldparam operation [::Gapic::Rest::TransportOperation]
|
|
900
|
+
#
|
|
901
|
+
# @return [::Google::Cloud::Storage::Control::V2::StorageLayout]
|
|
902
|
+
#
|
|
903
|
+
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
|
904
|
+
#
|
|
905
|
+
# @example Basic example
|
|
906
|
+
# require "google/cloud/storage/control/v2"
|
|
907
|
+
#
|
|
908
|
+
# # Create a client object. The client can be reused for multiple calls.
|
|
909
|
+
# client = Google::Cloud::Storage::Control::V2::StorageControl::Rest::Client.new
|
|
910
|
+
#
|
|
911
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
|
912
|
+
# request = Google::Cloud::Storage::Control::V2::GetStorageLayoutRequest.new
|
|
913
|
+
#
|
|
914
|
+
# # Call the get_storage_layout method.
|
|
915
|
+
# result = client.get_storage_layout request
|
|
916
|
+
#
|
|
917
|
+
# # The returned object is of type Google::Cloud::Storage::Control::V2::StorageLayout.
|
|
918
|
+
# p result
|
|
919
|
+
#
|
|
920
|
+
def get_storage_layout request, options = nil
|
|
921
|
+
raise ::ArgumentError, "request must be provided" if request.nil?
|
|
922
|
+
|
|
923
|
+
request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Storage::Control::V2::GetStorageLayoutRequest
|
|
924
|
+
|
|
925
|
+
# Converts hash and nil to an options object
|
|
926
|
+
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
|
|
927
|
+
|
|
928
|
+
# Customize the options with defaults
|
|
929
|
+
call_metadata = @config.rpcs.get_storage_layout.metadata.to_h
|
|
930
|
+
|
|
931
|
+
# Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
|
|
932
|
+
call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
|
|
933
|
+
lib_name: @config.lib_name, lib_version: @config.lib_version,
|
|
934
|
+
gapic_version: ::Google::Cloud::Storage::Control::V2::VERSION,
|
|
935
|
+
transports_version_send: [:rest]
|
|
936
|
+
|
|
937
|
+
call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
|
|
938
|
+
call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
|
939
|
+
|
|
940
|
+
options.apply_defaults timeout: @config.rpcs.get_storage_layout.timeout,
|
|
941
|
+
metadata: call_metadata,
|
|
942
|
+
retry_policy: @config.rpcs.get_storage_layout.retry_policy
|
|
943
|
+
|
|
944
|
+
options.apply_defaults timeout: @config.timeout,
|
|
945
|
+
metadata: @config.metadata,
|
|
946
|
+
retry_policy: @config.retry_policy
|
|
947
|
+
|
|
948
|
+
@storage_control_stub.get_storage_layout request, options do |result, operation|
|
|
949
|
+
yield result, operation if block_given?
|
|
950
|
+
end
|
|
951
|
+
rescue ::Gapic::Rest::Error => e
|
|
952
|
+
raise ::Google::Cloud::Error.from_error(e)
|
|
953
|
+
end
|
|
954
|
+
|
|
237
955
|
##
|
|
238
956
|
# Returns the Project scoped singleton IntelligenceConfig resource.
|
|
239
957
|
#
|
|
@@ -814,7 +1532,7 @@ module Google
|
|
|
814
1532
|
end
|
|
815
1533
|
|
|
816
1534
|
##
|
|
817
|
-
# Lists the `IntelligenceFinding` resources for the specified project.
|
|
1535
|
+
# Lists the `IntelligenceFinding` resources for the specified the project.
|
|
818
1536
|
#
|
|
819
1537
|
# @overload list_intelligence_findings(request, options = nil)
|
|
820
1538
|
# Pass arguments to `list_intelligence_findings` via a request object, either of type
|
|
@@ -915,8 +1633,8 @@ module Google
|
|
|
915
1633
|
end
|
|
916
1634
|
|
|
917
1635
|
##
|
|
918
|
-
#
|
|
919
|
-
# project).
|
|
1636
|
+
# Summarizes the intelligence findings for the specified scope (organization,
|
|
1637
|
+
# folder or project).
|
|
920
1638
|
#
|
|
921
1639
|
# @overload summarize_intelligence_findings(request, options = nil)
|
|
922
1640
|
# Pass arguments to `summarize_intelligence_findings` via a request object, either of type
|
|
@@ -1225,17 +1943,17 @@ module Google
|
|
|
1225
1943
|
# @example
|
|
1226
1944
|
#
|
|
1227
1945
|
# # Modify the global config, setting the timeout for
|
|
1228
|
-
# #
|
|
1946
|
+
# # create_folder to 20 seconds,
|
|
1229
1947
|
# # and all remaining timeouts to 10 seconds.
|
|
1230
1948
|
# ::Google::Cloud::Storage::Control::V2::StorageControl::Rest::Client.configure do |config|
|
|
1231
1949
|
# config.timeout = 10.0
|
|
1232
|
-
# config.rpcs.
|
|
1950
|
+
# config.rpcs.create_folder.timeout = 20.0
|
|
1233
1951
|
# end
|
|
1234
1952
|
#
|
|
1235
1953
|
# # Apply the above configuration only to a new client.
|
|
1236
1954
|
# client = ::Google::Cloud::Storage::Control::V2::StorageControl::Rest::Client.new do |config|
|
|
1237
1955
|
# config.timeout = 10.0
|
|
1238
|
-
# config.rpcs.
|
|
1956
|
+
# config.rpcs.create_folder.timeout = 20.0
|
|
1239
1957
|
# end
|
|
1240
1958
|
#
|
|
1241
1959
|
# @!attribute [rw] endpoint
|
|
@@ -1357,6 +2075,41 @@ module Google
|
|
|
1357
2075
|
# trigger a retry.
|
|
1358
2076
|
#
|
|
1359
2077
|
class Rpcs
|
|
2078
|
+
##
|
|
2079
|
+
# RPC-specific configuration for `create_folder`
|
|
2080
|
+
# @return [::Gapic::Config::Method]
|
|
2081
|
+
#
|
|
2082
|
+
attr_reader :create_folder
|
|
2083
|
+
##
|
|
2084
|
+
# RPC-specific configuration for `delete_folder`
|
|
2085
|
+
# @return [::Gapic::Config::Method]
|
|
2086
|
+
#
|
|
2087
|
+
attr_reader :delete_folder
|
|
2088
|
+
##
|
|
2089
|
+
# RPC-specific configuration for `get_folder`
|
|
2090
|
+
# @return [::Gapic::Config::Method]
|
|
2091
|
+
#
|
|
2092
|
+
attr_reader :get_folder
|
|
2093
|
+
##
|
|
2094
|
+
# RPC-specific configuration for `list_folders`
|
|
2095
|
+
# @return [::Gapic::Config::Method]
|
|
2096
|
+
#
|
|
2097
|
+
attr_reader :list_folders
|
|
2098
|
+
##
|
|
2099
|
+
# RPC-specific configuration for `rename_folder`
|
|
2100
|
+
# @return [::Gapic::Config::Method]
|
|
2101
|
+
#
|
|
2102
|
+
attr_reader :rename_folder
|
|
2103
|
+
##
|
|
2104
|
+
# RPC-specific configuration for `delete_folder_recursive`
|
|
2105
|
+
# @return [::Gapic::Config::Method]
|
|
2106
|
+
#
|
|
2107
|
+
attr_reader :delete_folder_recursive
|
|
2108
|
+
##
|
|
2109
|
+
# RPC-specific configuration for `get_storage_layout`
|
|
2110
|
+
# @return [::Gapic::Config::Method]
|
|
2111
|
+
#
|
|
2112
|
+
attr_reader :get_storage_layout
|
|
1360
2113
|
##
|
|
1361
2114
|
# RPC-specific configuration for `get_project_intelligence_config`
|
|
1362
2115
|
# @return [::Gapic::Config::Method]
|
|
@@ -1415,6 +2168,20 @@ module Google
|
|
|
1415
2168
|
|
|
1416
2169
|
# @private
|
|
1417
2170
|
def initialize parent_rpcs = nil
|
|
2171
|
+
create_folder_config = parent_rpcs.create_folder if parent_rpcs.respond_to? :create_folder
|
|
2172
|
+
@create_folder = ::Gapic::Config::Method.new create_folder_config
|
|
2173
|
+
delete_folder_config = parent_rpcs.delete_folder if parent_rpcs.respond_to? :delete_folder
|
|
2174
|
+
@delete_folder = ::Gapic::Config::Method.new delete_folder_config
|
|
2175
|
+
get_folder_config = parent_rpcs.get_folder if parent_rpcs.respond_to? :get_folder
|
|
2176
|
+
@get_folder = ::Gapic::Config::Method.new get_folder_config
|
|
2177
|
+
list_folders_config = parent_rpcs.list_folders if parent_rpcs.respond_to? :list_folders
|
|
2178
|
+
@list_folders = ::Gapic::Config::Method.new list_folders_config
|
|
2179
|
+
rename_folder_config = parent_rpcs.rename_folder if parent_rpcs.respond_to? :rename_folder
|
|
2180
|
+
@rename_folder = ::Gapic::Config::Method.new rename_folder_config
|
|
2181
|
+
delete_folder_recursive_config = parent_rpcs.delete_folder_recursive if parent_rpcs.respond_to? :delete_folder_recursive
|
|
2182
|
+
@delete_folder_recursive = ::Gapic::Config::Method.new delete_folder_recursive_config
|
|
2183
|
+
get_storage_layout_config = parent_rpcs.get_storage_layout if parent_rpcs.respond_to? :get_storage_layout
|
|
2184
|
+
@get_storage_layout = ::Gapic::Config::Method.new get_storage_layout_config
|
|
1418
2185
|
get_project_intelligence_config_config = parent_rpcs.get_project_intelligence_config if parent_rpcs.respond_to? :get_project_intelligence_config
|
|
1419
2186
|
@get_project_intelligence_config = ::Gapic::Config::Method.new get_project_intelligence_config_config
|
|
1420
2187
|
update_project_intelligence_config_config = parent_rpcs.update_project_intelligence_config if parent_rpcs.respond_to? :update_project_intelligence_config
|