com.vmware.nsx.model

Class BgpNeighbor.Builder

java.lang.Object

com.vmware.nsx.model.BgpNeighbor.Builder

Enclosing class:

BgpNeighbor

public static final class BgpNeighbor.Builder
extends java.lang.Object

Builder class for BgpNeighbor.

Constructor Summary

Constructors

Constructor and Description
Builder() Constructor with parameters for the required properties of BgpNeighbor.

Method Summary

Modifier and Type	Method and Description
BgpNeighbor	build()
BgpNeighbor.Builder	setAddressFamilies(java.util.List<BgpNeighborAddressFamily> addressFamilies) User can enable the neighbor for the specific address families and also define filters per address family.
BgpNeighbor.Builder	setAllowAsIn(java.lang.Boolean allowAsIn) Flag to enable allowas_in option for BGP neighbor
BgpNeighbor.Builder	setBfdConfig(BfdConfigParameters bfdConfig)
BgpNeighbor.Builder	setCreateTime(java.lang.Long createTime) Timestamp of resource creation format: int64 This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
BgpNeighbor.Builder	setCreateUser(java.lang.String createUser) ID of the user who created this resource This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
BgpNeighbor.Builder	setDescription(java.lang.String description) Description of this resource
BgpNeighbor.Builder	setDisplayName(java.lang.String displayName) Defaults to ID if not set
BgpNeighbor.Builder	setEnableBfd(java.lang.Boolean enableBfd) Flag to enable BFD for this BGP Neighbor.
BgpNeighbor.Builder	setEnabled(java.lang.Boolean enabled) Flag to enable this BGP Neighbor
BgpNeighbor.Builder	setFilterInIpprefixlistId(java.lang.String filterInIpprefixlistId) This is a deprecated property, Please use 'address_family' instead.
BgpNeighbor.Builder	setFilterInRoutemapId(java.lang.String filterInRoutemapId) This is a deprecated property, Please use 'address_family' instead.
BgpNeighbor.Builder	setFilterOutIpprefixlistId(java.lang.String filterOutIpprefixlistId) This is a deprecated property, Please use 'address_family' instead.
BgpNeighbor.Builder	setFilterOutRoutemapId(java.lang.String filterOutRoutemapId) This is a deprecated property, Please use 'address_family' instead.
BgpNeighbor.Builder	setGracefulRestartMode(java.lang.String gracefulRestartMode) Possible values are: BgpNeighbor.GRACEFUL_RESTART_MODE_DISABLE BgpNeighbor.GRACEFUL_RESTART_MODE_HELPER_ONLY BgpNeighbor.GRACEFUL_RESTART_MODE_GR_AND_HELPER BGP Graceful Restart mode.
BgpNeighbor.Builder	setHoldDownTimer(java.lang.Long holdDownTimer) Wait period (seconds) before declaring peer dead format: int64
BgpNeighbor.Builder	setId(java.lang.String id) Unique identifier of this resource
BgpNeighbor.Builder	setKeepAliveTimer(java.lang.Long keepAliveTimer) Frequency (seconds) with which keep alive messages are sent to peers format: int64
BgpNeighbor.Builder	setLastModifiedTime(java.lang.Long lastModifiedTime) Timestamp of last modification format: int64 This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
BgpNeighbor.Builder	setLastModifiedUser(java.lang.String lastModifiedUser) ID of the user who last modified this resource This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
BgpNeighbor.Builder	setLinks(java.util.List<ResourceLink> links) The server will populate this field when returing the resource.
BgpNeighbor.Builder	setLogicalRouterId(java.lang.String logicalRouterId) Logical router id This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
BgpNeighbor.Builder	setMaximumHopLimit(java.lang.Long maximumHopLimit) This value is set on TTL(time to live) of BGP header.
BgpNeighbor.Builder	setNeighborAddress(java.lang.String neighborAddress) Neighbor IP Address format: ip
BgpNeighbor.Builder	setPassword(java.lang.String password) User can create (POST) the neighbor with or without the password.
BgpNeighbor.Builder	setProtection(java.lang.String protection) Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it.
BgpNeighbor.Builder	setRemoteAs(java.lang.Long remoteAs) This is a deprecated property, Please use 'remote_as_num' instead.
BgpNeighbor.Builder	setRemoteAsNum(java.lang.String remoteAsNum) 4 Byte ASN of the neighbor in ASPLAIN/ASDOT Format
BgpNeighbor.Builder	setResourceType(java.lang.String resourceType) The type of this resource.
BgpNeighbor.Builder	setRevision(java.lang.Long revision) The _revision property describes the current revision of the resource.
BgpNeighbor.Builder	setSchema(java.lang.String schema) Schema for this resource This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
BgpNeighbor.Builder	setSelf(SelfResourceLink self)
BgpNeighbor.Builder	setSourceAddress(java.lang.String sourceAddress) Deprecated - do not provide a value for this field.
BgpNeighbor.Builder	setSourceAddresses(java.util.List<java.lang.String> sourceAddresses) BGP neighborship will be formed from all these source addresses to this neighbour.
BgpNeighbor.Builder	setSystemOwned(java.lang.Boolean systemOwned) Indicates system owned resource This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
BgpNeighbor.Builder	setTags(java.util.List<Tag> tags) Opaque identifiers meaningful to the API user

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Builder

