Class protos.google.cloud.compute.v1.ListExternalVpnGatewaysRequest

Represents a ListExternalVpnGatewaysRequest.

Package

@google-cloud/compute

Constructors

(constructor)(properties)

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

Constructs a new ListExternalVpnGatewaysRequest.

Parameter
NameDescription
properties IListExternalVpnGatewaysRequest

Properties to set

Properties

_filter

public _filter?: "filter";

ListExternalVpnGatewaysRequest _filter.

_maxResults

public _maxResults?: "maxResults";

ListExternalVpnGatewaysRequest _maxResults.

_orderBy

public _orderBy?: "orderBy";

ListExternalVpnGatewaysRequest _orderBy.

_pageToken

public _pageToken?: "pageToken";

ListExternalVpnGatewaysRequest _pageToken.

_returnPartialSuccess

public _returnPartialSuccess?: "returnPartialSuccess";

ListExternalVpnGatewaysRequest _returnPartialSuccess.

filter

public filter?: (string|null);

ListExternalVpnGatewaysRequest filter.

maxResults

public maxResults?: (number|null);

ListExternalVpnGatewaysRequest maxResults.

orderBy

public orderBy?: (string|null);

ListExternalVpnGatewaysRequest orderBy.

pageToken

public pageToken?: (string|null);

ListExternalVpnGatewaysRequest pageToken.

project

public project: string;

ListExternalVpnGatewaysRequest project.

returnPartialSuccess

public returnPartialSuccess?: (boolean|null);

ListExternalVpnGatewaysRequest returnPartialSuccess.

Methods

create(properties)

public static create(properties?: google.cloud.compute.v1.IListExternalVpnGatewaysRequest): google.cloud.compute.v1.ListExternalVpnGatewaysRequest;

Creates a new ListExternalVpnGatewaysRequest instance using the specified properties.

Parameter
NameDescription
properties IListExternalVpnGatewaysRequest

Properties to set

Returns
TypeDescription
google.cloud.compute.v1.ListExternalVpnGatewaysRequest

ListExternalVpnGatewaysRequest instance

decode(reader, length)

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

Decodes a ListExternalVpnGatewaysRequest message from the specified reader or buffer.

Parameters
NameDescription
reader ($protobuf.Reader|Uint8Array)

Reader or buffer to decode from

length number

Message length if known beforehand

Returns
TypeDescription
google.cloud.compute.v1.ListExternalVpnGatewaysRequest

ListExternalVpnGatewaysRequest

decodeDelimited(reader)

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

Decodes a ListExternalVpnGatewaysRequest message from the specified reader or buffer, length delimited.

Parameter
NameDescription
reader ($protobuf.Reader|Uint8Array)

Reader or buffer to decode from

Returns
TypeDescription
google.cloud.compute.v1.ListExternalVpnGatewaysRequest

ListExternalVpnGatewaysRequest

encode(message, writer)

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

Encodes the specified ListExternalVpnGatewaysRequest message. Does not implicitly messages.

Parameters
NameDescription
message IListExternalVpnGatewaysRequest

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

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

Parameters
NameDescription
message IListExternalVpnGatewaysRequest

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

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

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

Plain object

Returns
TypeDescription
google.cloud.compute.v1.ListExternalVpnGatewaysRequest

ListExternalVpnGatewaysRequest

toJSON()

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

Converts this ListExternalVpnGatewaysRequest to JSON.

Returns
TypeDescription
{ [k: string]: any }

JSON object

toObject(message, options)

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

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

Parameters
NameDescription
message google.cloud.compute.v1.ListExternalVpnGatewaysRequest

ListExternalVpnGatewaysRequest

options $protobuf.IConversionOptions

Conversion options

Returns
TypeDescription
{ [k: string]: any }

Plain object

verify(message)

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

Verifies a ListExternalVpnGatewaysRequest 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