Class protos.google.cloud.compute.v1.AggregatedListTargetInstancesRequest (4.3.0)

Represents an AggregatedListTargetInstancesRequest.

Package

@google-cloud/compute

Constructors

(constructor)(properties)

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

Constructs a new AggregatedListTargetInstancesRequest.

Parameter
Name Description
properties IAggregatedListTargetInstancesRequest

Properties to set

Properties

_filter

public _filter?: "filter";

AggregatedListTargetInstancesRequest _filter.

_includeAllScopes

public _includeAllScopes?: "includeAllScopes";

AggregatedListTargetInstancesRequest _includeAllScopes.

_maxResults

public _maxResults?: "maxResults";

AggregatedListTargetInstancesRequest _maxResults.

_orderBy

public _orderBy?: "orderBy";

AggregatedListTargetInstancesRequest _orderBy.

_pageToken

public _pageToken?: "pageToken";

AggregatedListTargetInstancesRequest _pageToken.

_returnPartialSuccess

public _returnPartialSuccess?: "returnPartialSuccess";

AggregatedListTargetInstancesRequest _returnPartialSuccess.

_serviceProjectNumber

public _serviceProjectNumber?: "serviceProjectNumber";

AggregatedListTargetInstancesRequest _serviceProjectNumber.

filter

public filter?: (string|null);

AggregatedListTargetInstancesRequest filter.

includeAllScopes

public includeAllScopes?: (boolean|null);

AggregatedListTargetInstancesRequest includeAllScopes.

maxResults

public maxResults?: (number|null);

AggregatedListTargetInstancesRequest maxResults.

orderBy

public orderBy?: (string|null);

AggregatedListTargetInstancesRequest orderBy.

pageToken

public pageToken?: (string|null);

AggregatedListTargetInstancesRequest pageToken.

project

public project: string;

AggregatedListTargetInstancesRequest project.

returnPartialSuccess

public returnPartialSuccess?: (boolean|null);

AggregatedListTargetInstancesRequest returnPartialSuccess.

serviceProjectNumber

public serviceProjectNumber?: (number|Long|string|null);

AggregatedListTargetInstancesRequest serviceProjectNumber.

Methods

create(properties)

public static create(properties?: google.cloud.compute.v1.IAggregatedListTargetInstancesRequest): google.cloud.compute.v1.AggregatedListTargetInstancesRequest;

Creates a new AggregatedListTargetInstancesRequest instance using the specified properties.

Parameter
Name Description
properties IAggregatedListTargetInstancesRequest

Properties to set
Returns
Type Description
AggregatedListTargetInstancesRequest

AggregatedListTargetInstancesRequest instance

decode(reader, length)

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

Decodes an AggregatedListTargetInstancesRequest message from the specified reader or buffer.

Parameters
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from
length number

Message length if known beforehand
Returns
Type Description
AggregatedListTargetInstancesRequest

AggregatedListTargetInstancesRequest

decodeDelimited(reader)

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

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

Parameter
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from
Returns
Type Description
AggregatedListTargetInstancesRequest

AggregatedListTargetInstancesRequest

encode(message, writer)

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

Encodes the specified AggregatedListTargetInstancesRequest message. Does not implicitly messages.

Parameters
Name Description
message IAggregatedListTargetInstancesRequest

AggregatedListTargetInstancesRequest 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.IAggregatedListTargetInstancesRequest, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
Name Description
message IAggregatedListTargetInstancesRequest

AggregatedListTargetInstancesRequest 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.AggregatedListTargetInstancesRequest;

Creates an AggregatedListTargetInstancesRequest 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
AggregatedListTargetInstancesRequest

AggregatedListTargetInstancesRequest

getTypeUrl(typeUrlPrefix)

public static getTypeUrl(typeUrlPrefix?: string): string;

Gets the default type url for AggregatedListTargetInstancesRequest

Parameter
Name Description
typeUrlPrefix string

your custom typeUrlPrefix(default "type.googleapis.com")
Returns
Type Description
string

The default type url

toJSON()

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

Converts this AggregatedListTargetInstancesRequest to JSON.

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

JSON object

toObject(message, options)

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

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

Parameters
Name Description
message AggregatedListTargetInstancesRequest

AggregatedListTargetInstancesRequest
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 an AggregatedListTargetInstancesRequest 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