Class protos.google.cloud.compute.v1.ListTargetInstancesRequest (3.5.1)

Represents a ListTargetInstancesRequest.

Package

Constructors

(constructor)(properties)

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

Constructs a new ListTargetInstancesRequest.

Parameter

Name	Description
properties	`IListTargetInstancesRequest` Properties to set

Properties

_filter

public _filter?: "filter";

ListTargetInstancesRequest _filter.

_maxResults

public _maxResults?: "maxResults";

ListTargetInstancesRequest _maxResults.

_orderBy

public _orderBy?: "orderBy";

ListTargetInstancesRequest _orderBy.

_pageToken

public _pageToken?: "pageToken";

ListTargetInstancesRequest _pageToken.

_returnPartialSuccess

public _returnPartialSuccess?: "returnPartialSuccess";

ListTargetInstancesRequest _returnPartialSuccess.

filter

public filter?: (string|null);

ListTargetInstancesRequest filter.

maxResults

public maxResults?: (number|null);

ListTargetInstancesRequest maxResults.

orderBy

public orderBy?: (string|null);

ListTargetInstancesRequest orderBy.

pageToken

public pageToken?: (string|null);

ListTargetInstancesRequest pageToken.

project

public project: string;

ListTargetInstancesRequest project.

returnPartialSuccess

public returnPartialSuccess?: (boolean|null);

ListTargetInstancesRequest returnPartialSuccess.

zone

public zone: string;

ListTargetInstancesRequest zone.

Methods

create(properties)

public static create(properties?: google.cloud.compute.v1.IListTargetInstancesRequest): google.cloud.compute.v1.ListTargetInstancesRequest;

Creates a new ListTargetInstancesRequest instance using the specified properties.

Parameter

Name	Description
properties	`IListTargetInstancesRequest` Properties to set

Returns

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

decode(reader, length)

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

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

decodeDelimited(reader)

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

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

encode(message, writer)

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

Encodes the specified ListTargetInstancesRequest message. Does not implicitly messages.

Parameters

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

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

Parameters

Name	Description
message	`IListTargetInstancesRequest` ListTargetInstancesRequest 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.ListTargetInstancesRequest;

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

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for ListTargetInstancesRequest

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 ListTargetInstancesRequest to JSON.

Returns

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

toObject(message, options)

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

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

Parameters

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