Class protos.google.cloud.compute.v1.ListInstanceGroupsRequest (3.1.2)

Represents a ListInstanceGroupsRequest.

Package

Constructors

(constructor)(properties)

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

Constructs a new ListInstanceGroupsRequest.

Parameter

Name	Description
properties	`IListInstanceGroupsRequest` Properties to set

Properties

_filter

public _filter?: "filter";

ListInstanceGroupsRequest _filter.

_maxResults

public _maxResults?: "maxResults";

ListInstanceGroupsRequest _maxResults.

_orderBy

public _orderBy?: "orderBy";

ListInstanceGroupsRequest _orderBy.

_pageToken

public _pageToken?: "pageToken";

ListInstanceGroupsRequest _pageToken.

_returnPartialSuccess

public _returnPartialSuccess?: "returnPartialSuccess";

ListInstanceGroupsRequest _returnPartialSuccess.

filter

public filter?: (string|null);

ListInstanceGroupsRequest filter.

maxResults

public maxResults?: (number|null);

ListInstanceGroupsRequest maxResults.

orderBy

public orderBy?: (string|null);

ListInstanceGroupsRequest orderBy.

pageToken

public pageToken?: (string|null);

ListInstanceGroupsRequest pageToken.

project

public project: string;

ListInstanceGroupsRequest project.

returnPartialSuccess

public returnPartialSuccess?: (boolean|null);

ListInstanceGroupsRequest returnPartialSuccess.

zone

public zone: string;

ListInstanceGroupsRequest zone.

Methods

create(properties)

public static create(properties?: google.cloud.compute.v1.IListInstanceGroupsRequest): google.cloud.compute.v1.ListInstanceGroupsRequest;

Creates a new ListInstanceGroupsRequest instance using the specified properties.

Parameter

Name	Description
properties	`IListInstanceGroupsRequest` Properties to set

Returns

Type	Description
google.cloud.compute.v1.ListInstanceGroupsRequest	ListInstanceGroupsRequest instance

decode(reader, length)

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

Decodes a ListInstanceGroupsRequest 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.ListInstanceGroupsRequest	ListInstanceGroupsRequest

decodeDelimited(reader)

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

Decodes a ListInstanceGroupsRequest 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.ListInstanceGroupsRequest	ListInstanceGroupsRequest

encode(message, writer)

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

Encodes the specified ListInstanceGroupsRequest message. Does not implicitly messages.

Parameters

Name	Description
message	`IListInstanceGroupsRequest` ListInstanceGroupsRequest 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.IListInstanceGroupsRequest, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters

Name	Description
message	`IListInstanceGroupsRequest` ListInstanceGroupsRequest 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.ListInstanceGroupsRequest;

Creates a ListInstanceGroupsRequest 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.ListInstanceGroupsRequest	ListInstanceGroupsRequest

toJSON()

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

Converts this ListInstanceGroupsRequest to JSON.

Returns

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

toObject(message, options)

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

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

Parameters

Name	Description
message	`google.cloud.compute.v1.ListInstanceGroupsRequest` ListInstanceGroupsRequest
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 ListInstanceGroupsRequest 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