google-apis-storagebatchoperations_v1 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.
@@ -0,0 +1,474 @@
1
+ # Copyright 2020 Google LLC
2
+ #
3
+ # Licensed under the Apache License, Version 2.0 (the "License");
4
+ # you may not use this file except in compliance with the License.
5
+ # You may obtain a copy of the License at
6
+ #
7
+ # http://www.apache.org/licenses/LICENSE-2.0
8
+ #
9
+ # Unless required by applicable law or agreed to in writing, software
10
+ # distributed under the License is distributed on an "AS IS" BASIS,
11
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12
+ # See the License for the specific language governing permissions and
13
+ # limitations under the License.
14
+
15
+ require 'google/apis/core/base_service'
16
+ require 'google/apis/core/json_representation'
17
+ require 'google/apis/core/hashable'
18
+ require 'google/apis/errors'
19
+
20
+ module Google
21
+ module Apis
22
+ module StoragebatchoperationsV1
23
+ # Storage Batch Operations API
24
+ #
25
+ #
26
+ #
27
+ # @example
28
+ # require 'google/apis/storagebatchoperations_v1'
29
+ #
30
+ # Storagebatchoperations = Google::Apis::StoragebatchoperationsV1 # Alias the module
31
+ # service = Storagebatchoperations::StorageBatchOperationsService.new
32
+ #
33
+ # @see https://cloud.google.com/storage/docs/metadata
34
+ class StorageBatchOperationsService < Google::Apis::Core::BaseService
35
+ DEFAULT_ENDPOINT_TEMPLATE = "https://storagebatchoperations.$UNIVERSE_DOMAIN$/"
36
+
37
+ # @return [String]
38
+ # API key. Your API key identifies your project and provides you with API access,
39
+ # quota, and reports. Required unless you provide an OAuth 2.0 token.
40
+ attr_accessor :key
41
+
42
+ # @return [String]
43
+ # Available to use for quota purposes for server-side applications. Can be any
44
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
45
+ attr_accessor :quota_user
46
+
47
+ def initialize
48
+ super(DEFAULT_ENDPOINT_TEMPLATE, '',
49
+ client_name: 'google-apis-storagebatchoperations_v1',
50
+ client_version: Google::Apis::StoragebatchoperationsV1::GEM_VERSION)
51
+ @batch_path = 'batch'
52
+ end
53
+
54
+ # Gets information about a location.
55
+ # @param [String] name
56
+ # Resource name for the location.
57
+ # @param [String] fields
58
+ # Selector specifying which fields to include in a partial response.
59
+ # @param [String] quota_user
60
+ # Available to use for quota purposes for server-side applications. Can be any
61
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
62
+ # @param [Google::Apis::RequestOptions] options
63
+ # Request-specific options
64
+ #
65
+ # @yield [result, err] Result & error if block supplied
66
+ # @yieldparam result [Google::Apis::StoragebatchoperationsV1::Location] parsed result object
67
+ # @yieldparam err [StandardError] error object if request failed
68
+ #
69
+ # @return [Google::Apis::StoragebatchoperationsV1::Location]
70
+ #
71
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
72
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
73
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
74
+ def get_project_location(name, fields: nil, quota_user: nil, options: nil, &block)
75
+ command = make_simple_command(:get, 'v1/{+name}', options)
76
+ command.response_representation = Google::Apis::StoragebatchoperationsV1::Location::Representation
77
+ command.response_class = Google::Apis::StoragebatchoperationsV1::Location
78
+ command.params['name'] = name unless name.nil?
79
+ command.query['fields'] = fields unless fields.nil?
80
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
81
+ execute_or_queue_command(command, &block)
82
+ end
83
+
84
+ # Lists information about the supported locations for this service.
85
+ # @param [String] name
86
+ # The resource that owns the locations collection, if applicable.
87
+ # @param [Array<String>, String] extra_location_types
88
+ # Optional. A list of extra location types that should be used as conditions for
89
+ # controlling the visibility of the locations.
90
+ # @param [String] filter
91
+ # A filter to narrow down results to a preferred subset. The filtering language
92
+ # accepts strings like `"displayName=tokyo"`, and is documented in more detail
93
+ # in [AIP-160](https://google.aip.dev/160).
94
+ # @param [Fixnum] page_size
95
+ # The maximum number of results to return. If not set, the service selects a
96
+ # default.
97
+ # @param [String] page_token
98
+ # A page token received from the `next_page_token` field in the response. Send
99
+ # that page token to receive the subsequent page.
100
+ # @param [String] fields
101
+ # Selector specifying which fields to include in a partial response.
102
+ # @param [String] quota_user
103
+ # Available to use for quota purposes for server-side applications. Can be any
104
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
105
+ # @param [Google::Apis::RequestOptions] options
106
+ # Request-specific options
107
+ #
108
+ # @yield [result, err] Result & error if block supplied
109
+ # @yieldparam result [Google::Apis::StoragebatchoperationsV1::ListLocationsResponse] parsed result object
110
+ # @yieldparam err [StandardError] error object if request failed
111
+ #
112
+ # @return [Google::Apis::StoragebatchoperationsV1::ListLocationsResponse]
113
+ #
114
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
115
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
116
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
117
+ def list_project_locations(name, extra_location_types: nil, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
118
+ command = make_simple_command(:get, 'v1/{+name}/locations', options)
119
+ command.response_representation = Google::Apis::StoragebatchoperationsV1::ListLocationsResponse::Representation
120
+ command.response_class = Google::Apis::StoragebatchoperationsV1::ListLocationsResponse
121
+ command.params['name'] = name unless name.nil?
122
+ command.query['extraLocationTypes'] = extra_location_types unless extra_location_types.nil?
123
+ command.query['filter'] = filter unless filter.nil?
124
+ command.query['pageSize'] = page_size unless page_size.nil?
125
+ command.query['pageToken'] = page_token unless page_token.nil?
126
+ command.query['fields'] = fields unless fields.nil?
127
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
128
+ execute_or_queue_command(command, &block)
129
+ end
130
+
131
+ # Cancels a batch job.
132
+ # @param [String] name
133
+ # Required. The `name` of the job to cancel. Format: projects/`project_id`/
134
+ # locations/global/jobs/`job_id`.
135
+ # @param [Google::Apis::StoragebatchoperationsV1::CancelJobRequest] cancel_job_request_object
136
+ # @param [String] fields
137
+ # Selector specifying which fields to include in a partial response.
138
+ # @param [String] quota_user
139
+ # Available to use for quota purposes for server-side applications. Can be any
140
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
141
+ # @param [Google::Apis::RequestOptions] options
142
+ # Request-specific options
143
+ #
144
+ # @yield [result, err] Result & error if block supplied
145
+ # @yieldparam result [Google::Apis::StoragebatchoperationsV1::CancelJobResponse] parsed result object
146
+ # @yieldparam err [StandardError] error object if request failed
147
+ #
148
+ # @return [Google::Apis::StoragebatchoperationsV1::CancelJobResponse]
149
+ #
150
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
151
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
152
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
153
+ def cancel_job(name, cancel_job_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
154
+ command = make_simple_command(:post, 'v1/{+name}:cancel', options)
155
+ command.request_representation = Google::Apis::StoragebatchoperationsV1::CancelJobRequest::Representation
156
+ command.request_object = cancel_job_request_object
157
+ command.response_representation = Google::Apis::StoragebatchoperationsV1::CancelJobResponse::Representation
158
+ command.response_class = Google::Apis::StoragebatchoperationsV1::CancelJobResponse
159
+ command.params['name'] = name unless name.nil?
160
+ command.query['fields'] = fields unless fields.nil?
161
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
162
+ execute_or_queue_command(command, &block)
163
+ end
164
+
165
+ # Creates a batch job.
166
+ # @param [String] parent
167
+ # Required. Value for parent.
168
+ # @param [Google::Apis::StoragebatchoperationsV1::Job] job_object
169
+ # @param [String] job_id
170
+ # Required. The optional `job_id` for this Job . If not specified, an id is
171
+ # generated. `job_id` should be no more than 128 characters and must include
172
+ # only characters available in DNS names, as defined by RFC-1123.
173
+ # @param [String] request_id
174
+ # Optional. An optional request ID to identify requests. Specify a unique
175
+ # request ID in case you need to retry your request. Requests with same `
176
+ # request_id` will ignored for at least 60 minutes since the first request. The
177
+ # request ID must be a valid UUID with the exception that zero UUID is not
178
+ # supported (00000000-0000-0000-0000-000000000000).
179
+ # @param [String] fields
180
+ # Selector specifying which fields to include in a partial response.
181
+ # @param [String] quota_user
182
+ # Available to use for quota purposes for server-side applications. Can be any
183
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
184
+ # @param [Google::Apis::RequestOptions] options
185
+ # Request-specific options
186
+ #
187
+ # @yield [result, err] Result & error if block supplied
188
+ # @yieldparam result [Google::Apis::StoragebatchoperationsV1::Operation] parsed result object
189
+ # @yieldparam err [StandardError] error object if request failed
190
+ #
191
+ # @return [Google::Apis::StoragebatchoperationsV1::Operation]
192
+ #
193
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
194
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
195
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
196
+ def create_project_location_job(parent, job_object = nil, job_id: nil, request_id: nil, fields: nil, quota_user: nil, options: nil, &block)
197
+ command = make_simple_command(:post, 'v1/{+parent}/jobs', options)
198
+ command.request_representation = Google::Apis::StoragebatchoperationsV1::Job::Representation
199
+ command.request_object = job_object
200
+ command.response_representation = Google::Apis::StoragebatchoperationsV1::Operation::Representation
201
+ command.response_class = Google::Apis::StoragebatchoperationsV1::Operation
202
+ command.params['parent'] = parent unless parent.nil?
203
+ command.query['jobId'] = job_id unless job_id.nil?
204
+ command.query['requestId'] = request_id unless request_id.nil?
205
+ command.query['fields'] = fields unless fields.nil?
206
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
207
+ execute_or_queue_command(command, &block)
208
+ end
209
+
210
+ # Deletes a batch job.
211
+ # @param [String] name
212
+ # Required. The `name` of the job to delete. Format: projects/`project_id`/
213
+ # locations/global/jobs/`job_id` .
214
+ # @param [String] request_id
215
+ # Optional. An optional request ID to identify requests. Specify a unique
216
+ # request ID in case you need to retry your request. Requests with same `
217
+ # request_id` will ignored for at least 60 minutes since the first request. The
218
+ # request ID must be a valid UUID with the exception that zero UUID is not
219
+ # supported (00000000-0000-0000-0000-000000000000).
220
+ # @param [String] fields
221
+ # Selector specifying which fields to include in a partial response.
222
+ # @param [String] quota_user
223
+ # Available to use for quota purposes for server-side applications. Can be any
224
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
225
+ # @param [Google::Apis::RequestOptions] options
226
+ # Request-specific options
227
+ #
228
+ # @yield [result, err] Result & error if block supplied
229
+ # @yieldparam result [Google::Apis::StoragebatchoperationsV1::Empty] parsed result object
230
+ # @yieldparam err [StandardError] error object if request failed
231
+ #
232
+ # @return [Google::Apis::StoragebatchoperationsV1::Empty]
233
+ #
234
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
235
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
236
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
237
+ def delete_project_location_job(name, request_id: nil, fields: nil, quota_user: nil, options: nil, &block)
238
+ command = make_simple_command(:delete, 'v1/{+name}', options)
239
+ command.response_representation = Google::Apis::StoragebatchoperationsV1::Empty::Representation
240
+ command.response_class = Google::Apis::StoragebatchoperationsV1::Empty
241
+ command.params['name'] = name unless name.nil?
242
+ command.query['requestId'] = request_id unless request_id.nil?
243
+ command.query['fields'] = fields unless fields.nil?
244
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
245
+ execute_or_queue_command(command, &block)
246
+ end
247
+
248
+ # Gets a batch job.
249
+ # @param [String] name
250
+ # Required. `name` of the job to retrieve. Format: projects/`project_id`/
251
+ # locations/global/jobs/`job_id` .
252
+ # @param [String] fields
253
+ # Selector specifying which fields to include in a partial response.
254
+ # @param [String] quota_user
255
+ # Available to use for quota purposes for server-side applications. Can be any
256
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
257
+ # @param [Google::Apis::RequestOptions] options
258
+ # Request-specific options
259
+ #
260
+ # @yield [result, err] Result & error if block supplied
261
+ # @yieldparam result [Google::Apis::StoragebatchoperationsV1::Job] parsed result object
262
+ # @yieldparam err [StandardError] error object if request failed
263
+ #
264
+ # @return [Google::Apis::StoragebatchoperationsV1::Job]
265
+ #
266
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
267
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
268
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
269
+ def get_project_location_job(name, fields: nil, quota_user: nil, options: nil, &block)
270
+ command = make_simple_command(:get, 'v1/{+name}', options)
271
+ command.response_representation = Google::Apis::StoragebatchoperationsV1::Job::Representation
272
+ command.response_class = Google::Apis::StoragebatchoperationsV1::Job
273
+ command.params['name'] = name unless name.nil?
274
+ command.query['fields'] = fields unless fields.nil?
275
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
276
+ execute_or_queue_command(command, &block)
277
+ end
278
+
279
+ # Lists Jobs in a given project.
280
+ # @param [String] parent
281
+ # Required. Format: projects/`project_id`/locations/global.
282
+ # @param [String] filter
283
+ # Optional. Filters results as defined by https://google.aip.dev/160.
284
+ # @param [String] order_by
285
+ # Optional. Field to sort by. Supported fields are name, create_time.
286
+ # @param [Fixnum] page_size
287
+ # Optional. The list page size. default page size is 100.
288
+ # @param [String] page_token
289
+ # Optional. The list page token.
290
+ # @param [String] fields
291
+ # Selector specifying which fields to include in a partial response.
292
+ # @param [String] quota_user
293
+ # Available to use for quota purposes for server-side applications. Can be any
294
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
295
+ # @param [Google::Apis::RequestOptions] options
296
+ # Request-specific options
297
+ #
298
+ # @yield [result, err] Result & error if block supplied
299
+ # @yieldparam result [Google::Apis::StoragebatchoperationsV1::ListJobsResponse] parsed result object
300
+ # @yieldparam err [StandardError] error object if request failed
301
+ #
302
+ # @return [Google::Apis::StoragebatchoperationsV1::ListJobsResponse]
303
+ #
304
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
305
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
306
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
307
+ def list_project_location_jobs(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
308
+ command = make_simple_command(:get, 'v1/{+parent}/jobs', options)
309
+ command.response_representation = Google::Apis::StoragebatchoperationsV1::ListJobsResponse::Representation
310
+ command.response_class = Google::Apis::StoragebatchoperationsV1::ListJobsResponse
311
+ command.params['parent'] = parent unless parent.nil?
312
+ command.query['filter'] = filter unless filter.nil?
313
+ command.query['orderBy'] = order_by unless order_by.nil?
314
+ command.query['pageSize'] = page_size unless page_size.nil?
315
+ command.query['pageToken'] = page_token unless page_token.nil?
316
+ command.query['fields'] = fields unless fields.nil?
317
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
318
+ execute_or_queue_command(command, &block)
319
+ end
320
+
321
+ # Starts asynchronous cancellation on a long-running operation. The server makes
322
+ # a best effort to cancel the operation, but success is not guaranteed. If the
323
+ # server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.
324
+ # Clients can use Operations.GetOperation or other methods to check whether the
325
+ # cancellation succeeded or whether the operation completed despite cancellation.
326
+ # On successful cancellation, the operation is not deleted; instead, it becomes
327
+ # an operation with an Operation.error value with a google.rpc.Status.code of `1`
328
+ # , corresponding to `Code.CANCELLED`.
329
+ # @param [String] name
330
+ # The name of the operation resource to be cancelled.
331
+ # @param [Google::Apis::StoragebatchoperationsV1::CancelOperationRequest] cancel_operation_request_object
332
+ # @param [String] fields
333
+ # Selector specifying which fields to include in a partial response.
334
+ # @param [String] quota_user
335
+ # Available to use for quota purposes for server-side applications. Can be any
336
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
337
+ # @param [Google::Apis::RequestOptions] options
338
+ # Request-specific options
339
+ #
340
+ # @yield [result, err] Result & error if block supplied
341
+ # @yieldparam result [Google::Apis::StoragebatchoperationsV1::Empty] parsed result object
342
+ # @yieldparam err [StandardError] error object if request failed
343
+ #
344
+ # @return [Google::Apis::StoragebatchoperationsV1::Empty]
345
+ #
346
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
347
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
348
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
349
+ def cancel_operation(name, cancel_operation_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
350
+ command = make_simple_command(:post, 'v1/{+name}:cancel', options)
351
+ command.request_representation = Google::Apis::StoragebatchoperationsV1::CancelOperationRequest::Representation
352
+ command.request_object = cancel_operation_request_object
353
+ command.response_representation = Google::Apis::StoragebatchoperationsV1::Empty::Representation
354
+ command.response_class = Google::Apis::StoragebatchoperationsV1::Empty
355
+ command.params['name'] = name unless name.nil?
356
+ command.query['fields'] = fields unless fields.nil?
357
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
358
+ execute_or_queue_command(command, &block)
359
+ end
360
+
361
+ # Deletes a long-running operation. This method indicates that the client is no
362
+ # longer interested in the operation result. It does not cancel the operation.
363
+ # If the server doesn't support this method, it returns `google.rpc.Code.
364
+ # UNIMPLEMENTED`.
365
+ # @param [String] name
366
+ # The name of the operation resource to be deleted.
367
+ # @param [String] fields
368
+ # Selector specifying which fields to include in a partial response.
369
+ # @param [String] quota_user
370
+ # Available to use for quota purposes for server-side applications. Can be any
371
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
372
+ # @param [Google::Apis::RequestOptions] options
373
+ # Request-specific options
374
+ #
375
+ # @yield [result, err] Result & error if block supplied
376
+ # @yieldparam result [Google::Apis::StoragebatchoperationsV1::Empty] parsed result object
377
+ # @yieldparam err [StandardError] error object if request failed
378
+ #
379
+ # @return [Google::Apis::StoragebatchoperationsV1::Empty]
380
+ #
381
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
382
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
383
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
384
+ def delete_project_location_operation(name, fields: nil, quota_user: nil, options: nil, &block)
385
+ command = make_simple_command(:delete, 'v1/{+name}', options)
386
+ command.response_representation = Google::Apis::StoragebatchoperationsV1::Empty::Representation
387
+ command.response_class = Google::Apis::StoragebatchoperationsV1::Empty
388
+ command.params['name'] = name unless name.nil?
389
+ command.query['fields'] = fields unless fields.nil?
390
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
391
+ execute_or_queue_command(command, &block)
392
+ end
393
+
394
+ # Gets the latest state of a long-running operation. Clients can use this method
395
+ # to poll the operation result at intervals as recommended by the API service.
396
+ # @param [String] name
397
+ # The name of the operation resource.
398
+ # @param [String] fields
399
+ # Selector specifying which fields to include in a partial response.
400
+ # @param [String] quota_user
401
+ # Available to use for quota purposes for server-side applications. Can be any
402
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
403
+ # @param [Google::Apis::RequestOptions] options
404
+ # Request-specific options
405
+ #
406
+ # @yield [result, err] Result & error if block supplied
407
+ # @yieldparam result [Google::Apis::StoragebatchoperationsV1::Operation] parsed result object
408
+ # @yieldparam err [StandardError] error object if request failed
409
+ #
410
+ # @return [Google::Apis::StoragebatchoperationsV1::Operation]
411
+ #
412
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
413
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
414
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
415
+ def get_project_location_operation(name, fields: nil, quota_user: nil, options: nil, &block)
416
+ command = make_simple_command(:get, 'v1/{+name}', options)
417
+ command.response_representation = Google::Apis::StoragebatchoperationsV1::Operation::Representation
418
+ command.response_class = Google::Apis::StoragebatchoperationsV1::Operation
419
+ command.params['name'] = name unless name.nil?
420
+ command.query['fields'] = fields unless fields.nil?
421
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
422
+ execute_or_queue_command(command, &block)
423
+ end
424
+
425
+ # Lists operations that match the specified filter in the request. If the server
426
+ # doesn't support this method, it returns `UNIMPLEMENTED`.
427
+ # @param [String] name
428
+ # The name of the operation's parent resource.
429
+ # @param [String] filter
430
+ # The standard list filter.
431
+ # @param [Fixnum] page_size
432
+ # The standard list page size.
433
+ # @param [String] page_token
434
+ # The standard list page token.
435
+ # @param [String] fields
436
+ # Selector specifying which fields to include in a partial response.
437
+ # @param [String] quota_user
438
+ # Available to use for quota purposes for server-side applications. Can be any
439
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
440
+ # @param [Google::Apis::RequestOptions] options
441
+ # Request-specific options
442
+ #
443
+ # @yield [result, err] Result & error if block supplied
444
+ # @yieldparam result [Google::Apis::StoragebatchoperationsV1::ListOperationsResponse] parsed result object
445
+ # @yieldparam err [StandardError] error object if request failed
446
+ #
447
+ # @return [Google::Apis::StoragebatchoperationsV1::ListOperationsResponse]
448
+ #
449
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
450
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
451
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
452
+ def list_project_location_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
453
+ command = make_simple_command(:get, 'v1/{+name}/operations', options)
454
+ command.response_representation = Google::Apis::StoragebatchoperationsV1::ListOperationsResponse::Representation
455
+ command.response_class = Google::Apis::StoragebatchoperationsV1::ListOperationsResponse
456
+ command.params['name'] = name unless name.nil?
457
+ command.query['filter'] = filter unless filter.nil?
458
+ command.query['pageSize'] = page_size unless page_size.nil?
459
+ command.query['pageToken'] = page_token unless page_token.nil?
460
+ command.query['fields'] = fields unless fields.nil?
461
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
462
+ execute_or_queue_command(command, &block)
463
+ end
464
+
465
+ protected
466
+
467
+ def apply_command_defaults(command)
468
+ command.query['key'] = key unless key.nil?
469
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
470
+ end
471
+ end
472
+ end
473
+ end
474
+ end
@@ -0,0 +1,36 @@
1
+ # Copyright 2020 Google LLC
2
+ #
3
+ # Licensed under the Apache License, Version 2.0 (the "License");
4
+ # you may not use this file except in compliance with the License.
5
+ # You may obtain a copy of the License at
6
+ #
7
+ # http://www.apache.org/licenses/LICENSE-2.0
8
+ #
9
+ # Unless required by applicable law or agreed to in writing, software
10
+ # distributed under the License is distributed on an "AS IS" BASIS,
11
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12
+ # See the License for the specific language governing permissions and
13
+ # limitations under the License.
14
+
15
+ require 'google/apis/storagebatchoperations_v1/service.rb'
16
+ require 'google/apis/storagebatchoperations_v1/classes.rb'
17
+ require 'google/apis/storagebatchoperations_v1/representations.rb'
18
+ require 'google/apis/storagebatchoperations_v1/gem_version.rb'
19
+
20
+ module Google
21
+ module Apis
22
+ # Storage Batch Operations API
23
+ #
24
+ #
25
+ #
26
+ # @see https://cloud.google.com/storage/docs/metadata
27
+ module StoragebatchoperationsV1
28
+ # Version of the Storage Batch Operations API this client connects to.
29
+ # This is NOT the gem version.
30
+ VERSION = 'V1'
31
+
32
+ # See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account.
33
+ AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform'
34
+ end
35
+ end
36
+ end
@@ -0,0 +1,15 @@
1
+ # Copyright 2020 Google LLC
2
+ #
3
+ # Licensed under the Apache License, Version 2.0 (the "License");
4
+ # you may not use this file except in compliance with the License.
5
+ # You may obtain a copy of the License at
6
+ #
7
+ # http://www.apache.org/licenses/LICENSE-2.0
8
+ #
9
+ # Unless required by applicable law or agreed to in writing, software
10
+ # distributed under the License is distributed on an "AS IS" BASIS,
11
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12
+ # See the License for the specific language governing permissions and
13
+ # limitations under the License.
14
+
15
+ require "google/apis/storagebatchoperations_v1"
metadata ADDED
@@ -0,0 +1,79 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: google-apis-storagebatchoperations_v1
3
+ version: !ruby/object:Gem::Version
4
+ version: 0.1.0
5
+ platform: ruby
6
+ authors:
7
+ - Google LLC
8
+ bindir: bin
9
+ cert_chain: []
10
+ date: 2025-04-16 00:00:00.000000000 Z
11
+ dependencies:
12
+ - !ruby/object:Gem::Dependency
13
+ name: google-apis-core
14
+ requirement: !ruby/object:Gem::Requirement
15
+ requirements:
16
+ - - ">="
17
+ - !ruby/object:Gem::Version
18
+ version: 0.15.0
19
+ - - "<"
20
+ - !ruby/object:Gem::Version
21
+ version: 2.a
22
+ type: :runtime
23
+ prerelease: false
24
+ version_requirements: !ruby/object:Gem::Requirement
25
+ requirements:
26
+ - - ">="
27
+ - !ruby/object:Gem::Version
28
+ version: 0.15.0
29
+ - - "<"
30
+ - !ruby/object:Gem::Version
31
+ version: 2.a
32
+ description: This is the simple REST client for Storage Batch Operations API V1. Simple
33
+ REST clients are Ruby client libraries that provide access to Google services via
34
+ their HTTP REST API endpoints. These libraries are generated and updated automatically
35
+ based on the discovery documents published by the service, and they handle most
36
+ concerns such as authentication, pagination, retry, timeouts, and logging. You can
37
+ use this client to access the Storage Batch Operations API, but note that some services
38
+ may provide a separate modern client that is easier to use.
39
+ email: googleapis-packages@google.com
40
+ executables: []
41
+ extensions: []
42
+ extra_rdoc_files: []
43
+ files:
44
+ - ".yardopts"
45
+ - CHANGELOG.md
46
+ - LICENSE.md
47
+ - OVERVIEW.md
48
+ - lib/google-apis-storagebatchoperations_v1.rb
49
+ - lib/google/apis/storagebatchoperations_v1.rb
50
+ - lib/google/apis/storagebatchoperations_v1/classes.rb
51
+ - lib/google/apis/storagebatchoperations_v1/gem_version.rb
52
+ - lib/google/apis/storagebatchoperations_v1/representations.rb
53
+ - lib/google/apis/storagebatchoperations_v1/service.rb
54
+ homepage: https://github.com/google/google-api-ruby-client
55
+ licenses:
56
+ - Apache-2.0
57
+ metadata:
58
+ bug_tracker_uri: https://github.com/googleapis/google-api-ruby-client/issues
59
+ changelog_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-storagebatchoperations_v1/CHANGELOG.md
60
+ documentation_uri: https://googleapis.dev/ruby/google-apis-storagebatchoperations_v1/v0.1.0
61
+ source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-storagebatchoperations_v1
62
+ rdoc_options: []
63
+ require_paths:
64
+ - lib
65
+ required_ruby_version: !ruby/object:Gem::Requirement
66
+ requirements:
67
+ - - ">="
68
+ - !ruby/object:Gem::Version
69
+ version: '2.7'
70
+ required_rubygems_version: !ruby/object:Gem::Requirement
71
+ requirements:
72
+ - - ">="
73
+ - !ruby/object:Gem::Version
74
+ version: '0'
75
+ requirements: []
76
+ rubygems_version: 3.6.5
77
+ specification_version: 4
78
+ summary: Simple REST client for Storage Batch Operations API V1
79
+ test_files: []