Package com.softlayer.api.service.network.lbaas

Interface Listener.Service

All Superinterfaces:

Maskable, ResultLimitable, Service

Enclosing class:

Listener

@ApiService("SoftLayer_Network_LBaaS_Listener")
public static interface Listener.Service
extends Service

The SoftLayer_Network_LBaaS_Listener API service allows consumers to add, edit and delete load balancers protocols for front- and backends. In order to retrieve list of front- and backends protocols please refer to [[SoftLayer_Network_LBaaS_LoadBalancer]] service. A listener object specifies the protocol and port of allowed incoming network requests and the maximum number of accepted connections. It has references to its associated load balancer and default pool object.

See Also:

SoftLayer_Network_LBaaS_Listener

Method Summary

Modifier and Type	Method	Description
Listener.ServiceAsync	asAsync()	Get an async version of this service
LoadBalancer	deleteLoadBalancerProtocols(String loadBalancerUuid, List<String> listenerUuids)	Delete load balancers front- and backend protocols and return load balancer object with listeners (frontend), pools (backend), server instances (members) and datacenter populated.
Pool	getDefaultPool()
List<L7Policy>	getL7Policies()
Listener	getObject()
void	setMask(Listener.Mask mask)
LoadBalancer	updateLoadBalancerProtocols(String loadBalancerUuid, List<LoadBalancerProtocolConfiguration> protocolConfigurations)	Update (create) load balancers front- and backend protocols and return load balancer object with listeners (frontend), pools (backend), server instances (members) and datacenter populated.
Listener.Mask	withMask()	Use the existing mask on this service or create it if not present
Listener.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

Listener.ServiceAsync asAsync()

Description copied from interface: Service

Get an async version of this service

Specified by:

asAsync in interface Service

withNewMask

Listener.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

Listener.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(Listener.Mask mask)

deleteLoadBalancerProtocols

@ApiMethod LoadBalancer deleteLoadBalancerProtocols(String loadBalancerUuid, List<String> listenerUuids)

Delete load balancers front- and backend protocols and return load balancer object with listeners (frontend), pools (backend), server instances (members) and datacenter populated.

See Also:

SoftLayer_Network_LBaaS_Listener::deleteLoadBalancerProtocols

getObject

@ApiMethod(instanceRequired=true) Listener getObject()

See Also:

SoftLayer_Network_LBaaS_Listener::getObject

updateLoadBalancerProtocols

@ApiMethod LoadBalancer updateLoadBalancerProtocols(String loadBalancerUuid, List<LoadBalancerProtocolConfiguration> protocolConfigurations)

Update (create) load balancers front- and backend protocols and return load balancer object with listeners (frontend), pools (backend), server instances (members) and datacenter populated. Note if a protocolConfiguration has no listenerUuid set, this function will create the specified front- and backend accordingly. Otherwise the given front- and backend will be updated with the new protocol and port.

See Also:

SoftLayer_Network_LBaaS_Listener::updateLoadBalancerProtocols

getDefaultPool

@ApiMethod(instanceRequired=true) Pool getDefaultPool()

See Also:

SoftLayer_Network_LBaaS_Listener::getDefaultPool

getL7Policies

@ApiMethod(instanceRequired=true) List<L7Policy> getL7Policies()

See Also:

SoftLayer_Network_LBaaS_Listener::getL7Policies