Cloud KMS V1 Client - Class Certificate (1.16.4)

Reference documentation and code samples for the Cloud KMS V1 Client class Certificate.

A Certificate represents an X.509 certificate used to authenticate HTTPS connections to EKM replicas.

Generated from protobuf message google.cloud.kms.v1.Certificate

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ raw_der string

Required. The raw certificate bytes in DER format.

↳ parsed bool

Output only. True if the certificate was parsed successfully.

↳ issuer string

Output only. The issuer distinguished name in RFC 2253 format. Only present if parsed is true.

↳ subject string

Output only. The subject distinguished name in RFC 2253 format. Only present if parsed is true.

↳ subject_alternative_dns_names array

Output only. The subject Alternative DNS names. Only present if parsed is true.

↳ not_before_time Google\Protobuf\Timestamp

Output only. The certificate is not valid before this time. Only present if parsed is true.

↳ not_after_time Google\Protobuf\Timestamp

Output only. The certificate is not valid after this time. Only present if parsed is true.

↳ serial_number string

Output only. The certificate serial number as a hex string. Only present if parsed is true.

↳ sha256_fingerprint string

Output only. The SHA-256 certificate fingerprint as a hex string. Only present if parsed is true.

getRawDer

Required. The raw certificate bytes in DER format.

Returns
TypeDescription
string

setRawDer

Required. The raw certificate bytes in DER format.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getParsed

Output only. True if the certificate was parsed successfully.

Returns
TypeDescription
bool

setParsed

Output only. True if the certificate was parsed successfully.

Parameter
NameDescription
var bool
Returns
TypeDescription
$this

getIssuer

Output only. The issuer distinguished name in RFC 2253 format. Only present if parsed is true.

Returns
TypeDescription
string

setIssuer

Output only. The issuer distinguished name in RFC 2253 format. Only present if parsed is true.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getSubject

Output only. The subject distinguished name in RFC 2253 format. Only present if parsed is true.

Returns
TypeDescription
string

setSubject

Output only. The subject distinguished name in RFC 2253 format. Only present if parsed is true.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getSubjectAlternativeDnsNames

Output only. The subject Alternative DNS names. Only present if parsed is true.

Returns
TypeDescription
Google\Protobuf\Internal\RepeatedField

setSubjectAlternativeDnsNames

Output only. The subject Alternative DNS names. Only present if parsed is true.

Parameter
NameDescription
var string[]
Returns
TypeDescription
$this

getNotBeforeTime

Output only. The certificate is not valid before this time. Only present if parsed is true.

Returns
TypeDescription
Google\Protobuf\Timestamp|null

hasNotBeforeTime

clearNotBeforeTime

setNotBeforeTime

Output only. The certificate is not valid before this time. Only present if parsed is true.

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

getNotAfterTime

Output only. The certificate is not valid after this time. Only present if parsed is true.

Returns
TypeDescription
Google\Protobuf\Timestamp|null

hasNotAfterTime

clearNotAfterTime

setNotAfterTime

Output only. The certificate is not valid after this time. Only present if parsed is true.

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

getSerialNumber

Output only. The certificate serial number as a hex string. Only present if parsed is true.

Returns
TypeDescription
string

setSerialNumber

Output only. The certificate serial number as a hex string. Only present if parsed is true.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getSha256Fingerprint

Output only. The SHA-256 certificate fingerprint as a hex string. Only present if parsed is true.

Returns
TypeDescription
string

setSha256Fingerprint

Output only. The SHA-256 certificate fingerprint as a hex string. Only present if parsed is true.

Parameter
NameDescription
var string
Returns
TypeDescription
$this