Google Certificate Authority Service V1 Client - Class CaOptions (2.1.1)

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

Describes the X.509 basic constraints extension, per RFC 5280 section 4.2.1.9

Generated from protobuf message google.cloud.security.privateca.v1.X509Parameters.CaOptions

Namespace

Google \ Cloud \ Security \ PrivateCA \ V1 \ X509Parameters

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ is_ca bool

Optional. Refers to the "CA" boolean field in the X.509 extension. When this value is missing, the basic constraints extension will be omitted from the certificate.

↳ max_issuer_path_length int

Optional. Refers to the path length constraint field in the X.509 extension. For a CA certificate, this value describes the depth of subordinate CA certificates that are allowed. If this value is less than 0, the request will fail. If this value is missing, the max path length will be omitted from the certificate.

getIsCa

Optional. Refers to the "CA" boolean field in the X.509 extension.

When this value is missing, the basic constraints extension will be omitted from the certificate.

Returns
Type Description
bool

hasIsCa

clearIsCa

setIsCa

Optional. Refers to the "CA" boolean field in the X.509 extension.

When this value is missing, the basic constraints extension will be omitted from the certificate.

Parameter
Name Description
var bool
Returns
Type Description
$this

getMaxIssuerPathLength

Optional. Refers to the path length constraint field in the X.509 extension. For a CA certificate, this value describes the depth of subordinate CA certificates that are allowed. If this value is less than 0, the request will fail. If this value is missing, the max path length will be omitted from the certificate.

Returns
Type Description
int

hasMaxIssuerPathLength

clearMaxIssuerPathLength

setMaxIssuerPathLength

Optional. Refers to the path length constraint field in the X.509 extension. For a CA certificate, this value describes the depth of subordinate CA certificates that are allowed. If this value is less than 0, the request will fail. If this value is missing, the max path length will be omitted from the certificate.

Parameter
Name Description
var int
Returns
Type Description
$this