Google Certificate Authority Service V1beta1 Client - Class CertificateAuthority (1.5.0)

Version 1.5.0

• 2.0.0 (latest)
• 2.0.0-RC1
• 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 CertificateAuthority.

A CertificateAuthority represents an individual Certificate Authority.

A CertificateAuthority can be used to create Certificates.

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

Namespace

Google \ Cloud \ Security \ PrivateCA \ V1beta1

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 projects/*/locations/*/certificateAuthorities/*.
↳ type	int Required. Immutable. The Type of this CertificateAuthority.
↳ tier	int Required. Immutable. The Tier of this CertificateAuthority.
↳ config	Google\Cloud\Security\PrivateCA\V1beta1\CertificateConfig Required. Immutable. The config used to create a self-signed X.509 certificate or CSR.
↳ lifetime	Google\Protobuf\Duration Required. 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\V1beta1\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.
↳ certificate_policy	Google\Cloud\Security\PrivateCA\V1beta1\CertificateAuthority\CertificateAuthorityPolicy Optional. The CertificateAuthorityPolicy to enforce when issuing Certificates from this CertificateAuthority.
↳ issuing_options	Google\Cloud\Security\PrivateCA\V1beta1\CertificateAuthority\IssuingOptions Optional. The IssuingOptions to follow when issuing Certificates from this CertificateAuthority.
↳ subordinate_config	Google\Cloud\Security\PrivateCA\V1beta1\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.
↳ 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\V1beta1\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	Google\Cloud\Security\PrivateCA\V1beta1\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 updated.
↳ delete_time	Google\Protobuf\Timestamp Output only. The time at which this CertificateAuthority will be deleted, if scheduled for deletion.
↳ 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/*/certificateAuthorities/*.

Returns
Type	Description
string

setName

Output only. The resource name for this CertificateAuthority in the format projects/*/locations/*/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

getTier

Required. Immutable. The Tier of this CertificateAuthority.

Returns
Type	Description
int

setTier

Required. Immutable. The Tier 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\V1beta1\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\V1beta1\CertificateConfig

Returns
Type	Description
$this

getLifetime

Required. 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. 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\V1beta1\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\V1beta1\CertificateAuthority\KeyVersionSpec

Returns
Type	Description
$this

getCertificatePolicy

Optional. The CertificateAuthorityPolicy to enforce when issuing Certificates from this CertificateAuthority.

Returns
Type	Description
Google\Cloud\Security\PrivateCA\V1beta1\CertificateAuthority\CertificateAuthorityPolicy|null

hasCertificatePolicy

clearCertificatePolicy

setCertificatePolicy

Optional. The CertificateAuthorityPolicy to enforce when issuing Certificates from this CertificateAuthority.

Parameter
Name	Description
var	Google\Cloud\Security\PrivateCA\V1beta1\CertificateAuthority\CertificateAuthorityPolicy

Returns
Type	Description
$this

getIssuingOptions

Optional. The IssuingOptions to follow when issuing Certificates from this CertificateAuthority.

Returns
Type	Description
Google\Cloud\Security\PrivateCA\V1beta1\CertificateAuthority\IssuingOptions|null

hasIssuingOptions

clearIssuingOptions

setIssuingOptions

Optional. The IssuingOptions to follow when issuing Certificates from this CertificateAuthority.

Parameter
Name	Description
var	Google\Cloud\Security\PrivateCA\V1beta1\CertificateAuthority\IssuingOptions

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\V1beta1\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\V1beta1\SubordinateConfig

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\V1beta1\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\V1beta1\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\V1beta1\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 updated.

Returns
Type	Description
Google\Protobuf\Timestamp|null

hasUpdateTime

clearUpdateTime

setUpdateTime

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

Parameter
Name	Description
var	Google\Protobuf\Timestamp

Returns
Type	Description
$this

getDeleteTime

Output only. The time at which this CertificateAuthority will be deleted, if scheduled for deletion.

Returns
Type	Description
Google\Protobuf\Timestamp|null

hasDeleteTime

clearDeleteTime

setDeleteTime

Output only. The time at which this CertificateAuthority will be deleted, if scheduled for deletion.

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