Public Certificate Authority V1beta1 API - Class Google::Cloud::Security::PublicCA::V1beta1::PublicCertificateAuthorityService::Client (v0.3.0)

Reference documentation and code samples for the Public Certificate Authority V1beta1 API class Google::Cloud::Security::PublicCA::V1beta1::PublicCertificateAuthorityService::Client.

Client for the PublicCertificateAuthorityService service.

Manages the resources required for ACME external account binding for the public certificate authority service.

Inherits

Object

Includes

Google::Cloud::Security::PublicCA::V1beta1::PublicCertificateAuthorityService::Paths

Methods

.configure

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

Configure the PublicCertificateAuthorityService Client class.

See Configuration for a description of the configuration fields.

Yields

(config) — Configure the Client client.

Yield Parameter

config (Client::Configuration)

Returns

(Client::Configuration)

Example

# Modify the configuration for all PublicCertificateAuthorityService clients
::Google::Cloud::Security::PublicCA::V1beta1::PublicCertificateAuthorityService::Client.configure do |config|
  config.timeout = 10.0
end

#configure

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

Configure the PublicCertificateAuthorityService Client instance.

The configuration is set to the derived mode, meaning that values can be changed, but structural changes (adding new fields, etc.) are not allowed. Structural changes should be made on Client.configure.

See Configuration for a description of the configuration fields.

Yields

(config) — Configure the Client client.

Yield Parameter

config (Client::Configuration)

Returns

(Client::Configuration)

#create_external_account_key

def create_external_account_key(request, options = nil) -> ::Google::Cloud::Security::PublicCA::V1beta1::ExternalAccountKey
def create_external_account_key(parent: nil, external_account_key: nil) -> ::Google::Cloud::Security::PublicCA::V1beta1::ExternalAccountKey

Creates a new ExternalAccountKey bound to the project.

Overloads

def create_external_account_key(request, options = nil) -> ::Google::Cloud::Security::PublicCA::V1beta1::ExternalAccountKey

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

Parameters

request (::Google::Cloud::Security::PublicCA::V1beta1::CreateExternalAccountKeyRequest, ::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_external_account_key(parent: nil, external_account_key: nil) -> ::Google::Cloud::Security::PublicCA::V1beta1::ExternalAccountKey

Pass arguments to create_external_account_key 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 where this external_account_key will be created. Format: projects/[project_id]/locations/[location]. At present only the "global" location is supported.
external_account_key (::Google::Cloud::Security::PublicCA::V1beta1::ExternalAccountKey, ::Hash) — Required. The external account key to create. This field only exists to future-proof the API. At present, all fields in ExternalAccountKey are output only and all values are ignored. For the purpose of the CreateExternalAccountKeyRequest, set it to a default/empty value.

Yields

(response, operation) — Access the result along with the RPC operation

Yield Parameters

response (::Google::Cloud::Security::PublicCA::V1beta1::ExternalAccountKey)
operation (::GRPC::ActiveCall::Operation)

Returns

(::Google::Cloud::Security::PublicCA::V1beta1::ExternalAccountKey)

Raises

(::Google::Cloud::Error) — if the RPC is aborted.

Example

Basic example

require "google/cloud/security/public_ca/v1beta1"

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

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

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

# The returned object is of type Google::Cloud::Security::PublicCA::V1beta1::ExternalAccountKey.
p result

#initialize

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

Create a new PublicCertificateAuthorityService client object.

Yields

(config) — Configure the PublicCertificateAuthorityService client.

Yield Parameter

config (Client::Configuration)

Returns

(Client) — a new instance of Client

Example

# Create a client using the default configuration
client = ::Google::Cloud::Security::PublicCA::V1beta1::PublicCertificateAuthorityService::Client.new

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