com.softlayer.api.service.network.loadbalancer.VirtualIpAddress

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

The SoftLayer_Network_LoadBalancer_VirtualIpAddress data type contains all the information relating to a specific load balancer assigned to a customer account.

Information retained on the object itself is the virtual IP address, load balancing method, and any notes that are related to the load balancer. There is also an array of SoftLayer_Network_LoadBalancer_Service objects, which represent the load balancer services, explained more fully in the SoftLayer_Network_LoadBalancer_Service documentation.

See Also:: SoftLayer_Network_LoadBalancer_VirtualIpAddress

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`static class`	`VirtualIpAddress.Mask`
`static interface`	`VirtualIpAddress.Service`	Each SoftLayer customer that has purchased a load balancer will have one defined in the SoftLayer_Network_LoadBalancer_VirtualIpAddress service.
`static interface`	`VirtualIpAddress.ServiceAsync`

Field Summary

Fields
Modifier and Type	Field	Description
`protected Account`	`account`	The account that owns this load balancer.
`protected Item`	`billingItem`	The current billing item for the Load Balancer.
`protected Long`	`connectionLimit`	Connection limit on this VIP.
`protected boolean`	`connectionLimitSpecified`
`protected Long`	`customerManagedFlag`	If false, this VIP and associated services may be edited via the portal or the API.
`protected Long`	`id`	Unique ID for this object, used for the getObject method, and must be set if you are editing this object.
`protected boolean`	`idSpecified`
`protected String`	`loadBalancingMethod`	The load balancing method that determines which server is used "next" by the load balancer.
`protected String`	`loadBalancingMethodFullName`	A human readable version of loadBalancingMethod, intended mainly for API users.
`protected boolean`	`loadBalancingMethodFullNameSpecified`
`protected boolean`	`loadBalancingMethodSpecified`
`protected Boolean`	`managedResourceFlag`	A flag indicating that the load balancer is a managed resource.
`protected GregorianCalendar`	`modifyDate`	Date this load balancer was last modified
`protected boolean`	`modifyDateSpecified`
`protected String`	`name`	The name of the load balancer instance
`protected boolean`	`nameSpecified`
`protected String`	`notes`	User-created notes on this load balancer.
`protected boolean`	`notesSpecified`
`protected Long`	`securityCertificateId`	The unique identifier of the Security Certificate to be utilized when SSL support is enabled.
`protected boolean`	`securityCertificateIdSpecified`
`protected Long`	`serviceCount`	A count of the services on this load balancer.
`protected List<LoadBalancerService>`	`services`	the services on this load balancer.
`protected Long`	`sourcePort`	This is the port for incoming traffic.
`protected boolean`	`sourcePortSpecified`
`protected String`	`type`	The connection type of this VIP.
`protected boolean`	`typeSpecified`
`protected String`	`virtualIpAddress`	The virtual, public-facing IP address for your load balancer.
`protected boolean`	`virtualIpAddressSpecified`

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()`
`Item`	`getBillingItem()`
`Long`	`getConnectionLimit()`
`Long`	`getCustomerManagedFlag()`
`Long`	`getId()`
`String`	`getLoadBalancingMethod()`
`String`	`getLoadBalancingMethodFullName()`
`Boolean`	`getManagedResourceFlag()`
`GregorianCalendar`	`getModifyDate()`
`String`	`getName()`
`String`	`getNotes()`
`Long`	`getSecurityCertificateId()`
`Long`	`getServiceCount()`
`List<LoadBalancerService>`	`getServices()`
`Long`	`getSourcePort()`
`String`	`getType()`
`String`	`getVirtualIpAddress()`
`boolean`	`isConnectionLimitSpecified()`
`boolean`	`isIdSpecified()`
`boolean`	`isLoadBalancingMethodFullNameSpecified()`
`boolean`	`isLoadBalancingMethodSpecified()`
`boolean`	`isModifyDateSpecified()`
`boolean`	`isNameSpecified()`
`boolean`	`isNotesSpecified()`
`boolean`	`isSecurityCertificateIdSpecified()`
`boolean`	`isSourcePortSpecified()`
`boolean`	`isTypeSpecified()`
`boolean`	`isVirtualIpAddressSpecified()`
`static VirtualIpAddress.Service`	`service(ApiClient client)`
`static VirtualIpAddress.Service`	`service(ApiClient client, Long id)`
`void`	`setAccount(Account account)`
`void`	`setBillingItem(Item billingItem)`
`void`	`setConnectionLimit(Long connectionLimit)`
`void`	`setCustomerManagedFlag(Long customerManagedFlag)`
`void`	`setId(Long id)`
`void`	`setLoadBalancingMethod(String loadBalancingMethod)`
`void`	`setLoadBalancingMethodFullName(String loadBalancingMethodFullName)`
`void`	`setManagedResourceFlag(Boolean managedResourceFlag)`
`void`	`setModifyDate(GregorianCalendar modifyDate)`
`void`	`setName(String name)`
`void`	`setNotes(String notes)`
`void`	`setSecurityCertificateId(Long securityCertificateId)`
`void`	`setServiceCount(Long serviceCount)`
`void`	`setSourcePort(Long sourcePort)`
`void`	`setType(String type)`
`void`	`setVirtualIpAddress(String virtualIpAddress)`
`void`	`unsetConnectionLimit()`
`void`	`unsetId()`
`void`	`unsetLoadBalancingMethod()`
`void`	`unsetLoadBalancingMethodFullName()`
`void`	`unsetModifyDate()`
`void`	`unsetName()`
`void`	`unsetNotes()`
`void`	`unsetSecurityCertificateId()`
`void`	`unsetSourcePort()`
`void`	`unsetType()`
`void`	`unsetVirtualIpAddress()`

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 Details
- account
  
  @ApiProperty protected Account account
  
  The account that owns this load balancer.
- billingItem
  
  @ApiProperty protected Item billingItem
  
  The current billing item for the Load Balancer.
- customerManagedFlag
  
  @ApiProperty protected Long customerManagedFlag
  
  If false, this VIP and associated services may be edited via the portal or the API. If true, you must configure this VIP manually on the device.
- managedResourceFlag
  
  @ApiProperty protected Boolean managedResourceFlag
  
  A flag indicating that the load balancer is a managed resource.
- services
  
  @ApiProperty protected List<LoadBalancerService> services
  
  the services on this load balancer.
- connectionLimit
  
  @ApiProperty(canBeNullOrNotSet=true) protected Long connectionLimit
  
  Connection limit on this VIP. Can be upgraded through the upgradeConnectionLimit() function
- connectionLimitSpecified
  
  protected boolean connectionLimitSpecified
- id
  
  @ApiProperty(canBeNullOrNotSet=true) protected Long id
  
  Unique ID for this object, used for the getObject method, and must be set if you are editing this object.
- idSpecified
  
  protected boolean idSpecified
- loadBalancingMethod
  
  @ApiProperty(canBeNullOrNotSet=true) protected String loadBalancingMethod
  
  The load balancing method that determines which server is used "next" by the load balancer. The method is stored in an abbreviated form, represented in parentheses after the full name. Methods include: Round Robin (Value "rr"): Each server is used sequentially in a circular queue Shortest Response (Value "sr"): The server with the lowest ping at the last health check gets the next request Least Connections (Value "lc"): The server with the least current connections is given the next request Persistent IP - Round Robin (Value "pi"): The same server will be returned to a request during a users session. Servers are chosen through round robin. Persistent IP - Shortest Response (Value "pi-sr"): The same server will be returned to a request during a users session. Servers are chosen through shortest response. Persistent IP - Least Connections (Value "pi-lc"): The same server will be returned to a request during a users session. Servers are chosen through least connections. Insert Cookie - Round Robin (Value "ic"): Inserts a cookie into the HTTP stream that will tie that client to a particular balanced server. Servers are chosen through round robin. Insert Cookie - Shortest Response (Value "ic-sr"): Inserts a cookie into the HTTP stream that will tie that client to a particular balanced server. Servers are chosen through shortest response. Insert Cookie - Least Connections (Value "ic-lc"): Inserts a cookie into the HTTP stream that will tie that client to a particular balanced server. Servers are chosen through least connections.
- loadBalancingMethodSpecified
  
  protected boolean loadBalancingMethodSpecified
- loadBalancingMethodFullName
  
  @ApiProperty(canBeNullOrNotSet=true) protected String loadBalancingMethodFullName
  
  A human readable version of loadBalancingMethod, intended mainly for API users.
- loadBalancingMethodFullNameSpecified
  
  protected boolean loadBalancingMethodFullNameSpecified
- modifyDate
  
  @ApiProperty(canBeNullOrNotSet=true) protected GregorianCalendar modifyDate
  
  Date this load balancer was last modified
- modifyDateSpecified
  
  protected boolean modifyDateSpecified
- name
  
  @ApiProperty(canBeNullOrNotSet=true) protected String name
  
  The name of the load balancer instance
- nameSpecified
  
  protected boolean nameSpecified
- notes
  
  @ApiProperty(canBeNullOrNotSet=true) protected String notes
  
  User-created notes on this load balancer.
- 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
- sourcePort
  
  @ApiProperty(canBeNullOrNotSet=true) protected Long sourcePort
  
  This is the port for incoming traffic.
- sourcePortSpecified
  
  protected boolean sourcePortSpecified
- type
  
  @ApiProperty(canBeNullOrNotSet=true) protected String type
  
  The connection type of this VIP. Valid values are HTTP, FTP, TCP, UDP, and DNS.
- typeSpecified
  
  protected boolean typeSpecified
- virtualIpAddress
  
  @ApiProperty(canBeNullOrNotSet=true) protected String virtualIpAddress
  
  The virtual, public-facing IP address for your load balancer. This is the address of all incoming traffic
- virtualIpAddressSpecified
  
  protected boolean virtualIpAddressSpecified
- serviceCount
  
  @ApiProperty protected Long serviceCount
  
  A count of the services on this load balancer.
Constructor Details
- VirtualIpAddress
  
  public VirtualIpAddress()
Method Details
- getAccount
  
  public Account getAccount()
- setAccount
  
  public void setAccount(Account account)
- getBillingItem
  
  public Item getBillingItem()
- setBillingItem
  
  public void setBillingItem(Item billingItem)
- getCustomerManagedFlag
  
  public Long getCustomerManagedFlag()
- setCustomerManagedFlag
  
  public void setCustomerManagedFlag(Long customerManagedFlag)
- getManagedResourceFlag
  
  public Boolean getManagedResourceFlag()
- setManagedResourceFlag
  
  public void setManagedResourceFlag(Boolean managedResourceFlag)
- getServices
  
  public List<LoadBalancerService> getServices()
- getConnectionLimit
  
  public Long getConnectionLimit()
- setConnectionLimit
  
  public void setConnectionLimit(Long connectionLimit)
- isConnectionLimitSpecified
  
  public boolean isConnectionLimitSpecified()
- unsetConnectionLimit
  
  public void unsetConnectionLimit()
- getId
  
  public Long getId()
- setId
  
  public void setId(Long id)
- isIdSpecified
  
  public boolean isIdSpecified()
- unsetId
  
  public void unsetId()
- getLoadBalancingMethod
  
  public String getLoadBalancingMethod()
- setLoadBalancingMethod
  
  public void setLoadBalancingMethod(String loadBalancingMethod)
- isLoadBalancingMethodSpecified
  
  public boolean isLoadBalancingMethodSpecified()
- unsetLoadBalancingMethod
  
  public void unsetLoadBalancingMethod()
- getLoadBalancingMethodFullName
  
  public String getLoadBalancingMethodFullName()
- setLoadBalancingMethodFullName
  
  public void setLoadBalancingMethodFullName(String loadBalancingMethodFullName)
- isLoadBalancingMethodFullNameSpecified
  
  public boolean isLoadBalancingMethodFullNameSpecified()
- unsetLoadBalancingMethodFullName
  
  public void unsetLoadBalancingMethodFullName()
- getModifyDate
  
  public GregorianCalendar getModifyDate()
- setModifyDate
  
  public void setModifyDate(GregorianCalendar modifyDate)
- isModifyDateSpecified
  
  public boolean isModifyDateSpecified()
- unsetModifyDate
  
  public void unsetModifyDate()
- getName
  
  public String getName()
- setName
  
  public void setName(String name)
- isNameSpecified
  
  public boolean isNameSpecified()
- unsetName
  
  public void unsetName()
- 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()
- getSourcePort
  
  public Long getSourcePort()
- setSourcePort
  
  public void setSourcePort(Long sourcePort)
- isSourcePortSpecified
  
  public boolean isSourcePortSpecified()
- unsetSourcePort
  
  public void unsetSourcePort()
- getType
  
  public String getType()
- setType
  
  public void setType(String type)
- isTypeSpecified
  
  public boolean isTypeSpecified()
- unsetType
  
  public void unsetType()
- getVirtualIpAddress
  
  public String getVirtualIpAddress()
- setVirtualIpAddress
  
  public void setVirtualIpAddress(String virtualIpAddress)
- isVirtualIpAddressSpecified
  
  public boolean isVirtualIpAddressSpecified()
- unsetVirtualIpAddress
  
  public void unsetVirtualIpAddress()
- getServiceCount
  
  public Long getServiceCount()
- setServiceCount
  
  public void setServiceCount(Long serviceCount)
- 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 Details

Constructor Details

Method Details