google-apis-storagetransfer_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.
- checksums.yaml +7 -0
- data/.yardopts +13 -0
- data/CHANGELOG.md +7 -0
- data/LICENSE.md +202 -0
- data/OVERVIEW.md +96 -0
- data/lib/google-apis-storagetransfer_v1.rb +15 -0
- data/lib/google/apis/storagetransfer_v1.rb +37 -0
- data/lib/google/apis/storagetransfer_v1/classes.rb +1260 -0
- data/lib/google/apis/storagetransfer_v1/gem_version.rb +28 -0
- data/lib/google/apis/storagetransfer_v1/representations.rb +489 -0
- data/lib/google/apis/storagetransfer_v1/service.rb +432 -0
- metadata +76 -0
@@ -0,0 +1,432 @@
|
|
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 StoragetransferV1
|
23
|
+
# Storage Transfer API
|
24
|
+
#
|
25
|
+
# Transfers data from external data sources to a Google Cloud Storage bucket or
|
26
|
+
# between Google Cloud Storage buckets.
|
27
|
+
#
|
28
|
+
# @example
|
29
|
+
# require 'google/apis/storagetransfer_v1'
|
30
|
+
#
|
31
|
+
# Storagetransfer = Google::Apis::StoragetransferV1 # Alias the module
|
32
|
+
# service = Storagetransfer::StoragetransferService.new
|
33
|
+
#
|
34
|
+
# @see https://cloud.google.com/storage-transfer/docs
|
35
|
+
class StoragetransferService < Google::Apis::Core::BaseService
|
36
|
+
# @return [String]
|
37
|
+
# API key. Your API key identifies your project and provides you with API access,
|
38
|
+
# quota, and reports. Required unless you provide an OAuth 2.0 token.
|
39
|
+
attr_accessor :key
|
40
|
+
|
41
|
+
# @return [String]
|
42
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
43
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
44
|
+
attr_accessor :quota_user
|
45
|
+
|
46
|
+
def initialize
|
47
|
+
super('https://storagetransfer.googleapis.com/', '',
|
48
|
+
client_name: 'google-apis-storagetransfer_v1',
|
49
|
+
client_version: Google::Apis::StoragetransferV1::GEM_VERSION)
|
50
|
+
@batch_path = 'batch'
|
51
|
+
end
|
52
|
+
|
53
|
+
# Returns the Google service account that is used by Storage Transfer Service to
|
54
|
+
# access buckets in the project where transfers run or in other projects. Each
|
55
|
+
# Google service account is associated with one Google Cloud Platform Console
|
56
|
+
# project. Users should add this service account to the Google Cloud Storage
|
57
|
+
# bucket ACLs to grant access to Storage Transfer Service. This service account
|
58
|
+
# is created and owned by Storage Transfer Service and can only be used by
|
59
|
+
# Storage Transfer Service.
|
60
|
+
# @param [String] project_id
|
61
|
+
# Required. The ID of the Google Cloud Platform Console project that the Google
|
62
|
+
# service account is associated with.
|
63
|
+
# @param [String] fields
|
64
|
+
# Selector specifying which fields to include in a partial response.
|
65
|
+
# @param [String] quota_user
|
66
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
67
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
68
|
+
# @param [Google::Apis::RequestOptions] options
|
69
|
+
# Request-specific options
|
70
|
+
#
|
71
|
+
# @yield [result, err] Result & error if block supplied
|
72
|
+
# @yieldparam result [Google::Apis::StoragetransferV1::GoogleServiceAccount] parsed result object
|
73
|
+
# @yieldparam err [StandardError] error object if request failed
|
74
|
+
#
|
75
|
+
# @return [Google::Apis::StoragetransferV1::GoogleServiceAccount]
|
76
|
+
#
|
77
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
78
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
79
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
80
|
+
def get_google_service_account(project_id, fields: nil, quota_user: nil, options: nil, &block)
|
81
|
+
command = make_simple_command(:get, 'v1/googleServiceAccounts/{projectId}', options)
|
82
|
+
command.response_representation = Google::Apis::StoragetransferV1::GoogleServiceAccount::Representation
|
83
|
+
command.response_class = Google::Apis::StoragetransferV1::GoogleServiceAccount
|
84
|
+
command.params['projectId'] = project_id unless project_id.nil?
|
85
|
+
command.query['fields'] = fields unless fields.nil?
|
86
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
87
|
+
execute_or_queue_command(command, &block)
|
88
|
+
end
|
89
|
+
|
90
|
+
# Creates a transfer job that runs periodically.
|
91
|
+
# @param [Google::Apis::StoragetransferV1::TransferJob] transfer_job_object
|
92
|
+
# @param [String] fields
|
93
|
+
# Selector specifying which fields to include in a partial response.
|
94
|
+
# @param [String] quota_user
|
95
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
96
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
97
|
+
# @param [Google::Apis::RequestOptions] options
|
98
|
+
# Request-specific options
|
99
|
+
#
|
100
|
+
# @yield [result, err] Result & error if block supplied
|
101
|
+
# @yieldparam result [Google::Apis::StoragetransferV1::TransferJob] parsed result object
|
102
|
+
# @yieldparam err [StandardError] error object if request failed
|
103
|
+
#
|
104
|
+
# @return [Google::Apis::StoragetransferV1::TransferJob]
|
105
|
+
#
|
106
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
107
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
108
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
109
|
+
def create_transfer_job(transfer_job_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
110
|
+
command = make_simple_command(:post, 'v1/transferJobs', options)
|
111
|
+
command.request_representation = Google::Apis::StoragetransferV1::TransferJob::Representation
|
112
|
+
command.request_object = transfer_job_object
|
113
|
+
command.response_representation = Google::Apis::StoragetransferV1::TransferJob::Representation
|
114
|
+
command.response_class = Google::Apis::StoragetransferV1::TransferJob
|
115
|
+
command.query['fields'] = fields unless fields.nil?
|
116
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
117
|
+
execute_or_queue_command(command, &block)
|
118
|
+
end
|
119
|
+
|
120
|
+
# Gets a transfer job.
|
121
|
+
# @param [String] job_name
|
122
|
+
# Required. " The job to get.
|
123
|
+
# @param [String] project_id
|
124
|
+
# Required. The ID of the Google Cloud Platform Console project that owns the
|
125
|
+
# job.
|
126
|
+
# @param [String] fields
|
127
|
+
# Selector specifying which fields to include in a partial response.
|
128
|
+
# @param [String] quota_user
|
129
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
130
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
131
|
+
# @param [Google::Apis::RequestOptions] options
|
132
|
+
# Request-specific options
|
133
|
+
#
|
134
|
+
# @yield [result, err] Result & error if block supplied
|
135
|
+
# @yieldparam result [Google::Apis::StoragetransferV1::TransferJob] parsed result object
|
136
|
+
# @yieldparam err [StandardError] error object if request failed
|
137
|
+
#
|
138
|
+
# @return [Google::Apis::StoragetransferV1::TransferJob]
|
139
|
+
#
|
140
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
141
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
142
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
143
|
+
def get_transfer_job(job_name, project_id, fields: nil, quota_user: nil, options: nil, &block)
|
144
|
+
command = make_simple_command(:get, 'v1/{+jobName}', options)
|
145
|
+
command.response_representation = Google::Apis::StoragetransferV1::TransferJob::Representation
|
146
|
+
command.response_class = Google::Apis::StoragetransferV1::TransferJob
|
147
|
+
command.params['jobName'] = job_name unless job_name.nil?
|
148
|
+
command.query['projectId'] = project_id unless project_id.nil?
|
149
|
+
command.query['fields'] = fields unless fields.nil?
|
150
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
151
|
+
execute_or_queue_command(command, &block)
|
152
|
+
end
|
153
|
+
|
154
|
+
# Lists transfer jobs.
|
155
|
+
# @param [String] filter
|
156
|
+
# Required. A list of query parameters specified as JSON text in the form of: ``"
|
157
|
+
# projectId":"my_project_id", "jobNames":["jobid1","jobid2",...], "jobStatuses":[
|
158
|
+
# "status1","status2",...]`` Since `jobNames` and `jobStatuses` support multiple
|
159
|
+
# values, their values must be specified with array notation. `projectId` is
|
160
|
+
# required. `jobNames` and `jobStatuses` are optional. The valid values for `
|
161
|
+
# jobStatuses` are case-insensitive: ENABLED, DISABLED, and DELETED.
|
162
|
+
# @param [Fixnum] page_size
|
163
|
+
# The list page size. The max allowed value is 256.
|
164
|
+
# @param [String] page_token
|
165
|
+
# The list page token.
|
166
|
+
# @param [String] fields
|
167
|
+
# Selector specifying which fields to include in a partial response.
|
168
|
+
# @param [String] quota_user
|
169
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
170
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
171
|
+
# @param [Google::Apis::RequestOptions] options
|
172
|
+
# Request-specific options
|
173
|
+
#
|
174
|
+
# @yield [result, err] Result & error if block supplied
|
175
|
+
# @yieldparam result [Google::Apis::StoragetransferV1::ListTransferJobsResponse] parsed result object
|
176
|
+
# @yieldparam err [StandardError] error object if request failed
|
177
|
+
#
|
178
|
+
# @return [Google::Apis::StoragetransferV1::ListTransferJobsResponse]
|
179
|
+
#
|
180
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
181
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
182
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
183
|
+
def list_transfer_jobs(filter, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
|
184
|
+
command = make_simple_command(:get, 'v1/transferJobs', options)
|
185
|
+
command.response_representation = Google::Apis::StoragetransferV1::ListTransferJobsResponse::Representation
|
186
|
+
command.response_class = Google::Apis::StoragetransferV1::ListTransferJobsResponse
|
187
|
+
command.query['filter'] = filter unless filter.nil?
|
188
|
+
command.query['pageSize'] = page_size unless page_size.nil?
|
189
|
+
command.query['pageToken'] = page_token unless page_token.nil?
|
190
|
+
command.query['fields'] = fields unless fields.nil?
|
191
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
192
|
+
execute_or_queue_command(command, &block)
|
193
|
+
end
|
194
|
+
|
195
|
+
# Updates a transfer job. Updating a job's transfer spec does not affect
|
196
|
+
# transfer operations that are running already. **Note:** The job's status field
|
197
|
+
# can be modified using this RPC (for example, to set a job's status to DELETED,
|
198
|
+
# DISABLED, or ENABLED).
|
199
|
+
# @param [String] job_name
|
200
|
+
# Required. The name of job to update.
|
201
|
+
# @param [Google::Apis::StoragetransferV1::UpdateTransferJobRequest] update_transfer_job_request_object
|
202
|
+
# @param [String] fields
|
203
|
+
# Selector specifying which fields to include in a partial response.
|
204
|
+
# @param [String] quota_user
|
205
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
206
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
207
|
+
# @param [Google::Apis::RequestOptions] options
|
208
|
+
# Request-specific options
|
209
|
+
#
|
210
|
+
# @yield [result, err] Result & error if block supplied
|
211
|
+
# @yieldparam result [Google::Apis::StoragetransferV1::TransferJob] parsed result object
|
212
|
+
# @yieldparam err [StandardError] error object if request failed
|
213
|
+
#
|
214
|
+
# @return [Google::Apis::StoragetransferV1::TransferJob]
|
215
|
+
#
|
216
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
217
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
218
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
219
|
+
def patch_transfer_job(job_name, update_transfer_job_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
220
|
+
command = make_simple_command(:patch, 'v1/{+jobName}', options)
|
221
|
+
command.request_representation = Google::Apis::StoragetransferV1::UpdateTransferJobRequest::Representation
|
222
|
+
command.request_object = update_transfer_job_request_object
|
223
|
+
command.response_representation = Google::Apis::StoragetransferV1::TransferJob::Representation
|
224
|
+
command.response_class = Google::Apis::StoragetransferV1::TransferJob
|
225
|
+
command.params['jobName'] = job_name unless job_name.nil?
|
226
|
+
command.query['fields'] = fields unless fields.nil?
|
227
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
228
|
+
execute_or_queue_command(command, &block)
|
229
|
+
end
|
230
|
+
|
231
|
+
# Cancels a transfer. Use the transferOperations.get method to check if the
|
232
|
+
# cancellation succeeded or if the operation completed despite the `cancel`
|
233
|
+
# request. When you cancel an operation, the currently running transfer is
|
234
|
+
# interrupted. For recurring transfer jobs, the next instance of the transfer
|
235
|
+
# job will still run. For example, if your job is configured to run every day at
|
236
|
+
# 1pm and you cancel Monday's operation at 1:05pm, Monday's transfer will stop.
|
237
|
+
# However, a transfer job will still be attempted on Tuesday. This applies only
|
238
|
+
# to currently running operations. If an operation is not currently running, `
|
239
|
+
# cancel` does nothing. *Caution:* Canceling a transfer job can leave your data
|
240
|
+
# in an unknown state. We recommend that you restore the state at both the
|
241
|
+
# destination and the source after the `cancel` request completes so that your
|
242
|
+
# data is in a consistent state. When you cancel a job, the next job computes a
|
243
|
+
# delta of files and may repair any inconsistent state. For instance, if you run
|
244
|
+
# a job every day, and today's job found 10 new files and transferred five files
|
245
|
+
# before you canceled the job, tomorrow's transfer operation will compute a new
|
246
|
+
# delta with the five files that were not copied today plus any new files
|
247
|
+
# discovered tomorrow.
|
248
|
+
# @param [String] name
|
249
|
+
# The name of the operation resource to be cancelled.
|
250
|
+
# @param [Google::Apis::StoragetransferV1::CancelOperationRequest] cancel_operation_request_object
|
251
|
+
# @param [String] fields
|
252
|
+
# Selector specifying which fields to include in a partial response.
|
253
|
+
# @param [String] quota_user
|
254
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
255
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
256
|
+
# @param [Google::Apis::RequestOptions] options
|
257
|
+
# Request-specific options
|
258
|
+
#
|
259
|
+
# @yield [result, err] Result & error if block supplied
|
260
|
+
# @yieldparam result [Google::Apis::StoragetransferV1::Empty] parsed result object
|
261
|
+
# @yieldparam err [StandardError] error object if request failed
|
262
|
+
#
|
263
|
+
# @return [Google::Apis::StoragetransferV1::Empty]
|
264
|
+
#
|
265
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
266
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
267
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
268
|
+
def cancel_transfer_operation(name, cancel_operation_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
269
|
+
command = make_simple_command(:post, 'v1/{+name}:cancel', options)
|
270
|
+
command.request_representation = Google::Apis::StoragetransferV1::CancelOperationRequest::Representation
|
271
|
+
command.request_object = cancel_operation_request_object
|
272
|
+
command.response_representation = Google::Apis::StoragetransferV1::Empty::Representation
|
273
|
+
command.response_class = Google::Apis::StoragetransferV1::Empty
|
274
|
+
command.params['name'] = name unless name.nil?
|
275
|
+
command.query['fields'] = fields unless fields.nil?
|
276
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
277
|
+
execute_or_queue_command(command, &block)
|
278
|
+
end
|
279
|
+
|
280
|
+
# Gets the latest state of a long-running operation. Clients can use this method
|
281
|
+
# to poll the operation result at intervals as recommended by the API service.
|
282
|
+
# @param [String] name
|
283
|
+
# The name of the operation resource.
|
284
|
+
# @param [String] fields
|
285
|
+
# Selector specifying which fields to include in a partial response.
|
286
|
+
# @param [String] quota_user
|
287
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
288
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
289
|
+
# @param [Google::Apis::RequestOptions] options
|
290
|
+
# Request-specific options
|
291
|
+
#
|
292
|
+
# @yield [result, err] Result & error if block supplied
|
293
|
+
# @yieldparam result [Google::Apis::StoragetransferV1::Operation] parsed result object
|
294
|
+
# @yieldparam err [StandardError] error object if request failed
|
295
|
+
#
|
296
|
+
# @return [Google::Apis::StoragetransferV1::Operation]
|
297
|
+
#
|
298
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
299
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
300
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
301
|
+
def get_transfer_operation(name, fields: nil, quota_user: nil, options: nil, &block)
|
302
|
+
command = make_simple_command(:get, 'v1/{+name}', options)
|
303
|
+
command.response_representation = Google::Apis::StoragetransferV1::Operation::Representation
|
304
|
+
command.response_class = Google::Apis::StoragetransferV1::Operation
|
305
|
+
command.params['name'] = name unless name.nil?
|
306
|
+
command.query['fields'] = fields unless fields.nil?
|
307
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
308
|
+
execute_or_queue_command(command, &block)
|
309
|
+
end
|
310
|
+
|
311
|
+
# Lists transfer operations.
|
312
|
+
# @param [String] name
|
313
|
+
# Required. The value `transferOperations`.
|
314
|
+
# @param [String] filter
|
315
|
+
# Required. A list of query parameters specified as JSON text in the form of: ``"
|
316
|
+
# projectId":"my_project_id", "jobNames":["jobid1","jobid2",...], "
|
317
|
+
# operationNames":["opid1","opid2",...], "transferStatuses":["status1","status2",
|
318
|
+
# ...]`` Since `jobNames`, `operationNames`, and `transferStatuses` support
|
319
|
+
# multiple values, they must be specified with array notation. `projectId` is
|
320
|
+
# required. `jobNames`, `operationNames`, and `transferStatuses` are optional.
|
321
|
+
# The valid values for `transferStatuses` are case-insensitive: IN_PROGRESS,
|
322
|
+
# PAUSED, SUCCESS, FAILED, and ABORTED.
|
323
|
+
# @param [Fixnum] page_size
|
324
|
+
# The list page size. The max allowed value is 256.
|
325
|
+
# @param [String] page_token
|
326
|
+
# The list page token.
|
327
|
+
# @param [String] fields
|
328
|
+
# Selector specifying which fields to include in a partial response.
|
329
|
+
# @param [String] quota_user
|
330
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
331
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
332
|
+
# @param [Google::Apis::RequestOptions] options
|
333
|
+
# Request-specific options
|
334
|
+
#
|
335
|
+
# @yield [result, err] Result & error if block supplied
|
336
|
+
# @yieldparam result [Google::Apis::StoragetransferV1::ListOperationsResponse] parsed result object
|
337
|
+
# @yieldparam err [StandardError] error object if request failed
|
338
|
+
#
|
339
|
+
# @return [Google::Apis::StoragetransferV1::ListOperationsResponse]
|
340
|
+
#
|
341
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
342
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
343
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
344
|
+
def list_transfer_operations(name, filter, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
|
345
|
+
command = make_simple_command(:get, 'v1/{+name}', options)
|
346
|
+
command.response_representation = Google::Apis::StoragetransferV1::ListOperationsResponse::Representation
|
347
|
+
command.response_class = Google::Apis::StoragetransferV1::ListOperationsResponse
|
348
|
+
command.params['name'] = name unless name.nil?
|
349
|
+
command.query['filter'] = filter unless filter.nil?
|
350
|
+
command.query['pageSize'] = page_size unless page_size.nil?
|
351
|
+
command.query['pageToken'] = page_token unless page_token.nil?
|
352
|
+
command.query['fields'] = fields unless fields.nil?
|
353
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
354
|
+
execute_or_queue_command(command, &block)
|
355
|
+
end
|
356
|
+
|
357
|
+
# Pauses a transfer operation.
|
358
|
+
# @param [String] name
|
359
|
+
# Required. The name of the transfer operation.
|
360
|
+
# @param [Google::Apis::StoragetransferV1::PauseTransferOperationRequest] pause_transfer_operation_request_object
|
361
|
+
# @param [String] fields
|
362
|
+
# Selector specifying which fields to include in a partial response.
|
363
|
+
# @param [String] quota_user
|
364
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
365
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
366
|
+
# @param [Google::Apis::RequestOptions] options
|
367
|
+
# Request-specific options
|
368
|
+
#
|
369
|
+
# @yield [result, err] Result & error if block supplied
|
370
|
+
# @yieldparam result [Google::Apis::StoragetransferV1::Empty] parsed result object
|
371
|
+
# @yieldparam err [StandardError] error object if request failed
|
372
|
+
#
|
373
|
+
# @return [Google::Apis::StoragetransferV1::Empty]
|
374
|
+
#
|
375
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
376
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
377
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
378
|
+
def pause_transfer_operation(name, pause_transfer_operation_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
379
|
+
command = make_simple_command(:post, 'v1/{+name}:pause', options)
|
380
|
+
command.request_representation = Google::Apis::StoragetransferV1::PauseTransferOperationRequest::Representation
|
381
|
+
command.request_object = pause_transfer_operation_request_object
|
382
|
+
command.response_representation = Google::Apis::StoragetransferV1::Empty::Representation
|
383
|
+
command.response_class = Google::Apis::StoragetransferV1::Empty
|
384
|
+
command.params['name'] = name unless name.nil?
|
385
|
+
command.query['fields'] = fields unless fields.nil?
|
386
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
387
|
+
execute_or_queue_command(command, &block)
|
388
|
+
end
|
389
|
+
|
390
|
+
# Resumes a transfer operation that is paused.
|
391
|
+
# @param [String] name
|
392
|
+
# Required. The name of the transfer operation.
|
393
|
+
# @param [Google::Apis::StoragetransferV1::ResumeTransferOperationRequest] resume_transfer_operation_request_object
|
394
|
+
# @param [String] fields
|
395
|
+
# Selector specifying which fields to include in a partial response.
|
396
|
+
# @param [String] quota_user
|
397
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
398
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
399
|
+
# @param [Google::Apis::RequestOptions] options
|
400
|
+
# Request-specific options
|
401
|
+
#
|
402
|
+
# @yield [result, err] Result & error if block supplied
|
403
|
+
# @yieldparam result [Google::Apis::StoragetransferV1::Empty] parsed result object
|
404
|
+
# @yieldparam err [StandardError] error object if request failed
|
405
|
+
#
|
406
|
+
# @return [Google::Apis::StoragetransferV1::Empty]
|
407
|
+
#
|
408
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
409
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
410
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
411
|
+
def resume_transfer_operation(name, resume_transfer_operation_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
412
|
+
command = make_simple_command(:post, 'v1/{+name}:resume', options)
|
413
|
+
command.request_representation = Google::Apis::StoragetransferV1::ResumeTransferOperationRequest::Representation
|
414
|
+
command.request_object = resume_transfer_operation_request_object
|
415
|
+
command.response_representation = Google::Apis::StoragetransferV1::Empty::Representation
|
416
|
+
command.response_class = Google::Apis::StoragetransferV1::Empty
|
417
|
+
command.params['name'] = name unless name.nil?
|
418
|
+
command.query['fields'] = fields unless fields.nil?
|
419
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
420
|
+
execute_or_queue_command(command, &block)
|
421
|
+
end
|
422
|
+
|
423
|
+
protected
|
424
|
+
|
425
|
+
def apply_command_defaults(command)
|
426
|
+
command.query['key'] = key unless key.nil?
|
427
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
428
|
+
end
|
429
|
+
end
|
430
|
+
end
|
431
|
+
end
|
432
|
+
end
|
metadata
ADDED
@@ -0,0 +1,76 @@
|
|
1
|
+
--- !ruby/object:Gem::Specification
|
2
|
+
name: google-apis-storagetransfer_v1
|
3
|
+
version: !ruby/object:Gem::Version
|
4
|
+
version: 0.1.0
|
5
|
+
platform: ruby
|
6
|
+
authors:
|
7
|
+
- Google LLC
|
8
|
+
autorequire:
|
9
|
+
bindir: bin
|
10
|
+
cert_chain: []
|
11
|
+
date: 2021-01-08 00:00:00.000000000 Z
|
12
|
+
dependencies:
|
13
|
+
- !ruby/object:Gem::Dependency
|
14
|
+
name: google-apis-core
|
15
|
+
requirement: !ruby/object:Gem::Requirement
|
16
|
+
requirements:
|
17
|
+
- - "~>"
|
18
|
+
- !ruby/object:Gem::Version
|
19
|
+
version: '0.1'
|
20
|
+
type: :runtime
|
21
|
+
prerelease: false
|
22
|
+
version_requirements: !ruby/object:Gem::Requirement
|
23
|
+
requirements:
|
24
|
+
- - "~>"
|
25
|
+
- !ruby/object:Gem::Version
|
26
|
+
version: '0.1'
|
27
|
+
description: This is the simple REST client for Storage Transfer API V1. Simple REST
|
28
|
+
clients are Ruby client libraries that provide access to Google services via their
|
29
|
+
HTTP REST API endpoints. These libraries are generated and updated automatically
|
30
|
+
based on the discovery documents published by the service, and they handle most
|
31
|
+
concerns such as authentication, pagination, retry, timeouts, and logging. You can
|
32
|
+
use this client to access the Storage Transfer API, but note that some services
|
33
|
+
may provide a separate modern client that is easier to use.
|
34
|
+
email: googleapis-packages@google.com
|
35
|
+
executables: []
|
36
|
+
extensions: []
|
37
|
+
extra_rdoc_files: []
|
38
|
+
files:
|
39
|
+
- ".yardopts"
|
40
|
+
- CHANGELOG.md
|
41
|
+
- LICENSE.md
|
42
|
+
- OVERVIEW.md
|
43
|
+
- lib/google-apis-storagetransfer_v1.rb
|
44
|
+
- lib/google/apis/storagetransfer_v1.rb
|
45
|
+
- lib/google/apis/storagetransfer_v1/classes.rb
|
46
|
+
- lib/google/apis/storagetransfer_v1/gem_version.rb
|
47
|
+
- lib/google/apis/storagetransfer_v1/representations.rb
|
48
|
+
- lib/google/apis/storagetransfer_v1/service.rb
|
49
|
+
homepage: https://github.com/google/google-api-ruby-client
|
50
|
+
licenses:
|
51
|
+
- Apache-2.0
|
52
|
+
metadata:
|
53
|
+
bug_tracker_uri: https://github.com/googleapis/google-api-ruby-client/issues
|
54
|
+
changelog_uri: https://github.com/googleapis/google-api-ruby-client/tree/master/generated/google-apis-storagetransfer_v1/CHANGELOG.md
|
55
|
+
documentation_uri: https://googleapis.dev/ruby/google-apis-storagetransfer_v1/v0.1.0
|
56
|
+
source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/master/generated/google-apis-storagetransfer_v1
|
57
|
+
post_install_message:
|
58
|
+
rdoc_options: []
|
59
|
+
require_paths:
|
60
|
+
- lib
|
61
|
+
required_ruby_version: !ruby/object:Gem::Requirement
|
62
|
+
requirements:
|
63
|
+
- - ">="
|
64
|
+
- !ruby/object:Gem::Version
|
65
|
+
version: '2.4'
|
66
|
+
required_rubygems_version: !ruby/object:Gem::Requirement
|
67
|
+
requirements:
|
68
|
+
- - ">="
|
69
|
+
- !ruby/object:Gem::Version
|
70
|
+
version: '0'
|
71
|
+
requirements: []
|
72
|
+
rubygems_version: 3.1.4
|
73
|
+
signing_key:
|
74
|
+
specification_version: 4
|
75
|
+
summary: Simple REST client for Storage Transfer API V1
|
76
|
+
test_files: []
|