java.lang.Object
- com.softlayer.api.Type
- - com.softlayer.api.service.Entity
  - - com.softlayer.api.service.network.application.delivery.controller.loadbalancer.VirtualIpAddress

@ApiType("SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress")
public class VirtualIpAddress
extends Entity

See Also:: SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`static class`	`VirtualIpAddress.Mask`
`static interface`	`VirtualIpAddress.Service`
`static interface`	`VirtualIpAddress.ServiceAsync`

Field Summary

Fields
Modifier and Type	Field	Description
`protected Account`	`account`
`protected Long`	`accountId`	The unique identifier of the SoftLayer customer account that owns the virtual IP address
`protected boolean`	`accountIdSpecified`
`protected Controller`	`applicationDeliveryController`	A virtual IP address's associated application delivery controller.
`protected Long`	`applicationDeliveryControllerCount`	A count of a virtual IP address's associated application delivery controllers.
`protected List<Controller>`	`applicationDeliveryControllers`	A virtual IP address's associated application delivery controllers.
`protected Item`	`billingItem`	The current billing item for the load balancer virtual IP.
`protected Long`	`connectionLimit`	The connection limit for this virtual IP address
`protected boolean`	`connectionLimitSpecified`
`protected String`	`connectionLimitUnits`	The units for the connection limit
`protected boolean`	`connectionLimitUnitsSpecified`
`protected LoadBalancer`	`dedicatedBillingItem`	The current billing item for the load balancing device housing the virtual IP.
`protected Boolean`	`dedicatedFlag`	A flag that determines if a VIP is dedicated or not.
`protected boolean`	`dedicatedFlagSpecified`
`protected Boolean`	`highAvailabilityFlag`	Denotes whether the virtual IP is configured within a high availability cluster.
`protected Long`	`id`	The unique identifier of the virtual IP address record
`protected boolean`	`idSpecified`
`protected IpAddress`	`ipAddress`
`protected Long`	`ipAddressId`	ID of the IP address this virtual IP utilizes
`protected boolean`	`ipAddressIdSpecified`
`protected List<Hardware>`	`loadBalancerHardware`
`protected Long`	`loadBalancerHardwareCount`	A count of
`protected Boolean`	`managedResourceFlag`	A flag indicating that the load balancer is a managed resource.
`protected String`	`notes`	User-created notes for this load balancer virtual IP address
`protected boolean`	`notesSpecified`
`protected Long`	`secureTransportCipherCount`	A count of the list of security ciphers enabled for this virtual IP address
`protected List<SecureTransportCipher>`	`secureTransportCiphers`	The list of security ciphers enabled for this virtual IP address
`protected Long`	`secureTransportProtocolCount`	A count of the list of secure transport protocols enabled for this virtual IP address
`protected List<SecureTransportProtocol>`	`secureTransportProtocols`	The list of secure transport protocols enabled for this virtual IP address
`protected Certificate`	`securityCertificate`	The SSL certificate currently associated with the VIP.
`protected Entry`	`securityCertificateEntry`	The SSL certificate currently associated with the VIP.
`protected Long`	`securityCertificateId`	The unique identifier of the Security Certificate to be utilized when SSL support is enabled.
`protected boolean`	`securityCertificateIdSpecified`
`protected Boolean`	`sslActiveFlag`	Determines if the VIP currently has SSL acceleration enabled
`protected boolean`	`sslActiveFlagSpecified`
`protected Boolean`	`sslEnabledFlag`	Determines if the VIP is _allowed_ to utilize SSL acceleration
`protected boolean`	`sslEnabledFlagSpecified`
`protected Long`	`virtualServerCount`	A count of
`protected List<VirtualServer>`	`virtualServers`

Fields inherited from class com.softlayer.api.Type
unknownProperties

Constructor Summary

Constructors
Constructor Description

VirtualIpAddress()

Method Summary