public Builder()

Constructor with parameters for the required properties of BgpNeighbor.

Method Detail

setLinks

public BgpNeighbor.Builder setLinks(java.util.List<ResourceLink> links)

The server will populate this field when returing the resource. Ignored on PUT and POST. This property may be present in responses from the server, but if it is present in a request to server it will be ignored.

Parameters:

links - New value for the property.

setSchema

public BgpNeighbor.Builder setSchema(java.lang.String schema)

Schema for this resource This property may be present in responses from the server, but if it is present in a request to server it will be ignored.

Parameters:

schema - New value for the property.

setSelf

public BgpNeighbor.Builder setSelf(SelfResourceLink self)

Parameters:

self - New value for the property.

setRevision

public BgpNeighbor.Builder setRevision(java.lang.Long revision)

The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32

Parameters:

revision - New value for the property.

setCreateTime

public BgpNeighbor.Builder setCreateTime(java.lang.Long createTime)

Timestamp of resource creation format: int64 This property may be present in responses from the server, but if it is present in a request to server it will be ignored.

Parameters:

createTime - New value for the property.

setCreateUser

public BgpNeighbor.Builder setCreateUser(java.lang.String createUser)

ID of the user who created this resource This property may be present in responses from the server, but if it is present in a request to server it will be ignored.

Parameters:

createUser - New value for the property.

setLastModifiedTime

public BgpNeighbor.Builder setLastModifiedTime(java.lang.Long lastModifiedTime)

Timestamp of last modification format: int64 This property may be present in responses from the server, but if it is present in a request to server it will be ignored.

Parameters:

lastModifiedTime - New value for the property.

setLastModifiedUser

public BgpNeighbor.Builder setLastModifiedUser(java.lang.String lastModifiedUser)

ID of the user who last modified this resource This property may be present in responses from the server, but if it is present in a request to server it will be ignored.

Parameters:

lastModifiedUser - New value for the property.

setProtection

public BgpNeighbor.Builder setProtection(java.lang.String protection)

Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This property may be present in responses from the server, but if it is present in a request to server it will be ignored.

Parameters:

protection - New value for the property.

setSystemOwned

public BgpNeighbor.Builder setSystemOwned(java.lang.Boolean systemOwned)

Indicates system owned resource This property may be present in responses from the server, but if it is present in a request to server it will be ignored.

Parameters:

systemOwned - New value for the property.

setDescription

public BgpNeighbor.Builder setDescription(java.lang.String description)

Description of this resource

Parameters:

description - New value for the property.

setDisplayName

public BgpNeighbor.Builder setDisplayName(java.lang.String displayName)

Defaults to ID if not set

Parameters:

displayName - New value for the property.

setId

public BgpNeighbor.Builder setId(java.lang.String id)

Unique identifier of this resource

Parameters:

id - New value for the property.

setResourceType

public BgpNeighbor.Builder setResourceType(java.lang.String resourceType)

The type of this resource.

Parameters:

resourceType - New value for the property.

setTags

public BgpNeighbor.Builder setTags(java.util.List<Tag> tags)

Opaque identifiers meaningful to the API user

Parameters:

tags - New value for the property.

setAddressFamilies

public BgpNeighbor.Builder setAddressFamilies(java.util.List<BgpNeighborAddressFamily> addressFamilies)

User can enable the neighbor for the specific address families and also define filters per address family. When the neighbor is created, it is default enabled for IPV4_UNICAST address family for backward compatibility reasons. User can change that if required, by defining the address family configuration.

Parameters:

addressFamilies - New value for the property.

setAllowAsIn

public BgpNeighbor.Builder setAllowAsIn(java.lang.Boolean allowAsIn)

Flag to enable allowas_in option for BGP neighbor

Parameters:

allowAsIn - New value for the property.

setBfdConfig

public BgpNeighbor.Builder setBfdConfig(BfdConfigParameters bfdConfig)

Parameters:

bfdConfig - New value for the property.

setEnableBfd

public BgpNeighbor.Builder setEnableBfd(java.lang.Boolean enableBfd)

Flag to enable BFD for this BGP Neighbor. Enable this if the neighbor supports BFD as this will lead to faster convergence.

Parameters:

enableBfd - New value for the property.

setEnabled

public BgpNeighbor.Builder setEnabled(java.lang.Boolean enabled)

Flag to enable this BGP Neighbor

Parameters:

enabled - New value for the property.

