com.vmware.vcenter.namespace_management

Class SupervisorsStub

java.lang.Object

com.vmware.vapi.internal.bindings.Stub

com.vmware.vcenter.namespace_management.SupervisorsStub

All Implemented Interfaces:

Service, Supervisors, SupervisorsTypes

public class SupervisorsStub
extends com.vmware.vapi.internal.bindings.Stub
implements Supervisors

Remote stub implementation of the Supervisors API service.

WARNING: Internal class, subject to change in future versions.

Nested Class Summary

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

SupervisorsTypes.EnableOnComputeClusterSpec, SupervisorsTypes.EnableOnZonesSpec, SupervisorsTypes.EnableSpec

Field Summary

Fields inherited from class com.vmware.vapi.internal.bindings.Stub

apiProvider, converter, ifaceId, retryPolicy, securityContext

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

_VAPI_SERVICE_ID

Constructor Summary

Constructors

Constructor and Description
SupervisorsStub(ApiProvider apiProvider, StubConfigurationBase config)
SupervisorsStub(ApiProvider apiProvider, com.vmware.vapi.internal.bindings.TypeConverter typeConverter, StubConfigurationBase config)

Method Summary

Modifier and Type	Method and Description
java.lang.String	enableOnComputeCluster(java.lang.String cluster, SupervisorsTypes.EnableOnComputeClusterSpec spec) Enable the Supervisor on a single vSphere cluster.
void	enableOnComputeCluster(java.lang.String cluster, SupervisorsTypes.EnableOnComputeClusterSpec spec, AsyncCallback<java.lang.String> asyncCallback) Enable the Supervisor on a single vSphere cluster.
void	enableOnComputeCluster(java.lang.String cluster, SupervisorsTypes.EnableOnComputeClusterSpec spec, AsyncCallback<java.lang.String> asyncCallback, InvocationConfig invocationConfig) Enable the Supervisor on a single vSphere cluster.
java.lang.String	enableOnComputeCluster(java.lang.String cluster, SupervisorsTypes.EnableOnComputeClusterSpec spec, InvocationConfig invocationConfig) Enable the Supervisor on a single vSphere cluster.
java.lang.String	enableOnZones(SupervisorsTypes.EnableOnZonesSpec spec) Enable a Supervisor on a set of vSphere Zones.
void	enableOnZones(SupervisorsTypes.EnableOnZonesSpec spec, AsyncCallback<java.lang.String> asyncCallback) Enable a Supervisor on a set of vSphere Zones.
void	enableOnZones(SupervisorsTypes.EnableOnZonesSpec spec, AsyncCallback<java.lang.String> asyncCallback, InvocationConfig invocationConfig) Enable a Supervisor on a set of vSphere Zones.
java.lang.String	enableOnZones(SupervisorsTypes.EnableOnZonesSpec spec, InvocationConfig invocationConfig) Enable a Supervisor on a set of vSphere Zones.

Methods inherited from class com.vmware.vapi.internal.bindings.Stub

invokeMethod, invokeMethodAsync, invokeStreamMethod, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

SupervisorsStub

public SupervisorsStub(ApiProvider apiProvider,
                       com.vmware.vapi.internal.bindings.TypeConverter typeConverter,
                       StubConfigurationBase config)

SupervisorsStub

public SupervisorsStub(ApiProvider apiProvider,
                       StubConfigurationBase config)

Method Detail

enableOnZones

public java.lang.String enableOnZones(SupervisorsTypes.EnableOnZonesSpec spec)

Description copied from interface: Supervisors

Enable a Supervisor on a set of vSphere Zones. The cluster control plane and its workloads will be eligible for placement across the zones. Enabling on multiple zones enables fault tolerance for applications deployed on more than one zone in case of a zone failure.

To verify if the Supervisor is compatible with the provided Zones use: ClusterCompatibility.list(com.vmware.vcenter.namespace_management.ClusterCompatibilityTypes.FilterSpec).

. This method was added in vSphere API 8.0.0.1.

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

Specified by:

enableOnZones in interface Supervisors

Parameters:

spec - Specification for configuring the Supervisor and Workloads.

Returns:

ID of the Supervisor object being enabled. The return value will be an identifier for the resource type: com.vmware.vcenter.namespace_management.supervisor.Supervisor.

enableOnZones

public java.lang.String enableOnZones(SupervisorsTypes.EnableOnZonesSpec spec,
                                      InvocationConfig invocationConfig)

Description copied from interface: Supervisors

Enable a Supervisor on a set of vSphere Zones. The cluster control plane and its workloads will be eligible for placement across the zones. Enabling on multiple zones enables fault tolerance for applications deployed on more than one zone in case of a zone failure.

To verify if the Supervisor is compatible with the provided Zones use: ClusterCompatibility.list(com.vmware.vcenter.namespace_management.ClusterCompatibilityTypes.FilterSpec).

. This method was added in vSphere API 8.0.0.1.

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

Specified by:

enableOnZones in interface Supervisors

Parameters:

spec - Specification for configuring the Supervisor and Workloads.

invocationConfig - Configuration for the method invocation.

Returns:

ID of the Supervisor object being enabled. The return value will be an identifier for the resource type: com.vmware.vcenter.namespace_management.supervisor.Supervisor.

enableOnZones

public void enableOnZones(SupervisorsTypes.EnableOnZonesSpec spec,
                          AsyncCallback<java.lang.String> asyncCallback)

Description copied from interface: Supervisors

Enable a Supervisor on a set of vSphere Zones. The cluster control plane and its workloads will be eligible for placement across the zones. Enabling on multiple zones enables fault tolerance for applications deployed on more than one zone in case of a zone failure.

To verify if the Supervisor is compatible with the provided Zones use: ClusterCompatibility.list(com.vmware.vcenter.namespace_management.ClusterCompatibilityTypes.FilterSpec).

. This method was added in vSphere API 8.0.0.1.

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

Invocation Result:
ID of the Supervisor object being enabled. The return value will be an identifier for the resource type: com.vmware.vcenter.namespace_management.supervisor.Supervisor.

Operation Errors:
AlreadyExists - if one or more zones already host a another Supervisor.
Error - if the system reports an error while responding to the request.
NotFound - if the provided zones could not be located.
InvalidArgument - if spec contains any errors.
UnableToAllocateResource - if the one or more zones are not licensed.
Unauthenticated - if the user can not be authenticated.
Unauthorized - if the user does not have Namespaces.Manage privilege.
Unsupported - if the zones are not supported for the Supervisor, the zones' hosts do not have the required ESX version, or for any other incompatibilities.

Specified by:

enableOnZones in interface Supervisors

Parameters:

spec - Specification for configuring the Supervisor and Workloads.

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

enableOnZones

public void enableOnZones(SupervisorsTypes.EnableOnZonesSpec spec,
                          AsyncCallback<java.lang.String> asyncCallback,
                          InvocationConfig invocationConfig)

Description copied from interface: Supervisors

Enable a Supervisor on a set of vSphere Zones. The cluster control plane and its workloads will be eligible for placement across the zones. Enabling on multiple zones enables fault tolerance for applications deployed on more than one zone in case of a zone failure.

To verify if the Supervisor is compatible with the provided Zones use: ClusterCompatibility.list(com.vmware.vcenter.namespace_management.ClusterCompatibilityTypes.FilterSpec).

. This method was added in vSphere API 8.0.0.1.

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:
ID of the Supervisor object being enabled. The return value will be an identifier for the resource type: com.vmware.vcenter.namespace_management.supervisor.Supervisor.

Operation Errors:
AlreadyExists - if one or more zones already host a another Supervisor.
Error - if the system reports an error while responding to the request.
NotFound - if the provided zones could not be located.
InvalidArgument - if spec contains any errors.
UnableToAllocateResource - if the one or more zones are not licensed.
Unauthenticated - if the user can not be authenticated.
Unauthorized - if the user does not have Namespaces.Manage privilege.
Unsupported - if the zones are not supported for the Supervisor, the zones' hosts do not have the required ESX version, or for any other incompatibilities.

Specified by:

enableOnZones in interface Supervisors

Parameters:

spec - Specification for configuring the Supervisor and Workloads.

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

invocationConfig - Configuration for the method invocation.

enableOnComputeCluster

public java.lang.String enableOnComputeCluster(java.lang.String cluster,
                                               SupervisorsTypes.EnableOnComputeClusterSpec spec)

Description copied from interface: Supervisors

Enable the Supervisor on a single vSphere cluster. This operation sets up the Kubernetes instance for the cluster along with worker nodes. A #com.vmware.vcenter.consumption-domains.Zones zone will automatically be created if the specified cluster is not already associated with a vSphere Zone.

To verify if the Supervisor is compatible with this vSphere cluster use: ClusterCompatibility.list(com.vmware.vcenter.namespace_management.ClusterCompatibilityTypes.FilterSpec).

A Supervisor can be running on one or multiple vSphere Zones, and each vSphere Zone is associated with one or more vSphere Clusters. If a Supervisor running on the specified vSphere Cluster is running on additional vSphere Clusters, this operation will apply to Supervisor components running on the other vSphere Clusters in addition to the specified vSphere Cluster.

To call this API on a Supervisor with multiple vSphere Clusters, use Topology.get(java.lang.String) to get the vSphere Clusters associated with the given Supervisor. Any cluster from the list returned can be used as the input of this API.

. This method was added in vSphere API 8.0.0.1.

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

Specified by:

enableOnComputeCluster in interface Supervisors

Parameters:

cluster - Identifier for the cluster used to enable the Supervisor Cluster. The parameter must be an identifier for the resource type: ClusterComputeResource.

spec - Specification for configuring the Supervisor and Workloads.

Returns:

ID of the Supervisor object being enabled. The return value will be an identifier for the resource type: com.vmware.vcenter.namespace_management.supervisor.Supervisor.

enableOnComputeCluster

public java.lang.String enableOnComputeCluster(java.lang.String cluster,
                                               SupervisorsTypes.EnableOnComputeClusterSpec spec,
                                               InvocationConfig invocationConfig)

Description copied from interface: Supervisors

Enable the Supervisor on a single vSphere cluster. This operation sets up the Kubernetes instance for the cluster along with worker nodes. A #com.vmware.vcenter.consumption-domains.Zones zone will automatically be created if the specified cluster is not already associated with a vSphere Zone.

To verify if the Supervisor is compatible with this vSphere cluster use: ClusterCompatibility.list(com.vmware.vcenter.namespace_management.ClusterCompatibilityTypes.FilterSpec).

A Supervisor can be running on one or multiple vSphere Zones, and each vSphere Zone is associated with one or more vSphere Clusters. If a Supervisor running on the specified vSphere Cluster is running on additional vSphere Clusters, this operation will apply to Supervisor components running on the other vSphere Clusters in addition to the specified vSphere Cluster.

To call this API on a Supervisor with multiple vSphere Clusters, use Topology.get(java.lang.String) to get the vSphere Clusters associated with the given Supervisor. Any cluster from the list returned can be used as the input of this API.

. This method was added in vSphere API 8.0.0.1.

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

Specified by:

enableOnComputeCluster in interface Supervisors

Parameters:

cluster - Identifier for the cluster used to enable the Supervisor Cluster. The parameter must be an identifier for the resource type: ClusterComputeResource.

spec - Specification for configuring the Supervisor and Workloads.

invocationConfig - Configuration for the method invocation.

Returns:

ID of the Supervisor object being enabled. The return value will be an identifier for the resource type: com.vmware.vcenter.namespace_management.supervisor.Supervisor.

enableOnComputeCluster

public void enableOnComputeCluster(java.lang.String cluster,
                                   SupervisorsTypes.EnableOnComputeClusterSpec spec,
                                   AsyncCallback<java.lang.String> asyncCallback)

Description copied from interface: Supervisors

Enable the Supervisor on a single vSphere cluster. This operation sets up the Kubernetes instance for the cluster along with worker nodes. A #com.vmware.vcenter.consumption-domains.Zones zone will automatically be created if the specified cluster is not already associated with a vSphere Zone.

To verify if the Supervisor is compatible with this vSphere cluster use: ClusterCompatibility.list(com.vmware.vcenter.namespace_management.ClusterCompatibilityTypes.FilterSpec).

A Supervisor can be running on one or multiple vSphere Zones, and each vSphere Zone is associated with one or more vSphere Clusters. If a Supervisor running on the specified vSphere Cluster is running on additional vSphere Clusters, this operation will apply to Supervisor components running on the other vSphere Clusters in addition to the specified vSphere Cluster.

To call this API on a Supervisor with multiple vSphere Clusters, use Topology.get(java.lang.String) to get the vSphere Clusters associated with the given Supervisor. Any cluster from the list returned can be used as the input of this API.

. This method was added in vSphere API 8.0.0.1.

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

Invocation Result:
ID of the Supervisor object being enabled. The return value will be an identifier for the resource type: com.vmware.vcenter.namespace_management.supervisor.Supervisor.

Operation Errors:
AlreadyExists - if the cluster already has the Supervisor enabled.
Error - if the system reports an error while responding to the request.
NotFound - if resources/objects could not be located.
InvalidArgument - if spec contains any errors.
UnableToAllocateResource - if the specified cluster is not licensed.
Unauthenticated - if the user can not be authenticated.
Unauthorized - if the user does not have Namespaces.Manage privilege.
Unsupported - if the specified cluster is not supported for the Supervisor, the cluster's hosts do not have the required ESX version, or for any other incompatibilities.

Specified by:

enableOnComputeCluster in interface Supervisors

Parameters:

cluster - Identifier for the cluster used to enable the Supervisor Cluster. The parameter must be an identifier for the resource type: ClusterComputeResource.

spec - Specification for configuring the Supervisor and Workloads.

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

enableOnComputeCluster

public void enableOnComputeCluster(java.lang.String cluster,
                                   SupervisorsTypes.EnableOnComputeClusterSpec spec,
                                   AsyncCallback<java.lang.String> asyncCallback,
                                   InvocationConfig invocationConfig)

Description copied from interface: Supervisors

Enable the Supervisor on a single vSphere cluster. This operation sets up the Kubernetes instance for the cluster along with worker nodes. A #com.vmware.vcenter.consumption-domains.Zones zone will automatically be created if the specified cluster is not already associated with a vSphere Zone.

To verify if the Supervisor is compatible with this vSphere cluster use: ClusterCompatibility.list(com.vmware.vcenter.namespace_management.ClusterCompatibilityTypes.FilterSpec).

A Supervisor can be running on one or multiple vSphere Zones, and each vSphere Zone is associated with one or more vSphere Clusters. If a Supervisor running on the specified vSphere Cluster is running on additional vSphere Clusters, this operation will apply to Supervisor components running on the other vSphere Clusters in addition to the specified vSphere Cluster.

To call this API on a Supervisor with multiple vSphere Clusters, use Topology.get(java.lang.String) to get the vSphere Clusters associated with the given Supervisor. Any cluster from the list returned can be used as the input of this API.

. This method was added in vSphere API 8.0.0.1.

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:
ID of the Supervisor object being enabled. The return value will be an identifier for the resource type: com.vmware.vcenter.namespace_management.supervisor.Supervisor.

Operation Errors:
AlreadyExists - if the cluster already has the Supervisor enabled.
Error - if the system reports an error while responding to the request.
NotFound - if resources/objects could not be located.
InvalidArgument - if spec contains any errors.
UnableToAllocateResource - if the specified cluster is not licensed.
Unauthenticated - if the user can not be authenticated.
Unauthorized - if the user does not have Namespaces.Manage privilege.
Unsupported - if the specified cluster is not supported for the Supervisor, the cluster's hosts do not have the required ESX version, or for any other incompatibilities.

Specified by:

enableOnComputeCluster in interface Supervisors

Parameters:

cluster - Identifier for the cluster used to enable the Supervisor Cluster. The parameter must be an identifier for the resource type: ClusterComputeResource.

spec - Specification for configuring the Supervisor and Workloads.

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

invocationConfig - Configuration for the method invocation.