Modifier and Type	Method	Description
`VirtualIpAddress.Service`	`asService(ApiClient client)`
`Account`	`getAccount()`
`Long`	`getAccountId()`
`Controller`	`getApplicationDeliveryController()`
`Long`	`getApplicationDeliveryControllerCount()`
`List<Controller>`	`getApplicationDeliveryControllers()`
`Item`	`getBillingItem()`
`Long`	`getConnectionLimit()`
`String`	`getConnectionLimitUnits()`
`LoadBalancer`	`getDedicatedBillingItem()`
`Boolean`	`getDedicatedFlag()`
`Boolean`	`getHighAvailabilityFlag()`
`Long`	`getId()`
`IpAddress`	`getIpAddress()`
`Long`	`getIpAddressId()`
`List<Hardware>`	`getLoadBalancerHardware()`
`Long`	`getLoadBalancerHardwareCount()`
`Boolean`	`getManagedResourceFlag()`
`String`	`getNotes()`
`Long`	`getSecureTransportCipherCount()`
`List<SecureTransportCipher>`	`getSecureTransportCiphers()`
`Long`	`getSecureTransportProtocolCount()`
`List<SecureTransportProtocol>`	`getSecureTransportProtocols()`
`Certificate`	`getSecurityCertificate()`
`Entry`	`getSecurityCertificateEntry()`
`Long`	`getSecurityCertificateId()`
`Boolean`	`getSslActiveFlag()`
`Boolean`	`getSslEnabledFlag()`
`Long`	`getVirtualServerCount()`
`List<VirtualServer>`	`getVirtualServers()`
`boolean`	`isAccountIdSpecified()`
`boolean`	`isConnectionLimitSpecified()`
`boolean`	`isConnectionLimitUnitsSpecified()`
`boolean`	`isDedicatedFlagSpecified()`
`boolean`	`isIdSpecified()`
`boolean`	`isIpAddressIdSpecified()`
`boolean`	`isNotesSpecified()`
`boolean`	`isSecurityCertificateIdSpecified()`
`boolean`	`isSslActiveFlagSpecified()`
`boolean`	`isSslEnabledFlagSpecified()`
`static VirtualIpAddress.Service`	`service(ApiClient client)`
`static VirtualIpAddress.Service`	`service(ApiClient client, Long id)`
`void`	`setAccount(Account account)`
`void`	`setAccountId(Long accountId)`
`void`	`setApplicationDeliveryController(Controller applicationDeliveryController)`
`void`	`setApplicationDeliveryControllerCount(Long applicationDeliveryControllerCount)`
`void`	`setBillingItem(Item billingItem)`
`void`	`setConnectionLimit(Long connectionLimit)`
`void`	`setConnectionLimitUnits(String connectionLimitUnits)`
`void`	`setDedicatedBillingItem(LoadBalancer dedicatedBillingItem)`
`void`	`setDedicatedFlag(Boolean dedicatedFlag)`
`void`	`setHighAvailabilityFlag(Boolean highAvailabilityFlag)`
`void`	`setId(Long id)`
`void`	`setIpAddress(IpAddress ipAddress)`
`void`	`setIpAddressId(Long ipAddressId)`
`void`	`setLoadBalancerHardwareCount(Long loadBalancerHardwareCount)`
`void`	`setManagedResourceFlag(Boolean managedResourceFlag)`
`void`	`setNotes(String notes)`
`void`	`setSecureTransportCipherCount(Long secureTransportCipherCount)`
`void`	`setSecureTransportProtocolCount(Long secureTransportProtocolCount)`
`void`	`setSecurityCertificate(Certificate securityCertificate)`
`void`	`setSecurityCertificateEntry(Entry securityCertificateEntry)`
`void`	`setSecurityCertificateId(Long securityCertificateId)`
`void`	`setSslActiveFlag(Boolean sslActiveFlag)`
`void`	`setSslEnabledFlag(Boolean sslEnabledFlag)`
`void`	`setVirtualServerCount(Long virtualServerCount)`
`void`	`unsetAccountId()`
`void`	`unsetConnectionLimit()`
`void`	`unsetConnectionLimitUnits()`
`void`	`unsetDedicatedFlag()`
`void`	`unsetId()`
`void`	`unsetIpAddressId()`
`void`	`unsetNotes()`
`void`	`unsetSecurityCertificateId()`
`void`	`unsetSslActiveFlag()`
`void`	`unsetSslEnabledFlag()`

Methods inherited from class com.softlayer.api.Type
getUnknownProperties, setUnknownProperties

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

Field Detail
- account
```
@ApiProperty
protected Account account
```
- applicationDeliveryController
```
@ApiProperty
protected Controller applicationDeliveryController
```
  A virtual IP address's associated application delivery controller.
- applicationDeliveryControllers
```
@ApiProperty
protected List<Controller> applicationDeliveryControllers
```
  A virtual IP address's associated application delivery controllers.
