Class protos.google.cloud.security.privateca.v1.CertificateAuthority (5.2.0)

Represents a CertificateAuthority.

Package

Constructors

(constructor)(properties)

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

Constructs a new CertificateAuthority.

Parameter
Name	Description
`properties`	`ICertificateAuthority` Properties to set

Properties

accessUrls

public accessUrls?: (google.cloud.security.privateca.v1.CertificateAuthority.IAccessUrls|null);

CertificateAuthority accessUrls.

caCertificateDescriptions

public caCertificateDescriptions: google.cloud.security.privateca.v1.ICertificateDescription[];

CertificateAuthority caCertificateDescriptions.

config

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

CertificateAuthority config.

createTime

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

CertificateAuthority createTime.

deleteTime

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

CertificateAuthority deleteTime.

expireTime

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

CertificateAuthority expireTime.

gcsBucket

public gcsBucket: string;

CertificateAuthority gcsBucket.

keySpec

public keySpec?: (google.cloud.security.privateca.v1.CertificateAuthority.IKeyVersionSpec|null);

CertificateAuthority keySpec.

labels

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

CertificateAuthority labels.

lifetime

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

CertificateAuthority lifetime.

name

public name: string;

CertificateAuthority name.

pemCaCertificates

public pemCaCertificates: string[];

CertificateAuthority pemCaCertificates.

state

public state: (google.cloud.security.privateca.v1.CertificateAuthority.State|keyof typeof google.cloud.security.privateca.v1.CertificateAuthority.State);

CertificateAuthority state.

subordinateConfig

public subordinateConfig?: (google.cloud.security.privateca.v1.ISubordinateConfig|null);

CertificateAuthority subordinateConfig.

tier

public tier: (google.cloud.security.privateca.v1.CaPool.Tier|keyof typeof google.cloud.security.privateca.v1.CaPool.Tier);

CertificateAuthority tier.

type

public type: (google.cloud.security.privateca.v1.CertificateAuthority.Type|keyof typeof google.cloud.security.privateca.v1.CertificateAuthority.Type);

CertificateAuthority type.

updateTime

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

CertificateAuthority updateTime.

Methods

create(properties)

public static create(properties?: google.cloud.security.privateca.v1.ICertificateAuthority): google.cloud.security.privateca.v1.CertificateAuthority;

Creates a new CertificateAuthority instance using the specified properties.

Parameter
Name	Description
`properties`	`ICertificateAuthority` Properties to set

Returns
Type	Description
`CertificateAuthority`	CertificateAuthority instance

decode(reader, length)

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

Decodes a CertificateAuthority message from the specified reader or buffer.

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

Returns
Type	Description
`CertificateAuthority`	CertificateAuthority

decodeDelimited(reader)

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

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

Parameter
Name	Description
`reader`	`(Reader\|Uint8Array)` Reader or buffer to decode from

Returns
Type	Description
`CertificateAuthority`	CertificateAuthority

encode(message, writer)

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

Encodes the specified CertificateAuthority message. Does not implicitly messages.

Parameters
Name	Description
`message`	`ICertificateAuthority` CertificateAuthority 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.ICertificateAuthority, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
Name	Description
`message`	`ICertificateAuthority` CertificateAuthority 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.CertificateAuthority;

Creates a CertificateAuthority 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
`CertificateAuthority`	CertificateAuthority

getTypeUrl(typeUrlPrefix)

public static getTypeUrl(typeUrlPrefix?: string): string;

Gets the default type url for CertificateAuthority

Parameter
Name	Description
`typeUrlPrefix`	`string` your custom typeUrlPrefix(default "type.googleapis.com")

Returns
Type	Description
`string`	The default type url

toJSON()

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

Converts this CertificateAuthority to JSON.

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

toObject(message, options)

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

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

Parameters
Name	Description
`message`	`CertificateAuthority` CertificateAuthority
`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 CertificateAuthority 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