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.
# Modify the configuration for all PublicCertificateAuthorityService clients::Google::Cloud::Security::PublicCA::V1beta1::PublicCertificateAuthorityService::Client.configuredo|config|config.timeout=10.0end
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.
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
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_keyrequest# The returned object is of type Google::Cloud::Security::PublicCA::V1beta1::ExternalAccountKey.presult
#initialize
definitialize(){|config|...}->Client
Create a new PublicCertificateAuthorityService client object.
Yields
(config) — Configure the PublicCertificateAuthorityService client.
# Create a client using the default configurationclient=::Google::Cloud::Security::PublicCA::V1beta1::PublicCertificateAuthorityService::Client.new# Create a client using a custom configurationclient=::Google::Cloud::Security::PublicCA::V1beta1::PublicCertificateAuthorityService::Client.newdo|config|config.timeout=10.0end
#logger
deflogger()->Logger
The logger used for request/response debug logging.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-28 UTC."],[],[],null,["# Public Certificate Authority V1beta1 API - Class Google::Cloud::Security::PublicCA::V1beta1::PublicCertificateAuthorityService::Client (v0.9.0)\n\nVersion latestkeyboard_arrow_down\n\n- [0.9.0 (latest)](/ruby/docs/reference/google-cloud-security-public_ca-v1beta1/latest/Google-Cloud-Security-PublicCA-V1beta1-PublicCertificateAuthorityService-Client)\n- [0.8.1](/ruby/docs/reference/google-cloud-security-public_ca-v1beta1/0.8.1/Google-Cloud-Security-PublicCA-V1beta1-PublicCertificateAuthorityService-Client)\n- [0.7.0](/ruby/docs/reference/google-cloud-security-public_ca-v1beta1/0.7.0/Google-Cloud-Security-PublicCA-V1beta1-PublicCertificateAuthorityService-Client)\n- [0.6.1](/ruby/docs/reference/google-cloud-security-public_ca-v1beta1/0.6.1/Google-Cloud-Security-PublicCA-V1beta1-PublicCertificateAuthorityService-Client)\n- [0.5.2](/ruby/docs/reference/google-cloud-security-public_ca-v1beta1/0.5.2/Google-Cloud-Security-PublicCA-V1beta1-PublicCertificateAuthorityService-Client)\n- [0.4.0](/ruby/docs/reference/google-cloud-security-public_ca-v1beta1/0.4.0/Google-Cloud-Security-PublicCA-V1beta1-PublicCertificateAuthorityService-Client)\n- [0.3.1](/ruby/docs/reference/google-cloud-security-public_ca-v1beta1/0.3.1/Google-Cloud-Security-PublicCA-V1beta1-PublicCertificateAuthorityService-Client)\n- [0.2.0](/ruby/docs/reference/google-cloud-security-public_ca-v1beta1/0.2.0/Google-Cloud-Security-PublicCA-V1beta1-PublicCertificateAuthorityService-Client)\n- [0.1.0](/ruby/docs/reference/google-cloud-security-public_ca-v1beta1/0.1.0/Google-Cloud-Security-PublicCA-V1beta1-PublicCertificateAuthorityService-Client) \nReference documentation and code samples for the Public Certificate Authority V1beta1 API class Google::Cloud::Security::PublicCA::V1beta1::PublicCertificateAuthorityService::Client.\n\nClient for the PublicCertificateAuthorityService service.\n\n\n\u003cbr /\u003e\n\nManages the resources required for ACME [external account\nbinding](https://tools.ietf.org/html/rfc8555#section-7.3.4) for\nthe public certificate authority service. \n\nInherits\n--------\n\n- Object \n\nIncludes\n--------\n\n- [Google::Cloud::Security::PublicCA::V1beta1::PublicCertificateAuthorityService::Paths](./Google-Cloud-Security-PublicCA-V1beta1-PublicCertificateAuthorityService-Paths)\n\nMethods\n-------\n\n### .configure\n\n def self.configure() { |config| ... } -\u003e Client::Configuration\n\nConfigure the PublicCertificateAuthorityService Client class.\n\n\n\u003cbr /\u003e\n\nSee [Configuration](/ruby/docs/reference/google-cloud-security-public_ca-v1beta1/latest/Google-Cloud-Security-PublicCA-V1beta1-PublicCertificateAuthorityService-Client-Configuration \"Google::Cloud::Security::PublicCA::V1beta1::PublicCertificateAuthorityService::Client::Configuration (class)\")\nfor a description of the configuration fields. \n**Yields**\n\n- (config) --- Configure the Client client. \n**Yield Parameter**\n\n- **config** ([Client::Configuration](./Google-Cloud-Security-PublicCA-V1beta1-PublicCertificateAuthorityService-Client-Configuration)) \n**Returns**\n\n- ([Client::Configuration](./Google-Cloud-Security-PublicCA-V1beta1-PublicCertificateAuthorityService-Client-Configuration))\n**Example** \n\n```ruby\n# Modify the configuration for all PublicCertificateAuthorityService clients\n::Google::Cloud::Security::PublicCA::V1beta1::PublicCertificateAuthorityService::Client.configure do |config|\n config.timeout = 10.0\nend\n```\n\n### #configure\n\n def configure() { |config| ... } -\u003e Client::Configuration\n\nConfigure the PublicCertificateAuthorityService Client instance.\n\n\nThe configuration is set to the derived mode, meaning that values can be changed,\nbut structural changes (adding new fields, etc.) are not allowed. Structural changes\nshould be made on [Client.configure](/ruby/docs/reference/google-cloud-security-public_ca-v1beta1/latest/Google-Cloud-Security-PublicCA-V1beta1-PublicCertificateAuthorityService-Client#Google__Cloud__Security__PublicCA__V1beta1__PublicCertificateAuthorityService__Client_configure_class_ \"Google::Cloud::Security::PublicCA::V1beta1::PublicCertificateAuthorityService::Client.configure (method)\").\n\n\u003cbr /\u003e\n\nSee [Configuration](/ruby/docs/reference/google-cloud-security-public_ca-v1beta1/latest/Google-Cloud-Security-PublicCA-V1beta1-PublicCertificateAuthorityService-Client-Configuration \"Google::Cloud::Security::PublicCA::V1beta1::PublicCertificateAuthorityService::Client::Configuration (class)\")\nfor a description of the configuration fields. \n**Yields**\n\n- (config) --- Configure the Client client. \n**Yield Parameter**\n\n- **config** ([Client::Configuration](./Google-Cloud-Security-PublicCA-V1beta1-PublicCertificateAuthorityService-Client-Configuration)) \n**Returns**\n\n- ([Client::Configuration](./Google-Cloud-Security-PublicCA-V1beta1-PublicCertificateAuthorityService-Client-Configuration))\n\n### #create_external_account_key\n\n def create_external_account_key(request, options = nil) -\u003e ::Google::Cloud::Security::PublicCA::V1beta1::ExternalAccountKey\n def create_external_account_key(parent: nil, external_account_key: nil) -\u003e ::Google::Cloud::Security::PublicCA::V1beta1::ExternalAccountKey\n\nCreates a new [ExternalAccountKey](/ruby/docs/reference/google-cloud-security-public_ca-v1beta1/latest/Google-Cloud-Security-PublicCA-V1beta1-ExternalAccountKey \"Google::Cloud::Security::PublicCA::V1beta1::ExternalAccountKey (class)\") bound to the project. \n**Overloads** \n\n def create_external_account_key(request, options = nil) -\u003e ::Google::Cloud::Security::PublicCA::V1beta1::ExternalAccountKey\n\nPass arguments to `create_external_account_key` via a request object, either of type [CreateExternalAccountKeyRequest](/ruby/docs/reference/google-cloud-security-public_ca-v1beta1/latest/Google-Cloud-Security-PublicCA-V1beta1-CreateExternalAccountKeyRequest \"Google::Cloud::Security::PublicCA::V1beta1::CreateExternalAccountKeyRequest (class)\") or an equivalent Hash. \n**Parameters**\n\n- **request** ([::Google::Cloud::Security::PublicCA::V1beta1::CreateExternalAccountKeyRequest](./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.\n- **options** (::Gapic::CallOptions, ::Hash) --- Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. \n\n def create_external_account_key(parent: nil, external_account_key: nil) -\u003e ::Google::Cloud::Security::PublicCA::V1beta1::ExternalAccountKey\n\nPass 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). \n**Parameters**\n\n- **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.\n- **external_account_key** ([::Google::Cloud::Security::PublicCA::V1beta1::ExternalAccountKey](./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. \n**Yields**\n\n- (response, operation) --- Access the result along with the RPC operation \n**Yield Parameters**\n\n- **response** ([::Google::Cloud::Security::PublicCA::V1beta1::ExternalAccountKey](./Google-Cloud-Security-PublicCA-V1beta1-ExternalAccountKey))\n- **operation** (::GRPC::ActiveCall::Operation) \n**Returns**\n\n- ([::Google::Cloud::Security::PublicCA::V1beta1::ExternalAccountKey](./Google-Cloud-Security-PublicCA-V1beta1-ExternalAccountKey)) \n**Raises**\n\n- (::Google::Cloud::Error) --- if the RPC is aborted.\n**Example**\n\nBasic example \n\n```ruby\nrequire \"google/cloud/security/public_ca/v1beta1\"\n\n# Create a client object. The client can be reused for multiple calls.\nclient = Google::Cloud::Security::PublicCA::V1beta1::PublicCertificateAuthorityService::Client.new\n\n# Create a request. To set request fields, pass in keyword arguments.\nrequest = Google::Cloud::Security::PublicCA::V1beta1::CreateExternalAccountKeyRequest.new\n\n# Call the create_external_account_key method.\nresult = client.create_external_account_key request\n\n# The returned object is of type Google::Cloud::Security::PublicCA::V1beta1::ExternalAccountKey.\np result\n```\n\n### #initialize\n\n def initialize() { |config| ... } -\u003e Client\n\nCreate a new PublicCertificateAuthorityService client object. \n**Yields**\n\n- (config) --- Configure the PublicCertificateAuthorityService client. \n**Yield Parameter**\n\n- **config** ([Client::Configuration](./Google-Cloud-Security-PublicCA-V1beta1-PublicCertificateAuthorityService-Client-Configuration)) \n**Returns**\n\n- ([Client](./Google-Cloud-Security-PublicCA-V1beta1-PublicCertificateAuthorityService-Client)) --- a new instance of Client\n**Example** \n\n```ruby\n# Create a client using the default configuration\nclient = ::Google::Cloud::Security::PublicCA::V1beta1::PublicCertificateAuthorityService::Client.new\n\n# Create a client using a custom configuration\nclient = ::Google::Cloud::Security::PublicCA::V1beta1::PublicCertificateAuthorityService::Client.new do |config|\n config.timeout = 10.0\nend\n```\n\n### #logger\n\n def logger() -\u003e Logger\n\nThe logger used for request/response debug logging. \n**Returns**\n\n- (Logger)\n\n### #universe_domain\n\n def universe_domain() -\u003e String\n\nThe effective universe domain \n**Returns**\n\n- (String)"]]
