Class protos.google.cloud.networkmanagement.v1beta1.VpnGatewayInfo (1.0.2)

Represents a VpnGatewayInfo.

Package

@google-cloud/network-management!

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.networkmanagement.v1beta1.IVpnGatewayInfo);

Constructs a new VpnGatewayInfo.

Parameter

Name	Description
properties	`IVpnGatewayInfo` Properties to set

Properties

displayName

public displayName: string;

VpnGatewayInfo displayName.

Property Value

Type	Description
string

ipAddress

public ipAddress: string;

VpnGatewayInfo ipAddress.

Property Value

Type	Description
string

networkUri

public networkUri: string;

VpnGatewayInfo networkUri.

Property Value

Type	Description
string

region

public region: string;

VpnGatewayInfo region.

Property Value

Type	Description
string

uri

public uri: string;

VpnGatewayInfo uri.

Property Value

Type	Description
string

vpnTunnelUri

public vpnTunnelUri: string;

VpnGatewayInfo vpnTunnelUri.

Property Value

Type	Description
string

Methods

create(properties)

public static create(properties?: google.cloud.networkmanagement.v1beta1.IVpnGatewayInfo): google.cloud.networkmanagement.v1beta1.VpnGatewayInfo;

Creates a new VpnGatewayInfo instance using the specified properties.

Parameter

Name	Description
properties	`IVpnGatewayInfo` Properties to set

Returns

Type	Description
google.cloud.networkmanagement.v1beta1.VpnGatewayInfo	VpnGatewayInfo instance

decode(reader, length)

public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.networkmanagement.v1beta1.VpnGatewayInfo;

Decodes a VpnGatewayInfo 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.networkmanagement.v1beta1.VpnGatewayInfo	VpnGatewayInfo

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.networkmanagement.v1beta1.VpnGatewayInfo;

Decodes a VpnGatewayInfo 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.networkmanagement.v1beta1.VpnGatewayInfo	VpnGatewayInfo

encode(message, writer)

public static encode(message: google.cloud.networkmanagement.v1beta1.IVpnGatewayInfo, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified VpnGatewayInfo message. Does not implicitly messages.

Parameters

Name	Description
message	`IVpnGatewayInfo` VpnGatewayInfo 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.networkmanagement.v1beta1.IVpnGatewayInfo, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters

Name	Description
message	`IVpnGatewayInfo` VpnGatewayInfo 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.networkmanagement.v1beta1.VpnGatewayInfo;

Creates a VpnGatewayInfo 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.networkmanagement.v1beta1.VpnGatewayInfo	VpnGatewayInfo

toJSON()

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

Converts this VpnGatewayInfo to JSON.

Returns

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

toObject(message, options)

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

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

Parameters

Name	Description
message	`google.cloud.networkmanagement.v1beta1.VpnGatewayInfo` VpnGatewayInfo
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 VpnGatewayInfo 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