Certificate Manager V1 API - Class Google::Cloud::CertificateManager::V1::CertificateManager::Rest::Client (v0.5.0)

Reference documentation and code samples for the Certificate Manager V1 API class Google::Cloud::CertificateManager::V1::CertificateManager::Rest::Client.

REST client for the CertificateManager service.

API Overview

Certificates Manager API allows customers to see and manage all their TLS certificates.

Certificates Manager API service provides methods to manage certificates, group them into collections, and create serving configuration that can be easily applied to other Cloud resources e.g. Target Proxies.

Data Model

The Certificates Manager service exposes the following resources:

  • Certificate that describes a single TLS certificate.
  • CertificateMap that describes a collection of certificates that can be attached to a target resource.
  • CertificateMapEntry that describes a single configuration entry that consists of a SNI and a group of certificates. It's a subresource of CertificateMap.

Certificate, CertificateMap and CertificateMapEntry IDs have to fully match the regexp [a-z0-9-]{1,63}. In other words,

  • only lower case letters, digits, and hyphen are allowed
  • length of the resource ID has to be in [1,63] range.

Provides methods to manage Cloud Certificate Manager entities.

Inherits

  • Object

Includes

Methods

.configure

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

Configure the CertificateManager 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 CertificateManager clients
::Google::Cloud::CertificateManager::V1::CertificateManager::Rest::Client.configure do |config|
  config.timeout = 10.0
end

#configure

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

Configure the CertificateManager 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) -> ::Gapic::Operation
def create_certificate(parent: nil, certificate_id: nil, certificate: nil) -> ::Gapic::Operation

Creates a new Certificate in a given project and location.

