class Google::Cloud::Security::PrivateCA::V1::CertificateAuthorityService::Client
Client
for the CertificateAuthorityService
service.
{::Google::Cloud::Security::PrivateCA::V1::CertificateAuthorityService::Client Certificate
Authority Service} manages private certificate authorities and issued certificates.
Attributes
Get the associated client for long-running operations.
@return [::Google::Cloud::Security::PrivateCA::V1::CertificateAuthorityService::Operations]
Public Class Methods
Configure the CertificateAuthorityService
Client
class.
See {::Google::Cloud::Security::PrivateCA::V1::CertificateAuthorityService::Client::Configuration} for a description of the configuration fields.
@example
# Modify the configuration for all CertificateAuthorityService clients ::Google::Cloud::Security::PrivateCA::V1::CertificateAuthorityService::Client.configure do |config| config.timeout = 10.0 end
@yield [config] Configure the Client
client. @yieldparam config [Client::Configuration]
@return [Client::Configuration]
# File lib/google/cloud/security/private_ca/v1/certificate_authority_service/client.rb, line 58 def self.configure @configure ||= begin namespace = ["Google", "Cloud", "Security", "PrivateCA", "V1"] parent_config = while namespace.any? parent_name = namespace.join "::" parent_const = const_get parent_name break parent_const.configure if parent_const.respond_to? :configure namespace.pop end default_config = Client::Configuration.new parent_config default_config.timeout = 60.0 default_config.retry_policy = { initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [2, 14, 4] } default_config end yield @configure if block_given? @configure end
Create a new CertificateAuthorityService
client object.
@example
# Create a client using the default configuration client = ::Google::Cloud::Security::PrivateCA::V1::CertificateAuthorityService::Client.new # Create a client using a custom configuration client = ::Google::Cloud::Security::PrivateCA::V1::CertificateAuthorityService::Client.new do |config| config.timeout = 10.0 end
@yield [config] Configure the CertificateAuthorityService
client. @yieldparam config [Client::Configuration]
# File lib/google/cloud/security/private_ca/v1/certificate_authority_service/client.rb, line 116 def initialize # These require statements are intentionally placed here to initialize # the gRPC module only when it's required. # See https://github.com/googleapis/toolkit/issues/446 require "gapic/grpc" require "google/cloud/security/privateca/v1/service_services_pb" # Create the configuration object @config = Configuration.new Client.configure # Yield the configuration if needed yield @config if block_given? # Create credentials credentials = @config.credentials # Use self-signed JWT if the endpoint is unchanged from default, # but only if the default endpoint does not have a region prefix. enable_self_signed_jwt = @config.endpoint == Client.configure.endpoint && !@config.endpoint.split(".").first.include?("-") credentials ||= Credentials.default scope: @config.scope, enable_self_signed_jwt: enable_self_signed_jwt if credentials.is_a?(::String) || credentials.is_a?(::Hash) credentials = Credentials.new credentials, scope: @config.scope end @quota_project_id = @config.quota_project @quota_project_id ||= credentials.quota_project_id if credentials.respond_to? :quota_project_id @operations_client = Operations.new do |config| config.credentials = credentials config.endpoint = @config.endpoint end @certificate_authority_service_stub = ::Gapic::ServiceStub.new( ::Google::Cloud::Security::PrivateCA::V1::CertificateAuthorityService::Stub, credentials: credentials, endpoint: @config.endpoint, channel_args: @config.channel_args, interceptors: @config.interceptors ) end
Public Instance Methods
Configure the CertificateAuthorityService
Client
instance.
The configuration is set to the derived mode, meaning that values can be changed, but structural changes (adding new fields, etc.) are not allowed. Structural changes should be made on {Client.configure}.
See {::Google::Cloud::Security::PrivateCA::V1::CertificateAuthorityService::Client::Configuration} for a description of the configuration fields.
@yield [config] Configure the Client
client. @yieldparam config [Client::Configuration]
@return [Client::Configuration]
# File lib/google/cloud/security/private_ca/v1/certificate_authority_service/client.rb, line 95 def configure yield @config if block_given? @config end
Create a {::Google::Cloud::Security::PrivateCA::V1::CaPool CaPool}.
@overload create_ca_pool
(request, options = nil)
Pass arguments to `create_ca_pool` via a request object, either of type {::Google::Cloud::Security::PrivateCA::V1::CreateCaPoolRequest} or an equivalent Hash. @param request [::Google::Cloud::Security::PrivateCA::V1::CreateCaPoolRequest, ::Hash] A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash. @param options [::Gapic::CallOptions, ::Hash] Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
@overload create_ca_pool
(parent: nil, ca_pool_id: nil, ca_pool: nil, request_id: nil)
Pass arguments to `create_ca_pool` via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above). @param parent [::String] Required. The resource name of the location associated with the {::Google::Cloud::Security::PrivateCA::V1::CaPool CaPool}, in the format `projects/*/locations/*`. @param ca_pool_id [::String] Required. It must be unique within a location and match the regular expression `[a-zA-Z0-9_-]{1,63}` @param ca_pool [::Google::Cloud::Security::PrivateCA::V1::CaPool, ::Hash] Required. A {::Google::Cloud::Security::PrivateCA::V1::CaPool CaPool} with initial field values. @param request_id [::String] Optional. An ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and t he request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Gapic::Operation] @yieldparam operation [::GRPC::ActiveCall::Operation]
@return [::Gapic::Operation]
@raise [::Google::Cloud::Error] if the RPC is aborted.
# File lib/google/cloud/security/private_ca/v1/certificate_authority_service/client.rb, line 1488 def create_ca_pool request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Security::PrivateCA::V1::CreateCaPoolRequest # Converts hash and nil to an options object options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h # Customize the options with defaults metadata = @config.rpcs.create_ca_pool.metadata.to_h # Set x-goog-api-client and x-goog-user-project headers metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::Security::PrivateCA::V1::VERSION metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = { "parent" => request.parent } request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&") metadata[:"x-goog-request-params"] ||= request_params_header options.apply_defaults timeout: @config.rpcs.create_ca_pool.timeout, metadata: metadata, retry_policy: @config.rpcs.create_ca_pool.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @certificate_authority_service_stub.call_rpc :create_ca_pool, request, options: options do |response, operation| response = ::Gapic::Operation.new response, @operations_client, options: options yield response, operation if block_given? return response end rescue ::GRPC::BadStatus => e raise ::Google::Cloud::Error.from_error(e) end
Create a new {::Google::Cloud::Security::PrivateCA::V1::Certificate Certificate} in a given Project, Location from a particular {::Google::Cloud::Security::PrivateCA::V1::CaPool CaPool}.
@overload create_certificate
(request, options = nil)
Pass arguments to `create_certificate` via a request object, either of type {::Google::Cloud::Security::PrivateCA::V1::CreateCertificateRequest} or an equivalent Hash. @param request [::Google::Cloud::Security::PrivateCA::V1::CreateCertificateRequest, ::Hash] A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash. @param options [::Gapic::CallOptions, ::Hash] Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
@overload create_certificate
(parent: nil, certificate_id: nil, certificate: nil, request_id: nil, validate_only: nil, issuing_certificate_authority_id: nil)
Pass arguments to `create_certificate` via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above). @param parent [::String] Required. The resource name of the {::Google::Cloud::Security::PrivateCA::V1::CaPool CaPool} associated with the {::Google::Cloud::Security::PrivateCA::V1::Certificate Certificate}, in the format `projects/*/locations/*/caPools/*`. @param certificate_id [::String] Optional. It must be unique within a location and match the regular expression `[a-zA-Z0-9_-]{1,63}`. This field is required when using a {::Google::Cloud::Security::PrivateCA::V1::CertificateAuthority CertificateAuthority} in the Enterprise [CertificateAuthority.Tier][], but is optional and its value is ignored otherwise. @param certificate [::Google::Cloud::Security::PrivateCA::V1::Certificate, ::Hash] Required. A {::Google::Cloud::Security::PrivateCA::V1::Certificate Certificate} with initial field values. @param request_id [::String] Optional. An ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and t he request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). @param validate_only [::Boolean] Optional. If this is true, no {::Google::Cloud::Security::PrivateCA::V1::Certificate Certificate} resource will be persisted regardless 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} will not contain the {::Google::Cloud::Security::PrivateCA::V1::Certificate#pem_certificate pem_certificate} field. @param issuing_certificate_authority_id [::String] Optional. The resource ID of the {::Google::Cloud::Security::PrivateCA::V1::CertificateAuthority CertificateAuthority} that should issue the certificate. This optional field will ignore the load-balancing scheme of the Pool and directly issue the certificate from the CA with the specified ID, contained in the same {::Google::Cloud::Security::PrivateCA::V1::CaPool CaPool} referenced by `parent`. Per-CA quota rules apply. If left empty, a {::Google::Cloud::Security::PrivateCA::V1::CertificateAuthority CertificateAuthority} will be chosen from the {::Google::Cloud::Security::PrivateCA::V1::CaPool CaPool} by the service. For example, to issue a {::Google::Cloud::Security::PrivateCA::V1::Certificate Certificate} from a Certificate Authority with resource name "projects/my-project/locations/us-central1/caPools/my-pool/certificateAuthorities/my-ca", you can set the {::Google::Cloud::Security::PrivateCA::V1::CreateCertificateRequest#parent parent} to "projects/my-project/locations/us-central1/caPools/my-pool" and the {::Google::Cloud::Security::PrivateCA::V1::CreateCertificateRequest#issuing_certificate_authority_id issuing_certificate_authority_id} to "my-ca".
@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Google::Cloud::Security::PrivateCA::V1::Certificate] @yieldparam operation [::GRPC::ActiveCall::Operation]
@return [::Google::Cloud::Security::PrivateCA::V1::Certificate]
@raise [::Google::Cloud::Error] if the RPC is aborted.
# File lib/google/cloud/security/private_ca/v1/certificate_authority_service/client.rb, line 234 def create_certificate request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Security::PrivateCA::V1::CreateCertificateRequest # Converts hash and nil to an options object options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h # Customize the options with defaults metadata = @config.rpcs.create_certificate.metadata.to_h # Set x-goog-api-client and x-goog-user-project headers metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::Security::PrivateCA::V1::VERSION metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = { "parent" => request.parent } request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&") metadata[:"x-goog-request-params"] ||= request_params_header options.apply_defaults timeout: @config.rpcs.create_certificate.timeout, metadata: metadata, retry_policy: @config.rpcs.create_certificate.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @certificate_authority_service_stub.call_rpc :create_certificate, request, options: options do |response, operation| yield response, operation if block_given? return response end rescue ::GRPC::BadStatus => e raise ::Google::Cloud::Error.from_error(e) end
Create a new {::Google::Cloud::Security::PrivateCA::V1::CertificateTemplate CertificateTemplate} in a given Project and Location.
@overload create_certificate_template
(request, options = nil)
Pass arguments to `create_certificate_template` via a request object, either of type {::Google::Cloud::Security::PrivateCA::V1::CreateCertificateTemplateRequest} or an equivalent Hash. @param request [::Google::Cloud::Security::PrivateCA::V1::CreateCertificateTemplateRequest, ::Hash] A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash. @param options [::Gapic::CallOptions, ::Hash] Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
@overload create_certificate_template
(parent: nil, certificate_template_id: nil, certificate_template: nil, request_id: nil)
Pass arguments to `create_certificate_template` via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above). @param parent [::String] Required. The resource name of the location associated with the {::Google::Cloud::Security::PrivateCA::V1::CertificateTemplate CertificateTemplate}, in the format `projects/*/locations/*`. @param certificate_template_id [::String] Required. It must be unique within a location and match the regular expression `[a-zA-Z0-9_-]{1,63}` @param certificate_template [::Google::Cloud::Security::PrivateCA::V1::CertificateTemplate, ::Hash] Required. A {::Google::Cloud::Security::PrivateCA::V1::CertificateTemplate CertificateTemplate} with initial field values. @param request_id [::String] Optional. An ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and t he request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Gapic::Operation] @yieldparam operation [::GRPC::ActiveCall::Operation]
@return [::Gapic::Operation]
@raise [::Google::Cloud::Error] if the RPC is aborted.
# File lib/google/cloud/security/private_ca/v1/certificate_authority_service/client.rb, line 2224 def create_certificate_template request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Security::PrivateCA::V1::CreateCertificateTemplateRequest # Converts hash and nil to an options object options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h # Customize the options with defaults metadata = @config.rpcs.create_certificate_template.metadata.to_h # Set x-goog-api-client and x-goog-user-project headers metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::Security::PrivateCA::V1::VERSION metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = { "parent" => request.parent } request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&") metadata[:"x-goog-request-params"] ||= request_params_header options.apply_defaults timeout: @config.rpcs.create_certificate_template.timeout, metadata: metadata, retry_policy: @config.rpcs.create_certificate_template.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @certificate_authority_service_stub.call_rpc :create_certificate_template, request, options: options do |response, operation| response = ::Gapic::Operation.new response, @operations_client, options: options yield response, operation if block_given? return response end rescue ::GRPC::BadStatus => e raise ::Google::Cloud::Error.from_error(e) end
Delete a {::Google::Cloud::Security::PrivateCA::V1::CaPool CaPool}.
@overload delete_ca_pool
(request, options = nil)
Pass arguments to `delete_ca_pool` via a request object, either of type {::Google::Cloud::Security::PrivateCA::V1::DeleteCaPoolRequest} or an equivalent Hash. @param request [::Google::Cloud::Security::PrivateCA::V1::DeleteCaPoolRequest, ::Hash] A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash. @param options [::Gapic::CallOptions, ::Hash] Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
@overload delete_ca_pool
(name: nil, request_id: nil)
Pass arguments to `delete_ca_pool` via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above). @param name [::String] Required. The resource name for this {::Google::Cloud::Security::PrivateCA::V1::CaPool CaPool} in the format `projects/*/locations/*/caPools/*`. @param request_id [::String] Optional. An ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and t he request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Gapic::Operation] @yieldparam operation [::GRPC::ActiveCall::Operation]
@return [::Gapic::Operation]
@raise [::Google::Cloud::Error] if the RPC is aborted.
# File lib/google/cloud/security/private_ca/v1/certificate_authority_service/client.rb, line 1810 def delete_ca_pool request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Security::PrivateCA::V1::DeleteCaPoolRequest # Converts hash and nil to an options object options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h # Customize the options with defaults metadata = @config.rpcs.delete_ca_pool.metadata.to_h # Set x-goog-api-client and x-goog-user-project headers metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::Security::PrivateCA::V1::VERSION metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = { "name" => request.name } request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&") metadata[:"x-goog-request-params"] ||= request_params_header options.apply_defaults timeout: @config.rpcs.delete_ca_pool.timeout, metadata: metadata, retry_policy: @config.rpcs.delete_ca_pool.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @certificate_authority_service_stub.call_rpc :delete_ca_pool, request, options: options do |response, operation| response = ::Gapic::Operation.new response, @operations_client, options: options yield response, operation if block_given? return response end rescue ::GRPC::BadStatus => e raise ::Google::Cloud::Error.from_error(e) end
DeleteCertificateTemplate deletes a {::Google::Cloud::Security::PrivateCA::V1::CertificateTemplate CertificateTemplate}.
@overload delete_certificate_template
(request, options = nil)
Pass arguments to `delete_certificate_template` via a request object, either of type {::Google::Cloud::Security::PrivateCA::V1::DeleteCertificateTemplateRequest} or an equivalent Hash. @param request [::Google::Cloud::Security::PrivateCA::V1::DeleteCertificateTemplateRequest, ::Hash] A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash. @param options [::Gapic::CallOptions, ::Hash] Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
@overload delete_certificate_template
(name: nil, request_id: nil)
Pass arguments to `delete_certificate_template` via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above). @param name [::String] Required. The resource name for this {::Google::Cloud::Security::PrivateCA::V1::CertificateTemplate CertificateTemplate} in the format `projects/*/locations/*/certificateTemplates/*`. @param request_id [::String] Optional. An ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and t he request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Gapic::Operation] @yieldparam operation [::GRPC::ActiveCall::Operation]
@return [::Gapic::Operation]
@raise [::Google::Cloud::Error] if the RPC is aborted.
# File lib/google/cloud/security/private_ca/v1/certificate_authority_service/client.rb, line 2308 def delete_certificate_template request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Security::PrivateCA::V1::DeleteCertificateTemplateRequest # Converts hash and nil to an options object options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h # Customize the options with defaults metadata = @config.rpcs.delete_certificate_template.metadata.to_h # Set x-goog-api-client and x-goog-user-project headers metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::Security::PrivateCA::V1::VERSION metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = { "name" => request.name } request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&") metadata[:"x-goog-request-params"] ||= request_params_header options.apply_defaults timeout: @config.rpcs.delete_certificate_template.timeout, metadata: metadata, retry_policy: @config.rpcs.delete_certificate_template.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @certificate_authority_service_stub.call_rpc :delete_certificate_template, request, options: options do |response, operation| response = ::Gapic::Operation.new response, @operations_client, options: options yield response, operation if block_given? return response end rescue ::GRPC::BadStatus => e raise ::Google::Cloud::Error.from_error(e) end
FetchCaCerts returns the current trust anchor for the {::Google::Cloud::Security::PrivateCA::V1::CaPool CaPool}. This will include CA certificate chains for all ACTIVE {::Google::Cloud::Security::PrivateCA::V1::CertificateAuthority CertificateAuthority} resources in the {::Google::Cloud::Security::PrivateCA::V1::CaPool CaPool}.
@overload fetch_ca_certs
(request, options = nil)
Pass arguments to `fetch_ca_certs` via a request object, either of type {::Google::Cloud::Security::PrivateCA::V1::FetchCaCertsRequest} or an equivalent Hash. @param request [::Google::Cloud::Security::PrivateCA::V1::FetchCaCertsRequest, ::Hash] A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash. @param options [::Gapic::CallOptions, ::Hash] Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
@overload fetch_ca_certs
(ca_pool: nil, request_id: nil)
Pass arguments to `fetch_ca_certs` via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above). @param ca_pool [::String] Required. The resource name for the {::Google::Cloud::Security::PrivateCA::V1::CaPool CaPool} in the format `projects/*/locations/*/caPools/*`. @param request_id [::String] Optional. An ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and t he request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Google::Cloud::Security::PrivateCA::V1::FetchCaCertsResponse] @yieldparam operation [::GRPC::ActiveCall::Operation]
@return [::Google::Cloud::Security::PrivateCA::V1::FetchCaCertsResponse]
@raise [::Google::Cloud::Error] if the RPC is aborted.
# File lib/google/cloud/security/private_ca/v1/certificate_authority_service/client.rb, line 1896 def fetch_ca_certs request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Security::PrivateCA::V1::FetchCaCertsRequest # Converts hash and nil to an options object options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h # Customize the options with defaults metadata = @config.rpcs.fetch_ca_certs.metadata.to_h # Set x-goog-api-client and x-goog-user-project headers metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::Security::PrivateCA::V1::VERSION metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = { "ca_pool" => request.ca_pool } request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&") metadata[:"x-goog-request-params"] ||= request_params_header options.apply_defaults timeout: @config.rpcs.fetch_ca_certs.timeout, metadata: metadata, retry_policy: @config.rpcs.fetch_ca_certs.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @certificate_authority_service_stub.call_rpc :fetch_ca_certs, request, options: options do |response, operation| yield response, operation if block_given? return response end rescue ::GRPC::BadStatus => e raise ::Google::Cloud::Error.from_error(e) end
Returns a {::Google::Cloud::Security::PrivateCA::V1::CaPool CaPool}.
@overload get_ca_pool
(request, options = nil)
Pass arguments to `get_ca_pool` via a request object, either of type {::Google::Cloud::Security::PrivateCA::V1::GetCaPoolRequest} or an equivalent Hash. @param request [::Google::Cloud::Security::PrivateCA::V1::GetCaPoolRequest, ::Hash] A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash. @param options [::Gapic::CallOptions, ::Hash] Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
@overload get_ca_pool
(name: nil)
Pass arguments to `get_ca_pool` via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above). @param name [::String] Required. The {::Google::Cloud::Security::PrivateCA::V1::CaPool#name name} of the {::Google::Cloud::Security::PrivateCA::V1::CaPool CaPool} to get.
@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Google::Cloud::Security::PrivateCA::V1::CaPool] @yieldparam operation [::GRPC::ActiveCall::Operation]
@return [::Google::Cloud::Security::PrivateCA::V1::CaPool]
@raise [::Google::Cloud::Error] if the RPC is aborted.
# File lib/google/cloud/security/private_ca/v1/certificate_authority_service/client.rb, line 1642 def get_ca_pool request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Security::PrivateCA::V1::GetCaPoolRequest # Converts hash and nil to an options object options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h # Customize the options with defaults metadata = @config.rpcs.get_ca_pool.metadata.to_h # Set x-goog-api-client and x-goog-user-project headers metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::Security::PrivateCA::V1::VERSION metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = { "name" => request.name } request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&") metadata[:"x-goog-request-params"] ||= request_params_header options.apply_defaults timeout: @config.rpcs.get_ca_pool.timeout, metadata: metadata, retry_policy: @config.rpcs.get_ca_pool.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @certificate_authority_service_stub.call_rpc :get_ca_pool, request, options: options do |response, operation| yield response, operation if block_given? return response end rescue ::GRPC::BadStatus => e raise ::Google::Cloud::Error.from_error(e) end
Returns a {::Google::Cloud::Security::PrivateCA::V1::Certificate Certificate}.
@overload get_certificate
(request, options = nil)
Pass arguments to `get_certificate` via a request object, either of type {::Google::Cloud::Security::PrivateCA::V1::GetCertificateRequest} or an equivalent Hash. @param request [::Google::Cloud::Security::PrivateCA::V1::GetCertificateRequest, ::Hash] A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash. @param options [::Gapic::CallOptions, ::Hash] Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
@overload get_certificate
(name: nil)
Pass arguments to `get_certificate` via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above). @param name [::String] Required. The {::Google::Cloud::Security::PrivateCA::V1::Certificate#name name} of the {::Google::Cloud::Security::PrivateCA::V1::Certificate Certificate} to get.
@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Google::Cloud::Security::PrivateCA::V1::Certificate] @yieldparam operation [::GRPC::ActiveCall::Operation]
@return [::Google::Cloud::Security::PrivateCA::V1::Certificate]
@raise [::Google::Cloud::Error] if the RPC is aborted.
# File lib/google/cloud/security/private_ca/v1/certificate_authority_service/client.rb, line 302 def get_certificate request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Security::PrivateCA::V1::GetCertificateRequest # Converts hash and nil to an options object options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h # Customize the options with defaults metadata = @config.rpcs.get_certificate.metadata.to_h # Set x-goog-api-client and x-goog-user-project headers metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::Security::PrivateCA::V1::VERSION metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = { "name" => request.name } request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&") metadata[:"x-goog-request-params"] ||= request_params_header options.apply_defaults timeout: @config.rpcs.get_certificate.timeout, metadata: metadata, retry_policy: @config.rpcs.get_certificate.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @certificate_authority_service_stub.call_rpc :get_certificate, request, options: options do |response, operation| yield response, operation if block_given? return response end rescue ::GRPC::BadStatus => e raise ::Google::Cloud::Error.from_error(e) end
Returns a {::Google::Cloud::Security::PrivateCA::V1::CertificateRevocationList CertificateRevocationList}.
@overload get_certificate_revocation_list
(request, options = nil)
Pass arguments to `get_certificate_revocation_list` via a request object, either of type {::Google::Cloud::Security::PrivateCA::V1::GetCertificateRevocationListRequest} or an equivalent Hash. @param request [::Google::Cloud::Security::PrivateCA::V1::GetCertificateRevocationListRequest, ::Hash] A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash. @param options [::Gapic::CallOptions, ::Hash] Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
@overload get_certificate_revocation_list
(name: nil)
Pass arguments to `get_certificate_revocation_list` via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above). @param name [::String] Required. The {::Google::Cloud::Security::PrivateCA::V1::CertificateRevocationList#name name} of the {::Google::Cloud::Security::PrivateCA::V1::CertificateRevocationList CertificateRevocationList} to get.
@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Google::Cloud::Security::PrivateCA::V1::CertificateRevocationList] @yieldparam operation [::GRPC::ActiveCall::Operation]
@return [::Google::Cloud::Security::PrivateCA::V1::CertificateRevocationList]
@raise [::Google::Cloud::Error] if the RPC is aborted.
# File lib/google/cloud/security/private_ca/v1/certificate_authority_service/client.rb, line 1965 def get_certificate_revocation_list request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Security::PrivateCA::V1::GetCertificateRevocationListRequest # Converts hash and nil to an options object options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h # Customize the options with defaults metadata = @config.rpcs.get_certificate_revocation_list.metadata.to_h # Set x-goog-api-client and x-goog-user-project headers metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::Security::PrivateCA::V1::VERSION metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = { "name" => request.name } request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&") metadata[:"x-goog-request-params"] ||= request_params_header options.apply_defaults timeout: @config.rpcs.get_certificate_revocation_list.timeout, metadata: metadata, retry_policy: @config.rpcs.get_certificate_revocation_list.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @certificate_authority_service_stub.call_rpc :get_certificate_revocation_list, request, options: options do |response, operation| yield response, operation if block_given? return response end rescue ::GRPC::BadStatus => e raise ::Google::Cloud::Error.from_error(e) end
Returns a {::Google::Cloud::Security::PrivateCA::V1::CertificateTemplate CertificateTemplate}.
@overload get_certificate_template
(request, options = nil)
Pass arguments to `get_certificate_template` via a request object, either of type {::Google::Cloud::Security::PrivateCA::V1::GetCertificateTemplateRequest} or an equivalent Hash. @param request [::Google::Cloud::Security::PrivateCA::V1::GetCertificateTemplateRequest, ::Hash] A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash. @param options [::Gapic::CallOptions, ::Hash] Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
@overload get_certificate_template
(name: nil)
Pass arguments to `get_certificate_template` via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above). @param name [::String] Required. The {::Google::Cloud::Security::PrivateCA::V1::CertificateTemplate#name name} of the {::Google::Cloud::Security::PrivateCA::V1::CertificateTemplate CertificateTemplate} to get.
@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Google::Cloud::Security::PrivateCA::V1::CertificateTemplate] @yieldparam operation [::GRPC::ActiveCall::Operation]
@return [::Google::Cloud::Security::PrivateCA::V1::CertificateTemplate]
@raise [::Google::Cloud::Error] if the RPC is aborted.
# File lib/google/cloud/security/private_ca/v1/certificate_authority_service/client.rb, line 2378 def get_certificate_template request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Security::PrivateCA::V1::GetCertificateTemplateRequest # Converts hash and nil to an options object options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h # Customize the options with defaults metadata = @config.rpcs.get_certificate_template.metadata.to_h # Set x-goog-api-client and x-goog-user-project headers metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::Security::PrivateCA::V1::VERSION metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = { "name" => request.name } request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&") metadata[:"x-goog-request-params"] ||= request_params_header options.apply_defaults timeout: @config.rpcs.get_certificate_template.timeout, metadata: metadata, retry_policy: @config.rpcs.get_certificate_template.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @certificate_authority_service_stub.call_rpc :get_certificate_template, request, options: options do |response, operation| yield response, operation if block_given? return response end rescue ::GRPC::BadStatus => e raise ::Google::Cloud::Error.from_error(e) end
Lists {::Google::Cloud::Security::PrivateCA::V1::CaPool CaPools}.
@overload list_ca_pools
(request, options = nil)
Pass arguments to `list_ca_pools` via a request object, either of type {::Google::Cloud::Security::PrivateCA::V1::ListCaPoolsRequest} or an equivalent Hash. @param request [::Google::Cloud::Security::PrivateCA::V1::ListCaPoolsRequest, ::Hash] A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash. @param options [::Gapic::CallOptions, ::Hash] Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
@overload list_ca_pools
(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil)
Pass arguments to `list_ca_pools` via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above). @param parent [::String] Required. The resource name of the location associated with the {::Google::Cloud::Security::PrivateCA::V1::CaPool CaPools}, in the format `projects/*/locations/*`. @param page_size [::Integer] Optional. Limit on the number of {::Google::Cloud::Security::PrivateCA::V1::CaPool CaPools} to include in the response. Further {::Google::Cloud::Security::PrivateCA::V1::CaPool CaPools} can subsequently be obtained by including the {::Google::Cloud::Security::PrivateCA::V1::ListCaPoolsResponse#next_page_token ListCaPoolsResponse.next_page_token} in a subsequent request. If unspecified, the server will pick an appropriate default. @param page_token [::String] Optional. Pagination token, returned earlier via {::Google::Cloud::Security::PrivateCA::V1::ListCaPoolsResponse#next_page_token ListCaPoolsResponse.next_page_token}. @param filter [::String] Optional. Only include resources that match the filter in the response. @param order_by [::String] Optional. Specify how the results should be sorted.
@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Gapic::PagedEnumerable<::Google::Cloud::Security::PrivateCA::V1::CaPool>] @yieldparam operation [::GRPC::ActiveCall::Operation]
@return [::Gapic::PagedEnumerable<::Google::Cloud::Security::PrivateCA::V1::CaPool>]
@raise [::Google::Cloud::Error] if the RPC is aborted.
# File lib/google/cloud/security/private_ca/v1/certificate_authority_service/client.rb, line 1726 def list_ca_pools request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Security::PrivateCA::V1::ListCaPoolsRequest # Converts hash and nil to an options object options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h # Customize the options with defaults metadata = @config.rpcs.list_ca_pools.metadata.to_h # Set x-goog-api-client and x-goog-user-project headers metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::Security::PrivateCA::V1::VERSION metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = { "parent" => request.parent } request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&") metadata[:"x-goog-request-params"] ||= request_params_header options.apply_defaults timeout: @config.rpcs.list_ca_pools.timeout, metadata: metadata, retry_policy: @config.rpcs.list_ca_pools.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @certificate_authority_service_stub.call_rpc :list_ca_pools, request, options: options do |response, operation| response = ::Gapic::PagedEnumerable.new @certificate_authority_service_stub, :list_ca_pools, request, response, operation, options yield response, operation if block_given? return response end rescue ::GRPC::BadStatus => e raise ::Google::Cloud::Error.from_error(e) end
Lists {::Google::Cloud::Security::PrivateCA::V1::CertificateRevocationList CertificateRevocationLists}.
@overload list_certificate_revocation_lists
(request, options = nil)
Pass arguments to `list_certificate_revocation_lists` via a request object, either of type {::Google::Cloud::Security::PrivateCA::V1::ListCertificateRevocationListsRequest} or an equivalent Hash. @param request [::Google::Cloud::Security::PrivateCA::V1::ListCertificateRevocationListsRequest, ::Hash] A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash. @param options [::Gapic::CallOptions, ::Hash] Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
@overload list_certificate_revocation_lists
(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil)
Pass arguments to `list_certificate_revocation_lists` via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above). @param parent [::String] Required. The resource name of the location associated with the {::Google::Cloud::Security::PrivateCA::V1::CertificateRevocationList CertificateRevocationLists}, in the format `projects/*/locations/*/caPools/*/certificateAuthorities/*`. @param page_size [::Integer] Optional. Limit on the number of {::Google::Cloud::Security::PrivateCA::V1::CertificateRevocationList CertificateRevocationLists} to include in the response. Further {::Google::Cloud::Security::PrivateCA::V1::CertificateRevocationList CertificateRevocationLists} can subsequently be obtained by including the {::Google::Cloud::Security::PrivateCA::V1::ListCertificateRevocationListsResponse#next_page_token ListCertificateRevocationListsResponse.next_page_token} in a subsequent request. If unspecified, the server will pick an appropriate default. @param page_token [::String] Optional. Pagination token, returned earlier via {::Google::Cloud::Security::PrivateCA::V1::ListCertificateRevocationListsResponse#next_page_token ListCertificateRevocationListsResponse.next_page_token}. @param filter [::String] Optional. Only include resources that match the filter in the response. @param order_by [::String] Optional. Specify how the results should be sorted.
@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Gapic::PagedEnumerable<::Google::Cloud::Security::PrivateCA::V1::CertificateRevocationList>] @yieldparam operation [::GRPC::ActiveCall::Operation]
@return [::Gapic::PagedEnumerable<::Google::Cloud::Security::PrivateCA::V1::CertificateRevocationList>]
@raise [::Google::Cloud::Error] if the RPC is aborted.
# File lib/google/cloud/security/private_ca/v1/certificate_authority_service/client.rb, line 2049 def list_certificate_revocation_lists request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Security::PrivateCA::V1::ListCertificateRevocationListsRequest # Converts hash and nil to an options object options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h # Customize the options with defaults metadata = @config.rpcs.list_certificate_revocation_lists.metadata.to_h # Set x-goog-api-client and x-goog-user-project headers metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::Security::PrivateCA::V1::VERSION metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = { "parent" => request.parent } request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&") metadata[:"x-goog-request-params"] ||= request_params_header options.apply_defaults timeout: @config.rpcs.list_certificate_revocation_lists.timeout, metadata: metadata, retry_policy: @config.rpcs.list_certificate_revocation_lists.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @certificate_authority_service_stub.call_rpc :list_certificate_revocation_lists, request, options: options do |response, operation| response = ::Gapic::PagedEnumerable.new @certificate_authority_service_stub, :list_certificate_revocation_lists, request, response, operation, options yield response, operation if block_given? return response end rescue ::GRPC::BadStatus => e raise ::Google::Cloud::Error.from_error(e) end
Lists {::Google::Cloud::Security::PrivateCA::V1::CertificateTemplate CertificateTemplates}.
@overload list_certificate_templates
(request, options = nil)
Pass arguments to `list_certificate_templates` via a request object, either of type {::Google::Cloud::Security::PrivateCA::V1::ListCertificateTemplatesRequest} or an equivalent Hash. @param request [::Google::Cloud::Security::PrivateCA::V1::ListCertificateTemplatesRequest, ::Hash] A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash. @param options [::Gapic::CallOptions, ::Hash] Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
@overload list_certificate_templates
(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil)
Pass arguments to `list_certificate_templates` via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above). @param parent [::String] Required. The resource name of the location associated with the {::Google::Cloud::Security::PrivateCA::V1::CertificateTemplate CertificateTemplates}, in the format `projects/*/locations/*`. @param page_size [::Integer] Optional. Limit on the number of {::Google::Cloud::Security::PrivateCA::V1::CertificateTemplate CertificateTemplates} to include in the response. Further {::Google::Cloud::Security::PrivateCA::V1::CertificateTemplate CertificateTemplates} can subsequently be obtained by including the {::Google::Cloud::Security::PrivateCA::V1::ListCertificateTemplatesResponse#next_page_token ListCertificateTemplatesResponse.next_page_token} in a subsequent request. If unspecified, the server will pick an appropriate default. @param page_token [::String] Optional. Pagination token, returned earlier via {::Google::Cloud::Security::PrivateCA::V1::ListCertificateTemplatesResponse#next_page_token ListCertificateTemplatesResponse.next_page_token}. @param filter [::String] Optional. Only include resources that match the filter in the response. @param order_by [::String] Optional. Specify how the results should be sorted.
@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Gapic::PagedEnumerable<::Google::Cloud::Security::PrivateCA::V1::CertificateTemplate>] @yieldparam operation [::GRPC::ActiveCall::Operation]
@return [::Gapic::PagedEnumerable<::Google::Cloud::Security::PrivateCA::V1::CertificateTemplate>]
@raise [::Google::Cloud::Error] if the RPC is aborted.
# File lib/google/cloud/security/private_ca/v1/certificate_authority_service/client.rb, line 2462 def list_certificate_templates request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Security::PrivateCA::V1::ListCertificateTemplatesRequest # Converts hash and nil to an options object options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h # Customize the options with defaults metadata = @config.rpcs.list_certificate_templates.metadata.to_h # Set x-goog-api-client and x-goog-user-project headers metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::Security::PrivateCA::V1::VERSION metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = { "parent" => request.parent } request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&") metadata[:"x-goog-request-params"] ||= request_params_header options.apply_defaults timeout: @config.rpcs.list_certificate_templates.timeout, metadata: metadata, retry_policy: @config.rpcs.list_certificate_templates.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @certificate_authority_service_stub.call_rpc :list_certificate_templates, request, options: options do |response, operation| response = ::Gapic::PagedEnumerable.new @certificate_authority_service_stub, :list_certificate_templates, request, response, operation, options yield response, operation if block_given? return response end rescue ::GRPC::BadStatus => e raise ::Google::Cloud::Error.from_error(e) end
Lists {::Google::Cloud::Security::PrivateCA::V1::Certificate Certificates}.
@overload list_certificates
(request, options = nil)
Pass arguments to `list_certificates` via a request object, either of type {::Google::Cloud::Security::PrivateCA::V1::ListCertificatesRequest} or an equivalent Hash. @param request [::Google::Cloud::Security::PrivateCA::V1::ListCertificatesRequest, ::Hash] A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash. @param options [::Gapic::CallOptions, ::Hash] Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
@overload list_certificates
(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil)
Pass arguments to `list_certificates` via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above). @param parent [::String] Required. The resource name of the location associated with the {::Google::Cloud::Security::PrivateCA::V1::Certificate Certificates}, in the format `projects/*/locations/*/caPools/*`. @param page_size [::Integer] Optional. Limit on the number of {::Google::Cloud::Security::PrivateCA::V1::Certificate Certificates} to include in the response. Further {::Google::Cloud::Security::PrivateCA::V1::Certificate Certificates} can subsequently be obtained by including the {::Google::Cloud::Security::PrivateCA::V1::ListCertificatesResponse#next_page_token ListCertificatesResponse.next_page_token} in a subsequent request. If unspecified, the server will pick an appropriate default. @param page_token [::String] Optional. Pagination token, returned earlier via {::Google::Cloud::Security::PrivateCA::V1::ListCertificatesResponse#next_page_token ListCertificatesResponse.next_page_token}. @param filter [::String] Optional. Only include resources that match the filter in the response. For details on supported filters and syntax, see [Certificates Filtering documentation](https://cloud.google.com/certificate-authority-service/docs/sorting-filtering-certificates#filtering_support). @param order_by [::String] Optional. Specify how the results should be sorted. For details on supported fields and syntax, see [Certificates Sorting documentation](https://cloud.google.com/certificate-authority-service/docs/sorting-filtering-certificates#sorting_support).
@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Gapic::PagedEnumerable<::Google::Cloud::Security::PrivateCA::V1::Certificate>] @yieldparam operation [::GRPC::ActiveCall::Operation]
@return [::Gapic::PagedEnumerable<::Google::Cloud::Security::PrivateCA::V1::Certificate>]
@raise [::Google::Cloud::Error] if the RPC is aborted.
# File lib/google/cloud/security/private_ca/v1/certificate_authority_service/client.rb, line 390 def list_certificates request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Security::PrivateCA::V1::ListCertificatesRequest # Converts hash and nil to an options object options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h # Customize the options with defaults metadata = @config.rpcs.list_certificates.metadata.to_h # Set x-goog-api-client and x-goog-user-project headers metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::Security::PrivateCA::V1::VERSION metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = { "parent" => request.parent } request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&") metadata[:"x-goog-request-params"] ||= request_params_header options.apply_defaults timeout: @config.rpcs.list_certificates.timeout, metadata: metadata, retry_policy: @config.rpcs.list_certificates.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @certificate_authority_service_stub.call_rpc :list_certificates, request, options: options do |response, operation| response = ::Gapic::PagedEnumerable.new @certificate_authority_service_stub, :list_certificates, request, response, operation, options yield response, operation if block_given? return response end rescue ::GRPC::BadStatus => e raise ::Google::Cloud::Error.from_error(e) end
Revoke a {::Google::Cloud::Security::PrivateCA::V1::Certificate Certificate}.
@overload revoke_certificate
(request, options = nil)
Pass arguments to `revoke_certificate` via a request object, either of type {::Google::Cloud::Security::PrivateCA::V1::RevokeCertificateRequest} or an equivalent Hash. @param request [::Google::Cloud::Security::PrivateCA::V1::RevokeCertificateRequest, ::Hash] A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash. @param options [::Gapic::CallOptions, ::Hash] Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
@overload revoke_certificate
(name: nil, reason: nil, request_id: nil)
Pass arguments to `revoke_certificate` via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above). @param name [::String] Required. The resource name for this {::Google::Cloud::Security::PrivateCA::V1::Certificate Certificate} in the format `projects/*/locations/*/caPools/*/certificates/*`. @param reason [::Google::Cloud::Security::PrivateCA::V1::RevocationReason] Required. The {::Google::Cloud::Security::PrivateCA::V1::RevocationReason RevocationReason} for revoking this certificate. @param request_id [::String] Optional. An ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and t he request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Google::Cloud::Security::PrivateCA::V1::Certificate] @yieldparam operation [::GRPC::ActiveCall::Operation]
@return [::Google::Cloud::Security::PrivateCA::V1::Certificate]
@raise [::Google::Cloud::Error] if the RPC is aborted.
# File lib/google/cloud/security/private_ca/v1/certificate_authority_service/client.rb, line 477 def revoke_certificate request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Security::PrivateCA::V1::RevokeCertificateRequest # Converts hash and nil to an options object options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h # Customize the options with defaults metadata = @config.rpcs.revoke_certificate.metadata.to_h # Set x-goog-api-client and x-goog-user-project headers metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::Security::PrivateCA::V1::VERSION metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = { "name" => request.name } request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&") metadata[:"x-goog-request-params"] ||= request_params_header options.apply_defaults timeout: @config.rpcs.revoke_certificate.timeout, metadata: metadata, retry_policy: @config.rpcs.revoke_certificate.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @certificate_authority_service_stub.call_rpc :revoke_certificate, request, options: options do |response, operation| yield response, operation if block_given? return response end rescue ::GRPC::BadStatus => e raise ::Google::Cloud::Error.from_error(e) end
Update a {::Google::Cloud::Security::PrivateCA::V1::CaPool CaPool}.
@overload update_ca_pool
(request, options = nil)
Pass arguments to `update_ca_pool` via a request object, either of type {::Google::Cloud::Security::PrivateCA::V1::UpdateCaPoolRequest} or an equivalent Hash. @param request [::Google::Cloud::Security::PrivateCA::V1::UpdateCaPoolRequest, ::Hash] A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash. @param options [::Gapic::CallOptions, ::Hash] Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
@overload update_ca_pool
(ca_pool: nil, update_mask: nil, request_id: nil)
Pass arguments to `update_ca_pool` via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above). @param ca_pool [::Google::Cloud::Security::PrivateCA::V1::CaPool, ::Hash] Required. {::Google::Cloud::Security::PrivateCA::V1::CaPool CaPool} with updated values. @param update_mask [::Google::Protobuf::FieldMask, ::Hash] Required. A list of fields to be updated in this request. @param request_id [::String] Optional. An ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and t he request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Gapic::Operation] @yieldparam operation [::GRPC::ActiveCall::Operation]
@return [::Gapic::Operation]
@raise [::Google::Cloud::Error] if the RPC is aborted.
# File lib/google/cloud/security/private_ca/v1/certificate_authority_service/client.rb, line 1573 def update_ca_pool request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Security::PrivateCA::V1::UpdateCaPoolRequest # Converts hash and nil to an options object options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h # Customize the options with defaults metadata = @config.rpcs.update_ca_pool.metadata.to_h # Set x-goog-api-client and x-goog-user-project headers metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::Security::PrivateCA::V1::VERSION metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = { "ca_pool.name" => request.ca_pool.name } request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&") metadata[:"x-goog-request-params"] ||= request_params_header options.apply_defaults timeout: @config.rpcs.update_ca_pool.timeout, metadata: metadata, retry_policy: @config.rpcs.update_ca_pool.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @certificate_authority_service_stub.call_rpc :update_ca_pool, request, options: options do |response, operation| response = ::Gapic::Operation.new response, @operations_client, options: options yield response, operation if block_given? return response end rescue ::GRPC::BadStatus => e raise ::Google::Cloud::Error.from_error(e) end
Update a {::Google::Cloud::Security::PrivateCA::V1::Certificate Certificate}. Currently, the only field you can update is the {::Google::Cloud::Security::PrivateCA::V1::Certificate#labels labels} field.
@overload update_certificate
(request, options = nil)
Pass arguments to `update_certificate` via a request object, either of type {::Google::Cloud::Security::PrivateCA::V1::UpdateCertificateRequest} or an equivalent Hash. @param request [::Google::Cloud::Security::PrivateCA::V1::UpdateCertificateRequest, ::Hash] A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash. @param options [::Gapic::CallOptions, ::Hash] Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
@overload update_certificate
(certificate: nil, update_mask: nil, request_id: nil)
Pass arguments to `update_certificate` via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above). @param certificate [::Google::Cloud::Security::PrivateCA::V1::Certificate, ::Hash] Required. {::Google::Cloud::Security::PrivateCA::V1::Certificate Certificate} with updated values. @param update_mask [::Google::Protobuf::FieldMask, ::Hash] Required. A list of fields to be updated in this request. @param request_id [::String] Optional. An ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and t he request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Google::Cloud::Security::PrivateCA::V1::Certificate] @yieldparam operation [::GRPC::ActiveCall::Operation]
@return [::Google::Cloud::Security::PrivateCA::V1::Certificate]
@raise [::Google::Cloud::Error] if the RPC is aborted.
# File lib/google/cloud/security/private_ca/v1/certificate_authority_service/client.rb, line 562 def update_certificate request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Security::PrivateCA::V1::UpdateCertificateRequest # Converts hash and nil to an options object options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h # Customize the options with defaults metadata = @config.rpcs.update_certificate.metadata.to_h # Set x-goog-api-client and x-goog-user-project headers metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::Security::PrivateCA::V1::VERSION metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = { "certificate.name" => request.certificate.name } request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&") metadata[:"x-goog-request-params"] ||= request_params_header options.apply_defaults timeout: @config.rpcs.update_certificate.timeout, metadata: metadata, retry_policy: @config.rpcs.update_certificate.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @certificate_authority_service_stub.call_rpc :update_certificate, request, options: options do |response, operation| yield response, operation if block_given? return response end rescue ::GRPC::BadStatus => e raise ::Google::Cloud::Error.from_error(e) end
Update a {::Google::Cloud::Security::PrivateCA::V1::CertificateRevocationList CertificateRevocationList}.
@overload update_certificate_revocation_list
(request, options = nil)
Pass arguments to `update_certificate_revocation_list` via a request object, either of type {::Google::Cloud::Security::PrivateCA::V1::UpdateCertificateRevocationListRequest} or an equivalent Hash. @param request [::Google::Cloud::Security::PrivateCA::V1::UpdateCertificateRevocationListRequest, ::Hash] A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash. @param options [::Gapic::CallOptions, ::Hash] Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
@overload update_certificate_revocation_list
(certificate_revocation_list: nil, update_mask: nil, request_id: nil)
Pass arguments to `update_certificate_revocation_list` via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above). @param certificate_revocation_list [::Google::Cloud::Security::PrivateCA::V1::CertificateRevocationList, ::Hash] Required. {::Google::Cloud::Security::PrivateCA::V1::CertificateRevocationList CertificateRevocationList} with updated values. @param update_mask [::Google::Protobuf::FieldMask, ::Hash] Required. A list of fields to be updated in this request. @param request_id [::String] Optional. An ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and t he request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Gapic::Operation] @yieldparam operation [::GRPC::ActiveCall::Operation]
@return [::Gapic::Operation]
@raise [::Google::Cloud::Error] if the RPC is aborted.
# File lib/google/cloud/security/private_ca/v1/certificate_authority_service/client.rb, line 2134 def update_certificate_revocation_list request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Security::PrivateCA::V1::UpdateCertificateRevocationListRequest # Converts hash and nil to an options object options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h # Customize the options with defaults metadata = @config.rpcs.update_certificate_revocation_list.metadata.to_h # Set x-goog-api-client and x-goog-user-project headers metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::Security::PrivateCA::V1::VERSION metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = { "certificate_revocation_list.name" => request.certificate_revocation_list.name } request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&") metadata[:"x-goog-request-params"] ||= request_params_header options.apply_defaults timeout: @config.rpcs.update_certificate_revocation_list.timeout, metadata: metadata, retry_policy: @config.rpcs.update_certificate_revocation_list.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @certificate_authority_service_stub.call_rpc :update_certificate_revocation_list, request, options: options do |response, operation| response = ::Gapic::Operation.new response, @operations_client, options: options yield response, operation if block_given? return response end rescue ::GRPC::BadStatus => e raise ::Google::Cloud::Error.from_error(e) end
Update a {::Google::Cloud::Security::PrivateCA::V1::CertificateTemplate CertificateTemplate}.
@overload update_certificate_template
(request, options = nil)
Pass arguments to `update_certificate_template` via a request object, either of type {::Google::Cloud::Security::PrivateCA::V1::UpdateCertificateTemplateRequest} or an equivalent Hash. @param request [::Google::Cloud::Security::PrivateCA::V1::UpdateCertificateTemplateRequest, ::Hash] A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash. @param options [::Gapic::CallOptions, ::Hash] Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
@overload update_certificate_template
(certificate_template: nil, update_mask: nil, request_id: nil)
Pass arguments to `update_certificate_template` via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above). @param certificate_template [::Google::Cloud::Security::PrivateCA::V1::CertificateTemplate, ::Hash] Required. {::Google::Cloud::Security::PrivateCA::V1::CertificateTemplate CertificateTemplate} with updated values. @param update_mask [::Google::Protobuf::FieldMask, ::Hash] Required. A list of fields to be updated in this request. @param request_id [::String] Optional. An ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and t he request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Gapic::Operation] @yieldparam operation [::GRPC::ActiveCall::Operation]
@return [::Gapic::Operation]
@raise [::Google::Cloud::Error] if the RPC is aborted.
# File lib/google/cloud/security/private_ca/v1/certificate_authority_service/client.rb, line 2547 def update_certificate_template request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Security::PrivateCA::V1::UpdateCertificateTemplateRequest # Converts hash and nil to an options object options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h # Customize the options with defaults metadata = @config.rpcs.update_certificate_template.metadata.to_h # Set x-goog-api-client and x-goog-user-project headers metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::Security::PrivateCA::V1::VERSION metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = { "certificate_template.name" => request.certificate_template.name } request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&") metadata[:"x-goog-request-params"] ||= request_params_header options.apply_defaults timeout: @config.rpcs.update_certificate_template.timeout, metadata: metadata, retry_policy: @config.rpcs.update_certificate_template.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @certificate_authority_service_stub.call_rpc :update_certificate_template, request, options: options do |response, operation| response = ::Gapic::Operation.new response, @operations_client, options: options yield response, operation if block_given? return response end rescue ::GRPC::BadStatus => e raise ::Google::Cloud::Error.from_error(e) end