Package com.vmware.nsx_policy.model
Class BgpNeighborConfig.Builder
- java.lang.Object
-
- com.vmware.nsx_policy.model.BgpNeighborConfig.Builder
-
- Enclosing class:
- BgpNeighborConfig
public static final class BgpNeighborConfig.Builder extends java.lang.ObjectBuilder class forBgpNeighborConfig.
-
-
Constructor Summary
Constructors Constructor Description Builder()Constructor with parameters for the required properties ofBgpNeighborConfig.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description BgpNeighborConfigbuild()BgpNeighborConfig.BuildersetAllowAsIn(java.lang.Boolean allowAsIn)Flag to enable allowas_in option for BGP neighborBgpNeighborConfig.BuildersetBfd(BgpBfdConfig bfd)BgpNeighborConfig.BuildersetChildren(java.util.List<com.vmware.vapi.bindings.Structure> children)Subtree for this type within policy tree containing nested elements.BgpNeighborConfig.BuildersetCreateTime(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.BgpNeighborConfig.BuildersetCreateUser(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.BgpNeighborConfig.BuildersetDescription(java.lang.String description)Description of this resourceBgpNeighborConfig.BuildersetDisplayName(java.lang.String displayName)Defaults to ID if not setBgpNeighborConfig.BuildersetEnabled(java.lang.Boolean enabled)Flag to enable/disable BGP peering.BgpNeighborConfig.BuildersetGracefulRestartMode(java.lang.String gracefulRestartMode)Possible values are:BgpNeighborConfig.GRACEFUL_RESTART_MODE_DISABLEBgpNeighborConfig.GRACEFUL_RESTART_MODE_GR_AND_HELPERBgpNeighborConfig.GRACEFUL_RESTART_MODE_HELPER_ONLYIf mode is DISABLE, then graceful restart and helper modes are disabled.BgpNeighborConfig.BuildersetHoldDownTime(java.lang.Long holdDownTime)Wait time in seconds before declaring peer dead.BgpNeighborConfig.BuildersetId(java.lang.String id)Unique identifier of this resourceBgpNeighborConfig.BuildersetInRouteFilters(java.util.List<java.lang.String> inRouteFilters)Specify path of prefix-list or route map to filter routes for IN direction.BgpNeighborConfig.BuildersetKeepAliveTime(java.lang.Long keepAliveTime)Interval (in seconds) between keep alive messages sent to peer.BgpNeighborConfig.BuildersetLastModifiedTime(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.BgpNeighborConfig.BuildersetLastModifiedUser(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.BgpNeighborConfig.BuildersetLinks(java.util.List<ResourceLink> links)The server will populate this field when returing the resource.BgpNeighborConfig.BuildersetMarkedForDelete(java.lang.Boolean markedForDelete)Intent objects are not directly deleted from the system when a delete is invoked on them.BgpNeighborConfig.BuildersetMaximumHopLimit(java.lang.Long maximumHopLimit)Maximum number of hops allowed to reach BGP neighbor.BgpNeighborConfig.BuildersetNeighborAddress(java.lang.String neighborAddress)Neighbor IP Address format: ipBgpNeighborConfig.BuildersetNeighborLocalAsConfig(BgpNeighborLocalAsConfig neighborLocalAsConfig)BgpNeighborConfig.BuildersetOriginSiteId(java.lang.String originSiteId)This is a UUID generated by the system for knowing which site owns an object.BgpNeighborConfig.BuildersetOutRouteFilters(java.util.List<java.lang.String> outRouteFilters)Specify path of prefix-list or route map to filter routes for OUT direction.BgpNeighborConfig.BuildersetOverridden(java.lang.Boolean overridden)Global intent objects cannot be modified by the user.BgpNeighborConfig.BuildersetOwnerId(java.lang.String ownerId)This is a UUID generated by the system for knowing who owns this object.BgpNeighborConfig.BuildersetParentPath(java.lang.String parentPath)Path of its parent This property may be present in responses from the server, but if it is present in a request to server it will be ignored.BgpNeighborConfig.BuildersetPassword(java.lang.String password)Specify password for BGP neighbor authentication.BgpNeighborConfig.BuildersetPath(java.lang.String path)Absolute path of this object This property may be present in responses from the server, but if it is present in a request to server it will be ignored.BgpNeighborConfig.BuildersetProtection(java.lang.String protection)Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it.BgpNeighborConfig.BuildersetRealizationId(java.lang.String realizationId)This is a UUID generated by the system for realizing the entity object.BgpNeighborConfig.BuildersetRelativePath(java.lang.String relativePath)Path relative from its parent This property may be present in responses from the server, but if it is present in a request to server it will be ignored.BgpNeighborConfig.BuildersetRemoteAsNum(java.lang.String remoteAsNum)4 Byte ASN of the neighbor in ASPLAIN FormatBgpNeighborConfig.BuildersetRemotePath(java.lang.String remotePath)This is the path of the object on the local managers when queried on the NSX+ service, and path of the object on NSX+ service when queried from the local managers.BgpNeighborConfig.BuildersetResourceType(java.lang.String resourceType)The type of this resource.BgpNeighborConfig.BuildersetRevision(java.lang.Long revision)The _revision property describes the current revision of the resource.BgpNeighborConfig.BuildersetRouteFiltering(java.util.List<BgpRouteFiltering> routeFiltering)Enable address families and route filtering in each direction.BgpNeighborConfig.BuildersetSchema(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.BgpNeighborConfig.BuildersetSelf(SelfResourceLink self)BgpNeighborConfig.BuildersetSourceAddresses(java.util.List<java.lang.String> sourceAddresses)Source addresses should belong to Tier0 external or loopback or VTI interface IP Addresses .BgpNeighborConfig.BuildersetSystemOwned(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.BgpNeighborConfig.BuildersetTags(java.util.List<Tag> tags)Opaque identifiers meaningful to the API userBgpNeighborConfig.BuildersetUniqueId(java.lang.String uniqueId)This is a UUID generated by the GM/LM to uniquely identify entities in a federated environment.
-
-
-
Constructor Detail
-
Builder
public Builder()
Constructor with parameters for the required properties ofBgpNeighborConfig.
-
-
Method Detail
-
setLinks
public BgpNeighborConfig.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 BgpNeighborConfig.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 BgpNeighborConfig.Builder setSelf(SelfResourceLink self)
- Parameters:
self- New value for the property.
-
setRevision
public BgpNeighborConfig.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 BgpNeighborConfig.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 BgpNeighborConfig.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 BgpNeighborConfig.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 BgpNeighborConfig.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 BgpNeighborConfig.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 BgpNeighborConfig.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 BgpNeighborConfig.Builder setDescription(java.lang.String description)
Description of this resource- Parameters:
description- New value for the property.
-
setDisplayName
public BgpNeighborConfig.Builder setDisplayName(java.lang.String displayName)
Defaults to ID if not set- Parameters:
displayName- New value for the property.
-
setId
public BgpNeighborConfig.Builder setId(java.lang.String id)
Unique identifier of this resource- Parameters:
id- New value for the property.
-
setResourceType
public BgpNeighborConfig.Builder setResourceType(java.lang.String resourceType)
The type of this resource.- Parameters:
resourceType- New value for the property.
-
setTags
public BgpNeighborConfig.Builder setTags(java.util.List<Tag> tags)
Opaque identifiers meaningful to the API user- Parameters:
tags- New value for the property.
-
setOriginSiteId
public BgpNeighborConfig.Builder setOriginSiteId(java.lang.String originSiteId)
This is a UUID generated by the system for knowing which site owns an object. This is used in NSX+. 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:
originSiteId- New value for the property.
-
setOwnerId
public BgpNeighborConfig.Builder setOwnerId(java.lang.String ownerId)
This is a UUID generated by the system for knowing who owns this object. This is used in NSX+. 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:
ownerId- New value for the property.
-
setParentPath
public BgpNeighborConfig.Builder setParentPath(java.lang.String parentPath)
Path of its parent 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:
parentPath- New value for the property.
-
setPath
public BgpNeighborConfig.Builder setPath(java.lang.String path)
Absolute path of this object 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:
path- New value for the property.
-
setRealizationId
public BgpNeighborConfig.Builder setRealizationId(java.lang.String realizationId)
This is a UUID generated by the system for realizing the entity object. In most cases this should be same as 'unique_id' of the entity. However, in some cases this can be different because of entities have migrated their unique identifier to NSX Policy intent objects later in the timeline and did not use unique_id for realization. Realization id is helpful for users to debug data path to correlate the configuration with corresponding intent. 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:
realizationId- New value for the property.
-
setRelativePath
public BgpNeighborConfig.Builder setRelativePath(java.lang.String relativePath)
Path relative from its parent 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:
relativePath- New value for the property.
-
setRemotePath
public BgpNeighborConfig.Builder setRemotePath(java.lang.String remotePath)
This is the path of the object on the local managers when queried on the NSX+ service, and path of the object on NSX+ service when queried from the local managers. 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:
remotePath- New value for the property.
-
setUniqueId
public BgpNeighborConfig.Builder setUniqueId(java.lang.String uniqueId)
This is a UUID generated by the GM/LM to uniquely identify entities in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites. 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:
uniqueId- New value for the property.
-
setChildren
public BgpNeighborConfig.Builder setChildren(java.util.List<com.vmware.vapi.bindings.Structure> children)
Subtree for this type within policy tree containing nested elements. Note that this type is applicable to be used in Hierarchical API only.- Parameters:
children- New value for the property. When clients pass a value of this class as a parameter, the property must contain all the properties defined inChildPolicyConfigResource. When methods return a value of this class as a return value, the property will contain all the properties defined inChildPolicyConfigResource.
-
setMarkedForDelete
public BgpNeighborConfig.Builder setMarkedForDelete(java.lang.Boolean markedForDelete)
Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects. 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:
markedForDelete- New value for the property.
-
setOverridden
public BgpNeighborConfig.Builder setOverridden(java.lang.Boolean overridden)
Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties. 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:
overridden- New value for the property.
-
setAllowAsIn
public BgpNeighborConfig.Builder setAllowAsIn(java.lang.Boolean allowAsIn)
Flag to enable allowas_in option for BGP neighbor- Parameters:
allowAsIn- New value for the property.
-
setBfd
public BgpNeighborConfig.Builder setBfd(BgpBfdConfig bfd)
- Parameters:
bfd- New value for the property.
-
setEnabled
public BgpNeighborConfig.Builder setEnabled(java.lang.Boolean enabled)
Flag to enable/disable BGP peering. Disabling will stop the BGP peering. True - indicates enable BGP peering, False - indicates disable BGP peering. Default is True.- Parameters:
enabled- New value for the property.
-
setGracefulRestartMode
public BgpNeighborConfig.Builder setGracefulRestartMode(java.lang.String gracefulRestartMode)
Possible values are: If mode is DISABLE, then graceful restart and helper modes are disabled. If mode is GR_AND_HELPER, then both graceful restart and helper modes are enabled. If mode is HELPER_ONLY, then helper mode is enabled. HELPER_ONLY mode is the ability for a BGP speaker to indicate its ability to preserve forwarding state during BGP restart. GRACEFUL_RESTART mode is the ability of a BGP speaker to advertise its restart to its peers.- Parameters:
gracefulRestartMode- New value for the property.
-
setHoldDownTime
public BgpNeighborConfig.Builder setHoldDownTime(java.lang.Long holdDownTime)
Wait time in seconds before declaring peer dead. format: int32- Parameters:
holdDownTime- New value for the property.
-
setInRouteFilters
public BgpNeighborConfig.Builder setInRouteFilters(java.util.List<java.lang.String> inRouteFilters)
Specify path of prefix-list or route map to filter routes for IN direction. This property is deprecated, use route_filtering instead. Specifying different values for both properties will result in error.- Parameters:
inRouteFilters- New value for the property.
-
setKeepAliveTime
public BgpNeighborConfig.Builder setKeepAliveTime(java.lang.Long keepAliveTime)
Interval (in seconds) between keep alive messages sent to peer. format: int32- Parameters:
keepAliveTime- New value for the property.
-
setMaximumHopLimit
public BgpNeighborConfig.Builder setMaximumHopLimit(java.lang.Long maximumHopLimit)
Maximum number of hops allowed to reach BGP neighbor. format: int32- Parameters:
maximumHopLimit- New value for the property.
-
setNeighborAddress
public BgpNeighborConfig.Builder setNeighborAddress(java.lang.String neighborAddress)
Neighbor IP Address format: ip- Parameters:
neighborAddress- New value for the property.
-
setNeighborLocalAsConfig
public BgpNeighborConfig.Builder setNeighborLocalAsConfig(BgpNeighborLocalAsConfig neighborLocalAsConfig)
- Parameters:
neighborLocalAsConfig- New value for the property.
-
setOutRouteFilters
public BgpNeighborConfig.Builder setOutRouteFilters(java.util.List<java.lang.String> outRouteFilters)
Specify path of prefix-list or route map to filter routes for OUT direction. When not specified, a built-in prefix-list named 'prefixlist-out-default' is automatically applied. This property is deprecated, use route_filtering instead. Specifying different values for both properties will result in error.- Parameters:
outRouteFilters- New value for the property.
-
setPassword
public BgpNeighborConfig.Builder setPassword(java.lang.String password)
Specify password for BGP neighbor authentication. Empty string (\"\") clears existing password.- Parameters:
password- New value for the property.
-
setRemoteAsNum
public BgpNeighborConfig.Builder setRemoteAsNum(java.lang.String remoteAsNum)
4 Byte ASN of the neighbor in ASPLAIN Format- Parameters:
remoteAsNum- New value for the property.
-
setRouteFiltering
public BgpNeighborConfig.Builder setRouteFiltering(java.util.List<BgpRouteFiltering> routeFiltering)
Enable address families and route filtering in each direction.- Parameters:
routeFiltering- New value for the property.
-
setSourceAddresses
public BgpNeighborConfig.Builder setSourceAddresses(java.util.List<java.lang.String> sourceAddresses)
Source addresses should belong to Tier0 external or loopback or VTI interface IP Addresses . BGP peering is formed from all these addresses. This property is mandatory when maximum_hop_limit is greater than 1. format: ip- Parameters:
sourceAddresses- New value for the property.
-
build
public BgpNeighborConfig build()
-
-