Class protos.google.cloud.compute.v1.ListNodeGroupsRequest (3.0.0)

Represents a ListNodeGroupsRequest.

Package

@google-cloud/compute

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.compute.v1.IListNodeGroupsRequest);

Constructs a new ListNodeGroupsRequest.

Parameter
Name Description
properties google.cloud.compute.v1.IListNodeGroupsRequest

Properties to set

Properties

_filter

public _filter?: "filter";

ListNodeGroupsRequest _filter.

_maxResults

public _maxResults?: "maxResults";

ListNodeGroupsRequest _maxResults.

_orderBy

public _orderBy?: "orderBy";

ListNodeGroupsRequest _orderBy.

_pageToken

public _pageToken?: "pageToken";

ListNodeGroupsRequest _pageToken.

_returnPartialSuccess

public _returnPartialSuccess?: "returnPartialSuccess";

ListNodeGroupsRequest _returnPartialSuccess.

filter

public filter?: (string|null);

ListNodeGroupsRequest filter.

maxResults

public maxResults?: (number|null);

ListNodeGroupsRequest maxResults.

orderBy

public orderBy?: (string|null);

ListNodeGroupsRequest orderBy.

pageToken

public pageToken?: (string|null);

ListNodeGroupsRequest pageToken.

project

public project: string;

ListNodeGroupsRequest project.

returnPartialSuccess

public returnPartialSuccess?: (boolean|null);

ListNodeGroupsRequest returnPartialSuccess.

zone

public zone: string;

ListNodeGroupsRequest zone.

Methods

create(properties)

public static create(properties?: google.cloud.compute.v1.IListNodeGroupsRequest): google.cloud.compute.v1.ListNodeGroupsRequest;

Creates a new ListNodeGroupsRequest instance using the specified properties.

Parameter
Name Description
properties google.cloud.compute.v1.IListNodeGroupsRequest

Properties to set
Returns
Type Description
google.cloud.compute.v1.ListNodeGroupsRequest

ListNodeGroupsRequest instance

decode(reader, length)

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

Decodes a ListNodeGroupsRequest 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.compute.v1.ListNodeGroupsRequest

ListNodeGroupsRequest

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.compute.v1.ListNodeGroupsRequest;

Decodes a ListNodeGroupsRequest 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.compute.v1.ListNodeGroupsRequest

ListNodeGroupsRequest

encode(message, writer)

public static encode(message: google.cloud.compute.v1.IListNodeGroupsRequest, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified ListNodeGroupsRequest message. Does not implicitly messages.

Parameters
Name Description
message google.cloud.compute.v1.IListNodeGroupsRequest

ListNodeGroupsRequest 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.compute.v1.IListNodeGroupsRequest, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
Name Description
message google.cloud.compute.v1.IListNodeGroupsRequest

ListNodeGroupsRequest 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.compute.v1.ListNodeGroupsRequest;

Creates a ListNodeGroupsRequest 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.compute.v1.ListNodeGroupsRequest

ListNodeGroupsRequest

toJSON()

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

Converts this ListNodeGroupsRequest to JSON.

Returns
Type Description
{ [k: string]: any }

JSON object

toObject(message, options)

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

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

Parameters
Name Description
message google.cloud.compute.v1.ListNodeGroupsRequest

ListNodeGroupsRequest
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 ListNodeGroupsRequest 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