BgpNeighbor (Java SDK for NSX Manager API 4.1.2.0.0)

java.lang.Object
- com.vmware.nsx.model.BgpNeighbor

All Implemented Interfaces:

com.vmware.vapi.bindings.StaticStructure, com.vmware.vapi.bindings.Structure, java.io.Serializable
```
public final class BgpNeighbor
extends java.lang.Object
implements java.io.Serializable, com.vmware.vapi.bindings.StaticStructure
```
See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class BgpNeighbor.Builder
Builder class for BgpNeighbor.

Nested Classes
Modifier and Type	Class and Description
`static class`	`BgpNeighbor.Builder` Builder class for `BgpNeighbor`.

Field Summary

Fields
Modifier and Type	Field and Description
`protected com.vmware.vapi.data.StructValue`	`__dynamicStructureFields`
`static java.lang.String`	`GRACEFUL_RESTART_MODE_DISABLE`
`static java.lang.String`	`GRACEFUL_RESTART_MODE_GR_AND_HELPER`
`static java.lang.String`	`GRACEFUL_RESTART_MODE_HELPER_ONLY`

Constructor Summary

Constructors
Modifier Constructor and Description

BgpNeighbor()
Default constructor.

protected BgpNeighbor(com.vmware.vapi.data.StructValue __dynamicStructureFields)

Constructors
Modifier	Constructor and Description
	`BgpNeighbor()` Default constructor.
