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

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

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ key_usage Google\Cloud\Security\PrivateCA\V1\KeyUsage

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

↳ ca_options Google\Cloud\Security\PrivateCA\V1\X509Parameters\CaOptions

Optional. Describes options in this [X509Parameters][google.cloud.security.privateca.v1.X509Parameters] that are relevant in a CA certificate.

↳ policy_ids array<Google\Cloud\Security\PrivateCA\V1\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 Google\Cloud\Security\PrivateCA\V1\X509Parameters\NameConstraints

Optional. Describes the X.509 name constraints extension.

↳ additional_extensions array<Google\Cloud\Security\PrivateCA\V1\X509Extension>

Optional. Describes custom X.509 extensions.

getKeyUsage

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

Returns
TypeDescription
Google\Cloud\Security\PrivateCA\V1\KeyUsage|null

hasKeyUsage

clearKeyUsage

setKeyUsage

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

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

getCaOptions

Optional. Describes options in this [X509Parameters][google.cloud.security.privateca.v1.X509Parameters] that are relevant in a CA certificate.

Returns
TypeDescription
Google\Cloud\Security\PrivateCA\V1\X509Parameters\CaOptions|null

hasCaOptions

clearCaOptions

setCaOptions

Optional. Describes options in this [X509Parameters][google.cloud.security.privateca.v1.X509Parameters] that are relevant in a CA certificate.

Parameter
NameDescription
var Google\Cloud\Security\PrivateCA\V1\X509Parameters\CaOptions
Returns
TypeDescription
$this

getPolicyIds

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

Returns
TypeDescription
Google\Protobuf\Internal\RepeatedField

setPolicyIds

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

Parameter
NameDescription
var array<Google\Cloud\Security\PrivateCA\V1\ObjectId>
Returns
TypeDescription
$this

getAiaOcspServers

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

Returns
TypeDescription
Google\Protobuf\Internal\RepeatedField

setAiaOcspServers

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

Parameter
NameDescription
var string[]
Returns
TypeDescription
$this

getNameConstraints

Optional. Describes the X.509 name constraints extension.

Returns
TypeDescription
Google\Cloud\Security\PrivateCA\V1\X509Parameters\NameConstraints|null

hasNameConstraints

clearNameConstraints

setNameConstraints

Optional. Describes the X.509 name constraints extension.

Parameter
NameDescription
var Google\Cloud\Security\PrivateCA\V1\X509Parameters\NameConstraints
Returns
TypeDescription
$this

getAdditionalExtensions

Optional. Describes custom X.509 extensions.

Returns
TypeDescription
Google\Protobuf\Internal\RepeatedField

setAdditionalExtensions

Optional. Describes custom X.509 extensions.

Parameter
NameDescription
var array<Google\Cloud\Security\PrivateCA\V1\X509Extension>
Returns
TypeDescription
$this