Certificate Authority Service V1beta1 API - Class Google::Cloud::Security::PrivateCA::V1beta1::CertificateAuthorityService::Rest::Client (v0.9.0)

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

REST client for the CertificateAuthorityService service.

Certificate Authority Service manages private certificate authorities and issued certificates.

Inherits

  • Object

Includes

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
Returns
Example 
# Modify the configuration for all CertificateAuthorityService clients
::Google::Cloud::Security::PrivateCA::V1beta1::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 PENDING_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 
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/*/certificateAuthorities/*.
  • pem_ca_certificate (::String) — Required. The signed CA certificate issued from FetchCertificateAuthorityCsrResponse.pem_csr.
  • subordinate_config (::Google::Cloud::Security::PrivateCA::V1beta1::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 t he request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

    The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

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/v1beta1"

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

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Security::PrivateCA::V1beta1::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
Returns

#create_certificate

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

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

Overloads 
def create_certificate(request, options = nil) -> ::Google::Cloud::Security::PrivateCA::V1beta1::Certificate
Pass arguments to create_certificate via a request object, either of type Google::Cloud::Security::PrivateCA::V1beta1::CreateCertificateRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Security::PrivateCA::V1beta1::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) -> ::Google::Cloud::Security::PrivateCA::V1beta1::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 location and CertificateAuthority associated with the Certificate, in the format projects/*/locations/*/certificateAuthorities/*.
  • 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::V1beta1::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 t he request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

    The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/security/private_ca/v1beta1"

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

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

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

# The returned object is of type Google::Cloud::Security::PrivateCA::V1beta1::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::V1beta1::CreateCertificateAuthorityRequest or an equivalent Hash.
Parameters 
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 location associated with the CertificateAuthorities, in the format projects/*/locations/*.
  • 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::V1beta1::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 t he request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

    The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

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/v1beta1"

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

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Security::PrivateCA::V1beta1::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

#disable_certificate_authority

def disable_certificate_authority(request, options = nil) -> ::Gapic::Operation
def disable_certificate_authority(name: nil, request_id: 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 
def disable_certificate_authority(name: nil, request_id: 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/*/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 t he request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

    The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

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/v1beta1"

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

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Security::PrivateCA::V1beta1::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 
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/*/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 t he request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

    The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

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/v1beta1"

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

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Security::PrivateCA::V1beta1::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_certificate_authority_csr

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

Fetch a certificate signing request (CSR) from a CertificateAuthority that is in state PENDING_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::V1beta1::FetchCertificateAuthorityCsrResponse
Pass arguments to fetch_certificate_authority_csr via a request object, either of type FetchCertificateAuthorityCsrRequest or an equivalent Hash.
Parameters 
def fetch_certificate_authority_csr(name: nil) -> ::Google::Cloud::Security::PrivateCA::V1beta1::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/*/certificateAuthorities/*.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/security/private_ca/v1beta1"

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

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Security::PrivateCA::V1beta1::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::V1beta1::FetchCertificateAuthorityCsrResponse.
p result

#get_certificate

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

Returns a Certificate.

Overloads 
def get_certificate(request, options = nil) -> ::Google::Cloud::Security::PrivateCA::V1beta1::Certificate
Pass arguments to get_certificate via a request object, either of type GetCertificateRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Security::PrivateCA::V1beta1::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::V1beta1::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
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/security/private_ca/v1beta1"

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

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

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

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

#get_certificate_authority

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

Returns a CertificateAuthority.

Overloads 
def get_certificate_authority(request, options = nil) -> ::Google::Cloud::Security::PrivateCA::V1beta1::CertificateAuthority
Pass arguments to get_certificate_authority via a request object, either of type GetCertificateAuthorityRequest or an equivalent Hash.
Parameters 
def get_certificate_authority(name: nil) -> ::Google::Cloud::Security::PrivateCA::V1beta1::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
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/security/private_ca/v1beta1"

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

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

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

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

#get_certificate_revocation_list

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

Returns a CertificateRevocationList.

Overloads 
def get_certificate_revocation_list(request, options = nil) -> ::Google::Cloud::Security::PrivateCA::V1beta1::CertificateRevocationList
Pass arguments to get_certificate_revocation_list via a request object, either of type GetCertificateRevocationListRequest or an equivalent Hash.
Parameters 
def get_certificate_revocation_list(name: nil) -> ::Google::Cloud::Security::PrivateCA::V1beta1::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
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/security/private_ca/v1beta1"

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

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Security::PrivateCA::V1beta1::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::V1beta1::CertificateRevocationList.
p result

#get_reusable_config

def get_reusable_config(request, options = nil) -> ::Google::Cloud::Security::PrivateCA::V1beta1::ReusableConfig
def get_reusable_config(name: nil) -> ::Google::Cloud::Security::PrivateCA::V1beta1::ReusableConfig

Returns a ReusableConfig.

Overloads 
def get_reusable_config(request, options = nil) -> ::Google::Cloud::Security::PrivateCA::V1beta1::ReusableConfig
Pass arguments to get_reusable_config via a request object, either of type GetReusableConfigRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Security::PrivateCA::V1beta1::GetReusableConfigRequest, ::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_reusable_config(name: nil) -> ::Google::Cloud::Security::PrivateCA::V1beta1::ReusableConfig
Pass arguments to get_reusable_config 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][ReusableConfigs.name] of the [ReusableConfigs][] to get.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/security/private_ca/v1beta1"

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

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

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

# The returned object is of type Google::Cloud::Security::PrivateCA::V1beta1::ReusableConfig.
p result

#initialize

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

Create a new CertificateAuthorityService REST client object.

Yields
  • (config) — Configure the CertificateAuthorityService client.
Yield Parameter
Returns
  • (Client) — a new instance of Client
Example 
# Create a client using the default configuration
client = ::Google::Cloud::Security::PrivateCA::V1beta1::CertificateAuthorityService::Rest::Client.new

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

#list_certificate_authorities

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

Lists CertificateAuthorities.

Overloads 
def list_certificate_authorities(request, options = nil) -> ::Google::Cloud::Security::PrivateCA::V1beta1::ListCertificateAuthoritiesResponse
Pass arguments to list_certificate_authorities via a request object, either of type ListCertificateAuthoritiesRequest or an equivalent Hash.
Parameters 
def list_certificate_authorities(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) -> ::Google::Cloud::Security::PrivateCA::V1beta1::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
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/security/private_ca/v1beta1"

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

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Security::PrivateCA::V1beta1::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::V1beta1::CertificateAuthority.
  p item
end

#list_certificate_revocation_lists

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

Lists CertificateRevocationLists.

Overloads 
def list_certificate_revocation_lists(request, options = nil) -> ::Google::Cloud::Security::PrivateCA::V1beta1::ListCertificateRevocationListsResponse
Pass arguments to list_certificate_revocation_lists via a request object, either of type ListCertificateRevocationListsRequest or an equivalent Hash.
Parameters 
def list_certificate_revocation_lists(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) -> ::Google::Cloud::Security::PrivateCA::V1beta1::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
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/security/private_ca/v1beta1"

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

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Security::PrivateCA::V1beta1::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::V1beta1::CertificateRevocationList.
  p item
end

#list_certificates

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

Lists Certificates.

Overloads 
def list_certificates(request, options = nil) -> ::Google::Cloud::Security::PrivateCA::V1beta1::ListCertificatesResponse
Pass arguments to list_certificates via a request object, either of type ListCertificatesRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Security::PrivateCA::V1beta1::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::V1beta1::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
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/security/private_ca/v1beta1"

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

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Security::PrivateCA::V1beta1::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::V1beta1::Certificate.
  p item
end

#list_reusable_configs

def list_reusable_configs(request, options = nil) -> ::Google::Cloud::Security::PrivateCA::V1beta1::ListReusableConfigsResponse
def list_reusable_configs(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) -> ::Google::Cloud::Security::PrivateCA::V1beta1::ListReusableConfigsResponse

Lists ReusableConfigs.

Overloads 
def list_reusable_configs(request, options = nil) -> ::Google::Cloud::Security::PrivateCA::V1beta1::ListReusableConfigsResponse
Pass arguments to list_reusable_configs via a request object, either of type ListReusableConfigsRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Security::PrivateCA::V1beta1::ListReusableConfigsRequest, ::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_reusable_configs(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) -> ::Google::Cloud::Security::PrivateCA::V1beta1::ListReusableConfigsResponse
Pass arguments to list_reusable_configs 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 ReusableConfigs, in the format projects/*/locations/*.
  • page_size (::Integer) — Optional. Limit on the number of ReusableConfigs to include in the response. Further ReusableConfigs can subsequently be obtained by including the ListReusableConfigsResponse.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 ListReusableConfigsResponse.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
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/security/private_ca/v1beta1"

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

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

# Call the list_reusable_configs method.
result = client.list_reusable_configs 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::V1beta1::ReusableConfig.
  p item
end

#operations_client

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

Get the associated client for long-running operations.

Returns

#restore_certificate_authority

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

Restore a CertificateAuthority that is scheduled for deletion.

Overloads 
def restore_certificate_authority(request, options = nil) -> ::Gapic::Operation
Pass arguments to restore_certificate_authority via a request object, either of type RestoreCertificateAuthorityRequest or an equivalent Hash.
Parameters 
def restore_certificate_authority(name: nil, request_id: nil) -> ::Gapic::Operation
Pass arguments to restore_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/*/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 t he request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

    The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

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/v1beta1"

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

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

