Certificate Authority Service V1 API - Class Google::Cloud::Security::PrivateCA::V1::CertificateAuthorityService::Rest::Client (v1.1.0)

Version latest

• 1.1.0 (latest)
• 1.0.1
• 0.13.0
• 0.12.0
• 0.11.0
• 0.10.2
• 0.9.0
• 0.8.1
• 0.7.0
• 0.6.0
• 0.5.0
• 0.4.0
• 0.3.0
• 0.2.1
• 0.1.6

Reference documentation and code samples for the Certificate Authority Service V1 API class Google::Cloud::Security::PrivateCA::V1::CertificateAuthorityService::Rest::Client.

REST client for the CertificateAuthorityService service.

[Certificate Authority Service][google.cloud.security.privateca.v1.CertificateAuthorityService] manages private certificate authorities and issued certificates.

Inherits

• Object

Includes

• Google::Cloud::Security::PrivateCA::V1::CertificateAuthorityService::Paths

Methods

.configure

def self.configure() { |config| ... } -> Client::Configuration

Configure the CertificateAuthorityService Client class.

See Configuration for a description of the configuration fields.

Yields

• (config) — Configure the Client client.

Yield Parameter

• config (Client::Configuration)

Returns

• (Client::Configuration)

Example

# Modify the configuration for all CertificateAuthorityService clients
::Google::Cloud::Security::PrivateCA::V1::CertificateAuthorityService::Rest::Client.configure do |config|
  config.timeout = 10.0
end

#activate_certificate_authority

def activate_certificate_authority(request, options = nil) -> ::Gapic::Operation
def activate_certificate_authority(name: nil, pem_ca_certificate: nil, subordinate_config: nil, request_id: nil) -> ::Gapic::Operation

Activate a CertificateAuthority that is in state AWAITING_USER_ACTIVATION and is of type SUBORDINATE. After the parent Certificate Authority signs a certificate signing request from FetchCertificateAuthorityCsr, this method can complete the activation process.

Overloads

def activate_certificate_authority(request, options = nil) -> ::Gapic::Operation

Pass arguments to activate_certificate_authority via a request object, either of type ActivateCertificateAuthorityRequest or an equivalent Hash.

Parameters

• request (::Google::Cloud::Security::PrivateCA::V1::ActivateCertificateAuthorityRequest, ::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.
• options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

def activate_certificate_authority(name: nil, pem_ca_certificate: nil, subordinate_config: nil, request_id: nil) -> ::Gapic::Operation

Pass arguments to activate_certificate_authority 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).

Parameters

