Class protos.google.cloud.secretmanager.v1.Secret

Represents a Secret.

Package

@google-cloud/secret-manager

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.secretmanager.v1.ISecret);

Constructs a new Secret.

Parameter
NameDescription
properties ISecret

Properties to set

Properties

createTime

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

Secret createTime.

etag

public etag: string;

Secret etag.

expiration

public expiration?: ("expireTime"|"ttl");

Secret expiration.

expireTime

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

Secret expireTime.

labels

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

Secret labels.

name

public name: string;

Secret name.

replication

public replication?: (google.cloud.secretmanager.v1.IReplication|null);

Secret replication.

rotation

public rotation?: (google.cloud.secretmanager.v1.IRotation|null);

Secret rotation.

topics

public topics: google.cloud.secretmanager.v1.ITopic[];

Secret topics.

ttl

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

Secret ttl.

Methods

create(properties)

public static create(properties?: google.cloud.secretmanager.v1.ISecret): google.cloud.secretmanager.v1.Secret;

Creates a new Secret instance using the specified properties.

Parameter
NameDescription
properties ISecret

Properties to set

Returns
TypeDescription
google.cloud.secretmanager.v1.Secret

Secret instance

decode(reader, length)

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

Decodes a Secret message from the specified reader or buffer.

Parameters
NameDescription
reader ($protobuf.Reader|Uint8Array)

Reader or buffer to decode from

length number

Message length if known beforehand

Returns
TypeDescription
google.cloud.secretmanager.v1.Secret

Secret

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.secretmanager.v1.Secret;

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

Parameter
NameDescription
reader ($protobuf.Reader|Uint8Array)

Reader or buffer to decode from

Returns
TypeDescription
google.cloud.secretmanager.v1.Secret

Secret

encode(message, writer)

public static encode(message: google.cloud.secretmanager.v1.ISecret, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified Secret message. Does not implicitly messages.

Parameters
NameDescription
message ISecret

Secret message or plain object to encode

writer $protobuf.Writer

Writer to encode to

Returns
TypeDescription
$protobuf.Writer

Writer

encodeDelimited(message, writer)

public static encodeDelimited(message: google.cloud.secretmanager.v1.ISecret, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
NameDescription
message ISecret

Secret message or plain object to encode

writer $protobuf.Writer

Writer to encode to

Returns
TypeDescription
$protobuf.Writer

Writer

fromObject(object)

public static fromObject(object: { [k: string]: any }): google.cloud.secretmanager.v1.Secret;

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

Parameter
NameDescription
object { [k: string]: any }

Plain object

Returns
TypeDescription
google.cloud.secretmanager.v1.Secret

Secret

toJSON()

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

Converts this Secret to JSON.

Returns
TypeDescription
{ [k: string]: any }

JSON object

toObject(message, options)

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

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

Parameters
NameDescription
message google.cloud.secretmanager.v1.Secret

Secret

options $protobuf.IConversionOptions

Conversion options

Returns
TypeDescription
{ [k: string]: any }

Plain object

verify(message)

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

Verifies a Secret message.

Parameter
NameDescription
message { [k: string]: any }

Plain object to verify

Returns
TypeDescription
(string|null)

null if valid, otherwise the reason why it is not