google-cloud-security-private_ca-v1 0.3.0 → 0.5.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -19,7 +19,7 @@
19
19
  require "google/cloud/errors"
20
20
  require "google/cloud/security/privateca/v1/service_pb"
21
21
  require "google/cloud/location"
22
- require "google/iam/v1/iam_policy"
22
+ require "google/iam/v1"
23
23
 
24
24
  module Google
25
25
  module Cloud
@@ -30,8 +30,9 @@ module Google
30
30
  ##
31
31
  # Client for the CertificateAuthorityService service.
32
32
  #
33
- # {::Google::Cloud::Security::PrivateCA::V1::CertificateAuthorityService::Client Certificate Authority Service} manages private
34
- # certificate authorities and issued certificates.
33
+ # [Certificate Authority
34
+ # Service][google.cloud.security.privateca.v1.CertificateAuthorityService]
35
+ # manages private certificate authorities and issued certificates.
35
36
  #
36
37
  class Client
37
38
  include Paths
@@ -193,7 +194,8 @@ module Google
193
194
  # Service calls
194
195
 
195
196
  ##
196
- # Create a new {::Google::Cloud::Security::PrivateCA::V1::Certificate Certificate} in a given Project, Location from a particular
197
+ # Create a new {::Google::Cloud::Security::PrivateCA::V1::Certificate Certificate}
198
+ # in a given Project, Location from a particular
197
199
  # {::Google::Cloud::Security::PrivateCA::V1::CaPool CaPool}.
198
200
  #
199
201
  # @overload create_certificate(request, options = nil)
@@ -212,20 +214,24 @@ module Google
212
214
  # the default parameter values, pass an empty Hash as a request object (see above).
213
215
  #
214
216
  # @param parent [::String]
215
- # Required. The resource name of the {::Google::Cloud::Security::PrivateCA::V1::CaPool CaPool} associated with the {::Google::Cloud::Security::PrivateCA::V1::Certificate Certificate},
216
- # in the format `projects/*/locations/*/caPools/*`.
217
+ # Required. The resource name of the
218
+ # {::Google::Cloud::Security::PrivateCA::V1::CaPool CaPool} associated with the
219
+ # {::Google::Cloud::Security::PrivateCA::V1::Certificate Certificate}, in the
220
+ # format `projects/*/locations/*/caPools/*`.
217
221
  # @param certificate_id [::String]
218
222
  # Optional. It must be unique within a location and match the regular
219
223
  # expression `[a-zA-Z0-9_-]{1,63}`. This field is required when using a
220
- # {::Google::Cloud::Security::PrivateCA::V1::CertificateAuthority CertificateAuthority} in the Enterprise [CertificateAuthority.Tier][],
221
- # but is optional and its value is ignored otherwise.
224
+ # {::Google::Cloud::Security::PrivateCA::V1::CertificateAuthority CertificateAuthority}
225
+ # in the Enterprise [CertificateAuthority.Tier][], but is optional and its
226
+ # value is ignored otherwise.
222
227
  # @param certificate [::Google::Cloud::Security::PrivateCA::V1::Certificate, ::Hash]
223
- # Required. A {::Google::Cloud::Security::PrivateCA::V1::Certificate Certificate} with initial field values.
228
+ # Required. A {::Google::Cloud::Security::PrivateCA::V1::Certificate Certificate}
229
+ # with initial field values.
224
230
  # @param request_id [::String]
225
- # Optional. An ID to identify requests. Specify a unique request ID so that if you must
226
- # retry your request, the server will know to ignore the request if it has
227
- # already been completed. The server will guarantee that for at least 60
228
- # minutes since the first request.
231
+ # Optional. An ID to identify requests. Specify a unique request ID so that
232
+ # if you must retry your request, the server will know to ignore the request
233
+ # if it has already been completed. The server will guarantee that for at
234
+ # least 60 minutes since the first request.
229
235
  #
230
236
  # For example, consider a situation where you make an initial request and the
231
237
  # request times out. If you make the request again with the same request ID,
@@ -236,21 +242,34 @@ module Google
236
242
  # The request ID must be a valid UUID with the exception that zero UUID is
237
243
  # not supported (00000000-0000-0000-0000-000000000000).
238
244
  # @param validate_only [::Boolean]
239
- # Optional. If this is true, no {::Google::Cloud::Security::PrivateCA::V1::Certificate Certificate} resource will be persisted regardless
240
- # of the {::Google::Cloud::Security::PrivateCA::V1::CaPool CaPool}'s {::Google::Cloud::Security::PrivateCA::V1::CaPool#tier tier}, and the returned {::Google::Cloud::Security::PrivateCA::V1::Certificate Certificate}
241
- # will not contain the {::Google::Cloud::Security::PrivateCA::V1::Certificate#pem_certificate pem_certificate} field.
245
+ # Optional. If this is true, no
246
+ # {::Google::Cloud::Security::PrivateCA::V1::Certificate Certificate} resource will
247
+ # be persisted regardless of the
248
+ # {::Google::Cloud::Security::PrivateCA::V1::CaPool CaPool}'s
249
+ # {::Google::Cloud::Security::PrivateCA::V1::CaPool#tier tier}, and the returned
250
+ # {::Google::Cloud::Security::PrivateCA::V1::Certificate Certificate} will not
251
+ # contain the
252
+ # {::Google::Cloud::Security::PrivateCA::V1::Certificate#pem_certificate pem_certificate}
253
+ # field.
242
254
  # @param issuing_certificate_authority_id [::String]
243
- # Optional. The resource ID of the {::Google::Cloud::Security::PrivateCA::V1::CertificateAuthority CertificateAuthority} that should issue the
244
- # certificate. This optional field will ignore the load-balancing scheme of
245
- # the Pool and directly issue the certificate from the CA with the specified
246
- # ID, contained in the same {::Google::Cloud::Security::PrivateCA::V1::CaPool CaPool} referenced by `parent`. Per-CA quota
247
- # rules apply. If left empty, a {::Google::Cloud::Security::PrivateCA::V1::CertificateAuthority CertificateAuthority} will be chosen from
248
- # the {::Google::Cloud::Security::PrivateCA::V1::CaPool CaPool} by the service. For example, to issue a {::Google::Cloud::Security::PrivateCA::V1::Certificate Certificate} from
249
- # a Certificate Authority with resource name
255
+ # Optional. The resource ID of the
256
+ # {::Google::Cloud::Security::PrivateCA::V1::CertificateAuthority CertificateAuthority}
257
+ # that should issue the certificate. This optional field will ignore the
258
+ # load-balancing scheme of the Pool and directly issue the certificate from
259
+ # the CA with the specified ID, contained in the same
260
+ # {::Google::Cloud::Security::PrivateCA::V1::CaPool CaPool} referenced by `parent`.
261
+ # Per-CA quota rules apply. If left empty, a
262
+ # {::Google::Cloud::Security::PrivateCA::V1::CertificateAuthority CertificateAuthority}
263
+ # will be chosen from the {::Google::Cloud::Security::PrivateCA::V1::CaPool CaPool}
264
+ # by the service. For example, to issue a
265
+ # {::Google::Cloud::Security::PrivateCA::V1::Certificate Certificate} from a
266
+ # Certificate Authority with resource name
250
267
  # "projects/my-project/locations/us-central1/caPools/my-pool/certificateAuthorities/my-ca",
251
- # you can set the {::Google::Cloud::Security::PrivateCA::V1::CreateCertificateRequest#parent parent} to
252
- # "projects/my-project/locations/us-central1/caPools/my-pool" and the
253
- # {::Google::Cloud::Security::PrivateCA::V1::CreateCertificateRequest#issuing_certificate_authority_id issuing_certificate_authority_id} to "my-ca".
268
+ # you can set the
269
+ # {::Google::Cloud::Security::PrivateCA::V1::CreateCertificateRequest#parent parent}
270
+ # to "projects/my-project/locations/us-central1/caPools/my-pool" and the
271
+ # {::Google::Cloud::Security::PrivateCA::V1::CreateCertificateRequest#issuing_certificate_authority_id issuing_certificate_authority_id}
272
+ # to "my-ca".
254
273
  #
255
274
  # @yield [response, operation] Access the result along with the RPC operation
256
275
  # @yieldparam response [::Google::Cloud::Security::PrivateCA::V1::Certificate]
@@ -335,7 +354,9 @@ module Google
335
354
  # the default parameter values, pass an empty Hash as a request object (see above).
336
355
  #
337
356
  # @param name [::String]
338
- # Required. The {::Google::Cloud::Security::PrivateCA::V1::Certificate#name name} of the {::Google::Cloud::Security::PrivateCA::V1::Certificate Certificate} to get.
357
+ # Required. The {::Google::Cloud::Security::PrivateCA::V1::Certificate#name name}
358
+ # of the {::Google::Cloud::Security::PrivateCA::V1::Certificate Certificate} to
359
+ # get.
339
360
  #
340
361
  # @yield [response, operation] Access the result along with the RPC operation
341
362
  # @yieldparam response [::Google::Cloud::Security::PrivateCA::V1::Certificate]
@@ -421,25 +442,27 @@ module Google
421
442
  #
422
443
  # @param parent [::String]
423
444
  # Required. The resource name of the location associated with the
424
- # {::Google::Cloud::Security::PrivateCA::V1::Certificate Certificates}, in the format
425
- # `projects/*/locations/*/caPools/*`.
445
+ # {::Google::Cloud::Security::PrivateCA::V1::Certificate Certificates}, in the
446
+ # format `projects/*/locations/*/caPools/*`.
426
447
  # @param page_size [::Integer]
427
448
  # Optional. Limit on the number of
428
- # {::Google::Cloud::Security::PrivateCA::V1::Certificate Certificates} to include in the
429
- # response. Further {::Google::Cloud::Security::PrivateCA::V1::Certificate Certificates} can subsequently be obtained
430
- # by including the
431
- # {::Google::Cloud::Security::PrivateCA::V1::ListCertificatesResponse#next_page_token ListCertificatesResponse.next_page_token} in a subsequent
432
- # request. If unspecified, the server will pick an appropriate default.
449
+ # {::Google::Cloud::Security::PrivateCA::V1::Certificate Certificates} to include
450
+ # in the response. Further
451
+ # {::Google::Cloud::Security::PrivateCA::V1::Certificate Certificates} can
452
+ # subsequently be obtained by including the
453
+ # {::Google::Cloud::Security::PrivateCA::V1::ListCertificatesResponse#next_page_token ListCertificatesResponse.next_page_token}
454
+ # in a subsequent request. If unspecified, the server will pick an
455
+ # appropriate default.
433
456
  # @param page_token [::String]
434
457
  # Optional. Pagination token, returned earlier via
435
458
  # {::Google::Cloud::Security::PrivateCA::V1::ListCertificatesResponse#next_page_token ListCertificatesResponse.next_page_token}.
