Class protos.google.cloud.compute.v1.AggregatedListInstancesRequest

Represents an AggregatedListInstancesRequest.

Package

@google-cloud/compute

Constructors

(constructor)(properties)

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

Constructs a new AggregatedListInstancesRequest.

Parameter
NameDescription
properties google.cloud.compute.v1.IAggregatedListInstancesRequest

Properties to set

Properties

_filter

public _filter?: "filter";

AggregatedListInstancesRequest _filter.

_includeAllScopes

public _includeAllScopes?: "includeAllScopes";

AggregatedListInstancesRequest _includeAllScopes.

_maxResults

public _maxResults?: "maxResults";

AggregatedListInstancesRequest _maxResults.

_orderBy

public _orderBy?: "orderBy";

AggregatedListInstancesRequest _orderBy.

_pageToken

public _pageToken?: "pageToken";

AggregatedListInstancesRequest _pageToken.

_returnPartialSuccess

public _returnPartialSuccess?: "returnPartialSuccess";

AggregatedListInstancesRequest _returnPartialSuccess.

filter

public filter?: (string|null);

AggregatedListInstancesRequest filter.

includeAllScopes

public includeAllScopes?: (boolean|null);

AggregatedListInstancesRequest includeAllScopes.

maxResults

public maxResults?: (number|null);

AggregatedListInstancesRequest maxResults.

orderBy

public orderBy?: (string|null);

AggregatedListInstancesRequest orderBy.

pageToken

public pageToken?: (string|null);

AggregatedListInstancesRequest pageToken.

project

public project: string;

AggregatedListInstancesRequest project.

returnPartialSuccess

public returnPartialSuccess?: (boolean|null);

AggregatedListInstancesRequest returnPartialSuccess.

Methods

create(properties)

public static create(properties?: google.cloud.compute.v1.IAggregatedListInstancesRequest): google.cloud.compute.v1.AggregatedListInstancesRequest;

Creates a new AggregatedListInstancesRequest instance using the specified properties.

Parameter
NameDescription
properties google.cloud.compute.v1.IAggregatedListInstancesRequest

Properties to set

Returns
TypeDescription
google.cloud.compute.v1.AggregatedListInstancesRequest

AggregatedListInstancesRequest instance

decode(reader, length)

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

Decodes an AggregatedListInstancesRequest message from the specified reader or buffer.

Parameters
NameDescription
reader ($protobuf.Reader|Uint8Array)

Reader or buffer to decode from

length number

Message length if known beforehand

Returns
TypeDescription
google.cloud.compute.v1.AggregatedListInstancesRequest

AggregatedListInstancesRequest

decodeDelimited(reader)

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

Decodes an AggregatedListInstancesRequest message from the specified reader or buffer, length delimited.

Parameter
NameDescription
reader ($protobuf.Reader|Uint8Array)

Reader or buffer to decode from

Returns
TypeDescription
google.cloud.compute.v1.AggregatedListInstancesRequest

AggregatedListInstancesRequest

encode(message, writer)

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

Encodes the specified AggregatedListInstancesRequest message. Does not implicitly messages.

Parameters
NameDescription
message google.cloud.compute.v1.IAggregatedListInstancesRequest

AggregatedListInstancesRequest message or plain object to encode

writer $protobuf.Writer

Writer to encode to

Returns
TypeDescription
$protobuf.Writer

Writer

encodeDelimited(message, writer)

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

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

Parameters
NameDescription
message google.cloud.compute.v1.IAggregatedListInstancesRequest

AggregatedListInstancesRequest message or plain object to encode

writer $protobuf.Writer

Writer to encode to

Returns
TypeDescription
$protobuf.Writer

Writer

fromObject(object)

public static fromObject(object: { [k: string]: any }): google.cloud.compute.v1.AggregatedListInstancesRequest;

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

Parameter
NameDescription
object { [k: string]: any }

Plain object

Returns
TypeDescription
google.cloud.compute.v1.AggregatedListInstancesRequest

AggregatedListInstancesRequest

toJSON()

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

Converts this AggregatedListInstancesRequest to JSON.

Returns
TypeDescription
{ [k: string]: any }

JSON object

toObject(message, options)

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

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

Parameters
NameDescription
message google.cloud.compute.v1.AggregatedListInstancesRequest

AggregatedListInstancesRequest

options $protobuf.IConversionOptions

Conversion options

Returns
TypeDescription
{ [k: string]: any }

Plain object

verify(message)

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

Verifies an AggregatedListInstancesRequest message.

Parameter
NameDescription
message { [k: string]: any }

Plain object to verify

Returns
TypeDescription
(string|null)

null if valid, otherwise the reason why it is not