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

Version 1.7.1

• 1.7.3 (latest)
• 1.7.2
• 1.5.0
• 1.4.2
• 1.3.1
• 1.2.2
• 1.1.0
• 1.0.3

Beta

This library is covered by the Pre-GA Offerings Terms of the Terms of Service. Pre-GA libraries might have limited support, and changes to pre-GA libraries might not be compatible with other pre-GA versions. For more information, see the launch stage descriptions.

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

Namespace

Google \ Cloud \ Security \ PrivateCA \ V1beta1 \ CertificateDescription

Methods

__construct

Constructor.

Parameters
Name	Description
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
Type	Description
Google\Cloud\Security\PrivateCA\V1beta1\Subject|null

hasSubject

clearSubject

setSubject

Contains distinguished name fields such as the location and organization.

Parameter
Name	Description
var	Google\Cloud\Security\PrivateCA\V1beta1\Subject

Returns
Type	Description
$this

getCommonName

The "common name" of the distinguished name.

Returns
Type	Description
string

setCommonName

The "common name" of the distinguished name.

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getSubjectAltName

The subject alternative name fields.

Returns
Type	Description
Google\Cloud\Security\PrivateCA\V1beta1\SubjectAltNames|null

hasSubjectAltName

clearSubjectAltName

setSubjectAltName

The subject alternative name fields.

Parameter
Name	Description
var	Google\Cloud\Security\PrivateCA\V1beta1\SubjectAltNames

Returns
Type	Description
$this

getHexSerialNumber

The serial number encoded in lowercase hexadecimal.

Returns
Type	Description
string

setHexSerialNumber

The serial number encoded in lowercase hexadecimal.

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getLifetime

For convenience, the actual lifetime of an issued certificate.

Corresponds to 'not_after_time' - 'not_before_time'.

Returns
Type	Description
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
Name	Description
var	Google\Protobuf\Duration

Returns
Type	Description
$this

getNotBeforeTime

The time at which the certificate becomes valid.

Returns
Type	Description
Google\Protobuf\Timestamp|null

hasNotBeforeTime

clearNotBeforeTime

setNotBeforeTime

The time at which the certificate becomes valid.

Parameter
Name	Description
var	Google\Protobuf\Timestamp

Returns
Type	Description
$this

getNotAfterTime

The time at which the certificate expires.

Returns
Type	Description
Google\Protobuf\Timestamp|null

hasNotAfterTime

clearNotAfterTime

setNotAfterTime

The time at which the certificate expires.

Parameter
Name	Description
var	Google\Protobuf\Timestamp

Returns
Type	Description
$this