436
459
  # @param filter [::String]
437
- # Optional. Only include resources that match the filter in the response. For details
438
- # on supported filters and syntax, see [Certificates Filtering
460
+ # Optional. Only include resources that match the filter in the response. For
461
+ # details on supported filters and syntax, see [Certificates Filtering
439
462
  # documentation](https://cloud.google.com/certificate-authority-service/docs/sorting-filtering-certificates#filtering_support).
440
463
  # @param order_by [::String]
441
- # Optional. Specify how the results should be sorted. For details on supported fields
442
- # and syntax, see [Certificates Sorting
464
+ # Optional. Specify how the results should be sorted. For details on
465
+ # supported fields and syntax, see [Certificates Sorting
443
466
  # documentation](https://cloud.google.com/certificate-authority-service/docs/sorting-filtering-certificates#sorting_support).
444
467
  #
445
468
  # @yield [response, operation] Access the result along with the RPC operation
@@ -462,13 +485,11 @@ module Google
462
485
  # # Call the list_certificates method.
463
486
  # result = client.list_certificates request
464
487
  #
465
- # # The returned object is of type Gapic::PagedEnumerable. You can
466
- # # iterate over all elements by calling #each, and the enumerable
467
- # # will lazily make API calls to fetch subsequent pages. Other
468
- # # methods are also available for managing paging directly.
469
- # result.each do |response|
488
+ # # The returned object is of type Gapic::PagedEnumerable. You can iterate
489
+ # # over elements, and API calls will be issued to fetch pages as needed.
490
+ # result.each do |item|
470
491
  # # Each element is of type ::Google::Cloud::Security::PrivateCA::V1::Certificate.
471
- # p response
492
+ # p item
472
493
  # end
473
494
  #
474
495
  def list_certificates request, options = nil
@@ -532,19 +553,21 @@ module Google
532
553
  # the default parameter values, pass an empty Hash as a request object (see above).
533
554
  #
534
555
  # @param name [::String]
535
- # Required. The resource name for this {::Google::Cloud::Security::PrivateCA::V1::Certificate Certificate} in the
536
- # format
556
+ # Required. The resource name for this
557
+ # {::Google::Cloud::Security::PrivateCA::V1::Certificate Certificate} in the format
537
558
  # `projects/*/locations/*/caPools/*/certificates/*`.
538
559
  # @param reason [::Google::Cloud::Security::PrivateCA::V1::RevocationReason]
539
- # Required. The {::Google::Cloud::Security::PrivateCA::V1::RevocationReason RevocationReason} for revoking this certificate.
560
+ # Required. The
561
+ # {::Google::Cloud::Security::PrivateCA::V1::RevocationReason RevocationReason} for
562
+ # revoking this certificate.
540
563
  # @param request_id [::String]
541
- # Optional. An ID to identify requests. Specify a unique request ID so that if you must
542
- # retry your request, the server will know to ignore the request if it has
543
- # already been completed. The server will guarantee that for at least 60
544
- # minutes since the first request.
564
+ # Optional. An ID to identify requests. Specify a unique request ID so that
565
+ # if you must retry your request, the server will know to ignore the request
566
+ # if it has already been completed. The server will guarantee that for at
567
+ # least 60 minutes since the first request.
545
568
  #
546
- # For example, consider a situation where you make an initial request and t
547
- # he request times out. If you make the request again with the same request
569
+ # For example, consider a situation where you make an initial request and
570
+ # the request times out. If you make the request again with the same request
548
571
  # ID, the server can check if original operation with the same request ID
549
572
  # was received, and if so, will ignore the second request. This prevents
550
573
  # clients from accidentally creating duplicate commitments.
@@ -617,7 +640,8 @@ module Google
617
640
  end
618
641
 
619
642
  ##
620
- # Update a {::Google::Cloud::Security::PrivateCA::V1::Certificate Certificate}. Currently, the only field you can update is the
643
+ # Update a {::Google::Cloud::Security::PrivateCA::V1::Certificate Certificate}.
644
+ # Currently, the only field you can update is the
621
645
  # {::Google::Cloud::Security::PrivateCA::V1::Certificate#labels labels} field.
622
646
  #
623
647
  # @overload update_certificate(request, options = nil)
@@ -636,17 +660,18 @@ module Google
636
660
  # the default parameter values, pass an empty Hash as a request object (see above).
637
661
  #
638
662
  # @param certificate [::Google::Cloud::Security::PrivateCA::V1::Certificate, ::Hash]
639
- # Required. {::Google::Cloud::Security::PrivateCA::V1::Certificate Certificate} with updated values.
663
+ # Required. {::Google::Cloud::Security::PrivateCA::V1::Certificate Certificate}
664
+ # with updated values.
640
665
  # @param update_mask [::Google::Protobuf::FieldMask, ::Hash]
641
666
  # Required. A list of fields to be updated in this request.
642
667
  # @param request_id [::String]
643
- # Optional. An ID to identify requests. Specify a unique request ID so that if you must
644
- # retry your request, the server will know to ignore the request if it has
645
- # already been completed. The server will guarantee that for at least 60
646
- # minutes since the first request.
668
+ # Optional. An ID to identify requests. Specify a unique request ID so that
669
+ # if you must retry your request, the server will know to ignore the request
670
+ # if it has already been completed. The server will guarantee that for at
671
+ # least 60 minutes since the first request.
647
672
  #
648
- # For example, consider a situation where you make an initial request and t
649
- # he request times out. If you make the request again with the same request
673
+ # For example, consider a situation where you make an initial request and
674
+ # the request times out. If you make the request again with the same request
650
675
  # ID, the server can check if original operation with the same request ID
651
676
  # was received, and if so, will ignore the second request. This prevents
652
677
  # clients from accidentally creating duplicate commitments.
@@ -719,12 +744,16 @@ module Google
719
744
  end
720
745
 
721
746
  ##
722
- # Activate a {::Google::Cloud::Security::PrivateCA::V1::CertificateAuthority CertificateAuthority} that is in state
747
+ # Activate a
748
+ # {::Google::Cloud::Security::PrivateCA::V1::CertificateAuthority CertificateAuthority}
749
+ # that is in state
723
750
  # {::Google::Cloud::Security::PrivateCA::V1::CertificateAuthority::State::AWAITING_USER_ACTIVATION AWAITING_USER_ACTIVATION}
724
- # and is of type {::Google::Cloud::Security::PrivateCA::V1::CertificateAuthority::Type::SUBORDINATE SUBORDINATE}. After
725
- # the parent Certificate Authority signs a certificate signing request from
726
- # {::Google::Cloud::Security::PrivateCA::V1::CertificateAuthorityService::Client#fetch_certificate_authority_csr FetchCertificateAuthorityCsr}, this method can complete the activation
727
- # process.
751
+ # and is of type
752
+ # {::Google::Cloud::Security::PrivateCA::V1::CertificateAuthority::Type::SUBORDINATE SUBORDINATE}.
753
+ # After the parent Certificate Authority signs a certificate signing request
754
+ # from
755
+ # {::Google::Cloud::Security::PrivateCA::V1::CertificateAuthorityService::Client#fetch_certificate_authority_csr FetchCertificateAuthorityCsr},
756
+ # this method can complete the activation process.
728
757
  #
729
758
  # @overload activate_certificate_authority(request, options = nil)
730
759
  # Pass arguments to `activate_certificate_authority` via a request object, either of type
@@ -742,22 +771,23 @@ module Google
742
771
  # the default parameter values, pass an empty Hash as a request object (see above).
743
772
  #
744
773
  # @param name [::String]
745
- # Required. The resource name for this {::Google::Cloud::Security::PrivateCA::V1::CertificateAuthority CertificateAuthority} in the
746
- # format `projects/*/locations/*/caPools/*/certificateAuthorities/*`.
774
+ # Required. The resource name for this
775
+ # {::Google::Cloud::Security::PrivateCA::V1::CertificateAuthority CertificateAuthority}
776
+ # in the format `projects/*/locations/*/caPools/*/certificateAuthorities/*`.
747
777
  # @param pem_ca_certificate [::String]
748
778
  # Required. The signed CA certificate issued from
749
779
  # {::Google::Cloud::Security::PrivateCA::V1::FetchCertificateAuthorityCsrResponse#pem_csr FetchCertificateAuthorityCsrResponse.pem_csr}.
750
780
  # @param subordinate_config [::Google::Cloud::Security::PrivateCA::V1::SubordinateConfig, ::Hash]
751
- # Required. Must include information about the issuer of 'pem_ca_certificate', and any
752
- # further issuers until the self-signed CA.
781
+ # Required. Must include information about the issuer of
782
+ # 'pem_ca_certificate', and any further issuers until the self-signed CA.
753
783
  # @param request_id [::String]
754
- # Optional. An ID to identify requests. Specify a unique request ID so that if you must
755
- # retry your request, the server will know to ignore the request if it has
756
- # already been completed. The server will guarantee that for at least 60
757
- # minutes since the first request.
784
+ # Optional. An ID to identify requests. Specify a unique request ID so that
785
+ # if you must retry your request, the server will know to ignore the request
786
+ # if it has already been completed. The server will guarantee that for at
787
+ # least 60 minutes since the first request.
758
788
  #
759
- # For example, consider a situation where you make an initial request and t
760
- # he request times out. If you make the request again with the same request
789
+ # For example, consider a situation where you make an initial request and
790
+ # the request times out. If you make the request again with the same request
761
791
  # ID, the server can check if original operation with the same request ID
762
792
  # was received, and if so, will ignore the second request. This prevents
763
793
  # clients from accidentally creating duplicate commitments.
@@ -785,14 +815,14 @@ module Google
785
815
  # # Call the activate_certificate_authority method.
786
816
  # result = client.activate_certificate_authority request
787
817
  #
788
- # # The returned object is of type Gapic::Operation. You can use this
789
- # # object to check the status of an operation, cancel it, or wait
790
- # # for results. Here is how to block until completion:
818
+ # # The returned object is of type Gapic::Operation. You can use it to
819
+ # # check the status of an operation, cancel it, or wait for results.
820
+ # # Here is how to wait for a response.
791
821
  # result.wait_until_done! timeout: 60
792
822
  # if result.response?
793
823
  # p result.response
794
824
  # else
795
- # puts "Error!"
825
+ # puts "No response received."
796
826
  # end
797
827
  #
798
828
  def activate_certificate_authority request, options = nil
@@ -838,7 +868,9 @@ module Google
838
868
  end
839
869
 
840
870
  ##
841
- # Create a new {::Google::Cloud::Security::PrivateCA::V1::CertificateAuthority CertificateAuthority} in a given Project and Location.
871
+ # Create a new
872
+ # {::Google::Cloud::Security::PrivateCA::V1::CertificateAuthority CertificateAuthority}
873
+ # in a given Project and Location.
842
874
  #
