Google Certificate Authority Service V1 Client - Class KeyUsage (2.3.0)

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

A KeyUsage describes key usage values that may appear in an X.509 certificate.

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

Namespace

Google \ Cloud \ Security \ PrivateCA \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ base_key_usage KeyUsage\KeyUsageOptions

Describes high-level ways in which a key may be used.

↳ extended_key_usage KeyUsage\ExtendedKeyUsageOptions

Detailed scenarios in which a key may be used.

↳ unknown_extended_key_usages array<ObjectId>

Used to describe extended key usages that are not listed in the KeyUsage.ExtendedKeyUsageOptions message.

getBaseKeyUsage

Describes high-level ways in which a key may be used.

Returns
Type Description
KeyUsage\KeyUsageOptions|null

hasBaseKeyUsage

clearBaseKeyUsage

setBaseKeyUsage

Describes high-level ways in which a key may be used.

Parameter
Name Description
var KeyUsage\KeyUsageOptions
Returns
Type Description
$this

getExtendedKeyUsage

Detailed scenarios in which a key may be used.

Returns
Type Description
KeyUsage\ExtendedKeyUsageOptions|null

hasExtendedKeyUsage

clearExtendedKeyUsage

setExtendedKeyUsage

Detailed scenarios in which a key may be used.

Parameter
Name Description
var KeyUsage\ExtendedKeyUsageOptions
Returns
Type Description
$this

getUnknownExtendedKeyUsages

Used to describe extended key usages that are not listed in the KeyUsage.ExtendedKeyUsageOptions message.

Returns
Type Description
Google\Protobuf\RepeatedField<ObjectId>

setUnknownExtendedKeyUsages

Used to describe extended key usages that are not listed in the KeyUsage.ExtendedKeyUsageOptions message.

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