`protected`	`BgpNeighbor(com.vmware.vapi.data.StructValue __dynamicStructureFields)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`<T extends com.vmware.vapi.bindings.Structure> T`	`_convertTo(java.lang.Class<T> clazz)`
`java.lang.String`	`_getCanonicalName()`
`static java.lang.String`	`_getCanonicalTypeName()` Returns the canonical type name.
`static com.vmware.vapi.bindings.type.StructType`	`_getClassType()` WARNING: Internal method, subject to change in future versions.
`com.vmware.vapi.data.StructValue`	`_getDataValue()`
`com.vmware.vapi.data.DataValue`	`_getDynamicField(java.lang.String fieldName)`
`java.util.Set<java.lang.String>`	`_getDynamicFieldNames()`
`com.vmware.vapi.bindings.type.StructType`	`_getType()`
`boolean`	`_hasTypeNameOf(java.lang.Class<? extends com.vmware.vapi.bindings.Structure> clazz)`
`static BgpNeighbor`	`_newInstance(com.vmware.vapi.data.StructValue structValue)` WARNING: Internal method, subject to change in future versions. Returns new instance of this binding class and injects the provided data value. WARNING: The returned object is not fully initialized.
`static BgpNeighbor`	`_newInstance2(com.vmware.vapi.data.StructValue structValue)` WARNING: Internal method, subject to change in future versions. Serves as a versioning mechanism.
`void`	`_setDynamicField(java.lang.String fieldName, com.vmware.vapi.data.DataValue fieldValue)`
`protected void`	`_updateDataValue(com.vmware.vapi.data.StructValue structValue)`
`void`	`_validate()`
`boolean`	`equals(java.lang.Object obj)`
`java.util.List<BgpNeighborAddressFamily>`	`getAddressFamilies()` User can enable the neighbor for the specific address families and also define filters per address family.
`java.lang.Boolean`	`getAllowAsIn()` Flag to enable allowas_in option for BGP neighbor
`BfdConfigParameters`	`getBfdConfig()`
`java.lang.Long`	`getCreateTime()` 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.
`java.lang.String`	`getCreateUser()` 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.
`java.lang.String`	`getDescription()` Description of this resource
`java.lang.String`	`getDisplayName()` Defaults to ID if not set
`java.lang.Boolean`	`getEnableBfd()` Flag to enable BFD for this BGP Neighbor.
`java.lang.Boolean`	`getEnabled()` Flag to enable this BGP Neighbor
`java.lang.String`	`getFilterInIpprefixlistId()` Deprecated.
`java.lang.String`	`getFilterInRoutemapId()` Deprecated.
`java.lang.String`	`getFilterOutIpprefixlistId()` Deprecated.
`java.lang.String`	`getFilterOutRoutemapId()` Deprecated.
`java.lang.String`	`getGracefulRestartMode()` Possible values are: `GRACEFUL_RESTART_MODE_DISABLE` `GRACEFUL_RESTART_MODE_HELPER_ONLY` `GRACEFUL_RESTART_MODE_GR_AND_HELPER` BGP Graceful Restart mode.
`java.lang.Long`	`getHoldDownTimer()` Wait period (seconds) before declaring peer dead format: int64
`java.lang.String`	`getId()` Unique identifier of this resource
`java.lang.Long`	`getKeepAliveTimer()` Frequency (seconds) with which keep alive messages are sent to peers format: int64
`java.lang.Long`	`getLastModifiedTime()` 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.
`java.lang.String`	`getLastModifiedUser()` 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.
`java.util.List<ResourceLink>`	`getLinks()` The server will populate this field when returing the resource.
`java.lang.String`	`getLogicalRouterId()` 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.
`java.lang.Long`	`getMaximumHopLimit()` This value is set on TTL(time to live) of BGP header.
`java.lang.String`	`getNeighborAddress()` Neighbor IP Address format: ip
`java.lang.String`	`getPassword()` User can create (POST) the neighbor with or without the password.
`java.lang.String`	`getProtection()` Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it.
`java.lang.Long`	`getRemoteAs()` Deprecated.
`java.lang.String`	`getRemoteAsNum()` 4 Byte ASN of the neighbor in ASPLAIN/ASDOT Format
`java.lang.String`	`getResourceType()` The type of this resource.
`java.lang.Long`	`getRevision()` The _revision property describes the current revision of the resource.
`java.lang.String`	`getSchema()` 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.
`SelfResourceLink`	`getSelf()`
`java.lang.String`	`getSourceAddress()` Deprecated.
`java.util.List<java.lang.String>`	`getSourceAddresses()` BGP neighborship will be formed from all these source addresses to this neighbour.
`java.lang.Boolean`	`getSystemOwned()` 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.
`java.util.List<Tag>`	`getTags()` Opaque identifiers meaningful to the API user
`int`	`hashCode()`
`void`	`setAddressFamilies(java.util.List<BgpNeighborAddressFamily> addressFamilies)` User can enable the neighbor for the specific address families and also define filters per address family.
`void`	`setAllowAsIn(java.lang.Boolean allowAsIn)` Flag to enable allowas_in option for BGP neighbor
`void`	`setBfdConfig(BfdConfigParameters bfdConfig)`
`void`	`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.
`void`	`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.
`void`	`setDescription(java.lang.String description)` Description of this resource
`void`	`setDisplayName(java.lang.String displayName)` Defaults to ID if not set
`void`	`setEnableBfd(java.lang.Boolean enableBfd)` Flag to enable BFD for this BGP Neighbor.
`void`	`setEnabled(java.lang.Boolean enabled)` Flag to enable this BGP Neighbor
`void`	`setFilterInIpprefixlistId(java.lang.String filterInIpprefixlistId)` Deprecated.
`void`	`setFilterInRoutemapId(java.lang.String filterInRoutemapId)` Deprecated.
`void`	`setFilterOutIpprefixlistId(java.lang.String filterOutIpprefixlistId)` Deprecated.
`void`	`setFilterOutRoutemapId(java.lang.String filterOutRoutemapId)` Deprecated.
`void`	`setGracefulRestartMode(java.lang.String gracefulRestartMode)` Possible values are: `GRACEFUL_RESTART_MODE_DISABLE` `GRACEFUL_RESTART_MODE_HELPER_ONLY` `GRACEFUL_RESTART_MODE_GR_AND_HELPER` BGP Graceful Restart mode.
`void`	`setHoldDownTimer(java.lang.Long holdDownTimer)` Wait period (seconds) before declaring peer dead format: int64
`void`	`setId(java.lang.String id)` Unique identifier of this resource
`void`	`setKeepAliveTimer(java.lang.Long keepAliveTimer)` Frequency (seconds) with which keep alive messages are sent to peers format: int64
`void`	`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.
`void`	`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.
`void`	`setLinks(java.util.List<ResourceLink> links)` The server will populate this field when returing the resource.
`void`	`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.
`void`	`setMaximumHopLimit(java.lang.Long maximumHopLimit)` This value is set on TTL(time to live) of BGP header.
`void`	`setNeighborAddress(java.lang.String neighborAddress)` Neighbor IP Address format: ip
`void`	`setPassword(java.lang.String password)` User can create (POST) the neighbor with or without the password.
`void`	`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.
`void`	`setRemoteAs(java.lang.Long remoteAs)` Deprecated.
`void`	`setRemoteAsNum(java.lang.String remoteAsNum)` 4 Byte ASN of the neighbor in ASPLAIN/ASDOT Format
`void`	`setResourceType(java.lang.String resourceType)` The type of this resource.
`void`	`setRevision(java.lang.Long revision)` The _revision property describes the current revision of the resource.
`void`	`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.
`void`	`setSelf(SelfResourceLink self)`
`void`	`setSourceAddress(java.lang.String sourceAddress)` Deprecated.
`void`	`setSourceAddresses(java.util.List<java.lang.String> sourceAddresses)` BGP neighborship will be formed from all these source addresses to this neighbour.
`void`	`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.
`void`	`setTags(java.util.List<Tag> tags)` Opaque identifiers meaningful to the API user
`java.lang.String`	`toString()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - GRACEFUL_RESTART_MODE_DISABLE
```
public static final java.lang.String GRACEFUL_RESTART_MODE_DISABLE
```
    See Also:
    
    Constant Field Values
  - GRACEFUL_RESTART_MODE_HELPER_ONLY
