Class protos.google.cloud.security.privateca.v1.Certificate (3.1.0)

Represents a Certificate.

Package

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.security.privateca.v1.ICertificate);

Constructs a new Certificate.

Parameter

Name	Description
properties	`ICertificate` Properties to set

Properties

certificateConfig

public certificateConfig?: ("pemCsr"|"config");

Certificate certificateConfig.

certificateDescription

public certificateDescription?: (google.cloud.security.privateca.v1.ICertificateDescription|null);

Certificate certificateDescription.

certificateTemplate

public certificateTemplate: string;

Certificate certificateTemplate.

config

public config?: (google.cloud.security.privateca.v1.ICertificateConfig|null);

Certificate config.

createTime

public createTime?: (google.protobuf.ITimestamp|null);

Certificate createTime.

issuerCertificateAuthority

public issuerCertificateAuthority: string;

Certificate issuerCertificateAuthority.

labels

public labels: { [k: string]: string };

Certificate labels.

lifetime

public lifetime?: (google.protobuf.IDuration|null);

Certificate lifetime.

name

public name: string;

Certificate name.

pemCertificate

public pemCertificate: string;

Certificate pemCertificate.

pemCertificateChain

public pemCertificateChain: string[];

Certificate pemCertificateChain.

pemCsr

public pemCsr?: (string|null);

Certificate pemCsr.

revocationDetails

public revocationDetails?: (google.cloud.security.privateca.v1.Certificate.IRevocationDetails|null);

Certificate revocationDetails.

subjectMode

public subjectMode: (google.cloud.security.privateca.v1.SubjectRequestMode|keyof typeof google.cloud.security.privateca.v1.SubjectRequestMode);

Certificate subjectMode.

updateTime

public updateTime?: (google.protobuf.ITimestamp|null);

Certificate updateTime.

Methods

create(properties)

public static create(properties?: google.cloud.security.privateca.v1.ICertificate): google.cloud.security.privateca.v1.Certificate;

Creates a new Certificate instance using the specified properties.

Parameter

Name	Description
properties	`ICertificate` Properties to set

Returns

Type	Description
google.cloud.security.privateca.v1.Certificate	Certificate instance

decode(reader, length)

public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.security.privateca.v1.Certificate;

Decodes a Certificate message from the specified reader or buffer.

Parameters

Name	Description
reader	`($protobuf.Reader\|Uint8Array)` Reader or buffer to decode from
length	`number` Message length if known beforehand

Returns

Type	Description
google.cloud.security.privateca.v1.Certificate	Certificate

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.security.privateca.v1.Certificate;

Decodes a Certificate message from the specified reader or buffer, length delimited.

Parameter

Name	Description
reader	`($protobuf.Reader\|Uint8Array)` Reader or buffer to decode from

Returns

Type	Description
google.cloud.security.privateca.v1.Certificate	Certificate

encode(message, writer)

public static encode(message: google.cloud.security.privateca.v1.ICertificate, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified Certificate message. Does not implicitly messages.

Parameters

Name	Description
message	`ICertificate` Certificate message or plain object to encode
writer	`$protobuf.Writer` Writer to encode to

Returns

Type	Description
$protobuf.Writer	Writer

encodeDelimited(message, writer)

public static encodeDelimited(message: google.cloud.security.privateca.v1.ICertificate, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified Certificate message, length delimited. Does not implicitly messages.

Parameters

Name	Description
message	`ICertificate` Certificate message or plain object to encode
writer	`$protobuf.Writer` Writer to encode to

Returns

Type	Description
$protobuf.Writer	Writer

fromObject(object)

public static fromObject(object: { [k: string]: any }): google.cloud.security.privateca.v1.Certificate;

Creates a Certificate message from a plain object. Also converts values to their respective internal types.

Parameter

Name	Description
object	`{ [k: string]: any }` Plain object

Returns

Type	Description
google.cloud.security.privateca.v1.Certificate	Certificate

toJSON()

public toJSON(): { [k: string]: any };

Converts this Certificate to JSON.

Returns

Type	Description
{ [k: string]: any }	JSON object

toObject(message, options)

public static toObject(message: google.cloud.security.privateca.v1.Certificate, options?: $protobuf.IConversionOptions): { [k: string]: any };

Creates a plain object from a Certificate message. Also converts values to other types if specified.

Parameters

Name	Description
message	`google.cloud.security.privateca.v1.Certificate` Certificate
options	`$protobuf.IConversionOptions` Conversion options

Returns

Type	Description
{ [k: string]: any }	Plain object

verify(message)

public static verify(message: { [k: string]: any }): (string|null);

Verifies a Certificate message.

Parameter

Name	Description
message	`{ [k: string]: any }` Plain object to verify

Returns

Type	Description
(string\|null)	`null` if valid, otherwise the reason why it is not