Class protos.google.cloud.compute.v1.AggregatedListTargetPoolsRequest (4.5.0)

Represents an AggregatedListTargetPoolsRequest.

Package

@google-cloud/compute

Constructors

(constructor)(properties)

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

Constructs a new AggregatedListTargetPoolsRequest.

Parameter
Name Description
properties IAggregatedListTargetPoolsRequest

Properties to set

Properties

_filter

public _filter?: "filter";

AggregatedListTargetPoolsRequest _filter.

_includeAllScopes

public _includeAllScopes?: "includeAllScopes";

AggregatedListTargetPoolsRequest _includeAllScopes.

_maxResults

public _maxResults?: "maxResults";

AggregatedListTargetPoolsRequest _maxResults.

_orderBy

public _orderBy?: "orderBy";

AggregatedListTargetPoolsRequest _orderBy.

_pageToken

public _pageToken?: "pageToken";

AggregatedListTargetPoolsRequest _pageToken.

_returnPartialSuccess

public _returnPartialSuccess?: "returnPartialSuccess";

AggregatedListTargetPoolsRequest _returnPartialSuccess.

_serviceProjectNumber

public _serviceProjectNumber?: "serviceProjectNumber";

AggregatedListTargetPoolsRequest _serviceProjectNumber.

filter

public filter?: (string|null);

AggregatedListTargetPoolsRequest filter.

includeAllScopes

public includeAllScopes?: (boolean|null);

AggregatedListTargetPoolsRequest includeAllScopes.

maxResults

public maxResults?: (number|null);

AggregatedListTargetPoolsRequest maxResults.

orderBy

public orderBy?: (string|null);

AggregatedListTargetPoolsRequest orderBy.

pageToken

public pageToken?: (string|null);

AggregatedListTargetPoolsRequest pageToken.

project

public project: string;

AggregatedListTargetPoolsRequest project.

returnPartialSuccess

public returnPartialSuccess?: (boolean|null);

AggregatedListTargetPoolsRequest returnPartialSuccess.

serviceProjectNumber

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

AggregatedListTargetPoolsRequest serviceProjectNumber.

Methods

create(properties)

public static create(properties?: google.cloud.compute.v1.IAggregatedListTargetPoolsRequest): google.cloud.compute.v1.AggregatedListTargetPoolsRequest;

Creates a new AggregatedListTargetPoolsRequest instance using the specified properties.

Parameter
Name Description
properties IAggregatedListTargetPoolsRequest

Properties to set
Returns
Type Description
AggregatedListTargetPoolsRequest

AggregatedListTargetPoolsRequest instance

decode(reader, length)

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

Decodes an AggregatedListTargetPoolsRequest 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
AggregatedListTargetPoolsRequest

AggregatedListTargetPoolsRequest

decodeDelimited(reader)

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

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

Parameter
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from
Returns
Type Description
AggregatedListTargetPoolsRequest

AggregatedListTargetPoolsRequest

encode(message, writer)

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

Encodes the specified AggregatedListTargetPoolsRequest message. Does not implicitly messages.

Parameters
Name Description
message IAggregatedListTargetPoolsRequest

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

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

Parameters
Name Description
message IAggregatedListTargetPoolsRequest

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

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

AggregatedListTargetPoolsRequest

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for AggregatedListTargetPoolsRequest

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

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

JSON object

toObject(message, options)

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

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

Parameters
Name Description
message AggregatedListTargetPoolsRequest

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