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

Represents an AggregatedListAddressesRequest.

Package

@google-cloud/compute

Constructors

(constructor)(properties)

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

Constructs a new AggregatedListAddressesRequest.

Parameter
NameDescription
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.

_returnPartialSuccess

public _returnPartialSuccess?: "returnPartialSuccess";

AggregatedListAddressesRequest _returnPartialSuccess.

_serviceProjectNumber

public _serviceProjectNumber?: "serviceProjectNumber";

AggregatedListAddressesRequest _serviceProjectNumber.

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.

returnPartialSuccess

public returnPartialSuccess?: (boolean|null);

AggregatedListAddressesRequest returnPartialSuccess.

serviceProjectNumber

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

AggregatedListAddressesRequest serviceProjectNumber.

Methods

create(properties)

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

Creates a new AggregatedListAddressesRequest instance using the specified properties.

Parameter
NameDescription
properties IAggregatedListAddressesRequest

Properties to set

Returns
TypeDescription
AggregatedListAddressesRequest

AggregatedListAddressesRequest instance

decode(reader, length)

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

Decodes an AggregatedListAddressesRequest message from the specified reader or buffer.

Parameters
NameDescription
reader (Reader|Uint8Array)

Reader or buffer to decode from

length number

Message length if known beforehand

Returns
TypeDescription
AggregatedListAddressesRequest

AggregatedListAddressesRequest

decodeDelimited(reader)

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

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

Parameter
NameDescription
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
TypeDescription
AggregatedListAddressesRequest

AggregatedListAddressesRequest

encode(message, writer)

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

Encodes the specified AggregatedListAddressesRequest message. Does not implicitly messages.

Parameters
NameDescription
message IAggregatedListAddressesRequest

AggregatedListAddressesRequest message or plain object to encode

writer $protobuf.Writer

Writer to encode to

Returns
TypeDescription
$protobuf.Writer

Writer

encodeDelimited(message, writer)

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

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

Parameters
NameDescription
message IAggregatedListAddressesRequest

AggregatedListAddressesRequest message or plain object to encode

writer $protobuf.Writer

Writer to encode to

Returns
TypeDescription
$protobuf.Writer

Writer

fromObject(object)

public static fromObject(object: { [k: string]: any }): google.cloud.compute.v1.AggregatedListAddressesRequest;

Creates an AggregatedListAddressesRequest message from a plain object. Also converts values to their respective internal types.

Parameter
NameDescription
object { [k: string]: any }

Plain object

Returns
TypeDescription
AggregatedListAddressesRequest

AggregatedListAddressesRequest

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for AggregatedListAddressesRequest

Parameter
NameDescription
typeUrlPrefix string

your custom typeUrlPrefix(default "type.googleapis.com")

Returns
TypeDescription
string

The default type url

toJSON()

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

Converts this AggregatedListAddressesRequest to JSON.

Returns
TypeDescription
{ [k: string]: any }

JSON object

toObject(message, options)

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

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

Parameters
NameDescription
message AggregatedListAddressesRequest

AggregatedListAddressesRequest

options $protobuf.IConversionOptions

Conversion options

Returns
TypeDescription
{ [k: string]: any }

Plain object

verify(message)

public static verify(message: { [k: string]: any }): (string|null);

Verifies an AggregatedListAddressesRequest message.

Parameter
NameDescription
message { [k: string]: any }

Plain object to verify

Returns
TypeDescription
(string|null)

null if valid, otherwise the reason why it is not