Class protos.google.bigtable.admin.v2.ListClustersResponse (3.6.0)

Version 3.6.0

• 5.0.0 (latest)
• 4.6.1
• 4.1.0
• 4.0.5
• 3.10.0
• 3.9.4
• 3.8.0
• 3.7.0
• 3.6.0
• 3.5.4

Represents a ListClustersResponse.

Package

@google-cloud/bigtable!

Constructors

(constructor)(properties)

constructor(properties?: google.bigtable.admin.v2.IListClustersResponse);

Constructs a new ListClustersResponse.

Parameter

Name	Description
properties	IListClustersResponse Properties to set

Properties

clusters

public clusters: google.bigtable.admin.v2.ICluster[];

ListClustersResponse clusters.

Property Value

Type	Description
google.bigtable.admin.v2.ICluster[]

failedLocations

public failedLocations: string[];

ListClustersResponse failedLocations.

Property Value

Type	Description
string[]

nextPageToken

public nextPageToken: string;

ListClustersResponse nextPageToken.

Property Value

Type	Description
string

Methods

create(properties)

public static create(properties?: google.bigtable.admin.v2.IListClustersResponse): google.bigtable.admin.v2.ListClustersResponse;

Creates a new ListClustersResponse instance using the specified properties.

Parameter

Name	Description
properties	IListClustersResponse Properties to set

Returns

Type	Description
google.bigtable.admin.v2.ListClustersResponse	ListClustersResponse instance

decode(reader, length)

public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.bigtable.admin.v2.ListClustersResponse;

Decodes a ListClustersResponse 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.bigtable.admin.v2.ListClustersResponse	ListClustersResponse

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.bigtable.admin.v2.ListClustersResponse;

Decodes a ListClustersResponse 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.bigtable.admin.v2.ListClustersResponse	ListClustersResponse

encode(message, writer)

public static encode(message: google.bigtable.admin.v2.IListClustersResponse, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified ListClustersResponse message. Does not implicitly messages.

Parameters

Name	Description
message	IListClustersResponse ListClustersResponse 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.bigtable.admin.v2.IListClustersResponse, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters

Name	Description
message	IListClustersResponse ListClustersResponse 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.bigtable.admin.v2.ListClustersResponse;

Creates a ListClustersResponse 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.bigtable.admin.v2.ListClustersResponse	ListClustersResponse

toJSON()

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

Converts this ListClustersResponse to JSON.

Returns

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

toObject(message, options)

public static toObject(message: google.bigtable.admin.v2.ListClustersResponse, options?: $protobuf.IConversionOptions): { [k: string]: any };

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

Parameters

Name	Description
message	google.bigtable.admin.v2.ListClustersResponse ListClustersResponse
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 ListClustersResponse 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