google-apis-privateca_v1 0.1.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -0,0 +1,1868 @@
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 PrivatecaV1
23
+ # Certificate Authority API
24
+ #
25
+ # The Certificate Authority Service API is a highly-available, scalable service
26
+ # that enables you to simplify and automate the management of private
27
+ # certificate authorities (CAs) while staying in control of your private keys."
28
+ #
29
+ # @example
30
+ # require 'google/apis/privateca_v1'
31
+ #
32
+ # Privateca = Google::Apis::PrivatecaV1 # Alias the module
33
+ # service = Privateca::CertificateAuthorityServiceService.new
34
+ #
35
+ # @see https://cloud.google.com/
36
+ class CertificateAuthorityServiceService < Google::Apis::Core::BaseService
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('https://privateca.googleapis.com/', '',
49
+ client_name: 'google-apis-privateca_v1',
50
+ client_version: Google::Apis::PrivatecaV1::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::PrivatecaV1::Location] parsed result object
67
+ # @yieldparam err [StandardError] error object if request failed
68
+ #
69
+ # @return [Google::Apis::PrivatecaV1::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::PrivatecaV1::Location::Representation
77
+ command.response_class = Google::Apis::PrivatecaV1::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 in [
90
+ # 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::PrivatecaV1::ListLocationsResponse] parsed result object
107
+ # @yieldparam err [StandardError] error object if request failed
108
+ #
109
+ # @return [Google::Apis::PrivatecaV1::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::PrivatecaV1::ListLocationsResponse::Representation
117
+ command.response_class = Google::Apis::PrivatecaV1::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
+ # Create a CaPool.
128
+ # @param [String] parent
129
+ # Required. The resource name of the location associated with the CaPool, in the
130
+ # format `projects/*/locations/*`.
131
+ # @param [Google::Apis::PrivatecaV1::CaPool] ca_pool_object
132
+ # @param [String] ca_pool_id
133
+ # Required. It must be unique within a location and match the regular expression
134
+ # `[a-zA-Z0-9_-]`1,63``
135
+ # @param [String] request_id
136
+ # Optional. An ID to identify requests. Specify a unique request ID so that if
137
+ # you must retry your request, the server will know to ignore the request if it
138
+ # has already been completed. The server will guarantee that for at least 60
139
+ # minutes since the first request. For example, consider a situation where you
140
+ # make an initial request and t he request times out. If you make the request
141
+ # again with the same request ID, the server can check if original operation
142
+ # with the same request ID was received, and if so, will ignore the second
143
+ # request. This prevents clients from accidentally creating duplicate
144
+ # commitments. The request ID must be a valid UUID with the exception that zero
145
+ # UUID is not supported (00000000-0000-0000-0000-000000000000).
146
+ # @param [String] fields
147
+ # Selector specifying which fields to include in a partial response.
148
+ # @param [String] quota_user
149
+ # Available to use for quota purposes for server-side applications. Can be any
150
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
151
+ # @param [Google::Apis::RequestOptions] options
152
+ # Request-specific options
153
+ #
154
+ # @yield [result, err] Result & error if block supplied
155
+ # @yieldparam result [Google::Apis::PrivatecaV1::Operation] parsed result object
156
+ # @yieldparam err [StandardError] error object if request failed
157
+ #
158
+ # @return [Google::Apis::PrivatecaV1::Operation]
159
+ #
160
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
161
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
162
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
163
+ def create_project_location_ca_pool(parent, ca_pool_object = nil, ca_pool_id: nil, request_id: nil, fields: nil, quota_user: nil, options: nil, &block)
164
+ command = make_simple_command(:post, 'v1/{+parent}/caPools', options)
165
+ command.request_representation = Google::Apis::PrivatecaV1::CaPool::Representation
166
+ command.request_object = ca_pool_object
167
+ command.response_representation = Google::Apis::PrivatecaV1::Operation::Representation
168
+ command.response_class = Google::Apis::PrivatecaV1::Operation
169
+ command.params['parent'] = parent unless parent.nil?
170
+ command.query['caPoolId'] = ca_pool_id unless ca_pool_id.nil?
171
+ command.query['requestId'] = request_id unless request_id.nil?
172
+ command.query['fields'] = fields unless fields.nil?
173
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
174
+ execute_or_queue_command(command, &block)
175
+ end
176
+
177
+ # Delete a CaPool.
178
+ # @param [String] name
179
+ # Required. The resource name for this CaPool in the format `projects/*/
180
+ # locations/*/caPools/*`.
181
+ # @param [String] request_id
182
+ # Optional. An ID to identify requests. Specify a unique request ID so that if
183
+ # you must retry your request, the server will know to ignore the request if it
184
+ # has already been completed. The server will guarantee that for at least 60
185
+ # minutes since the first request. For example, consider a situation where you
186
+ # make an initial request and t he request times out. If you make the request
187
+ # again with the same request ID, the server can check if original operation
188
+ # with the same request ID was received, and if so, will ignore the second
189
+ # request. This prevents clients from accidentally creating duplicate
190
+ # commitments. The request ID must be a valid UUID with the exception that zero
191
+ # UUID is not supported (00000000-0000-0000-0000-000000000000).
192
+ # @param [String] fields
193
+ # Selector specifying which fields to include in a partial response.
194
+ # @param [String] quota_user
195
+ # Available to use for quota purposes for server-side applications. Can be any
196
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
197
+ # @param [Google::Apis::RequestOptions] options
198
+ # Request-specific options
199
+ #
200
+ # @yield [result, err] Result & error if block supplied
201
+ # @yieldparam result [Google::Apis::PrivatecaV1::Operation] parsed result object
202
+ # @yieldparam err [StandardError] error object if request failed
203
+ #
204
+ # @return [Google::Apis::PrivatecaV1::Operation]
205
+ #
206
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
207
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
208
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
209
+ def delete_project_location_ca_pool(name, request_id: nil, fields: nil, quota_user: nil, options: nil, &block)
210
+ command = make_simple_command(:delete, 'v1/{+name}', options)
211
+ command.response_representation = Google::Apis::PrivatecaV1::Operation::Representation
212
+ command.response_class = Google::Apis::PrivatecaV1::Operation
213
+ command.params['name'] = name unless name.nil?
214
+ command.query['requestId'] = request_id unless request_id.nil?
215
+ command.query['fields'] = fields unless fields.nil?
216
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
217
+ execute_or_queue_command(command, &block)
218
+ end
219
+
220
+ # FetchCaCerts returns the current trust anchor for the CaPool. This will
221
+ # include CA certificate chains for all ACTIVE CertificateAuthority resources in
222
+ # the CaPool.
223
+ # @param [String] ca_pool
224
+ # Required. The resource name for the CaPool in the format `projects/*/locations/
225
+ # */caPools/*`.
226
+ # @param [Google::Apis::PrivatecaV1::FetchCaCertsRequest] fetch_ca_certs_request_object
227
+ # @param [String] fields
228
+ # Selector specifying which fields to include in a partial response.
229
+ # @param [String] quota_user
230
+ # Available to use for quota purposes for server-side applications. Can be any
231
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
232
+ # @param [Google::Apis::RequestOptions] options
233
+ # Request-specific options
234
+ #
235
+ # @yield [result, err] Result & error if block supplied
236
+ # @yieldparam result [Google::Apis::PrivatecaV1::FetchCaCertsResponse] parsed result object
237
+ # @yieldparam err [StandardError] error object if request failed
238
+ #
239
+ # @return [Google::Apis::PrivatecaV1::FetchCaCertsResponse]
240
+ #
241
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
242
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
243
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
244
+ def fetch_ca_pool_ca_certs(ca_pool, fetch_ca_certs_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
245
+ command = make_simple_command(:post, 'v1/{+caPool}:fetchCaCerts', options)
246
+ command.request_representation = Google::Apis::PrivatecaV1::FetchCaCertsRequest::Representation
247
+ command.request_object = fetch_ca_certs_request_object
248
+ command.response_representation = Google::Apis::PrivatecaV1::FetchCaCertsResponse::Representation
249
+ command.response_class = Google::Apis::PrivatecaV1::FetchCaCertsResponse
250
+ command.params['caPool'] = ca_pool unless ca_pool.nil?
251
+ command.query['fields'] = fields unless fields.nil?
252
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
253
+ execute_or_queue_command(command, &block)
254
+ end
255
+
256
+ # Returns a CaPool.
257
+ # @param [String] name
258
+ # Required. The name of the CaPool to get.
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::PrivatecaV1::CaPool] parsed result object
269
+ # @yieldparam err [StandardError] error object if request failed
270
+ #
271
+ # @return [Google::Apis::PrivatecaV1::CaPool]
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_ca_pool(name, fields: nil, quota_user: nil, options: nil, &block)
277
+ command = make_simple_command(:get, 'v1/{+name}', options)
278
+ command.response_representation = Google::Apis::PrivatecaV1::CaPool::Representation
279
+ command.response_class = Google::Apis::PrivatecaV1::CaPool
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
+ # Gets the access control policy for a resource. Returns an empty policy if the
287
+ # resource exists and does not have a policy set.
288
+ # @param [String] resource
289
+ # REQUIRED: The resource for which the policy is being requested. See the
290
+ # operation documentation for the appropriate value for this field.
291
+ # @param [Fixnum] options_requested_policy_version
292
+ # Optional. The policy format version to be returned. Valid values are 0, 1, and
293
+ # 3. Requests specifying an invalid value will be rejected. Requests for
294
+ # policies with any conditional bindings must specify version 3. Policies
295
+ # without any conditional bindings may specify any valid value or leave the
296
+ # field unset. To learn which resources support conditions in their IAM policies,
297
+ # see the [IAM documentation](https://cloud.google.com/iam/help/conditions/
298
+ # resource-policies).
299
+ # @param [String] fields
300
+ # Selector specifying which fields to include in a partial response.
301
+ # @param [String] quota_user
302
+ # Available to use for quota purposes for server-side applications. Can be any
303
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
304
+ # @param [Google::Apis::RequestOptions] options
305
+ # Request-specific options
306
+ #
307
+ # @yield [result, err] Result & error if block supplied
308
+ # @yieldparam result [Google::Apis::PrivatecaV1::Policy] parsed result object
309
+ # @yieldparam err [StandardError] error object if request failed
310
+ #
311
+ # @return [Google::Apis::PrivatecaV1::Policy]
312
+ #
313
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
314
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
315
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
316
+ def get_project_location_ca_pool_iam_policy(resource, options_requested_policy_version: nil, fields: nil, quota_user: nil, options: nil, &block)
317
+ command = make_simple_command(:get, 'v1/{+resource}:getIamPolicy', options)
318
+ command.response_representation = Google::Apis::PrivatecaV1::Policy::Representation
319
+ command.response_class = Google::Apis::PrivatecaV1::Policy
320
+ command.params['resource'] = resource unless resource.nil?
321
+ command.query['options.requestedPolicyVersion'] = options_requested_policy_version unless options_requested_policy_version.nil?
322
+ command.query['fields'] = fields unless fields.nil?
323
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
324
+ execute_or_queue_command(command, &block)
325
+ end
326
+
327
+ # Lists CaPools.
328
+ # @param [String] parent
329
+ # Required. The resource name of the location associated with the CaPools, in
330
+ # the format `projects/*/locations/*`.
331
+ # @param [String] filter
332
+ # Optional. Only include resources that match the filter in the response.
333
+ # @param [String] order_by
334
+ # Optional. Specify how the results should be sorted.
335
+ # @param [Fixnum] page_size
336
+ # Optional. Limit on the number of CaPools to include in the response. Further
337
+ # CaPools can subsequently be obtained by including the ListCaPoolsResponse.
338
+ # next_page_token in a subsequent request. If unspecified, the server will pick
339
+ # an appropriate default.
340
+ # @param [String] page_token
341
+ # Optional. Pagination token, returned earlier via ListCaPoolsResponse.
342
+ # next_page_token.
343
+ # @param [String] fields
344
+ # Selector specifying which fields to include in a partial response.
345
+ # @param [String] quota_user
346
+ # Available to use for quota purposes for server-side applications. Can be any
347
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
348
+ # @param [Google::Apis::RequestOptions] options
349
+ # Request-specific options
350
+ #
351
+ # @yield [result, err] Result & error if block supplied
352
+ # @yieldparam result [Google::Apis::PrivatecaV1::ListCaPoolsResponse] parsed result object
353
+ # @yieldparam err [StandardError] error object if request failed
354
+ #
355
+ # @return [Google::Apis::PrivatecaV1::ListCaPoolsResponse]
356
+ #
357
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
358
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
359
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
360
+ def list_project_location_ca_pools(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
361
+ command = make_simple_command(:get, 'v1/{+parent}/caPools', options)
362
+ command.response_representation = Google::Apis::PrivatecaV1::ListCaPoolsResponse::Representation
363
+ command.response_class = Google::Apis::PrivatecaV1::ListCaPoolsResponse
364
+ command.params['parent'] = parent unless parent.nil?
365
+ command.query['filter'] = filter unless filter.nil?
366
+ command.query['orderBy'] = order_by unless order_by.nil?
367
+ command.query['pageSize'] = page_size unless page_size.nil?
368
+ command.query['pageToken'] = page_token unless page_token.nil?
369
+ command.query['fields'] = fields unless fields.nil?
370
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
371
+ execute_or_queue_command(command, &block)
372
+ end
373
+
374
+ # Update a CaPool.
375
+ # @param [String] name
376
+ # Output only. The resource name for this CaPool in the format `projects/*/
377
+ # locations/*/caPools/*`.
378
+ # @param [Google::Apis::PrivatecaV1::CaPool] ca_pool_object
379
+ # @param [String] request_id
380
+ # Optional. An ID to identify requests. Specify a unique request ID so that if
381
+ # you must retry your request, the server will know to ignore the request if it
382
+ # has already been completed. The server will guarantee that for at least 60
383
+ # minutes since the first request. For example, consider a situation where you
384
+ # make an initial request and t he request times out. If you make the request
385
+ # again with the same request ID, the server can check if original operation
386
+ # with the same request ID was received, and if so, will ignore the second
387
+ # request. This prevents clients from accidentally creating duplicate
388
+ # commitments. The request ID must be a valid UUID with the exception that zero
389
+ # UUID is not supported (00000000-0000-0000-0000-000000000000).
390
+ # @param [String] update_mask
391
+ # Required. A list of fields to be updated in this request.
392
+ # @param [String] fields
393
+ # Selector specifying which fields to include in a partial response.
394
+ # @param [String] quota_user
395
+ # Available to use for quota purposes for server-side applications. Can be any
396
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
397
+ # @param [Google::Apis::RequestOptions] options
398
+ # Request-specific options
399
+ #
400
+ # @yield [result, err] Result & error if block supplied
401
+ # @yieldparam result [Google::Apis::PrivatecaV1::Operation] parsed result object
402
+ # @yieldparam err [StandardError] error object if request failed
403
+ #
404
+ # @return [Google::Apis::PrivatecaV1::Operation]
405
+ #
406
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
407
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
408
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
409
+ def patch_project_location_ca_pool(name, ca_pool_object = nil, request_id: nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
410
+ command = make_simple_command(:patch, 'v1/{+name}', options)
411
+ command.request_representation = Google::Apis::PrivatecaV1::CaPool::Representation
412
+ command.request_object = ca_pool_object
413
+ command.response_representation = Google::Apis::PrivatecaV1::Operation::Representation
414
+ command.response_class = Google::Apis::PrivatecaV1::Operation
415
+ command.params['name'] = name unless name.nil?
416
+ command.query['requestId'] = request_id unless request_id.nil?
417
+ command.query['updateMask'] = update_mask unless update_mask.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
+ # Sets the access control policy on the specified resource. Replaces any
424
+ # existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `
425
+ # PERMISSION_DENIED` errors.
426
+ # @param [String] resource
427
+ # REQUIRED: The resource for which the policy is being specified. See the
428
+ # operation documentation for the appropriate value for this field.
429
+ # @param [Google::Apis::PrivatecaV1::SetIamPolicyRequest] set_iam_policy_request_object
430
+ # @param [String] fields
431
+ # Selector specifying which fields to include in a partial response.
432
+ # @param [String] quota_user
433
+ # Available to use for quota purposes for server-side applications. Can be any
434
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
435
+ # @param [Google::Apis::RequestOptions] options
436
+ # Request-specific options
437
+ #
438
+ # @yield [result, err] Result & error if block supplied
439
+ # @yieldparam result [Google::Apis::PrivatecaV1::Policy] parsed result object
440
+ # @yieldparam err [StandardError] error object if request failed
441
+ #
442
+ # @return [Google::Apis::PrivatecaV1::Policy]
443
+ #
444
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
445
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
446
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
447
+ def set_ca_pool_iam_policy(resource, set_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
448
+ command = make_simple_command(:post, 'v1/{+resource}:setIamPolicy', options)
449
+ command.request_representation = Google::Apis::PrivatecaV1::SetIamPolicyRequest::Representation
450
+ command.request_object = set_iam_policy_request_object
451
+ command.response_representation = Google::Apis::PrivatecaV1::Policy::Representation
452
+ command.response_class = Google::Apis::PrivatecaV1::Policy
453
+ command.params['resource'] = resource unless resource.nil?
454
+ command.query['fields'] = fields unless fields.nil?
455
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
456
+ execute_or_queue_command(command, &block)
457
+ end
458
+
459
+ # Returns permissions that a caller has on the specified resource. If the
460
+ # resource does not exist, this will return an empty set of permissions, not a `
461
+ # NOT_FOUND` error. Note: This operation is designed to be used for building
462
+ # permission-aware UIs and command-line tools, not for authorization checking.
463
+ # This operation may "fail open" without warning.
464
+ # @param [String] resource
465
+ # REQUIRED: The resource for which the policy detail is being requested. See the
466
+ # operation documentation for the appropriate value for this field.
467
+ # @param [Google::Apis::PrivatecaV1::TestIamPermissionsRequest] test_iam_permissions_request_object
468
+ # @param [String] fields
469
+ # Selector specifying which fields to include in a partial response.
470
+ # @param [String] quota_user
471
+ # Available to use for quota purposes for server-side applications. Can be any
472
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
473
+ # @param [Google::Apis::RequestOptions] options
474
+ # Request-specific options
475
+ #
476
+ # @yield [result, err] Result & error if block supplied
477
+ # @yieldparam result [Google::Apis::PrivatecaV1::TestIamPermissionsResponse] parsed result object
478
+ # @yieldparam err [StandardError] error object if request failed
479
+ #
480
+ # @return [Google::Apis::PrivatecaV1::TestIamPermissionsResponse]
481
+ #
482
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
483
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
484
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
485
+ def test_ca_pool_iam_permissions(resource, test_iam_permissions_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
486
+ command = make_simple_command(:post, 'v1/{+resource}:testIamPermissions', options)
487
+ command.request_representation = Google::Apis::PrivatecaV1::TestIamPermissionsRequest::Representation
488
+ command.request_object = test_iam_permissions_request_object
489
+ command.response_representation = Google::Apis::PrivatecaV1::TestIamPermissionsResponse::Representation
490
+ command.response_class = Google::Apis::PrivatecaV1::TestIamPermissionsResponse
491
+ command.params['resource'] = resource unless resource.nil?
492
+ command.query['fields'] = fields unless fields.nil?
493
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
494
+ execute_or_queue_command(command, &block)
495
+ end
496
+
497
+ # Activate a CertificateAuthority that is in state AWAITING_USER_ACTIVATION and
498
+ # is of type SUBORDINATE. After the parent Certificate Authority signs a
499
+ # certificate signing request from FetchCertificateAuthorityCsr, this method can
500
+ # complete the activation process.
501
+ # @param [String] name
502
+ # Required. The resource name for this CertificateAuthority in the format `
503
+ # projects/*/locations/*/caPools/*/certificateAuthorities/*`.
504
+ # @param [Google::Apis::PrivatecaV1::ActivateCertificateAuthorityRequest] activate_certificate_authority_request_object
505
+ # @param [String] fields
506
+ # Selector specifying which fields to include in a partial response.
507
+ # @param [String] quota_user
508
+ # Available to use for quota purposes for server-side applications. Can be any
509
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
510
+ # @param [Google::Apis::RequestOptions] options
511
+ # Request-specific options
512
+ #
513
+ # @yield [result, err] Result & error if block supplied
514
+ # @yieldparam result [Google::Apis::PrivatecaV1::Operation] parsed result object
515
+ # @yieldparam err [StandardError] error object if request failed
516
+ #
517
+ # @return [Google::Apis::PrivatecaV1::Operation]
518
+ #
519
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
520
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
521
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
522
+ def activate_certificate_authority(name, activate_certificate_authority_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
523
+ command = make_simple_command(:post, 'v1/{+name}:activate', options)
524
+ command.request_representation = Google::Apis::PrivatecaV1::ActivateCertificateAuthorityRequest::Representation
525
+ command.request_object = activate_certificate_authority_request_object
526
+ command.response_representation = Google::Apis::PrivatecaV1::Operation::Representation
527
+ command.response_class = Google::Apis::PrivatecaV1::Operation
528
+ command.params['name'] = name unless name.nil?
529
+ command.query['fields'] = fields unless fields.nil?
530
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
531
+ execute_or_queue_command(command, &block)
532
+ end
533
+
534
+ # Create a new CertificateAuthority in a given Project and Location.
535
+ # @param [String] parent
536
+ # Required. The resource name of the CaPool associated with the
537
+ # CertificateAuthorities, in the format `projects/*/locations/*/caPools/*`.
538
+ # @param [Google::Apis::PrivatecaV1::CertificateAuthority] certificate_authority_object
539
+ # @param [String] certificate_authority_id
540
+ # Required. It must be unique within a location and match the regular expression
541
+ # `[a-zA-Z0-9_-]`1,63``
542
+ # @param [String] request_id
543
+ # Optional. An ID to identify requests. Specify a unique request ID so that if
544
+ # you must retry your request, the server will know to ignore the request if it
545
+ # has already been completed. The server will guarantee that for at least 60
546
+ # minutes since the first request. For example, consider a situation where you
547
+ # make an initial request and t he request times out. If you make the request
548
+ # again with the same request ID, the server can check if original operation
549
+ # with the same request ID was received, and if so, will ignore the second
550
+ # request. This prevents clients from accidentally creating duplicate
551
+ # commitments. The request ID must be a valid UUID with the exception that zero
552
+ # UUID is not supported (00000000-0000-0000-0000-000000000000).
553
+ # @param [String] fields
554
+ # Selector specifying which fields to include in a partial response.
555
+ # @param [String] quota_user
556
+ # Available to use for quota purposes for server-side applications. Can be any
557
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
558
+ # @param [Google::Apis::RequestOptions] options
559
+ # Request-specific options
560
+ #
561
+ # @yield [result, err] Result & error if block supplied
562
+ # @yieldparam result [Google::Apis::PrivatecaV1::Operation] parsed result object
563
+ # @yieldparam err [StandardError] error object if request failed
564
+ #
565
+ # @return [Google::Apis::PrivatecaV1::Operation]
566
+ #
567
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
568
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
569
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
570
+ def create_project_location_ca_pool_certificate_authority(parent, certificate_authority_object = nil, certificate_authority_id: nil, request_id: nil, fields: nil, quota_user: nil, options: nil, &block)
571
+ command = make_simple_command(:post, 'v1/{+parent}/certificateAuthorities', options)
572
+ command.request_representation = Google::Apis::PrivatecaV1::CertificateAuthority::Representation
573
+ command.request_object = certificate_authority_object
574
+ command.response_representation = Google::Apis::PrivatecaV1::Operation::Representation
575
+ command.response_class = Google::Apis::PrivatecaV1::Operation
576
+ command.params['parent'] = parent unless parent.nil?
577
+ command.query['certificateAuthorityId'] = certificate_authority_id unless certificate_authority_id.nil?
578
+ command.query['requestId'] = request_id unless request_id.nil?
579
+ command.query['fields'] = fields unless fields.nil?
580
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
581
+ execute_or_queue_command(command, &block)
582
+ end
583
+
584
+ # Delete a CertificateAuthority.
585
+ # @param [String] name
586
+ # Required. The resource name for this CertificateAuthority in the format `
587
+ # projects/*/locations/*/caPools/*/certificateAuthorities/*`.
588
+ # @param [Boolean] ignore_active_certificates
589
+ # Optional. This field allows the CA to be deleted even if the CA has active
590
+ # certs. Active certs include both unrevoked and unexpired certs.
591
+ # @param [String] request_id
592
+ # Optional. An ID to identify requests. Specify a unique request ID so that if
593
+ # you must retry your request, the server will know to ignore the request if it
594
+ # has already been completed. The server will guarantee that for at least 60
595
+ # minutes since the first request. For example, consider a situation where you
596
+ # make an initial request and t he request times out. If you make the request
597
+ # again with the same request ID, the server can check if original operation
598
+ # with the same request ID was received, and if so, will ignore the second
599
+ # request. This prevents clients from accidentally creating duplicate
600
+ # commitments. The request ID must be a valid UUID with the exception that zero
601
+ # UUID is not supported (00000000-0000-0000-0000-000000000000).
602
+ # @param [String] fields
603
+ # Selector specifying which fields to include in a partial response.
604
+ # @param [String] quota_user
605
+ # Available to use for quota purposes for server-side applications. Can be any
606
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
607
+ # @param [Google::Apis::RequestOptions] options
608
+ # Request-specific options
609
+ #
610
+ # @yield [result, err] Result & error if block supplied
611
+ # @yieldparam result [Google::Apis::PrivatecaV1::Operation] parsed result object
612
+ # @yieldparam err [StandardError] error object if request failed
613
+ #
614
+ # @return [Google::Apis::PrivatecaV1::Operation]
615
+ #
616
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
617
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
618
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
619
+ def delete_project_location_ca_pool_certificate_authority(name, ignore_active_certificates: nil, request_id: nil, fields: nil, quota_user: nil, options: nil, &block)
620
+ command = make_simple_command(:delete, 'v1/{+name}', options)
621
+ command.response_representation = Google::Apis::PrivatecaV1::Operation::Representation
622
+ command.response_class = Google::Apis::PrivatecaV1::Operation
623
+ command.params['name'] = name unless name.nil?
624
+ command.query['ignoreActiveCertificates'] = ignore_active_certificates unless ignore_active_certificates.nil?
625
+ command.query['requestId'] = request_id unless request_id.nil?
626
+ command.query['fields'] = fields unless fields.nil?
627
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
628
+ execute_or_queue_command(command, &block)
629
+ end
630
+
631
+ # Disable a CertificateAuthority.
632
+ # @param [String] name
633
+ # Required. The resource name for this CertificateAuthority in the format `
634
+ # projects/*/locations/*/caPools/*/certificateAuthorities/*`.
635
+ # @param [Google::Apis::PrivatecaV1::DisableCertificateAuthorityRequest] disable_certificate_authority_request_object
636
+ # @param [String] fields
637
+ # Selector specifying which fields to include in a partial response.
638
+ # @param [String] quota_user
639
+ # Available to use for quota purposes for server-side applications. Can be any
640
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
641
+ # @param [Google::Apis::RequestOptions] options
642
+ # Request-specific options
643
+ #
644
+ # @yield [result, err] Result & error if block supplied
645
+ # @yieldparam result [Google::Apis::PrivatecaV1::Operation] parsed result object
646
+ # @yieldparam err [StandardError] error object if request failed
647
+ #
648
+ # @return [Google::Apis::PrivatecaV1::Operation]
649
+ #
650
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
651
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
652
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
653
+ def disable_certificate_authority(name, disable_certificate_authority_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
654
+ command = make_simple_command(:post, 'v1/{+name}:disable', options)
655
+ command.request_representation = Google::Apis::PrivatecaV1::DisableCertificateAuthorityRequest::Representation
656
+ command.request_object = disable_certificate_authority_request_object
657
+ command.response_representation = Google::Apis::PrivatecaV1::Operation::Representation
658
+ command.response_class = Google::Apis::PrivatecaV1::Operation
659
+ command.params['name'] = name unless name.nil?
660
+ command.query['fields'] = fields unless fields.nil?
661
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
662
+ execute_or_queue_command(command, &block)
663
+ end
664
+
665
+ # Enable a CertificateAuthority.
666
+ # @param [String] name
667
+ # Required. The resource name for this CertificateAuthority in the format `
668
+ # projects/*/locations/*/caPools/*/certificateAuthorities/*`.
669
+ # @param [Google::Apis::PrivatecaV1::EnableCertificateAuthorityRequest] enable_certificate_authority_request_object
670
+ # @param [String] fields
671
+ # Selector specifying which fields to include in a partial response.
672
+ # @param [String] quota_user
673
+ # Available to use for quota purposes for server-side applications. Can be any
674
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
675
+ # @param [Google::Apis::RequestOptions] options
676
+ # Request-specific options
677
+ #
678
+ # @yield [result, err] Result & error if block supplied
679
+ # @yieldparam result [Google::Apis::PrivatecaV1::Operation] parsed result object
680
+ # @yieldparam err [StandardError] error object if request failed
681
+ #
682
+ # @return [Google::Apis::PrivatecaV1::Operation]
683
+ #
684
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
685
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
686
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
687
+ def enable_certificate_authority(name, enable_certificate_authority_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
688
+ command = make_simple_command(:post, 'v1/{+name}:enable', options)
689
+ command.request_representation = Google::Apis::PrivatecaV1::EnableCertificateAuthorityRequest::Representation
690
+ command.request_object = enable_certificate_authority_request_object
691
+ command.response_representation = Google::Apis::PrivatecaV1::Operation::Representation
692
+ command.response_class = Google::Apis::PrivatecaV1::Operation
693
+ command.params['name'] = name unless name.nil?
694
+ command.query['fields'] = fields unless fields.nil?
695
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
696
+ execute_or_queue_command(command, &block)
697
+ end
698
+
699
+ # Fetch a certificate signing request (CSR) from a CertificateAuthority that is
700
+ # in state AWAITING_USER_ACTIVATION and is of type SUBORDINATE. The CSR must
701
+ # then be signed by the desired parent Certificate Authority, which could be
702
+ # another CertificateAuthority resource, or could be an on-prem certificate
703
+ # authority. See also ActivateCertificateAuthority.
704
+ # @param [String] name
705
+ # Required. The resource name for this CertificateAuthority in the format `
706
+ # projects/*/locations/*/caPools/*/certificateAuthorities/*`.
707
+ # @param [String] fields
708
+ # Selector specifying which fields to include in a partial response.
709
+ # @param [String] quota_user
710
+ # Available to use for quota purposes for server-side applications. Can be any
711
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
712
+ # @param [Google::Apis::RequestOptions] options
713
+ # Request-specific options
714
+ #
715
+ # @yield [result, err] Result & error if block supplied
716
+ # @yieldparam result [Google::Apis::PrivatecaV1::FetchCertificateAuthorityCsrResponse] parsed result object
717
+ # @yieldparam err [StandardError] error object if request failed
718
+ #
719
+ # @return [Google::Apis::PrivatecaV1::FetchCertificateAuthorityCsrResponse]
720
+ #
721
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
722
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
723
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
724
+ def fetch_project_location_ca_pool_certificate_authority(name, fields: nil, quota_user: nil, options: nil, &block)
725
+ command = make_simple_command(:get, 'v1/{+name}:fetch', options)
726
+ command.response_representation = Google::Apis::PrivatecaV1::FetchCertificateAuthorityCsrResponse::Representation
727
+ command.response_class = Google::Apis::PrivatecaV1::FetchCertificateAuthorityCsrResponse
728
+ command.params['name'] = name unless name.nil?
729
+ command.query['fields'] = fields unless fields.nil?
730
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
731
+ execute_or_queue_command(command, &block)
732
+ end
733
+
734
+ # Returns a CertificateAuthority.
735
+ # @param [String] name
736
+ # Required. The name of the CertificateAuthority to get.
737
+ # @param [String] fields
738
+ # Selector specifying which fields to include in a partial response.
739
+ # @param [String] quota_user
740
+ # Available to use for quota purposes for server-side applications. Can be any
741
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
742
+ # @param [Google::Apis::RequestOptions] options
743
+ # Request-specific options
744
+ #
745
+ # @yield [result, err] Result & error if block supplied
746
+ # @yieldparam result [Google::Apis::PrivatecaV1::CertificateAuthority] parsed result object
747
+ # @yieldparam err [StandardError] error object if request failed
748
+ #
749
+ # @return [Google::Apis::PrivatecaV1::CertificateAuthority]
750
+ #
751
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
752
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
753
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
754
+ def get_project_location_ca_pool_certificate_authority(name, fields: nil, quota_user: nil, options: nil, &block)
755
+ command = make_simple_command(:get, 'v1/{+name}', options)
756
+ command.response_representation = Google::Apis::PrivatecaV1::CertificateAuthority::Representation
757
+ command.response_class = Google::Apis::PrivatecaV1::CertificateAuthority
758
+ command.params['name'] = name unless name.nil?
759
+ command.query['fields'] = fields unless fields.nil?
760
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
761
+ execute_or_queue_command(command, &block)
762
+ end
763
+
764
+ # Lists CertificateAuthorities.
765
+ # @param [String] parent
766
+ # Required. The resource name of the CaPool associated with the
767
+ # CertificateAuthorities, in the format `projects/*/locations/*/caPools/*`.
768
+ # @param [String] filter
769
+ # Optional. Only include resources that match the filter in the response.
770
+ # @param [String] order_by
771
+ # Optional. Specify how the results should be sorted.
772
+ # @param [Fixnum] page_size
773
+ # Optional. Limit on the number of CertificateAuthorities to include in the
774
+ # response. Further CertificateAuthorities can subsequently be obtained by
775
+ # including the ListCertificateAuthoritiesResponse.next_page_token in a
776
+ # subsequent request. If unspecified, the server will pick an appropriate
777
+ # default.
778
+ # @param [String] page_token
779
+ # Optional. Pagination token, returned earlier via
780
+ # ListCertificateAuthoritiesResponse.next_page_token.
781
+ # @param [String] fields
782
+ # Selector specifying which fields to include in a partial response.
783
+ # @param [String] quota_user
784
+ # Available to use for quota purposes for server-side applications. Can be any
785
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
786
+ # @param [Google::Apis::RequestOptions] options
787
+ # Request-specific options
788
+ #
789
+ # @yield [result, err] Result & error if block supplied
790
+ # @yieldparam result [Google::Apis::PrivatecaV1::ListCertificateAuthoritiesResponse] parsed result object
791
+ # @yieldparam err [StandardError] error object if request failed
792
+ #
793
+ # @return [Google::Apis::PrivatecaV1::ListCertificateAuthoritiesResponse]
794
+ #
795
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
796
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
797
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
798
+ def list_project_location_ca_pool_certificate_authorities(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
799
+ command = make_simple_command(:get, 'v1/{+parent}/certificateAuthorities', options)
800
+ command.response_representation = Google::Apis::PrivatecaV1::ListCertificateAuthoritiesResponse::Representation
801
+ command.response_class = Google::Apis::PrivatecaV1::ListCertificateAuthoritiesResponse
802
+ command.params['parent'] = parent unless parent.nil?
803
+ command.query['filter'] = filter unless filter.nil?
804
+ command.query['orderBy'] = order_by unless order_by.nil?
805
+ command.query['pageSize'] = page_size unless page_size.nil?
806
+ command.query['pageToken'] = page_token unless page_token.nil?
807
+ command.query['fields'] = fields unless fields.nil?
808
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
809
+ execute_or_queue_command(command, &block)
810
+ end
811
+
812
+ # Update a CertificateAuthority.
813
+ # @param [String] name
814
+ # Output only. The resource name for this CertificateAuthority in the format `
815
+ # projects/*/locations/*/caPools/*/certificateAuthorities/*`.
816
+ # @param [Google::Apis::PrivatecaV1::CertificateAuthority] certificate_authority_object
817
+ # @param [String] request_id
818
+ # Optional. An ID to identify requests. Specify a unique request ID so that if
819
+ # you must retry your request, the server will know to ignore the request if it
820
+ # has already been completed. The server will guarantee that for at least 60
821
+ # minutes since the first request. For example, consider a situation where you
822
+ # make an initial request and t he request times out. If you make the request
823
+ # again with the same request ID, the server can check if original operation
824
+ # with the same request ID was received, and if so, will ignore the second
825
+ # request. This prevents clients from accidentally creating duplicate
826
+ # commitments. The request ID must be a valid UUID with the exception that zero
827
+ # UUID is not supported (00000000-0000-0000-0000-000000000000).
828
+ # @param [String] update_mask
829
+ # Required. A list of fields to be updated in this request.
830
+ # @param [String] fields
831
+ # Selector specifying which fields to include in a partial response.
832
+ # @param [String] quota_user
833
+ # Available to use for quota purposes for server-side applications. Can be any
834
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
835
+ # @param [Google::Apis::RequestOptions] options
836
+ # Request-specific options
837
+ #
838
+ # @yield [result, err] Result & error if block supplied
839
+ # @yieldparam result [Google::Apis::PrivatecaV1::Operation] parsed result object
840
+ # @yieldparam err [StandardError] error object if request failed
841
+ #
842
+ # @return [Google::Apis::PrivatecaV1::Operation]
843
+ #
844
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
845
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
846
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
847
+ def patch_project_location_ca_pool_certificate_authority(name, certificate_authority_object = nil, request_id: nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
848
+ command = make_simple_command(:patch, 'v1/{+name}', options)
849
+ command.request_representation = Google::Apis::PrivatecaV1::CertificateAuthority::Representation
850
+ command.request_object = certificate_authority_object
851
+ command.response_representation = Google::Apis::PrivatecaV1::Operation::Representation
852
+ command.response_class = Google::Apis::PrivatecaV1::Operation
853
+ command.params['name'] = name unless name.nil?
854
+ command.query['requestId'] = request_id unless request_id.nil?
855
+ command.query['updateMask'] = update_mask unless update_mask.nil?
856
+ command.query['fields'] = fields unless fields.nil?
857
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
858
+ execute_or_queue_command(command, &block)
859
+ end
860
+
861
+ # Undelete a CertificateAuthority that has been deleted.
862
+ # @param [String] name
863
+ # Required. The resource name for this CertificateAuthority in the format `
864
+ # projects/*/locations/*/caPools/*/certificateAuthorities/*`.
865
+ # @param [Google::Apis::PrivatecaV1::UndeleteCertificateAuthorityRequest] undelete_certificate_authority_request_object
866
+ # @param [String] fields
867
+ # Selector specifying which fields to include in a partial response.
868
+ # @param [String] quota_user
869
+ # Available to use for quota purposes for server-side applications. Can be any
870
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
871
+ # @param [Google::Apis::RequestOptions] options
872
+ # Request-specific options
873
+ #
874
+ # @yield [result, err] Result & error if block supplied
875
+ # @yieldparam result [Google::Apis::PrivatecaV1::Operation] parsed result object
876
+ # @yieldparam err [StandardError] error object if request failed
877
+ #
878
+ # @return [Google::Apis::PrivatecaV1::Operation]
879
+ #
880
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
881
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
882
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
883
+ def undelete_certificate_authority(name, undelete_certificate_authority_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
884
+ command = make_simple_command(:post, 'v1/{+name}:undelete', options)
885
+ command.request_representation = Google::Apis::PrivatecaV1::UndeleteCertificateAuthorityRequest::Representation
886
+ command.request_object = undelete_certificate_authority_request_object
887
+ command.response_representation = Google::Apis::PrivatecaV1::Operation::Representation
888
+ command.response_class = Google::Apis::PrivatecaV1::Operation
889
+ command.params['name'] = name unless name.nil?
890
+ command.query['fields'] = fields unless fields.nil?
891
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
892
+ execute_or_queue_command(command, &block)
893
+ end
894
+
895
+ # Returns a CertificateRevocationList.
896
+ # @param [String] name
897
+ # Required. The name of the CertificateRevocationList to get.
898
+ # @param [String] fields
899
+ # Selector specifying which fields to include in a partial response.
900
+ # @param [String] quota_user
901
+ # Available to use for quota purposes for server-side applications. Can be any
902
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
903
+ # @param [Google::Apis::RequestOptions] options
904
+ # Request-specific options
905
+ #
906
+ # @yield [result, err] Result & error if block supplied
907
+ # @yieldparam result [Google::Apis::PrivatecaV1::CertificateRevocationList] parsed result object
908
+ # @yieldparam err [StandardError] error object if request failed
909
+ #
910
+ # @return [Google::Apis::PrivatecaV1::CertificateRevocationList]
911
+ #
912
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
913
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
914
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
915
+ def get_project_location_ca_pool_certificate_authority_certificate_revocation_list(name, fields: nil, quota_user: nil, options: nil, &block)
916
+ command = make_simple_command(:get, 'v1/{+name}', options)
917
+ command.response_representation = Google::Apis::PrivatecaV1::CertificateRevocationList::Representation
918
+ command.response_class = Google::Apis::PrivatecaV1::CertificateRevocationList
919
+ command.params['name'] = name unless name.nil?
920
+ command.query['fields'] = fields unless fields.nil?
921
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
922
+ execute_or_queue_command(command, &block)
923
+ end
924
+
925
+ # Gets the access control policy for a resource. Returns an empty policy if the
926
+ # resource exists and does not have a policy set.
927
+ # @param [String] resource
928
+ # REQUIRED: The resource for which the policy is being requested. See the
929
+ # operation documentation for the appropriate value for this field.
930
+ # @param [Fixnum] options_requested_policy_version
931
+ # Optional. The policy format version to be returned. Valid values are 0, 1, and
932
+ # 3. Requests specifying an invalid value will be rejected. Requests for
933
+ # policies with any conditional bindings must specify version 3. Policies
934
+ # without any conditional bindings may specify any valid value or leave the
935
+ # field unset. To learn which resources support conditions in their IAM policies,
936
+ # see the [IAM documentation](https://cloud.google.com/iam/help/conditions/
937
+ # resource-policies).
938
+ # @param [String] fields
939
+ # Selector specifying which fields to include in a partial response.
940
+ # @param [String] quota_user
941
+ # Available to use for quota purposes for server-side applications. Can be any
942
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
943
+ # @param [Google::Apis::RequestOptions] options
944
+ # Request-specific options
945
+ #
946
+ # @yield [result, err] Result & error if block supplied
947
+ # @yieldparam result [Google::Apis::PrivatecaV1::Policy] parsed result object
948
+ # @yieldparam err [StandardError] error object if request failed
949
+ #
950
+ # @return [Google::Apis::PrivatecaV1::Policy]
951
+ #
952
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
953
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
954
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
955
+ def get_project_location_ca_pool_certificate_authority_certificate_revocation_list_iam_policy(resource, options_requested_policy_version: nil, fields: nil, quota_user: nil, options: nil, &block)
956
+ command = make_simple_command(:get, 'v1/{+resource}:getIamPolicy', options)
957
+ command.response_representation = Google::Apis::PrivatecaV1::Policy::Representation
958
+ command.response_class = Google::Apis::PrivatecaV1::Policy
959
+ command.params['resource'] = resource unless resource.nil?
960
+ command.query['options.requestedPolicyVersion'] = options_requested_policy_version unless options_requested_policy_version.nil?
961
+ command.query['fields'] = fields unless fields.nil?
962
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
963
+ execute_or_queue_command(command, &block)
964
+ end
965
+
966
+ # Lists CertificateRevocationLists.
967
+ # @param [String] parent
968
+ # Required. The resource name of the location associated with the
969
+ # CertificateRevocationLists, in the format `projects/*/locations/*/caPools/*/
970
+ # certificateAuthorities/*`.
971
+ # @param [String] filter
972
+ # Optional. Only include resources that match the filter in the response.
973
+ # @param [String] order_by
974
+ # Optional. Specify how the results should be sorted.
975
+ # @param [Fixnum] page_size
976
+ # Optional. Limit on the number of CertificateRevocationLists to include in the
977
+ # response. Further CertificateRevocationLists can subsequently be obtained by
978
+ # including the ListCertificateRevocationListsResponse.next_page_token in a
979
+ # subsequent request. If unspecified, the server will pick an appropriate
980
+ # default.
981
+ # @param [String] page_token
982
+ # Optional. Pagination token, returned earlier via
983
+ # ListCertificateRevocationListsResponse.next_page_token.
984
+ # @param [String] fields
985
+ # Selector specifying which fields to include in a partial response.
986
+ # @param [String] quota_user
987
+ # Available to use for quota purposes for server-side applications. Can be any
988
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
989
+ # @param [Google::Apis::RequestOptions] options
990
+ # Request-specific options
991
+ #
992
+ # @yield [result, err] Result & error if block supplied
993
+ # @yieldparam result [Google::Apis::PrivatecaV1::ListCertificateRevocationListsResponse] parsed result object
994
+ # @yieldparam err [StandardError] error object if request failed
995
+ #
996
+ # @return [Google::Apis::PrivatecaV1::ListCertificateRevocationListsResponse]
997
+ #
998
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
999
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1000
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1001
+ def list_project_location_ca_pool_certificate_authority_certificate_revocation_lists(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
1002
+ command = make_simple_command(:get, 'v1/{+parent}/certificateRevocationLists', options)
1003
+ command.response_representation = Google::Apis::PrivatecaV1::ListCertificateRevocationListsResponse::Representation
1004
+ command.response_class = Google::Apis::PrivatecaV1::ListCertificateRevocationListsResponse
1005
+ command.params['parent'] = parent unless parent.nil?
1006
+ command.query['filter'] = filter unless filter.nil?
1007
+ command.query['orderBy'] = order_by unless order_by.nil?
1008
+ command.query['pageSize'] = page_size unless page_size.nil?
1009
+ command.query['pageToken'] = page_token unless page_token.nil?
1010
+ command.query['fields'] = fields unless fields.nil?
1011
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1012
+ execute_or_queue_command(command, &block)
1013
+ end
1014
+
1015
+ # Update a CertificateRevocationList.
1016
+ # @param [String] name
1017
+ # Output only. The resource name for this CertificateRevocationList in the
1018
+ # format `projects/*/locations/*/caPools/*certificateAuthorities/*/
1019
+ # certificateRevocationLists/*`.
1020
+ # @param [Google::Apis::PrivatecaV1::CertificateRevocationList] certificate_revocation_list_object
1021
+ # @param [String] request_id
1022
+ # Optional. An ID to identify requests. Specify a unique request ID so that if
1023
+ # you must retry your request, the server will know to ignore the request if it
1024
+ # has already been completed. The server will guarantee that for at least 60
1025
+ # minutes since the first request. For example, consider a situation where you
1026
+ # make an initial request and t he request times out. If you make the request
1027
+ # again with the same request ID, the server can check if original operation
1028
+ # with the same request ID was received, and if so, will ignore the second
1029
+ # request. This prevents clients from accidentally creating duplicate
1030
+ # commitments. The request ID must be a valid UUID with the exception that zero
1031
+ # UUID is not supported (00000000-0000-0000-0000-000000000000).
1032
+ # @param [String] update_mask
1033
+ # Required. A list of fields to be updated in this request.
1034
+ # @param [String] fields
1035
+ # Selector specifying which fields to include in a partial response.
1036
+ # @param [String] quota_user
1037
+ # Available to use for quota purposes for server-side applications. Can be any
1038
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1039
+ # @param [Google::Apis::RequestOptions] options
1040
+ # Request-specific options
1041
+ #
1042
+ # @yield [result, err] Result & error if block supplied
1043
+ # @yieldparam result [Google::Apis::PrivatecaV1::Operation] parsed result object
1044
+ # @yieldparam err [StandardError] error object if request failed
1045
+ #
1046
+ # @return [Google::Apis::PrivatecaV1::Operation]
1047
+ #
1048
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1049
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1050
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1051
+ def patch_project_location_ca_pool_certificate_authority_certificate_revocation_list(name, certificate_revocation_list_object = nil, request_id: nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
1052
+ command = make_simple_command(:patch, 'v1/{+name}', options)
1053
+ command.request_representation = Google::Apis::PrivatecaV1::CertificateRevocationList::Representation
1054
+ command.request_object = certificate_revocation_list_object
1055
+ command.response_representation = Google::Apis::PrivatecaV1::Operation::Representation
1056
+ command.response_class = Google::Apis::PrivatecaV1::Operation
1057
+ command.params['name'] = name unless name.nil?
1058
+ command.query['requestId'] = request_id unless request_id.nil?
1059
+ command.query['updateMask'] = update_mask unless update_mask.nil?
1060
+ command.query['fields'] = fields unless fields.nil?
1061
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1062
+ execute_or_queue_command(command, &block)
1063
+ end
1064
+
1065
+ # Sets the access control policy on the specified resource. Replaces any
1066
+ # existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `
1067
+ # PERMISSION_DENIED` errors.
1068
+ # @param [String] resource
1069
+ # REQUIRED: The resource for which the policy is being specified. See the
1070
+ # operation documentation for the appropriate value for this field.
1071
+ # @param [Google::Apis::PrivatecaV1::SetIamPolicyRequest] set_iam_policy_request_object
1072
+ # @param [String] fields
1073
+ # Selector specifying which fields to include in a partial response.
1074
+ # @param [String] quota_user
1075
+ # Available to use for quota purposes for server-side applications. Can be any
1076
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1077
+ # @param [Google::Apis::RequestOptions] options
1078
+ # Request-specific options
1079
+ #
1080
+ # @yield [result, err] Result & error if block supplied
1081
+ # @yieldparam result [Google::Apis::PrivatecaV1::Policy] parsed result object
1082
+ # @yieldparam err [StandardError] error object if request failed
1083
+ #
1084
+ # @return [Google::Apis::PrivatecaV1::Policy]
1085
+ #
1086
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1087
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1088
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1089
+ def set_certificate_revocation_list_iam_policy(resource, set_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
1090
+ command = make_simple_command(:post, 'v1/{+resource}:setIamPolicy', options)
1091
+ command.request_representation = Google::Apis::PrivatecaV1::SetIamPolicyRequest::Representation
1092
+ command.request_object = set_iam_policy_request_object
1093
+ command.response_representation = Google::Apis::PrivatecaV1::Policy::Representation
1094
+ command.response_class = Google::Apis::PrivatecaV1::Policy
1095
+ command.params['resource'] = resource unless resource.nil?
1096
+ command.query['fields'] = fields unless fields.nil?
1097
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1098
+ execute_or_queue_command(command, &block)
1099
+ end
1100
+
1101
+ # Returns permissions that a caller has on the specified resource. If the
1102
+ # resource does not exist, this will return an empty set of permissions, not a `
1103
+ # NOT_FOUND` error. Note: This operation is designed to be used for building
1104
+ # permission-aware UIs and command-line tools, not for authorization checking.
1105
+ # This operation may "fail open" without warning.
1106
+ # @param [String] resource
1107
+ # REQUIRED: The resource for which the policy detail is being requested. See the
1108
+ # operation documentation for the appropriate value for this field.
1109
+ # @param [Google::Apis::PrivatecaV1::TestIamPermissionsRequest] test_iam_permissions_request_object
1110
+ # @param [String] fields
1111
+ # Selector specifying which fields to include in a partial response.
1112
+ # @param [String] quota_user
1113
+ # Available to use for quota purposes for server-side applications. Can be any
1114
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1115
+ # @param [Google::Apis::RequestOptions] options
1116
+ # Request-specific options
1117
+ #
1118
+ # @yield [result, err] Result & error if block supplied
1119
+ # @yieldparam result [Google::Apis::PrivatecaV1::TestIamPermissionsResponse] parsed result object
1120
+ # @yieldparam err [StandardError] error object if request failed
1121
+ #
1122
+ # @return [Google::Apis::PrivatecaV1::TestIamPermissionsResponse]
1123
+ #
1124
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1125
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1126
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1127
+ def test_certificate_revocation_list_iam_permissions(resource, test_iam_permissions_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
1128
+ command = make_simple_command(:post, 'v1/{+resource}:testIamPermissions', options)
1129
+ command.request_representation = Google::Apis::PrivatecaV1::TestIamPermissionsRequest::Representation
1130
+ command.request_object = test_iam_permissions_request_object
1131
+ command.response_representation = Google::Apis::PrivatecaV1::TestIamPermissionsResponse::Representation
1132
+ command.response_class = Google::Apis::PrivatecaV1::TestIamPermissionsResponse
1133
+ command.params['resource'] = resource unless resource.nil?
1134
+ command.query['fields'] = fields unless fields.nil?
1135
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1136
+ execute_or_queue_command(command, &block)
1137
+ end
1138
+
1139
+ # Create a new Certificate in a given Project, Location from a particular CaPool.
1140
+ # @param [String] parent
1141
+ # Required. The resource name of the CaPool associated with the Certificate, in
1142
+ # the format `projects/*/locations/*/caPools/*`.
1143
+ # @param [Google::Apis::PrivatecaV1::Certificate] certificate_object
1144
+ # @param [String] certificate_id
1145
+ # Optional. It must be unique within a location and match the regular expression
1146
+ # `[a-zA-Z0-9_-]`1,63``. This field is required when using a
1147
+ # CertificateAuthority in the Enterprise CertificateAuthority.Tier, but is
1148
+ # optional and its value is ignored otherwise.
1149
+ # @param [String] issuing_certificate_authority_id
1150
+ # Optional. The resource ID of the CertificateAuthority that should issue the
1151
+ # certificate. This optional field will ignore the load-balancing scheme of the
1152
+ # Pool and directly issue the certificate from the CA with the specified ID,
1153
+ # contained in the same CaPool referenced by `parent`. Per-CA quota rules apply.
1154
+ # If left empty, a CertificateAuthority will be chosen from the CaPool by the
1155
+ # service. For example, to issue a Certificate from a Certificate Authority with
1156
+ # resource name "projects/my-project/locations/us-central1/caPools/my-pool/
1157
+ # certificateAuthorities/my-ca", you can set the parent to "projects/my-project/
1158
+ # locations/us-central1/caPools/my-pool" and the
1159
+ # issuing_certificate_authority_id to "my-ca".
1160
+ # @param [String] request_id
1161
+ # Optional. An ID to identify requests. Specify a unique request ID so that if
1162
+ # you must retry your request, the server will know to ignore the request if it
1163
+ # has already been completed. The server will guarantee that for at least 60
1164
+ # minutes since the first request. For example, consider a situation where you
1165
+ # make an initial request and t he request times out. If you make the request
1166
+ # again with the same request ID, the server can check if original operation
1167
+ # with the same request ID was received, and if so, will ignore the second
1168
+ # request. This prevents clients from accidentally creating duplicate
1169
+ # commitments. The request ID must be a valid UUID with the exception that zero
1170
+ # UUID is not supported (00000000-0000-0000-0000-000000000000).
1171
+ # @param [Boolean] validate_only
1172
+ # Optional. If this is true, no Certificate resource will be persisted
1173
+ # regardless of the CaPool's tier, and the returned Certificate will not contain
1174
+ # the pem_certificate field.
1175
+ # @param [String] fields
1176
+ # Selector specifying which fields to include in a partial response.
1177
+ # @param [String] quota_user
1178
+ # Available to use for quota purposes for server-side applications. Can be any
1179
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1180
+ # @param [Google::Apis::RequestOptions] options
1181
+ # Request-specific options
1182
+ #
1183
+ # @yield [result, err] Result & error if block supplied
1184
+ # @yieldparam result [Google::Apis::PrivatecaV1::Certificate] parsed result object
1185
+ # @yieldparam err [StandardError] error object if request failed
1186
+ #
1187
+ # @return [Google::Apis::PrivatecaV1::Certificate]
1188
+ #
1189
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1190
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1191
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1192
+ def create_project_location_ca_pool_certificate(parent, certificate_object = nil, certificate_id: nil, issuing_certificate_authority_id: nil, request_id: nil, validate_only: nil, fields: nil, quota_user: nil, options: nil, &block)
1193
+ command = make_simple_command(:post, 'v1/{+parent}/certificates', options)
1194
+ command.request_representation = Google::Apis::PrivatecaV1::Certificate::Representation
1195
+ command.request_object = certificate_object
1196
+ command.response_representation = Google::Apis::PrivatecaV1::Certificate::Representation
1197
+ command.response_class = Google::Apis::PrivatecaV1::Certificate
1198
+ command.params['parent'] = parent unless parent.nil?
1199
+ command.query['certificateId'] = certificate_id unless certificate_id.nil?
1200
+ command.query['issuingCertificateAuthorityId'] = issuing_certificate_authority_id unless issuing_certificate_authority_id.nil?
1201
+ command.query['requestId'] = request_id unless request_id.nil?
1202
+ command.query['validateOnly'] = validate_only unless validate_only.nil?
1203
+ command.query['fields'] = fields unless fields.nil?
1204
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1205
+ execute_or_queue_command(command, &block)
1206
+ end
1207
+
1208
+ # Returns a Certificate.
1209
+ # @param [String] name
1210
+ # Required. The name of the Certificate to get.
1211
+ # @param [String] fields
1212
+ # Selector specifying which fields to include in a partial response.
1213
+ # @param [String] quota_user
1214
+ # Available to use for quota purposes for server-side applications. Can be any
1215
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1216
+ # @param [Google::Apis::RequestOptions] options
1217
+ # Request-specific options
1218
+ #
1219
+ # @yield [result, err] Result & error if block supplied
1220
+ # @yieldparam result [Google::Apis::PrivatecaV1::Certificate] parsed result object
1221
+ # @yieldparam err [StandardError] error object if request failed
1222
+ #
1223
+ # @return [Google::Apis::PrivatecaV1::Certificate]
1224
+ #
1225
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1226
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1227
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1228
+ def get_project_location_ca_pool_certificate(name, fields: nil, quota_user: nil, options: nil, &block)
1229
+ command = make_simple_command(:get, 'v1/{+name}', options)
1230
+ command.response_representation = Google::Apis::PrivatecaV1::Certificate::Representation
1231
+ command.response_class = Google::Apis::PrivatecaV1::Certificate
1232
+ command.params['name'] = name unless name.nil?
1233
+ command.query['fields'] = fields unless fields.nil?
1234
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1235
+ execute_or_queue_command(command, &block)
1236
+ end
1237
+
1238
+ # Lists Certificates.
1239
+ # @param [String] parent
1240
+ # Required. The resource name of the location associated with the Certificates,
1241
+ # in the format `projects/*/locations/*/caPools/*`.
1242
+ # @param [String] filter
1243
+ # Optional. Only include resources that match the filter in the response. For
1244
+ # details on supported filters and syntax, see [Certificates Filtering
1245
+ # documentation](https://cloud.google.com/certificate-authority-service/docs/
1246
+ # sorting-filtering-certificates#filtering_support).
1247
+ # @param [String] order_by
1248
+ # Optional. Specify how the results should be sorted. For details on supported
1249
+ # fields and syntax, see [Certificates Sorting documentation](https://cloud.
1250
+ # google.com/certificate-authority-service/docs/sorting-filtering-certificates#
1251
+ # sorting_support).
1252
+ # @param [Fixnum] page_size
1253
+ # Optional. Limit on the number of Certificates to include in the response.
1254
+ # Further Certificates can subsequently be obtained by including the
1255
+ # ListCertificatesResponse.next_page_token in a subsequent request. If
1256
+ # unspecified, the server will pick an appropriate default.
1257
+ # @param [String] page_token
1258
+ # Optional. Pagination token, returned earlier via ListCertificatesResponse.
1259
+ # next_page_token.
1260
+ # @param [String] fields
1261
+ # Selector specifying which fields to include in a partial response.
1262
+ # @param [String] quota_user
1263
+ # Available to use for quota purposes for server-side applications. Can be any
1264
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1265
+ # @param [Google::Apis::RequestOptions] options
1266
+ # Request-specific options
1267
+ #
1268
+ # @yield [result, err] Result & error if block supplied
1269
+ # @yieldparam result [Google::Apis::PrivatecaV1::ListCertificatesResponse] parsed result object
1270
+ # @yieldparam err [StandardError] error object if request failed
1271
+ #
1272
+ # @return [Google::Apis::PrivatecaV1::ListCertificatesResponse]
1273
+ #
1274
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1275
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1276
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1277
+ def list_project_location_ca_pool_certificates(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
1278
+ command = make_simple_command(:get, 'v1/{+parent}/certificates', options)
1279
+ command.response_representation = Google::Apis::PrivatecaV1::ListCertificatesResponse::Representation
1280
+ command.response_class = Google::Apis::PrivatecaV1::ListCertificatesResponse
1281
+ command.params['parent'] = parent unless parent.nil?
1282
+ command.query['filter'] = filter unless filter.nil?
1283
+ command.query['orderBy'] = order_by unless order_by.nil?
1284
+ command.query['pageSize'] = page_size unless page_size.nil?
1285
+ command.query['pageToken'] = page_token unless page_token.nil?
1286
+ command.query['fields'] = fields unless fields.nil?
1287
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1288
+ execute_or_queue_command(command, &block)
1289
+ end
1290
+
1291
+ # Update a Certificate. Currently, the only field you can update is the labels
1292
+ # field.
1293
+ # @param [String] name
1294
+ # Output only. The resource name for this Certificate in the format `projects/*/
1295
+ # locations/*/caPools/*/certificates/*`.
1296
+ # @param [Google::Apis::PrivatecaV1::Certificate] certificate_object
1297
+ # @param [String] request_id
1298
+ # Optional. An ID to identify requests. Specify a unique request ID so that if
1299
+ # you must retry your request, the server will know to ignore the request if it
1300
+ # has already been completed. The server will guarantee that for at least 60
1301
+ # minutes since the first request. For example, consider a situation where you
1302
+ # make an initial request and t he request times out. If you make the request
1303
+ # again with the same request ID, the server can check if original operation
1304
+ # with the same request ID was received, and if so, will ignore the second
1305
+ # request. This prevents clients from accidentally creating duplicate
1306
+ # commitments. The request ID must be a valid UUID with the exception that zero
1307
+ # UUID is not supported (00000000-0000-0000-0000-000000000000).
1308
+ # @param [String] update_mask
1309
+ # Required. A list of fields to be updated in this request.
1310
+ # @param [String] fields
1311
+ # Selector specifying which fields to include in a partial response.
1312
+ # @param [String] quota_user
1313
+ # Available to use for quota purposes for server-side applications. Can be any
1314
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1315
+ # @param [Google::Apis::RequestOptions] options
1316
+ # Request-specific options
1317
+ #
1318
+ # @yield [result, err] Result & error if block supplied
1319
+ # @yieldparam result [Google::Apis::PrivatecaV1::Certificate] parsed result object
1320
+ # @yieldparam err [StandardError] error object if request failed
1321
+ #
1322
+ # @return [Google::Apis::PrivatecaV1::Certificate]
1323
+ #
1324
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1325
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1326
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1327
+ def patch_project_location_ca_pool_certificate(name, certificate_object = nil, request_id: nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
1328
+ command = make_simple_command(:patch, 'v1/{+name}', options)
1329
+ command.request_representation = Google::Apis::PrivatecaV1::Certificate::Representation
1330
+ command.request_object = certificate_object
1331
+ command.response_representation = Google::Apis::PrivatecaV1::Certificate::Representation
1332
+ command.response_class = Google::Apis::PrivatecaV1::Certificate
1333
+ command.params['name'] = name unless name.nil?
1334
+ command.query['requestId'] = request_id unless request_id.nil?
1335
+ command.query['updateMask'] = update_mask unless update_mask.nil?
1336
+ command.query['fields'] = fields unless fields.nil?
1337
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1338
+ execute_or_queue_command(command, &block)
1339
+ end
1340
+
1341
+ # Revoke a Certificate.
1342
+ # @param [String] name
1343
+ # Required. The resource name for this Certificate in the format `projects/*/
1344
+ # locations/*/caPools/*/certificates/*`.
1345
+ # @param [Google::Apis::PrivatecaV1::RevokeCertificateRequest] revoke_certificate_request_object
1346
+ # @param [String] fields
1347
+ # Selector specifying which fields to include in a partial response.
1348
+ # @param [String] quota_user
1349
+ # Available to use for quota purposes for server-side applications. Can be any
1350
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1351
+ # @param [Google::Apis::RequestOptions] options
1352
+ # Request-specific options
1353
+ #
1354
+ # @yield [result, err] Result & error if block supplied
1355
+ # @yieldparam result [Google::Apis::PrivatecaV1::Certificate] parsed result object
1356
+ # @yieldparam err [StandardError] error object if request failed
1357
+ #
1358
+ # @return [Google::Apis::PrivatecaV1::Certificate]
1359
+ #
1360
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1361
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1362
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1363
+ def revoke_certificate(name, revoke_certificate_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
1364
+ command = make_simple_command(:post, 'v1/{+name}:revoke', options)
1365
+ command.request_representation = Google::Apis::PrivatecaV1::RevokeCertificateRequest::Representation
1366
+ command.request_object = revoke_certificate_request_object
1367
+ command.response_representation = Google::Apis::PrivatecaV1::Certificate::Representation
1368
+ command.response_class = Google::Apis::PrivatecaV1::Certificate
1369
+ command.params['name'] = name unless name.nil?
1370
+ command.query['fields'] = fields unless fields.nil?
1371
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1372
+ execute_or_queue_command(command, &block)
1373
+ end
1374
+
1375
+ # Create a new CertificateTemplate in a given Project and Location.
1376
+ # @param [String] parent
1377
+ # Required. The resource name of the location associated with the
1378
+ # CertificateTemplate, in the format `projects/*/locations/*`.
1379
+ # @param [Google::Apis::PrivatecaV1::CertificateTemplate] certificate_template_object
1380
+ # @param [String] certificate_template_id
1381
+ # Required. It must be unique within a location and match the regular expression
1382
+ # `[a-zA-Z0-9_-]`1,63``
1383
+ # @param [String] request_id
1384
+ # Optional. An ID to identify requests. Specify a unique request ID so that if
1385
+ # you must retry your request, the server will know to ignore the request if it
1386
+ # has already been completed. The server will guarantee that for at least 60
1387
+ # minutes since the first request. For example, consider a situation where you
1388
+ # make an initial request and t he request times out. If you make the request
1389
+ # again with the same request ID, the server can check if original operation
1390
+ # with the same request ID was received, and if so, will ignore the second
1391
+ # request. This prevents clients from accidentally creating duplicate
1392
+ # commitments. The request ID must be a valid UUID with the exception that zero
1393
+ # UUID is not supported (00000000-0000-0000-0000-000000000000).
1394
+ # @param [String] fields
1395
+ # Selector specifying which fields to include in a partial response.
1396
+ # @param [String] quota_user
1397
+ # Available to use for quota purposes for server-side applications. Can be any
1398
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1399
+ # @param [Google::Apis::RequestOptions] options
1400
+ # Request-specific options
1401
+ #
1402
+ # @yield [result, err] Result & error if block supplied
1403
+ # @yieldparam result [Google::Apis::PrivatecaV1::Operation] parsed result object
1404
+ # @yieldparam err [StandardError] error object if request failed
1405
+ #
1406
+ # @return [Google::Apis::PrivatecaV1::Operation]
1407
+ #
1408
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1409
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1410
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1411
+ def create_project_location_certificate_template(parent, certificate_template_object = nil, certificate_template_id: nil, request_id: nil, fields: nil, quota_user: nil, options: nil, &block)
1412
+ command = make_simple_command(:post, 'v1/{+parent}/certificateTemplates', options)
1413
+ command.request_representation = Google::Apis::PrivatecaV1::CertificateTemplate::Representation
1414
+ command.request_object = certificate_template_object
1415
+ command.response_representation = Google::Apis::PrivatecaV1::Operation::Representation
1416
+ command.response_class = Google::Apis::PrivatecaV1::Operation
1417
+ command.params['parent'] = parent unless parent.nil?
1418
+ command.query['certificateTemplateId'] = certificate_template_id unless certificate_template_id.nil?
1419
+ command.query['requestId'] = request_id unless request_id.nil?
1420
+ command.query['fields'] = fields unless fields.nil?
1421
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1422
+ execute_or_queue_command(command, &block)
1423
+ end
1424
+
1425
+ # DeleteCertificateTemplate deletes a CertificateTemplate.
1426
+ # @param [String] name
1427
+ # Required. The resource name for this CertificateTemplate in the format `
1428
+ # projects/*/locations/*/certificateTemplates/*`.
1429
+ # @param [String] request_id
1430
+ # Optional. An ID to identify requests. Specify a unique request ID so that if
1431
+ # you must retry your request, the server will know to ignore the request if it
1432
+ # has already been completed. The server will guarantee that for at least 60
1433
+ # minutes since the first request. For example, consider a situation where you
1434
+ # make an initial request and t he request times out. If you make the request
1435
+ # again with the same request ID, the server can check if original operation
1436
+ # with the same request ID was received, and if so, will ignore the second
1437
+ # request. This prevents clients from accidentally creating duplicate
1438
+ # commitments. The request ID must be a valid UUID with the exception that zero
1439
+ # UUID is not supported (00000000-0000-0000-0000-000000000000).
1440
+ # @param [String] fields
1441
+ # Selector specifying which fields to include in a partial response.
1442
+ # @param [String] quota_user
1443
+ # Available to use for quota purposes for server-side applications. Can be any
1444
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1445
+ # @param [Google::Apis::RequestOptions] options
1446
+ # Request-specific options
1447
+ #
1448
+ # @yield [result, err] Result & error if block supplied
1449
+ # @yieldparam result [Google::Apis::PrivatecaV1::Operation] parsed result object
1450
+ # @yieldparam err [StandardError] error object if request failed
1451
+ #
1452
+ # @return [Google::Apis::PrivatecaV1::Operation]
1453
+ #
1454
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1455
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1456
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1457
+ def delete_project_location_certificate_template(name, request_id: nil, fields: nil, quota_user: nil, options: nil, &block)
1458
+ command = make_simple_command(:delete, 'v1/{+name}', options)
1459
+ command.response_representation = Google::Apis::PrivatecaV1::Operation::Representation
1460
+ command.response_class = Google::Apis::PrivatecaV1::Operation
1461
+ command.params['name'] = name unless name.nil?
1462
+ command.query['requestId'] = request_id unless request_id.nil?
1463
+ command.query['fields'] = fields unless fields.nil?
1464
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1465
+ execute_or_queue_command(command, &block)
1466
+ end
1467
+
1468
+ # Returns a CertificateTemplate.
1469
+ # @param [String] name
1470
+ # Required. The name of the CertificateTemplate to get.
1471
+ # @param [String] fields
1472
+ # Selector specifying which fields to include in a partial response.
1473
+ # @param [String] quota_user
1474
+ # Available to use for quota purposes for server-side applications. Can be any
1475
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1476
+ # @param [Google::Apis::RequestOptions] options
1477
+ # Request-specific options
1478
+ #
1479
+ # @yield [result, err] Result & error if block supplied
1480
+ # @yieldparam result [Google::Apis::PrivatecaV1::CertificateTemplate] parsed result object
1481
+ # @yieldparam err [StandardError] error object if request failed
1482
+ #
1483
+ # @return [Google::Apis::PrivatecaV1::CertificateTemplate]
1484
+ #
1485
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1486
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1487
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1488
+ def get_project_location_certificate_template(name, fields: nil, quota_user: nil, options: nil, &block)
1489
+ command = make_simple_command(:get, 'v1/{+name}', options)
1490
+ command.response_representation = Google::Apis::PrivatecaV1::CertificateTemplate::Representation
1491
+ command.response_class = Google::Apis::PrivatecaV1::CertificateTemplate
1492
+ command.params['name'] = name unless name.nil?
1493
+ command.query['fields'] = fields unless fields.nil?
1494
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1495
+ execute_or_queue_command(command, &block)
1496
+ end
1497
+
1498
+ # Gets the access control policy for a resource. Returns an empty policy if the
1499
+ # resource exists and does not have a policy set.
1500
+ # @param [String] resource
1501
+ # REQUIRED: The resource for which the policy is being requested. See the
1502
+ # operation documentation for the appropriate value for this field.
1503
+ # @param [Fixnum] options_requested_policy_version
1504
+ # Optional. The policy format version to be returned. Valid values are 0, 1, and
1505
+ # 3. Requests specifying an invalid value will be rejected. Requests for
1506
+ # policies with any conditional bindings must specify version 3. Policies
1507
+ # without any conditional bindings may specify any valid value or leave the
1508
+ # field unset. To learn which resources support conditions in their IAM policies,
1509
+ # see the [IAM documentation](https://cloud.google.com/iam/help/conditions/
1510
+ # resource-policies).
1511
+ # @param [String] fields
1512
+ # Selector specifying which fields to include in a partial response.
1513
+ # @param [String] quota_user
1514
+ # Available to use for quota purposes for server-side applications. Can be any
1515
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1516
+ # @param [Google::Apis::RequestOptions] options
1517
+ # Request-specific options
1518
+ #
1519
+ # @yield [result, err] Result & error if block supplied
1520
+ # @yieldparam result [Google::Apis::PrivatecaV1::Policy] parsed result object
1521
+ # @yieldparam err [StandardError] error object if request failed
1522
+ #
1523
+ # @return [Google::Apis::PrivatecaV1::Policy]
1524
+ #
1525
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1526
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1527
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1528
+ def get_project_location_certificate_template_iam_policy(resource, options_requested_policy_version: nil, fields: nil, quota_user: nil, options: nil, &block)
1529
+ command = make_simple_command(:get, 'v1/{+resource}:getIamPolicy', options)
1530
+ command.response_representation = Google::Apis::PrivatecaV1::Policy::Representation
1531
+ command.response_class = Google::Apis::PrivatecaV1::Policy
1532
+ command.params['resource'] = resource unless resource.nil?
1533
+ command.query['options.requestedPolicyVersion'] = options_requested_policy_version unless options_requested_policy_version.nil?
1534
+ command.query['fields'] = fields unless fields.nil?
1535
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1536
+ execute_or_queue_command(command, &block)
1537
+ end
1538
+
1539
+ # Lists CertificateTemplates.
1540
+ # @param [String] parent
1541
+ # Required. The resource name of the location associated with the
1542
+ # CertificateTemplates, in the format `projects/*/locations/*`.
1543
+ # @param [String] filter
1544
+ # Optional. Only include resources that match the filter in the response.
1545
+ # @param [String] order_by
1546
+ # Optional. Specify how the results should be sorted.
1547
+ # @param [Fixnum] page_size
1548
+ # Optional. Limit on the number of CertificateTemplates to include in the
1549
+ # response. Further CertificateTemplates can subsequently be obtained by
1550
+ # including the ListCertificateTemplatesResponse.next_page_token in a subsequent
1551
+ # request. If unspecified, the server will pick an appropriate default.
1552
+ # @param [String] page_token
1553
+ # Optional. Pagination token, returned earlier via
1554
+ # ListCertificateTemplatesResponse.next_page_token.
1555
+ # @param [String] fields
1556
+ # Selector specifying which fields to include in a partial response.
1557
+ # @param [String] quota_user
1558
+ # Available to use for quota purposes for server-side applications. Can be any
1559
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1560
+ # @param [Google::Apis::RequestOptions] options
1561
+ # Request-specific options
1562
+ #
1563
+ # @yield [result, err] Result & error if block supplied
1564
+ # @yieldparam result [Google::Apis::PrivatecaV1::ListCertificateTemplatesResponse] parsed result object
1565
+ # @yieldparam err [StandardError] error object if request failed
1566
+ #
1567
+ # @return [Google::Apis::PrivatecaV1::ListCertificateTemplatesResponse]
1568
+ #
1569
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1570
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1571
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1572
+ def list_project_location_certificate_templates(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
1573
+ command = make_simple_command(:get, 'v1/{+parent}/certificateTemplates', options)
1574
+ command.response_representation = Google::Apis::PrivatecaV1::ListCertificateTemplatesResponse::Representation
1575
+ command.response_class = Google::Apis::PrivatecaV1::ListCertificateTemplatesResponse
1576
+ command.params['parent'] = parent unless parent.nil?
1577
+ command.query['filter'] = filter unless filter.nil?
1578
+ command.query['orderBy'] = order_by unless order_by.nil?
1579
+ command.query['pageSize'] = page_size unless page_size.nil?
1580
+ command.query['pageToken'] = page_token unless page_token.nil?
1581
+ command.query['fields'] = fields unless fields.nil?
1582
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1583
+ execute_or_queue_command(command, &block)
1584
+ end
1585
+
1586
+ # Update a CertificateTemplate.
1587
+ # @param [String] name
1588
+ # Output only. The resource name for this CertificateTemplate in the format `
1589
+ # projects/*/locations/*/certificateTemplates/*`.
1590
+ # @param [Google::Apis::PrivatecaV1::CertificateTemplate] certificate_template_object
1591
+ # @param [String] request_id
1592
+ # Optional. An ID to identify requests. Specify a unique request ID so that if
1593
+ # you must retry your request, the server will know to ignore the request if it
1594
+ # has already been completed. The server will guarantee that for at least 60
1595
+ # minutes since the first request. For example, consider a situation where you
1596
+ # make an initial request and t he request times out. If you make the request
1597
+ # again with the same request ID, the server can check if original operation
1598
+ # with the same request ID was received, and if so, will ignore the second
1599
+ # request. This prevents clients from accidentally creating duplicate
1600
+ # commitments. The request ID must be a valid UUID with the exception that zero
1601
+ # UUID is not supported (00000000-0000-0000-0000-000000000000).
1602
+ # @param [String] update_mask
1603
+ # Required. A list of fields to be updated in this request.
1604
+ # @param [String] fields
1605
+ # Selector specifying which fields to include in a partial response.
1606
+ # @param [String] quota_user
1607
+ # Available to use for quota purposes for server-side applications. Can be any
1608
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1609
+ # @param [Google::Apis::RequestOptions] options
1610
+ # Request-specific options
1611
+ #
1612
+ # @yield [result, err] Result & error if block supplied
1613
+ # @yieldparam result [Google::Apis::PrivatecaV1::Operation] parsed result object
1614
+ # @yieldparam err [StandardError] error object if request failed
1615
+ #
1616
+ # @return [Google::Apis::PrivatecaV1::Operation]
1617
+ #
1618
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1619
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1620
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1621
+ def patch_project_location_certificate_template(name, certificate_template_object = nil, request_id: nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
1622
+ command = make_simple_command(:patch, 'v1/{+name}', options)
1623
+ command.request_representation = Google::Apis::PrivatecaV1::CertificateTemplate::Representation
1624
+ command.request_object = certificate_template_object
1625
+ command.response_representation = Google::Apis::PrivatecaV1::Operation::Representation
1626
+ command.response_class = Google::Apis::PrivatecaV1::Operation
1627
+ command.params['name'] = name unless name.nil?
1628
+ command.query['requestId'] = request_id unless request_id.nil?
1629
+ command.query['updateMask'] = update_mask unless update_mask.nil?
1630
+ command.query['fields'] = fields unless fields.nil?
1631
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1632
+ execute_or_queue_command(command, &block)
1633
+ end
1634
+
1635
+ # Sets the access control policy on the specified resource. Replaces any
1636
+ # existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `
1637
+ # PERMISSION_DENIED` errors.
1638
+ # @param [String] resource
1639
+ # REQUIRED: The resource for which the policy is being specified. See the
1640
+ # operation documentation for the appropriate value for this field.
1641
+ # @param [Google::Apis::PrivatecaV1::SetIamPolicyRequest] set_iam_policy_request_object
1642
+ # @param [String] fields
1643
+ # Selector specifying which fields to include in a partial response.
1644
+ # @param [String] quota_user
1645
+ # Available to use for quota purposes for server-side applications. Can be any
1646
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1647
+ # @param [Google::Apis::RequestOptions] options
1648
+ # Request-specific options
1649
+ #
1650
+ # @yield [result, err] Result & error if block supplied
1651
+ # @yieldparam result [Google::Apis::PrivatecaV1::Policy] parsed result object
1652
+ # @yieldparam err [StandardError] error object if request failed
1653
+ #
1654
+ # @return [Google::Apis::PrivatecaV1::Policy]
1655
+ #
1656
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1657
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1658
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1659
+ def set_certificate_template_iam_policy(resource, set_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
1660
+ command = make_simple_command(:post, 'v1/{+resource}:setIamPolicy', options)
1661
+ command.request_representation = Google::Apis::PrivatecaV1::SetIamPolicyRequest::Representation
1662
+ command.request_object = set_iam_policy_request_object
1663
+ command.response_representation = Google::Apis::PrivatecaV1::Policy::Representation
1664
+ command.response_class = Google::Apis::PrivatecaV1::Policy
1665
+ command.params['resource'] = resource unless resource.nil?
1666
+ command.query['fields'] = fields unless fields.nil?
1667
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1668
+ execute_or_queue_command(command, &block)
1669
+ end
1670
+
1671
+ # Returns permissions that a caller has on the specified resource. If the
1672
+ # resource does not exist, this will return an empty set of permissions, not a `
1673
+ # NOT_FOUND` error. Note: This operation is designed to be used for building
1674
+ # permission-aware UIs and command-line tools, not for authorization checking.
1675
+ # This operation may "fail open" without warning.
1676
+ # @param [String] resource
1677
+ # REQUIRED: The resource for which the policy detail is being requested. See the
1678
+ # operation documentation for the appropriate value for this field.
1679
+ # @param [Google::Apis::PrivatecaV1::TestIamPermissionsRequest] test_iam_permissions_request_object
1680
+ # @param [String] fields
1681
+ # Selector specifying which fields to include in a partial response.
1682
+ # @param [String] quota_user
1683
+ # Available to use for quota purposes for server-side applications. Can be any
1684
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1685
+ # @param [Google::Apis::RequestOptions] options
1686
+ # Request-specific options
1687
+ #
1688
+ # @yield [result, err] Result & error if block supplied
1689
+ # @yieldparam result [Google::Apis::PrivatecaV1::TestIamPermissionsResponse] parsed result object
1690
+ # @yieldparam err [StandardError] error object if request failed
1691
+ #
1692
+ # @return [Google::Apis::PrivatecaV1::TestIamPermissionsResponse]
1693
+ #
1694
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1695
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1696
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1697
+ def test_certificate_template_iam_permissions(resource, test_iam_permissions_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
1698
+ command = make_simple_command(:post, 'v1/{+resource}:testIamPermissions', options)
1699
+ command.request_representation = Google::Apis::PrivatecaV1::TestIamPermissionsRequest::Representation
1700
+ command.request_object = test_iam_permissions_request_object
1701
+ command.response_representation = Google::Apis::PrivatecaV1::TestIamPermissionsResponse::Representation
1702
+ command.response_class = Google::Apis::PrivatecaV1::TestIamPermissionsResponse
1703
+ command.params['resource'] = resource unless resource.nil?
1704
+ command.query['fields'] = fields unless fields.nil?
1705
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1706
+ execute_or_queue_command(command, &block)
1707
+ end
1708
+
1709
+ # Starts asynchronous cancellation on a long-running operation. The server makes
1710
+ # a best effort to cancel the operation, but success is not guaranteed. If the
1711
+ # server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.
1712
+ # Clients can use Operations.GetOperation or other methods to check whether the
1713
+ # cancellation succeeded or whether the operation completed despite cancellation.
1714
+ # On successful cancellation, the operation is not deleted; instead, it becomes
1715
+ # an operation with an Operation.error value with a google.rpc.Status.code of 1,
1716
+ # corresponding to `Code.CANCELLED`.
1717
+ # @param [String] name
1718
+ # The name of the operation resource to be cancelled.
1719
+ # @param [Google::Apis::PrivatecaV1::CancelOperationRequest] cancel_operation_request_object
1720
+ # @param [String] fields
1721
+ # Selector specifying which fields to include in a partial response.
1722
+ # @param [String] quota_user
1723
+ # Available to use for quota purposes for server-side applications. Can be any
1724
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1725
+ # @param [Google::Apis::RequestOptions] options
1726
+ # Request-specific options
1727
+ #
1728
+ # @yield [result, err] Result & error if block supplied
1729
+ # @yieldparam result [Google::Apis::PrivatecaV1::Empty] parsed result object
1730
+ # @yieldparam err [StandardError] error object if request failed
1731
+ #
1732
+ # @return [Google::Apis::PrivatecaV1::Empty]
1733
+ #
1734
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1735
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1736
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1737
+ def cancel_operation(name, cancel_operation_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
1738
+ command = make_simple_command(:post, 'v1/{+name}:cancel', options)
1739
+ command.request_representation = Google::Apis::PrivatecaV1::CancelOperationRequest::Representation
1740
+ command.request_object = cancel_operation_request_object
1741
+ command.response_representation = Google::Apis::PrivatecaV1::Empty::Representation
1742
+ command.response_class = Google::Apis::PrivatecaV1::Empty
1743
+ command.params['name'] = name unless name.nil?
1744
+ command.query['fields'] = fields unless fields.nil?
1745
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1746
+ execute_or_queue_command(command, &block)
1747
+ end
1748
+
1749
+ # Deletes a long-running operation. This method indicates that the client is no
1750
+ # longer interested in the operation result. It does not cancel the operation.
1751
+ # If the server doesn't support this method, it returns `google.rpc.Code.
1752
+ # UNIMPLEMENTED`.
1753
+ # @param [String] name
1754
+ # The name of the operation resource to be deleted.
1755
+ # @param [String] fields
1756
+ # Selector specifying which fields to include in a partial response.
1757
+ # @param [String] quota_user
1758
+ # Available to use for quota purposes for server-side applications. Can be any
1759
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1760
+ # @param [Google::Apis::RequestOptions] options
1761
+ # Request-specific options
1762
+ #
1763
+ # @yield [result, err] Result & error if block supplied
1764
+ # @yieldparam result [Google::Apis::PrivatecaV1::Empty] parsed result object
1765
+ # @yieldparam err [StandardError] error object if request failed
1766
+ #
1767
+ # @return [Google::Apis::PrivatecaV1::Empty]
1768
+ #
1769
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1770
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1771
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1772
+ def delete_project_location_operation(name, fields: nil, quota_user: nil, options: nil, &block)
1773
+ command = make_simple_command(:delete, 'v1/{+name}', options)
1774
+ command.response_representation = Google::Apis::PrivatecaV1::Empty::Representation
1775
+ command.response_class = Google::Apis::PrivatecaV1::Empty
1776
+ command.params['name'] = name unless name.nil?
1777
+ command.query['fields'] = fields unless fields.nil?
1778
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1779
+ execute_or_queue_command(command, &block)
1780
+ end
1781
+
1782
+ # Gets the latest state of a long-running operation. Clients can use this method
1783
+ # to poll the operation result at intervals as recommended by the API service.
1784
+ # @param [String] name
1785
+ # The name of the operation resource.
1786
+ # @param [String] fields
1787
+ # Selector specifying which fields to include in a partial response.
1788
+ # @param [String] quota_user
1789
+ # Available to use for quota purposes for server-side applications. Can be any
1790
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1791
+ # @param [Google::Apis::RequestOptions] options
1792
+ # Request-specific options
1793
+ #
1794
+ # @yield [result, err] Result & error if block supplied
1795
+ # @yieldparam result [Google::Apis::PrivatecaV1::Operation] parsed result object
1796
+ # @yieldparam err [StandardError] error object if request failed
1797
+ #
1798
+ # @return [Google::Apis::PrivatecaV1::Operation]
1799
+ #
1800
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1801
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1802
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1803
+ def get_project_location_operation(name, fields: nil, quota_user: nil, options: nil, &block)
1804
+ command = make_simple_command(:get, 'v1/{+name}', options)
1805
+ command.response_representation = Google::Apis::PrivatecaV1::Operation::Representation
1806
+ command.response_class = Google::Apis::PrivatecaV1::Operation
1807
+ command.params['name'] = name unless name.nil?
1808
+ command.query['fields'] = fields unless fields.nil?
1809
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1810
+ execute_or_queue_command(command, &block)
1811
+ end
1812
+
1813
+ # Lists operations that match the specified filter in the request. If the server
1814
+ # doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name`
1815
+ # binding allows API services to override the binding to use different resource
1816
+ # name schemes, such as `users/*/operations`. To override the binding, API
1817
+ # services can add a binding such as `"/v1/`name=users/*`/operations"` to their
1818
+ # service configuration. For backwards compatibility, the default name includes
1819
+ # the operations collection id, however overriding users must ensure the name
1820
+ # binding is the parent resource, without the operations collection id.
1821
+ # @param [String] name
1822
+ # The name of the operation's parent resource.
1823
+ # @param [String] filter
1824
+ # The standard list filter.
1825
+ # @param [Fixnum] page_size
1826
+ # The standard list page size.
1827
+ # @param [String] page_token
1828
+ # The standard list page token.
1829
+ # @param [String] fields
1830
+ # Selector specifying which fields to include in a partial response.
1831
+ # @param [String] quota_user
1832
+ # Available to use for quota purposes for server-side applications. Can be any
1833
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1834
+ # @param [Google::Apis::RequestOptions] options
1835
+ # Request-specific options
1836
+ #
1837
+ # @yield [result, err] Result & error if block supplied
1838
+ # @yieldparam result [Google::Apis::PrivatecaV1::ListOperationsResponse] parsed result object
1839
+ # @yieldparam err [StandardError] error object if request failed
1840
+ #
1841
+ # @return [Google::Apis::PrivatecaV1::ListOperationsResponse]
1842
+ #
1843
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1844
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1845
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1846
+ def list_project_location_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
1847
+ command = make_simple_command(:get, 'v1/{+name}/operations', options)
1848
+ command.response_representation = Google::Apis::PrivatecaV1::ListOperationsResponse::Representation
1849
+ command.response_class = Google::Apis::PrivatecaV1::ListOperationsResponse
1850
+ command.params['name'] = name unless name.nil?
1851
+ command.query['filter'] = filter unless filter.nil?
1852
+ command.query['pageSize'] = page_size unless page_size.nil?
1853
+ command.query['pageToken'] = page_token unless page_token.nil?
1854
+ command.query['fields'] = fields unless fields.nil?
1855
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1856
+ execute_or_queue_command(command, &block)
1857
+ end
1858
+
1859
+ protected
1860
+
1861
+ def apply_command_defaults(command)
1862
+ command.query['key'] = key unless key.nil?
1863
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1864
+ end
1865
+ end
1866
+ end
1867
+ end
1868
+ end