Instance

google.cloud.redis.v1beta1. Instance

Represents an Instance.

Constructor

new Instance(propertiesopt)

Constructs a new Instance.

Parameters:
Name Type Attributes Description
properties google.cloud.redis.v1beta1.IInstance <optional>

Properties to set

Implements:
  • IInstance

Members

ConnectMode

ConnectMode enum.

Properties:
Name Type Description
CONNECT_MODE_UNSPECIFIED number

CONNECT_MODE_UNSPECIFIED value

DIRECT_PEERING number

DIRECT_PEERING value

PRIVATE_SERVICE_ACCESS number

PRIVATE_SERVICE_ACCESS value

State

State enum.

Properties:
Name Type Description
STATE_UNSPECIFIED number

STATE_UNSPECIFIED value

CREATING number

CREATING value

READY number

READY value

UPDATING number

UPDATING value

DELETING number

DELETING value

REPAIRING number

REPAIRING value

MAINTENANCE number

MAINTENANCE value

IMPORTING number

IMPORTING value

FAILING_OVER number

FAILING_OVER value

Tier

Tier enum.

Properties:
Name Type Description
TIER_UNSPECIFIED number

TIER_UNSPECIFIED value

BASIC number

BASIC value

STANDARD_HA number

STANDARD_HA value

alternativeLocationId

Instance alternativeLocationId.

authorizedNetwork

Instance authorizedNetwork.

connectMode

Instance connectMode.

createTime

Instance createTime.

currentLocationId

Instance currentLocationId.

displayName

Instance displayName.

host

Instance host.

labels

Instance labels.

locationId

Instance locationId.

memorySizeGb

Instance memorySizeGb.

name

Instance name.

persistenceIamIdentity

Instance persistenceIamIdentity.

port

Instance port.

redisConfigs

Instance redisConfigs.

redisVersion

Instance redisVersion.

reservedIpRange

Instance reservedIpRange.

state

Instance state.

statusMessage

Instance statusMessage.

tier

Instance tier.

Methods

(static) create(propertiesopt) → {google.cloud.redis.v1beta1.Instance}

Creates a new Instance instance using the specified properties.

Parameters:
Name Type Attributes Description
properties google.cloud.redis.v1beta1.IInstance <optional>

Properties to set

Returns:
Type Description
google.cloud.redis.v1beta1.Instance

Instance instance

(static) decode(reader, lengthopt) → {google.cloud.redis.v1beta1.Instance}

Decodes an Instance 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.v1beta1.Instance

Instance

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.v1beta1.Instance}

Decodes an Instance 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.v1beta1.Instance

Instance

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

Parameters:
Name Type Attributes Description
message google.cloud.redis.v1beta1.IInstance

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

Parameters:
Name Type Attributes Description
message google.cloud.redis.v1beta1.IInstance

Instance 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.v1beta1.Instance}

Creates an Instance 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.v1beta1.Instance

Instance

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

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

Parameters:
Name Type Attributes Description
message google.cloud.redis.v1beta1.Instance

Instance

options $protobuf.IConversionOptions <optional>

Conversion options

Returns:
Type Description
Object.<string, *>

Plain object

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

Verifies an Instance 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

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

Converts this Instance to JSON.

Returns:
Type Description
Object.<string, *>

JSON object