Some or all of the information on this page might not apply to Cloud de Confiance by S3NS. See Differences from Google Cloud for more details.

Class protos.google.cloud.compute.v1.VpnGatewayAggregatedList (3.1.2)

Represents a VpnGatewayAggregatedList.

Package

@google-cloud/compute

Constructors

(constructor)(properties)

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

Constructs a new VpnGatewayAggregatedList.

Parameter

Name	Description
properties	`IVpnGatewayAggregatedList` Properties to set

Properties

_id

public _id?: "id";

VpnGatewayAggregatedList _id.

_kind

public _kind?: "kind";

VpnGatewayAggregatedList _kind.

_nextPageToken

public _nextPageToken?: "nextPageToken";

VpnGatewayAggregatedList _nextPageToken.

_selfLink

public _selfLink?: "selfLink";

VpnGatewayAggregatedList _selfLink.

_warning

public _warning?: "warning";

VpnGatewayAggregatedList _warning.

id

public id?: (string|null);

VpnGatewayAggregatedList id.

items

public items: { [k: string]: google.cloud.compute.v1.IVpnGatewaysScopedList };

VpnGatewayAggregatedList items.

kind

public kind?: (string|null);

VpnGatewayAggregatedList kind.

nextPageToken

public nextPageToken?: (string|null);

VpnGatewayAggregatedList nextPageToken.

selfLink

public selfLink?: (string|null);

VpnGatewayAggregatedList selfLink.

unreachables

public unreachables: string[];

VpnGatewayAggregatedList unreachables.

warning

public warning?: (google.cloud.compute.v1.IWarning|null);

VpnGatewayAggregatedList warning.

Methods

create(properties)

public static create(properties?: google.cloud.compute.v1.IVpnGatewayAggregatedList): google.cloud.compute.v1.VpnGatewayAggregatedList;

Creates a new VpnGatewayAggregatedList instance using the specified properties.

Parameter

Name	Description
properties	`IVpnGatewayAggregatedList` Properties to set

Returns

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

decode(reader, length)

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

Decodes a VpnGatewayAggregatedList 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.VpnGatewayAggregatedList	VpnGatewayAggregatedList

decodeDelimited(reader)

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

Decodes a VpnGatewayAggregatedList 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.VpnGatewayAggregatedList	VpnGatewayAggregatedList

encode(message, writer)

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

Encodes the specified VpnGatewayAggregatedList message. Does not implicitly messages.

Parameters

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

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

Parameters

Name	Description
message	`IVpnGatewayAggregatedList` VpnGatewayAggregatedList 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.VpnGatewayAggregatedList;

Creates a VpnGatewayAggregatedList 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.VpnGatewayAggregatedList	VpnGatewayAggregatedList

toJSON()

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

Converts this VpnGatewayAggregatedList to JSON.

Returns

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

toObject(message, options)

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

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

Parameters

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