# Google Certificate Authority Service V1 Client - Class CertificateDescription (2.4.0)

2.4.0 (latest) 2.3.0 2.2.2 2.1.1 2.0.3 1.7.3 1.5.0 1.4.2 1.3.1 1.2.2 1.1.0 1.0.3 Reference documentation and code samples for the Google Certificate Authority Service V1 Client class CertificateDescription.

A
[CertificateDescription](https://docs.cloud.google.com/php/docs/reference/cloud-security-private-ca/latest/V1.CertificateDescription)
describes an X.509 certificate or CSR that has been issued, as an alternative
to using ASN.1 / X.509.

Generated from protobuf message `google.cloud.security.privateca.v1.CertificateDescription`

## Namespace

Google \\ Cloud \\ Security \\ PrivateCA \\ V1

## Methods

### __construct

Constructor.

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `data` | `array` Optional. Data for populating the Message object. |
| `↳ subject_description` | `https://docs.cloud.google.com/php/docs/reference/cloud-security-private-ca/latest/V1.CertificateDescription.SubjectDescription` Describes some of the values in a certificate that are related to the subject and lifetime. |
| `↳ x509_description` | `https://docs.cloud.google.com/php/docs/reference/cloud-security-private-ca/latest/V1.X509Parameters` Describes some of the technical X.509 fields in a certificate. |
| `↳ public_key` | `https://docs.cloud.google.com/php/docs/reference/cloud-security-private-ca/latest/V1.PublicKey` The public key that corresponds to an issued certificate. |
| `↳ subject_key_id` | `https://docs.cloud.google.com/php/docs/reference/cloud-security-private-ca/latest/V1.CertificateDescription.KeyId` Provides a means of identifiying certificates that contain a particular public key, per <https://tools.ietf.org/html/rfc5280#section-4.2.1.2>. |
| `↳ authority_key_id` | `https://docs.cloud.google.com/php/docs/reference/cloud-security-private-ca/latest/V1.CertificateDescription.KeyId` Identifies the subject_key_id of the parent certificate, per <https://tools.ietf.org/html/rfc5280#section-4.2.1.1> |
| `↳ crl_distribution_points` | `string[]` Describes a list of locations to obtain CRL information, i.e. the DistributionPoint.fullName described by <https://tools.ietf.org/html/rfc5280#section-4.2.1.13> |
| `↳ aia_issuing_certificate_urls` | `string[]` Describes lists of issuer CA certificate URLs that appear in the "Authority Information Access" extension in the certificate. |
| `↳ cert_fingerprint` | `https://docs.cloud.google.com/php/docs/reference/cloud-security-private-ca/latest/V1.CertificateDescription.CertificateFingerprint` The hash of the x.509 certificate. |
| `↳ tbs_certificate_digest` | `string` The hash of the pre-signed certificate, which will be signed by the CA. Corresponds to the TBS Certificate in <https://tools.ietf.org/html/rfc5280#section-4.1.2>. The field will always be populated. |

### getSubjectDescription

Describes some of the values in a certificate that are related to the
subject and lifetime.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/php/docs/reference/cloud-security-private-ca/latest/V1.CertificateDescription.SubjectDescription|null` |   |

### hasSubjectDescription

### clearSubjectDescription

### setSubjectDescription

Describes some of the values in a certificate that are related to the
subject and lifetime.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `https://docs.cloud.google.com/php/docs/reference/cloud-security-private-ca/latest/V1.CertificateDescription.SubjectDescription` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getX509Description

Describes some of the technical X.509 fields in a certificate.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/php/docs/reference/cloud-security-private-ca/latest/V1.X509Parameters|null` |   |

### hasX509Description

### clearX509Description

### setX509Description

Describes some of the technical X.509 fields in a certificate.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `https://docs.cloud.google.com/php/docs/reference/cloud-security-private-ca/latest/V1.X509Parameters` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getPublicKey

The public key that corresponds to an issued certificate.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/php/docs/reference/cloud-security-private-ca/latest/V1.PublicKey|null` |   |

### hasPublicKey

### clearPublicKey

### setPublicKey

The public key that corresponds to an issued certificate.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `https://docs.cloud.google.com/php/docs/reference/cloud-security-private-ca/latest/V1.PublicKey` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getSubjectKeyId

Provides a means of identifiying certificates that contain a particular
public key, per <https://tools.ietf.org/html/rfc5280#section-4.2.1.2>.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/php/docs/reference/cloud-security-private-ca/latest/V1.CertificateDescription.KeyId|null` |   |

### hasSubjectKeyId

### clearSubjectKeyId

### setSubjectKeyId

Provides a means of identifiying certificates that contain a particular
public key, per <https://tools.ietf.org/html/rfc5280#section-4.2.1.2>.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `https://docs.cloud.google.com/php/docs/reference/cloud-security-private-ca/latest/V1.CertificateDescription.KeyId` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getAuthorityKeyId

Identifies the subject_key_id of the parent certificate, per
<https://tools.ietf.org/html/rfc5280#section-4.2.1.1>

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/php/docs/reference/cloud-security-private-ca/latest/V1.CertificateDescription.KeyId|null` |   |

### hasAuthorityKeyId

### clearAuthorityKeyId

### setAuthorityKeyId

Identifies the subject_key_id of the parent certificate, per
<https://tools.ietf.org/html/rfc5280#section-4.2.1.1>

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `https://docs.cloud.google.com/php/docs/reference/cloud-security-private-ca/latest/V1.CertificateDescription.KeyId` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getCrlDistributionPoints

Describes a list of locations to obtain CRL information, i.e.

the DistributionPoint.fullName described by
<https://tools.ietf.org/html/rfc5280#section-4.2.1.13>

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://protobuf.dev/reference/php/api-docs/Google/Protobuf/RepeatedField<string>` |   |

### setCrlDistributionPoints

Describes a list of locations to obtain CRL information, i.e.

the DistributionPoint.fullName described by
<https://tools.ietf.org/html/rfc5280#section-4.2.1.13>

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `string[]` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getAiaIssuingCertificateUrls

Describes lists of issuer CA certificate URLs that appear in the
"Authority Information Access" extension in the certificate.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://protobuf.dev/reference/php/api-docs/Google/Protobuf/RepeatedField<string>` |   |

### setAiaIssuingCertificateUrls

Describes lists of issuer CA certificate URLs that appear in the
"Authority Information Access" extension in the certificate.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `string[]` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getCertFingerprint

The hash of the x.509 certificate.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/php/docs/reference/cloud-security-private-ca/latest/V1.CertificateDescription.CertificateFingerprint|null` |   |

### hasCertFingerprint

### clearCertFingerprint

### setCertFingerprint

The hash of the x.509 certificate.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `https://docs.cloud.google.com/php/docs/reference/cloud-security-private-ca/latest/V1.CertificateDescription.CertificateFingerprint` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getTbsCertificateDigest

The hash of the pre-signed certificate, which will be signed by the CA.

Corresponds to the TBS Certificate in
<https://tools.ietf.org/html/rfc5280#section-4.1.2>. The field will always be
populated.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `string` |   |

### setTbsCertificateDigest

The hash of the pre-signed certificate, which will be signed by the CA.

Corresponds to the TBS Certificate in
<https://tools.ietf.org/html/rfc5280#section-4.1.2>. The field will always be
populated.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `string` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |