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.LoadBalancersTypes.AviConfigCreateSpec, LoadBalancersTypes.AviConfigSetSpec, LoadBalancersTypes.AviConfigUpdateSpec, LoadBalancersTypes.AviInfo, LoadBalancersTypes.ConfigSpec, LoadBalancersTypes.HAProxyConfigCreateSpec, LoadBalancersTypes.HAProxyConfigSetSpec, LoadBalancersTypes.HAProxyConfigUpdateSpec, LoadBalancersTypes.HAProxyInfo, LoadBalancersTypes.Info, LoadBalancersTypes.Provider, LoadBalancersTypes.Server, LoadBalancersTypes.SetSpec, LoadBalancersTypes.Summary, LoadBalancersTypes.UpdateSpec
_VAPI_SERVICE_ID
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.
|
void |
set(java.lang.String cluster,
java.lang.String id,
LoadBalancersTypes.SetSpec spec)
Applies the entire load balancer
spec to an existing load balancer
configuration. |
void |
set(java.lang.String cluster,
java.lang.String id,
LoadBalancersTypes.SetSpec spec,
AsyncCallback<java.lang.Void> asyncCallback)
Applies the entire load balancer
spec to an existing load balancer
configuration. |
void |
set(java.lang.String cluster,
java.lang.String id,
LoadBalancersTypes.SetSpec spec,
AsyncCallback<java.lang.Void> asyncCallback,
InvocationConfig invocationConfig)
Applies the entire load balancer
spec to an existing load balancer
configuration. |
void |
set(java.lang.String cluster,
java.lang.String id,
LoadBalancersTypes.SetSpec spec,
InvocationConfig invocationConfig)
Applies the entire load balancer
spec to an existing load balancer
configuration. |
void |
update(java.lang.String cluster,
java.lang.String id,
LoadBalancersTypes.UpdateSpec spec)
Updates the load balancer configuration.
|
void |
update(java.lang.String cluster,
java.lang.String id,
LoadBalancersTypes.UpdateSpec spec,
AsyncCallback<java.lang.Void> asyncCallback)
Updates the load balancer configuration.
|
void |
update(java.lang.String cluster,
java.lang.String id,
LoadBalancersTypes.UpdateSpec spec,
AsyncCallback<java.lang.Void> asyncCallback,
InvocationConfig invocationConfig)
Updates the load balancer configuration.
|
void |
update(java.lang.String cluster,
java.lang.String id,
LoadBalancersTypes.UpdateSpec spec,
InvocationConfig invocationConfig)
Updates the load balancer configuration.
|
LoadBalancersTypes.Info get(java.lang.String cluster, java.lang.String id)
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.
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
.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.LoadBalancersTypes.Info get(java.lang.String cluster, java.lang.String id, InvocationConfig invocationConfig)
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.
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.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.void get(java.lang.String cluster, java.lang.String id, AsyncCallback<LoadBalancersTypes.Info> asyncCallback)
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
.
Invocation Result:
Information about load balancer associated with a cluster.
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.
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.void get(java.lang.String cluster, java.lang.String id, AsyncCallback<LoadBalancersTypes.Info> asyncCallback, InvocationConfig invocationConfig)
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.
Invocation Result:
Information about load balancer associated with a cluster.
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.
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.java.util.List<LoadBalancersTypes.Summary> list(java.lang.String cluster)
Synchronous method overload. Result of the invocation will be reported as a method return value.
cluster
- Identifier of the cluster the load balancers are associated with.
The parameter must be an identifier for the resource type: ClusterComputeResource
.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.java.util.List<LoadBalancersTypes.Summary> list(java.lang.String cluster, InvocationConfig invocationConfig)
Synchronous method overload. Result of the invocation will be
reported as a method return value.
Use invocationConfig
to specify configuration for this particular invocation.
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.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.void list(java.lang.String cluster, AsyncCallback<java.util.List<LoadBalancersTypes.Summary>> asyncCallback)
Asynchronous method overload. Result of the invocation will be
reported via the specified asyncCallback
.
Invocation Result:
List of summary of all load balancers associated with a clusters.
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.
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.void list(java.lang.String cluster, AsyncCallback<java.util.List<LoadBalancersTypes.Summary>> asyncCallback, InvocationConfig invocationConfig)
Asynchronous method overload. Result of the invocation will be
reported via the specified asyncCallback
.
Use invocationConfig
to specify configuration for this particular invocation.
Invocation Result:
List of summary of all load balancers associated with a clusters.
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.
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.void set(java.lang.String cluster, java.lang.String id, LoadBalancersTypes.SetSpec spec)
spec
to an existing load balancer
configuration. This method was added in vSphere API 7.0.3.0.
Synchronous method overload. Result of the invocation will be reported as a method return value.
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.
The parameter must be an identifier for the resource type: com.vmware.vcenter.namespace_management.LoadBalancerConfig
.spec
- Information about the load balancer object to be set.Error
- if the system reports an error while responding to the request.InvalidArgument
- if if spec
contain any errors.NotAllowedInCurrentState
- if the associated cluster is being disabled or if the load balancer config is
already marked for delete.NotFound
- if cluster
or id
cannot be located.Unauthenticated
- if the user cannot be authenticated.Unauthorized
- if the user does not have Namespaces.Manage privilege.Unsupported
- if the specified cluster does not have vSphere Namespaces enabled.void set(java.lang.String cluster, java.lang.String id, LoadBalancersTypes.SetSpec spec, InvocationConfig invocationConfig)
spec
to an existing load balancer
configuration. This method was added in vSphere API 7.0.3.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.
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.
The parameter must be an identifier for the resource type: com.vmware.vcenter.namespace_management.LoadBalancerConfig
.spec
- Information about the load balancer object to be set.invocationConfig
- Configuration for the method invocation.Error
- if the system reports an error while responding to the request.InvalidArgument
- if if spec
contain any errors.NotAllowedInCurrentState
- if the associated cluster is being disabled or if the load balancer config is
already marked for delete.NotFound
- if cluster
or id
cannot be located.Unauthenticated
- if the user cannot be authenticated.Unauthorized
- if the user does not have Namespaces.Manage privilege.Unsupported
- if the specified cluster does not have vSphere Namespaces enabled.void set(java.lang.String cluster, java.lang.String id, LoadBalancersTypes.SetSpec spec, AsyncCallback<java.lang.Void> asyncCallback)
spec
to an existing load balancer
configuration. This method was added in vSphere API 7.0.3.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.
InvalidArgument
- if if spec
contain any errors.
NotAllowedInCurrentState
- if the associated cluster is being disabled or if the load balancer config is
already marked for delete.
NotFound
- if cluster
or id
cannot be located.
Unauthenticated
- if the user cannot be authenticated.
Unauthorized
- if the user does not have Namespaces.Manage privilege.
Unsupported
- if the specified cluster does not have vSphere Namespaces enabled.
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.
The parameter must be an identifier for the resource type: com.vmware.vcenter.namespace_management.LoadBalancerConfig
.spec
- Information about the load balancer object to be set.asyncCallback
- Receives the status (progress, result or error) of the operation invocation.void set(java.lang.String cluster, java.lang.String id, LoadBalancersTypes.SetSpec spec, AsyncCallback<java.lang.Void> asyncCallback, InvocationConfig invocationConfig)
spec
to an existing load balancer
configuration. This method was added in vSphere API 7.0.3.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.
InvalidArgument
- if if spec
contain any errors.
NotAllowedInCurrentState
- if the associated cluster is being disabled or if the load balancer config is
already marked for delete.
NotFound
- if cluster
or id
cannot be located.
Unauthenticated
- if the user cannot be authenticated.
Unauthorized
- if the user does not have Namespaces.Manage privilege.
Unsupported
- if the specified cluster does not have vSphere Namespaces enabled.
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.
The parameter must be an identifier for the resource type: com.vmware.vcenter.namespace_management.LoadBalancerConfig
.spec
- Information about the load balancer object to be set.asyncCallback
- Receives the status (progress, result or error) of the operation invocation.invocationConfig
- Configuration for the method invocation.void update(java.lang.String cluster, java.lang.String id, LoadBalancersTypes.UpdateSpec spec)
null
fields in spec
will leave those parts of
configuration as-is. This method was added in vSphere API 7.0.3.0.
Synchronous method overload. Result of the invocation will be reported as a method return value.
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.
The parameter must be an identifier for the resource type: com.vmware.vcenter.namespace_management.LoadBalancerConfig
.spec
- Information about the load balancer object to be updated.Error
- if the system reports an error while responding to the request.InvalidArgument
- if spec
contains any errors.InvalidArgument
- if if spec
contain any errors.NotAllowedInCurrentState
- if the associated cluster is being disabled or if the load balancer config is
already marked for delete.NotFound
- if cluster
or id
cannot be located.Unauthenticated
- if the user cannot be authenticated.Unauthorized
- if the user does not have Namespaces.Manage privilege.Unsupported
- if the specified cluster does not have vSphere Namespaces enabled.void update(java.lang.String cluster, java.lang.String id, LoadBalancersTypes.UpdateSpec spec, InvocationConfig invocationConfig)
null
fields in spec
will leave those parts of
configuration as-is. This method was added in vSphere API 7.0.3.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.
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.
The parameter must be an identifier for the resource type: com.vmware.vcenter.namespace_management.LoadBalancerConfig
.spec
- Information about the load balancer object to be updated.invocationConfig
- Configuration for the method invocation.Error
- if the system reports an error while responding to the request.InvalidArgument
- if spec
contains any errors.InvalidArgument
- if if spec
contain any errors.NotAllowedInCurrentState
- if the associated cluster is being disabled or if the load balancer config is
already marked for delete.NotFound
- if cluster
or id
cannot be located.Unauthenticated
- if the user cannot be authenticated.Unauthorized
- if the user does not have Namespaces.Manage privilege.Unsupported
- if the specified cluster does not have vSphere Namespaces enabled.void update(java.lang.String cluster, java.lang.String id, LoadBalancersTypes.UpdateSpec spec, AsyncCallback<java.lang.Void> asyncCallback)
null
fields in spec
will leave those parts of
configuration as-is. This method was added in vSphere API 7.0.3.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.
InvalidArgument
- if spec
contains any errors.
InvalidArgument
- if if spec
contain any errors.
NotAllowedInCurrentState
- if the associated cluster is being disabled or if the load balancer config is
already marked for delete.
NotFound
- if cluster
or id
cannot be located.
Unauthenticated
- if the user cannot be authenticated.
Unauthorized
- if the user does not have Namespaces.Manage privilege.
Unsupported
- if the specified cluster does not have vSphere Namespaces enabled.
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.
The parameter must be an identifier for the resource type: com.vmware.vcenter.namespace_management.LoadBalancerConfig
.spec
- Information about the load balancer object to be updated.asyncCallback
- Receives the status (progress, result or error) of the operation invocation.void update(java.lang.String cluster, java.lang.String id, LoadBalancersTypes.UpdateSpec spec, AsyncCallback<java.lang.Void> asyncCallback, InvocationConfig invocationConfig)
null
fields in spec
will leave those parts of
configuration as-is. This method was added in vSphere API 7.0.3.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.
InvalidArgument
- if spec
contains any errors.
InvalidArgument
- if if spec
contain any errors.
NotAllowedInCurrentState
- if the associated cluster is being disabled or if the load balancer config is
already marked for delete.
NotFound
- if cluster
or id
cannot be located.
Unauthenticated
- if the user cannot be authenticated.
Unauthorized
- if the user does not have Namespaces.Manage privilege.
Unsupported
- if the specified cluster does not have vSphere Namespaces enabled.
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.
The parameter must be an identifier for the resource type: com.vmware.vcenter.namespace_management.LoadBalancerConfig
.spec
- Information about the load balancer object to be updated.asyncCallback
- Receives the status (progress, result or error) of the operation invocation.invocationConfig
- Configuration for the method invocation.