setFilterInIpprefixlistId

public BgpNeighbor.Builder setFilterInIpprefixlistId(java.lang.String filterInIpprefixlistId)

This is a deprecated property, Please use 'address_family' instead.

Parameters:

filterInIpprefixlistId - New value for the property.

setFilterInRoutemapId

public BgpNeighbor.Builder setFilterInRoutemapId(java.lang.String filterInRoutemapId)

This is a deprecated property, Please use 'address_family' instead.

Parameters:

filterInRoutemapId - New value for the property.

setFilterOutIpprefixlistId

public BgpNeighbor.Builder setFilterOutIpprefixlistId(java.lang.String filterOutIpprefixlistId)

This is a deprecated property, Please use 'address_family' instead.

Parameters:

filterOutIpprefixlistId - New value for the property.

setFilterOutRoutemapId

public BgpNeighbor.Builder setFilterOutRoutemapId(java.lang.String filterOutRoutemapId)

This is a deprecated property, Please use 'address_family' instead.

Parameters:

filterOutRoutemapId - New value for the property.

setGracefulRestartMode

public BgpNeighbor.Builder setGracefulRestartMode(java.lang.String gracefulRestartMode)

Possible values are:

• BgpNeighbor.GRACEFUL_RESTART_MODE_DISABLE
• BgpNeighbor.GRACEFUL_RESTART_MODE_HELPER_ONLY
• BgpNeighbor.GRACEFUL_RESTART_MODE_GR_AND_HELPER

BGP Graceful Restart mode. If specified, then it will take precedence over global Graceful Restart mode configured in logical router BgpConfig otherwise BgpConfig level Graceful Restart mode will be applicable for peer.

Parameters:

gracefulRestartMode - New value for the property.

setHoldDownTimer

public BgpNeighbor.Builder setHoldDownTimer(java.lang.Long holdDownTimer)

Wait period (seconds) before declaring peer dead format: int64

Parameters:

holdDownTimer - New value for the property.

setKeepAliveTimer

public BgpNeighbor.Builder setKeepAliveTimer(java.lang.Long keepAliveTimer)

Frequency (seconds) with which keep alive messages are sent to peers format: int64

Parameters:

keepAliveTimer - New value for the property.

setLogicalRouterId

public BgpNeighbor.Builder setLogicalRouterId(java.lang.String logicalRouterId)

Logical router id This property may be present in responses from the server, but if it is present in a request to server it will be ignored.

Parameters:

logicalRouterId - New value for the property.

setMaximumHopLimit

public BgpNeighbor.Builder setMaximumHopLimit(java.lang.Long maximumHopLimit)

This value is set on TTL(time to live) of BGP header. When router receives the BGP packet, it decrements the TTL. The default value of TTL is one when BPG request is initiated.So in the case of a BGP peer multiple hops away and and value of TTL is one, then next router in the path will decrement the TTL to 0, realize it cant forward the packet and will drop it. If the hop count value to reach neighbor is equal to or less than the maximum_hop_limit value then intermediate router decrements the TTL count by one and forwards the request to BGP neighour. If the hop count value is greater than the maximum_hop_limit value then intermediate router discards the request when TTL becomes 0. format: int32

Parameters:

maximumHopLimit - New value for the property.

setNeighborAddress

public BgpNeighbor.Builder setNeighborAddress(java.lang.String neighborAddress)

Neighbor IP Address format: ip

Parameters:

neighborAddress - New value for the property.

setPassword

public BgpNeighbor.Builder setPassword(java.lang.String password)

User can create (POST) the neighbor with or without the password. The view (GET) on the neighbor, would never reveal if the password is set or not. The password can be set later using edit neighbor workFlow (PUT) On the edit neighbor (PUT), if the user does not specify the password property, the older value is retained. Maximum length of this field is 32 characters.

Parameters:

password - New value for the property.

setRemoteAs

public BgpNeighbor.Builder setRemoteAs(java.lang.Long remoteAs)

This is a deprecated property, Please use 'remote_as_num' instead. format: int64

Parameters:

remoteAs - New value for the property.

setRemoteAsNum

public BgpNeighbor.Builder setRemoteAsNum(java.lang.String remoteAsNum)

4 Byte ASN of the neighbor in ASPLAIN/ASDOT Format

Parameters:

remoteAsNum - New value for the property.

setSourceAddress

public BgpNeighbor.Builder setSourceAddress(java.lang.String sourceAddress)

Deprecated - do not provide a value for this field. Use source_addresses instead. format: ip

Parameters:

sourceAddress - New value for the property.

setSourceAddresses

public BgpNeighbor.Builder setSourceAddresses(java.util.List<java.lang.String> sourceAddresses)

BGP neighborship will be formed from all these source addresses to this neighbour. format: ip

Parameters:

sourceAddresses - New value for the property.

build

public BgpNeighbor build()