843
875
  # @overload create_certificate_authority(request, options = nil)
844
876
  # Pass arguments to `create_certificate_authority` via a request object, either of type
@@ -856,22 +888,25 @@ module Google
856
888
  # the default parameter values, pass an empty Hash as a request object (see above).
857
889
  #
858
890
  # @param parent [::String]
859
- # Required. The resource name of the {::Google::Cloud::Security::PrivateCA::V1::CaPool CaPool} associated with the
860
- # {::Google::Cloud::Security::PrivateCA::V1::CertificateAuthority CertificateAuthorities}, in the format
861
- # `projects/*/locations/*/caPools/*`.
891
+ # Required. The resource name of the
892
+ # {::Google::Cloud::Security::PrivateCA::V1::CaPool CaPool} associated with the
893
+ # {::Google::Cloud::Security::PrivateCA::V1::CertificateAuthority CertificateAuthorities},
894
+ # in the format `projects/*/locations/*/caPools/*`.
862
895
  # @param certificate_authority_id [::String]
863
896
  # Required. It must be unique within a location and match the regular
864
897
  # expression `[a-zA-Z0-9_-]{1,63}`
865
898
  # @param certificate_authority [::Google::Cloud::Security::PrivateCA::V1::CertificateAuthority, ::Hash]
866
- # Required. A {::Google::Cloud::Security::PrivateCA::V1::CertificateAuthority CertificateAuthority} with initial field values.
899
+ # Required. A
900
+ # {::Google::Cloud::Security::PrivateCA::V1::CertificateAuthority CertificateAuthority}
901
+ # with initial field values.
867
902
  # @param request_id [::String]
868
- # Optional. An ID to identify requests. Specify a unique request ID so that if you must
869
- # retry your request, the server will know to ignore the request if it has
870
- # already been completed. The server will guarantee that for at least 60
871
- # minutes since the first request.
903
+ # Optional. An ID to identify requests. Specify a unique request ID so that
904
+ # if you must retry your request, the server will know to ignore the request
905
+ # if it has already been completed. The server will guarantee that for at
906
+ # least 60 minutes since the first request.
872
907
  #
873
- # For example, consider a situation where you make an initial request and t
874
- # he request times out. If you make the request again with the same request
908
+ # For example, consider a situation where you make an initial request and
909
+ # the request times out. If you make the request again with the same request
875
910
  # ID, the server can check if original operation with the same request ID
876
911
  # was received, and if so, will ignore the second request. This prevents
877
912
  # clients from accidentally creating duplicate commitments.
@@ -899,14 +934,14 @@ module Google
899
934
  # # Call the create_certificate_authority method.
900
935
  # result = client.create_certificate_authority request
901
936
  #
902
- # # The returned object is of type Gapic::Operation. You can use this
903
- # # object to check the status of an operation, cancel it, or wait
904
- # # for results. Here is how to block until completion:
937
+ # # The returned object is of type Gapic::Operation. You can use it to
938
+ # # check the status of an operation, cancel it, or wait for results.
939
+ # # Here is how to wait for a response.
905
940
  # result.wait_until_done! timeout: 60
906
941
  # if result.response?
907
942
  # p result.response
908
943
  # else
909
- # puts "Error!"
944
+ # puts "No response received."
910
945
  # end
911
946
  #
912
947
  def create_certificate_authority request, options = nil
@@ -952,7 +987,8 @@ module Google
952
987
  end
953
988
 
954
989
  ##
955
- # Disable a {::Google::Cloud::Security::PrivateCA::V1::CertificateAuthority CertificateAuthority}.
990
+ # Disable a
991
+ # {::Google::Cloud::Security::PrivateCA::V1::CertificateAuthority CertificateAuthority}.
956
992
  #
957
993
  # @overload disable_certificate_authority(request, options = nil)
958
994
  # Pass arguments to `disable_certificate_authority` via a request object, either of type
@@ -970,16 +1006,17 @@ module Google
970
1006
  # the default parameter values, pass an empty Hash as a request object (see above).
971
1007
  #
972
1008
  # @param name [::String]
973
- # Required. The resource name for this {::Google::Cloud::Security::PrivateCA::V1::CertificateAuthority CertificateAuthority} in the
974
- # format `projects/*/locations/*/caPools/*/certificateAuthorities/*`.
1009
+ # Required. The resource name for this
1010
+ # {::Google::Cloud::Security::PrivateCA::V1::CertificateAuthority CertificateAuthority}
1011
+ # in the format `projects/*/locations/*/caPools/*/certificateAuthorities/*`.
975
1012
  # @param request_id [::String]
976
- # Optional. An ID to identify requests. Specify a unique request ID so that if you must
977
- # retry your request, the server will know to ignore the request if it has
978
- # already been completed. The server will guarantee that for at least 60
979
- # minutes since the first request.
1013
+ # Optional. An ID to identify requests. Specify a unique request ID so that
1014
+ # if you must retry your request, the server will know to ignore the request
1015
+ # if it has already been completed. The server will guarantee that for at
1016
+ # least 60 minutes since the first request.
980
1017
  #
981
- # For example, consider a situation where you make an initial request and t
982
- # he request times out. If you make the request again with the same request
1018
+ # For example, consider a situation where you make an initial request and
1019
+ # the request times out. If you make the request again with the same request
983
1020
  # ID, the server can check if original operation with the same request ID
984
1021
  # was received, and if so, will ignore the second request. This prevents
985
1022
  # clients from accidentally creating duplicate commitments.
@@ -1007,14 +1044,14 @@ module Google
1007
1044
  # # Call the disable_certificate_authority method.
1008
1045
  # result = client.disable_certificate_authority request
1009
1046
  #
1010
- # # The returned object is of type Gapic::Operation. You can use this
1011
- # # object to check the status of an operation, cancel it, or wait
1012
- # # for results. Here is how to block until completion:
1047
+ # # The returned object is of type Gapic::Operation. You can use it to
1048
+ # # check the status of an operation, cancel it, or wait for results.
1049
+ # # Here is how to wait for a response.
1013
1050
  # result.wait_until_done! timeout: 60
1014
1051
  # if result.response?
1015
1052
  # p result.response
1016
1053
  # else
1017
- # puts "Error!"
1054
+ # puts "No response received."
1018
1055
  # end
1019
1056
  #
1020
1057
  def disable_certificate_authority request, options = nil
@@ -1060,7 +1097,8 @@ module Google
1060
1097
  end
1061
1098
 
1062
1099
  ##
1063
- # Enable a {::Google::Cloud::Security::PrivateCA::V1::CertificateAuthority CertificateAuthority}.
1100
+ # Enable a
1101
+ # {::Google::Cloud::Security::PrivateCA::V1::CertificateAuthority CertificateAuthority}.
1064
1102
  #
1065
1103
  # @overload enable_certificate_authority(request, options = nil)
1066
1104
  # Pass arguments to `enable_certificate_authority` via a request object, either of type
@@ -1078,16 +1116,17 @@ module Google
1078
1116
  # the default parameter values, pass an empty Hash as a request object (see above).
1079
1117
  #
1080
1118
  # @param name [::String]
1081
- # Required. The resource name for this {::Google::Cloud::Security::PrivateCA::V1::CertificateAuthority CertificateAuthority} in the
1082
- # format `projects/*/locations/*/caPools/*/certificateAuthorities/*`.
1119
+ # Required. The resource name for this
1120
+ # {::Google::Cloud::Security::PrivateCA::V1::CertificateAuthority CertificateAuthority}
1121
+ # in the format `projects/*/locations/*/caPools/*/certificateAuthorities/*`.
1083
1122
  # @param request_id [::String]
1084
- # Optional. An ID to identify requests. Specify a unique request ID so that if you must
1085
- # retry your request, the server will know to ignore the request if it has
1086
- # already been completed. The server will guarantee that for at least 60
1087
- # minutes since the first request.
1123
+ # Optional. An ID to identify requests. Specify a unique request ID so that
1124
+ # if you must retry your request, the server will know to ignore the request
1125
+ # if it has already been completed. The server will guarantee that for at
1126
+ # least 60 minutes since the first request.
1088
1127
  #
1089
- # For example, consider a situation where you make an initial request and t
1090
- # he request times out. If you make the request again with the same request
1128
+ # For example, consider a situation where you make an initial request and
1129
+ # the request times out. If you make the request again with the same request
1091
1130
  # ID, the server can check if original operation with the same request ID
1092
1131
  # was received, and if so, will ignore the second request. This prevents
1093
1132
  # clients from accidentally creating duplicate commitments.
@@ -1115,14 +1154,14 @@ module Google
1115
1154
  # # Call the enable_certificate_authority method.
1116
1155
  # result = client.enable_certificate_authority request
1117
1156
  #
1118
- # # The returned object is of type Gapic::Operation. You can use this
1119
- # # object to check the status of an operation, cancel it, or wait
1120
- # # for results. Here is how to block until completion:
1157
+ # # The returned object is of type Gapic::Operation. You can use it to
1158
+ # # check the status of an operation, cancel it, or wait for results.
1159
+ # # Here is how to wait for a response.
1121
1160
  # result.wait_until_done! timeout: 60
1122
1161
  # if result.response?
1123
1162
  # p result.response
1124
1163
  # else
1125
- # puts "Error!"
1164
+ # puts "No response received."
1126
1165
  # end
1127
1166
  #
1128
1167
  def enable_certificate_authority request, options = nil
@@ -1168,13 +1207,17 @@ module Google
1168
1207
  end
1169
1208
 
1170
1209
  ##
1171
- # Fetch a certificate signing request (CSR) from a {::Google::Cloud::Security::PrivateCA::V1::CertificateAuthority CertificateAuthority}
1210
+ # Fetch a certificate signing request (CSR) from a
1211
+ # {::Google::Cloud::Security::PrivateCA::V1::CertificateAuthority CertificateAuthority}
1172
1212
  # that is in state
1173
1213
  # {::Google::Cloud::Security::PrivateCA::V1::CertificateAuthority::State::AWAITING_USER_ACTIVATION AWAITING_USER_ACTIVATION}
1174
- # and is of type {::Google::Cloud::Security::PrivateCA::V1::CertificateAuthority::Type::SUBORDINATE SUBORDINATE}. The
1175
- # CSR must then be signed by the desired parent Certificate Authority, which
1176
- # could be another {::Google::Cloud::Security::PrivateCA::V1::CertificateAuthority CertificateAuthority} resource, or could be an on-prem
1177
- # certificate authority. See also {::Google::Cloud::Security::PrivateCA::V1::CertificateAuthorityService::Client#activate_certificate_authority ActivateCertificateAuthority}.
1214
+ # and is of type
1215
+ # {::Google::Cloud::Security::PrivateCA::V1::CertificateAuthority::Type::SUBORDINATE SUBORDINATE}.
1216
+ # The CSR must then be signed by the desired parent Certificate Authority,
1217
+ # which could be another
1218
+ # {::Google::Cloud::Security::PrivateCA::V1::CertificateAuthority CertificateAuthority}
1219
+ # resource, or could be an on-prem certificate authority. See also
1220
+ # {::Google::Cloud::Security::PrivateCA::V1::CertificateAuthorityService::Client#activate_certificate_authority ActivateCertificateAuthority}.
1178
1221
  #
