Class protos.google.cloud.compute.v1small.AggregatedListAddressesRequest (3.1.2)

Represents an AggregatedListAddressesRequest.

Package

@google-cloud/compute

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.compute.v1small.IAggregatedListAddressesRequest);

Constructs a new AggregatedListAddressesRequest.

Parameter
Name Description
properties IAggregatedListAddressesRequest

Properties to set

Properties

_filter

public _filter?: "filter";

AggregatedListAddressesRequest _filter.

_includeAllScopes

public _includeAllScopes?: "includeAllScopes";

AggregatedListAddressesRequest _includeAllScopes.

_maxResults

public _maxResults?: "maxResults";

AggregatedListAddressesRequest _maxResults.

_orderBy

public _orderBy?: "orderBy";

AggregatedListAddressesRequest _orderBy.

_pageToken

public _pageToken?: "pageToken";

AggregatedListAddressesRequest _pageToken.

filter

public filter?: (string|null);

AggregatedListAddressesRequest filter.

includeAllScopes

public includeAllScopes?: (boolean|null);

AggregatedListAddressesRequest includeAllScopes.

maxResults

public maxResults?: (number|null);

AggregatedListAddressesRequest maxResults.

orderBy

public orderBy?: (string|null);

AggregatedListAddressesRequest orderBy.

pageToken

public pageToken?: (string|null);

AggregatedListAddressesRequest pageToken.

project

public project: string;

AggregatedListAddressesRequest project.

Methods

create(properties)

public static create(properties?: google.cloud.compute.v1small.IAggregatedListAddressesRequest): google.cloud.compute.v1small.AggregatedListAddressesRequest;

Creates a new AggregatedListAddressesRequest instance using the specified properties.

Parameter
Name Description
properties IAggregatedListAddressesRequest

Properties to set
Returns
Type Description
google.cloud.compute.v1small.AggregatedListAddressesRequest

AggregatedListAddressesRequest instance

decode(reader, length)

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

Decodes an AggregatedListAddressesRequest 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.v1small.AggregatedListAddressesRequest

AggregatedListAddressesRequest

decodeDelimited(reader)

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

Decodes an AggregatedListAddressesRequest 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.v1small.AggregatedListAddressesRequest

AggregatedListAddressesRequest

encode(message, writer)

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

Encodes the specified AggregatedListAddressesRequest message. Does not implicitly messages.

Parameters
Name Description
message IAggregatedListAddressesRequest

AggregatedListAddressesRequest 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.v1small.IAggregatedListAddressesRequest, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
Name Description
message IAggregatedListAddressesRequest

AggregatedListAddressesRequest 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.v1small.AggregatedListAddressesRequest;

Creates an AggregatedListAddressesRequest 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.v1small.AggregatedListAddressesRequest

AggregatedListAddressesRequest

toJSON()

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

Converts this AggregatedListAddressesRequest to JSON.

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

JSON object

toObject(message, options)

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

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

Parameters
Name Description
message google.cloud.compute.v1small.AggregatedListAddressesRequest

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