PersistenceConfig

google.cloud.redis.v1. PersistenceConfig

Represents a PersistenceConfig.

Constructor

new PersistenceConfig(propertiesopt)

Constructs a new PersistenceConfig.

Parameters:
Name Type Attributes Description
properties google.cloud.redis.v1.IPersistenceConfig <optional>

Properties to set

Implements:
  • IPersistenceConfig

Members

persistenceMode

PersistenceConfig persistenceMode.

rdbNextSnapshotTime

PersistenceConfig rdbNextSnapshotTime.

rdbSnapshotPeriod

PersistenceConfig rdbSnapshotPeriod.

rdbSnapshotStartTime

PersistenceConfig rdbSnapshotStartTime.

PersistenceMode

PersistenceMode enum.

Properties:
Name Type Description
PERSISTENCE_MODE_UNSPECIFIED number

PERSISTENCE_MODE_UNSPECIFIED value

DISABLED number

DISABLED value

RDB number

RDB value

SnapshotPeriod

SnapshotPeriod enum.

Properties:
Name Type Description
SNAPSHOT_PERIOD_UNSPECIFIED number

SNAPSHOT_PERIOD_UNSPECIFIED value

ONE_HOUR number

ONE_HOUR value

SIX_HOURS number

SIX_HOURS value

TWELVE_HOURS number

TWELVE_HOURS value

TWENTY_FOUR_HOURS number

TWENTY_FOUR_HOURS value

Methods

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

Converts this PersistenceConfig to JSON.

Returns:
Type Description
Object.<string, *>

JSON object

(static) create(propertiesopt) → {google.cloud.redis.v1.PersistenceConfig}

Creates a new PersistenceConfig instance using the specified properties.

Parameters:
Name Type Attributes Description
properties google.cloud.redis.v1.IPersistenceConfig <optional>

Properties to set

Returns:
Type Description
google.cloud.redis.v1.PersistenceConfig

PersistenceConfig instance

(static) decode(reader, lengthopt) → {google.cloud.redis.v1.PersistenceConfig}

Decodes a PersistenceConfig 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.redis.v1.PersistenceConfig

PersistenceConfig

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.redis.v1.PersistenceConfig}

Decodes a PersistenceConfig 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.redis.v1.PersistenceConfig

PersistenceConfig

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

Parameters:
Name Type Attributes Description
message google.cloud.redis.v1.IPersistenceConfig

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

Parameters:
Name Type Attributes Description
message google.cloud.redis.v1.IPersistenceConfig

PersistenceConfig 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.redis.v1.PersistenceConfig}

Creates a PersistenceConfig 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.redis.v1.PersistenceConfig

PersistenceConfig

(static) getTypeUrl(typeUrlPrefixopt) → {string}

Gets the default type url for PersistenceConfig

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

Parameters:
Name Type Attributes Description
message google.cloud.redis.v1.PersistenceConfig

PersistenceConfig

options $protobuf.IConversionOptions <optional>

Conversion options

Returns:
Type Description
Object.<string, *>

Plain object

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

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