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

Represents an AggregatedListReservationsRequest.

Package

Constructors

(constructor)(properties)

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

Constructs a new AggregatedListReservationsRequest.

Parameter

Name	Description
properties	`IAggregatedListReservationsRequest` Properties to set

Properties

_filter

public _filter?: "filter";

AggregatedListReservationsRequest _filter.

_includeAllScopes

public _includeAllScopes?: "includeAllScopes";

AggregatedListReservationsRequest _includeAllScopes.

_maxResults

public _maxResults?: "maxResults";

AggregatedListReservationsRequest _maxResults.

_orderBy

public _orderBy?: "orderBy";

AggregatedListReservationsRequest _orderBy.

_pageToken

public _pageToken?: "pageToken";

AggregatedListReservationsRequest _pageToken.

_returnPartialSuccess

public _returnPartialSuccess?: "returnPartialSuccess";

AggregatedListReservationsRequest _returnPartialSuccess.

filter

public filter?: (string|null);

AggregatedListReservationsRequest filter.

includeAllScopes

public includeAllScopes?: (boolean|null);

AggregatedListReservationsRequest includeAllScopes.

maxResults

public maxResults?: (number|null);

AggregatedListReservationsRequest maxResults.

orderBy

public orderBy?: (string|null);

AggregatedListReservationsRequest orderBy.

pageToken

public pageToken?: (string|null);

AggregatedListReservationsRequest pageToken.

project

public project: string;

AggregatedListReservationsRequest project.

returnPartialSuccess

public returnPartialSuccess?: (boolean|null);

AggregatedListReservationsRequest returnPartialSuccess.

Methods

create(properties)

public static create(properties?: google.cloud.compute.v1.IAggregatedListReservationsRequest): google.cloud.compute.v1.AggregatedListReservationsRequest;

Creates a new AggregatedListReservationsRequest instance using the specified properties.

Parameter

Name	Description
properties	`IAggregatedListReservationsRequest` Properties to set

Returns

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

decode(reader, length)

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

Decodes an AggregatedListReservationsRequest 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.AggregatedListReservationsRequest	AggregatedListReservationsRequest

decodeDelimited(reader)

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

Decodes an AggregatedListReservationsRequest 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.AggregatedListReservationsRequest	AggregatedListReservationsRequest

encode(message, writer)

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

Encodes the specified AggregatedListReservationsRequest message. Does not implicitly messages.

Parameters

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

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

Parameters

Name	Description
message	`IAggregatedListReservationsRequest` AggregatedListReservationsRequest 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.AggregatedListReservationsRequest;

Creates an AggregatedListReservationsRequest 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.AggregatedListReservationsRequest	AggregatedListReservationsRequest

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for AggregatedListReservationsRequest

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

Returns

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

toObject(message, options)

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

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

Parameters

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