1179
1222
  # @overload fetch_certificate_authority_csr(request, options = nil)
1180
1223
  # Pass arguments to `fetch_certificate_authority_csr` via a request object, either of type
@@ -1192,8 +1235,9 @@ module Google
1192
1235
  # the default parameter values, pass an empty Hash as a request object (see above).
1193
1236
  #
1194
1237
  # @param name [::String]
1195
- # Required. The resource name for this {::Google::Cloud::Security::PrivateCA::V1::CertificateAuthority CertificateAuthority} in the
1196
- # format `projects/*/locations/*/caPools/*/certificateAuthorities/*`.
1238
+ # Required. The resource name for this
1239
+ # {::Google::Cloud::Security::PrivateCA::V1::CertificateAuthority CertificateAuthority}
1240
+ # in the format `projects/*/locations/*/caPools/*/certificateAuthorities/*`.
1197
1241
  #
1198
1242
  # @yield [response, operation] Access the result along with the RPC operation
1199
1243
  # @yieldparam response [::Google::Cloud::Security::PrivateCA::V1::FetchCertificateAuthorityCsrResponse]
@@ -1260,7 +1304,8 @@ module Google
1260
1304
  end
1261
1305
 
1262
1306
  ##
1263
- # Returns a {::Google::Cloud::Security::PrivateCA::V1::CertificateAuthority CertificateAuthority}.
1307
+ # Returns a
1308
+ # {::Google::Cloud::Security::PrivateCA::V1::CertificateAuthority CertificateAuthority}.
1264
1309
  #
1265
1310
  # @overload get_certificate_authority(request, options = nil)
1266
1311
  # Pass arguments to `get_certificate_authority` via a request object, either of type
@@ -1278,8 +1323,10 @@ module Google
1278
1323
  # the default parameter values, pass an empty Hash as a request object (see above).
1279
1324
  #
1280
1325
  # @param name [::String]
1281
- # Required. The {::Google::Cloud::Security::PrivateCA::V1::CertificateAuthority#name name} of the {::Google::Cloud::Security::PrivateCA::V1::CertificateAuthority CertificateAuthority} to
1282
- # get.
1326
+ # Required. The
1327
+ # {::Google::Cloud::Security::PrivateCA::V1::CertificateAuthority#name name} of the
1328
+ # {::Google::Cloud::Security::PrivateCA::V1::CertificateAuthority CertificateAuthority}
1329
+ # to get.
1283
1330
  #
1284
1331
  # @yield [response, operation] Access the result along with the RPC operation
1285
1332
  # @yieldparam response [::Google::Cloud::Security::PrivateCA::V1::CertificateAuthority]
@@ -1346,7 +1393,8 @@ module Google
1346
1393
  end
1347
1394
 
1348
1395
  ##
1349
- # Lists {::Google::Cloud::Security::PrivateCA::V1::CertificateAuthority CertificateAuthorities}.
1396
+ # Lists
1397
+ # {::Google::Cloud::Security::PrivateCA::V1::CertificateAuthority CertificateAuthorities}.
1350
1398
  #
1351
1399
  # @overload list_certificate_authorities(request, options = nil)
1352
1400
  # Pass arguments to `list_certificate_authorities` via a request object, either of type
@@ -1364,16 +1412,19 @@ module Google
1364
1412
  # the default parameter values, pass an empty Hash as a request object (see above).
1365
1413
  #
1366
1414
  # @param parent [::String]
1367
- # Required. The resource name of the {::Google::Cloud::Security::PrivateCA::V1::CaPool CaPool} associated with the
1368
- # {::Google::Cloud::Security::PrivateCA::V1::CertificateAuthority CertificateAuthorities}, in the format
1369
- # `projects/*/locations/*/caPools/*`.
1415
+ # Required. The resource name of the
1416
+ # {::Google::Cloud::Security::PrivateCA::V1::CaPool CaPool} associated with the
1417
+ # {::Google::Cloud::Security::PrivateCA::V1::CertificateAuthority CertificateAuthorities},
1418
+ # in the format `projects/*/locations/*/caPools/*`.
1370
1419
  # @param page_size [::Integer]
1371
- # Optional. Limit on the number of {::Google::Cloud::Security::PrivateCA::V1::CertificateAuthority CertificateAuthorities} to
1372
- # include in the response.
1373
- # Further {::Google::Cloud::Security::PrivateCA::V1::CertificateAuthority CertificateAuthorities} can subsequently be
1374
- # obtained by including the
1375
- # {::Google::Cloud::Security::PrivateCA::V1::ListCertificateAuthoritiesResponse#next_page_token ListCertificateAuthoritiesResponse.next_page_token} in a subsequent
1376
- # request. If unspecified, the server will pick an appropriate default.
1420
+ # Optional. Limit on the number of
1421
+ # {::Google::Cloud::Security::PrivateCA::V1::CertificateAuthority CertificateAuthorities}
1422
+ # to include in the response. Further
1423
+ # {::Google::Cloud::Security::PrivateCA::V1::CertificateAuthority CertificateAuthorities}
1424
+ # can subsequently be obtained by including the
1425
+ # {::Google::Cloud::Security::PrivateCA::V1::ListCertificateAuthoritiesResponse#next_page_token ListCertificateAuthoritiesResponse.next_page_token}
1426
+ # in a subsequent request. If unspecified, the server will pick an
1427
+ # appropriate default.
1377
1428
  # @param page_token [::String]
1378
1429
  # Optional. Pagination token, returned earlier via
1379
1430
  # {::Google::Cloud::Security::PrivateCA::V1::ListCertificateAuthoritiesResponse#next_page_token ListCertificateAuthoritiesResponse.next_page_token}.
@@ -1402,13 +1453,11 @@ module Google
1402
1453
  # # Call the list_certificate_authorities method.
1403
1454
  # result = client.list_certificate_authorities request
1404
1455
  #
1405
- # # The returned object is of type Gapic::PagedEnumerable. You can
1406
- # # iterate over all elements by calling #each, and the enumerable
1407
- # # will lazily make API calls to fetch subsequent pages. Other
1408
- # # methods are also available for managing paging directly.
1409
- # result.each do |response|
1456
+ # # The returned object is of type Gapic::PagedEnumerable. You can iterate
1457
+ # # over elements, and API calls will be issued to fetch pages as needed.
1458
+ # result.each do |item|
1410
1459
  # # Each element is of type ::Google::Cloud::Security::PrivateCA::V1::CertificateAuthority.
1411
- # p response
1460
+ # p item
1412
1461
  # end
1413
1462
  #
1414
1463
  def list_certificate_authorities request, options = nil
@@ -1454,7 +1503,9 @@ module Google
1454
1503
  end
1455
1504
 
1456
1505
  ##
1457
- # Undelete a {::Google::Cloud::Security::PrivateCA::V1::CertificateAuthority CertificateAuthority} that has been deleted.
1506
+ # Undelete a
1507
+ # {::Google::Cloud::Security::PrivateCA::V1::CertificateAuthority CertificateAuthority}
1508
+ # that has been deleted.
1458
1509
  #
1459
1510
  # @overload undelete_certificate_authority(request, options = nil)
1460
1511
  # Pass arguments to `undelete_certificate_authority` via a request object, either of type
@@ -1472,16 +1523,17 @@ module Google
1472
1523
  # the default parameter values, pass an empty Hash as a request object (see above).
1473
1524
  #
1474
1525
  # @param name [::String]
1475
- # Required. The resource name for this {::Google::Cloud::Security::PrivateCA::V1::CertificateAuthority CertificateAuthority} in the
1476
- # format `projects/*/locations/*/caPools/*/certificateAuthorities/*`.
1526
+ # Required. The resource name for this
1527
+ # {::Google::Cloud::Security::PrivateCA::V1::CertificateAuthority CertificateAuthority}
1528
+ # in the format `projects/*/locations/*/caPools/*/certificateAuthorities/*`.
1477
1529
  # @param request_id [::String]
1478
- # Optional. An ID to identify requests. Specify a unique request ID so that if you must
1479
- # retry your request, the server will know to ignore the request if it has
1480
- # already been completed. The server will guarantee that for at least 60
1481
- # minutes since the first request.
1530
+ # Optional. An ID to identify requests. Specify a unique request ID so that
1531
+ # if you must retry your request, the server will know to ignore the request
1532
+ # if it has already been completed. The server will guarantee that for at
1533
+ # least 60 minutes since the first request.
1482
1534
  #
1483
- # For example, consider a situation where you make an initial request and t
1484
- # he request times out. If you make the request again with the same request
1535
+ # For example, consider a situation where you make an initial request and
1536
+ # the request times out. If you make the request again with the same request
1485
1537
  # ID, the server can check if original operation with the same request ID
1486
1538
  # was received, and if so, will ignore the second request. This prevents
1487
1539
  # clients from accidentally creating duplicate commitments.
@@ -1509,14 +1561,14 @@ module Google
1509
1561
  # # Call the undelete_certificate_authority method.
1510
1562
  # result = client.undelete_certificate_authority request
1511
1563
  #
1512
- # # The returned object is of type Gapic::Operation. You can use this
1513
- # # object to check the status of an operation, cancel it, or wait
1514
- # # for results. Here is how to block until completion:
1564
+ # # The returned object is of type Gapic::Operation. You can use it to
1565
+ # # check the status of an operation, cancel it, or wait for results.
1566
+ # # Here is how to wait for a response.
1515
1567
  # result.wait_until_done! timeout: 60
1516
1568
  # if result.response?
1517
1569
  # p result.response
1518
1570
  # else
1519
- # puts "Error!"
1571
+ # puts "No response received."
1520
1572
  # end
1521
1573
  #
1522
1574
  def undelete_certificate_authority request, options = nil
@@ -1562,7 +1614,8 @@ module Google
1562
1614
  end
1563
1615
 
1564
1616
  ##
1565
- # Delete a {::Google::Cloud::Security::PrivateCA::V1::CertificateAuthority CertificateAuthority}.
1617
+ # Delete a
1618
+ # {::Google::Cloud::Security::PrivateCA::V1::CertificateAuthority CertificateAuthority}.
1566
1619
  #
1567
1620
  # @overload delete_certificate_authority(request, options = nil)
1568
1621
  # Pass arguments to `delete_certificate_authority` via a request object, either of type
@@ -1580,16 +1633,17 @@ module Google
1580
1633
  # the default parameter values, pass an empty Hash as a request object (see above).
1581
1634
  #
1582
1635
  # @param name [::String]
