Package com.softlayer.api.service.network.application.delivery.controller.loadbalancer

Interface VirtualIpAddress.Service

All Superinterfaces:

Maskable, ResultLimitable, Service

Enclosing class:

VirtualIpAddress

@ApiService("SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress")
public static interface VirtualIpAddress.Service
extends Service

See Also:

SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress

Method Summary

Modifier and Type	Method	Description
VirtualIpAddress.ServiceAsync	asAsync()	Get an async version of this service
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.
Account	getAccount()
Controller	getApplicationDeliveryController()	A virtual IP address's associated application delivery controller.
List<Controller>	getApplicationDeliveryControllers()	A virtual IP address's associated application delivery controllers.
List<SecureTransportCipher>	getAvailableSecureTransportCiphers()	Yields a list of the SSL/TLS encryption ciphers that are currently supported on this virtual IP address instance.
List<SecureTransportProtocol>	getAvailableSecureTransportProtocols()	Yields a list of the secure communication protocols that are currently supported on this virtual IP address instance.
Item	getBillingItem()	The current billing item for the load balancer virtual IP.
LoadBalancer	getDedicatedBillingItem()	The current billing item for the load balancing device housing the virtual IP.
Boolean	getHighAvailabilityFlag()	Denotes whether the virtual IP is configured within a high availability cluster.
IpAddress	getIpAddress()
List<Hardware>	getLoadBalancerHardware()
Boolean	getManagedResourceFlag()	A flag indicating that the load balancer is a managed resource.
VirtualIpAddress	getObject()
List<SecureTransportCipher>	getSecureTransportCiphers()	The list of security ciphers enabled for this virtual IP address
List<SecureTransportProtocol>	getSecureTransportProtocols()	The list of secure transport protocols enabled for this virtual IP address
Certificate	getSecurityCertificate()	The SSL certificate currently associated with the VIP.
Entry	getSecurityCertificateEntry()	The SSL certificate currently associated with the VIP.
List<VirtualServer>	getVirtualServers()
void	setMask(VirtualIpAddress.Mask mask)
Boolean	startSsl()	Start SSL acceleration on all SSL virtual services (those with a type of HTTPS).
Boolean	stopSsl()	Stop SSL acceleration on all SSL virtual services (those with a type of HTTPS).
Boolean	upgradeConnectionLimit()	Upgrades the connection limit on the Virtual IP to Address to the next, higher connection limit of the same product.
VirtualIpAddress.Mask	withMask()	Use the existing mask on this service or create it if not present
VirtualIpAddress.Mask	withNewMask()	Overwrite the existing mask on this service with a new one and return it

Methods inherited from interface com.softlayer.api.Maskable

clearMask, setMask, setMask

Methods inherited from interface com.softlayer.api.ResultLimitable

getLastResponseTotalItemCount, getResultLimit, setResultLimit

Method Details

asAsync

VirtualIpAddress.ServiceAsync asAsync()

Description copied from interface: Service

Get an async version of this service

Specified by:

asAsync in interface 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 interface Maskable

withMask

VirtualIpAddress.Mask withMask()

Description copied from interface: Maskable

Use the existing mask on this service or create it if not present

Specified by:

withMask in interface Maskable

setMask

void setMask(VirtualIpAddress.Mask mask)

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.

See Also:

SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress::editObject

getAvailableSecureTransportCiphers

@ApiMethod(instanceRequired=true) List<SecureTransportCipher> getAvailableSecureTransportCiphers()

Yields a list of the SSL/TLS encryption ciphers that are currently supported on this virtual IP address instance.

See Also:

SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress::getAvailableSecureTransportCiphers

getAvailableSecureTransportProtocols

@ApiMethod(instanceRequired=true) List<SecureTransportProtocol> getAvailableSecureTransportProtocols()

Yields a list of the secure communication protocols that are currently supported on this virtual IP address instance. The list of supported ciphers for each protocol is culled to match availability.

See Also:

SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress::getAvailableSecureTransportProtocols

getObject

@ApiMethod(instanceRequired=true) VirtualIpAddress getObject()

See Also:

SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress::getObject

startSsl

@ApiMethod(instanceRequired=true) Boolean startSsl()

Start SSL acceleration on all SSL virtual services (those with a type of HTTPS). This action should be taken only after configuring an SSL certificate for the virtual IP.

See Also:

SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress::startSsl

stopSsl

@ApiMethod(instanceRequired=true) Boolean stopSsl()

Stop SSL acceleration on all SSL virtual services (those with a type of HTTPS).

See Also:

SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress::stopSsl

upgradeConnectionLimit

@ApiMethod(instanceRequired=true) Boolean upgradeConnectionLimit()

Upgrades the connection limit on the Virtual IP to Address to the next, higher connection limit of the same product.

See Also:

SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress::upgradeConnectionLimit

getAccount

@ApiMethod(instanceRequired=true) Account getAccount()

See Also:

SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress::getAccount

getApplicationDeliveryController

@ApiMethod(instanceRequired=true) Controller getApplicationDeliveryController()

A virtual IP address's associated application delivery controller.

See Also:

SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress::getApplicationDeliveryController

getApplicationDeliveryControllers

@ApiMethod(instanceRequired=true) List<Controller> getApplicationDeliveryControllers()

A virtual IP address's associated application delivery controllers.

See Also:

SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress::getApplicationDeliveryControllers

getBillingItem

@ApiMethod(instanceRequired=true) Item getBillingItem()

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.

See Also:

SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress::getBillingItem

getDedicatedBillingItem

@ApiMethod(instanceRequired=true) LoadBalancer getDedicatedBillingItem()

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.

See Also:

SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress::getDedicatedBillingItem

getHighAvailabilityFlag

@ApiMethod(instanceRequired=true) Boolean getHighAvailabilityFlag()

Denotes whether the virtual IP is configured within a high availability cluster.

See Also:

SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress::getHighAvailabilityFlag

getIpAddress

@ApiMethod(instanceRequired=true) IpAddress getIpAddress()

See Also:

SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress::getIpAddress

getLoadBalancerHardware

@ApiMethod(instanceRequired=true) List<Hardware> getLoadBalancerHardware()

See Also:

SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress::getLoadBalancerHardware

getManagedResourceFlag

@ApiMethod(instanceRequired=true) Boolean getManagedResourceFlag()

A flag indicating that the load balancer is a managed resource.

See Also:

SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress::getManagedResourceFlag

getSecureTransportCiphers

@ApiMethod(instanceRequired=true) List<SecureTransportCipher> getSecureTransportCiphers()

The list of security ciphers enabled for this virtual IP address

See Also:

SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress::getSecureTransportCiphers

getSecureTransportProtocols

@ApiMethod(instanceRequired=true) List<SecureTransportProtocol> getSecureTransportProtocols()

The list of secure transport protocols enabled for this virtual IP address

See Also:

SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress::getSecureTransportProtocols

getSecurityCertificate

@ApiMethod(instanceRequired=true) Certificate getSecurityCertificate()

The SSL certificate currently associated with the VIP.

See Also:

SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress::getSecurityCertificate

getSecurityCertificateEntry

@ApiMethod(instanceRequired=true) Entry getSecurityCertificateEntry()

The SSL certificate currently associated with the VIP. Provides chosen certificate visibility to unprivileged users.

See Also:

SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress::getSecurityCertificateEntry

getVirtualServers

@ApiMethod(instanceRequired=true) List<VirtualServer> getVirtualServers()

See Also:

SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress::getVirtualServers