Class protos.google.cloud.compute.v1.RouterBgpPeer (6.5.0)

Represents a RouterBgpPeer.

Package

@google-cloud/compute

Constructors

(constructor)(properties)

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

Constructs a new RouterBgpPeer.

Parameter
Name Description
properties IRouterBgpPeer

Properties to set

Properties

advertisedGroups

public advertisedGroups: string[];

RouterBgpPeer advertisedGroups.

advertisedIpRanges

public advertisedIpRanges: google.cloud.compute.v1.IRouterAdvertisedIpRange[];

RouterBgpPeer advertisedIpRanges.

advertisedRoutePriority

public advertisedRoutePriority?: (number|null);

RouterBgpPeer advertisedRoutePriority.

advertiseMode

public advertiseMode?: (string|null);

RouterBgpPeer advertiseMode.

bfd

public bfd?: (google.cloud.compute.v1.IRouterBgpPeerBfd|null);

RouterBgpPeer bfd.

customLearnedIpRanges

public customLearnedIpRanges: google.cloud.compute.v1.IRouterBgpPeerCustomLearnedIpRange[];

RouterBgpPeer customLearnedIpRanges.

customLearnedRoutePriority

public customLearnedRoutePriority?: (number|null);

RouterBgpPeer customLearnedRoutePriority.

enable

public enable?: (string|null);

RouterBgpPeer enable.

enableIpv4

public enableIpv4?: (boolean|null);

RouterBgpPeer enableIpv4.

enableIpv6

public enableIpv6?: (boolean|null);

RouterBgpPeer enableIpv6.

exportPolicies

public exportPolicies: string[];

RouterBgpPeer exportPolicies.

importPolicies

public importPolicies: string[];

RouterBgpPeer importPolicies.

interfaceName

public interfaceName?: (string|null);

RouterBgpPeer interfaceName.

ipAddress

public ipAddress?: (string|null);

RouterBgpPeer ipAddress.

ipv4NexthopAddress

public ipv4NexthopAddress?: (string|null);

RouterBgpPeer ipv4NexthopAddress.

ipv6NexthopAddress

public ipv6NexthopAddress?: (string|null);

RouterBgpPeer ipv6NexthopAddress.

managementType

public managementType?: (string|null);

RouterBgpPeer managementType.

md5AuthenticationKeyName

public md5AuthenticationKeyName?: (string|null);

RouterBgpPeer md5AuthenticationKeyName.

name

public name?: (string|null);

RouterBgpPeer name.

peerAsn

public peerAsn?: (number|null);

RouterBgpPeer peerAsn.

peerIpAddress

public peerIpAddress?: (string|null);

RouterBgpPeer peerIpAddress.

peerIpv4NexthopAddress

public peerIpv4NexthopAddress?: (string|null);

RouterBgpPeer peerIpv4NexthopAddress.

peerIpv6NexthopAddress

public peerIpv6NexthopAddress?: (string|null);

RouterBgpPeer peerIpv6NexthopAddress.

routerApplianceInstance

public routerApplianceInstance?: (string|null);

RouterBgpPeer routerApplianceInstance.

Methods

create(properties)

public static create(properties?: google.cloud.compute.v1.IRouterBgpPeer): google.cloud.compute.v1.RouterBgpPeer;

Creates a new RouterBgpPeer instance using the specified properties.

Parameter
Name Description
properties IRouterBgpPeer

Properties to set
Returns
Type Description
RouterBgpPeer

RouterBgpPeer instance

decode(reader, length)

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

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

RouterBgpPeer

decodeDelimited(reader)

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

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

Parameter
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from
Returns
Type Description
RouterBgpPeer

RouterBgpPeer

encode(message, writer)

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

Encodes the specified RouterBgpPeer message. Does not implicitly messages.

Parameters
Name Description
message IRouterBgpPeer

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

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

Parameters
Name Description
message IRouterBgpPeer

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

Creates a RouterBgpPeer 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
RouterBgpPeer

RouterBgpPeer

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for RouterBgpPeer

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

Returns
Type Description
{ [k: string]: any }

JSON object

toObject(message, options)

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

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

Parameters
Name Description
message RouterBgpPeer

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