SecretVersion

google.cloud.secretmanager.v1. SecretVersion

Represents a SecretVersion.

Constructor

new SecretVersion(propertiesopt)

Constructs a new SecretVersion.

Parameters:
Name Type Attributes Description
properties google.cloud.secretmanager.v1.ISecretVersion <optional>

Properties to set

Implements:
  • ISecretVersion

Members

clientSpecifiedPayloadChecksum

SecretVersion clientSpecifiedPayloadChecksum.

createTime

SecretVersion createTime.

customerManagedEncryption

SecretVersion customerManagedEncryption.

destroyTime

SecretVersion destroyTime.

etag

SecretVersion etag.

name

SecretVersion name.

replicationStatus

SecretVersion replicationStatus.

scheduledDestroyTime

SecretVersion scheduledDestroyTime.

state

SecretVersion state.

State

State enum.

Properties:
Name Type Description
STATE_UNSPECIFIED number

STATE_UNSPECIFIED value

ENABLED number

ENABLED value

DISABLED number

DISABLED value

DESTROYED number

DESTROYED value

Methods

toJSON() → {Object.<string, *>}

Converts this SecretVersion to JSON.

Returns:
Type Description
Object.<string, *>

JSON object

(static) create(propertiesopt) → {google.cloud.secretmanager.v1.SecretVersion}

Creates a new SecretVersion instance using the specified properties.

Parameters:
Name Type Attributes Description
properties google.cloud.secretmanager.v1.ISecretVersion <optional>

Properties to set

Returns:
Type Description
google.cloud.secretmanager.v1.SecretVersion

SecretVersion instance

(static) decode(reader, lengthopt) → {google.cloud.secretmanager.v1.SecretVersion}

Decodes a SecretVersion message from the specified reader or buffer.

Parameters:
Name Type Attributes Description
reader $protobuf.Reader | Uint8Array

Reader or buffer to decode from

length number <optional>

Message length if known beforehand

Returns:
Type Description
google.cloud.secretmanager.v1.SecretVersion

SecretVersion

Throws:
  • If the payload is not a reader or valid buffer

    Type
    Error
  • If required fields are missing

    Type
    $protobuf.util.ProtocolError

(static) decodeDelimited(reader) → {google.cloud.secretmanager.v1.SecretVersion}

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

Parameters:
Name Type Description
reader $protobuf.Reader | Uint8Array

Reader or buffer to decode from

Returns:
Type Description
google.cloud.secretmanager.v1.SecretVersion

SecretVersion

Throws:
  • If the payload is not a reader or valid buffer

    Type
    Error
  • If required fields are missing

    Type
    $protobuf.util.ProtocolError

(static) encode(message, writeropt) → {$protobuf.Writer}

Encodes the specified SecretVersion message. Does not implicitly verify messages.

Parameters:
Name Type Attributes Description
message google.cloud.secretmanager.v1.ISecretVersion

SecretVersion message or plain object to encode

writer $protobuf.Writer <optional>

Writer to encode to

Returns:
Type Description
$protobuf.Writer

Writer

(static) encodeDelimited(message, writeropt) → {$protobuf.Writer}

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

Parameters:
Name Type Attributes Description
message google.cloud.secretmanager.v1.ISecretVersion

SecretVersion message or plain object to encode

writer $protobuf.Writer <optional>

Writer to encode to

Returns:
Type Description
$protobuf.Writer

Writer

(static) fromObject(object) → {google.cloud.secretmanager.v1.SecretVersion}

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

Parameters:
Name Type Description
object Object.<string, *>

Plain object

Returns:
Type Description
google.cloud.secretmanager.v1.SecretVersion

SecretVersion

(static) getTypeUrl(typeUrlPrefixopt) → {string}

Gets the default type url for SecretVersion

Parameters:
Name Type Attributes Description
typeUrlPrefix string <optional>

your custom typeUrlPrefix(default "type.googleapis.com")

Returns:
Type Description
string

The default type url

(static) toObject(message, optionsopt) → {Object.<string, *>}

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

Parameters:
Name Type Attributes Description
message google.cloud.secretmanager.v1.SecretVersion

SecretVersion

options $protobuf.IConversionOptions <optional>

Conversion options

Returns:
Type Description
Object.<string, *>

Plain object

(static) verify(message) → {string|null}

Verifies a SecretVersion message.

Parameters:
Name Type Description
message Object.<string, *>

Plain object to verify

Returns:
Type Description
string | null

null if valid, otherwise the reason why it is not