- billingItem
```
@ApiProperty
protected Item billingItem
```
  The current billing item for the load balancer virtual IP. This is only valid when dedicatedFlag is false. This is an independent virtual IP, and if canceled, will only affect the associated virtual IP.
- dedicatedBillingItem
```
@ApiProperty
protected LoadBalancer dedicatedBillingItem
```
  The current billing item for the load balancing device housing the virtual IP. This billing item represents a device which could contain other virtual IPs. Caution should be taken when canceling. This is only valid when dedicatedFlag is true.
- highAvailabilityFlag
```
@ApiProperty
protected Boolean highAvailabilityFlag
```
  Denotes whether the virtual IP is configured within a high availability cluster.
- ipAddress
```
@ApiProperty
protected IpAddress ipAddress
```
- loadBalancerHardware
```
@ApiProperty
protected List<Hardware> loadBalancerHardware
```
- managedResourceFlag
```
@ApiProperty
protected Boolean managedResourceFlag
```
  A flag indicating that the load balancer is a managed resource.
- secureTransportCiphers
```
@ApiProperty
protected List<SecureTransportCipher> secureTransportCiphers
```
  The list of security ciphers enabled for this virtual IP address
- secureTransportProtocols
```
@ApiProperty
protected List<SecureTransportProtocol> secureTransportProtocols
```
  The list of secure transport protocols enabled for this virtual IP address
- securityCertificate
```
@ApiProperty
protected Certificate securityCertificate
```
  The SSL certificate currently associated with the VIP.
- securityCertificateEntry
```
@ApiProperty
protected Entry securityCertificateEntry
```
  The SSL certificate currently associated with the VIP. Provides chosen certificate visibility to unprivileged users.
- virtualServers
```
@ApiProperty
protected List<VirtualServer> virtualServers
```
- accountId
```
@ApiProperty(canBeNullOrNotSet=true)
protected Long accountId
```
  The unique identifier of the SoftLayer customer account that owns the virtual IP address
- accountIdSpecified
```
protected boolean accountIdSpecified
```
- connectionLimit
```
@ApiProperty(canBeNullOrNotSet=true)
protected Long connectionLimit
```
  The connection limit for this virtual IP address
- connectionLimitSpecified
```
protected boolean connectionLimitSpecified
```
- connectionLimitUnits
```
@ApiProperty(canBeNullOrNotSet=true)
protected String connectionLimitUnits
```
  The units for the connection limit
- connectionLimitUnitsSpecified
```
protected boolean connectionLimitUnitsSpecified
```
- dedicatedFlag
```
@ApiProperty(canBeNullOrNotSet=true)
protected Boolean dedicatedFlag
```
  A flag that determines if a VIP is dedicated or not. This is used to override the connection limit and use an unlimited value.
- dedicatedFlagSpecified
```
protected boolean dedicatedFlagSpecified
```
- id
```
@ApiProperty(canBeNullOrNotSet=true)
protected Long id
```
  The unique identifier of the virtual IP address record
- idSpecified
```
protected boolean idSpecified
```
- ipAddressId
```
@ApiProperty(canBeNullOrNotSet=true)
protected Long ipAddressId
```
  ID of the IP address this virtual IP utilizes
- ipAddressIdSpecified
```
protected boolean ipAddressIdSpecified
```
- notes
```
@ApiProperty(canBeNullOrNotSet=true)
protected String notes
```
  User-created notes for this load balancer virtual IP address
- notesSpecified
```
protected boolean notesSpecified
```
- securityCertificateId
```
@ApiProperty(canBeNullOrNotSet=true)
protected Long securityCertificateId
```
  The unique identifier of the Security Certificate to be utilized when SSL support is enabled.
- securityCertificateIdSpecified
```
protected boolean securityCertificateIdSpecified
```
- sslActiveFlag
```
@ApiProperty(canBeNullOrNotSet=true)
protected Boolean sslActiveFlag
```
  Determines if the VIP currently has SSL acceleration enabled
- sslActiveFlagSpecified
```
protected boolean sslActiveFlagSpecified
```
- sslEnabledFlag
```
@ApiProperty(canBeNullOrNotSet=true)
protected Boolean sslEnabledFlag
```
  Determines if the VIP is _allowed_ to utilize SSL acceleration
