Instance

google.cloud.redis.v1. Instance

Represents an Instance.

Constructor

new Instance(propertiesopt)

Constructs a new Instance.

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

Properties to set
Implements:
  • IInstance

Members

alternativeLocationId

Instance alternativeLocationId.

authEnabled

Instance authEnabled.

authorizedNetwork

Instance authorizedNetwork.

availableMaintenanceVersions

Instance availableMaintenanceVersions.

connectMode

Instance connectMode.

createTime

Instance createTime.

currentLocationId

Instance currentLocationId.

customerManagedKey

Instance customerManagedKey.

displayName

Instance displayName.

host

Instance host.

labels

Instance labels.

locationId

Instance locationId.

maintenancePolicy

Instance maintenancePolicy.

maintenanceSchedule

Instance maintenanceSchedule.

maintenanceVersion

Instance maintenanceVersion.

memorySizeGb

Instance memorySizeGb.

name

Instance name.

nodes

Instance nodes.

persistenceConfig

Instance persistenceConfig.

persistenceIamIdentity

Instance persistenceIamIdentity.

port

Instance port.

readEndpoint

Instance readEndpoint.

readEndpointPort

Instance readEndpointPort.

readReplicasMode

Instance readReplicasMode.

redisConfigs

Instance redisConfigs.

redisVersion

Instance redisVersion.

replicaCount

Instance replicaCount.

reservedIpRange

Instance reservedIpRange.

secondaryIpRange

Instance secondaryIpRange.

serverCaCerts

Instance serverCaCerts.

state

Instance state.

statusMessage

Instance statusMessage.

suspensionReasons

Instance suspensionReasons.

tier

Instance tier.

transitEncryptionMode

Instance transitEncryptionMode.

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

ReadReplicasMode

ReadReplicasMode enum.

Properties:
Name Type Description
READ_REPLICAS_MODE_UNSPECIFIED number

READ_REPLICAS_MODE_UNSPECIFIED value
READ_REPLICAS_DISABLED number

READ_REPLICAS_DISABLED value
READ_REPLICAS_ENABLED number

READ_REPLICAS_ENABLED 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

SuspensionReason

SuspensionReason enum.

Properties:
Name Type Description
SUSPENSION_REASON_UNSPECIFIED number

SUSPENSION_REASON_UNSPECIFIED value
CUSTOMER_MANAGED_KEY_ISSUE number

CUSTOMER_MANAGED_KEY_ISSUE value

Tier

Tier enum.

Properties:
Name Type Description
TIER_UNSPECIFIED number

TIER_UNSPECIFIED value
BASIC number

BASIC value
STANDARD_HA number

STANDARD_HA value

TransitEncryptionMode

TransitEncryptionMode enum.

Properties:
Name Type Description
TRANSIT_ENCRYPTION_MODE_UNSPECIFIED number

TRANSIT_ENCRYPTION_MODE_UNSPECIFIED value
SERVER_AUTHENTICATION number

SERVER_AUTHENTICATION value
DISABLED number

DISABLED value

Methods

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

Converts this Instance to JSON.

Returns:
Type Description
Object.<string, *>

JSON object

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

Creates a new Instance instance using the specified properties.

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

Properties to set
Returns:
Type Description
google.cloud.redis.v1.Instance

Instance instance

(static) decode(reader, lengthopt) → {google.cloud.redis.v1.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.v1.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.v1.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.v1.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.v1.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.v1.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.v1.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.v1.Instance

Instance

(static) getTypeUrl(typeUrlPrefixopt) → {string}

Gets the default type url for Instance

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

Parameters:
Name Type Attributes Description
message google.cloud.redis.v1.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