```
public static final java.lang.String GRACEFUL_RESTART_MODE_HELPER_ONLY
```
    See Also:
    
    Constant Field Values
  - GRACEFUL_RESTART_MODE_GR_AND_HELPER
```
public static final java.lang.String GRACEFUL_RESTART_MODE_GR_AND_HELPER
```
    See Also:
    
    Constant Field Values
  - __dynamicStructureFields
```
protected com.vmware.vapi.data.StructValue __dynamicStructureFields
```
- Constructor Detail
  - BgpNeighbor
```
public BgpNeighbor()
```
    Default constructor.
  - BgpNeighbor
```
protected BgpNeighbor(com.vmware.vapi.data.StructValue __dynamicStructureFields)
```
- Method Detail
  - getLinks
```
public java.util.List<ResourceLink> getLinks()
```
    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.
    
    Returns:
    
    The current value of the property.
  - setLinks
```
public void 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.
  - getSchema
```
public java.lang.String getSchema()
```
    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.
    
    Returns:
    
    The current value of the property.
  - setSchema
```
public void 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.
  - getSelf
```
public SelfResourceLink getSelf()
```
    Returns:
    
    The current value of the property.
  - setSelf
```
public void setSelf(SelfResourceLink self)
```
    Parameters:
    
    self - New value for the property.
  - getRevision
```
public java.lang.Long getRevision()
```
    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
    
    Returns:
    
    The current value of the property.
  - setRevision
```
public void 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.
  - getCreateTime
```
public java.lang.Long getCreateTime()
```
    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.
    
    Returns:
    
    The current value of the property.
  - setCreateTime
```
public void 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.
  - getCreateUser
```
public java.lang.String getCreateUser()
```
    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.
    
    Returns:
    
    The current value of the property.
  - setCreateUser
```
public void 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.
  - getLastModifiedTime
```
public java.lang.Long getLastModifiedTime()
```
    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.
    
    Returns:
    
    The current value of the property.
  - setLastModifiedTime
```
public void 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.
  - getLastModifiedUser
```
public java.lang.String getLastModifiedUser()
```
    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.
    
    Returns:
    
    The current value of the property.
  - setLastModifiedUser
```
public void 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.
  - getProtection
```
public java.lang.String getProtection()
```
    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.
    
    Returns:
    
    The current value of the property.
  - setProtection
```
public void 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.
  - getSystemOwned
```
public java.lang.Boolean getSystemOwned()
```
    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.
    
    Returns:
    
    The current value of the property.
  - setSystemOwned
```
public void 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.
  - getDescription
```
public java.lang.String getDescription()
```
    Description of this resource
    
    Returns:
    
    The current value of the property.
  - setDescription
```
public void setDescription(java.lang.String description)
```
    Description of this resource
    
    Parameters:
    
    description - New value for the property.
  - getDisplayName
```
public java.lang.String getDisplayName()
```
    Defaults to ID if not set
    
    Returns:
    
    The current value of the property.
  - setDisplayName
```
public void setDisplayName(java.lang.String displayName)
```
    Defaults to ID if not set
    
    Parameters:
    
    displayName - New value for the property.
  - getId
```
public java.lang.String getId()
```
    Unique identifier of this resource
    
    Returns:
    
    The current value of the property.
  - setId
```
public void setId(java.lang.String id)
```
    Unique identifier of this resource
    
    Parameters:
    
    id - New value for the property.
  - getResourceType
```
public java.lang.String getResourceType()
```
    The type of this resource.
    
    Returns:
    
    The current value of the property.
  - setResourceType
```
public void setResourceType(java.lang.String resourceType)
```
    The type of this resource.
    
    Parameters:
    
    resourceType - New value for the property.
  - getTags
```
public java.util.List<Tag> getTags()
```
    Opaque identifiers meaningful to the API user
    
    Returns:
    
    The current value of the property.
  - setTags
```
public void setTags(java.util.List<Tag> tags)
```
    Opaque identifiers meaningful to the API user
    
    Parameters:
    
    tags - New value for the property.
  - getAddressFamilies
```
public java.util.List<BgpNeighborAddressFamily> getAddressFamilies()
```
    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.
    
    Returns:
    
    The current value of the property.
  - setAddressFamilies
```
public void 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.
  - getAllowAsIn
