Class protos.google.cloud.memcache.v1.Instance.Node (1.5.1)

Represents a Node.

Package

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.memcache.v1.Instance.INode);

Constructs a new Node.

Parameter

Name	Description
properties	`INode` Properties to set

Properties

host

public host: string;

Node host.

nodeId

public nodeId: string;

Node nodeId.

parameters

public parameters?: (google.cloud.memcache.v1.IMemcacheParameters|null);

Node parameters.

port

public port: number;

Node port.

state

public state: (google.cloud.memcache.v1.Instance.Node.State|keyof typeof google.cloud.memcache.v1.Instance.Node.State);

Node state.

zone

public zone: string;

Node zone.

Methods

create(properties)

public static create(properties?: google.cloud.memcache.v1.Instance.INode): google.cloud.memcache.v1.Instance.Node;

Creates a new Node instance using the specified properties.

Parameter

Name	Description
properties	`INode` Properties to set

Returns

Type	Description
google.cloud.memcache.v1.Instance.Node	Node instance

decode(reader, length)

public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.memcache.v1.Instance.Node;

Decodes a Node message from the specified reader or buffer.

Parameters

Name	Description
reader	`($protobuf.Reader\|Uint8Array)` Reader or buffer to decode from
length	`number` Message length if known beforehand

Returns

Type	Description
google.cloud.memcache.v1.Instance.Node	Node

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.memcache.v1.Instance.Node;

Decodes a Node message from the specified reader or buffer, length delimited.

Parameter

Name	Description
reader	`($protobuf.Reader\|Uint8Array)` Reader or buffer to decode from

Returns

Type	Description
google.cloud.memcache.v1.Instance.Node	Node

encode(message, writer)

public static encode(message: google.cloud.memcache.v1.Instance.INode, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified Node message. Does not implicitly messages.

Parameters

Name	Description
message	`INode` Node message or plain object to encode
writer	`$protobuf.Writer` Writer to encode to

Returns

Type	Description
$protobuf.Writer	Writer

encodeDelimited(message, writer)

public static encodeDelimited(message: google.cloud.memcache.v1.Instance.INode, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified Node message, length delimited. Does not implicitly messages.

Parameters

Name	Description
message	`INode` Node message or plain object to encode
writer	`$protobuf.Writer` Writer to encode to

Returns

Type	Description
$protobuf.Writer	Writer

fromObject(object)

public static fromObject(object: { [k: string]: any }): google.cloud.memcache.v1.Instance.Node;

Creates a Node message from a plain object. Also converts values to their respective internal types.

Parameter

Name	Description
object	`{ [k: string]: any }` Plain object

Returns

Type	Description
google.cloud.memcache.v1.Instance.Node	Node

toJSON()

public toJSON(): { [k: string]: any };

Converts this Node to JSON.

Returns

Type	Description
{ [k: string]: any }	JSON object

toObject(message, options)

public static toObject(message: google.cloud.memcache.v1.Instance.Node, options?: $protobuf.IConversionOptions): { [k: string]: any };

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

Parameters

Name	Description
message	`google.cloud.memcache.v1.Instance.Node` Node
options	`$protobuf.IConversionOptions` Conversion options

Returns

Type	Description
{ [k: string]: any }	Plain object

verify(message)

public static verify(message: { [k: string]: any }): (string|null);

Verifies a Node message.

Parameter

Name	Description
message	`{ [k: string]: any }` Plain object to verify

Returns

Type	Description
(string\|null)	`null` if valid, otherwise the reason why it is not