1583
- # Required. The resource name for this {::Google::Cloud::Security::PrivateCA::V1::CertificateAuthority CertificateAuthority} in the
1584
- # format `projects/*/locations/*/caPools/*/certificateAuthorities/*`.
1636
+ # Required. The resource name for this
1637
+ # {::Google::Cloud::Security::PrivateCA::V1::CertificateAuthority CertificateAuthority}
1638
+ # in the format `projects/*/locations/*/caPools/*/certificateAuthorities/*`.
1585
1639
  # @param request_id [::String]
1586
- # Optional. An ID to identify requests. Specify a unique request ID so that if you must
1587
- # retry your request, the server will know to ignore the request if it has
1588
- # already been completed. The server will guarantee that for at least 60
1589
- # minutes since the first request.
1640
+ # Optional. An ID to identify requests. Specify a unique request ID so that
1641
+ # if you must retry your request, the server will know to ignore the request
1642
+ # if it has already been completed. The server will guarantee that for at
1643
+ # least 60 minutes since the first request.
1590
1644
  #
1591
- # For example, consider a situation where you make an initial request and t
1592
- # he request times out. If you make the request again with the same request
1645
+ # For example, consider a situation where you make an initial request and
1646
+ # the request times out. If you make the request again with the same request
1593
1647
  # ID, the server can check if original operation with the same request ID
1594
1648
  # was received, and if so, will ignore the second request. This prevents
1595
1649
  # clients from accidentally creating duplicate commitments.
@@ -1600,9 +1654,9 @@ module Google
1600
1654
  # Optional. This field allows the CA to be deleted even if the CA has
1601
1655
  # active certs. Active certs include both unrevoked and unexpired certs.
1602
1656
  # @param skip_grace_period [::Boolean]
1603
- # Optional. If this flag is set, the Certificate Authority will be deleted as soon as
1604
- # possible without a 30-day grace period where undeletion would have been
1605
- # allowed. If you proceed, there will be no way to recover this CA.
1657
+ # Optional. If this flag is set, the Certificate Authority will be deleted as
1658
+ # soon as possible without a 30-day grace period where undeletion would have
1659
+ # been allowed. If you proceed, there will be no way to recover this CA.
1606
1660
  #
1607
1661
  # @yield [response, operation] Access the result along with the RPC operation
1608
1662
  # @yieldparam response [::Gapic::Operation]
@@ -1624,14 +1678,14 @@ module Google
1624
1678
  # # Call the delete_certificate_authority method.
1625
1679
  # result = client.delete_certificate_authority request
1626
1680
  #
1627
- # # The returned object is of type Gapic::Operation. You can use this
1628
- # # object to check the status of an operation, cancel it, or wait
1629
- # # for results. Here is how to block until completion:
1681
+ # # The returned object is of type Gapic::Operation. You can use it to
1682
+ # # check the status of an operation, cancel it, or wait for results.
1683
+ # # Here is how to wait for a response.
1630
1684
  # result.wait_until_done! timeout: 60
1631
1685
  # if result.response?
1632
1686
  # p result.response
1633
1687
  # else
1634
- # puts "Error!"
1688
+ # puts "No response received."
1635
1689
  # end
1636
1690
  #
1637
1691
  def delete_certificate_authority request, options = nil
@@ -1677,7 +1731,8 @@ module Google
1677
1731
  end
1678
1732
 
1679
1733
  ##
1680
- # Update a {::Google::Cloud::Security::PrivateCA::V1::CertificateAuthority CertificateAuthority}.
1734
+ # Update a
1735
+ # {::Google::Cloud::Security::PrivateCA::V1::CertificateAuthority CertificateAuthority}.
1681
1736
  #
1682
1737
  # @overload update_certificate_authority(request, options = nil)
1683
1738
  # Pass arguments to `update_certificate_authority` via a request object, either of type
@@ -1695,17 +1750,19 @@ module Google
1695
1750
  # the default parameter values, pass an empty Hash as a request object (see above).
1696
1751
  #
1697
1752
  # @param certificate_authority [::Google::Cloud::Security::PrivateCA::V1::CertificateAuthority, ::Hash]
1698
- # Required. {::Google::Cloud::Security::PrivateCA::V1::CertificateAuthority CertificateAuthority} with updated values.
1753
+ # Required.
1754
+ # {::Google::Cloud::Security::PrivateCA::V1::CertificateAuthority CertificateAuthority}
1755
+ # with updated values.
1699
1756
  # @param update_mask [::Google::Protobuf::FieldMask, ::Hash]
1700
1757
  # Required. A list of fields to be updated in this request.
1701
1758
  # @param request_id [::String]
1702
- # Optional. An ID to identify requests. Specify a unique request ID so that if you must
1703
- # retry your request, the server will know to ignore the request if it has
1704
- # already been completed. The server will guarantee that for at least 60
1705
- # minutes since the first request.
1759
+ # Optional. An ID to identify requests. Specify a unique request ID so that
1760
+ # if you must retry your request, the server will know to ignore the request
1761
+ # if it has already been completed. The server will guarantee that for at
1762
+ # least 60 minutes since the first request.
1706
1763
  #
1707
- # For example, consider a situation where you make an initial request and t
1708
- # he request times out. If you make the request again with the same request
1764
+ # For example, consider a situation where you make an initial request and
1765
+ # the request times out. If you make the request again with the same request
1709
1766
  # ID, the server can check if original operation with the same request ID
1710
1767
  # was received, and if so, will ignore the second request. This prevents
1711
1768
  # clients from accidentally creating duplicate commitments.
@@ -1733,14 +1790,14 @@ module Google
1733
1790
  # # Call the update_certificate_authority method.
1734
1791
  # result = client.update_certificate_authority request
1735
1792
  #
1736
- # # The returned object is of type Gapic::Operation. You can use this
1737
- # # object to check the status of an operation, cancel it, or wait
1738
- # # for results. Here is how to block until completion:
1793
+ # # The returned object is of type Gapic::Operation. You can use it to
1794
+ # # check the status of an operation, cancel it, or wait for results.
1795
+ # # Here is how to wait for a response.
1739
1796
  # result.wait_until_done! timeout: 60
1740
1797
  # if result.response?
1741
1798
  # p result.response
1742
1799
  # else
1743
- # puts "Error!"
1800
+ # puts "No response received."
1744
1801
  # end
1745
1802
  #
1746
1803
  def update_certificate_authority request, options = nil
@@ -1805,20 +1862,22 @@ module Google
1805
1862
  #
1806
1863
  # @param parent [::String]
1807
1864
  # Required. The resource name of the location associated with the
1808
- # {::Google::Cloud::Security::PrivateCA::V1::CaPool CaPool}, in the format `projects/*/locations/*`.
1865
+ # {::Google::Cloud::Security::PrivateCA::V1::CaPool CaPool}, in the format
1866
+ # `projects/*/locations/*`.
1809
1867
  # @param ca_pool_id [::String]
1810
1868
  # Required. It must be unique within a location and match the regular
1811
1869
  # expression `[a-zA-Z0-9_-]{1,63}`
1812
1870
  # @param ca_pool [::Google::Cloud::Security::PrivateCA::V1::CaPool, ::Hash]
1813
- # Required. A {::Google::Cloud::Security::PrivateCA::V1::CaPool CaPool} with initial field values.
1871
+ # Required. A {::Google::Cloud::Security::PrivateCA::V1::CaPool CaPool} with
1872
+ # initial field values.
1814
1873
  # @param request_id [::String]
1815
- # Optional. An ID to identify requests. Specify a unique request ID so that if you must
1816
- # retry your request, the server will know to ignore the request if it has
1817
- # already been completed. The server will guarantee that for at least 60
1818
- # minutes since the first request.
1874
+ # Optional. An ID to identify requests. Specify a unique request ID so that
1875
+ # if you must retry your request, the server will know to ignore the request
1876
+ # if it has already been completed. The server will guarantee that for at
1877
+ # least 60 minutes since the first request.
1819
1878
  #
1820
- # For example, consider a situation where you make an initial request and t
1821
- # he request times out. If you make the request again with the same request
1879
+ # For example, consider a situation where you make an initial request and
1880
+ # the request times out. If you make the request again with the same request
1822
1881
  # ID, the server can check if original operation with the same request ID
1823
1882
  # was received, and if so, will ignore the second request. This prevents
1824
1883
  # clients from accidentally creating duplicate commitments.
@@ -1846,14 +1905,14 @@ module Google
1846
1905
  # # Call the create_ca_pool method.
1847
1906
  # result = client.create_ca_pool request
1848
1907
  #
1849
- # # The returned object is of type Gapic::Operation. You can use this
1850
- # # object to check the status of an operation, cancel it, or wait
1851
- # # for results. Here is how to block until completion:
1908
+ # # The returned object is of type Gapic::Operation. You can use it to
1909
+ # # check the status of an operation, cancel it, or wait for results.
1910
+ # # Here is how to wait for a response.
1852
1911
  # result.wait_until_done! timeout: 60
1853
1912
  # if result.response?
1854
1913
  # p result.response
1855
1914
  # else
1856
- # puts "Error!"
1915
+ # puts "No response received."
1857
1916
  # end
1858
1917
  #
1859
1918
  def create_ca_pool request, options = nil
@@ -1917,17 +1976,18 @@ module Google
1917
1976
  # the default parameter values, pass an empty Hash as a request object (see above).
1918
1977
  #
1919
1978
  # @param ca_pool [::Google::Cloud::Security::PrivateCA::V1::CaPool, ::Hash]
1920
- # Required. {::Google::Cloud::Security::PrivateCA::V1::CaPool CaPool} with updated values.
1979
+ # Required. {::Google::Cloud::Security::PrivateCA::V1::CaPool CaPool} with updated
1980
+ # values.
1921
1981
  # @param update_mask [::Google::Protobuf::FieldMask, ::Hash]
1922
1982
  # Required. A list of fields to be updated in this request.
1923
1983
  # @param request_id [::String]
1924
- # Optional. An ID to identify requests. Specify a unique request ID so that if you must
1925
- # retry your request, the server will know to ignore the request if it has
1926
- # already been completed. The server will guarantee that for at least 60
1927
- # minutes since the first request.
1984
+ # Optional. An ID to identify requests. Specify a unique request ID so that
1985
+ # if you must retry your request, the server will know to ignore the request
1986
+ # if it has already been completed. The server will guarantee that for at
1987
+ # least 60 minutes since the first request.
1928
1988
  #
1929
- # For example, consider a situation where you make an initial request and t
1930
- # he request times out. If you make the request again with the same request
1989
+ # For example, consider a situation where you make an initial request and
1990
+ # the request times out. If you make the request again with the same request
1931
1991
  # ID, the server can check if original operation with the same request ID
1932
1992
  # was received, and if so, will ignore the second request. This prevents
1933
1993
  # clients from accidentally creating duplicate commitments.
