google-apis-iam_v1 0.38.0 → 0.40.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +9 -0
- data/lib/google/apis/iam_v1/classes.rb +379 -0
- data/lib/google/apis/iam_v1/gem_version.rb +3 -3
- data/lib/google/apis/iam_v1/representations.rb +162 -0
- data/lib/google/apis/iam_v1/service.rb +635 -0
- metadata +5 -5
@@ -116,6 +116,339 @@ module Google
|
|
116
116
|
execute_or_queue_command(command, &block)
|
117
117
|
end
|
118
118
|
|
119
|
+
# Creates a new WorkforcePool. You cannot reuse the name of a deleted pool until
|
120
|
+
# 30 days after deletion.
|
121
|
+
# @param [String] location
|
122
|
+
# The location of the pool to create. Format: `locations/`location``.
|
123
|
+
# @param [Google::Apis::IamV1::WorkforcePool] workforce_pool_object
|
124
|
+
# @param [String] workforce_pool_id
|
125
|
+
# The ID to use for the pool, which becomes the final component of the resource
|
126
|
+
# name. The IDs must be a globally unique string of 6 to 63 lowercase letters,
|
127
|
+
# digits, or hyphens. It must start with a letter, and cannot have a trailing
|
128
|
+
# hyphen. The prefix `gcp-` is reserved for use by Google, and may not be
|
129
|
+
# specified.
|
130
|
+
# @param [String] fields
|
131
|
+
# Selector specifying which fields to include in a partial response.
|
132
|
+
# @param [String] quota_user
|
133
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
134
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
135
|
+
# @param [Google::Apis::RequestOptions] options
|
136
|
+
# Request-specific options
|
137
|
+
#
|
138
|
+
# @yield [result, err] Result & error if block supplied
|
139
|
+
# @yieldparam result [Google::Apis::IamV1::Operation] parsed result object
|
140
|
+
# @yieldparam err [StandardError] error object if request failed
|
141
|
+
#
|
142
|
+
# @return [Google::Apis::IamV1::Operation]
|
143
|
+
#
|
144
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
145
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
146
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
147
|
+
def create_location_workforce_pool(location, workforce_pool_object = nil, workforce_pool_id: nil, fields: nil, quota_user: nil, options: nil, &block)
|
148
|
+
command = make_simple_command(:post, 'v1/{+location}/workforcePools', options)
|
149
|
+
command.request_representation = Google::Apis::IamV1::WorkforcePool::Representation
|
150
|
+
command.request_object = workforce_pool_object
|
151
|
+
command.response_representation = Google::Apis::IamV1::Operation::Representation
|
152
|
+
command.response_class = Google::Apis::IamV1::Operation
|
153
|
+
command.params['location'] = location unless location.nil?
|
154
|
+
command.query['workforcePoolId'] = workforce_pool_id unless workforce_pool_id.nil?
|
155
|
+
command.query['fields'] = fields unless fields.nil?
|
156
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
157
|
+
execute_or_queue_command(command, &block)
|
158
|
+
end
|
159
|
+
|
160
|
+
# Deletes a WorkforcePool. You cannot use a deleted WorkforcePool to exchange
|
161
|
+
# external credentials for Google Cloud credentials. However, deletion does not
|
162
|
+
# revoke credentials that have already been issued. Credentials issued for a
|
163
|
+
# deleted pool do not grant access to resources. If the pool is undeleted, and
|
164
|
+
# the credentials are not expired, they grant access again. You can undelete a
|
165
|
+
# pool for 30 days. After 30 days, deletion is permanent. You cannot update
|
166
|
+
# deleted pools. However, you can view and list them.
|
167
|
+
# @param [String] name
|
168
|
+
# Required. The name of the pool to delete. Format: `locations/`location`/
|
169
|
+
# workforcePools/`workforce_pool_id``
|
170
|
+
# @param [String] fields
|
171
|
+
# Selector specifying which fields to include in a partial response.
|
172
|
+
# @param [String] quota_user
|
173
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
174
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
175
|
+
# @param [Google::Apis::RequestOptions] options
|
176
|
+
# Request-specific options
|
177
|
+
#
|
178
|
+
# @yield [result, err] Result & error if block supplied
|
179
|
+
# @yieldparam result [Google::Apis::IamV1::Operation] parsed result object
|
180
|
+
# @yieldparam err [StandardError] error object if request failed
|
181
|
+
#
|
182
|
+
# @return [Google::Apis::IamV1::Operation]
|
183
|
+
#
|
184
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
185
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
186
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
187
|
+
def delete_location_workforce_pool(name, fields: nil, quota_user: nil, options: nil, &block)
|
188
|
+
command = make_simple_command(:delete, 'v1/{+name}', options)
|
189
|
+
command.response_representation = Google::Apis::IamV1::Operation::Representation
|
190
|
+
command.response_class = Google::Apis::IamV1::Operation
|
191
|
+
command.params['name'] = name unless name.nil?
|
192
|
+
command.query['fields'] = fields unless fields.nil?
|
193
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
194
|
+
execute_or_queue_command(command, &block)
|
195
|
+
end
|
196
|
+
|
197
|
+
# Gets an individual WorkforcePool.
|
198
|
+
# @param [String] name
|
199
|
+
# Required. The name of the pool to retrieve. Format: `locations/`location`/
|
200
|
+
# workforcePools/`workforce_pool_id``
|
201
|
+
# @param [String] fields
|
202
|
+
# Selector specifying which fields to include in a partial response.
|
203
|
+
# @param [String] quota_user
|
204
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
205
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
206
|
+
# @param [Google::Apis::RequestOptions] options
|
207
|
+
# Request-specific options
|
208
|
+
#
|
209
|
+
# @yield [result, err] Result & error if block supplied
|
210
|
+
# @yieldparam result [Google::Apis::IamV1::WorkforcePool] parsed result object
|
211
|
+
# @yieldparam err [StandardError] error object if request failed
|
212
|
+
#
|
213
|
+
# @return [Google::Apis::IamV1::WorkforcePool]
|
214
|
+
#
|
215
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
216
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
217
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
218
|
+
def get_location_workforce_pool(name, fields: nil, quota_user: nil, options: nil, &block)
|
219
|
+
command = make_simple_command(:get, 'v1/{+name}', options)
|
220
|
+
command.response_representation = Google::Apis::IamV1::WorkforcePool::Representation
|
221
|
+
command.response_class = Google::Apis::IamV1::WorkforcePool
|
222
|
+
command.params['name'] = name unless name.nil?
|
223
|
+
command.query['fields'] = fields unless fields.nil?
|
224
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
225
|
+
execute_or_queue_command(command, &block)
|
226
|
+
end
|
227
|
+
|
228
|
+
# Gets IAM policies on a WorkforcePool.
|
229
|
+
# @param [String] resource
|
230
|
+
# REQUIRED: The resource for which the policy is being requested. See [Resource
|
231
|
+
# names](https://cloud.google.com/apis/design/resource_names) for the
|
232
|
+
# appropriate value for this field.
|
233
|
+
# @param [Google::Apis::IamV1::GetIamPolicyRequest] get_iam_policy_request_object
|
234
|
+
# @param [String] fields
|
235
|
+
# Selector specifying which fields to include in a partial response.
|
236
|
+
# @param [String] quota_user
|
237
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
238
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
239
|
+
# @param [Google::Apis::RequestOptions] options
|
240
|
+
# Request-specific options
|
241
|
+
#
|
242
|
+
# @yield [result, err] Result & error if block supplied
|
243
|
+
# @yieldparam result [Google::Apis::IamV1::Policy] parsed result object
|
244
|
+
# @yieldparam err [StandardError] error object if request failed
|
245
|
+
#
|
246
|
+
# @return [Google::Apis::IamV1::Policy]
|
247
|
+
#
|
248
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
249
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
250
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
251
|
+
def get_workforce_pool_iam_policy(resource, get_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
252
|
+
command = make_simple_command(:post, 'v1/{+resource}:getIamPolicy', options)
|
253
|
+
command.request_representation = Google::Apis::IamV1::GetIamPolicyRequest::Representation
|
254
|
+
command.request_object = get_iam_policy_request_object
|
255
|
+
command.response_representation = Google::Apis::IamV1::Policy::Representation
|
256
|
+
command.response_class = Google::Apis::IamV1::Policy
|
257
|
+
command.params['resource'] = resource unless resource.nil?
|
258
|
+
command.query['fields'] = fields unless fields.nil?
|
259
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
260
|
+
execute_or_queue_command(command, &block)
|
261
|
+
end
|
262
|
+
|
263
|
+
# Lists all non-deleted WorkforcePools under the specified parent. If `
|
264
|
+
# show_deleted` is set to `true`, then deleted pools are also listed.
|
265
|
+
# @param [String] location
|
266
|
+
# The location of the pool. Format: `locations/`location``.
|
267
|
+
# @param [Fixnum] page_size
|
268
|
+
# The maximum number of pools to return. If unspecified, at most 50 pools will
|
269
|
+
# be returned. The maximum value is 1000; values above 1000 are truncated to
|
270
|
+
# 1000.
|
271
|
+
# @param [String] page_token
|
272
|
+
# A page token, received from a previous `ListWorkforcePools` call. Provide this
|
273
|
+
# to retrieve the subsequent page.
|
274
|
+
# @param [String] parent
|
275
|
+
# Required. The parent resource to list pools for. Format: `organizations/`org-
|
276
|
+
# id``.
|
277
|
+
# @param [Boolean] show_deleted
|
278
|
+
# Whether to return soft-deleted pools.
|
279
|
+
# @param [String] fields
|
280
|
+
# Selector specifying which fields to include in a partial response.
|
281
|
+
# @param [String] quota_user
|
282
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
283
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
284
|
+
# @param [Google::Apis::RequestOptions] options
|
285
|
+
# Request-specific options
|
286
|
+
#
|
287
|
+
# @yield [result, err] Result & error if block supplied
|
288
|
+
# @yieldparam result [Google::Apis::IamV1::ListWorkforcePoolsResponse] parsed result object
|
289
|
+
# @yieldparam err [StandardError] error object if request failed
|
290
|
+
#
|
291
|
+
# @return [Google::Apis::IamV1::ListWorkforcePoolsResponse]
|
292
|
+
#
|
293
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
294
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
295
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
296
|
+
def list_location_workforce_pools(location, page_size: nil, page_token: nil, parent: nil, show_deleted: nil, fields: nil, quota_user: nil, options: nil, &block)
|
297
|
+
command = make_simple_command(:get, 'v1/{+location}/workforcePools', options)
|
298
|
+
command.response_representation = Google::Apis::IamV1::ListWorkforcePoolsResponse::Representation
|
299
|
+
command.response_class = Google::Apis::IamV1::ListWorkforcePoolsResponse
|
300
|
+
command.params['location'] = location unless location.nil?
|
301
|
+
command.query['pageSize'] = page_size unless page_size.nil?
|
302
|
+
command.query['pageToken'] = page_token unless page_token.nil?
|
303
|
+
command.query['parent'] = parent unless parent.nil?
|
304
|
+
command.query['showDeleted'] = show_deleted unless show_deleted.nil?
|
305
|
+
command.query['fields'] = fields unless fields.nil?
|
306
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
307
|
+
execute_or_queue_command(command, &block)
|
308
|
+
end
|
309
|
+
|
310
|
+
# Updates an existing WorkforcePool.
|
311
|
+
# @param [String] name
|
312
|
+
# Output only. The resource name of the pool. Format: `locations/`location`/
|
313
|
+
# workforcePools/`workforce_pool_id``
|
314
|
+
# @param [Google::Apis::IamV1::WorkforcePool] workforce_pool_object
|
315
|
+
# @param [String] update_mask
|
316
|
+
# Required. The list of fields to update.
|
317
|
+
# @param [String] fields
|
318
|
+
# Selector specifying which fields to include in a partial response.
|
319
|
+
# @param [String] quota_user
|
320
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
321
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
322
|
+
# @param [Google::Apis::RequestOptions] options
|
323
|
+
# Request-specific options
|
324
|
+
#
|
325
|
+
# @yield [result, err] Result & error if block supplied
|
326
|
+
# @yieldparam result [Google::Apis::IamV1::Operation] parsed result object
|
327
|
+
# @yieldparam err [StandardError] error object if request failed
|
328
|
+
#
|
329
|
+
# @return [Google::Apis::IamV1::Operation]
|
330
|
+
#
|
331
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
332
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
333
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
334
|
+
def patch_location_workforce_pool(name, workforce_pool_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
|
335
|
+
command = make_simple_command(:patch, 'v1/{+name}', options)
|
336
|
+
command.request_representation = Google::Apis::IamV1::WorkforcePool::Representation
|
337
|
+
command.request_object = workforce_pool_object
|
338
|
+
command.response_representation = Google::Apis::IamV1::Operation::Representation
|
339
|
+
command.response_class = Google::Apis::IamV1::Operation
|
340
|
+
command.params['name'] = name unless name.nil?
|
341
|
+
command.query['updateMask'] = update_mask unless update_mask.nil?
|
342
|
+
command.query['fields'] = fields unless fields.nil?
|
343
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
344
|
+
execute_or_queue_command(command, &block)
|
345
|
+
end
|
346
|
+
|
347
|
+
# Sets IAM policies on a WorkforcePool.
|
348
|
+
# @param [String] resource
|
349
|
+
# REQUIRED: The resource for which the policy is being specified. See [Resource
|
350
|
+
# names](https://cloud.google.com/apis/design/resource_names) for the
|
351
|
+
# appropriate value for this field.
|
352
|
+
# @param [Google::Apis::IamV1::SetIamPolicyRequest] set_iam_policy_request_object
|
353
|
+
# @param [String] fields
|
354
|
+
# Selector specifying which fields to include in a partial response.
|
355
|
+
# @param [String] quota_user
|
356
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
357
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
358
|
+
# @param [Google::Apis::RequestOptions] options
|
359
|
+
# Request-specific options
|
360
|
+
#
|
361
|
+
# @yield [result, err] Result & error if block supplied
|
362
|
+
# @yieldparam result [Google::Apis::IamV1::Policy] parsed result object
|
363
|
+
# @yieldparam err [StandardError] error object if request failed
|
364
|
+
#
|
365
|
+
# @return [Google::Apis::IamV1::Policy]
|
366
|
+
#
|
367
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
368
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
369
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
370
|
+
def set_workforce_pool_iam_policy(resource, set_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
371
|
+
command = make_simple_command(:post, 'v1/{+resource}:setIamPolicy', options)
|
372
|
+
command.request_representation = Google::Apis::IamV1::SetIamPolicyRequest::Representation
|
373
|
+
command.request_object = set_iam_policy_request_object
|
374
|
+
command.response_representation = Google::Apis::IamV1::Policy::Representation
|
375
|
+
command.response_class = Google::Apis::IamV1::Policy
|
376
|
+
command.params['resource'] = resource unless resource.nil?
|
377
|
+
command.query['fields'] = fields unless fields.nil?
|
378
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
379
|
+
execute_or_queue_command(command, &block)
|
380
|
+
end
|
381
|
+
|
382
|
+
# Returns the caller's permissions on the WorkforcePool. If the pool does not
|
383
|
+
# exist, this will return an empty set of permissions, not a `NOT_FOUND` error.
|
384
|
+
# @param [String] resource
|
385
|
+
# REQUIRED: The resource for which the policy detail is being requested. See [
|
386
|
+
# Resource names](https://cloud.google.com/apis/design/resource_names) for the
|
387
|
+
# appropriate value for this field.
|
388
|
+
# @param [Google::Apis::IamV1::TestIamPermissionsRequest] test_iam_permissions_request_object
|
389
|
+
# @param [String] fields
|
390
|
+
# Selector specifying which fields to include in a partial response.
|
391
|
+
# @param [String] quota_user
|
392
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
393
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
394
|
+
# @param [Google::Apis::RequestOptions] options
|
395
|
+
# Request-specific options
|
396
|
+
#
|
397
|
+
# @yield [result, err] Result & error if block supplied
|
398
|
+
# @yieldparam result [Google::Apis::IamV1::TestIamPermissionsResponse] parsed result object
|
399
|
+
# @yieldparam err [StandardError] error object if request failed
|
400
|
+
#
|
401
|
+
# @return [Google::Apis::IamV1::TestIamPermissionsResponse]
|
402
|
+
#
|
403
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
404
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
405
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
406
|
+
def test_workforce_pool_iam_permissions(resource, test_iam_permissions_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
407
|
+
command = make_simple_command(:post, 'v1/{+resource}:testIamPermissions', options)
|
408
|
+
command.request_representation = Google::Apis::IamV1::TestIamPermissionsRequest::Representation
|
409
|
+
command.request_object = test_iam_permissions_request_object
|
410
|
+
command.response_representation = Google::Apis::IamV1::TestIamPermissionsResponse::Representation
|
411
|
+
command.response_class = Google::Apis::IamV1::TestIamPermissionsResponse
|
412
|
+
command.params['resource'] = resource unless resource.nil?
|
413
|
+
command.query['fields'] = fields unless fields.nil?
|
414
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
415
|
+
execute_or_queue_command(command, &block)
|
416
|
+
end
|
417
|
+
|
418
|
+
# Undeletes a WorkforcePool, as long as it was deleted fewer than 30 days ago.
|
419
|
+
# @param [String] name
|
420
|
+
# Required. The name of the pool to undelete. Format: `locations/`location`/
|
421
|
+
# workforcePools/`workforce_pool_id``
|
422
|
+
# @param [Google::Apis::IamV1::UndeleteWorkforcePoolRequest] undelete_workforce_pool_request_object
|
423
|
+
# @param [String] fields
|
424
|
+
# Selector specifying which fields to include in a partial response.
|
425
|
+
# @param [String] quota_user
|
426
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
427
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
428
|
+
# @param [Google::Apis::RequestOptions] options
|
429
|
+
# Request-specific options
|
430
|
+
#
|
431
|
+
# @yield [result, err] Result & error if block supplied
|
432
|
+
# @yieldparam result [Google::Apis::IamV1::Operation] parsed result object
|
433
|
+
# @yieldparam err [StandardError] error object if request failed
|
434
|
+
#
|
435
|
+
# @return [Google::Apis::IamV1::Operation]
|
436
|
+
#
|
437
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
438
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
439
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
440
|
+
def undelete_workforce_pool(name, undelete_workforce_pool_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
441
|
+
command = make_simple_command(:post, 'v1/{+name}:undelete', options)
|
442
|
+
command.request_representation = Google::Apis::IamV1::UndeleteWorkforcePoolRequest::Representation
|
443
|
+
command.request_object = undelete_workforce_pool_request_object
|
444
|
+
command.response_representation = Google::Apis::IamV1::Operation::Representation
|
445
|
+
command.response_class = Google::Apis::IamV1::Operation
|
446
|
+
command.params['name'] = name unless name.nil?
|
447
|
+
command.query['fields'] = fields unless fields.nil?
|
448
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
449
|
+
execute_or_queue_command(command, &block)
|
450
|
+
end
|
451
|
+
|
119
452
|
# Gets the latest state of a long-running operation. Clients can use this method
|
120
453
|
# to poll the operation result at intervals as recommended by the API service.
|
121
454
|
# @param [String] name
|
@@ -147,6 +480,228 @@ module Google
|
|
147
480
|
execute_or_queue_command(command, &block)
|
148
481
|
end
|
149
482
|
|
483
|
+
# Creates a new WorkforcePoolProvider in a WorkforcePool. You cannot reuse the
|
484
|
+
# name of a deleted provider until 30 days after deletion.
|
485
|
+
# @param [String] parent
|
486
|
+
# Required. The pool to create this provider in. Format: `locations/`location`/
|
487
|
+
# workforcePools/`workforce_pool_id``
|
488
|
+
# @param [Google::Apis::IamV1::WorkforcePoolProvider] workforce_pool_provider_object
|
489
|
+
# @param [String] workforce_pool_provider_id
|
490
|
+
# Required. The ID for the provider, which becomes the final component of the
|
491
|
+
# resource name. This value must be 4-32 characters, and may contain the
|
492
|
+
# characters [a-z0-9-]. The prefix `gcp-` is reserved for use by Google, and may
|
493
|
+
# not be specified.
|
494
|
+
# @param [String] fields
|
495
|
+
# Selector specifying which fields to include in a partial response.
|
496
|
+
# @param [String] quota_user
|
497
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
498
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
499
|
+
# @param [Google::Apis::RequestOptions] options
|
500
|
+
# Request-specific options
|
501
|
+
#
|
502
|
+
# @yield [result, err] Result & error if block supplied
|
503
|
+
# @yieldparam result [Google::Apis::IamV1::Operation] parsed result object
|
504
|
+
# @yieldparam err [StandardError] error object if request failed
|
505
|
+
#
|
506
|
+
# @return [Google::Apis::IamV1::Operation]
|
507
|
+
#
|
508
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
509
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
510
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
511
|
+
def create_location_workforce_pool_provider(parent, workforce_pool_provider_object = nil, workforce_pool_provider_id: nil, fields: nil, quota_user: nil, options: nil, &block)
|
512
|
+
command = make_simple_command(:post, 'v1/{+parent}/providers', options)
|
513
|
+
command.request_representation = Google::Apis::IamV1::WorkforcePoolProvider::Representation
|
514
|
+
command.request_object = workforce_pool_provider_object
|
515
|
+
command.response_representation = Google::Apis::IamV1::Operation::Representation
|
516
|
+
command.response_class = Google::Apis::IamV1::Operation
|
517
|
+
command.params['parent'] = parent unless parent.nil?
|
518
|
+
command.query['workforcePoolProviderId'] = workforce_pool_provider_id unless workforce_pool_provider_id.nil?
|
519
|
+
command.query['fields'] = fields unless fields.nil?
|
520
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
521
|
+
execute_or_queue_command(command, &block)
|
522
|
+
end
|
523
|
+
|
524
|
+
# Deletes a WorkforcePoolProvider. Deleting a provider does not revoke
|
525
|
+
# credentials that have already been\ issued; they continue to grant access. You
|
526
|
+
# can undelete a provider for 30 days. After 30 days, deletion is permanent. You
|
527
|
+
# cannot update deleted providers. However, you can view and list them.
|
528
|
+
# @param [String] name
|
529
|
+
# Required. The name of the provider to delete. Format: `locations/`location`/
|
530
|
+
# workforcePools/`workforce_pool_id`/providers/`provider_id``
|
531
|
+
# @param [String] fields
|
532
|
+
# Selector specifying which fields to include in a partial response.
|
533
|
+
# @param [String] quota_user
|
534
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
535
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
536
|
+
# @param [Google::Apis::RequestOptions] options
|
537
|
+
# Request-specific options
|
538
|
+
#
|
539
|
+
# @yield [result, err] Result & error if block supplied
|
540
|
+
# @yieldparam result [Google::Apis::IamV1::Operation] parsed result object
|
541
|
+
# @yieldparam err [StandardError] error object if request failed
|
542
|
+
#
|
543
|
+
# @return [Google::Apis::IamV1::Operation]
|
544
|
+
#
|
545
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
546
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
547
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
548
|
+
def delete_location_workforce_pool_provider(name, fields: nil, quota_user: nil, options: nil, &block)
|
549
|
+
command = make_simple_command(:delete, 'v1/{+name}', options)
|
550
|
+
command.response_representation = Google::Apis::IamV1::Operation::Representation
|
551
|
+
command.response_class = Google::Apis::IamV1::Operation
|
552
|
+
command.params['name'] = name unless name.nil?
|
553
|
+
command.query['fields'] = fields unless fields.nil?
|
554
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
555
|
+
execute_or_queue_command(command, &block)
|
556
|
+
end
|
557
|
+
|
558
|
+
# Gets an individual WorkforcePoolProvider.
|
559
|
+
# @param [String] name
|
560
|
+
# Required. The name of the provider to retrieve. Format: `locations/`location`/
|
561
|
+
# workforcePools/`workforce_pool_id`/providers/`provider_id``
|
562
|
+
# @param [String] fields
|
563
|
+
# Selector specifying which fields to include in a partial response.
|
564
|
+
# @param [String] quota_user
|
565
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
566
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
567
|
+
# @param [Google::Apis::RequestOptions] options
|
568
|
+
# Request-specific options
|
569
|
+
#
|
570
|
+
# @yield [result, err] Result & error if block supplied
|
571
|
+
# @yieldparam result [Google::Apis::IamV1::WorkforcePoolProvider] parsed result object
|
572
|
+
# @yieldparam err [StandardError] error object if request failed
|
573
|
+
#
|
574
|
+
# @return [Google::Apis::IamV1::WorkforcePoolProvider]
|
575
|
+
#
|
576
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
577
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
578
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
579
|
+
def get_location_workforce_pool_provider(name, fields: nil, quota_user: nil, options: nil, &block)
|
580
|
+
command = make_simple_command(:get, 'v1/{+name}', options)
|
581
|
+
command.response_representation = Google::Apis::IamV1::WorkforcePoolProvider::Representation
|
582
|
+
command.response_class = Google::Apis::IamV1::WorkforcePoolProvider
|
583
|
+
command.params['name'] = name unless name.nil?
|
584
|
+
command.query['fields'] = fields unless fields.nil?
|
585
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
586
|
+
execute_or_queue_command(command, &block)
|
587
|
+
end
|
588
|
+
|
589
|
+
# Lists all non-deleted WorkforcePoolProviders in a WorkforcePool. If `
|
590
|
+
# show_deleted` is set to `true`, then deleted providers are also listed.
|
591
|
+
# @param [String] parent
|
592
|
+
# Required. The pool to list providers for. Format: `locations/`location`/
|
593
|
+
# workforcePools/`workforce_pool_id``
|
594
|
+
# @param [Fixnum] page_size
|
595
|
+
# The maximum number of providers to return. If unspecified, at most 50
|
596
|
+
# providers are returned. The maximum value is 100; values above 100 are
|
597
|
+
# truncated to 100.
|
598
|
+
# @param [String] page_token
|
599
|
+
# A page token, received from a previous `ListWorkforcePoolProviders` call.
|
600
|
+
# Provide this to retrieve the subsequent page.
|
601
|
+
# @param [Boolean] show_deleted
|
602
|
+
# Whether to return soft-deleted providers.
|
603
|
+
# @param [String] fields
|
604
|
+
# Selector specifying which fields to include in a partial response.
|
605
|
+
# @param [String] quota_user
|
606
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
607
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
608
|
+
# @param [Google::Apis::RequestOptions] options
|
609
|
+
# Request-specific options
|
610
|
+
#
|
611
|
+
# @yield [result, err] Result & error if block supplied
|
612
|
+
# @yieldparam result [Google::Apis::IamV1::ListWorkforcePoolProvidersResponse] parsed result object
|
613
|
+
# @yieldparam err [StandardError] error object if request failed
|
614
|
+
#
|
615
|
+
# @return [Google::Apis::IamV1::ListWorkforcePoolProvidersResponse]
|
616
|
+
#
|
617
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
618
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
619
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
620
|
+
def list_location_workforce_pool_providers(parent, page_size: nil, page_token: nil, show_deleted: nil, fields: nil, quota_user: nil, options: nil, &block)
|
621
|
+
command = make_simple_command(:get, 'v1/{+parent}/providers', options)
|
622
|
+
command.response_representation = Google::Apis::IamV1::ListWorkforcePoolProvidersResponse::Representation
|
623
|
+
command.response_class = Google::Apis::IamV1::ListWorkforcePoolProvidersResponse
|
624
|
+
command.params['parent'] = parent unless parent.nil?
|
625
|
+
command.query['pageSize'] = page_size unless page_size.nil?
|
626
|
+
command.query['pageToken'] = page_token unless page_token.nil?
|
627
|
+
command.query['showDeleted'] = show_deleted unless show_deleted.nil?
|
628
|
+
command.query['fields'] = fields unless fields.nil?
|
629
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
630
|
+
execute_or_queue_command(command, &block)
|
631
|
+
end
|
632
|
+
|
633
|
+
# Updates an existing WorkforcePoolProvider.
|
634
|
+
# @param [String] name
|
635
|
+
# Output only. The resource name of the provider. Format: `locations/`location`/
|
636
|
+
# workforcePools/`workforce_pool_id`/providers/`provider_id``
|
637
|
+
# @param [Google::Apis::IamV1::WorkforcePoolProvider] workforce_pool_provider_object
|
638
|
+
# @param [String] update_mask
|
639
|
+
# Required. The list of fields to update.
|
640
|
+
# @param [String] fields
|
641
|
+
# Selector specifying which fields to include in a partial response.
|
642
|
+
# @param [String] quota_user
|
643
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
644
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
645
|
+
# @param [Google::Apis::RequestOptions] options
|
646
|
+
# Request-specific options
|
647
|
+
#
|
648
|
+
# @yield [result, err] Result & error if block supplied
|
649
|
+
# @yieldparam result [Google::Apis::IamV1::Operation] parsed result object
|
650
|
+
# @yieldparam err [StandardError] error object if request failed
|
651
|
+
#
|
652
|
+
# @return [Google::Apis::IamV1::Operation]
|
653
|
+
#
|
654
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
655
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
656
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
657
|
+
def patch_location_workforce_pool_provider(name, workforce_pool_provider_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
|
658
|
+
command = make_simple_command(:patch, 'v1/{+name}', options)
|
659
|
+
command.request_representation = Google::Apis::IamV1::WorkforcePoolProvider::Representation
|
660
|
+
command.request_object = workforce_pool_provider_object
|
661
|
+
command.response_representation = Google::Apis::IamV1::Operation::Representation
|
662
|
+
command.response_class = Google::Apis::IamV1::Operation
|
663
|
+
command.params['name'] = name unless name.nil?
|
664
|
+
command.query['updateMask'] = update_mask unless update_mask.nil?
|
665
|
+
command.query['fields'] = fields unless fields.nil?
|
666
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
667
|
+
execute_or_queue_command(command, &block)
|
668
|
+
end
|
669
|
+
|
670
|
+
# Undeletes a WorkforcePoolProvider, as long as it was deleted fewer than 30
|
671
|
+
# days ago.
|
672
|
+
# @param [String] name
|
673
|
+
# Required. The name of the provider to undelete. Format: `locations/`location`/
|
674
|
+
# workforcePools/`workforce_pool_id`/providers/`provider_id``
|
675
|
+
# @param [Google::Apis::IamV1::UndeleteWorkforcePoolProviderRequest] undelete_workforce_pool_provider_request_object
|
676
|
+
# @param [String] fields
|
677
|
+
# Selector specifying which fields to include in a partial response.
|
678
|
+
# @param [String] quota_user
|
679
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
680
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
681
|
+
# @param [Google::Apis::RequestOptions] options
|
682
|
+
# Request-specific options
|
683
|
+
#
|
684
|
+
# @yield [result, err] Result & error if block supplied
|
685
|
+
# @yieldparam result [Google::Apis::IamV1::Operation] parsed result object
|
686
|
+
# @yieldparam err [StandardError] error object if request failed
|
687
|
+
#
|
688
|
+
# @return [Google::Apis::IamV1::Operation]
|
689
|
+
#
|
690
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
691
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
692
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
693
|
+
def undelete_workforce_pool_provider(name, undelete_workforce_pool_provider_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
694
|
+
command = make_simple_command(:post, 'v1/{+name}:undelete', options)
|
695
|
+
command.request_representation = Google::Apis::IamV1::UndeleteWorkforcePoolProviderRequest::Representation
|
696
|
+
command.request_object = undelete_workforce_pool_provider_request_object
|
697
|
+
command.response_representation = Google::Apis::IamV1::Operation::Representation
|
698
|
+
command.response_class = Google::Apis::IamV1::Operation
|
699
|
+
command.params['name'] = name unless name.nil?
|
700
|
+
command.query['fields'] = fields unless fields.nil?
|
701
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
702
|
+
execute_or_queue_command(command, &block)
|
703
|
+
end
|
704
|
+
|
150
705
|
# Gets the latest state of a long-running operation. Clients can use this method
|
151
706
|
# to poll the operation result at intervals as recommended by the API service.
|
152
707
|
# @param [String] name
|
@@ -209,6 +764,86 @@ module Google
|
|
209
764
|
execute_or_queue_command(command, &block)
|
210
765
|
end
|
211
766
|
|
767
|
+
# Deletes a WorkforcePoolSubject. Subject must not already be in a deleted state.
|
768
|
+
# A WorkforcePoolSubject is automatically created the first time an external
|
769
|
+
# credential is exchanged for a Google Cloud credential with a mapped `google.
|
770
|
+
# subject` attribute. There is no path to manually create WorkforcePoolSubjects.
|
771
|
+
# Once deleted, the WorkforcePoolSubject may not be used for 30 days. After 30
|
772
|
+
# days, the WorkforcePoolSubject will be deleted forever and can be reused in
|
773
|
+
# token exchanges with Google Cloud STS. This will automatically create a new
|
774
|
+
# WorkforcePoolSubject that is independent of the previously deleted
|
775
|
+
# WorkforcePoolSubject with the same google.subject value.
|
776
|
+
# @param [String] name
|
777
|
+
# Required. The resource name of the WorkforcePoolSubject. Special characters,
|
778
|
+
# like '/' and ':', must be escaped, because all URLs need to conform to the "
|
779
|
+
# When to Escape and Unescape" section of [RFC3986](https://www.ietf.org/rfc/
|
780
|
+
# rfc2396.txt). Format: `locations/`location`/workforcePools/`workforce_pool_id`/
|
781
|
+
# subjects/`subject_id``
|
782
|
+
# @param [String] fields
|
783
|
+
# Selector specifying which fields to include in a partial response.
|
784
|
+
# @param [String] quota_user
|
785
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
786
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
787
|
+
# @param [Google::Apis::RequestOptions] options
|
788
|
+
# Request-specific options
|
789
|
+
#
|
790
|
+
# @yield [result, err] Result & error if block supplied
|
791
|
+
# @yieldparam result [Google::Apis::IamV1::Operation] parsed result object
|
792
|
+
# @yieldparam err [StandardError] error object if request failed
|
793
|
+
#
|
794
|
+
# @return [Google::Apis::IamV1::Operation]
|
795
|
+
#
|
796
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
797
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
798
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
799
|
+
def delete_location_workforce_pool_subject(name, fields: nil, quota_user: nil, options: nil, &block)
|
800
|
+
command = make_simple_command(:delete, 'v1/{+name}', options)
|
801
|
+
command.response_representation = Google::Apis::IamV1::Operation::Representation
|
802
|
+
command.response_class = Google::Apis::IamV1::Operation
|
803
|
+
command.params['name'] = name unless name.nil?
|
804
|
+
command.query['fields'] = fields unless fields.nil?
|
805
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
806
|
+
execute_or_queue_command(command, &block)
|
807
|
+
end
|
808
|
+
|
809
|
+
# Undeletes a WorkforcePoolSubject, as long as it was deleted fewer than 30 days
|
810
|
+
# ago.
|
811
|
+
# @param [String] name
|
812
|
+
# Required. The resource name of the WorkforcePoolSubject. Special characters,
|
813
|
+
# like '/' and ':', must be escaped, because all URLs need to conform to the "
|
814
|
+
# When to Escape and Unescape" section of [RFC3986](https://www.ietf.org/rfc/
|
815
|
+
# rfc2396.txt). Format: `locations/`location`/workforcePools/`workforce_pool_id`/
|
816
|
+
# subjects/`subject_id``
|
817
|
+
# @param [Google::Apis::IamV1::UndeleteWorkforcePoolSubjectRequest] undelete_workforce_pool_subject_request_object
|
818
|
+
# @param [String] fields
|
819
|
+
# Selector specifying which fields to include in a partial response.
|
820
|
+
# @param [String] quota_user
|
821
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
822
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
823
|
+
# @param [Google::Apis::RequestOptions] options
|
824
|
+
# Request-specific options
|
825
|
+
#
|
826
|
+
# @yield [result, err] Result & error if block supplied
|
827
|
+
# @yieldparam result [Google::Apis::IamV1::Operation] parsed result object
|
828
|
+
# @yieldparam err [StandardError] error object if request failed
|
829
|
+
#
|
830
|
+
# @return [Google::Apis::IamV1::Operation]
|
831
|
+
#
|
832
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
833
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
834
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
835
|
+
def undelete_workforce_pool_subject(name, undelete_workforce_pool_subject_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
836
|
+
command = make_simple_command(:post, 'v1/{+name}:undelete', options)
|
837
|
+
command.request_representation = Google::Apis::IamV1::UndeleteWorkforcePoolSubjectRequest::Representation
|
838
|
+
command.request_object = undelete_workforce_pool_subject_request_object
|
839
|
+
command.response_representation = Google::Apis::IamV1::Operation::Representation
|
840
|
+
command.response_class = Google::Apis::IamV1::Operation
|
841
|
+
command.params['name'] = name unless name.nil?
|
842
|
+
command.query['fields'] = fields unless fields.nil?
|
843
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
844
|
+
execute_or_queue_command(command, &block)
|
845
|
+
end
|
846
|
+
|
212
847
|
# Gets the latest state of a long-running operation. Clients can use this method
|
213
848
|
# to poll the operation result at intervals as recommended by the API service.
|
214
849
|
# @param [String] name
|