- sslEnabledFlagSpecified
```
protected boolean sslEnabledFlagSpecified
```
- applicationDeliveryControllerCount
```
@ApiProperty
protected Long applicationDeliveryControllerCount
```
  A count of a virtual IP address's associated application delivery controllers.
- loadBalancerHardwareCount
```
@ApiProperty
protected Long loadBalancerHardwareCount
```
  A count of
- secureTransportCipherCount
```
@ApiProperty
protected Long secureTransportCipherCount
```
  A count of the list of security ciphers enabled for this virtual IP address
- secureTransportProtocolCount
```
@ApiProperty
protected Long secureTransportProtocolCount
```
  A count of the list of secure transport protocols enabled for this virtual IP address
- virtualServerCount
```
@ApiProperty
protected Long virtualServerCount
```
  A count of

Constructor Detail
- VirtualIpAddress
```
public VirtualIpAddress()
```

Method Detail

getAccount
```
public Account getAccount()
```

setAccount

public void setAccount(Account account)

getApplicationDeliveryController

public Controller getApplicationDeliveryController()

setApplicationDeliveryController

public void setApplicationDeliveryController(Controller applicationDeliveryController)

getApplicationDeliveryControllers

public List<Controller> getApplicationDeliveryControllers()

getBillingItem
```
public Item getBillingItem()
```

setBillingItem

public void setBillingItem(Item billingItem)

getDedicatedBillingItem

public LoadBalancer getDedicatedBillingItem()

setDedicatedBillingItem

public void setDedicatedBillingItem(LoadBalancer dedicatedBillingItem)

getHighAvailabilityFlag

public Boolean getHighAvailabilityFlag()

setHighAvailabilityFlag

public void setHighAvailabilityFlag(Boolean highAvailabilityFlag)

getIpAddress
```
public IpAddress getIpAddress()
```

setIpAddress

public void setIpAddress(IpAddress ipAddress)

getLoadBalancerHardware

public List<Hardware> getLoadBalancerHardware()

getManagedResourceFlag

public Boolean getManagedResourceFlag()

setManagedResourceFlag

public void setManagedResourceFlag(Boolean managedResourceFlag)

getSecureTransportCiphers

public List<SecureTransportCipher> getSecureTransportCiphers()

getSecureTransportProtocols

public List<SecureTransportProtocol> getSecureTransportProtocols()

getSecurityCertificate

public Certificate getSecurityCertificate()

setSecurityCertificate

public void setSecurityCertificate(Certificate securityCertificate)

getSecurityCertificateEntry

public Entry getSecurityCertificateEntry()

setSecurityCertificateEntry

public void setSecurityCertificateEntry(Entry securityCertificateEntry)

getVirtualServers

public List<VirtualServer> getVirtualServers()

getAccountId
```
public Long getAccountId()
```

setAccountId

public void setAccountId(Long accountId)

isAccountIdSpecified
```
public boolean isAccountIdSpecified()
```

unsetAccountId
```
public void unsetAccountId()
```

getConnectionLimit
```
public Long getConnectionLimit()
```

setConnectionLimit

public void setConnectionLimit(Long connectionLimit)

isConnectionLimitSpecified

public boolean isConnectionLimitSpecified()

unsetConnectionLimit
```
public void unsetConnectionLimit()
```

getConnectionLimitUnits

public String getConnectionLimitUnits()

setConnectionLimitUnits

public void setConnectionLimitUnits(String connectionLimitUnits)

isConnectionLimitUnitsSpecified

public boolean isConnectionLimitUnitsSpecified()

unsetConnectionLimitUnits

public void unsetConnectionLimitUnits()

getDedicatedFlag
```
public Boolean getDedicatedFlag()
```

setDedicatedFlag

public void setDedicatedFlag(Boolean dedicatedFlag)

isDedicatedFlagSpecified

public boolean isDedicatedFlagSpecified()

unsetDedicatedFlag
```
public void unsetDedicatedFlag()
```

getId
```
public Long getId()
```

setId
```
public void setId(Long id)
```

isIdSpecified
```
public boolean isIdSpecified()
```

unsetId
```
public void unsetId()
```

getIpAddressId
```
public Long getIpAddressId()
```

setIpAddressId

public void setIpAddressId(Long ipAddressId)

isIpAddressIdSpecified

public boolean isIpAddressIdSpecified()

unsetIpAddressId
```
public void unsetIpAddressId()
```

