Class protos.google.cloud.secretmanager.v1.SecretVersion

Represents a SecretVersion.

Package

@google-cloud/secret-manager

Constructors

(constructor)(properties)

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

Constructs a new SecretVersion.

Parameter
NameDescription
properties ISecretVersion

Properties to set

Properties

clientSpecifiedPayloadChecksum

public clientSpecifiedPayloadChecksum: boolean;

SecretVersion clientSpecifiedPayloadChecksum.

createTime

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

SecretVersion createTime.

destroyTime

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

SecretVersion destroyTime.

etag

public etag: string;

SecretVersion etag.

name

public name: string;

SecretVersion name.

replicationStatus

public replicationStatus?: (google.cloud.secretmanager.v1.IReplicationStatus|null);

SecretVersion replicationStatus.

state

public state: (google.cloud.secretmanager.v1.SecretVersion.State|keyof typeof google.cloud.secretmanager.v1.SecretVersion.State);

SecretVersion state.

Methods

create(properties)

public static create(properties?: google.cloud.secretmanager.v1.ISecretVersion): google.cloud.secretmanager.v1.SecretVersion;

Creates a new SecretVersion instance using the specified properties.

Parameter
NameDescription
properties ISecretVersion

Properties to set

Returns
TypeDescription
google.cloud.secretmanager.v1.SecretVersion

SecretVersion instance

decode(reader, length)

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

Decodes a SecretVersion 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.SecretVersion

SecretVersion

decodeDelimited(reader)

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

Decodes a SecretVersion 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.SecretVersion

SecretVersion

encode(message, writer)

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

Encodes the specified SecretVersion message. Does not implicitly messages.

Parameters
NameDescription
message ISecretVersion

SecretVersion 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.ISecretVersion, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
NameDescription
message ISecretVersion

SecretVersion 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.SecretVersion;

Creates a SecretVersion 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.SecretVersion

SecretVersion

toJSON()

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

Converts this SecretVersion to JSON.

Returns
TypeDescription
{ [k: string]: any }

JSON object

toObject(message, options)

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

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

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

SecretVersion

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 SecretVersion 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