Reference documentation and code samples for the Certificate Authority Service V1beta1 API class Google::Cloud::Security::PrivateCA::V1beta1::CertificateAuthority.
A CertificateAuthority represents an individual Certificate Authority. A CertificateAuthority can be used to create Certificates.
Inherits
- Object
Extended By
- Google::Protobuf::MessageExts::ClassMethods
Includes
- Google::Protobuf::MessageExts
Methods
#access_urls
def access_urls() -> ::Google::Cloud::Security::PrivateCA::V1beta1::CertificateAuthority::AccessUrls
Returns
- (::Google::Cloud::Security::PrivateCA::V1beta1::CertificateAuthority::AccessUrls) — Output only. URLs for accessing content published by this CA, such as the CA certificate and CRLs.
#ca_certificate_descriptions
def ca_certificate_descriptions() -> ::Array<::Google::Cloud::Security::PrivateCA::V1beta1::CertificateDescription>
Returns
- (::Array<::Google::Cloud::Security::PrivateCA::V1beta1::CertificateDescription>) — Output only. A structured description of this CertificateAuthority's CA certificate and its issuers. Ordered as self-to-root.
#certificate_policy
def certificate_policy() -> ::Google::Cloud::Security::PrivateCA::V1beta1::CertificateAuthority::CertificateAuthorityPolicy
Returns
- (::Google::Cloud::Security::PrivateCA::V1beta1::CertificateAuthority::CertificateAuthorityPolicy) — Optional. The CertificateAuthorityPolicy to enforce when issuing Certificates from this CertificateAuthority.
#certificate_policy=
def certificate_policy=(value) -> ::Google::Cloud::Security::PrivateCA::V1beta1::CertificateAuthority::CertificateAuthorityPolicy
Parameter
- value (::Google::Cloud::Security::PrivateCA::V1beta1::CertificateAuthority::CertificateAuthorityPolicy) — Optional. The CertificateAuthorityPolicy to enforce when issuing Certificates from this CertificateAuthority.
Returns
- (::Google::Cloud::Security::PrivateCA::V1beta1::CertificateAuthority::CertificateAuthorityPolicy) — Optional. The CertificateAuthorityPolicy to enforce when issuing Certificates from this CertificateAuthority.
#config
def config() -> ::Google::Cloud::Security::PrivateCA::V1beta1::CertificateConfig
Returns
- (::Google::Cloud::Security::PrivateCA::V1beta1::CertificateConfig) — Required. Immutable. The config used to create a self-signed X.509 certificate or CSR.
#config=
def config=(value) -> ::Google::Cloud::Security::PrivateCA::V1beta1::CertificateConfig
Parameter
- value (::Google::Cloud::Security::PrivateCA::V1beta1::CertificateConfig) — Required. Immutable. The config used to create a self-signed X.509 certificate or CSR.
Returns
- (::Google::Cloud::Security::PrivateCA::V1beta1::CertificateConfig) — Required. Immutable. The config used to create a self-signed X.509 certificate or CSR.
#create_time
def create_time() -> ::Google::Protobuf::Timestamp
Returns
- (::Google::Protobuf::Timestamp) — Output only. The time at which this CertificateAuthority was created.
#delete_time
def delete_time() -> ::Google::Protobuf::Timestamp
Returns
- (::Google::Protobuf::Timestamp) — Output only. The time at which this CertificateAuthority will be deleted, if scheduled for deletion.
#gcs_bucket
def gcs_bucket() -> ::String
Returns
-
(::String) — Immutable. The name of a Cloud Storage bucket where this CertificateAuthority will
publish content, such as the CA certificate and CRLs. This must be a bucket
name, without any prefixes (such as
gs://
) or suffixes (such as.googleapis.com
). For example, to use a bucket namedmy-bucket
, you would simply specifymy-bucket
. If not specified, a managed bucket will be created.
#gcs_bucket=
def gcs_bucket=(value) -> ::String
Parameter
-
value (::String) — Immutable. The name of a Cloud Storage bucket where this CertificateAuthority will
publish content, such as the CA certificate and CRLs. This must be a bucket
name, without any prefixes (such as
gs://
) or suffixes (such as.googleapis.com
). For example, to use a bucket namedmy-bucket
, you would simply specifymy-bucket
. If not specified, a managed bucket will be created.
Returns
-
(::String) — Immutable. The name of a Cloud Storage bucket where this CertificateAuthority will
publish content, such as the CA certificate and CRLs. This must be a bucket
name, without any prefixes (such as
gs://
) or suffixes (such as.googleapis.com
). For example, to use a bucket namedmy-bucket
, you would simply specifymy-bucket
. If not specified, a managed bucket will be created.
#issuing_options
def issuing_options() -> ::Google::Cloud::Security::PrivateCA::V1beta1::CertificateAuthority::IssuingOptions
Returns
- (::Google::Cloud::Security::PrivateCA::V1beta1::CertificateAuthority::IssuingOptions) — Optional. The IssuingOptions to follow when issuing Certificates from this CertificateAuthority.
#issuing_options=
def issuing_options=(value) -> ::Google::Cloud::Security::PrivateCA::V1beta1::CertificateAuthority::IssuingOptions
Parameter
- value (::Google::Cloud::Security::PrivateCA::V1beta1::CertificateAuthority::IssuingOptions) — Optional. The IssuingOptions to follow when issuing Certificates from this CertificateAuthority.
Returns
- (::Google::Cloud::Security::PrivateCA::V1beta1::CertificateAuthority::IssuingOptions) — Optional. The IssuingOptions to follow when issuing Certificates from this CertificateAuthority.
#key_spec
def key_spec() -> ::Google::Cloud::Security::PrivateCA::V1beta1::CertificateAuthority::KeyVersionSpec
Returns
- (::Google::Cloud::Security::PrivateCA::V1beta1::CertificateAuthority::KeyVersionSpec) — Required. Immutable. Used when issuing certificates for this CertificateAuthority. If this CertificateAuthority is a self-signed CertificateAuthority, this key is also used to sign the self-signed CA certificate. Otherwise, it is used to sign a CSR.
#key_spec=
def key_spec=(value) -> ::Google::Cloud::Security::PrivateCA::V1beta1::CertificateAuthority::KeyVersionSpec
Parameter
- value (::Google::Cloud::Security::PrivateCA::V1beta1::CertificateAuthority::KeyVersionSpec) — Required. Immutable. Used when issuing certificates for this CertificateAuthority. If this CertificateAuthority is a self-signed CertificateAuthority, this key is also used to sign the self-signed CA certificate. Otherwise, it is used to sign a CSR.
Returns
- (::Google::Cloud::Security::PrivateCA::V1beta1::CertificateAuthority::KeyVersionSpec) — Required. Immutable. Used when issuing certificates for this CertificateAuthority. If this CertificateAuthority is a self-signed CertificateAuthority, this key is also used to sign the self-signed CA certificate. Otherwise, it is used to sign a CSR.
#labels
def labels() -> ::Google::Protobuf::Map{::String => ::String}
Returns
- (::Google::Protobuf::Map{::String => ::String}) — Optional. Labels with user-defined metadata.
#labels=
def labels=(value) -> ::Google::Protobuf::Map{::String => ::String}
Parameter
- value (::Google::Protobuf::Map{::String => ::String}) — Optional. Labels with user-defined metadata.
Returns
- (::Google::Protobuf::Map{::String => ::String}) — Optional. Labels with user-defined metadata.
#lifetime
def lifetime() -> ::Google::Protobuf::Duration
Returns
- (::Google::Protobuf::Duration) — Required. The desired lifetime of the CA certificate. Used to create the "not_before_time" and "not_after_time" fields inside an X.509 certificate.
#lifetime=
def lifetime=(value) -> ::Google::Protobuf::Duration
Parameter
- value (::Google::Protobuf::Duration) — Required. The desired lifetime of the CA certificate. Used to create the "not_before_time" and "not_after_time" fields inside an X.509 certificate.
Returns
- (::Google::Protobuf::Duration) — Required. The desired lifetime of the CA certificate. Used to create the "not_before_time" and "not_after_time" fields inside an X.509 certificate.
#name
def name() -> ::String
Returns
-
(::String) — Output only. The resource name for this CertificateAuthority in the
format
projects/*/locations/*/certificateAuthorities/*
.
#pem_ca_certificates
def pem_ca_certificates() -> ::Array<::String>
Returns
- (::Array<::String>) — Output only. This CertificateAuthority's certificate chain, including the current CertificateAuthority's certificate. Ordered such that the root issuer is the final element (consistent with RFC 5246). For a self-signed CA, this will only list the current CertificateAuthority's certificate.
#state
def state() -> ::Google::Cloud::Security::PrivateCA::V1beta1::CertificateAuthority::State
Returns
- (::Google::Cloud::Security::PrivateCA::V1beta1::CertificateAuthority::State) — Output only. The State for this CertificateAuthority.
#subordinate_config
def subordinate_config() -> ::Google::Cloud::Security::PrivateCA::V1beta1::SubordinateConfig
Returns
- (::Google::Cloud::Security::PrivateCA::V1beta1::SubordinateConfig) — Optional. If this is a subordinate CertificateAuthority, this field will be set with the subordinate configuration, which describes its issuers. This may be updated, but this CertificateAuthority must continue to validate.
#subordinate_config=
def subordinate_config=(value) -> ::Google::Cloud::Security::PrivateCA::V1beta1::SubordinateConfig
Parameter
- value (::Google::Cloud::Security::PrivateCA::V1beta1::SubordinateConfig) — Optional. If this is a subordinate CertificateAuthority, this field will be set with the subordinate configuration, which describes its issuers. This may be updated, but this CertificateAuthority must continue to validate.
Returns
- (::Google::Cloud::Security::PrivateCA::V1beta1::SubordinateConfig) — Optional. If this is a subordinate CertificateAuthority, this field will be set with the subordinate configuration, which describes its issuers. This may be updated, but this CertificateAuthority must continue to validate.
#tier
def tier() -> ::Google::Cloud::Security::PrivateCA::V1beta1::CertificateAuthority::Tier
Returns
- (::Google::Cloud::Security::PrivateCA::V1beta1::CertificateAuthority::Tier) — Required. Immutable. The Tier of this CertificateAuthority.
#tier=
def tier=(value) -> ::Google::Cloud::Security::PrivateCA::V1beta1::CertificateAuthority::Tier
Parameter
- value (::Google::Cloud::Security::PrivateCA::V1beta1::CertificateAuthority::Tier) — Required. Immutable. The Tier of this CertificateAuthority.
Returns
- (::Google::Cloud::Security::PrivateCA::V1beta1::CertificateAuthority::Tier) — Required. Immutable. The Tier of this CertificateAuthority.
#type
def type() -> ::Google::Cloud::Security::PrivateCA::V1beta1::CertificateAuthority::Type
Returns
- (::Google::Cloud::Security::PrivateCA::V1beta1::CertificateAuthority::Type) — Required. Immutable. The Type of this CertificateAuthority.
#type=
def type=(value) -> ::Google::Cloud::Security::PrivateCA::V1beta1::CertificateAuthority::Type
Parameter
- value (::Google::Cloud::Security::PrivateCA::V1beta1::CertificateAuthority::Type) — Required. Immutable. The Type of this CertificateAuthority.
Returns
- (::Google::Cloud::Security::PrivateCA::V1beta1::CertificateAuthority::Type) — Required. Immutable. The Type of this CertificateAuthority.
#update_time
def update_time() -> ::Google::Protobuf::Timestamp
Returns
- (::Google::Protobuf::Timestamp) — Output only. The time at which this CertificateAuthority was updated.