Reference documentation and code samples for the Ceritificate Authority Service V1 API class Google::Cloud::Security::PrivateCA::V1::Certificate.
A Certificate corresponds to a signed X.509 certificate issued by a CertificateAuthority.
Inherits
- Object
Extended By
- Google::Protobuf::MessageExts::ClassMethods
Includes
- Google::Protobuf::MessageExts
Methods
#certificate_description
def certificate_description() -> ::Google::Cloud::Security::PrivateCA::V1::CertificateDescription
Returns
- (::Google::Cloud::Security::PrivateCA::V1::CertificateDescription) — Output only. A structured description of the issued X.509 certificate.
#certificate_template
def certificate_template() -> ::String
Returns
-
(::String) — Immutable. The resource name for a
CertificateTemplate
used to issue this certificate, in the format
projects/*/locations/*/certificateTemplates/*
. If this is specified, the caller must have the necessary permission to use this template. If this is omitted, no template will be used. This template must be in the same location as the Certificate.
#certificate_template=
def certificate_template=(value) -> ::String
Parameter
-
value (::String) — Immutable. The resource name for a
CertificateTemplate
used to issue this certificate, in the format
projects/*/locations/*/certificateTemplates/*
. If this is specified, the caller must have the necessary permission to use this template. If this is omitted, no template will be used. This template must be in the same location as the Certificate.
Returns
-
(::String) — Immutable. The resource name for a
CertificateTemplate
used to issue this certificate, in the format
projects/*/locations/*/certificateTemplates/*
. If this is specified, the caller must have the necessary permission to use this template. If this is omitted, no template will be used. This template must be in the same location as the Certificate.
#config
def config() -> ::Google::Cloud::Security::PrivateCA::V1::CertificateConfig
Returns
- (::Google::Cloud::Security::PrivateCA::V1::CertificateConfig) — Immutable. A description of the certificate and key that does not require X.509 or ASN.1.
#config=
def config=(value) -> ::Google::Cloud::Security::PrivateCA::V1::CertificateConfig
Parameter
- value (::Google::Cloud::Security::PrivateCA::V1::CertificateConfig) — Immutable. A description of the certificate and key that does not require X.509 or ASN.1.
Returns
- (::Google::Cloud::Security::PrivateCA::V1::CertificateConfig) — Immutable. A description of the certificate and key that does not require X.509 or ASN.1.
#create_time
def create_time() -> ::Google::Protobuf::Timestamp
Returns
- (::Google::Protobuf::Timestamp) — Output only. The time at which this Certificate was created.
#issuer_certificate_authority
def issuer_certificate_authority() -> ::String
Returns
-
(::String) — Output only. The resource name of the issuing
CertificateAuthority
in the format
projects/*/locations/*/caPools/*/certificateAuthorities/*
.
#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. Immutable. The desired lifetime of a certificate. Used to create the "not_before_time" and "not_after_time" fields inside an X.509 certificate. Note that the lifetime may be truncated if it would extend past the life of any certificate authority in the issuing chain.
#lifetime=
def lifetime=(value) -> ::Google::Protobuf::Duration
Parameter
- value (::Google::Protobuf::Duration) — Required. Immutable. The desired lifetime of a certificate. Used to create the "not_before_time" and "not_after_time" fields inside an X.509 certificate. Note that the lifetime may be truncated if it would extend past the life of any certificate authority in the issuing chain.
Returns
- (::Google::Protobuf::Duration) — Required. Immutable. The desired lifetime of a certificate. Used to create the "not_before_time" and "not_after_time" fields inside an X.509 certificate. Note that the lifetime may be truncated if it would extend past the life of any certificate authority in the issuing chain.
#name
def name() -> ::String
Returns
-
(::String) — Output only. The resource name for this
Certificate in the format
projects/*/locations/*/caPools/*/certificates/*
.
#pem_certificate
def pem_certificate() -> ::String
Returns
- (::String) — Output only. The pem-encoded, signed X.509 certificate.
#pem_certificate_chain
def pem_certificate_chain() -> ::Array<::String>
Returns
- (::Array<::String>) — Output only. The chain that may be used to verify the X.509 certificate. Expected to be in issuer-to-root order according to RFC 5246.
#pem_csr
def pem_csr() -> ::String
Returns
- (::String) — Immutable. A pem-encoded X.509 certificate signing request (CSR).
#pem_csr=
def pem_csr=(value) -> ::String
Parameter
- value (::String) — Immutable. A pem-encoded X.509 certificate signing request (CSR).
Returns
- (::String) — Immutable. A pem-encoded X.509 certificate signing request (CSR).
#revocation_details
def revocation_details() -> ::Google::Cloud::Security::PrivateCA::V1::Certificate::RevocationDetails
Returns
- (::Google::Cloud::Security::PrivateCA::V1::Certificate::RevocationDetails) — Output only. Details regarding the revocation of this Certificate. This Certificate is considered revoked if and only if this field is present.
#subject_mode
def subject_mode() -> ::Google::Cloud::Security::PrivateCA::V1::SubjectRequestMode
Returns
-
(::Google::Cloud::Security::PrivateCA::V1::SubjectRequestMode) — Immutable. Specifies how the
Certificate's identity
fields are to be decided. If this is omitted, the
DEFAULT
subject mode will be used.
#subject_mode=
def subject_mode=(value) -> ::Google::Cloud::Security::PrivateCA::V1::SubjectRequestMode
Parameter
-
value (::Google::Cloud::Security::PrivateCA::V1::SubjectRequestMode) — Immutable. Specifies how the
Certificate's identity
fields are to be decided. If this is omitted, the
DEFAULT
subject mode will be used.
Returns
-
(::Google::Cloud::Security::PrivateCA::V1::SubjectRequestMode) — Immutable. Specifies how the
Certificate's identity
fields are to be decided. If this is omitted, the
DEFAULT
subject mode will be used.
#update_time
def update_time() -> ::Google::Protobuf::Timestamp
Returns
- (::Google::Protobuf::Timestamp) — Output only. The time at which this Certificate was updated.