Package com.ibm.cloud.networking.global_load_balancer.v1

Class GlobalLoadBalancer

java.lang.Object

com.ibm.cloud.sdk.core.service.BaseService

com.ibm.cloud.networking.global_load_balancer.v1.GlobalLoadBalancer

public class GlobalLoadBalancer
extends com.ibm.cloud.sdk.core.service.BaseService

Global Load Balancer.

Version:

v1

Field Summary

Fields

Modifier and Type	Field	Description
static String	DEFAULT_SERVICE_NAME
static String	DEFAULT_SERVICE_URL

Fields inherited from class com.ibm.cloud.sdk.core.service.BaseService

PROPNAME_DISABLE_SSL, PROPNAME_ENABLE_GZIP, PROPNAME_ENABLE_RETRIES, PROPNAME_MAX_RETRIES, PROPNAME_RETRY_INTERVAL, PROPNAME_URL

Constructor Summary

Constructors

Constructor	Description
GlobalLoadBalancer(String crn, String zoneIdentifier, String serviceName, com.ibm.cloud.sdk.core.security.Authenticator authenticator)	Constructs an instance of the `GlobalLoadBalancer` client.

Method Summary

Modifier and Type	Method	Description
com.ibm.cloud.sdk.core.http.ServiceCall<LoadBalancersResp>	createLoadBalancer()	Create load balancer.
com.ibm.cloud.sdk.core.http.ServiceCall<LoadBalancersResp>	createLoadBalancer(CreateLoadBalancerOptions createLoadBalancerOptions)	Create load balancer.
com.ibm.cloud.sdk.core.http.ServiceCall<DeleteLoadBalancersResp>	deleteLoadBalancer(DeleteLoadBalancerOptions deleteLoadBalancerOptions)	Delete load balancer.
com.ibm.cloud.sdk.core.http.ServiceCall<LoadBalancersResp>	editLoadBalancer(EditLoadBalancerOptions editLoadBalancerOptions)	Edit load balancer.
String	getCrn()	Gets the crn.
com.ibm.cloud.sdk.core.http.ServiceCall<LoadBalancersResp>	getLoadBalancerSettings(GetLoadBalancerSettingsOptions getLoadBalancerSettingsOptions)	Get load balancer.
String	getZoneIdentifier()	Gets the zoneIdentifier.
com.ibm.cloud.sdk.core.http.ServiceCall<ListLoadBalancersResp>	listAllLoadBalancers()	List all load balancers.
com.ibm.cloud.sdk.core.http.ServiceCall<ListLoadBalancersResp>	listAllLoadBalancers(ListAllLoadBalancersOptions listAllLoadBalancersOptions)	List all load balancers.
static GlobalLoadBalancer	newInstance(String crn, String zoneIdentifier)	Class method which constructs an instance of the `GlobalLoadBalancer` client.
static GlobalLoadBalancer	newInstance(String crn, String zoneIdentifier, String serviceName)	Class method which constructs an instance of the `GlobalLoadBalancer` client.
void	setCrn(String crn)	Sets the crn.
void	setZoneIdentifier(String zoneIdentifier)	Sets the zoneIdentifier.

Methods inherited from class com.ibm.cloud.sdk.core.service.BaseService

configureClient, configureService, constructServiceUrl, constructServiceURL, disableRetries, enableGzipCompression, enableRetries, getAuthenticator, getClient, getDefaultHeaders, getEndPoint, getName, getServiceUrl, isJsonMimeType, isJsonPatchMimeType, setClient, setDefaultHeaders, setEndPoint, setServiceUrl, toString

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

DEFAULT_SERVICE_NAME

public static final String DEFAULT_SERVICE_NAME

See Also:

Constant Field Values

DEFAULT_SERVICE_URL

public static final String DEFAULT_SERVICE_URL

See Also:

Constant Field Values

Constructor Detail

GlobalLoadBalancer

public GlobalLoadBalancer(String crn,
                          String zoneIdentifier,
                          String serviceName,
                          com.ibm.cloud.sdk.core.security.Authenticator authenticator)

Constructs an instance of the `GlobalLoadBalancer` client. The specified service name and authenticator are used to configure the client instance.

Parameters:

crn - Full CRN of the service instance.

zoneIdentifier - zone identifier.

serviceName - the service name to be used when configuring the client instance

