Instance

google.cloud.memcache.v1. Instance

Represents an Instance.

Constructor

new Instance(propertiesopt)

Constructs a new Instance.

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

Properties to set

Implements:
  • IInstance

Classes

InstanceMessage
Node
NodeConfig

Members

authorizedNetwork

Instance authorizedNetwork.

createTime

Instance createTime.

discoveryEndpoint

Instance discoveryEndpoint.

displayName

Instance displayName.

instanceMessages

Instance instanceMessages.

labels

Instance labels.

maintenancePolicy

Instance maintenancePolicy.

maintenanceSchedule

Instance maintenanceSchedule.

memcacheFullVersion

Instance memcacheFullVersion.

memcacheNodes

Instance memcacheNodes.

memcacheVersion

Instance memcacheVersion.

name

Instance name.

nodeConfig

Instance nodeConfig.

nodeCount

Instance nodeCount.

parameters

Instance parameters.

state

Instance state.

updateTime

Instance updateTime.

zones

Instance zones.

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

PERFORMING_MAINTENANCE number

PERFORMING_MAINTENANCE value

Methods

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

Converts this Instance to JSON.

Returns:
Type Description
Object.<string, *>

JSON object

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

Creates a new Instance instance using the specified properties.

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

Properties to set

Returns:
Type Description
google.cloud.memcache.v1.Instance

Instance instance

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