Instance

google.cloud.memcache.v1beta2. Instance

Represents an Instance.

Constructor

new Instance(propertiesopt)

Constructs a new Instance.

Parameters:
Name Type Attributes Description
properties google.cloud.memcache.v1beta2.IInstance <optional>

Properties to set
Implements:
  • IInstance

Classes

InstanceMessage
Node
NodeConfig

Members

(static) State :number

State enum.

Properties:
Name Type Description
STATE_UNSPECIFIED number

STATE_UNSPECIFIED value
CREATING number

CREATING value
READY number

READY value
DELETING number

DELETING value
PERFORMING_MAINTENANCE number

PERFORMING_MAINTENANCE value

authorizedNetwork :string

Instance authorizedNetwork.

createTime :google.protobuf.ITimestamp|null|undefined

Instance createTime.

discoveryEndpoint :string

Instance discoveryEndpoint.

displayName :string

Instance displayName.

instanceMessages :Array.<google.cloud.memcache.v1beta2.Instance.IInstanceMessage>

Instance instanceMessages.

labels :Object.<string, string>

Instance labels.

memcacheFullVersion :string

Instance memcacheFullVersion.

memcacheNodes :Array.<google.cloud.memcache.v1beta2.Instance.INode>

Instance memcacheNodes.

memcacheVersion :google.cloud.memcache.v1beta2.MemcacheVersion

Instance memcacheVersion.

name :string

Instance name.

nodeConfig :google.cloud.memcache.v1beta2.Instance.INodeConfig|null|undefined

Instance nodeConfig.

nodeCount :number

Instance nodeCount.

parameters :google.cloud.memcache.v1beta2.IMemcacheParameters|null|undefined

Instance parameters.

state :google.cloud.memcache.v1beta2.Instance.State

Instance state.

updateTime :google.protobuf.ITimestamp|null|undefined

Instance updateTime.

zones :Array.<string>

Instance zones.

Methods

(static) create(propertiesopt) → {google.cloud.memcache.v1beta2.Instance}

Creates a new Instance instance using the specified properties.

Parameters:
Name Type Attributes Description
properties google.cloud.memcache.v1beta2.IInstance <optional>

Properties to set

(static) decode(reader, lengthopt) → {google.cloud.memcache.v1beta2.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
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.memcache.v1beta2.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
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.memcache.v1beta2.IInstance

Instance message or plain object to encode
writer $protobuf.Writer <optional>

Writer to encode to

(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.memcache.v1beta2.IInstance

Instance message or plain object to encode
writer $protobuf.Writer <optional>

Writer to encode to

(static) fromObject(object) → {google.cloud.memcache.v1beta2.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

(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.memcache.v1beta2.Instance

Instance
options $protobuf.IConversionOptions <optional>

Conversion options

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

Verifies an Instance message.

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

Plain object to verify

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

Converts this Instance to JSON.