Interface VirtualIpAddress.Service
-
- All Superinterfaces:
Maskable
,ResultLimitable
,Service
- Enclosing class:
- VirtualIpAddress
@ApiService("SoftLayer_Network_LoadBalancer_VirtualIpAddress") public static interface VirtualIpAddress.Service extends Service
Each SoftLayer customer that has purchased a load balancer will have one defined in the SoftLayer_Network_LoadBalancer_VirtualIpAddress service. Load balancers have a virtual IP address and a number of SoftLayer_Network_LoadBalancer_Service objects associated with them. The SoftLayer_Network_LoadBalancer_VirtualIpAddress object is the only way for a customer to make changes to their load balancer service.
Load balancers can be upgraded by using the upgradeConnectionLimit function, but this will upgrade your billing accordingly. Downgrades are currently not supported, please open a ticket to accomplish a downgrade.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description VirtualIpAddress.ServiceAsync
asAsync()
Get an async version of this serviceBoolean
disable()
Disable a Virtual IP Address, removing it from load balancer rotation and denying all connections to that IP address.Boolean
editObject(VirtualIpAddress templateObject)
Like any other API object, the load balancers can have their exposed properties edited by passing in a modified version of the object.Boolean
enable()
Enable a disabled Virtual IP Address, allowing connections back to the IP address.Account
getAccount()
The account that owns this load balancer.Item
getBillingItem()
The current billing item for the Load Balancer.Long
getCustomerManagedFlag()
If false, this VIP and associated services may be edited via the portal or the API.Boolean
getManagedResourceFlag()
A flag indicating that the load balancer is a managed resource.VirtualIpAddress
getObject()
getObject retrieves the SoftLayer_Network_LoadBalancer_VirtualIpAddress object whose ID number corresponds to the ID number of the init parameter passed to the SoftLayer_Network_LoadBalancer_VirtualIpAddress service.List<LoadBalancerService>
getServices()
the services on this load balancer.Boolean
kickAllConnections()
Quickly remove all active external connections to a Virtual IP Address.void
setMask(VirtualIpAddress.Mask mask)
Boolean
upgradeConnectionLimit()
Upgrades the connection limit on the VirtualIp and changes the billing item on your account to reflect the change.VirtualIpAddress.Mask
withMask()
Use the existing mask on this service or create it if not presentVirtualIpAddress.Mask
withNewMask()
Overwrite the existing mask on this service with a new one and return it-
Methods inherited from interface com.softlayer.api.ResultLimitable
getLastResponseTotalItemCount, getResultLimit, setResultLimit
-
-
-
-
Method Detail
-
asAsync
VirtualIpAddress.ServiceAsync asAsync()
Description copied from interface:Service
Get an async version of this service
-
withNewMask
VirtualIpAddress.Mask withNewMask()
Description copied from interface:Maskable
Overwrite the existing mask on this service with a new one and return it- Specified by:
withNewMask
in interfaceMaskable
-
withMask
VirtualIpAddress.Mask withMask()
Description copied from interface:Maskable
Use the existing mask on this service or create it if not present
-
setMask
void setMask(VirtualIpAddress.Mask mask)
-
disable
@ApiMethod(instanceRequired=true) Boolean disable()
Disable a Virtual IP Address, removing it from load balancer rotation and denying all connections to that IP address.
-
editObject
@ApiMethod(instanceRequired=true) Boolean editObject(VirtualIpAddress templateObject)
Like any other API object, the load balancers can have their exposed properties edited by passing in a modified version of the object. The load balancer object also can modify its services in this way. Simply request the load balancer object you wish to edit, then modify the objects in the services array and pass the modified object to this function. WARNING: Services cannot be deleted in this manner, you must call deleteObject() on the service to physically remove them from the load balancer.
-
enable
@ApiMethod(instanceRequired=true) Boolean enable()
Enable a disabled Virtual IP Address, allowing connections back to the IP address.
-
getObject
@ApiMethod(instanceRequired=true) VirtualIpAddress getObject()
getObject retrieves the SoftLayer_Network_LoadBalancer_VirtualIpAddress object whose ID number corresponds to the ID number of the init parameter passed to the SoftLayer_Network_LoadBalancer_VirtualIpAddress service. You can only retrieve Load Balancers assigned to your account.
-
kickAllConnections
@ApiMethod(instanceRequired=true) Boolean kickAllConnections()
Quickly remove all active external connections to a Virtual IP Address.
-
upgradeConnectionLimit
@ApiMethod(instanceRequired=true) Boolean upgradeConnectionLimit()
Upgrades the connection limit on the VirtualIp and changes the billing item on your account to reflect the change. This function will only upgrade you to the next "level" of service. The next level follows this pattern Current Level => Next Level 50 100 100 200 200 500 500 1000 1000 1200 1200 1500 1500 2000 2000 2500 2500 3000
-
getAccount
@ApiMethod(instanceRequired=true) Account getAccount()
The account that owns this load balancer.
-
getBillingItem
@ApiMethod(instanceRequired=true) Item getBillingItem()
The current billing item for the Load Balancer.
-
getCustomerManagedFlag
@ApiMethod(instanceRequired=true) Long getCustomerManagedFlag()
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.
-
getManagedResourceFlag
@ApiMethod(instanceRequired=true) Boolean getManagedResourceFlag()
A flag indicating that the load balancer is a managed resource.
-
getServices
@ApiMethod(instanceRequired=true) List<LoadBalancerService> getServices()
the services on this load balancer.
-
-