Reference documentation and code samples for the Google Certificate Authority Service V1 Client class CertificateAuthority.
A CertificateAuthority represents an individual Certificate Authority. A CertificateAuthority can be used to create Certificates.
Generated from protobuf message google.cloud.security.privateca.v1.CertificateAuthority
Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ name |
string
Output only. The resource name for this CertificateAuthority in the format |
↳ type |
int
Required. Immutable. The Type of this CertificateAuthority. |
↳ config |
Google\Cloud\Security\PrivateCA\V1\CertificateConfig
Required. Immutable. The config used to create a self-signed X.509 certificate or CSR. |
↳ lifetime |
Google\Protobuf\Duration
Required. Immutable. The desired lifetime of the CA certificate. Used to create the "not_before_time" and "not_after_time" fields inside an X.509 certificate. |
↳ key_spec |
Google\Cloud\Security\PrivateCA\V1\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. |
↳ subordinate_config |
Google\Cloud\Security\PrivateCA\V1\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 |
int
Output only. The CaPool.Tier of the CaPool that includes this CertificateAuthority. |
↳ state |
int
Output only. The State for this CertificateAuthority. |
↳ pem_ca_certificates |
array
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. |
↳ ca_certificate_descriptions |
array<Google\Cloud\Security\PrivateCA\V1\CertificateDescription>
Output only. A structured description of this CertificateAuthority's CA certificate and its issuers. Ordered as self-to-root. |
↳ gcs_bucket |
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 |
↳ access_urls |
Google\Cloud\Security\PrivateCA\V1\CertificateAuthority\AccessUrls
Output only. URLs for accessing content published by this CA, such as the CA certificate and CRLs. |
↳ create_time |
Google\Protobuf\Timestamp
Output only. The time at which this CertificateAuthority was created. |
↳ update_time |
Google\Protobuf\Timestamp
Output only. The time at which this CertificateAuthority was last updated. |
↳ delete_time |
Google\Protobuf\Timestamp
Output only. The time at which this CertificateAuthority was soft deleted, if it is in the DELETED state. |
↳ expire_time |
Google\Protobuf\Timestamp
Output only. The time at which this CertificateAuthority will be permanently purged, if it is in the DELETED state. |
↳ labels |
array|Google\Protobuf\Internal\MapField
Optional. Labels with user-defined metadata. |
getName
Output only. The resource name for this
CertificateAuthority
in the format projects/*/locations/*/caPools/*/certificateAuthorities/*.
| Returns | |
|---|---|
| Type | Description |
string | |
setName
Output only. The resource name for this
CertificateAuthority
in the format projects/*/locations/*/caPools/*/certificateAuthorities/*.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getType
Required. Immutable. The Type of this CertificateAuthority.
| Returns | |
|---|---|
| Type | Description |
int | |
setType
Required. Immutable. The Type of this CertificateAuthority.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getConfig
Required. Immutable. The config used to create a self-signed X.509 certificate or CSR.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Security\PrivateCA\V1\CertificateConfig|null | |
hasConfig
clearConfig
setConfig
Required. Immutable. The config used to create a self-signed X.509 certificate or CSR.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\Security\PrivateCA\V1\CertificateConfig
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getLifetime
Required. Immutable. 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 | |
|---|---|
| Type | Description |
Google\Protobuf\Duration|null | |
hasLifetime
clearLifetime
setLifetime
Required. Immutable. The desired lifetime of the CA certificate. Used to create the "not_before_time" and "not_after_time" fields inside an X.509 certificate.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Duration
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getKeySpec
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 | |
|---|---|
| Type | Description |
Google\Cloud\Security\PrivateCA\V1\CertificateAuthority\KeyVersionSpec|null | |
hasKeySpec
clearKeySpec
setKeySpec
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.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\Security\PrivateCA\V1\CertificateAuthority\KeyVersionSpec
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getSubordinateConfig
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 | |
|---|---|
| Type | Description |
Google\Cloud\Security\PrivateCA\V1\SubordinateConfig|null | |
hasSubordinateConfig
clearSubordinateConfig
setSubordinateConfig
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.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\Security\PrivateCA\V1\SubordinateConfig
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getTier
Output only. The CaPool.Tier of the CaPool that includes this CertificateAuthority.
| Returns | |
|---|---|
| Type | Description |
int | |
setTier
Output only. The CaPool.Tier of the CaPool that includes this CertificateAuthority.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getState
Output only. The State for this CertificateAuthority.
| Returns | |
|---|---|
| Type | Description |
int | |
setState
Output only. The State for this CertificateAuthority.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getPemCaCertificates
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.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField | |
setPemCaCertificates
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.
| Parameter | |
|---|---|
| Name | Description |
var |
string[]
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getCaCertificateDescriptions
Output only. A structured description of this CertificateAuthority's CA certificate and its issuers. Ordered as self-to-root.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField | |
setCaCertificateDescriptions
Output only. A structured description of this CertificateAuthority's CA certificate and its issuers. Ordered as self-to-root.
| Parameter | |
|---|---|
| Name | Description |
var |
array<Google\Cloud\Security\PrivateCA\V1\CertificateDescription>
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getGcsBucket
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 named my-bucket, you
would simply specify my-bucket. If not specified, a managed bucket will
be created.
| Returns | |
|---|---|
| Type | Description |
string | |
setGcsBucket
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 named my-bucket, you
would simply specify my-bucket. If not specified, a managed bucket will
be created.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getAccessUrls
Output only. URLs for accessing content published by this CA, such as the CA certificate and CRLs.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Security\PrivateCA\V1\CertificateAuthority\AccessUrls|null | |
hasAccessUrls
clearAccessUrls
setAccessUrls
Output only. URLs for accessing content published by this CA, such as the CA certificate and CRLs.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\Security\PrivateCA\V1\CertificateAuthority\AccessUrls
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getCreateTime
Output only. The time at which this CertificateAuthority was created.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null | |
hasCreateTime
clearCreateTime
setCreateTime
Output only. The time at which this CertificateAuthority was created.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getUpdateTime
Output only. The time at which this CertificateAuthority was last updated.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null | |
hasUpdateTime
clearUpdateTime
setUpdateTime
Output only. The time at which this CertificateAuthority was last updated.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getDeleteTime
Output only. The time at which this CertificateAuthority was soft deleted, if it is in the DELETED state.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null | |
hasDeleteTime
clearDeleteTime
setDeleteTime
Output only. The time at which this CertificateAuthority was soft deleted, if it is in the DELETED state.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getExpireTime
Output only. The time at which this CertificateAuthority will be permanently purged, if it is in the DELETED state.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null | |
hasExpireTime
clearExpireTime
setExpireTime
Output only. The time at which this CertificateAuthority will be permanently purged, if it is in the DELETED state.
| 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 | |