```
public java.lang.Boolean getAllowAsIn()
```
    Flag to enable allowas_in option for BGP neighbor
    
    Returns:
    
    The current value of the property.
  - setAllowAsIn
```
public void setAllowAsIn(java.lang.Boolean allowAsIn)
```
    Flag to enable allowas_in option for BGP neighbor
    
    Parameters:
    
    allowAsIn - New value for the property.
  - getBfdConfig
```
public BfdConfigParameters getBfdConfig()
```
    Returns:
    
    The current value of the property.
  - setBfdConfig
```
public void setBfdConfig(BfdConfigParameters bfdConfig)
```
    Parameters:
    
    bfdConfig - New value for the property.
  - getEnableBfd
```
public java.lang.Boolean getEnableBfd()
```
    Flag to enable BFD for this BGP Neighbor. Enable this if the neighbor supports BFD as this will lead to faster convergence.
    
    Returns:
    
    The current value of the property.
  - setEnableBfd
```
public void 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.
  - getEnabled
```
public java.lang.Boolean getEnabled()
```
    Flag to enable this BGP Neighbor
    
    Returns:
    
    The current value of the property.
  - setEnabled
```
public void setEnabled(java.lang.Boolean enabled)
```
    Flag to enable this BGP Neighbor
    
    Parameters:
    
    enabled - New value for the property.
  - getFilterInIpprefixlistId
```
@Deprecated
public java.lang.String getFilterInIpprefixlistId()
```
    Deprecated.
    
    This is a deprecated property, Please use 'address_family' instead.
    
    Returns:
    
    The current value of the property.
  - setFilterInIpprefixlistId
```
@Deprecated
public void setFilterInIpprefixlistId(java.lang.String filterInIpprefixlistId)
```
    Deprecated.
    
    This is a deprecated property, Please use 'address_family' instead.
    
    Parameters:
    
    filterInIpprefixlistId - New value for the property.
  - getFilterInRoutemapId
```
@Deprecated
public java.lang.String getFilterInRoutemapId()
```
    Deprecated.
    
    This is a deprecated property, Please use 'address_family' instead.
    
    Returns:
    
    The current value of the property.
  - setFilterInRoutemapId
```
@Deprecated
public void setFilterInRoutemapId(java.lang.String filterInRoutemapId)
```
    Deprecated.
    
    This is a deprecated property, Please use 'address_family' instead.
    
    Parameters:
    
    filterInRoutemapId - New value for the property.
  - getFilterOutIpprefixlistId
```
@Deprecated
public java.lang.String getFilterOutIpprefixlistId()
```
    Deprecated.
    
    This is a deprecated property, Please use 'address_family' instead.
    
    Returns:
    
    The current value of the property.
  - setFilterOutIpprefixlistId
```
@Deprecated
public void setFilterOutIpprefixlistId(java.lang.String filterOutIpprefixlistId)
```
    Deprecated.
    
    This is a deprecated property, Please use 'address_family' instead.
    
    Parameters:
    
    filterOutIpprefixlistId - New value for the property.
  - getFilterOutRoutemapId
```
@Deprecated
public java.lang.String getFilterOutRoutemapId()
```
    Deprecated.
    
    This is a deprecated property, Please use 'address_family' instead.
    
    Returns:
    
    The current value of the property.
  - setFilterOutRoutemapId
```
@Deprecated
public void setFilterOutRoutemapId(java.lang.String filterOutRoutemapId)
```
    Deprecated.
    
    This is a deprecated property, Please use 'address_family' instead.
    
    Parameters:
    
    filterOutRoutemapId - New value for the property.
  - getGracefulRestartMode
```
public java.lang.String getGracefulRestartMode()
```
    Possible values are:
    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.
    Returns:
    
    The current value of the property.
  - setGracefulRestartMode
```
public void setGracefulRestartMode(java.lang.String gracefulRestartMode)
```
    Possible values are:
    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.
  - getHoldDownTimer
```
public java.lang.Long getHoldDownTimer()
```
    Wait period (seconds) before declaring peer dead format: int64
    
    Returns:
    
    The current value of the property.
  - setHoldDownTimer
```
public void setHoldDownTimer(java.lang.Long holdDownTimer)
```
    Wait period (seconds) before declaring peer dead format: int64
    
    Parameters:
    
    holdDownTimer - New value for the property.
  - getKeepAliveTimer
```
public java.lang.Long getKeepAliveTimer()
```
    Frequency (seconds) with which keep alive messages are sent to peers format: int64
    
    Returns:
    
    The current value of the property.
  - setKeepAliveTimer
```
public void 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.
  - getLogicalRouterId
