Class protos.google.cloud.edgenetwork.v1.Router.BgpPeer (0.4.0)

Represents a BgpPeer.

Package

@google-cloud/edgenetwork

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.edgenetwork.v1.Router.IBgpPeer);

Constructs a new BgpPeer.

Parameter
NameDescription
properties IBgpPeer

Properties to set

Properties

interface

public interface: string;

BgpPeer interface.

interfaceIpv4Cidr

public interfaceIpv4Cidr: string;

BgpPeer interfaceIpv4Cidr.

interfaceIpv6Cidr

public interfaceIpv6Cidr: string;

BgpPeer interfaceIpv6Cidr.

localAsn

public localAsn: number;

BgpPeer localAsn.

name

public name: string;

BgpPeer name.

peerAsn

public peerAsn: number;

BgpPeer peerAsn.

peerIpv4Cidr

public peerIpv4Cidr: string;

BgpPeer peerIpv4Cidr.

peerIpv6Cidr

public peerIpv6Cidr: string;

BgpPeer peerIpv6Cidr.

Methods

create(properties)

public static create(properties?: google.cloud.edgenetwork.v1.Router.IBgpPeer): google.cloud.edgenetwork.v1.Router.BgpPeer;

Creates a new BgpPeer instance using the specified properties.

Parameter
NameDescription
properties IBgpPeer

Properties to set

Returns
TypeDescription
BgpPeer

BgpPeer instance

decode(reader, length)

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

Decodes a BgpPeer 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
BgpPeer

BgpPeer

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.edgenetwork.v1.Router.BgpPeer;

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

Parameter
NameDescription
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
TypeDescription
BgpPeer

BgpPeer

encode(message, writer)

public static encode(message: google.cloud.edgenetwork.v1.Router.IBgpPeer, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified BgpPeer message. Does not implicitly messages.

Parameters
NameDescription
message IBgpPeer

BgpPeer 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.edgenetwork.v1.Router.IBgpPeer, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
NameDescription
message IBgpPeer

BgpPeer 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.edgenetwork.v1.Router.BgpPeer;

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

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

Plain object

Returns
TypeDescription
BgpPeer

BgpPeer

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for BgpPeer

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

Returns
TypeDescription
{ [k: string]: any }

JSON object

toObject(message, options)

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

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

Parameters
NameDescription
message BgpPeer

BgpPeer

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 BgpPeer 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