com.vmware.vcenter.namespace_management

Interface LoadBalancers

All Superinterfaces:

LoadBalancersTypes, Service

All Known Implementing Classes:

LoadBalancersStub

public interface LoadBalancers
extends Service, LoadBalancersTypes

LoadBalancers represent the user provisioned load balancers. The load balancers provided may be used to front the API servers in both, vSphere Namespaces Cluster and Tanzu Kubernetes Grid clusters. Note: The lifecycle of these load balancers is not managed by vSphere. This interface was added in vSphere API 7.0.1.0.

Nested Class Summary

Nested classes/interfaces inherited from interface com.vmware.vcenter.namespace_management.LoadBalancersTypes

LoadBalancersTypes.ConfigSpec, LoadBalancersTypes.HAProxyConfigCreateSpec, LoadBalancersTypes.HAProxyInfo, LoadBalancersTypes.Info, LoadBalancersTypes.Provider, LoadBalancersTypes.Server, LoadBalancersTypes.Summary

Field Summary

Fields inherited from interface com.vmware.vcenter.namespace_management.LoadBalancersTypes

_VAPI_SERVICE_ID

Method Summary

Modifier and Type	Method and Description
LoadBalancersTypes.Info	get(java.lang.String cluster, java.lang.String id) Returns information LoadBalancersTypes.Info about the load balancer associated with the given cluster.
void	get(java.lang.String cluster, java.lang.String id, AsyncCallback<LoadBalancersTypes.Info> asyncCallback) Returns information LoadBalancersTypes.Info about the load balancer associated with the given cluster.
void	get(java.lang.String cluster, java.lang.String id, AsyncCallback<LoadBalancersTypes.Info> asyncCallback, InvocationConfig invocationConfig) Returns information LoadBalancersTypes.Info about the load balancer associated with the given cluster.
LoadBalancersTypes.Info	get(java.lang.String cluster, java.lang.String id, InvocationConfig invocationConfig) Returns information LoadBalancersTypes.Info about the load balancer associated with the given cluster.
java.util.List<LoadBalancersTypes.Summary>	list(java.lang.String cluster) Returns information about all load balancers associated with the given cluster.
void	list(java.lang.String cluster, AsyncCallback<java.util.List<LoadBalancersTypes.Summary>> asyncCallback) Returns information about all load balancers associated with the given cluster.
void	list(java.lang.String cluster, AsyncCallback<java.util.List<LoadBalancersTypes.Summary>> asyncCallback, InvocationConfig invocationConfig) Returns information about all load balancers associated with the given cluster.
java.util.List<LoadBalancersTypes.Summary>	list(java.lang.String cluster, InvocationConfig invocationConfig) Returns information about all load balancers associated with the given cluster.

Method Detail

get

LoadBalancersTypes.Info get(java.lang.String cluster,
                            java.lang.String id)

Returns information LoadBalancersTypes.Info about the load balancer associated with the given cluster. This method was added in vSphere API 7.0.1.0.

Synchronous method overload. Result of the invocation will be reported as a method return value.

Parameters:

cluster - Identifier of the cluster the load balancer is associated with. The parameter must be an identifier for the resource type: ClusterComputeResource.

id - Identifier of the load balancer LoadBalancersTypes.ConfigSpec.getId(). The parameter must be an identifier for the resource type: com.vmware.vcenter.namespace_management.LoadBalancerConfig.

Throws:

Error - if the system reports an error while responding to the request.

NotFound - if cluster or id cannot be located.

Unauthenticated - if the user cannot be authenticated.

Unauthorized - if the user does not have System.Read privilege.

Unsupported - if the specified cluster does not have vSphere Namespaces enabled.

get

LoadBalancersTypes.Info get(java.lang.String cluster,
                            java.lang.String id,
                            InvocationConfig invocationConfig)

Returns information LoadBalancersTypes.Info about the load balancer associated with the given cluster. This method was added in vSphere API 7.0.1.0.

Synchronous method overload. Result of the invocation will be reported as a method return value. Use invocationConfig to specify configuration for this particular invocation.

Parameters:

cluster - Identifier of the cluster the load balancer is associated with. The parameter must be an identifier for the resource type: ClusterComputeResource.

id - Identifier of the load balancer LoadBalancersTypes.ConfigSpec.getId(). The parameter must be an identifier for the resource type: com.vmware.vcenter.namespace_management.LoadBalancerConfig.

invocationConfig - Configuration for the method invocation.

Throws:

Error - if the system reports an error while responding to the request.

NotFound - if cluster or id cannot be located.

Unauthenticated - if the user cannot be authenticated.

Unauthorized - if the user does not have System.Read privilege.

Unsupported - if the specified cluster does not have vSphere Namespaces enabled.

get

void get(java.lang.String cluster,
         java.lang.String id,
         AsyncCallback<LoadBalancersTypes.Info> asyncCallback)

Returns information LoadBalancersTypes.Info about the load balancer associated with the given cluster. This method was added in vSphere API 7.0.1.0.

