Reference documentation and code samples for the Google Certificate Authority Service V1 Client class Certificate.
A Certificate corresponds to a signed X.509 certificate issued by a CertificateAuthority.
Generated from protobuf message google.cloud.security.privateca.v1.Certificate
Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ name |
string
Output only. The resource name for this Certificate in the format |
↳ pem_csr |
string
Immutable. A pem-encoded X.509 certificate signing request (CSR). |
↳ config |
Google\Cloud\Security\PrivateCA\V1\CertificateConfig
Immutable. A description of the certificate and key that does not require X.509 or ASN.1. |
↳ issuer_certificate_authority |
string
Output only. The resource name of the issuing CertificateAuthority in the format |
↳ 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. |
↳ certificate_template |
string
Immutable. The resource name for a CertificateTemplate used to issue this certificate, in the format |
↳ subject_mode |
int
Immutable. Specifies how the Certificate's identity fields are to be decided. If this is omitted, the |
↳ revocation_details |
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. |
↳ pem_certificate |
string
Output only. The pem-encoded, signed X.509 certificate. |
↳ certificate_description |
Google\Cloud\Security\PrivateCA\V1\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 name for this Certificate in the format
projects/*/locations/*/caPools/*/certificates/*.
| Returns | |
|---|---|
| Type | Description |
string | |
setName
Output only. The resource name for this Certificate in the format
projects/*/locations/*/caPools/*/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\V1\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\V1\CertificateConfig
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getIssuerCertificateAuthority
Output only. The resource name of the issuing CertificateAuthority in the format
projects/*/locations/*/caPools/*/certificateAuthorities/*.
| Returns | |
|---|---|
| Type | Description |
string | |
setIssuerCertificateAuthority
Output only. The resource name of the issuing CertificateAuthority in the format
projects/*/locations/*/caPools/*/certificateAuthorities/*.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| 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 | |
getCertificateTemplate
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 | |
|---|---|
| Type | Description |
string | |
setCertificateTemplate
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.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getSubjectMode
Immutable. Specifies how the Certificate's identity fields are to be decided.
If this is omitted, the DEFAULT subject mode will be used.
| Returns | |
|---|---|
| Type | Description |
int | |
setSubjectMode
Immutable. Specifies how the Certificate's identity fields are to be decided.
If this is omitted, the DEFAULT subject mode will be used.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| 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\V1\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\V1\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\V1\CertificateDescription|null | |
hasCertificateDescription
clearCertificateDescription
setCertificateDescription
Output only. A structured description of the issued X.509 certificate.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\Security\PrivateCA\V1\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 | |