# Call the restore_certificate_authority method.
result = client.restore_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

#revoke_certificate

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

Revoke a Certificate.

Overloads 
def revoke_certificate(request, options = nil) -> ::Google::Cloud::Security::PrivateCA::V1beta1::Certificate
Pass arguments to revoke_certificate via a request object, either of type RevokeCertificateRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Security::PrivateCA::V1beta1::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::V1beta1::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/*/certificateAuthorities/*/certificates/*.
  • reason (::Google::Cloud::Security::PrivateCA::V1beta1::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 t he request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

    The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/security/private_ca/v1beta1"

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

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

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

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

#schedule_delete_certificate_authority

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

Schedule a CertificateAuthority for deletion.

Overloads 
def schedule_delete_certificate_authority(request, options = nil) -> ::Gapic::Operation
Pass arguments to schedule_delete_certificate_authority via a request object, either of type ScheduleDeleteCertificateAuthorityRequest or an equivalent Hash.
Parameters 
def schedule_delete_certificate_authority(name: nil, request_id: nil) -> ::Gapic::Operation
Pass arguments to schedule_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/*/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 t he request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

    The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

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/v1beta1"

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

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

# Call the schedule_delete_certificate_authority method.
result = client.schedule_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

#universe_domain

def universe_domain() -> String

The effective universe domain

Returns
  • (String)

#update_certificate

def update_certificate(request, options = nil) -> ::Google::Cloud::Security::PrivateCA::V1beta1::Certificate
def update_certificate(certificate: nil, update_mask: nil, request_id: nil) -> ::Google::Cloud::Security::PrivateCA::V1beta1::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::V1beta1::Certificate
Pass arguments to update_certificate via a request object, either of type UpdateCertificateRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Security::PrivateCA::V1beta1::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::V1beta1::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::V1beta1::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 t he request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

    The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/security/private_ca/v1beta1"

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

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

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

# The returned object is of type Google::Cloud::Security::PrivateCA::V1beta1::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 
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::V1beta1::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 t he request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

    The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

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/v1beta1"

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

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Security::PrivateCA::V1beta1::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 
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::V1beta1::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 t he request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

    The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

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/v1beta1"

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

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Security::PrivateCA::V1beta1::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