Asynchronous method overload. Result of the invocation will be reported via the specified asyncCallback.

Operation Errors:
Error - if the system reports an error while responding to the request.
NotFound - if cluster or id cannot be located.
Unauthenticated - if the user cannot be authenticated.
Unauthorized - if the user does not have System.Read privilege.
Unsupported - if the specified cluster does not have vSphere Namespaces enabled.

Parameters:

cluster - Identifier of the cluster the load balancer is associated with. The parameter must be an identifier for the resource type: ClusterComputeResource.

id - Identifier of the load balancer LoadBalancersTypes.ConfigSpec.getId(). The parameter must be an identifier for the resource type: com.vmware.vcenter.namespace_management.LoadBalancerConfig.

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

get

void get(java.lang.String cluster,
         java.lang.String id,
         AsyncCallback<LoadBalancersTypes.Info> asyncCallback,
         InvocationConfig invocationConfig)

Returns information LoadBalancersTypes.Info about the load balancer associated with the given cluster. This method was added in vSphere API 7.0.1.0.

Asynchronous method overload. Result of the invocation will be reported via the specified asyncCallback. Use invocationConfig to specify configuration for this particular invocation.

Operation Errors:
Error - if the system reports an error while responding to the request.
NotFound - if cluster or id cannot be located.
Unauthenticated - if the user cannot be authenticated.
Unauthorized - if the user does not have System.Read privilege.
Unsupported - if the specified cluster does not have vSphere Namespaces enabled.

Parameters:

cluster - Identifier of the cluster the load balancer is associated with. The parameter must be an identifier for the resource type: ClusterComputeResource.

id - Identifier of the load balancer LoadBalancersTypes.ConfigSpec.getId(). The parameter must be an identifier for the resource type: com.vmware.vcenter.namespace_management.LoadBalancerConfig.

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

invocationConfig - Configuration for the method invocation.

list

java.util.List<LoadBalancersTypes.Summary> list(java.lang.String cluster)

Returns information about all load balancers associated with the given cluster. This method was added in vSphere API 7.0.1.0.

Synchronous method overload. Result of the invocation will be reported as a method return value.

Parameters:

cluster - Identifier of the cluster the load balancers are associated with. The parameter must be an identifier for the resource type: ClusterComputeResource.

Throws:

Error - if the system reports an error while responding to the request.

NotFound - if cluster cannot be located.

Unauthenticated - if the user cannot be authenticated.

Unauthorized - if the user does not have System.Read privilege.

Unsupported - if the specified cluster does not have vSphere Namespaces enabled.

list

java.util.List<LoadBalancersTypes.Summary> list(java.lang.String cluster,
                                                InvocationConfig invocationConfig)

Returns information about all load balancers associated with the given cluster. This method was added in vSphere API 7.0.1.0.

Synchronous method overload. Result of the invocation will be reported as a method return value. Use invocationConfig to specify configuration for this particular invocation.

Parameters:

cluster - Identifier of the cluster the load balancers are associated with. The parameter must be an identifier for the resource type: ClusterComputeResource.

invocationConfig - Configuration for the method invocation.

Throws:

Error - if the system reports an error while responding to the request.

NotFound - if cluster cannot be located.

Unauthenticated - if the user cannot be authenticated.

Unauthorized - if the user does not have System.Read privilege.

Unsupported - if the specified cluster does not have vSphere Namespaces enabled.

list

void list(java.lang.String cluster,
          AsyncCallback<java.util.List<LoadBalancersTypes.Summary>> asyncCallback)

Returns information about all load balancers associated with the given cluster. This method was added in vSphere API 7.0.1.0.

Asynchronous method overload. Result of the invocation will be reported via the specified asyncCallback.

Operation Errors:
Error - if the system reports an error while responding to the request.
NotFound - if cluster cannot be located.
Unauthenticated - if the user cannot be authenticated.
Unauthorized - if the user does not have System.Read privilege.
Unsupported - if the specified cluster does not have vSphere Namespaces enabled.

Parameters:

cluster - Identifier of the cluster the load balancers are associated with. The parameter must be an identifier for the resource type: ClusterComputeResource.

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

list

void list(java.lang.String cluster,
          AsyncCallback<java.util.List<LoadBalancersTypes.Summary>> asyncCallback,
          InvocationConfig invocationConfig)

Returns information about all load balancers associated with the given cluster. This method was added in vSphere API 7.0.1.0.

Asynchronous method overload. Result of the invocation will be reported via the specified asyncCallback. Use invocationConfig to specify configuration for this particular invocation.

Operation Errors:
Error - if the system reports an error while responding to the request.
NotFound - if cluster cannot be located.
Unauthenticated - if the user cannot be authenticated.
Unauthorized - if the user does not have System.Read privilege.
Unsupported - if the specified cluster does not have vSphere Namespaces enabled.

Parameters:

cluster - Identifier of the cluster the load balancers are associated with. The parameter must be an identifier for the resource type: ClusterComputeResource.

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

invocationConfig - Configuration for the method invocation.