@@ -1955,14 +2015,14 @@ module Google
1955
2015
  # # Call the update_ca_pool method.
1956
2016
  # result = client.update_ca_pool request
1957
2017
  #
1958
- # # The returned object is of type Gapic::Operation. You can use this
1959
- # # object to check the status of an operation, cancel it, or wait
1960
- # # for results. Here is how to block until completion:
2018
+ # # The returned object is of type Gapic::Operation. You can use it to
2019
+ # # check the status of an operation, cancel it, or wait for results.
2020
+ # # Here is how to wait for a response.
1961
2021
  # result.wait_until_done! timeout: 60
1962
2022
  # if result.response?
1963
2023
  # p result.response
1964
2024
  # else
1965
- # puts "Error!"
2025
+ # puts "No response received."
1966
2026
  # end
1967
2027
  #
1968
2028
  def update_ca_pool request, options = nil
@@ -2026,7 +2086,8 @@ module Google
2026
2086
  # the default parameter values, pass an empty Hash as a request object (see above).
2027
2087
  #
2028
2088
  # @param name [::String]
2029
- # Required. The {::Google::Cloud::Security::PrivateCA::V1::CaPool#name name} of the {::Google::Cloud::Security::PrivateCA::V1::CaPool CaPool} to get.
2089
+ # Required. The {::Google::Cloud::Security::PrivateCA::V1::CaPool#name name} of the
2090
+ # {::Google::Cloud::Security::PrivateCA::V1::CaPool CaPool} to get.
2030
2091
  #
2031
2092
  # @yield [response, operation] Access the result along with the RPC operation
2032
2093
  # @yieldparam response [::Google::Cloud::Security::PrivateCA::V1::CaPool]
@@ -2115,12 +2176,13 @@ module Google
2115
2176
  # {::Google::Cloud::Security::PrivateCA::V1::CaPool CaPools}, in the format
2116
2177
  # `projects/*/locations/*`.
2117
2178
  # @param page_size [::Integer]
2118
- # Optional. Limit on the number of {::Google::Cloud::Security::PrivateCA::V1::CaPool CaPools} to
2119
- # include in the response.
2120
- # Further {::Google::Cloud::Security::PrivateCA::V1::CaPool CaPools} can subsequently be
2121
- # obtained by including the
2122
- # {::Google::Cloud::Security::PrivateCA::V1::ListCaPoolsResponse#next_page_token ListCaPoolsResponse.next_page_token} in a subsequent
2123
- # request. If unspecified, the server will pick an appropriate default.
2179
+ # Optional. Limit on the number of
2180
+ # {::Google::Cloud::Security::PrivateCA::V1::CaPool CaPools} to include in the
2181
+ # response. Further {::Google::Cloud::Security::PrivateCA::V1::CaPool CaPools} can
2182
+ # subsequently be obtained by including the
2183
+ # {::Google::Cloud::Security::PrivateCA::V1::ListCaPoolsResponse#next_page_token ListCaPoolsResponse.next_page_token}
2184
+ # in a subsequent request. If unspecified, the server will pick an
2185
+ # appropriate default.
2124
2186
  # @param page_token [::String]
2125
2187
  # Optional. Pagination token, returned earlier via
2126
2188
  # {::Google::Cloud::Security::PrivateCA::V1::ListCaPoolsResponse#next_page_token ListCaPoolsResponse.next_page_token}.
@@ -2149,13 +2211,11 @@ module Google
2149
2211
  # # Call the list_ca_pools method.
2150
2212
  # result = client.list_ca_pools request
2151
2213
  #
2152
- # # The returned object is of type Gapic::PagedEnumerable. You can
2153
- # # iterate over all elements by calling #each, and the enumerable
2154
- # # will lazily make API calls to fetch subsequent pages. Other
2155
- # # methods are also available for managing paging directly.
2156
- # result.each do |response|
2214
+ # # The returned object is of type Gapic::PagedEnumerable. You can iterate
2215
+ # # over elements, and API calls will be issued to fetch pages as needed.
2216
+ # result.each do |item|
2157
2217
  # # Each element is of type ::Google::Cloud::Security::PrivateCA::V1::CaPool.
2158
- # p response
2218
+ # p item
2159
2219
  # end
2160
2220
  #
2161
2221
  def list_ca_pools request, options = nil
@@ -2219,16 +2279,17 @@ module Google
2219
2279
  # the default parameter values, pass an empty Hash as a request object (see above).
2220
2280
  #
2221
2281
  # @param name [::String]
2222
- # Required. The resource name for this {::Google::Cloud::Security::PrivateCA::V1::CaPool CaPool} in the
2223
- # format `projects/*/locations/*/caPools/*`.
2282
+ # Required. The resource name for this
2283
+ # {::Google::Cloud::Security::PrivateCA::V1::CaPool CaPool} in the format
2284
+ # `projects/*/locations/*/caPools/*`.
2224
2285
  # @param request_id [::String]
2225
- # Optional. An ID to identify requests. Specify a unique request ID so that if you must
2226
- # retry your request, the server will know to ignore the request if it has
2227
- # already been completed. The server will guarantee that for at least 60
2228
- # minutes since the first request.
2286
+ # Optional. An ID to identify requests. Specify a unique request ID so that
2287
+ # if you must retry your request, the server will know to ignore the request
2288
+ # if it has already been completed. The server will guarantee that for at
2289
+ # least 60 minutes since the first request.
2229
2290
  #
2230
- # For example, consider a situation where you make an initial request and t
2231
- # he request times out. If you make the request again with the same request
2291
+ # For example, consider a situation where you make an initial request and
2292
+ # the request times out. If you make the request again with the same request
2232
2293
  # ID, the server can check if original operation with the same request ID
2233
2294
  # was received, and if so, will ignore the second request. This prevents
2234
2295
  # clients from accidentally creating duplicate commitments.
@@ -2256,14 +2317,14 @@ module Google
2256
2317
  # # Call the delete_ca_pool method.
2257
2318
  # result = client.delete_ca_pool request
2258
2319
  #
2259
- # # The returned object is of type Gapic::Operation. You can use this
2260
- # # object to check the status of an operation, cancel it, or wait
2261
- # # for results. Here is how to block until completion:
2320
+ # # The returned object is of type Gapic::Operation. You can use it to
2321
+ # # check the status of an operation, cancel it, or wait for results.
2322
+ # # Here is how to wait for a response.
2262
2323
  # result.wait_until_done! timeout: 60
2263
2324
  # if result.response?
2264
2325
  # p result.response
2265
2326
  # else
2266
- # puts "Error!"
2327
+ # puts "No response received."
2267
2328
  # end
2268
2329
  #
2269
2330
  def delete_ca_pool request, options = nil
@@ -2309,8 +2370,10 @@ module Google
2309
2370
  end
2310
2371
 
2311
2372
  ##
2312
- # FetchCaCerts returns the current trust anchor for the {::Google::Cloud::Security::PrivateCA::V1::CaPool CaPool}. This will
2313
- # include CA certificate chains for all ACTIVE {::Google::Cloud::Security::PrivateCA::V1::CertificateAuthority CertificateAuthority}
2373
+ # FetchCaCerts returns the current trust anchor for the
2374
+ # {::Google::Cloud::Security::PrivateCA::V1::CaPool CaPool}. This will include CA
2375
+ # certificate chains for all ACTIVE
2376
+ # {::Google::Cloud::Security::PrivateCA::V1::CertificateAuthority CertificateAuthority}
2314
2377
  # resources in the {::Google::Cloud::Security::PrivateCA::V1::CaPool CaPool}.
2315
2378
  #
2316
2379
  # @overload fetch_ca_certs(request, options = nil)
@@ -2329,16 +2392,17 @@ module Google
2329
2392
  # the default parameter values, pass an empty Hash as a request object (see above).
2330
2393
  #
2331
2394
  # @param ca_pool [::String]
2332
- # Required. The resource name for the {::Google::Cloud::Security::PrivateCA::V1::CaPool CaPool} in the
2333
- # format `projects/*/locations/*/caPools/*`.
2395
+ # Required. The resource name for the
2396
+ # {::Google::Cloud::Security::PrivateCA::V1::CaPool CaPool} in the format
2397
+ # `projects/*/locations/*/caPools/*`.
2334
2398
  # @param request_id [::String]
2335
- # Optional. An ID to identify requests. Specify a unique request ID so that if you must
2336
- # retry your request, the server will know to ignore the request if it has
2337
- # already been completed. The server will guarantee that for at least 60
2338
- # minutes since the first request.
2399
+ # Optional. An ID to identify requests. Specify a unique request ID so that
2400
+ # if you must retry your request, the server will know to ignore the request
2401
+ # if it has already been completed. The server will guarantee that for at
2402
+ # least 60 minutes since the first request.
2339
2403
  #
2340
- # For example, consider a situation where you make an initial request and t
2341
- # he request times out. If you make the request again with the same request
2404
+ # For example, consider a situation where you make an initial request and
2405
+ # the request times out. If you make the request again with the same request
2342
2406
  # ID, the server can check if original operation with the same request ID
2343
2407
  # was received, and if so, will ignore the second request. This prevents
2344
2408
  # clients from accidentally creating duplicate commitments.
@@ -2411,7 +2475,8 @@ module Google
2411
2475
  end
2412
2476
 
2413
2477
  ##
2414
- # Returns a {::Google::Cloud::Security::PrivateCA::V1::CertificateRevocationList CertificateRevocationList}.
2478
+ # Returns a
2479
+ # {::Google::Cloud::Security::PrivateCA::V1::CertificateRevocationList CertificateRevocationList}.
2415
2480
  #
2416
2481
  # @overload get_certificate_revocation_list(request, options = nil)
2417
2482
  # Pass arguments to `get_certificate_revocation_list` via a request object, either of type
@@ -2429,8 +2494,11 @@ module Google
2429
2494
  # the default parameter values, pass an empty Hash as a request object (see above).
2430
2495
  #
2431
2496
  # @param name [::String]
2432
- # Required. The {::Google::Cloud::Security::PrivateCA::V1::CertificateRevocationList#name name} of the
2433
- # {::Google::Cloud::Security::PrivateCA::V1::CertificateRevocationList CertificateRevocationList} to get.
2497
+ # Required. The
2498
+ # {::Google::Cloud::Security::PrivateCA::V1::CertificateRevocationList#name name}
2499
+ # of the
2500
+ # {::Google::Cloud::Security::PrivateCA::V1::CertificateRevocationList CertificateRevocationList}
2501
+ # to get.
2434
2502
  #
2435
2503
  # @yield [response, operation] Access the result along with the RPC operation
2436
2504
  # @yieldparam response [::Google::Cloud::Security::PrivateCA::V1::CertificateRevocationList]
@@ -2497,7 +2565,8 @@ module Google
2497
2565
  end
2498
2566
 