Overloads 
def create_certificate(request, options = nil) -> ::Gapic::Operation
Pass arguments to create_certificate via a request object, either of type Google::Cloud::CertificateManager::V1::CreateCertificateRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::CertificateManager::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) -> ::Gapic::Operation
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 parent resource of the certificate. Must be in the format projects/*/locations/*.
  • certificate_id (::String) — Required. A user-provided name of the certificate.
  • certificate (::Google::Cloud::CertificateManager::V1::Certificate, ::Hash) — Required. A definition of the certificate to create.
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.

#create_certificate_issuance_config

def create_certificate_issuance_config(request, options = nil) -> ::Gapic::Operation
def create_certificate_issuance_config(parent: nil, certificate_issuance_config_id: nil, certificate_issuance_config: nil) -> ::Gapic::Operation

Creates a new CertificateIssuanceConfig in a given project and location.

Overloads 
def create_certificate_issuance_config(request, options = nil) -> ::Gapic::Operation
Pass arguments to create_certificate_issuance_config via a request object, either of type Google::Cloud::CertificateManager::V1::CreateCertificateIssuanceConfigRequest or an equivalent Hash.
Parameters 
def create_certificate_issuance_config(parent: nil, certificate_issuance_config_id: nil, certificate_issuance_config: nil) -> ::Gapic::Operation
Pass arguments to create_certificate_issuance_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).
Parameters
  • parent (::String) — Required. The parent resource of the certificate issuance config. Must be in the format projects/*/locations/*.
  • certificate_issuance_config_id (::String) — Required. A user-provided name of the certificate config.
  • certificate_issuance_config (::Google::Cloud::CertificateManager::V1::CertificateIssuanceConfig, ::Hash) — Required. A definition of the certificate issuance config to create.
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.

#create_certificate_map

def create_certificate_map(request, options = nil) -> ::Gapic::Operation
def create_certificate_map(parent: nil, certificate_map_id: nil, certificate_map: nil) -> ::Gapic::Operation

Creates a new CertificateMap in a given project and location.

Overloads 
def create_certificate_map(request, options = nil) -> ::Gapic::Operation
Pass arguments to create_certificate_map via a request object, either of type Google::Cloud::CertificateManager::V1::CreateCertificateMapRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::CertificateManager::V1::CreateCertificateMapRequest, ::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_map(parent: nil, certificate_map_id: nil, certificate_map: nil) -> ::Gapic::Operation
Pass arguments to create_certificate_map 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 parent resource of the certificate map. Must be in the format projects/*/locations/*.
  • certificate_map_id (::String) — Required. A user-provided name of the certificate map.
  • certificate_map (::Google::Cloud::CertificateManager::V1::CertificateMap, ::Hash) — Required. A definition of the certificate map to create.
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.

#create_certificate_map_entry

def create_certificate_map_entry(request, options = nil) -> ::Gapic::Operation
def create_certificate_map_entry(parent: nil, certificate_map_entry_id: nil, certificate_map_entry: nil) -> ::Gapic::Operation

Creates a new CertificateMapEntry in a given project and location.

Overloads 
def create_certificate_map_entry(request, options = nil) -> ::Gapic::Operation
Pass arguments to create_certificate_map_entry via a request object, either of type Google::Cloud::CertificateManager::V1::CreateCertificateMapEntryRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::CertificateManager::V1::CreateCertificateMapEntryRequest, ::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_map_entry(parent: nil, certificate_map_entry_id: nil, certificate_map_entry: nil) -> ::Gapic::Operation
Pass arguments to create_certificate_map_entry 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 parent resource of the certificate map entry. Must be in the format projects/*/locations/*/certificateMaps/*.
  • certificate_map_entry_id (::String) — Required. A user-provided name of the certificate map entry.
  • certificate_map_entry (::Google::Cloud::CertificateManager::V1::CertificateMapEntry, ::Hash) — Required. A definition of the certificate map entry to create.
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.

#create_dns_authorization

def create_dns_authorization(request, options = nil) -> ::Gapic::Operation
def create_dns_authorization(parent: nil, dns_authorization_id: nil, dns_authorization: nil) -> ::Gapic::Operation

Creates a new DnsAuthorization in a given project and location.

Overloads 
def create_dns_authorization(request, options = nil) -> ::Gapic::Operation
Pass arguments to create_dns_authorization via a request object, either of type Google::Cloud::CertificateManager::V1::CreateDnsAuthorizationRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::CertificateManager::V1::CreateDnsAuthorizationRequest, ::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_dns_authorization(parent: nil, dns_authorization_id: nil, dns_authorization: nil) -> ::Gapic::Operation
Pass arguments to create_dns_authorization 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 parent resource of the dns authorization. Must be in the format projects/*/locations/*.
  • dns_authorization_id (::String) — Required. A user-provided name of the dns authorization.
  • dns_authorization (::Google::Cloud::CertificateManager::V1::DnsAuthorization, ::Hash) — Required. A definition of the dns authorization to create.
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.

#delete_certificate

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

Deletes a single Certificate.

Overloads 
def delete_certificate(request, options = nil) -> ::Gapic::Operation
Pass arguments to delete_certificate via a request object, either of type DeleteCertificateRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::CertificateManager::V1::DeleteCertificateRequest, ::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(name: nil) -> ::Gapic::Operation
Pass arguments to delete_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. A name of the certificate to delete. Must be in the format projects/*/locations/*/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.

#delete_certificate_issuance_config

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

Deletes a single CertificateIssuanceConfig.

Overloads 
def delete_certificate_issuance_config(request, options = nil) -> ::Gapic::Operation
Pass arguments to delete_certificate_issuance_config via a request object, either of type DeleteCertificateIssuanceConfigRequest or an equivalent Hash.
Parameters 
def delete_certificate_issuance_config(name: nil) -> ::Gapic::Operation
Pass arguments to delete_certificate_issuance_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. A name of the certificate issuance config to delete. Must be in the format projects/*/locations/*/certificateIssuanceConfigs/*.
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.

#delete_certificate_map

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

Deletes a single CertificateMap. A Certificate Map can't be deleted if it contains Certificate Map Entries. Remove all the entries from the map before calling this method.

Overloads 
def delete_certificate_map(request, options = nil) -> ::Gapic::Operation
Pass arguments to delete_certificate_map via a request object, either of type DeleteCertificateMapRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::CertificateManager::V1::DeleteCertificateMapRequest, ::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_map(name: nil) -> ::Gapic::Operation
Pass arguments to delete_certificate_map 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. A name of the certificate map to delete. Must be in the format projects/*/locations/*/certificateMaps/*.
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.

#delete_certificate_map_entry

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

Deletes a single CertificateMapEntry.

Overloads 
def delete_certificate_map_entry(request, options = nil) -> ::Gapic::Operation
Pass arguments to delete_certificate_map_entry via a request object, either of type DeleteCertificateMapEntryRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::CertificateManager::V1::DeleteCertificateMapEntryRequest, ::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_map_entry(name: nil) -> ::Gapic::Operation
Pass arguments to delete_certificate_map_entry 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. A name of the certificate map entry to delete. Must be in the format projects/*/locations/*/certificateMaps/*/certificateMapEntries/*.
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.

#delete_dns_authorization

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

Deletes a single DnsAuthorization.

Overloads 
def delete_dns_authorization(request, options = nil) -> ::Gapic::Operation
Pass arguments to delete_dns_authorization via a request object, either of type DeleteDnsAuthorizationRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::CertificateManager::V1::DeleteDnsAuthorizationRequest, ::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_dns_authorization(name: nil) -> ::Gapic::Operation
Pass arguments to delete_dns_authorization 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. A name of the dns authorization to delete. Must be in the format projects/*/locations/*/dnsAuthorizations/*.
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.

#get_certificate

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

Gets details of a single Certificate.

Overloads 
def get_certificate(request, options = nil) -> ::Google::Cloud::CertificateManager::V1::Certificate
Pass arguments to get_certificate via a request object, either of type GetCertificateRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::CertificateManager::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::CertificateManager::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. A name of the certificate to describe. Must be in the format projects/*/locations/*/certificates/*.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.

#get_certificate_issuance_config

def get_certificate_issuance_config(request, options = nil) -> ::Google::Cloud::CertificateManager::V1::CertificateIssuanceConfig
def get_certificate_issuance_config(name: nil) -> ::Google::Cloud::CertificateManager::V1::CertificateIssuanceConfig

Gets details of a single CertificateIssuanceConfig.

Overloads 
def get_certificate_issuance_config(request, options = nil) -> ::Google::Cloud::CertificateManager::V1::CertificateIssuanceConfig
Pass arguments to get_certificate_issuance_config via a request object, either of type GetCertificateIssuanceConfigRequest or an equivalent Hash.
Parameters 
def get_certificate_issuance_config(name: nil) -> ::Google::Cloud::CertificateManager::V1::CertificateIssuanceConfig
Pass arguments to get_certificate_issuance_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. A name of the certificate issuance config to describe. Must be in the format projects/*/locations/*/certificateIssuanceConfigs/*.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.

#get_certificate_map

def get_certificate_map(request, options = nil) -> ::Google::Cloud::CertificateManager::V1::CertificateMap
def get_certificate_map(name: nil) -> ::Google::Cloud::CertificateManager::V1::CertificateMap

Gets details of a single CertificateMap.

Overloads 
def get_certificate_map(request, options = nil) -> ::Google::Cloud::CertificateManager::V1::CertificateMap
Pass arguments to get_certificate_map via a request object, either of type GetCertificateMapRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::CertificateManager::V1::GetCertificateMapRequest, ::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_map(name: nil) -> ::Google::Cloud::CertificateManager::V1::CertificateMap
Pass arguments to get_certificate_map 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. A name of the certificate map to describe. Must be in the format projects/*/locations/*/certificateMaps/*.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.

#get_certificate_map_entry

def get_certificate_map_entry(request, options = nil) -> ::Google::Cloud::CertificateManager::V1::CertificateMapEntry
def get_certificate_map_entry(name: nil) -> ::Google::Cloud::CertificateManager::V1::CertificateMapEntry

Gets details of a single CertificateMapEntry.

Overloads 
def get_certificate_map_entry(request, options = nil) -> ::Google::Cloud::CertificateManager::V1::CertificateMapEntry
Pass arguments to get_certificate_map_entry via a request object, either of type GetCertificateMapEntryRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::CertificateManager::V1::GetCertificateMapEntryRequest, ::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_map_entry(name: nil) -> ::Google::Cloud::CertificateManager::V1::CertificateMapEntry
Pass arguments to get_certificate_map_entry 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. A name of the certificate map entry to describe. Must be in the format projects/*/locations/*/certificateMaps/*/certificateMapEntries/*.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.

#get_dns_authorization

def get_dns_authorization(request, options = nil) -> ::Google::Cloud::CertificateManager::V1::DnsAuthorization
def get_dns_authorization(name: nil) -> ::Google::Cloud::CertificateManager::V1::DnsAuthorization

Gets details of a single DnsAuthorization.

Overloads 
def get_dns_authorization(request, options = nil) -> ::Google::Cloud::CertificateManager::V1::DnsAuthorization
Pass arguments to get_dns_authorization via a request object, either of type GetDnsAuthorizationRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::CertificateManager::V1::GetDnsAuthorizationRequest, ::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_dns_authorization(name: nil) -> ::Google::Cloud::CertificateManager::V1::DnsAuthorization
Pass arguments to get_dns_authorization 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. A name of the dns authorization to describe. Must be in the format projects/*/locations/*/dnsAuthorizations/*.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.

#initialize

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

Create a new CertificateManager REST client object.

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

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

#list_certificate_issuance_configs

def list_certificate_issuance_configs(request, options = nil) -> ::Google::Cloud::CertificateManager::V1::ListCertificateIssuanceConfigsResponse
def list_certificate_issuance_configs(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) -> ::Google::Cloud::CertificateManager::V1::ListCertificateIssuanceConfigsResponse

Lists CertificateIssuanceConfigs in a given project and location.

Overloads 
def list_certificate_issuance_configs(request, options = nil) -> ::Google::Cloud::CertificateManager::V1::ListCertificateIssuanceConfigsResponse
Pass arguments to list_certificate_issuance_configs via a request object, either of type ListCertificateIssuanceConfigsRequest or an equivalent Hash.
Parameters 
def list_certificate_issuance_configs(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) -> ::Google::Cloud::CertificateManager::V1::ListCertificateIssuanceConfigsResponse
Pass arguments to list_certificate_issuance_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 project and location from which the certificate should be listed, specified in the format projects/*/locations/*.
  • page_size (::Integer) — Maximum number of certificate configs to return per call.
  • page_token (::String) — The value returned by the last ListCertificateIssuanceConfigsResponse. Indicates that this is a continuation of a prior ListCertificateIssuanceConfigs call, and that the system should return the next page of data.
  • filter (::String) — Filter expression to restrict the Certificates Configs returned.
  • order_by (::String) — A list of Certificate Config field names used to specify the order of the returned results. The default sorting order is ascending. To specify descending order for a field, add a suffix " desc".
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.

#list_certificate_map_entries

def list_certificate_map_entries(request, options = nil) -> ::Google::Cloud::CertificateManager::V1::ListCertificateMapEntriesResponse
def list_certificate_map_entries(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) -> ::Google::Cloud::CertificateManager::V1::ListCertificateMapEntriesResponse

Lists CertificateMapEntries in a given project and location.

Overloads 
def list_certificate_map_entries(request, options = nil) -> ::Google::Cloud::CertificateManager::V1::ListCertificateMapEntriesResponse
Pass arguments to list_certificate_map_entries via a request object, either of type ListCertificateMapEntriesRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::CertificateManager::V1::ListCertificateMapEntriesRequest, ::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_map_entries(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) -> ::Google::Cloud::CertificateManager::V1::ListCertificateMapEntriesResponse
Pass arguments to list_certificate_map_entries 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 project, location and certificate map from which the certificate map entries should be listed, specified in the format projects/*/locations/*/certificateMaps/*.
  • page_size (::Integer) — Maximum number of certificate map entries to return. The service may return fewer than this value. If unspecified, at most 50 certificate map entries will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
  • page_token (::String) — The value returned by the last ListCertificateMapEntriesResponse. Indicates that this is a continuation of a prior ListCertificateMapEntries call, and that the system should return the next page of data.
  • filter (::String) — Filter expression to restrict the returned Certificate Map Entries.
  • order_by (::String) — A list of Certificate Map Entry field names used to specify the order of the returned results. The default sorting order is ascending. To specify descending order for a field, add a suffix " desc".
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.

#list_certificate_maps

def list_certificate_maps(request, options = nil) -> ::Google::Cloud::CertificateManager::V1::ListCertificateMapsResponse
def list_certificate_maps(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) -> ::Google::Cloud::CertificateManager::V1::ListCertificateMapsResponse

Lists CertificateMaps in a given project and location.

Overloads 
def list_certificate_maps(request, options = nil) -> ::Google::Cloud::CertificateManager::V1::ListCertificateMapsResponse
Pass arguments to list_certificate_maps via a request object, either of type ListCertificateMapsRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::CertificateManager::V1::ListCertificateMapsRequest, ::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_maps(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) -> ::Google::Cloud::CertificateManager::V1::ListCertificateMapsResponse
Pass arguments to list_certificate_maps 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 project and location from which the certificate maps should be listed, specified in the format projects/*/locations/*.
  • page_size (::Integer) — Maximum number of certificate maps to return per call.
  • page_token (::String) — The value returned by the last ListCertificateMapsResponse. Indicates that this is a continuation of a prior ListCertificateMaps call, and that the system should return the next page of data.
  • filter (::String) — Filter expression to restrict the Certificates Maps returned.
  • order_by (::String) — A list of Certificate Map field names used to specify the order of the returned results. The default sorting order is ascending. To specify descending order for a field, add a suffix " desc".
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.

#list_certificates

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

Lists Certificates in a given project and location.

Overloads 
def list_certificates(request, options = nil) -> ::Google::Cloud::CertificateManager::V1::ListCertificatesResponse
Pass arguments to list_certificates via a request object, either of type ListCertificatesRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::CertificateManager::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::CertificateManager::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 project and location from which the certificate should be listed, specified in the format projects/*/locations/*.
  • page_size (::Integer) — Maximum number of certificates to return per call.
  • page_token (::String) — The value returned by the last ListCertificatesResponse. Indicates that this is a continuation of a prior ListCertificates call, and that the system should return the next page of data.
  • filter (::String) — Filter expression to restrict the Certificates returned.
  • order_by (::String) — A list of Certificate field names used to specify the order of the returned results. The default sorting order is ascending. To specify descending order for a field, add a suffix " desc".
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.

#list_dns_authorizations

def list_dns_authorizations(request, options = nil) -> ::Google::Cloud::CertificateManager::V1::ListDnsAuthorizationsResponse
def list_dns_authorizations(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) -> ::Google::Cloud::CertificateManager::V1::ListDnsAuthorizationsResponse

Lists DnsAuthorizations in a given project and location.

Overloads 
def list_dns_authorizations(request, options = nil) -> ::Google::Cloud::CertificateManager::V1::ListDnsAuthorizationsResponse
Pass arguments to list_dns_authorizations via a request object, either of type ListDnsAuthorizationsRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::CertificateManager::V1::ListDnsAuthorizationsRequest, ::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_dns_authorizations(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) -> ::Google::Cloud::CertificateManager::V1::ListDnsAuthorizationsResponse
Pass arguments to list_dns_authorizations 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 project and location from which the dns authorizations should be listed, specified in the format projects/*/locations/*.
  • page_size (::Integer) — Maximum number of dns authorizations to return per call.
  • page_token (::String) — The value returned by the last ListDnsAuthorizationsResponse. Indicates that this is a continuation of a prior ListDnsAuthorizations call, and that the system should return the next page of data.
  • filter (::String) — Filter expression to restrict the Dns Authorizations returned.
  • order_by (::String) — A list of Dns Authorization field names used to specify the order of the returned results. The default sorting order is ascending. To specify descending order for a field, add a suffix " desc".
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.

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

#operations_client

def operations_client() -> ::Google::Cloud::CertificateManager::V1::CertificateManager::Rest::Operations

Get the associated client for long-running operations.

Returns

#update_certificate

def update_certificate(request, options = nil) -> ::Gapic::Operation
def update_certificate(certificate: nil, update_mask: nil) -> ::Gapic::Operation

Updates a Certificate.

Overloads 
def update_certificate(request, options = nil) -> ::Gapic::Operation
Pass arguments to update_certificate via a request object, either of type UpdateCertificateRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::CertificateManager::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) -> ::Gapic::Operation
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
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.

#update_certificate_map

def update_certificate_map(request, options = nil) -> ::Gapic::Operation
def update_certificate_map(certificate_map: nil, update_mask: nil) -> ::Gapic::Operation

Updates a CertificateMap.

Overloads 
def update_certificate_map(request, options = nil) -> ::Gapic::Operation
Pass arguments to update_certificate_map via a request object, either of type UpdateCertificateMapRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::CertificateManager::V1::UpdateCertificateMapRequest, ::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_map(certificate_map: nil, update_mask: nil) -> ::Gapic::Operation
Pass arguments to update_certificate_map 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
  • result (::Gapic::Operation)
  • operation (::Gapic::Rest::TransportOperation)
Returns
  • (::Gapic::Operation)
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.

#update_certificate_map_entry

def update_certificate_map_entry(request, options = nil) -> ::Gapic::Operation
def update_certificate_map_entry(certificate_map_entry: nil, update_mask: nil) -> ::Gapic::Operation

Updates a CertificateMapEntry.

Overloads 
def update_certificate_map_entry(request, options = nil) -> ::Gapic::Operation
Pass arguments to update_certificate_map_entry via a request object, either of type UpdateCertificateMapEntryRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::CertificateManager::V1::UpdateCertificateMapEntryRequest, ::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_map_entry(certificate_map_entry: nil, update_mask: nil) -> ::Gapic::Operation
Pass arguments to update_certificate_map_entry 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
  • result (::Gapic::Operation)
  • operation (::Gapic::Rest::TransportOperation)
Returns
  • (::Gapic::Operation)
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.

#update_dns_authorization

def update_dns_authorization(request, options = nil) -> ::Gapic::Operation
def update_dns_authorization(dns_authorization: nil, update_mask: nil) -> ::Gapic::Operation

Updates a DnsAuthorization.

Overloads 
def update_dns_authorization(request, options = nil) -> ::Gapic::Operation
Pass arguments to update_dns_authorization via a request object, either of type UpdateDnsAuthorizationRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::CertificateManager::V1::UpdateDnsAuthorizationRequest, ::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_dns_authorization(dns_authorization: nil, update_mask: nil) -> ::Gapic::Operation
Pass arguments to update_dns_authorization 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
  • result (::Gapic::Operation)
  • operation (::Gapic::Rest::TransportOperation)
Returns
  • (::Gapic::Operation)
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.