Google Certificate Authority Service V1 Client - Class CaPool (1.0.3)

Reference documentation and code samples for the Google Certificate Authority Service V1 Client class CaPool.

A CaPool represents a group of CertificateAuthorities that form a trust anchor. A CaPool can be used to manage issuance policies for one or more CertificateAuthority resources and to rotate CA certificates in and out of the trust anchor.

Generated from protobuf message google.cloud.security.privateca.v1.CaPool

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ name string

Output only. The resource name for this CaPool in the format projects/*/locations/*/caPools/*.

↳ tier int

Required. Immutable. The Tier of this CaPool.

↳ issuance_policy Google\Cloud\Security\PrivateCA\V1\CaPool\IssuancePolicy

Optional. The IssuancePolicy to control how Certificates will be issued from this CaPool.

↳ publishing_options Google\Cloud\Security\PrivateCA\V1\CaPool\PublishingOptions

Optional. The PublishingOptions to follow when issuing Certificates from any CertificateAuthority in this CaPool.

↳ labels array|Google\Protobuf\Internal\MapField

Optional. Labels with user-defined metadata.

getName

Output only. The resource name for this CaPool in the format projects/*/locations/*/caPools/*.

Returns
TypeDescription
string

setName

Output only. The resource name for this CaPool in the format projects/*/locations/*/caPools/*.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getTier

Required. Immutable. The Tier of this CaPool.

Returns
TypeDescription
int

setTier

Required. Immutable. The Tier of this CaPool.

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getIssuancePolicy

Optional. The IssuancePolicy to control how Certificates will be issued from this CaPool.

Returns
TypeDescription
Google\Cloud\Security\PrivateCA\V1\CaPool\IssuancePolicy|null

hasIssuancePolicy

clearIssuancePolicy

setIssuancePolicy

Optional. The IssuancePolicy to control how Certificates will be issued from this CaPool.

Parameter
NameDescription
var Google\Cloud\Security\PrivateCA\V1\CaPool\IssuancePolicy
Returns
TypeDescription
$this

getPublishingOptions

Optional. The PublishingOptions to follow when issuing Certificates from any CertificateAuthority in this CaPool.

Returns
TypeDescription
Google\Cloud\Security\PrivateCA\V1\CaPool\PublishingOptions|null

hasPublishingOptions

clearPublishingOptions

setPublishingOptions

Optional. The PublishingOptions to follow when issuing Certificates from any CertificateAuthority in this CaPool.

Parameter
NameDescription
var Google\Cloud\Security\PrivateCA\V1\CaPool\PublishingOptions
Returns
TypeDescription
$this

getLabels

Optional. Labels with user-defined metadata.

Returns
TypeDescription
Google\Protobuf\Internal\MapField

setLabels

Optional. Labels with user-defined metadata.

Parameter
NameDescription
var array|Google\Protobuf\Internal\MapField
Returns
TypeDescription
$this