• name (::String) — Required. The resource name for this CertificateAuthority in the format projects/*/locations/*/caPools/*/certificateAuthorities/*.
• pem_ca_certificate (::String) — Required. The signed CA certificate issued from FetchCertificateAuthorityCsrResponse.pem_csr.
• subordinate_config (::Google::Cloud::Security::PrivateCA::V1::SubordinateConfig, ::Hash) — Required. Must include information about the issuer of 'pem_ca_certificate', and any further issuers until the self-signed CA.
• 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 the 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).

Yields

• (result, operation) — Access the result along with the TransportOperation object

Yield Parameters

• result (::Gapic::Operation)
• operation (::Gapic::Rest::TransportOperation)

Returns

• (::Gapic::Operation)

Raises

• (::Google::Cloud::Error) — if the REST call is aborted.

Example

Basic example

require "google/cloud/security/private_ca/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Security::PrivateCA::V1::CertificateAuthorityService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Security::PrivateCA::V1::ActivateCertificateAuthorityRequest.new

# Call the activate_certificate_authority method.
result = client.activate_certificate_authority request

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

#configure

def configure() { |config| ... } -> Client::Configuration

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 Configuration for a description of the configuration fields.

Yields

• (config) — Configure the Client client.

Yield Parameter

• config (Client::Configuration)

Returns

• (Client::Configuration)

#create_ca_pool

def create_ca_pool(request, options = nil) -> ::Gapic::Operation
def create_ca_pool(parent: nil, ca_pool_id: nil, ca_pool: nil, request_id: nil) -> ::Gapic::Operation

Create a CaPool.

Overloads

def create_ca_pool(request, options = nil) -> ::Gapic::Operation

Pass arguments to create_ca_pool via a request object, either of type Google::Cloud::Security::PrivateCA::V1::CreateCaPoolRequest or an equivalent Hash.

Parameters

• 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.
• options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

def create_ca_pool(parent: nil, ca_pool_id: nil, ca_pool: nil, request_id: nil) -> ::Gapic::Operation

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).

Parameters

• parent (::String) — Required. The resource name of the location associated with the CaPool, in the format projects/*/locations/*.
• ca_pool_id (::String) — Required. It must be unique within a location and match the regular expression [a-zA-Z0-9_-]{1,63}
• ca_pool (::Google::Cloud::Security::PrivateCA::V1::CaPool, ::Hash) — Required. A CaPool with initial field values.
• 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 the 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).

Yields

• (result, operation) — Access the result along with the TransportOperation object

Yield Parameters

• result (::Gapic::Operation)
• operation (::Gapic::Rest::TransportOperation)

Returns

• (::Gapic::Operation)

Raises

• (::Google::Cloud::Error) — if the REST call is aborted.

Example

Basic example

require "google/cloud/security/private_ca/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Security::PrivateCA::V1::CertificateAuthorityService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Security::PrivateCA::V1::CreateCaPoolRequest.new

# Call the create_ca_pool method.
result = client.create_ca_pool request

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

#create_certificate

def create_certificate(request, options = nil) -> ::Google::Cloud::Security::PrivateCA::V1::Certificate
def create_certificate(parent: nil, certificate_id: nil, certificate: nil, request_id: nil, validate_only: nil, issuing_certificate_authority_id: nil) -> ::Google::Cloud::Security::PrivateCA::V1::Certificate

Create a new Certificate in a given Project, Location from a particular CaPool.

Overloads

def create_certificate(request, options = nil) -> ::Google::Cloud::Security::PrivateCA::V1::Certificate

Pass arguments to create_certificate via a request object, either of type Google::Cloud::Security::PrivateCA::V1::CreateCertificateRequest or an equivalent Hash.

Parameters

• 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.
• options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

def create_certificate(parent: nil, certificate_id: nil, certificate: nil, request_id: nil, validate_only: nil, issuing_certificate_authority_id: nil) -> ::Google::Cloud::Security::PrivateCA::V1::Certificate

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).

Parameters

• parent (::String) — Required. The resource name of the CaPool associated with the Certificate, in the format projects/*/locations/*/caPools/*.
• 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 CertificateAuthority in the Enterprise [CertificateAuthority.Tier][], but is optional and its value is ignored otherwise.
• certificate (::Google::Cloud::Security::PrivateCA::V1::Certificate, ::Hash) — Required. A Certificate with initial field values.
• 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 the 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).

• validate_only (::Boolean) — Optional. If this is true, no Certificate resource will be persisted regardless of the CaPool's tier, and the returned Certificate will not contain the pem_certificate field.
• issuing_certificate_authority_id (::String) — Optional. The resource ID of the 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 CaPool referenced by parent. Per-CA quota rules apply. If left empty, a CertificateAuthority will be chosen from the CaPool by the service. For example, to issue a Certificate from a Certificate Authority with resource name "projects/my-project/locations/us-central1/caPools/my-pool/certificateAuthorities/my-ca", you can set the parent to "projects/my-project/locations/us-central1/caPools/my-pool" and the issuing_certificate_authority_id to "my-ca".

Yields

• (result, operation) — Access the result along with the TransportOperation object

Yield Parameters

• result (::Google::Cloud::Security::PrivateCA::V1::Certificate)
• operation (::Gapic::Rest::TransportOperation)

Returns

• (::Google::Cloud::Security::PrivateCA::V1::Certificate)

Raises

• (::Google::Cloud::Error) — if the REST call is aborted.

Example

Basic example

require "google/cloud/security/private_ca/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Security::PrivateCA::V1::CertificateAuthorityService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Security::PrivateCA::V1::CreateCertificateRequest.new

# Call the create_certificate method.
result = client.create_certificate request

# The returned object is of type Google::Cloud::Security::PrivateCA::V1::Certificate.
p result

#create_certificate_authority

def create_certificate_authority(request, options = nil) -> ::Gapic::Operation
def create_certificate_authority(parent: nil, certificate_authority_id: nil, certificate_authority: nil, request_id: nil) -> ::Gapic::Operation

Create a new CertificateAuthority in a given Project and Location.

Overloads

def create_certificate_authority(request, options = nil) -> ::Gapic::Operation

Pass arguments to create_certificate_authority via a request object, either of type Google::Cloud::Security::PrivateCA::V1::CreateCertificateAuthorityRequest or an equivalent Hash.

Parameters

• request (::Google::Cloud::Security::PrivateCA::V1::CreateCertificateAuthorityRequest, ::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.
• options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

def create_certificate_authority(parent: nil, certificate_authority_id: nil, certificate_authority: nil, request_id: nil) -> ::Gapic::Operation

Pass arguments to create_certificate_authority 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).

Parameters

• parent (::String) — Required. The resource name of the CaPool associated with the CertificateAuthorities, in the format projects/*/locations/*/caPools/*.
• certificate_authority_id (::String) — Required. It must be unique within a location and match the regular expression [a-zA-Z0-9_-]{1,63}
• certificate_authority (::Google::Cloud::Security::PrivateCA::V1::CertificateAuthority, ::Hash) — Required. A CertificateAuthority with initial field values.
• 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 the 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).

Yields

• (result, operation) — Access the result along with the TransportOperation object

Yield Parameters

• result (::Gapic::Operation)
• operation (::Gapic::Rest::TransportOperation)

Returns

• (::Gapic::Operation)

Raises

• (::Google::Cloud::Error) — if the REST call is aborted.

Example

Basic example

require "google/cloud/security/private_ca/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Security::PrivateCA::V1::CertificateAuthorityService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Security::PrivateCA::V1::CreateCertificateAuthorityRequest.new

# Call the create_certificate_authority method.
result = client.create_certificate_authority request

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

#create_certificate_template

def create_certificate_template(request, options = nil) -> ::Gapic::Operation
def create_certificate_template(parent: nil, certificate_template_id: nil, certificate_template: nil, request_id: nil) -> ::Gapic::Operation

Create a new CertificateTemplate in a given Project and Location.

Overloads

def create_certificate_template(request, options = nil) -> ::Gapic::Operation

Pass arguments to create_certificate_template via a request object, either of type Google::Cloud::Security::PrivateCA::V1::CreateCertificateTemplateRequest or an equivalent Hash.

Parameters

• 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.
• options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

def create_certificate_template(parent: nil, certificate_template_id: nil, certificate_template: nil, request_id: nil) -> ::Gapic::Operation

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).

Parameters

• parent (::String) — Required. The resource name of the location associated with the CertificateTemplate, in the format projects/*/locations/*.
• certificate_template_id (::String) — Required. It must be unique within a location and match the regular expression [a-zA-Z0-9_-]{1,63}
• certificate_template (::Google::Cloud::Security::PrivateCA::V1::CertificateTemplate, ::Hash) — Required. A CertificateTemplate with initial field values.
• 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 the 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).

Yields

• (result, operation) — Access the result along with the TransportOperation object

Yield Parameters

• result (::Gapic::Operation)
• operation (::Gapic::Rest::TransportOperation)

Returns

• (::Gapic::Operation)

Raises

• (::Google::Cloud::Error) — if the REST call is aborted.

Example

Basic example

require "google/cloud/security/private_ca/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Security::PrivateCA::V1::CertificateAuthorityService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Security::PrivateCA::V1::CreateCertificateTemplateRequest.new

# Call the create_certificate_template method.
result = client.create_certificate_template request

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

#delete_ca_pool

def delete_ca_pool(request, options = nil) -> ::Gapic::Operation
def delete_ca_pool(name: nil, request_id: nil, ignore_dependent_resources: nil) -> ::Gapic::Operation

Delete a CaPool.

Overloads

def delete_ca_pool(request, options = nil) -> ::Gapic::Operation

Pass arguments to delete_ca_pool via a request object, either of type DeleteCaPoolRequest or an equivalent Hash.

Parameters

• 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.
• options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

def delete_ca_pool(name: nil, request_id: nil, ignore_dependent_resources: nil) -> ::Gapic::Operation

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).

Parameters

• name (::String) — Required. The resource name for this CaPool in the format projects/*/locations/*/caPools/*.
• 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 the 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).

• ignore_dependent_resources (::Boolean) — Optional. This field allows this pool to be deleted even if it's being depended on by another resource. However, doing so may result in unintended and unrecoverable effects on any dependent resources since the pool will no longer be able to issue certificates.

Yields

• (result, operation) — Access the result along with the TransportOperation object

Yield Parameters

• result (::Gapic::Operation)
• operation (::Gapic::Rest::TransportOperation)

Returns

• (::Gapic::Operation)

Raises

• (::Google::Cloud::Error) — if the REST call is aborted.

Example

Basic example

require "google/cloud/security/private_ca/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Security::PrivateCA::V1::CertificateAuthorityService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Security::PrivateCA::V1::DeleteCaPoolRequest.new

# Call the delete_ca_pool method.
result = client.delete_ca_pool request

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

#delete_certificate_authority

def delete_certificate_authority(request, options = nil) -> ::Gapic::Operation
def delete_certificate_authority(name: nil, request_id: nil, ignore_active_certificates: nil, skip_grace_period: nil, ignore_dependent_resources: nil) -> ::Gapic::Operation

Delete a CertificateAuthority.

Overloads

def delete_certificate_authority(request, options = nil) -> ::Gapic::Operation

Pass arguments to delete_certificate_authority via a request object, either of type DeleteCertificateAuthorityRequest or an equivalent Hash.

Parameters

• request (::Google::Cloud::Security::PrivateCA::V1::DeleteCertificateAuthorityRequest, ::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.
• options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

def delete_certificate_authority(name: nil, request_id: nil, ignore_active_certificates: nil, skip_grace_period: nil, ignore_dependent_resources: nil) -> ::Gapic::Operation

Pass arguments to delete_certificate_authority 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).

Parameters

• name (::String) — Required. The resource name for this CertificateAuthority in the format projects/*/locations/*/caPools/*/certificateAuthorities/*.
• 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 the 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).

• ignore_active_certificates (::Boolean) — Optional. This field allows the CA to be deleted even if the CA has active certs. Active certs include both unrevoked and unexpired certs.
• skip_grace_period (::Boolean) — Optional. If this flag is set, the Certificate Authority will be deleted as soon as possible without a 30-day grace period where undeletion would have been allowed. If you proceed, there will be no way to recover this CA.
• ignore_dependent_resources (::Boolean) — Optional. This field allows this CA to be deleted even if it's being depended on by another resource. However, doing so may result in unintended and unrecoverable effects on any dependent resources since the CA will no longer be able to issue certificates.

Yields

• (result, operation) — Access the result along with the TransportOperation object

Yield Parameters

• result (::Gapic::Operation)
• operation (::Gapic::Rest::TransportOperation)

Returns

• (::Gapic::Operation)

Raises

• (::Google::Cloud::Error) — if the REST call is aborted.

Example

Basic example

require "google/cloud/security/private_ca/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Security::PrivateCA::V1::CertificateAuthorityService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Security::PrivateCA::V1::DeleteCertificateAuthorityRequest.new

# Call the delete_certificate_authority method.
result = client.delete_certificate_authority request

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

#delete_certificate_template

def delete_certificate_template(request, options = nil) -> ::Gapic::Operation
def delete_certificate_template(name: nil, request_id: nil) -> ::Gapic::Operation

DeleteCertificateTemplate deletes a CertificateTemplate.

Overloads

def delete_certificate_template(request, options = nil) -> ::Gapic::Operation

Pass arguments to delete_certificate_template via a request object, either of type DeleteCertificateTemplateRequest or an equivalent Hash.

Parameters

• 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.
• options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

def delete_certificate_template(name: nil, request_id: nil) -> ::Gapic::Operation

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).

Parameters

• name (::String) — Required. The resource name for this CertificateTemplate in the format projects/*/locations/*/certificateTemplates/*.
• 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 the 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).

Yields

• (result, operation) — Access the result along with the TransportOperation object

Yield Parameters

• result (::Gapic::Operation)
• operation (::Gapic::Rest::TransportOperation)

Returns

• (::Gapic::Operation)

Raises

• (::Google::Cloud::Error) — if the REST call is aborted.

Example

Basic example

require "google/cloud/security/private_ca/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Security::PrivateCA::V1::CertificateAuthorityService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Security::PrivateCA::V1::DeleteCertificateTemplateRequest.new

# Call the delete_certificate_template method.
result = client.delete_certificate_template request

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

#disable_certificate_authority

def disable_certificate_authority(request, options = nil) -> ::Gapic::Operation
def disable_certificate_authority(name: nil, request_id: nil, ignore_dependent_resources: nil) -> ::Gapic::Operation

Disable a CertificateAuthority.

Overloads

def disable_certificate_authority(request, options = nil) -> ::Gapic::Operation

Pass arguments to disable_certificate_authority via a request object, either of type DisableCertificateAuthorityRequest or an equivalent Hash.

Parameters

• request (::Google::Cloud::Security::PrivateCA::V1::DisableCertificateAuthorityRequest, ::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.
• options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

def disable_certificate_authority(name: nil, request_id: nil, ignore_dependent_resources: nil) -> ::Gapic::Operation

Pass arguments to disable_certificate_authority 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).

Parameters

• name (::String) — Required. The resource name for this CertificateAuthority in the format projects/*/locations/*/caPools/*/certificateAuthorities/*.
• 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 the 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).

• ignore_dependent_resources (::Boolean) — Optional. This field allows this CA to be disabled even if it's being depended on by another resource. However, doing so may result in unintended and unrecoverable effects on any dependent resources since the CA will no longer be able to issue certificates.

Yields

• (result, operation) — Access the result along with the TransportOperation object

Yield Parameters

• result (::Gapic::Operation)
• operation (::Gapic::Rest::TransportOperation)

Returns

• (::Gapic::Operation)

Raises

• (::Google::Cloud::Error) — if the REST call is aborted.

Example

Basic example

require "google/cloud/security/private_ca/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Security::PrivateCA::V1::CertificateAuthorityService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Security::PrivateCA::V1::DisableCertificateAuthorityRequest.new

# Call the disable_certificate_authority method.
result = client.disable_certificate_authority request

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

#enable_certificate_authority

def enable_certificate_authority(request, options = nil) -> ::Gapic::Operation
def enable_certificate_authority(name: nil, request_id: nil) -> ::Gapic::Operation

Enable a CertificateAuthority.

Overloads

def enable_certificate_authority(request, options = nil) -> ::Gapic::Operation

Pass arguments to enable_certificate_authority via a request object, either of type EnableCertificateAuthorityRequest or an equivalent Hash.

Parameters

• request (::Google::Cloud::Security::PrivateCA::V1::EnableCertificateAuthorityRequest, ::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.
• options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

def enable_certificate_authority(name: nil, request_id: nil) -> ::Gapic::Operation

Pass arguments to enable_certificate_authority 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).

Parameters

• name (::String) — Required. The resource name for this CertificateAuthority in the format projects/*/locations/*/caPools/*/certificateAuthorities/*.
• 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 the 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).

Yields

• (result, operation) — Access the result along with the TransportOperation object

Yield Parameters

• result (::Gapic::Operation)
• operation (::Gapic::Rest::TransportOperation)

Returns

• (::Gapic::Operation)

Raises

• (::Google::Cloud::Error) — if the REST call is aborted.

Example

Basic example

require "google/cloud/security/private_ca/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Security::PrivateCA::V1::CertificateAuthorityService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Security::PrivateCA::V1::EnableCertificateAuthorityRequest.new

# Call the enable_certificate_authority method.
result = client.enable_certificate_authority request

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

#fetch_ca_certs

def fetch_ca_certs(request, options = nil) -> ::Google::Cloud::Security::PrivateCA::V1::FetchCaCertsResponse
def fetch_ca_certs(ca_pool: nil, request_id: nil) -> ::Google::Cloud::Security::PrivateCA::V1::FetchCaCertsResponse

FetchCaCerts returns the current trust anchor for the CaPool. This will include CA certificate chains for all certificate authorities in the ENABLED, DISABLED, or STAGED states.

Overloads

def fetch_ca_certs(request, options = nil) -> ::Google::Cloud::Security::PrivateCA::V1::FetchCaCertsResponse

Pass arguments to fetch_ca_certs via a request object, either of type FetchCaCertsRequest or an equivalent Hash.

Parameters

• 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.
• options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

def fetch_ca_certs(ca_pool: nil, request_id: nil) -> ::Google::Cloud::Security::PrivateCA::V1::FetchCaCertsResponse

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).

Parameters

• ca_pool (::String) — Required. The resource name for the CaPool in the format projects/*/locations/*/caPools/*.
• 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 the 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).

Yields

• (result, operation) — Access the result along with the TransportOperation object

Yield Parameters

• result (::Google::Cloud::Security::PrivateCA::V1::FetchCaCertsResponse)
• operation (::Gapic::Rest::TransportOperation)

Returns

• (::Google::Cloud::Security::PrivateCA::V1::FetchCaCertsResponse)

Raises

• (::Google::Cloud::Error) — if the REST call is aborted.

Example

Basic example

require "google/cloud/security/private_ca/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Security::PrivateCA::V1::CertificateAuthorityService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Security::PrivateCA::V1::FetchCaCertsRequest.new

# Call the fetch_ca_certs method.
result = client.fetch_ca_certs request

# The returned object is of type Google::Cloud::Security::PrivateCA::V1::FetchCaCertsResponse.
p result

#fetch_certificate_authority_csr

def fetch_certificate_authority_csr(request, options = nil) -> ::Google::Cloud::Security::PrivateCA::V1::FetchCertificateAuthorityCsrResponse
def fetch_certificate_authority_csr(name: nil) -> ::Google::Cloud::Security::PrivateCA::V1::FetchCertificateAuthorityCsrResponse

Fetch a certificate signing request (CSR) from a CertificateAuthority that is in state AWAITING_USER_ACTIVATION and is of type SUBORDINATE. The CSR must then be signed by the desired parent Certificate Authority, which could be another CertificateAuthority resource, or could be an on-prem certificate authority. See also ActivateCertificateAuthority.

Overloads

def fetch_certificate_authority_csr(request, options = nil) -> ::Google::Cloud::Security::PrivateCA::V1::FetchCertificateAuthorityCsrResponse

Pass arguments to fetch_certificate_authority_csr via a request object, either of type FetchCertificateAuthorityCsrRequest or an equivalent Hash.

Parameters

• request (::Google::Cloud::Security::PrivateCA::V1::FetchCertificateAuthorityCsrRequest, ::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.
• options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

def fetch_certificate_authority_csr(name: nil) -> ::Google::Cloud::Security::PrivateCA::V1::FetchCertificateAuthorityCsrResponse

Pass arguments to fetch_certificate_authority_csr 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).

Parameter

• name (::String) — Required. The resource name for this CertificateAuthority in the format projects/*/locations/*/caPools/*/certificateAuthorities/*.

Yields

• (result, operation) — Access the result along with the TransportOperation object

Yield Parameters

• result (::Google::Cloud::Security::PrivateCA::V1::FetchCertificateAuthorityCsrResponse)
• operation (::Gapic::Rest::TransportOperation)

Returns

• (::Google::Cloud::Security::PrivateCA::V1::FetchCertificateAuthorityCsrResponse)

Raises

• (::Google::Cloud::Error) — if the REST call is aborted.

Example

Basic example

require "google/cloud/security/private_ca/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Security::PrivateCA::V1::CertificateAuthorityService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Security::PrivateCA::V1::FetchCertificateAuthorityCsrRequest.new

# Call the fetch_certificate_authority_csr method.
result = client.fetch_certificate_authority_csr request

# The returned object is of type Google::Cloud::Security::PrivateCA::V1::FetchCertificateAuthorityCsrResponse.
p result

#get_ca_pool

def get_ca_pool(request, options = nil) -> ::Google::Cloud::Security::PrivateCA::V1::CaPool
def get_ca_pool(name: nil) -> ::Google::Cloud::Security::PrivateCA::V1::CaPool

Returns a CaPool.

Overloads

def get_ca_pool(request, options = nil) -> ::Google::Cloud::Security::PrivateCA::V1::CaPool

Pass arguments to get_ca_pool via a request object, either of type GetCaPoolRequest or an equivalent Hash.

Parameters

• 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.
• options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

def get_ca_pool(name: nil) -> ::Google::Cloud::Security::PrivateCA::V1::CaPool

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).

Parameter

• name (::String) — Required. The name of the CaPool to get.

Yields

• (result, operation) — Access the result along with the TransportOperation object

Yield Parameters

• result (::Google::Cloud::Security::PrivateCA::V1::CaPool)
• operation (::Gapic::Rest::TransportOperation)

Returns

• (::Google::Cloud::Security::PrivateCA::V1::CaPool)

Raises

• (::Google::Cloud::Error) — if the REST call is aborted.

Example

Basic example

require "google/cloud/security/private_ca/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Security::PrivateCA::V1::CertificateAuthorityService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Security::PrivateCA::V1::GetCaPoolRequest.new

# Call the get_ca_pool method.
result = client.get_ca_pool request

# The returned object is of type Google::Cloud::Security::PrivateCA::V1::CaPool.
p result

#get_certificate

def get_certificate(request, options = nil) -> ::Google::Cloud::Security::PrivateCA::V1::Certificate
def get_certificate(name: nil) -> ::Google::Cloud::Security::PrivateCA::V1::Certificate

Returns a Certificate.

Overloads

def get_certificate(request, options = nil) -> ::Google::Cloud::Security::PrivateCA::V1::Certificate

Pass arguments to get_certificate via a request object, either of type GetCertificateRequest or an equivalent Hash.

Parameters

• 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.
• options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

def get_certificate(name: nil) -> ::Google::Cloud::Security::PrivateCA::V1::Certificate

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).

Parameter

• name (::String) — Required. The name of the Certificate to get.

Yields

• (result, operation) — Access the result along with the TransportOperation object

Yield Parameters

• result (::Google::Cloud::Security::PrivateCA::V1::Certificate)
• operation (::Gapic::Rest::TransportOperation)

Returns

• (::Google::Cloud::Security::PrivateCA::V1::Certificate)

Raises

• (::Google::Cloud::Error) — if the REST call is aborted.

Example

Basic example

require "google/cloud/security/private_ca/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Security::PrivateCA::V1::CertificateAuthorityService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Security::PrivateCA::V1::GetCertificateRequest.new

# Call the get_certificate method.
result = client.get_certificate request

# The returned object is of type Google::Cloud::Security::PrivateCA::V1::Certificate.
p result

#get_certificate_authority

def get_certificate_authority(request, options = nil) -> ::Google::Cloud::Security::PrivateCA::V1::CertificateAuthority
def get_certificate_authority(name: nil) -> ::Google::Cloud::Security::PrivateCA::V1::CertificateAuthority

Returns a CertificateAuthority.

Overloads

def get_certificate_authority(request, options = nil) -> ::Google::Cloud::Security::PrivateCA::V1::CertificateAuthority

Pass arguments to get_certificate_authority via a request object, either of type GetCertificateAuthorityRequest or an equivalent Hash.

Parameters

• request (::Google::Cloud::Security::PrivateCA::V1::GetCertificateAuthorityRequest, ::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.
• options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

def get_certificate_authority(name: nil) -> ::Google::Cloud::Security::PrivateCA::V1::CertificateAuthority

Pass arguments to get_certificate_authority 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).

Parameter

• name (::String) — Required. The name of the CertificateAuthority to get.

Yields

• (result, operation) — Access the result along with the TransportOperation object

Yield Parameters

• result (::Google::Cloud::Security::PrivateCA::V1::CertificateAuthority)
• operation (::Gapic::Rest::TransportOperation)

Returns

• (::Google::Cloud::Security::PrivateCA::V1::CertificateAuthority)

Raises

• (::Google::Cloud::Error) — if the REST call is aborted.

Example

Basic example

require "google/cloud/security/private_ca/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Security::PrivateCA::V1::CertificateAuthorityService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Security::PrivateCA::V1::GetCertificateAuthorityRequest.new

# Call the get_certificate_authority method.
result = client.get_certificate_authority request

# The returned object is of type Google::Cloud::Security::PrivateCA::V1::CertificateAuthority.
p result

#get_certificate_revocation_list

def get_certificate_revocation_list(request, options = nil) -> ::Google::Cloud::Security::PrivateCA::V1::CertificateRevocationList
def get_certificate_revocation_list(name: nil) -> ::Google::Cloud::Security::PrivateCA::V1::CertificateRevocationList

Returns a CertificateRevocationList.

Overloads

def get_certificate_revocation_list(request, options = nil) -> ::Google::Cloud::Security::PrivateCA::V1::CertificateRevocationList

Pass arguments to get_certificate_revocation_list via a request object, either of type GetCertificateRevocationListRequest or an equivalent Hash.

Parameters

• 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.
• options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

def get_certificate_revocation_list(name: nil) -> ::Google::Cloud::Security::PrivateCA::V1::CertificateRevocationList

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).

Parameter

• name (::String) — Required. The name of the CertificateRevocationList to get.

Yields

• (result, operation) — Access the result along with the TransportOperation object

Yield Parameters

• result (::Google::Cloud::Security::PrivateCA::V1::CertificateRevocationList)
• operation (::Gapic::Rest::TransportOperation)

Returns

• (::Google::Cloud::Security::PrivateCA::V1::CertificateRevocationList)

Raises

• (::Google::Cloud::Error) — if the REST call is aborted.

Example

Basic example

require "google/cloud/security/private_ca/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Security::PrivateCA::V1::CertificateAuthorityService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Security::PrivateCA::V1::GetCertificateRevocationListRequest.new

# Call the get_certificate_revocation_list method.
result = client.get_certificate_revocation_list request

# The returned object is of type Google::Cloud::Security::PrivateCA::V1::CertificateRevocationList.
p result

#get_certificate_template

def get_certificate_template(request, options = nil) -> ::Google::Cloud::Security::PrivateCA::V1::CertificateTemplate
def get_certificate_template(name: nil) -> ::Google::Cloud::Security::PrivateCA::V1::CertificateTemplate

Returns a CertificateTemplate.

Overloads

def get_certificate_template(request, options = nil) -> ::Google::Cloud::Security::PrivateCA::V1::CertificateTemplate

Pass arguments to get_certificate_template via a request object, either of type GetCertificateTemplateRequest or an equivalent Hash.

Parameters

• 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.
• options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

def get_certificate_template(name: nil) -> ::Google::Cloud::Security::PrivateCA::V1::CertificateTemplate

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).

Parameter

• name (::String) — Required. The name of the CertificateTemplate to get.

Yields

• (result, operation) — Access the result along with the TransportOperation object

Yield Parameters

• result (::Google::Cloud::Security::PrivateCA::V1::CertificateTemplate)
• operation (::Gapic::Rest::TransportOperation)

Returns

• (::Google::Cloud::Security::PrivateCA::V1::CertificateTemplate)

Raises

• (::Google::Cloud::Error) — if the REST call is aborted.

Example

Basic example

require "google/cloud/security/private_ca/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Security::PrivateCA::V1::CertificateAuthorityService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Security::PrivateCA::V1::GetCertificateTemplateRequest.new

# Call the get_certificate_template method.
result = client.get_certificate_template request

# The returned object is of type Google::Cloud::Security::PrivateCA::V1::CertificateTemplate.
p result

#iam_policy_client

def iam_policy_client() -> Google::Iam::V1::IAMPolicy::Rest::Client

Get the associated client for mix-in of the IAMPolicy.

Returns

• (Google::Iam::V1::IAMPolicy::Rest::Client)

#initialize

def initialize() { |config| ... } -> Client

Create a new CertificateAuthorityService REST client object.

Yields

• (config) — Configure the CertificateAuthorityService client.

Yield Parameter

• config (Client::Configuration)

Returns

• (Client) — a new instance of Client

Example

# Create a client using the default configuration
client = ::Google::Cloud::Security::PrivateCA::V1::CertificateAuthorityService::Rest::Client.new

# Create a client using a custom configuration
client = ::Google::Cloud::Security::PrivateCA::V1::CertificateAuthorityService::Rest::Client.new do |config|
  config.timeout = 10.0
end

#list_ca_pools

def list_ca_pools(request, options = nil) -> ::Google::Cloud::Security::PrivateCA::V1::ListCaPoolsResponse
def list_ca_pools(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) -> ::Google::Cloud::Security::PrivateCA::V1::ListCaPoolsResponse

Lists CaPools.

Overloads

def list_ca_pools(request, options = nil) -> ::Google::Cloud::Security::PrivateCA::V1::ListCaPoolsResponse

Pass arguments to list_ca_pools via a request object, either of type ListCaPoolsRequest or an equivalent Hash.

Parameters

• 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.
• options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

def list_ca_pools(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) -> ::Google::Cloud::Security::PrivateCA::V1::ListCaPoolsResponse

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).

Parameters

• parent (::String) — Required. The resource name of the location associated with the CaPools, in the format projects/*/locations/*.
• page_size (::Integer) — Optional. Limit on the number of CaPools to include in the response. Further CaPools can subsequently be obtained by including the ListCaPoolsResponse.next_page_token in a subsequent request. If unspecified, the server will pick an appropriate default.
• page_token (::String) — Optional. Pagination token, returned earlier via ListCaPoolsResponse.next_page_token.
• filter (::String) — Optional. Only include resources that match the filter in the response.
• order_by (::String) — Optional. Specify how the results should be sorted.

Yields

• (result, operation) — Access the result along with the TransportOperation object

Yield Parameters

• result (::Google::Cloud::Security::PrivateCA::V1::ListCaPoolsResponse)
• operation (::Gapic::Rest::TransportOperation)

Returns

• (::Google::Cloud::Security::PrivateCA::V1::ListCaPoolsResponse)

Raises

• (::Google::Cloud::Error) — if the REST call is aborted.

Example

Basic example

require "google/cloud/security/private_ca/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Security::PrivateCA::V1::CertificateAuthorityService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Security::PrivateCA::V1::ListCaPoolsRequest.new

# Call the list_ca_pools method.
result = client.list_ca_pools request

# The returned object is of type Gapic::PagedEnumerable. You can iterate
# over elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Cloud::Security::PrivateCA::V1::CaPool.
  p item
end

#list_certificate_authorities

def list_certificate_authorities(request, options = nil) -> ::Google::Cloud::Security::PrivateCA::V1::ListCertificateAuthoritiesResponse
def list_certificate_authorities(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) -> ::Google::Cloud::Security::PrivateCA::V1::ListCertificateAuthoritiesResponse

Lists CertificateAuthorities.

Overloads

def list_certificate_authorities(request, options = nil) -> ::Google::Cloud::Security::PrivateCA::V1::ListCertificateAuthoritiesResponse

Pass arguments to list_certificate_authorities via a request object, either of type ListCertificateAuthoritiesRequest or an equivalent Hash.

Parameters

• request (::Google::Cloud::Security::PrivateCA::V1::ListCertificateAuthoritiesRequest, ::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.
• options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

def list_certificate_authorities(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) -> ::Google::Cloud::Security::PrivateCA::V1::ListCertificateAuthoritiesResponse

Pass arguments to list_certificate_authorities 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).

Parameters

• parent (::String) — Required. The resource name of the CaPool associated with the CertificateAuthorities, in the format projects/*/locations/*/caPools/*.
• page_size (::Integer) — Optional. Limit on the number of CertificateAuthorities to include in the response. Further CertificateAuthorities can subsequently be obtained by including the ListCertificateAuthoritiesResponse.next_page_token in a subsequent request. If unspecified, the server will pick an appropriate default.
• page_token (::String) — Optional. Pagination token, returned earlier via ListCertificateAuthoritiesResponse.next_page_token.
• filter (::String) — Optional. Only include resources that match the filter in the response.
• order_by (::String) — Optional. Specify how the results should be sorted.

Yields

• (result, operation) — Access the result along with the TransportOperation object

Yield Parameters

• result (::Google::Cloud::Security::PrivateCA::V1::ListCertificateAuthoritiesResponse)
• operation (::Gapic::Rest::TransportOperation)

Returns

• (::Google::Cloud::Security::PrivateCA::V1::ListCertificateAuthoritiesResponse)

Raises

• (::Google::Cloud::Error) — if the REST call is aborted.

Example

Basic example

require "google/cloud/security/private_ca/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Security::PrivateCA::V1::CertificateAuthorityService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Security::PrivateCA::V1::ListCertificateAuthoritiesRequest.new

# Call the list_certificate_authorities method.
result = client.list_certificate_authorities request

# The returned object is of type Gapic::PagedEnumerable. You can iterate
# over elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Cloud::Security::PrivateCA::V1::CertificateAuthority.
  p item
end

#list_certificate_revocation_lists

def list_certificate_revocation_lists(request, options = nil) -> ::Google::Cloud::Security::PrivateCA::V1::ListCertificateRevocationListsResponse
def list_certificate_revocation_lists(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) -> ::Google::Cloud::Security::PrivateCA::V1::ListCertificateRevocationListsResponse

Lists CertificateRevocationLists.

Overloads

def list_certificate_revocation_lists(request, options = nil) -> ::Google::Cloud::Security::PrivateCA::V1::ListCertificateRevocationListsResponse

Pass arguments to list_certificate_revocation_lists via a request object, either of type ListCertificateRevocationListsRequest or an equivalent Hash.

Parameters

• 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.
• options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

def list_certificate_revocation_lists(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) -> ::Google::Cloud::Security::PrivateCA::V1::ListCertificateRevocationListsResponse

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).

Parameters

• parent (::String) — Required. The resource name of the location associated with the CertificateRevocationLists, in the format projects/*/locations/*/caPools/*/certificateAuthorities/*.
• page_size (::Integer) — Optional. Limit on the number of CertificateRevocationLists to include in the response. Further CertificateRevocationLists can subsequently be obtained by including the ListCertificateRevocationListsResponse.next_page_token in a subsequent request. If unspecified, the server will pick an appropriate default.
• page_token (::String) — Optional. Pagination token, returned earlier via ListCertificateRevocationListsResponse.next_page_token.
• filter (::String) — Optional. Only include resources that match the filter in the response.
• order_by (::String) — Optional. Specify how the results should be sorted.

Yields

• (result, operation) — Access the result along with the TransportOperation object

Yield Parameters

• result (::Google::Cloud::Security::PrivateCA::V1::ListCertificateRevocationListsResponse)
• operation (::Gapic::Rest::TransportOperation)

Returns

• (::Google::Cloud::Security::PrivateCA::V1::ListCertificateRevocationListsResponse)

Raises

• (::Google::Cloud::Error) — if the REST call is aborted.

Example

Basic example

require "google/cloud/security/private_ca/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Security::PrivateCA::V1::CertificateAuthorityService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Security::PrivateCA::V1::ListCertificateRevocationListsRequest.new

# Call the list_certificate_revocation_lists method.
result = client.list_certificate_revocation_lists request

# The returned object is of type Gapic::PagedEnumerable. You can iterate
# over elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Cloud::Security::PrivateCA::V1::CertificateRevocationList.
  p item
end

#list_certificate_templates

def list_certificate_templates(request, options = nil) -> ::Google::Cloud::Security::PrivateCA::V1::ListCertificateTemplatesResponse
def list_certificate_templates(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) -> ::Google::Cloud::Security::PrivateCA::V1::ListCertificateTemplatesResponse

Lists CertificateTemplates.

Overloads

def list_certificate_templates(request, options = nil) -> ::Google::Cloud::Security::PrivateCA::V1::ListCertificateTemplatesResponse

Pass arguments to list_certificate_templates via a request object, either of type ListCertificateTemplatesRequest or an equivalent Hash.

Parameters

• 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.
• options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

def list_certificate_templates(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) -> ::Google::Cloud::Security::PrivateCA::V1::ListCertificateTemplatesResponse

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).

Parameters

• parent (::String) — Required. The resource name of the location associated with the CertificateTemplates, in the format projects/*/locations/*.
• page_size (::Integer) — Optional. Limit on the number of CertificateTemplates to include in the response. Further CertificateTemplates can subsequently be obtained by including the ListCertificateTemplatesResponse.next_page_token in a subsequent request. If unspecified, the server will pick an appropriate default.
• page_token (::String) — Optional. Pagination token, returned earlier via ListCertificateTemplatesResponse.next_page_token.
• filter (::String) — Optional. Only include resources that match the filter in the response.
• order_by (::String) — Optional. Specify how the results should be sorted.

Yields

• (result, operation) — Access the result along with the TransportOperation object

Yield Parameters

• result (::Google::Cloud::Security::PrivateCA::V1::ListCertificateTemplatesResponse)
• operation (::Gapic::Rest::TransportOperation)

Returns

• (::Google::Cloud::Security::PrivateCA::V1::ListCertificateTemplatesResponse)

Raises

• (::Google::Cloud::Error) — if the REST call is aborted.

Example

Basic example

require "google/cloud/security/private_ca/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Security::PrivateCA::V1::CertificateAuthorityService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Security::PrivateCA::V1::ListCertificateTemplatesRequest.new

# Call the list_certificate_templates method.
result = client.list_certificate_templates request

# The returned object is of type Gapic::PagedEnumerable. You can iterate
# over elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Cloud::Security::PrivateCA::V1::CertificateTemplate.
  p item
end

#list_certificates

def list_certificates(request, options = nil) -> ::Google::Cloud::Security::PrivateCA::V1::ListCertificatesResponse
def list_certificates(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) -> ::Google::Cloud::Security::PrivateCA::V1::ListCertificatesResponse

Lists Certificates.

Overloads

def list_certificates(request, options = nil) -> ::Google::Cloud::Security::PrivateCA::V1::ListCertificatesResponse

Pass arguments to list_certificates via a request object, either of type ListCertificatesRequest or an equivalent Hash.

Parameters

• 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.
• options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

def list_certificates(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) -> ::Google::Cloud::Security::PrivateCA::V1::ListCertificatesResponse

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).

Parameters

• parent (::String) — Required. The resource name of the location associated with the Certificates, in the format projects/*/locations/*/caPools/*.
• page_size (::Integer) — Optional. Limit on the number of Certificates to include in the response. Further Certificates can subsequently be obtained by including the ListCertificatesResponse.next_page_token in a subsequent request. If unspecified, the server will pick an appropriate default.
• page_token (::String) — Optional. Pagination token, returned earlier via ListCertificatesResponse.next_page_token.
• filter (::String) — Optional. Only include resources that match the filter in the response. For details on supported filters and syntax, see Certificates Filtering documentation.
• order_by (::String) — Optional. Specify how the results should be sorted. For details on supported fields and syntax, see Certificates Sorting documentation.

Yields

• (result, operation) — Access the result along with the TransportOperation object

Yield Parameters

• result (::Google::Cloud::Security::PrivateCA::V1::ListCertificatesResponse)
• operation (::Gapic::Rest::TransportOperation)

Returns

• (::Google::Cloud::Security::PrivateCA::V1::ListCertificatesResponse)

Raises

• (::Google::Cloud::Error) — if the REST call is aborted.

Example

Basic example

require "google/cloud/security/private_ca/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Security::PrivateCA::V1::CertificateAuthorityService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Security::PrivateCA::V1::ListCertificatesRequest.new

# Call the list_certificates method.
result = client.list_certificates request

# The returned object is of type Gapic::PagedEnumerable. You can iterate
# over elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Cloud::Security::PrivateCA::V1::Certificate.
  p item
end

#location_client

def location_client() -> Google::Cloud::Location::Locations::Rest::Client

Get the associated client for mix-in of the Locations.

Returns

• (Google::Cloud::Location::Locations::Rest::Client)

#logger

def logger() -> Logger

The logger used for request/response debug logging.

Returns

• (Logger)

#operations_client

def operations_client() -> ::Google::Cloud::Security::PrivateCA::V1::CertificateAuthorityService::Rest::Operations

Get the associated client for long-running operations.

Returns

• (::Google::Cloud::Security::PrivateCA::V1::CertificateAuthorityService::Rest::Operations)

#revoke_certificate

def revoke_certificate(request, options = nil) -> ::Google::Cloud::Security::PrivateCA::V1::Certificate
def revoke_certificate(name: nil, reason: nil, request_id: nil) -> ::Google::Cloud::Security::PrivateCA::V1::Certificate

Revoke a Certificate.

Overloads

def revoke_certificate(request, options = nil) -> ::Google::Cloud::Security::PrivateCA::V1::Certificate

Pass arguments to revoke_certificate via a request object, either of type RevokeCertificateRequest or an equivalent Hash.

Parameters

• 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.
• options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

def revoke_certificate(name: nil, reason: nil, request_id: nil) -> ::Google::Cloud::Security::PrivateCA::V1::Certificate

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).

Parameters

• name (::String) — Required. The resource name for this Certificate in the format projects/*/locations/*/caPools/*/certificates/*.
• reason (::Google::Cloud::Security::PrivateCA::V1::RevocationReason) — Required. The RevocationReason for revoking this certificate.
• 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 the 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).

Yields

• (result, operation) — Access the result along with the TransportOperation object

Yield Parameters

• result (::Google::Cloud::Security::PrivateCA::V1::Certificate)
• operation (::Gapic::Rest::TransportOperation)

Returns

• (::Google::Cloud::Security::PrivateCA::V1::Certificate)

Raises

• (::Google::Cloud::Error) — if the REST call is aborted.

Example

Basic example

require "google/cloud/security/private_ca/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Security::PrivateCA::V1::CertificateAuthorityService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Security::PrivateCA::V1::RevokeCertificateRequest.new

# Call the revoke_certificate method.
result = client.revoke_certificate request

# The returned object is of type Google::Cloud::Security::PrivateCA::V1::Certificate.
p result

#undelete_certificate_authority

def undelete_certificate_authority(request, options = nil) -> ::Gapic::Operation
def undelete_certificate_authority(name: nil, request_id: nil) -> ::Gapic::Operation

Undelete a CertificateAuthority that has been deleted.

Overloads

def undelete_certificate_authority(request, options = nil) -> ::Gapic::Operation

Pass arguments to undelete_certificate_authority via a request object, either of type UndeleteCertificateAuthorityRequest or an equivalent Hash.

Parameters

• request (::Google::Cloud::Security::PrivateCA::V1::UndeleteCertificateAuthorityRequest, ::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.
• options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

def undelete_certificate_authority(name: nil, request_id: nil) -> ::Gapic::Operation

Pass arguments to undelete_certificate_authority 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).

Parameters

• name (::String) — Required. The resource name for this CertificateAuthority in the format projects/*/locations/*/caPools/*/certificateAuthorities/*.
• 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 the 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).

Yields

• (result, operation) — Access the result along with the TransportOperation object

Yield Parameters

• result (::Gapic::Operation)
• operation (::Gapic::Rest::TransportOperation)

Returns

• (::Gapic::Operation)

Raises

• (::Google::Cloud::Error) — if the REST call is aborted.

Example

Basic example

require "google/cloud/security/private_ca/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Security::PrivateCA::V1::CertificateAuthorityService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Security::PrivateCA::V1::UndeleteCertificateAuthorityRequest.new

# Call the undelete_certificate_authority method.
result = client.undelete_certificate_authority request

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

#universe_domain

def universe_domain() -> String

The effective universe domain

Returns

• (String)

#update_ca_pool

def update_ca_pool(request, options = nil) -> ::Gapic::Operation
def update_ca_pool(ca_pool: nil, update_mask: nil, request_id: nil) -> ::Gapic::Operation

Update a CaPool.

Overloads

def update_ca_pool(request, options = nil) -> ::Gapic::Operation

Pass arguments to update_ca_pool via a request object, either of type UpdateCaPoolRequest or an equivalent Hash.

Parameters

• 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.
• options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

def update_ca_pool(ca_pool: nil, update_mask: nil, request_id: nil) -> ::Gapic::Operation

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).

Parameters

• ca_pool (::Google::Cloud::Security::PrivateCA::V1::CaPool, ::Hash) — Required. CaPool with updated values.
• update_mask (::Google::Protobuf::FieldMask, ::Hash) — Required. A list of fields to be updated in this request.
• 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 the 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).

Yields

• (result, operation) — Access the result along with the TransportOperation object

Yield Parameters

• result (::Gapic::Operation)
• operation (::Gapic::Rest::TransportOperation)

Returns

• (::Gapic::Operation)

Raises

• (::Google::Cloud::Error) — if the REST call is aborted.

Example

Basic example

require "google/cloud/security/private_ca/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Security::PrivateCA::V1::CertificateAuthorityService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Security::PrivateCA::V1::UpdateCaPoolRequest.new

# Call the update_ca_pool method.
result = client.update_ca_pool request

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

#update_certificate

def update_certificate(request, options = nil) -> ::Google::Cloud::Security::PrivateCA::V1::Certificate
def update_certificate(certificate: nil, update_mask: nil, request_id: nil) -> ::Google::Cloud::Security::PrivateCA::V1::Certificate

Update a Certificate. Currently, the only field you can update is the labels field.

Overloads

def update_certificate(request, options = nil) -> ::Google::Cloud::Security::PrivateCA::V1::Certificate

Pass arguments to update_certificate via a request object, either of type UpdateCertificateRequest or an equivalent Hash.

Parameters

• 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.
• options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

def update_certificate(certificate: nil, update_mask: nil, request_id: nil) -> ::Google::Cloud::Security::PrivateCA::V1::Certificate

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).

Parameters

• certificate (::Google::Cloud::Security::PrivateCA::V1::Certificate, ::Hash) — Required. Certificate with updated values.
• update_mask (::Google::Protobuf::FieldMask, ::Hash) — Required. A list of fields to be updated in this request.
• 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 the 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).

Yields

• (result, operation) — Access the result along with the TransportOperation object

Yield Parameters

• result (::Google::Cloud::Security::PrivateCA::V1::Certificate)
• operation (::Gapic::Rest::TransportOperation)

Returns

• (::Google::Cloud::Security::PrivateCA::V1::Certificate)

Raises

• (::Google::Cloud::Error) — if the REST call is aborted.

Example

Basic example

require "google/cloud/security/private_ca/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Security::PrivateCA::V1::CertificateAuthorityService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Security::PrivateCA::V1::UpdateCertificateRequest.new

# Call the update_certificate method.
result = client.update_certificate request

# The returned object is of type Google::Cloud::Security::PrivateCA::V1::Certificate.
p result

#update_certificate_authority

def update_certificate_authority(request, options = nil) -> ::Gapic::Operation
def update_certificate_authority(certificate_authority: nil, update_mask: nil, request_id: nil) -> ::Gapic::Operation

Update a CertificateAuthority.

Overloads

def update_certificate_authority(request, options = nil) -> ::Gapic::Operation

Pass arguments to update_certificate_authority via a request object, either of type UpdateCertificateAuthorityRequest or an equivalent Hash.

Parameters

• request (::Google::Cloud::Security::PrivateCA::V1::UpdateCertificateAuthorityRequest, ::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.
• options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

def update_certificate_authority(certificate_authority: nil, update_mask: nil, request_id: nil) -> ::Gapic::Operation

Pass arguments to update_certificate_authority 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).

Parameters

• certificate_authority (::Google::Cloud::Security::PrivateCA::V1::CertificateAuthority, ::Hash) — Required. CertificateAuthority with updated values.
• update_mask (::Google::Protobuf::FieldMask, ::Hash) — Required. A list of fields to be updated in this request.
• 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 the 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).

Yields

• (result, operation) — Access the result along with the TransportOperation object

Yield Parameters

• result (::Gapic::Operation)
• operation (::Gapic::Rest::TransportOperation)

Returns

• (::Gapic::Operation)

Raises

• (::Google::Cloud::Error) — if the REST call is aborted.

Example

Basic example

require "google/cloud/security/private_ca/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Security::PrivateCA::V1::CertificateAuthorityService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Security::PrivateCA::V1::UpdateCertificateAuthorityRequest.new

# Call the update_certificate_authority method.
result = client.update_certificate_authority request

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

#update_certificate_revocation_list

def update_certificate_revocation_list(request, options = nil) -> ::Gapic::Operation
def update_certificate_revocation_list(certificate_revocation_list: nil, update_mask: nil, request_id: nil) -> ::Gapic::Operation

Update a CertificateRevocationList.

Overloads

def update_certificate_revocation_list(request, options = nil) -> ::Gapic::Operation

Pass arguments to update_certificate_revocation_list via a request object, either of type UpdateCertificateRevocationListRequest or an equivalent Hash.

Parameters

• 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.
• options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

def update_certificate_revocation_list(certificate_revocation_list: nil, update_mask: nil, request_id: nil) -> ::Gapic::Operation

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).

Parameters

• certificate_revocation_list (::Google::Cloud::Security::PrivateCA::V1::CertificateRevocationList, ::Hash) — Required. CertificateRevocationList with updated values.
• update_mask (::Google::Protobuf::FieldMask, ::Hash) — Required. A list of fields to be updated in this request.
• 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 the 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).

Yields

• (result, operation) — Access the result along with the TransportOperation object

Yield Parameters

• result (::Gapic::Operation)
• operation (::Gapic::Rest::TransportOperation)

Returns

• (::Gapic::Operation)

Raises

• (::Google::Cloud::Error) — if the REST call is aborted.

Example

Basic example

require "google/cloud/security/private_ca/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Security::PrivateCA::V1::CertificateAuthorityService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Security::PrivateCA::V1::UpdateCertificateRevocationListRequest.new

# Call the update_certificate_revocation_list method.
result = client.update_certificate_revocation_list request

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

#update_certificate_template

def update_certificate_template(request, options = nil) -> ::Gapic::Operation
def update_certificate_template(certificate_template: nil, update_mask: nil, request_id: nil) -> ::Gapic::Operation

Update a CertificateTemplate.

Overloads

def update_certificate_template(request, options = nil) -> ::Gapic::Operation

Pass arguments to update_certificate_template via a request object, either of type UpdateCertificateTemplateRequest or an equivalent Hash.

Parameters

• 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.
• options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

def update_certificate_template(certificate_template: nil, update_mask: nil, request_id: nil) -> ::Gapic::Operation

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).

Parameters

• certificate_template (::Google::Cloud::Security::PrivateCA::V1::CertificateTemplate, ::Hash) — Required. CertificateTemplate with updated values.
• update_mask (::Google::Protobuf::FieldMask, ::Hash) — Required. A list of fields to be updated in this request.
• 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 the 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).

Yields

• (result, operation) — Access the result along with the TransportOperation object

Yield Parameters

• result (::Gapic::Operation)
• operation (::Gapic::Rest::TransportOperation)

Returns

• (::Gapic::Operation)

Raises

• (::Google::Cloud::Error) — if the REST call is aborted.

Example

Basic example

require "google/cloud/security/private_ca/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Security::PrivateCA::V1::CertificateAuthorityService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Security::PrivateCA::V1::UpdateCertificateTemplateRequest.new

# Call the update_certificate_template method.
result = client.update_certificate_template request

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end