```
public java.lang.String getLogicalRouterId()
```
    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.
    
    Returns:
    
    The current value of the property.
  - setLogicalRouterId
```
public void 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.
  - getMaximumHopLimit
```
public java.lang.Long getMaximumHopLimit()
```
    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
    
    Returns:
    
    The current value of the property.
  - setMaximumHopLimit
```
public void 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.
  - getNeighborAddress
```
public java.lang.String getNeighborAddress()
```
    Neighbor IP Address format: ip
    
    Returns:
    
    The current value of the property.
  - setNeighborAddress
```
public void setNeighborAddress(java.lang.String neighborAddress)
```
    Neighbor IP Address format: ip
    
    Parameters:
    
    neighborAddress - New value for the property.
  - getPassword
```
public java.lang.String getPassword()
```
    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.
    
    Returns:
    
    The current value of the property.
  - setPassword
```
public void 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.
  - getRemoteAs
```
@Deprecated
public java.lang.Long getRemoteAs()
```
    Deprecated.
    
    This is a deprecated property, Please use 'remote_as_num' instead. format: int64
    
    Returns:
    
    The current value of the property.
  - setRemoteAs
```
@Deprecated
public void setRemoteAs(java.lang.Long remoteAs)
```
    Deprecated.
    
    This is a deprecated property, Please use 'remote_as_num' instead. format: int64
    
    Parameters:
    
    remoteAs - New value for the property.
  - getRemoteAsNum
```
public java.lang.String getRemoteAsNum()
```
    4 Byte ASN of the neighbor in ASPLAIN/ASDOT Format
    
    Returns:
    
    The current value of the property.
  - setRemoteAsNum
```
public void setRemoteAsNum(java.lang.String remoteAsNum)
```
    4 Byte ASN of the neighbor in ASPLAIN/ASDOT Format
    
    Parameters:
    
    remoteAsNum - New value for the property.
  - getSourceAddress
```
@Deprecated
public java.lang.String getSourceAddress()
```
    Deprecated.
    
    Deprecated - do not provide a value for this field. Use source_addresses instead. format: ip
    
    Returns:
    
    The current value of the property.
  - setSourceAddress
```
@Deprecated
public void setSourceAddress(java.lang.String sourceAddress)
```
    Deprecated.
    
    Deprecated - do not provide a value for this field. Use source_addresses instead. format: ip
    
    Parameters:
    
    sourceAddress - New value for the property.
  - getSourceAddresses
```
public java.util.List<java.lang.String> getSourceAddresses()
```
    BGP neighborship will be formed from all these source addresses to this neighbour. format: ip
    
    Returns:
    
    The current value of the property.
  - setSourceAddresses
```
public void 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.
  - _getType
```
public com.vmware.vapi.bindings.type.StructType _getType()
```
    Specified by:
    
    _getType in interface com.vmware.vapi.bindings.StaticStructure
  - _getDataValue
```
public com.vmware.vapi.data.StructValue _getDataValue()
```
    Specified by:
    
    _getDataValue in interface com.vmware.vapi.bindings.Structure
  - _updateDataValue
```
protected void _updateDataValue(com.vmware.vapi.data.StructValue structValue)
```
  - _validate
```
public void _validate()
```
    Specified by:
    
    _validate in interface com.vmware.vapi.bindings.StaticStructure
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Overrides:
    
    equals in class java.lang.Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - toString
