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

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

An [X509Parameters][google.cloud.security.privateca.v1.X509Parameters] is used to describe certain fields of an X.509 certificate, such as the key usage fields, fields specific to CA certificates, certificate policy extensions and custom extensions.

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

Namespace

Google \ Cloud \ Security \ PrivateCA \ V1

Methods

__construct

Constructor.

Parameters
Name
Description
data
array

Optional. Data for populating the Message object.

↳ key_usage
KeyUsage

Optional. Indicates the intended use for keys that correspond to a certificate.

↳ ca_options
X509Parameters\CaOptions

Optional. Describes options in this [X509Parameters][google.cloud.security.privateca.v1.X509Parameters] that are relevant in a CA certificate. If not specified, a default basic constraints extension with is_ca=false will be added for leaf certificates.

↳ policy_ids
array< ObjectId >

Optional. Describes the X.509 certificate policy object identifiers, per https://tools.ietf.org/html/rfc5280#section-4.2.1.4 .

↳ aia_ocsp_servers
array

Optional. Describes Online Certificate Status Protocol (OCSP) endpoint addresses that appear in the "Authority Information Access" extension in the certificate.

↳ name_constraints
X509Parameters\NameConstraints

Optional. Describes the X.509 name constraints extension.

↳ additional_extensions
array< X509Extension >

Optional. Describes custom X.509 extensions.

getKeyUsage

Optional. Indicates the intended use for keys that correspond to a certificate.

Returns
Type
Description
KeyUsage |null

hasKeyUsage

clearKeyUsage

setKeyUsage

Optional. Indicates the intended use for keys that correspond to a certificate.

Parameter
Name
Description
var
Returns
Type
Description
$this

getCaOptions

Optional. Describes options in this [X509Parameters][google.cloud.security.privateca.v1.X509Parameters] that are relevant in a CA certificate. If not specified, a default basic constraints extension with is_ca=false will be added for leaf certificates.

Returns
Type
Description

hasCaOptions

clearCaOptions

setCaOptions

Optional. Describes options in this [X509Parameters][google.cloud.security.privateca.v1.X509Parameters] that are relevant in a CA certificate. If not specified, a default basic constraints extension with is_ca=false will be added for leaf certificates.

Parameter
Name
Description
Returns
Type
Description
$this

getPolicyIds

Optional. Describes the X.509 certificate policy object identifiers, per https://tools.ietf.org/html/rfc5280#section-4.2.1.4 .

Returns
Type
Description

setPolicyIds

Optional. Describes the X.509 certificate policy object identifiers, per https://tools.ietf.org/html/rfc5280#section-4.2.1.4 .

Parameter
Name
Description
var
array< ObjectId >
Returns
Type
Description
$this

getAiaOcspServers

Optional. Describes Online Certificate Status Protocol (OCSP) endpoint addresses that appear in the "Authority Information Access" extension in the certificate.

Returns
Type
Description

setAiaOcspServers

Optional. Describes Online Certificate Status Protocol (OCSP) endpoint addresses that appear in the "Authority Information Access" extension in the certificate.

Parameter
Name
Description
var
string[]
Returns
Type
Description
$this

getNameConstraints

Optional. Describes the X.509 name constraints extension.

Returns
Type
Description

hasNameConstraints

clearNameConstraints

setNameConstraints

Optional. Describes the X.509 name constraints extension.

Parameter
Name
Description
Returns
Type
Description
$this

getAdditionalExtensions

Optional. Describes custom X.509 extensions.

Returns
Type
Description

setAdditionalExtensions

Optional. Describes custom X.509 extensions.

Parameter
Name
Description
var
array< X509Extension >
Returns
Type
Description
$this
Design a Mobile Site
View Site in Mobile | Classic
Share by: