Create a new client object for CertificateAuthorityService.
By default, this returns an instance of
Google::Cloud::Security::PrivateCA::V1::CertificateAuthorityService::Client
for a gRPC client for version V1 of the API.
However, you can specify a different API version by passing it in the
version parameter. If the CertificateAuthorityService service is
supported by that API version, and the corresponding gem is available, the
appropriate versioned client will be returned.
You can also specify a different transport by passing :rest or :grpc in
the transport parameter.
Raises an exception if the currently installed versioned client gem for the
given API version does not support the given transport of the CertificateAuthorityService service.
You can determine whether the method will succeed by calling
PrivateCA.certificate_authority_service_available?.
About CertificateAuthorityService
[Certificate Authority
Service][google.cloud.security.privateca.v1.CertificateAuthorityService]
manages private certificate authorities and issued certificates.
Parameters
version (::String, ::Symbol) (defaults to: :v1) — The API version to connect to. Optional.
Defaults to :v1.
transport (:grpc, :rest) (defaults to: :grpc) — The transport to use. Defaults to :grpc.
Returns
(::Object) — A client object for the specified version.
Determines whether the CertificateAuthorityService service is supported by the current client.
If true, you can retrieve a client object by calling PrivateCA.certificate_authority_service.
If false, that method will raise an exception. This could happen if the given
API version does not exist or does not support the CertificateAuthorityService service,
or if the versioned client gem needs an update to support the CertificateAuthorityService service.
Parameters
version (::String, ::Symbol) (defaults to: :v1) — The API version to connect to. Optional.
Defaults to :v1.
transport (:grpc, :rest) (defaults to: :grpc) — The transport to use. Defaults to :grpc.
Returns
(boolean) — Whether the service is available.
.configure
defself.configure()->::Google::Cloud::Config
Configure the google-cloud-security-private_ca library.
The following configuration parameters are supported:
credentials (type:String, Hash, Google::Auth::Credentials) -
The path to the keyfile as a String, the contents of the keyfile as a
Hash, or a Google::Auth::Credentials object.
lib_name (type:String) -
The library name as recorded in instrumentation and logging.
lib_version (type:String) -
The library version as recorded in instrumentation and logging.
interceptors (type:Array<GRPC::ClientInterceptor>) -
An array of interceptors that are run before calls are executed.
timeout (type:Numeric) -
Default timeout in seconds.
metadata (type:Hash{Symbol=>String}) -
Additional headers to be sent with the call.
retry_policy (type:Hash) -
The retry policy. The value is a hash with the following keys:
:initial_delay (type:Numeric) - The initial delay in seconds.
:max_delay (type:Numeric) - The max delay in seconds.
:multiplier (type:Numeric) - The incremental backoff multiplier.
:retry_codes (type:Array<String>) -
The error codes that should trigger a retry.
Yields
(::Google::Cloud.configure.security_private_ca)
Returns
(::Google::Cloud::Config) — The default configuration used by this library
[[["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-09-04 UTC."],[],[],null,["# Certificate Authority Service API - Module Google::Cloud::Security::PrivateCA (v2.0.1)\n\nVersion latestkeyboard_arrow_down\n\n- [2.0.1 (latest)](/ruby/docs/reference/google-cloud-security-private_ca/latest/Google-Cloud-Security-PrivateCA)\n- [2.0.0](/ruby/docs/reference/google-cloud-security-private_ca/2.0.0/Google-Cloud-Security-PrivateCA)\n- [1.5.0](/ruby/docs/reference/google-cloud-security-private_ca/1.5.0/Google-Cloud-Security-PrivateCA)\n- [1.4.1](/ruby/docs/reference/google-cloud-security-private_ca/1.4.1/Google-Cloud-Security-PrivateCA)\n- [1.3.0](/ruby/docs/reference/google-cloud-security-private_ca/1.3.0/Google-Cloud-Security-PrivateCA)\n- [1.2.0](/ruby/docs/reference/google-cloud-security-private_ca/1.2.0/Google-Cloud-Security-PrivateCA)\n- [1.1.0](/ruby/docs/reference/google-cloud-security-private_ca/1.1.0/Google-Cloud-Security-PrivateCA)\n- [1.0.4](/ruby/docs/reference/google-cloud-security-private_ca/1.0.4/Google-Cloud-Security-PrivateCA) \nReference documentation and code samples for the Certificate Authority Service API module Google::Cloud::Security::PrivateCA.\n\nMethods\n-------\n\n### .certificate_authority_service\n\n def self.certificate_authority_service(version: :v1, transport: :grpc, &block) -\u003e ::Object\n\nCreate a new client object for CertificateAuthorityService.\n\n\nBy default, this returns an instance of\n[Google::Cloud::Security::PrivateCA::V1::CertificateAuthorityService::Client](https://cloud.google.com/ruby/docs/reference/google-cloud-security-private_ca-v1/latest/Google-Cloud-Security-PrivateCA-V1-CertificateAuthorityService-Client)\nfor a gRPC client for version V1 of the API.\nHowever, you can specify a different API version by passing it in the\n`version` parameter. If the CertificateAuthorityService service is\nsupported by that API version, and the corresponding gem is available, the\nappropriate versioned client will be returned.\nYou can also specify a different transport by passing `:rest` or `:grpc` in\nthe `transport` parameter.\n\n\u003cbr /\u003e\n\nRaises an exception if the currently installed versioned client gem for the\ngiven API version does not support the given transport of the CertificateAuthorityService service.\nYou can determine whether the method will succeed by calling\n[PrivateCA.certificate_authority_service_available?](/ruby/docs/reference/google-cloud-security-private_ca/latest/Google-Cloud-Security-PrivateCA#Google__Cloud__Security__PrivateCA_certificate_authority_service_available__class_ \"Google::Cloud::Security::PrivateCA.certificate_authority_service_available? (method)\").\n\n#### About CertificateAuthorityService\n\n\u003cbr /\u003e\n\n\u003cbr /\u003e\n\n\\[Certificate Authority\nService\\]\\[google.cloud.security.privateca.v1.CertificateAuthorityService\\]\nmanages private certificate authorities and issued certificates. \n**Parameters**\n\n- **version** (::String, ::Symbol) *(defaults to: :v1)* --- The API version to connect to. Optional. Defaults to `:v1`.\n- **transport** (:grpc, :rest) *(defaults to: :grpc)* --- The transport to use. Defaults to `:grpc`. \n**Returns**\n\n- (::Object) --- A client object for the specified version.\n\n### .certificate_authority_service_available?\n\n def self.certificate_authority_service_available?(version: :v1, transport: :grpc) -\u003e boolean\n\nDetermines whether the CertificateAuthorityService service is supported by the current client.\nIf true, you can retrieve a client object by calling [PrivateCA.certificate_authority_service](/ruby/docs/reference/google-cloud-security-private_ca/latest/Google-Cloud-Security-PrivateCA#Google__Cloud__Security__PrivateCA_certificate_authority_service_class_ \"Google::Cloud::Security::PrivateCA.certificate_authority_service (method)\").\nIf false, that method will raise an exception. This could happen if the given\nAPI version does not exist or does not support the CertificateAuthorityService service,\nor if the versioned client gem needs an update to support the CertificateAuthorityService service. \n**Parameters**\n\n- **version** (::String, ::Symbol) *(defaults to: :v1)* --- The API version to connect to. Optional. Defaults to `:v1`.\n- **transport** (:grpc, :rest) *(defaults to: :grpc)* --- The transport to use. Defaults to `:grpc`. \n**Returns**\n\n- (boolean) --- Whether the service is available.\n\n### .configure\n\n def self.configure() -\u003e ::Google::Cloud::Config\n\nConfigure the google-cloud-security-private_ca library.\n\nThe following configuration parameters are supported:\n\n- `credentials` (*type:* `String, Hash, Google::Auth::Credentials`) - The path to the keyfile as a String, the contents of the keyfile as a Hash, or a Google::Auth::Credentials object.\n- `lib_name` (*type:* `String`) - The library name as recorded in instrumentation and logging.\n- `lib_version` (*type:* `String`) - The library version as recorded in instrumentation and logging.\n- `interceptors` (*type:* `Array\u003cGRPC::ClientInterceptor\u003e`) - An array of interceptors that are run before calls are executed.\n- `timeout` (*type:* `Numeric`) - Default timeout in seconds.\n- `metadata` (*type:* `Hash{Symbol=\u003eString}`) - Additional headers to be sent with the call.\n- `retry_policy` (*type:* `Hash`) - The retry policy. The value is a hash with the following keys:\n - `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.\n - `:max_delay` (*type:* `Numeric`) - The max delay in seconds.\n - `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.\n- `:retry_codes` (*type:* `Array\u003cString\u003e`) - The error codes that should trigger a retry. \n**Yields**\n\n- (::Google::Cloud.configure.security_private_ca) \n**Returns**\n\n- (::Google::Cloud::Config) --- The default configuration used by this library\n\nConstants\n---------\n\n### VERSION\n\n**value:**\"2.0.1\""]]
