Secret

google.cloud.secretmanager.v1. Secret

Represents a Secret.

Constructor

new Secret(propertiesopt)

Constructs a new Secret.

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

Properties to set

Implements:
  • ISecret

Members

createTime

Secret createTime.

etag

Secret etag.

expiration

Secret expiration.

expireTime

Secret expireTime.

labels

Secret labels.

name

Secret name.

replication

Secret replication.

rotation

Secret rotation.

topics

Secret topics.

ttl

Secret ttl.

versionAliases

Secret versionAliases.

Methods

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

Converts this Secret to JSON.

Returns:
Type Description
Object.<string, *>

JSON object

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

Creates a new Secret instance using the specified properties.

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

Properties to set

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

Secret instance

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

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

Secret

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.Secret}

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

Secret

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 Secret message. Does not implicitly verify messages.

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

Secret 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 Secret message, length delimited. Does not implicitly verify messages.

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

Secret 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.Secret}

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

Secret

(static) getTypeUrl(typeUrlPrefixopt) → {string}

Gets the default type url for Secret

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 Secret message. Also converts values to other types if specified.

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

Secret

options $protobuf.IConversionOptions <optional>

Conversion options

Returns:
Type Description
Object.<string, *>

Plain object

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

Verifies a Secret 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