Class protos.google.cloud.compute.v1.AggregatedListVpnTunnelsRequest (4.9.0)

Represents an AggregatedListVpnTunnelsRequest.

Package

Constructors

(constructor)(properties)

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

Constructs a new AggregatedListVpnTunnelsRequest.

Parameter
Name	Description
`properties`	`IAggregatedListVpnTunnelsRequest` Properties to set

Properties

_filter

public _filter?: "filter";

AggregatedListVpnTunnelsRequest _filter.

_includeAllScopes

public _includeAllScopes?: "includeAllScopes";

AggregatedListVpnTunnelsRequest _includeAllScopes.

_maxResults

public _maxResults?: "maxResults";

AggregatedListVpnTunnelsRequest _maxResults.

_orderBy

public _orderBy?: "orderBy";

AggregatedListVpnTunnelsRequest _orderBy.

_pageToken

public _pageToken?: "pageToken";

AggregatedListVpnTunnelsRequest _pageToken.

_returnPartialSuccess

public _returnPartialSuccess?: "returnPartialSuccess";

AggregatedListVpnTunnelsRequest _returnPartialSuccess.

_serviceProjectNumber

public _serviceProjectNumber?: "serviceProjectNumber";

AggregatedListVpnTunnelsRequest _serviceProjectNumber.

filter

public filter?: (string|null);

AggregatedListVpnTunnelsRequest filter.

includeAllScopes

public includeAllScopes?: (boolean|null);

AggregatedListVpnTunnelsRequest includeAllScopes.

maxResults

public maxResults?: (number|null);

AggregatedListVpnTunnelsRequest maxResults.

orderBy

public orderBy?: (string|null);

AggregatedListVpnTunnelsRequest orderBy.

pageToken

public pageToken?: (string|null);

AggregatedListVpnTunnelsRequest pageToken.

project

public project: string;

AggregatedListVpnTunnelsRequest project.

returnPartialSuccess

public returnPartialSuccess?: (boolean|null);

AggregatedListVpnTunnelsRequest returnPartialSuccess.

serviceProjectNumber

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

AggregatedListVpnTunnelsRequest serviceProjectNumber.

Methods

create(properties)

public static create(properties?: google.cloud.compute.v1.IAggregatedListVpnTunnelsRequest): google.cloud.compute.v1.AggregatedListVpnTunnelsRequest;

Creates a new AggregatedListVpnTunnelsRequest instance using the specified properties.

Parameter
Name	Description
`properties`	`IAggregatedListVpnTunnelsRequest` Properties to set

Returns
Type	Description
`AggregatedListVpnTunnelsRequest`	AggregatedListVpnTunnelsRequest instance

decode(reader, length)

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

Decodes an AggregatedListVpnTunnelsRequest 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
`AggregatedListVpnTunnelsRequest`	AggregatedListVpnTunnelsRequest

decodeDelimited(reader)

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

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

Parameter
Name	Description
`reader`	`(Reader\|Uint8Array)` Reader or buffer to decode from

Returns
Type	Description
`AggregatedListVpnTunnelsRequest`	AggregatedListVpnTunnelsRequest

encode(message, writer)

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

Encodes the specified AggregatedListVpnTunnelsRequest message. Does not implicitly messages.

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

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

Parameters
Name	Description
`message`	`IAggregatedListVpnTunnelsRequest` AggregatedListVpnTunnelsRequest 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.AggregatedListVpnTunnelsRequest;

Creates an AggregatedListVpnTunnelsRequest 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
`AggregatedListVpnTunnelsRequest`	AggregatedListVpnTunnelsRequest

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for AggregatedListVpnTunnelsRequest

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

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

toObject(message, options)

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

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

Parameters
Name	Description
`message`	`AggregatedListVpnTunnelsRequest` AggregatedListVpnTunnelsRequest
`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 AggregatedListVpnTunnelsRequest 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