2499
2567
  ##
2500
- # Lists {::Google::Cloud::Security::PrivateCA::V1::CertificateRevocationList CertificateRevocationLists}.
2568
+ # Lists
2569
+ # {::Google::Cloud::Security::PrivateCA::V1::CertificateRevocationList CertificateRevocationLists}.
2501
2570
  #
2502
2571
  # @overload list_certificate_revocation_lists(request, options = nil)
2503
2572
  # Pass arguments to `list_certificate_revocation_lists` via a request object, either of type
@@ -2516,15 +2585,17 @@ module Google
2516
2585
  #
2517
2586
  # @param parent [::String]
2518
2587
  # Required. The resource name of the location associated with the
2519
- # {::Google::Cloud::Security::PrivateCA::V1::CertificateRevocationList CertificateRevocationLists}, in the format
2520
- # `projects/*/locations/*/caPools/*/certificateAuthorities/*`.
2588
+ # {::Google::Cloud::Security::PrivateCA::V1::CertificateRevocationList CertificateRevocationLists},
2589
+ # in the format `projects/*/locations/*/caPools/*/certificateAuthorities/*`.
2521
2590
  # @param page_size [::Integer]
2522
2591
  # Optional. Limit on the number of
2523
- # {::Google::Cloud::Security::PrivateCA::V1::CertificateRevocationList CertificateRevocationLists} to include in the
2524
- # response. Further {::Google::Cloud::Security::PrivateCA::V1::CertificateRevocationList CertificateRevocationLists}
2592
+ # {::Google::Cloud::Security::PrivateCA::V1::CertificateRevocationList CertificateRevocationLists}
2593
+ # to include in the response. Further
2594
+ # {::Google::Cloud::Security::PrivateCA::V1::CertificateRevocationList CertificateRevocationLists}
2525
2595
  # can subsequently be obtained by including the
2526
- # {::Google::Cloud::Security::PrivateCA::V1::ListCertificateRevocationListsResponse#next_page_token ListCertificateRevocationListsResponse.next_page_token} in a subsequent
2527
- # request. If unspecified, the server will pick an appropriate default.
2596
+ # {::Google::Cloud::Security::PrivateCA::V1::ListCertificateRevocationListsResponse#next_page_token ListCertificateRevocationListsResponse.next_page_token}
2597
+ # in a subsequent request. If unspecified, the server will pick an
2598
+ # appropriate default.
2528
2599
  # @param page_token [::String]
2529
2600
  # Optional. Pagination token, returned earlier via
2530
2601
  # {::Google::Cloud::Security::PrivateCA::V1::ListCertificateRevocationListsResponse#next_page_token ListCertificateRevocationListsResponse.next_page_token}.
@@ -2553,13 +2624,11 @@ module Google
2553
2624
  # # Call the list_certificate_revocation_lists method.
2554
2625
  # result = client.list_certificate_revocation_lists request
2555
2626
  #
2556
- # # The returned object is of type Gapic::PagedEnumerable. You can
2557
- # # iterate over all elements by calling #each, and the enumerable
2558
- # # will lazily make API calls to fetch subsequent pages. Other
2559
- # # methods are also available for managing paging directly.
2560
- # result.each do |response|
2627
+ # # The returned object is of type Gapic::PagedEnumerable. You can iterate
2628
+ # # over elements, and API calls will be issued to fetch pages as needed.
2629
+ # result.each do |item|
2561
2630
  # # Each element is of type ::Google::Cloud::Security::PrivateCA::V1::CertificateRevocationList.
2562
- # p response
2631
+ # p item
2563
2632
  # end
2564
2633
  #
2565
2634
  def list_certificate_revocation_lists request, options = nil
@@ -2605,7 +2674,8 @@ module Google
2605
2674
  end
2606
2675
 
2607
2676
  ##
2608
- # Update a {::Google::Cloud::Security::PrivateCA::V1::CertificateRevocationList CertificateRevocationList}.
2677
+ # Update a
2678
+ # {::Google::Cloud::Security::PrivateCA::V1::CertificateRevocationList CertificateRevocationList}.
2609
2679
  #
2610
2680
  # @overload update_certificate_revocation_list(request, options = nil)
2611
2681
  # Pass arguments to `update_certificate_revocation_list` via a request object, either of type
@@ -2623,17 +2693,19 @@ module Google
2623
2693
  # the default parameter values, pass an empty Hash as a request object (see above).
2624
2694
  #
2625
2695
  # @param certificate_revocation_list [::Google::Cloud::Security::PrivateCA::V1::CertificateRevocationList, ::Hash]
2626
- # Required. {::Google::Cloud::Security::PrivateCA::V1::CertificateRevocationList CertificateRevocationList} with updated values.
2696
+ # Required.
2697
+ # {::Google::Cloud::Security::PrivateCA::V1::CertificateRevocationList CertificateRevocationList}
2698
+ # with updated values.
2627
2699
  # @param update_mask [::Google::Protobuf::FieldMask, ::Hash]
2628
2700
  # Required. A list of fields to be updated in this request.
2629
2701
  # @param request_id [::String]
2630
- # Optional. An ID to identify requests. Specify a unique request ID so that if you must
2631
- # retry your request, the server will know to ignore the request if it has
2632
- # already been completed. The server will guarantee that for at least 60
2633
- # minutes since the first request.
2702
+ # Optional. An ID to identify requests. Specify a unique request ID so that
2703
+ # if you must retry your request, the server will know to ignore the request
2704
+ # if it has already been completed. The server will guarantee that for at
2705
+ # least 60 minutes since the first request.
2634
2706
  #
2635
- # For example, consider a situation where you make an initial request and t
2636
- # he request times out. If you make the request again with the same request
2707
+ # For example, consider a situation where you make an initial request and
2708
+ # the request times out. If you make the request again with the same request
2637
2709
  # ID, the server can check if original operation with the same request ID
2638
2710
  # was received, and if so, will ignore the second request. This prevents
2639
2711
  # clients from accidentally creating duplicate commitments.
@@ -2661,14 +2733,14 @@ module Google
2661
2733
  # # Call the update_certificate_revocation_list method.
2662
2734
  # result = client.update_certificate_revocation_list request
2663
2735
  #
2664
- # # The returned object is of type Gapic::Operation. You can use this
2665
- # # object to check the status of an operation, cancel it, or wait
2666
- # # for results. Here is how to block until completion:
2736
+ # # The returned object is of type Gapic::Operation. You can use it to
2737
+ # # check the status of an operation, cancel it, or wait for results.
2738
+ # # Here is how to wait for a response.
2667
2739
  # result.wait_until_done! timeout: 60
2668
2740
  # if result.response?
2669
2741
  # p result.response
2670
2742
  # else
2671
- # puts "Error!"
2743
+ # puts "No response received."
2672
2744
  # end
2673
2745
  #
2674
2746
  def update_certificate_revocation_list request, options = nil
@@ -2714,7 +2786,9 @@ module Google
2714
2786
  end
2715
2787
 
2716
2788
  ##
2717
- # Create a new {::Google::Cloud::Security::PrivateCA::V1::CertificateTemplate CertificateTemplate} in a given Project and Location.
2789
+ # Create a new
2790
+ # {::Google::Cloud::Security::PrivateCA::V1::CertificateTemplate CertificateTemplate}
2791
+ # in a given Project and Location.
2718
2792
  #
2719
2793
  # @overload create_certificate_template(request, options = nil)
2720
2794
  # Pass arguments to `create_certificate_template` via a request object, either of type
@@ -2733,21 +2807,23 @@ module Google
2733
2807
  #
2734
2808
  # @param parent [::String]
2735
2809
  # Required. The resource name of the location associated with the
2736
- # {::Google::Cloud::Security::PrivateCA::V1::CertificateTemplate CertificateTemplate}, in the format
2737
- # `projects/*/locations/*`.
2810
+ # {::Google::Cloud::Security::PrivateCA::V1::CertificateTemplate CertificateTemplate},
2811
+ # in the format `projects/*/locations/*`.
2738
2812
  # @param certificate_template_id [::String]
2739
2813
  # Required. It must be unique within a location and match the regular
2740
2814
  # expression `[a-zA-Z0-9_-]{1,63}`
2741
2815
  # @param certificate_template [::Google::Cloud::Security::PrivateCA::V1::CertificateTemplate, ::Hash]
2742
- # Required. A {::Google::Cloud::Security::PrivateCA::V1::CertificateTemplate CertificateTemplate} with initial field values.
2816
+ # Required. A
2817
+ # {::Google::Cloud::Security::PrivateCA::V1::CertificateTemplate CertificateTemplate}
2818
+ # with initial field values.
2743
2819
  # @param request_id [::String]
2744
- # Optional. An ID to identify requests. Specify a unique request ID so that if you must
2745
- # retry your request, the server will know to ignore the request if it has
2746
- # already been completed. The server will guarantee that for at least 60
2747
- # minutes since the first request.
2820
+ # Optional. An ID to identify requests. Specify a unique request ID so that
2821
+ # if you must retry your request, the server will know to ignore the request
2822
+ # if it has already been completed. The server will guarantee that for at
2823
+ # least 60 minutes since the first request.
2748
2824
  #
2749
- # For example, consider a situation where you make an initial request and t
2750
- # he request times out. If you make the request again with the same request
2825
+ # For example, consider a situation where you make an initial request and
2826
+ # the request times out. If you make the request again with the same request
2751
2827
  # ID, the server can check if original operation with the same request ID
2752
2828
  # was received, and if so, will ignore the second request. This prevents
2753
2829
  # clients from accidentally creating duplicate commitments.
@@ -2775,14 +2851,14 @@ module Google
2775
2851
  # # Call the create_certificate_template method.
2776
2852
  # result = client.create_certificate_template request
2777
2853
  #
2778
- # # The returned object is of type Gapic::Operation. You can use this
2779
- # # object to check the status of an operation, cancel it, or wait
2780
- # # for results. Here is how to block until completion:
2854
+ # # The returned object is of type Gapic::Operation. You can use it to
2855
+ # # check the status of an operation, cancel it, or wait for results.
2856
+ # # Here is how to wait for a response.
2781
2857
  # result.wait_until_done! timeout: 60
2782
2858
  # if result.response?
2783
2859
  # p result.response
2784
2860
  # else
2785
- # puts "Error!"
2861
+ # puts "No response received."
2786
2862
  # end
2787
2863
  #
2788
2864
  def create_certificate_template request, options = nil
@@ -2828,7 +2904,8 @@ module Google
2828
2904
  end
2829
2905
 
2830
2906
  ##
2831
- # DeleteCertificateTemplate deletes a {::Google::Cloud::Security::PrivateCA::V1::CertificateTemplate CertificateTemplate}.
2907
+ # DeleteCertificateTemplate deletes a
2908
+ # {::Google::Cloud::Security::PrivateCA::V1::CertificateTemplate CertificateTemplate}.
2832
2909
  #
