google-apis-parallelstore_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,569 @@
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 ParallelstoreV1
23
+ # Parallelstore API
24
+ #
25
+ #
26
+ #
27
+ # @example
28
+ # require 'google/apis/parallelstore_v1'
29
+ #
30
+ # Parallelstore = Google::Apis::ParallelstoreV1 # Alias the module
31
+ # service = Parallelstore::ParallelstoreService.new
32
+ #
33
+ # @see https://cloud.google.com/
34
+ class ParallelstoreService < Google::Apis::Core::BaseService
35
+ DEFAULT_ENDPOINT_TEMPLATE = "https://parallelstore.$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-parallelstore_v1',
50
+ client_version: Google::Apis::ParallelstoreV1::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::ParallelstoreV1::Location] parsed result object
67
+ # @yieldparam err [StandardError] error object if request failed
68
+ #
69
+ # @return [Google::Apis::ParallelstoreV1::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::ParallelstoreV1::Location::Representation
77
+ command.response_class = Google::Apis::ParallelstoreV1::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 [String] filter
88
+ # A filter to narrow down results to a preferred subset. The filtering language
89
+ # accepts strings like `"displayName=tokyo"`, and is documented in more detail
90
+ # in [AIP-160](https://google.aip.dev/160).
91
+ # @param [Fixnum] page_size
92
+ # The maximum number of results to return. If not set, the service selects a
93
+ # default.
94
+ # @param [String] page_token
95
+ # A page token received from the `next_page_token` field in the response. Send
96
+ # that page token to receive the subsequent page.
97
+ # @param [String] fields
98
+ # Selector specifying which fields to include in a partial response.
99
+ # @param [String] quota_user
100
+ # Available to use for quota purposes for server-side applications. Can be any
101
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
102
+ # @param [Google::Apis::RequestOptions] options
103
+ # Request-specific options
104
+ #
105
+ # @yield [result, err] Result & error if block supplied
106
+ # @yieldparam result [Google::Apis::ParallelstoreV1::ListLocationsResponse] parsed result object
107
+ # @yieldparam err [StandardError] error object if request failed
108
+ #
109
+ # @return [Google::Apis::ParallelstoreV1::ListLocationsResponse]
110
+ #
111
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
112
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
113
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
114
+ def list_project_locations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
115
+ command = make_simple_command(:get, 'v1/{+name}/locations', options)
116
+ command.response_representation = Google::Apis::ParallelstoreV1::ListLocationsResponse::Representation
117
+ command.response_class = Google::Apis::ParallelstoreV1::ListLocationsResponse
118
+ command.params['name'] = name unless name.nil?
119
+ command.query['filter'] = filter unless filter.nil?
120
+ command.query['pageSize'] = page_size unless page_size.nil?
121
+ command.query['pageToken'] = page_token unless page_token.nil?
122
+ command.query['fields'] = fields unless fields.nil?
123
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
124
+ execute_or_queue_command(command, &block)
125
+ end
126
+
127
+ # Creates a Parallelstore instance in a given project and location.
128
+ # @param [String] parent
129
+ # Required. The instance's project and location, in the format `projects/`
130
+ # project`/locations/`location``. Locations map to Google Cloud zones; for
131
+ # example, `us-west1-b`.
132
+ # @param [Google::Apis::ParallelstoreV1::Instance] instance_object
133
+ # @param [String] instance_id
134
+ # Required. The name of the Parallelstore instance. * Must contain only
135
+ # lowercase letters, numbers, and hyphens. * Must start with a letter. * Must be
136
+ # between 1-63 characters. * Must end with a number or a letter. * Must be
137
+ # unique within the customer project / location
138
+ # @param [String] request_id
139
+ # Optional. An optional request ID to identify requests. Specify a unique
140
+ # request ID so that if you must retry your request, the server will know to
141
+ # ignore the request if it has already been completed. The server will guarantee
142
+ # that for at least 60 minutes since the first request. For example, consider a
143
+ # situation where you make an initial request and t he request times out. If you
144
+ # make the request again with the same request ID, the server can check if
145
+ # original operation with the same request ID was received, and if so, will
146
+ # ignore the second request. This prevents clients from accidentally creating
147
+ # duplicate commitments. The request ID must be a valid UUID with the exception
148
+ # that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
149
+ # @param [String] fields
150
+ # Selector specifying which fields to include in a partial response.
151
+ # @param [String] quota_user
152
+ # Available to use for quota purposes for server-side applications. Can be any
153
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
154
+ # @param [Google::Apis::RequestOptions] options
155
+ # Request-specific options
156
+ #
157
+ # @yield [result, err] Result & error if block supplied
158
+ # @yieldparam result [Google::Apis::ParallelstoreV1::Operation] parsed result object
159
+ # @yieldparam err [StandardError] error object if request failed
160
+ #
161
+ # @return [Google::Apis::ParallelstoreV1::Operation]
162
+ #
163
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
164
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
165
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
166
+ def create_project_location_instance(parent, instance_object = nil, instance_id: nil, request_id: nil, fields: nil, quota_user: nil, options: nil, &block)
167
+ command = make_simple_command(:post, 'v1/{+parent}/instances', options)
168
+ command.request_representation = Google::Apis::ParallelstoreV1::Instance::Representation
169
+ command.request_object = instance_object
170
+ command.response_representation = Google::Apis::ParallelstoreV1::Operation::Representation
171
+ command.response_class = Google::Apis::ParallelstoreV1::Operation
172
+ command.params['parent'] = parent unless parent.nil?
173
+ command.query['instanceId'] = instance_id unless instance_id.nil?
174
+ command.query['requestId'] = request_id unless request_id.nil?
175
+ command.query['fields'] = fields unless fields.nil?
176
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
177
+ execute_or_queue_command(command, &block)
178
+ end
179
+
180
+ # Deletes a single instance.
181
+ # @param [String] name
182
+ # Required. Name of the resource
183
+ # @param [String] request_id
184
+ # Optional. An optional request ID to identify requests. Specify a unique
185
+ # request ID so that if you must retry your request, the server will know to
186
+ # ignore the request if it has already been completed. The server will guarantee
187
+ # that for at least 60 minutes after the first request. For example, consider a
188
+ # situation where you make an initial request and t he request times out. If you
189
+ # make the request again with the same request ID, the server can check if
190
+ # original operation with the same request ID was received, and if so, will
191
+ # ignore the second request. This prevents clients from accidentally creating
192
+ # duplicate commitments. The request ID must be a valid UUID with the exception
193
+ # that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
194
+ # @param [String] fields
195
+ # Selector specifying which fields to include in a partial response.
196
+ # @param [String] quota_user
197
+ # Available to use for quota purposes for server-side applications. Can be any
198
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
199
+ # @param [Google::Apis::RequestOptions] options
200
+ # Request-specific options
201
+ #
202
+ # @yield [result, err] Result & error if block supplied
203
+ # @yieldparam result [Google::Apis::ParallelstoreV1::Operation] parsed result object
204
+ # @yieldparam err [StandardError] error object if request failed
205
+ #
206
+ # @return [Google::Apis::ParallelstoreV1::Operation]
207
+ #
208
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
209
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
210
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
211
+ def delete_project_location_instance(name, request_id: nil, fields: nil, quota_user: nil, options: nil, &block)
212
+ command = make_simple_command(:delete, 'v1/{+name}', options)
213
+ command.response_representation = Google::Apis::ParallelstoreV1::Operation::Representation
214
+ command.response_class = Google::Apis::ParallelstoreV1::Operation
215
+ command.params['name'] = name unless name.nil?
216
+ command.query['requestId'] = request_id unless request_id.nil?
217
+ command.query['fields'] = fields unless fields.nil?
218
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
219
+ execute_or_queue_command(command, &block)
220
+ end
221
+
222
+ # Copies data from Parallelstore to Cloud Storage.
223
+ # @param [String] name
224
+ # Required. Name of the resource.
225
+ # @param [Google::Apis::ParallelstoreV1::ExportDataRequest] export_data_request_object
226
+ # @param [String] fields
227
+ # Selector specifying which fields to include in a partial response.
228
+ # @param [String] quota_user
229
+ # Available to use for quota purposes for server-side applications. Can be any
230
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
231
+ # @param [Google::Apis::RequestOptions] options
232
+ # Request-specific options
233
+ #
234
+ # @yield [result, err] Result & error if block supplied
235
+ # @yieldparam result [Google::Apis::ParallelstoreV1::Operation] parsed result object
236
+ # @yieldparam err [StandardError] error object if request failed
237
+ #
238
+ # @return [Google::Apis::ParallelstoreV1::Operation]
239
+ #
240
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
241
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
242
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
243
+ def export_instance_data(name, export_data_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
244
+ command = make_simple_command(:post, 'v1/{+name}:exportData', options)
245
+ command.request_representation = Google::Apis::ParallelstoreV1::ExportDataRequest::Representation
246
+ command.request_object = export_data_request_object
247
+ command.response_representation = Google::Apis::ParallelstoreV1::Operation::Representation
248
+ command.response_class = Google::Apis::ParallelstoreV1::Operation
249
+ command.params['name'] = name unless name.nil?
250
+ command.query['fields'] = fields unless fields.nil?
251
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
252
+ execute_or_queue_command(command, &block)
253
+ end
254
+
255
+ # Gets details of a single instance.
256
+ # @param [String] name
257
+ # Required. The instance resource name, in the format `projects/`project_id`/
258
+ # locations/`location`/instances/`instance_id``.
259
+ # @param [String] fields
260
+ # Selector specifying which fields to include in a partial response.
261
+ # @param [String] quota_user
262
+ # Available to use for quota purposes for server-side applications. Can be any
263
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
264
+ # @param [Google::Apis::RequestOptions] options
265
+ # Request-specific options
266
+ #
267
+ # @yield [result, err] Result & error if block supplied
268
+ # @yieldparam result [Google::Apis::ParallelstoreV1::Instance] parsed result object
269
+ # @yieldparam err [StandardError] error object if request failed
270
+ #
271
+ # @return [Google::Apis::ParallelstoreV1::Instance]
272
+ #
273
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
274
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
275
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
276
+ def get_project_location_instance(name, fields: nil, quota_user: nil, options: nil, &block)
277
+ command = make_simple_command(:get, 'v1/{+name}', options)
278
+ command.response_representation = Google::Apis::ParallelstoreV1::Instance::Representation
279
+ command.response_class = Google::Apis::ParallelstoreV1::Instance
280
+ command.params['name'] = name unless name.nil?
281
+ command.query['fields'] = fields unless fields.nil?
282
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
283
+ execute_or_queue_command(command, &block)
284
+ end
285
+
286
+ # Copies data from Cloud Storage to Parallelstore.
287
+ # @param [String] name
288
+ # Required. Name of the resource.
289
+ # @param [Google::Apis::ParallelstoreV1::ImportDataRequest] import_data_request_object
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::ParallelstoreV1::Operation] parsed result object
300
+ # @yieldparam err [StandardError] error object if request failed
301
+ #
302
+ # @return [Google::Apis::ParallelstoreV1::Operation]
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 import_instance_data(name, import_data_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
308
+ command = make_simple_command(:post, 'v1/{+name}:importData', options)
309
+ command.request_representation = Google::Apis::ParallelstoreV1::ImportDataRequest::Representation
310
+ command.request_object = import_data_request_object
311
+ command.response_representation = Google::Apis::ParallelstoreV1::Operation::Representation
312
+ command.response_class = Google::Apis::ParallelstoreV1::Operation
313
+ command.params['name'] = name unless name.nil?
314
+ command.query['fields'] = fields unless fields.nil?
315
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
316
+ execute_or_queue_command(command, &block)
317
+ end
318
+
319
+ # Lists all instances in a given project and location.
320
+ # @param [String] parent
321
+ # Required. The project and location for which to retrieve instance information,
322
+ # in the format `projects/`project_id`/locations/`location``. To retrieve
323
+ # instance information for all locations, use "-" as the value of ``location``.
324
+ # @param [String] filter
325
+ # Optional. Filtering results.
326
+ # @param [String] order_by
327
+ # Optional. Hint for how to order the results.
328
+ # @param [Fixnum] page_size
329
+ # Optional. Requested page size. Server may return fewer items than requested.
330
+ # If unspecified, the server will pick an appropriate default.
331
+ # @param [String] page_token
332
+ # Optional. A token identifying a page of results the server should return.
333
+ # @param [String] fields
334
+ # Selector specifying which fields to include in a partial response.
335
+ # @param [String] quota_user
336
+ # Available to use for quota purposes for server-side applications. Can be any
337
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
338
+ # @param [Google::Apis::RequestOptions] options
339
+ # Request-specific options
340
+ #
341
+ # @yield [result, err] Result & error if block supplied
342
+ # @yieldparam result [Google::Apis::ParallelstoreV1::ListInstancesResponse] parsed result object
343
+ # @yieldparam err [StandardError] error object if request failed
344
+ #
345
+ # @return [Google::Apis::ParallelstoreV1::ListInstancesResponse]
346
+ #
347
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
348
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
349
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
350
+ def list_project_location_instances(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
351
+ command = make_simple_command(:get, 'v1/{+parent}/instances', options)
352
+ command.response_representation = Google::Apis::ParallelstoreV1::ListInstancesResponse::Representation
353
+ command.response_class = Google::Apis::ParallelstoreV1::ListInstancesResponse
354
+ command.params['parent'] = parent unless parent.nil?
355
+ command.query['filter'] = filter unless filter.nil?
356
+ command.query['orderBy'] = order_by unless order_by.nil?
357
+ command.query['pageSize'] = page_size unless page_size.nil?
358
+ command.query['pageToken'] = page_token unless page_token.nil?
359
+ command.query['fields'] = fields unless fields.nil?
360
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
361
+ execute_or_queue_command(command, &block)
362
+ end
363
+
364
+ # Updates the parameters of a single instance.
365
+ # @param [String] name
366
+ # Identifier. The resource name of the instance, in the format `projects/`
367
+ # project`/locations/`location`/instances/`instance_id``.
368
+ # @param [Google::Apis::ParallelstoreV1::Instance] instance_object
369
+ # @param [String] request_id
370
+ # Optional. An optional request ID to identify requests. Specify a unique
371
+ # request ID so that if you must retry your request, the server will know to
372
+ # ignore the request if it has already been completed. The server will guarantee
373
+ # that for at least 60 minutes since the first request. For example, consider a
374
+ # situation where you make an initial request and t he request times out. If you
375
+ # make the request again with the same request ID, the server can check if
376
+ # original operation with the same request ID was received, and if so, will
377
+ # ignore the second request. This prevents clients from accidentally creating
378
+ # duplicate commitments. The request ID must be a valid UUID with the exception
379
+ # that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
380
+ # @param [String] update_mask
381
+ # Required. Mask of fields to update. Field mask is used to specify the fields
382
+ # to be overwritten in the Instance resource by the update. At least one path
383
+ # must be supplied in this field. The fields specified in the update_mask are
384
+ # relative to the resource, not the full request.
385
+ # @param [String] fields
386
+ # Selector specifying which fields to include in a partial response.
387
+ # @param [String] quota_user
388
+ # Available to use for quota purposes for server-side applications. Can be any
389
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
390
+ # @param [Google::Apis::RequestOptions] options
391
+ # Request-specific options
392
+ #
393
+ # @yield [result, err] Result & error if block supplied
394
+ # @yieldparam result [Google::Apis::ParallelstoreV1::Operation] parsed result object
395
+ # @yieldparam err [StandardError] error object if request failed
396
+ #
397
+ # @return [Google::Apis::ParallelstoreV1::Operation]
398
+ #
399
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
400
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
401
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
402
+ def patch_project_location_instance(name, instance_object = nil, request_id: nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
403
+ command = make_simple_command(:patch, 'v1/{+name}', options)
404
+ command.request_representation = Google::Apis::ParallelstoreV1::Instance::Representation
405
+ command.request_object = instance_object
406
+ command.response_representation = Google::Apis::ParallelstoreV1::Operation::Representation
407
+ command.response_class = Google::Apis::ParallelstoreV1::Operation
408
+ command.params['name'] = name unless name.nil?
409
+ command.query['requestId'] = request_id unless request_id.nil?
410
+ command.query['updateMask'] = update_mask unless update_mask.nil?
411
+ command.query['fields'] = fields unless fields.nil?
412
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
413
+ execute_or_queue_command(command, &block)
414
+ end
415
+
416
+ # Starts asynchronous cancellation on a long-running operation. The server makes
417
+ # a best effort to cancel the operation, but success is not guaranteed. If the
418
+ # server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.
419
+ # Clients can use Operations.GetOperation or other methods to check whether the
420
+ # cancellation succeeded or whether the operation completed despite cancellation.
421
+ # On successful cancellation, the operation is not deleted; instead, it becomes
422
+ # an operation with an Operation.error value with a google.rpc.Status.code of `1`
423
+ # , corresponding to `Code.CANCELLED`.
424
+ # @param [String] name
425
+ # The name of the operation resource to be cancelled.
426
+ # @param [Google::Apis::ParallelstoreV1::CancelOperationRequest] cancel_operation_request_object
427
+ # @param [String] fields
428
+ # Selector specifying which fields to include in a partial response.
429
+ # @param [String] quota_user
430
+ # Available to use for quota purposes for server-side applications. Can be any
431
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
432
+ # @param [Google::Apis::RequestOptions] options
433
+ # Request-specific options
434
+ #
435
+ # @yield [result, err] Result & error if block supplied
436
+ # @yieldparam result [Google::Apis::ParallelstoreV1::GoogleProtobufEmpty] parsed result object
437
+ # @yieldparam err [StandardError] error object if request failed
438
+ #
439
+ # @return [Google::Apis::ParallelstoreV1::GoogleProtobufEmpty]
440
+ #
441
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
442
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
443
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
444
+ def cancel_operation(name, cancel_operation_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
445
+ command = make_simple_command(:post, 'v1/{+name}:cancel', options)
446
+ command.request_representation = Google::Apis::ParallelstoreV1::CancelOperationRequest::Representation
447
+ command.request_object = cancel_operation_request_object
448
+ command.response_representation = Google::Apis::ParallelstoreV1::GoogleProtobufEmpty::Representation
449
+ command.response_class = Google::Apis::ParallelstoreV1::GoogleProtobufEmpty
450
+ command.params['name'] = name unless name.nil?
451
+ command.query['fields'] = fields unless fields.nil?
452
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
453
+ execute_or_queue_command(command, &block)
454
+ end
455
+
456
+ # Deletes a long-running operation. This method indicates that the client is no
457
+ # longer interested in the operation result. It does not cancel the operation.
458
+ # If the server doesn't support this method, it returns `google.rpc.Code.
459
+ # UNIMPLEMENTED`.
460
+ # @param [String] name
461
+ # The name of the operation resource to be deleted.
462
+ # @param [String] fields
463
+ # Selector specifying which fields to include in a partial response.
464
+ # @param [String] quota_user
465
+ # Available to use for quota purposes for server-side applications. Can be any
466
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
467
+ # @param [Google::Apis::RequestOptions] options
468
+ # Request-specific options
469
+ #
470
+ # @yield [result, err] Result & error if block supplied
471
+ # @yieldparam result [Google::Apis::ParallelstoreV1::GoogleProtobufEmpty] parsed result object
472
+ # @yieldparam err [StandardError] error object if request failed
473
+ #
474
+ # @return [Google::Apis::ParallelstoreV1::GoogleProtobufEmpty]
475
+ #
476
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
477
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
478
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
479
+ def delete_project_location_operation(name, fields: nil, quota_user: nil, options: nil, &block)
480
+ command = make_simple_command(:delete, 'v1/{+name}', options)
481
+ command.response_representation = Google::Apis::ParallelstoreV1::GoogleProtobufEmpty::Representation
482
+ command.response_class = Google::Apis::ParallelstoreV1::GoogleProtobufEmpty
483
+ command.params['name'] = name unless name.nil?
484
+ command.query['fields'] = fields unless fields.nil?
485
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
486
+ execute_or_queue_command(command, &block)
487
+ end
488
+
489
+ # Gets the latest state of a long-running operation. Clients can use this method
490
+ # to poll the operation result at intervals as recommended by the API service.
491
+ # @param [String] name
492
+ # The name of the operation resource.
493
+ # @param [String] fields
494
+ # Selector specifying which fields to include in a partial response.
495
+ # @param [String] quota_user
496
+ # Available to use for quota purposes for server-side applications. Can be any
497
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
498
+ # @param [Google::Apis::RequestOptions] options
499
+ # Request-specific options
500
+ #
501
+ # @yield [result, err] Result & error if block supplied
502
+ # @yieldparam result [Google::Apis::ParallelstoreV1::Operation] parsed result object
503
+ # @yieldparam err [StandardError] error object if request failed
504
+ #
505
+ # @return [Google::Apis::ParallelstoreV1::Operation]
506
+ #
507
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
508
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
509
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
510
+ def get_project_location_operation(name, fields: nil, quota_user: nil, options: nil, &block)
511
+ command = make_simple_command(:get, 'v1/{+name}', options)
512
+ command.response_representation = Google::Apis::ParallelstoreV1::Operation::Representation
513
+ command.response_class = Google::Apis::ParallelstoreV1::Operation
514
+ command.params['name'] = name unless name.nil?
515
+ command.query['fields'] = fields unless fields.nil?
516
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
517
+ execute_or_queue_command(command, &block)
518
+ end
519
+
520
+ # Lists operations that match the specified filter in the request. If the server
521
+ # doesn't support this method, it returns `UNIMPLEMENTED`.
522
+ # @param [String] name
523
+ # The name of the operation's parent resource.
524
+ # @param [String] filter
525
+ # The standard list filter.
526
+ # @param [Fixnum] page_size
527
+ # The standard list page size.
528
+ # @param [String] page_token
529
+ # The standard list page token.
530
+ # @param [String] fields
531
+ # Selector specifying which fields to include in a partial response.
532
+ # @param [String] quota_user
533
+ # Available to use for quota purposes for server-side applications. Can be any
534
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
535
+ # @param [Google::Apis::RequestOptions] options
536
+ # Request-specific options
537
+ #
538
+ # @yield [result, err] Result & error if block supplied
539
+ # @yieldparam result [Google::Apis::ParallelstoreV1::ListOperationsResponse] parsed result object
540
+ # @yieldparam err [StandardError] error object if request failed
541
+ #
542
+ # @return [Google::Apis::ParallelstoreV1::ListOperationsResponse]
543
+ #
544
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
545
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
546
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
547
+ def list_project_location_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
548
+ command = make_simple_command(:get, 'v1/{+name}/operations', options)
549
+ command.response_representation = Google::Apis::ParallelstoreV1::ListOperationsResponse::Representation
550
+ command.response_class = Google::Apis::ParallelstoreV1::ListOperationsResponse
551
+ command.params['name'] = name unless name.nil?
552
+ command.query['filter'] = filter unless filter.nil?
553
+ command.query['pageSize'] = page_size unless page_size.nil?
554
+ command.query['pageToken'] = page_token unless page_token.nil?
555
+ command.query['fields'] = fields unless fields.nil?
556
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
557
+ execute_or_queue_command(command, &block)
558
+ end
559
+
560
+ protected
561
+
562
+ def apply_command_defaults(command)
563
+ command.query['key'] = key unless key.nil?
564
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
565
+ end
566
+ end
567
+ end
568
+ end
569
+ 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/parallelstore_v1/service.rb'
16
+ require 'google/apis/parallelstore_v1/classes.rb'
17
+ require 'google/apis/parallelstore_v1/representations.rb'
18
+ require 'google/apis/parallelstore_v1/gem_version.rb'
19
+
20
+ module Google
21
+ module Apis
22
+ # Parallelstore API
23
+ #
24
+ #
25
+ #
26
+ # @see https://cloud.google.com/
27
+ module ParallelstoreV1
28
+ # Version of the Parallelstore 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/parallelstore_v1"