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
Namespace
Google \ Cloud \ Security \ PrivateCA \ V1Methods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ name
string
Identifier. The resource name for this CertificateAuthority
in the format projects/*/locations/*/caPools/*/certificateAuthorities/*
.
↳ type
↳ config
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
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
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
↳ state
↳ 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< 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 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.
↳ access_urls
CertificateAuthority\AccessUrls
Output only. URLs for accessing content published by this CA, such as the CA certificate and CRLs.
↳ create_time
↳ 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
↳ user_defined_access_urls
CertificateAuthority\UserDefinedAccessUrls
Optional. User-defined URLs for CA certificate and CRLs. The service does not publish content to these URLs. It is up to the user to mirror content to these URLs.
↳ satisfies_pzs
bool
Output only. Reserved for future use.
↳ satisfies_pzi
bool
Output only. Reserved for future use.
getName
Identifier. The resource name for this CertificateAuthority
in the format projects/*/locations/*/caPools/*/certificateAuthorities/*
.
string
setName
Identifier. The resource name for this CertificateAuthority
in the format projects/*/locations/*/caPools/*/certificateAuthorities/*
.
var
string
$this
getType
Required. Immutable. The Type of this CertificateAuthority .
int
setType
Required. Immutable. The Type of this CertificateAuthority .
var
int
$this
getConfig
Required. Immutable. The config used to create a self-signed X.509 certificate or CSR.
hasConfig
clearConfig
setConfig
Required. Immutable. The config used to create a self-signed X.509 certificate or CSR.
$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.
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.
$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.
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.
$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.
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.
$this
getTier
Output only. The CaPool.Tier of the CaPool that includes this CertificateAuthority .
int
setTier
Output only. The CaPool.Tier of the CaPool that includes this CertificateAuthority .
var
int
$this
getState
Output only. The State for this CertificateAuthority .
int
setState
Output only. The State for this CertificateAuthority .
var
int
$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.
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.
var
string[]
$this
getCaCertificateDescriptions
Output only. A structured description of this CertificateAuthority 's CA certificate and its issuers. Ordered as self-to-root.
setCaCertificateDescriptions
Output only. A structured description of this CertificateAuthority 's CA certificate and its issuers. Ordered as self-to-root.
$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.
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.
var
string
$this
getAccessUrls
Output only. URLs for accessing content published by this CA, such as the CA certificate and CRLs.
hasAccessUrls
clearAccessUrls
setAccessUrls
Output only. URLs for accessing content published by this CA, such as the CA certificate and CRLs.
$this
getCreateTime
Output only. The time at which this CertificateAuthority was created.
hasCreateTime
clearCreateTime
setCreateTime
Output only. The time at which this CertificateAuthority was created.
$this
getUpdateTime
Output only. The time at which this CertificateAuthority was last updated.
hasUpdateTime
clearUpdateTime
setUpdateTime
Output only. The time at which this CertificateAuthority was last updated.
$this
getDeleteTime
Output only. The time at which this CertificateAuthority was soft deleted, if it is in the DELETED state.
hasDeleteTime
clearDeleteTime
setDeleteTime
Output only. The time at which this CertificateAuthority was soft deleted, if it is in the DELETED state.
$this
getExpireTime
Output only. The time at which this CertificateAuthority will be permanently purged, if it is in the DELETED state.
hasExpireTime
clearExpireTime
setExpireTime
Output only. The time at which this CertificateAuthority will be permanently purged, if it is in the DELETED state.
$this
getLabels
Optional. Labels with user-defined metadata.
setLabels
Optional. Labels with user-defined metadata.
$this
getUserDefinedAccessUrls
Optional. User-defined URLs for CA certificate and CRLs. The service does not publish content to these URLs. It is up to the user to mirror content to these URLs.
hasUserDefinedAccessUrls
clearUserDefinedAccessUrls
setUserDefinedAccessUrls
Optional. User-defined URLs for CA certificate and CRLs. The service does not publish content to these URLs. It is up to the user to mirror content to these URLs.
$this
getSatisfiesPzs
Output only. Reserved for future use.
bool
setSatisfiesPzs
Output only. Reserved for future use.
var
bool
$this
getSatisfiesPzi
Output only. Reserved for future use.
bool
setSatisfiesPzi
Output only. Reserved for future use.
var
bool
$this