2833
2910
  # @overload delete_certificate_template(request, options = nil)
2834
2911
  # Pass arguments to `delete_certificate_template` via a request object, either of type
@@ -2846,16 +2923,17 @@ module Google
2846
2923
  # the default parameter values, pass an empty Hash as a request object (see above).
2847
2924
  #
2848
2925
  # @param name [::String]
2849
- # Required. The resource name for this {::Google::Cloud::Security::PrivateCA::V1::CertificateTemplate CertificateTemplate} in the format
2850
- # `projects/*/locations/*/certificateTemplates/*`.
2926
+ # Required. The resource name for this
2927
+ # {::Google::Cloud::Security::PrivateCA::V1::CertificateTemplate CertificateTemplate}
2928
+ # in the format `projects/*/locations/*/certificateTemplates/*`.
2851
2929
  # @param request_id [::String]
2852
- # Optional. An ID to identify requests. Specify a unique request ID so that if you must
2853
- # retry your request, the server will know to ignore the request if it has
2854
- # already been completed. The server will guarantee that for at least 60
2855
- # minutes since the first request.
2930
+ # Optional. An ID to identify requests. Specify a unique request ID so that
2931
+ # if you must retry your request, the server will know to ignore the request
2932
+ # if it has already been completed. The server will guarantee that for at
2933
+ # least 60 minutes since the first request.
2856
2934
  #
2857
- # For example, consider a situation where you make an initial request and t
2858
- # he request times out. If you make the request again with the same request
2935
+ # For example, consider a situation where you make an initial request and
2936
+ # the request times out. If you make the request again with the same request
2859
2937
  # ID, the server can check if original operation with the same request ID
2860
2938
  # was received, and if so, will ignore the second request. This prevents
2861
2939
  # clients from accidentally creating duplicate commitments.
@@ -2883,14 +2961,14 @@ module Google
2883
2961
  # # Call the delete_certificate_template method.
2884
2962
  # result = client.delete_certificate_template request
2885
2963
  #
2886
- # # The returned object is of type Gapic::Operation. You can use this
2887
- # # object to check the status of an operation, cancel it, or wait
2888
- # # for results. Here is how to block until completion:
2964
+ # # The returned object is of type Gapic::Operation. You can use it to
2965
+ # # check the status of an operation, cancel it, or wait for results.
2966
+ # # Here is how to wait for a response.
2889
2967
  # result.wait_until_done! timeout: 60
2890
2968
  # if result.response?
2891
2969
  # p result.response
2892
2970
  # else
2893
- # puts "Error!"
2971
+ # puts "No response received."
2894
2972
  # end
2895
2973
  #
2896
2974
  def delete_certificate_template request, options = nil
@@ -2936,7 +3014,8 @@ module Google
2936
3014
  end
2937
3015
 
2938
3016
  ##
2939
- # Returns a {::Google::Cloud::Security::PrivateCA::V1::CertificateTemplate CertificateTemplate}.
3017
+ # Returns a
3018
+ # {::Google::Cloud::Security::PrivateCA::V1::CertificateTemplate CertificateTemplate}.
2940
3019
  #
2941
3020
  # @overload get_certificate_template(request, options = nil)
2942
3021
  # Pass arguments to `get_certificate_template` via a request object, either of type
@@ -2954,8 +3033,10 @@ module Google
2954
3033
  # the default parameter values, pass an empty Hash as a request object (see above).
2955
3034
  #
2956
3035
  # @param name [::String]
2957
- # Required. The {::Google::Cloud::Security::PrivateCA::V1::CertificateTemplate#name name} of the {::Google::Cloud::Security::PrivateCA::V1::CertificateTemplate CertificateTemplate} to
2958
- # get.
3036
+ # Required. The
3037
+ # {::Google::Cloud::Security::PrivateCA::V1::CertificateTemplate#name name} of the
3038
+ # {::Google::Cloud::Security::PrivateCA::V1::CertificateTemplate CertificateTemplate}
3039
+ # to get.
2959
3040
  #
2960
3041
  # @yield [response, operation] Access the result along with the RPC operation
2961
3042
  # @yieldparam response [::Google::Cloud::Security::PrivateCA::V1::CertificateTemplate]
@@ -3022,7 +3103,8 @@ module Google
3022
3103
  end
3023
3104
 
3024
3105
  ##
3025
- # Lists {::Google::Cloud::Security::PrivateCA::V1::CertificateTemplate CertificateTemplates}.
3106
+ # Lists
3107
+ # {::Google::Cloud::Security::PrivateCA::V1::CertificateTemplate CertificateTemplates}.
3026
3108
  #
3027
3109
  # @overload list_certificate_templates(request, options = nil)
3028
3110
  # Pass arguments to `list_certificate_templates` via a request object, either of type
@@ -3041,15 +3123,17 @@ module Google
3041
3123
  #
3042
3124
  # @param parent [::String]
3043
3125
  # Required. The resource name of the location associated with the
3044
- # {::Google::Cloud::Security::PrivateCA::V1::CertificateTemplate CertificateTemplates}, in the format
3045
- # `projects/*/locations/*`.
3126
+ # {::Google::Cloud::Security::PrivateCA::V1::CertificateTemplate CertificateTemplates},
3127
+ # in the format `projects/*/locations/*`.
3046
3128
  # @param page_size [::Integer]
3047
3129
  # Optional. Limit on the number of
3048
- # {::Google::Cloud::Security::PrivateCA::V1::CertificateTemplate CertificateTemplates} to include in the response.
3049
- # Further {::Google::Cloud::Security::PrivateCA::V1::CertificateTemplate CertificateTemplates} can subsequently be
3050
- # obtained by including the
3051
- # {::Google::Cloud::Security::PrivateCA::V1::ListCertificateTemplatesResponse#next_page_token ListCertificateTemplatesResponse.next_page_token} in a subsequent
3052
- # request. If unspecified, the server will pick an appropriate default.
3130
+ # {::Google::Cloud::Security::PrivateCA::V1::CertificateTemplate CertificateTemplates}
3131
+ # to include in the response. Further
3132
+ # {::Google::Cloud::Security::PrivateCA::V1::CertificateTemplate CertificateTemplates}
3133
+ # can subsequently be obtained by including the
3134
+ # {::Google::Cloud::Security::PrivateCA::V1::ListCertificateTemplatesResponse#next_page_token ListCertificateTemplatesResponse.next_page_token}
3135
+ # in a subsequent request. If unspecified, the server will pick an
3136
+ # appropriate default.
3053
3137
  # @param page_token [::String]
3054
3138
  # Optional. Pagination token, returned earlier via
3055
3139
  # {::Google::Cloud::Security::PrivateCA::V1::ListCertificateTemplatesResponse#next_page_token ListCertificateTemplatesResponse.next_page_token}.
@@ -3078,13 +3162,11 @@ module Google
3078
3162
  # # Call the list_certificate_templates method.
3079
3163
  # result = client.list_certificate_templates request
3080
3164
  #
3081
- # # The returned object is of type Gapic::PagedEnumerable. You can
3082
- # # iterate over all elements by calling #each, and the enumerable
3083
- # # will lazily make API calls to fetch subsequent pages. Other
3084
- # # methods are also available for managing paging directly.
3085
- # result.each do |response|
3165
+ # # The returned object is of type Gapic::PagedEnumerable. You can iterate
3166
+ # # over elements, and API calls will be issued to fetch pages as needed.
3167
+ # result.each do |item|
3086
3168
  # # Each element is of type ::Google::Cloud::Security::PrivateCA::V1::CertificateTemplate.
3087
- # p response
3169
+ # p item
3088
3170
  # end
3089
3171
  #
3090
3172
  def list_certificate_templates request, options = nil
@@ -3130,7 +3212,8 @@ module Google
3130
3212
  end
3131
3213
 
3132
3214
  ##
3133
- # Update a {::Google::Cloud::Security::PrivateCA::V1::CertificateTemplate CertificateTemplate}.
3215
+ # Update a
3216
+ # {::Google::Cloud::Security::PrivateCA::V1::CertificateTemplate CertificateTemplate}.
3134
3217
  #
3135
3218
  # @overload update_certificate_template(request, options = nil)
3136
3219
  # Pass arguments to `update_certificate_template` via a request object, either of type
@@ -3148,17 +3231,19 @@ module Google
3148
3231
  # the default parameter values, pass an empty Hash as a request object (see above).
3149
3232
  #
3150
3233
  # @param certificate_template [::Google::Cloud::Security::PrivateCA::V1::CertificateTemplate, ::Hash]
3151
- # Required. {::Google::Cloud::Security::PrivateCA::V1::CertificateTemplate CertificateTemplate} with updated values.
3234
+ # Required.
3235
+ # {::Google::Cloud::Security::PrivateCA::V1::CertificateTemplate CertificateTemplate}
3236
+ # with updated values.
3152
3237
  # @param update_mask [::Google::Protobuf::FieldMask, ::Hash]
3153
3238
  # Required. A list of fields to be updated in this request.
3154
3239
  # @param request_id [::String]
3155
- # Optional. An ID to identify requests. Specify a unique request ID so that if you must
3156
- # retry your request, the server will know to ignore the request if it has
3157
- # already been completed. The server will guarantee that for at least 60
3158
- # minutes since the first request.
3240
+ # Optional. An ID to identify requests. Specify a unique request ID so that
3241
+ # if you must retry your request, the server will know to ignore the request
3242
+ # if it has already been completed. The server will guarantee that for at
3243
+ # least 60 minutes since the first request.
3159
3244
  #
3160
- # For example, consider a situation where you make an initial request and t
3161
- # he request times out. If you make the request again with the same request
3245
+ # For example, consider a situation where you make an initial request and
3246
+ # the request times out. If you make the request again with the same request
3162
3247
  # ID, the server can check if original operation with the same request ID
3163
3248
  # was received, and if so, will ignore the second request. This prevents
3164
3249
  # clients from accidentally creating duplicate commitments.
@@ -3186,14 +3271,14 @@ module Google
3186
3271
  # # Call the update_certificate_template method.
3187
3272
  # result = client.update_certificate_template request
3188
3273
  #
3189
- # # The returned object is of type Gapic::Operation. You can use this
3190
- # # object to check the status of an operation, cancel it, or wait
3191
- # # for results. Here is how to block until completion:
3274
+ # # The returned object is of type Gapic::Operation. You can use it to
3275
+ # # check the status of an operation, cancel it, or wait for results.
3276
+ # # Here is how to wait for a response.
3192
3277
  # result.wait_until_done! timeout: 60
3193
3278
  # if result.response?
3194
3279
  # p result.response
3195
3280
  # else
3196
- # puts "Error!"
3281
+ # puts "No response received."
3197
3282
  # end
3198
3283
  #
3199
3284
  def update_certificate_template request, options = nil