getNotes
```
public String getNotes()
```

setNotes

public void setNotes(String notes)

isNotesSpecified
```
public boolean isNotesSpecified()
```

unsetNotes
```
public void unsetNotes()
```

getSecurityCertificateId

public Long getSecurityCertificateId()

setSecurityCertificateId

public void setSecurityCertificateId(Long securityCertificateId)

isSecurityCertificateIdSpecified

public boolean isSecurityCertificateIdSpecified()

unsetSecurityCertificateId

public void unsetSecurityCertificateId()

getSslActiveFlag
```
public Boolean getSslActiveFlag()
```

setSslActiveFlag

public void setSslActiveFlag(Boolean sslActiveFlag)

isSslActiveFlagSpecified

public boolean isSslActiveFlagSpecified()

unsetSslActiveFlag
```
public void unsetSslActiveFlag()
```

getSslEnabledFlag
```
public Boolean getSslEnabledFlag()
```

setSslEnabledFlag

public void setSslEnabledFlag(Boolean sslEnabledFlag)

isSslEnabledFlagSpecified

public boolean isSslEnabledFlagSpecified()

unsetSslEnabledFlag
```
public void unsetSslEnabledFlag()
```

getApplicationDeliveryControllerCount

public Long getApplicationDeliveryControllerCount()

setApplicationDeliveryControllerCount

public void setApplicationDeliveryControllerCount(Long applicationDeliveryControllerCount)

getLoadBalancerHardwareCount

public Long getLoadBalancerHardwareCount()

setLoadBalancerHardwareCount

public void setLoadBalancerHardwareCount(Long loadBalancerHardwareCount)

getSecureTransportCipherCount

public Long getSecureTransportCipherCount()

setSecureTransportCipherCount

public void setSecureTransportCipherCount(Long secureTransportCipherCount)

getSecureTransportProtocolCount

public Long getSecureTransportProtocolCount()

setSecureTransportProtocolCount

public void setSecureTransportProtocolCount(Long secureTransportProtocolCount)

getVirtualServerCount
```
public Long getVirtualServerCount()
```

setVirtualServerCount

public void setVirtualServerCount(Long virtualServerCount)

asService

public VirtualIpAddress.Service asService(ApiClient client)

service

public static VirtualIpAddress.Service service(ApiClient client)

service

public static VirtualIpAddress.Service service(ApiClient client,
                                               Long id)

Class VirtualIpAddress

Nested Class Summary

Field Summary

Fields inherited from class com.softlayer.api.Type

Constructor Summary

Method Summary

Methods inherited from class com.softlayer.api.Type

Methods inherited from class java.lang.Object

Field Detail

account

applicationDeliveryController

applicationDeliveryControllers

billingItem

dedicatedBillingItem

highAvailabilityFlag

ipAddress

loadBalancerHardware

managedResourceFlag

secureTransportCiphers

secureTransportProtocols

securityCertificate

securityCertificateEntry

virtualServers

accountId

accountIdSpecified

connectionLimit

connectionLimitSpecified

connectionLimitUnits

connectionLimitUnitsSpecified

dedicatedFlag

dedicatedFlagSpecified

id

idSpecified

ipAddressId

ipAddressIdSpecified

notes

notesSpecified

securityCertificateId

securityCertificateIdSpecified

sslActiveFlag

sslActiveFlagSpecified

sslEnabledFlag

sslEnabledFlagSpecified

applicationDeliveryControllerCount

loadBalancerHardwareCount

secureTransportCipherCount

secureTransportProtocolCount

virtualServerCount

Constructor Detail

VirtualIpAddress

Method Detail

getAccount

setAccount

getApplicationDeliveryController

setApplicationDeliveryController

getApplicationDeliveryControllers

getBillingItem

setBillingItem

getDedicatedBillingItem

setDedicatedBillingItem

getHighAvailabilityFlag

setHighAvailabilityFlag

getIpAddress

setIpAddress

getLoadBalancerHardware

getManagedResourceFlag

setManagedResourceFlag

getSecureTransportCiphers

getSecureTransportProtocols

getSecurityCertificate

setSecurityCertificate

getSecurityCertificateEntry

setSecurityCertificateEntry

getVirtualServers

getAccountId

setAccountId

isAccountIdSpecified

unsetAccountId

getConnectionLimit

setConnectionLimit