authenticator - the Authenticator instance to be configured for this client

Method Detail

newInstance

public static GlobalLoadBalancer newInstance(String crn,
                                             String zoneIdentifier)

Class method which constructs an instance of the `GlobalLoadBalancer` client. The default service name is used to configure the client instance.

Parameters:

crn - Full CRN of the service instance.

zoneIdentifier - zone identifier.

Returns:

an instance of the `GlobalLoadBalancer` client using external configuration

newInstance

public static GlobalLoadBalancer newInstance(String crn,
                                             String zoneIdentifier,
                                             String serviceName)

Class method which constructs an instance of the `GlobalLoadBalancer` client. The specified service name is used to configure the client instance.

Parameters:

crn - Full CRN of the service instance.

zoneIdentifier - zone identifier.

serviceName - the service name to be used when configuring the client instance

Returns:

an instance of the `GlobalLoadBalancer` client using external configuration

getCrn

public String getCrn()

Gets the crn. Full CRN of the service instance.

Returns:

the crn

setCrn

public void setCrn(String crn)

Sets the crn.

Parameters:

crn - the new crn

getZoneIdentifier

public String getZoneIdentifier()

Gets the zoneIdentifier. zone identifier.

Returns:

the zoneIdentifier

setZoneIdentifier

public void setZoneIdentifier(String zoneIdentifier)

Sets the zoneIdentifier.

Parameters:

zoneIdentifier - the new zoneIdentifier

listAllLoadBalancers

public com.ibm.cloud.sdk.core.http.ServiceCall<ListLoadBalancersResp> listAllLoadBalancers(ListAllLoadBalancersOptions listAllLoadBalancersOptions)

List all load balancers. List configured load balancers.

Parameters:

listAllLoadBalancersOptions - the ListAllLoadBalancersOptions containing the options for the call

Returns:

a ServiceCall with a result of type ListLoadBalancersResp

listAllLoadBalancers

public com.ibm.cloud.sdk.core.http.ServiceCall<ListLoadBalancersResp> listAllLoadBalancers()

List all load balancers. List configured load balancers.

Returns:

a ServiceCall with a result of type ListLoadBalancersResp

createLoadBalancer

public com.ibm.cloud.sdk.core.http.ServiceCall<LoadBalancersResp> createLoadBalancer(CreateLoadBalancerOptions createLoadBalancerOptions)

Create load balancer. Create a load balancer for a given zone. The zone should be active before placing an order of a load balancer.

Parameters:

createLoadBalancerOptions - the CreateLoadBalancerOptions containing the options for the call

Returns:

a ServiceCall with a result of type LoadBalancersResp

createLoadBalancer

public com.ibm.cloud.sdk.core.http.ServiceCall<LoadBalancersResp> createLoadBalancer()

Create load balancer. Create a load balancer for a given zone. The zone should be active before placing an order of a load balancer.

Returns:

a ServiceCall with a result of type LoadBalancersResp

editLoadBalancer

public com.ibm.cloud.sdk.core.http.ServiceCall<LoadBalancersResp> editLoadBalancer(EditLoadBalancerOptions editLoadBalancerOptions)

Edit load balancer. Edit porperties of an existing load balancer.

Parameters:

editLoadBalancerOptions - the EditLoadBalancerOptions containing the options for the call

Returns:

a ServiceCall with a result of type LoadBalancersResp

deleteLoadBalancer

public com.ibm.cloud.sdk.core.http.ServiceCall<DeleteLoadBalancersResp> deleteLoadBalancer(DeleteLoadBalancerOptions deleteLoadBalancerOptions)

Delete load balancer. Delete a load balancer.

Parameters:

deleteLoadBalancerOptions - the DeleteLoadBalancerOptions containing the options for the call

Returns:

a ServiceCall with a result of type DeleteLoadBalancersResp

getLoadBalancerSettings

public com.ibm.cloud.sdk.core.http.ServiceCall<LoadBalancersResp> getLoadBalancerSettings(GetLoadBalancerSettingsOptions getLoadBalancerSettingsOptions)

Get load balancer. For a given zone identifier and load balancer id, get the load balancer settings.

Parameters:

getLoadBalancerSettingsOptions - the GetLoadBalancerSettingsOptions containing the options for the call

Returns:

a ServiceCall with a result of type LoadBalancersResp