```
public java.lang.String toString()
```
    Specified by:
    
    toString in interface com.vmware.vapi.bindings.StaticStructure
    
    Overrides:
    
    toString in class java.lang.Object
  - _hasTypeNameOf
```
public boolean _hasTypeNameOf(java.lang.Class<? extends com.vmware.vapi.bindings.Structure> clazz)
```
    Specified by:
    
    _hasTypeNameOf in interface com.vmware.vapi.bindings.Structure
  - _convertTo
```
public <T extends com.vmware.vapi.bindings.Structure> T _convertTo(java.lang.Class<T> clazz)
```
    Specified by:
    
    _convertTo in interface com.vmware.vapi.bindings.Structure
  - _setDynamicField
```
public void _setDynamicField(java.lang.String fieldName,
                             com.vmware.vapi.data.DataValue fieldValue)
```
    Specified by:
    
    _setDynamicField in interface com.vmware.vapi.bindings.StaticStructure
  - _getDynamicField
```
public com.vmware.vapi.data.DataValue _getDynamicField(java.lang.String fieldName)
```
    Specified by:
    
    _getDynamicField in interface com.vmware.vapi.bindings.StaticStructure
  - _getDynamicFieldNames
```
public java.util.Set<java.lang.String> _getDynamicFieldNames()
```
    Specified by:
    
    _getDynamicFieldNames in interface com.vmware.vapi.bindings.StaticStructure
  - _getClassType
```
public static com.vmware.vapi.bindings.type.StructType _getClassType()
```
    WARNING: Internal method, subject to change in future versions.
    
    Returns:
    
    StructType instance representing the static bindings type for this Structure.
  - _getCanonicalName
```
public java.lang.String _getCanonicalName()
```
    Specified by:
    
    _getCanonicalName in interface com.vmware.vapi.bindings.Structure
  - _getCanonicalTypeName
```
public static java.lang.String _getCanonicalTypeName()
```
    Returns the canonical type name. See _getCanonicalName().
    
    Returns:
    
    canonical type name
  - _newInstance
```
public static BgpNeighbor _newInstance(com.vmware.vapi.data.StructValue structValue)
```
    WARNING: Internal method, subject to change in future versions.
    Returns new instance of this binding class and injects the provided data value.
    WARNING: The returned object is not fully initialized.
    
    Parameters:
    
    structValue - the source of the data contained in the binding object. Could contain more data than fields of this class can describe i.e. newer version of the binding object. Could be null.
    
    Returns:
    
    the static bindings StructType
  - _newInstance2
```
public static BgpNeighbor _newInstance2(com.vmware.vapi.data.StructValue structValue)
```
    WARNING: Internal method, subject to change in future versions.
    Serves as a versioning mechanism.

Class BgpNeighbor

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

GRACEFUL_RESTART_MODE_DISABLE

GRACEFUL_RESTART_MODE_HELPER_ONLY

GRACEFUL_RESTART_MODE_GR_AND_HELPER

__dynamicStructureFields

Constructor Detail

BgpNeighbor

BgpNeighbor

Method Detail

getLinks

setLinks

getSchema

setSchema

getSelf

setSelf

getRevision

setRevision

getCreateTime

setCreateTime

getCreateUser

setCreateUser

getLastModifiedTime

setLastModifiedTime

getLastModifiedUser

setLastModifiedUser

getProtection

setProtection

getSystemOwned

setSystemOwned

getDescription

setDescription

getDisplayName

setDisplayName

getId

setId

getResourceType

setResourceType

getTags

setTags

getAddressFamilies

setAddressFamilies

getAllowAsIn

setAllowAsIn

getBfdConfig

setBfdConfig

getEnableBfd

setEnableBfd

getEnabled

setEnabled

getFilterInIpprefixlistId

setFilterInIpprefixlistId

getFilterInRoutemapId

setFilterInRoutemapId

getFilterOutIpprefixlistId

setFilterOutIpprefixlistId

getFilterOutRoutemapId

setFilterOutRoutemapId

getGracefulRestartMode

setGracefulRestartMode

getHoldDownTimer

setHoldDownTimer

getKeepAliveTimer

setKeepAliveTimer

getLogicalRouterId

setLogicalRouterId

getMaximumHopLimit

setMaximumHopLimit

getNeighborAddress

setNeighborAddress

getPassword

setPassword

getRemoteAs

setRemoteAs

getRemoteAsNum