Google Certificate Authority Service V1beta1 Client - Class SubjectDescription (1.0.3)

Reference documentation and code samples for the Google Certificate Authority Service V1beta1 Client class SubjectDescription.

These values describe fields in an issued X.509 certificate such as the distinguished name, subject alternative names, serial number, and lifetime.

Generated from protobuf message google.cloud.security.privateca.v1beta1.CertificateDescription.SubjectDescription

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ subject Google\Cloud\Security\PrivateCA\V1beta1\Subject

Contains distinguished name fields such as the location and organization.

↳ common_name string

The "common name" of the distinguished name.

↳ subject_alt_name Google\Cloud\Security\PrivateCA\V1beta1\SubjectAltNames

The subject alternative name fields.

↳ hex_serial_number string

The serial number encoded in lowercase hexadecimal.

↳ lifetime Google\Protobuf\Duration

For convenience, the actual lifetime of an issued certificate. Corresponds to 'not_after_time' - 'not_before_time'.

↳ not_before_time Google\Protobuf\Timestamp

The time at which the certificate becomes valid.

↳ not_after_time Google\Protobuf\Timestamp

The time at which the certificate expires.

getSubject

Contains distinguished name fields such as the location and organization.

Returns
TypeDescription
Google\Cloud\Security\PrivateCA\V1beta1\Subject|null

hasSubject

clearSubject

setSubject

Contains distinguished name fields such as the location and organization.

Parameter
NameDescription
var Google\Cloud\Security\PrivateCA\V1beta1\Subject
Returns
TypeDescription
$this

getCommonName

The "common name" of the distinguished name.

Returns
TypeDescription
string

setCommonName

The "common name" of the distinguished name.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getSubjectAltName

The subject alternative name fields.

Returns
TypeDescription
Google\Cloud\Security\PrivateCA\V1beta1\SubjectAltNames|null

hasSubjectAltName

clearSubjectAltName

setSubjectAltName

The subject alternative name fields.

Parameter
NameDescription
var Google\Cloud\Security\PrivateCA\V1beta1\SubjectAltNames
Returns
TypeDescription
$this

getHexSerialNumber

The serial number encoded in lowercase hexadecimal.

Returns
TypeDescription
string

setHexSerialNumber

The serial number encoded in lowercase hexadecimal.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getLifetime

For convenience, the actual lifetime of an issued certificate.

Corresponds to 'not_after_time' - 'not_before_time'.

Returns
TypeDescription
Google\Protobuf\Duration|null

hasLifetime

clearLifetime

setLifetime

For convenience, the actual lifetime of an issued certificate.

Corresponds to 'not_after_time' - 'not_before_time'.

Parameter
NameDescription
var Google\Protobuf\Duration
Returns
TypeDescription
$this

getNotBeforeTime

The time at which the certificate becomes valid.

Returns
TypeDescription
Google\Protobuf\Timestamp|null

hasNotBeforeTime

clearNotBeforeTime

setNotBeforeTime

The time at which the certificate becomes valid.

Parameter
NameDescription
var Google\Protobuf\Timestamp
Returns
TypeDescription
$this

getNotAfterTime

The time at which the certificate expires.

Returns
TypeDescription
Google\Protobuf\Timestamp|null

hasNotAfterTime

clearNotAfterTime

setNotAfterTime

The time at which the certificate expires.

Parameter
NameDescription
var Google\Protobuf\Timestamp
Returns
TypeDescription
$this