Google Certificate Authority Service V1beta1 Client - Class Certificate (1.1.0)

Version 1.1.0

• 2.0.1 (latest)
• 2.0.0
• 1.7.3
• 1.5.0
• 1.4.2
• 1.3.1
• 1.2.2
• 1.1.0
• 1.0.3

Beta

This library is covered by the Pre-GA Offerings Terms of the Terms of Service. Pre-GA libraries might have limited support, and changes to pre-GA libraries might not be compatible with other pre-GA versions. For more information, see the launch stage descriptions.

Reference documentation and code samples for the Google Certificate Authority Service V1beta1 Client class Certificate.

A Certificate corresponds to a signed X.509 certificate issued by a CertificateAuthority.

Generated from protobuf message google.cloud.security.privateca.v1beta1.Certificate

Methods

__construct

Constructor.

Parameters
Name	Description
data	array Optional. Data for populating the Message object.
↳ name	string Output only. The resource path for this Certificate in the format projects/*/locations/*/certificateAuthorities/*/certificates/*.
↳ pem_csr	string Immutable. A pem-encoded X.509 certificate signing request (CSR).
↳ config	Google\Cloud\Security\PrivateCA\V1beta1\CertificateConfig Immutable. A description of the certificate and key that does not require X.509 or ASN.1.
↳ lifetime	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.
↳ revocation_details	Google\Cloud\Security\PrivateCA\V1beta1\Certificate\RevocationDetails Output only. Details regarding the revocation of this Certificate. This Certificate is considered revoked if and only if this field is present.
↳ pem_certificate	string Output only. The pem-encoded, signed X.509 certificate.
↳ certificate_description	Google\Cloud\Security\PrivateCA\V1beta1\CertificateDescription Output only. A structured description of the issued X.509 certificate.
↳ pem_certificate_chain	array 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.
↳ create_time	Google\Protobuf\Timestamp Output only. The time at which this Certificate was created.
↳ update_time	Google\Protobuf\Timestamp Output only. The time at which this Certificate was updated.
↳ labels	array|Google\Protobuf\Internal\MapField Optional. Labels with user-defined metadata.

getName

Output only. The resource path for this Certificate in the format projects/*/locations/*/certificateAuthorities/*/certificates/*.

Returns
Type	Description
string

setName

Output only. The resource path for this Certificate in the format projects/*/locations/*/certificateAuthorities/*/certificates/*.

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getPemCsr

Immutable. A pem-encoded X.509 certificate signing request (CSR).

Returns
Type	Description
string

hasPemCsr

setPemCsr

Immutable. A pem-encoded X.509 certificate signing request (CSR).

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getConfig

Immutable. A description of the certificate and key that does not require X.509 or ASN.1.

Returns
Type	Description
Google\Cloud\Security\PrivateCA\V1beta1\CertificateConfig|null

hasConfig

setConfig

Immutable. A description of the certificate and key that does not require X.509 or ASN.1.

Parameter
Name	Description
var	Google\Cloud\Security\PrivateCA\V1beta1\CertificateConfig

Returns
Type	Description
$this

getLifetime

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
Type	Description
Google\Protobuf\Duration|null

hasLifetime

clearLifetime

setLifetime

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.

Parameter
Name	Description
var	Google\Protobuf\Duration

Returns
Type	Description
$this

getRevocationDetails

Output only. Details regarding the revocation of this Certificate. This Certificate is considered revoked if and only if this field is present.

Returns
Type	Description
Google\Cloud\Security\PrivateCA\V1beta1\Certificate\RevocationDetails|null

hasRevocationDetails

clearRevocationDetails

setRevocationDetails

Output only. Details regarding the revocation of this Certificate. This Certificate is considered revoked if and only if this field is present.

Parameter
Name	Description
var	Google\Cloud\Security\PrivateCA\V1beta1\Certificate\RevocationDetails

Returns
Type	Description
$this

getPemCertificate

Output only. The pem-encoded, signed X.509 certificate.

Returns
Type	Description
string

setPemCertificate

Output only. The pem-encoded, signed X.509 certificate.

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getCertificateDescription

Output only. A structured description of the issued X.509 certificate.

Returns
Type	Description
Google\Cloud\Security\PrivateCA\V1beta1\CertificateDescription|null

hasCertificateDescription

clearCertificateDescription

setCertificateDescription

Output only. A structured description of the issued X.509 certificate.

Parameter
Name	Description
var	Google\Cloud\Security\PrivateCA\V1beta1\CertificateDescription

Returns
Type	Description
$this

getPemCertificateChain

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.

Returns
Type	Description
Google\Protobuf\Internal\RepeatedField

setPemCertificateChain

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.

Parameter
Name	Description
var	string[]

Returns
Type	Description
$this

getCreateTime

Output only. The time at which this Certificate was created.

Returns
Type	Description
Google\Protobuf\Timestamp|null

hasCreateTime

clearCreateTime

setCreateTime

Output only. The time at which this Certificate was created.

Parameter
Name	Description
var	Google\Protobuf\Timestamp

Returns
Type	Description
$this

getUpdateTime

Output only. The time at which this Certificate was updated.

Returns
Type	Description
Google\Protobuf\Timestamp|null

hasUpdateTime

clearUpdateTime

setUpdateTime

Output only. The time at which this Certificate was updated.

Parameter
Name	Description
var	Google\Protobuf\Timestamp

Returns
Type	Description
$this

getLabels

Optional. Labels with user-defined metadata.

Returns
Type	Description
Google\Protobuf\Internal\MapField

setLabels

Optional. Labels with user-defined metadata.

Parameter
Name	Description
var	array|Google\Protobuf\Internal\MapField

Returns
Type	Description
$this

getCertificateConfig

Returns
Type	Description
string