com.vmware.vcenter.namespace_management.supervisor_services

Interface ClusterSupervisorServices

All Superinterfaces:

ClusterSupervisorServicesTypes, Service

All Known Implementing Classes:

ClusterSupervisorServicesStub

public interface ClusterSupervisorServices
extends Service, ClusterSupervisorServicesTypes

The ClusterSupervisorServices interface provides methods to manage a Supervisor Service on the vSphere Supervisor clusters. This interface was added in vSphere API 7.0.3.0.

Nested Class Summary

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

ClusterSupervisorServicesTypes.ConfigStatus, ClusterSupervisorServicesTypes.CreateSpec, ClusterSupervisorServicesTypes.Info, ClusterSupervisorServicesTypes.Message, ClusterSupervisorServicesTypes.SetSpec, ClusterSupervisorServicesTypes.Summary

Field Summary

Fields inherited from interface com.vmware.vcenter.namespace_management.supervisor_services.ClusterSupervisorServicesTypes

_VAPI_SERVICE_ID

Method Summary

Modifier and Type	Method and Description
void	create(java.lang.String cluster, ClusterSupervisorServicesTypes.CreateSpec spec) Create a Supervisor Service on the specified vSphere Supervisor cluster.
void	create(java.lang.String cluster, ClusterSupervisorServicesTypes.CreateSpec spec, AsyncCallback<java.lang.Void> asyncCallback) Create a Supervisor Service on the specified vSphere Supervisor cluster.
void	create(java.lang.String cluster, ClusterSupervisorServicesTypes.CreateSpec spec, AsyncCallback<java.lang.Void> asyncCallback, InvocationConfig invocationConfig) Create a Supervisor Service on the specified vSphere Supervisor cluster.
void	create(java.lang.String cluster, ClusterSupervisorServicesTypes.CreateSpec spec, InvocationConfig invocationConfig) Create a Supervisor Service on the specified vSphere Supervisor cluster.
void	delete(java.lang.String cluster, java.lang.String supervisorService) Delete a Supervisor Service on the specified vSphere Supervisor cluster.
void	delete(java.lang.String cluster, java.lang.String supervisorService, AsyncCallback<java.lang.Void> asyncCallback) Delete a Supervisor Service on the specified vSphere Supervisor cluster.
void	delete(java.lang.String cluster, java.lang.String supervisorService, AsyncCallback<java.lang.Void> asyncCallback, InvocationConfig invocationConfig) Delete a Supervisor Service on the specified vSphere Supervisor cluster.
void	delete(java.lang.String cluster, java.lang.String supervisorService, InvocationConfig invocationConfig) Delete a Supervisor Service on the specified vSphere Supervisor cluster.
ClusterSupervisorServicesTypes.Info	get(java.lang.String cluster, java.lang.String supervisorService) Return information about the specific Supervisor Service on the specified vSphere Supervisor cluster.
void	get(java.lang.String cluster, java.lang.String supervisorService, AsyncCallback<ClusterSupervisorServicesTypes.Info> asyncCallback) Return information about the specific Supervisor Service on the specified vSphere Supervisor cluster.
void	get(java.lang.String cluster, java.lang.String supervisorService, AsyncCallback<ClusterSupervisorServicesTypes.Info> asyncCallback, InvocationConfig invocationConfig) Return information about the specific Supervisor Service on the specified vSphere Supervisor cluster.
ClusterSupervisorServicesTypes.Info	get(java.lang.String cluster, java.lang.String supervisorService, InvocationConfig invocationConfig) Return information about the specific Supervisor Service on the specified vSphere Supervisor cluster.
java.util.List<ClusterSupervisorServicesTypes.Summary>	list(java.lang.String cluster) Return the summaries about all Supervisor Services on the specified vSphere Supervisor cluster.
void	list(java.lang.String cluster, AsyncCallback<java.util.List<ClusterSupervisorServicesTypes.Summary>> asyncCallback) Return the summaries about all Supervisor Services on the specified vSphere Supervisor cluster.
void	list(java.lang.String cluster, AsyncCallback<java.util.List<ClusterSupervisorServicesTypes.Summary>> asyncCallback, InvocationConfig invocationConfig) Return the summaries about all Supervisor Services on the specified vSphere Supervisor cluster.
java.util.List<ClusterSupervisorServicesTypes.Summary>	list(java.lang.String cluster, InvocationConfig invocationConfig) Return the summaries about all Supervisor Services on the specified vSphere Supervisor cluster.
void	set(java.lang.String cluster, java.lang.String supervisorService, ClusterSupervisorServicesTypes.SetSpec spec) Set a new configuration to the specified Supervisor Service on the specified vSphere Supervisor cluster.
void	set(java.lang.String cluster, java.lang.String supervisorService, ClusterSupervisorServicesTypes.SetSpec spec, AsyncCallback<java.lang.Void> asyncCallback) Set a new configuration to the specified Supervisor Service on the specified vSphere Supervisor cluster.
void	set(java.lang.String cluster, java.lang.String supervisorService, ClusterSupervisorServicesTypes.SetSpec spec, AsyncCallback<java.lang.Void> asyncCallback, InvocationConfig invocationConfig) Set a new configuration to the specified Supervisor Service on the specified vSphere Supervisor cluster.
void	set(java.lang.String cluster, java.lang.String supervisorService, ClusterSupervisorServicesTypes.SetSpec spec, InvocationConfig invocationConfig) Set a new configuration to the specified Supervisor Service on the specified vSphere Supervisor cluster.

Method Detail

create

void create(java.lang.String cluster,
            ClusterSupervisorServicesTypes.CreateSpec spec)

Create a Supervisor Service on the specified vSphere Supervisor cluster. This method will apply the Supervisor Service version's service definition on the cluster. This method is possible only when the Supervisor Service and Supervisor Service version are in the State#ACTIVATED state. 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.

Parameters:

cluster - Identifier for the Supervisor cluster on which to create the service. The parameter must be an identifier for the resource type: ClusterComputeResource.

spec - Specification for the Supervisor Service on the cluster.

Throws:

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

InvalidArgument - if spec contains any errors.

AlreadyExists - if a Supervisor Service with the ID supervisorService exists on the Supervisor cluster

NotFound - if the specified cluster with ID cluster or Supervisor Service with the ID supervisorService or version with the ID {param.name version} could not be located.

NotAllowedInCurrentState - if the Supervisor cluster doesn't support Supervisor Services, or if the Supervisor Service cannot be created in the current state, e.g. the supervisor service version is in the State#DEACTIVATED state.

Unauthenticated - if the user cannot be authenticated.

Unauthorized - if the user does not have the SupervisorServices.Manage privilege on the specified cluster.

create

void create(java.lang.String cluster,
            ClusterSupervisorServicesTypes.CreateSpec spec,
            InvocationConfig invocationConfig)

Create a Supervisor Service on the specified vSphere Supervisor cluster. This method will apply the Supervisor Service version's service definition on the cluster. This method is possible only when the Supervisor Service and Supervisor Service version are in the State#ACTIVATED state. 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.

Parameters:

cluster - Identifier for the Supervisor cluster on which to create the service. The parameter must be an identifier for the resource type: ClusterComputeResource.

spec - Specification for the Supervisor Service on the cluster.

invocationConfig - Configuration for the method invocation.

Throws:

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

InvalidArgument - if spec contains any errors.

AlreadyExists - if a Supervisor Service with the ID supervisorService exists on the Supervisor cluster

NotFound - if the specified cluster with ID cluster or Supervisor Service with the ID supervisorService or version with the ID {param.name version} could not be located.

NotAllowedInCurrentState - if the Supervisor cluster doesn't support Supervisor Services, or if the Supervisor Service cannot be created in the current state, e.g. the supervisor service version is in the State#DEACTIVATED state.

Unauthenticated - if the user cannot be authenticated.

Unauthorized - if the user does not have the SupervisorServices.Manage privilege on the specified cluster.

create

void create(java.lang.String cluster,
            ClusterSupervisorServicesTypes.CreateSpec spec,
            AsyncCallback<java.lang.Void> asyncCallback)

Create a Supervisor Service on the specified vSphere Supervisor cluster. This method will apply the Supervisor Service version's service definition on the cluster. This method is possible only when the Supervisor Service and Supervisor Service version are in the State#ACTIVATED state. 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.
AlreadyExists - if a Supervisor Service with the ID supervisorService exists on the Supervisor cluster
NotFound - if the specified cluster with ID cluster or Supervisor Service with the ID supervisorService or version with the ID {param.name version} could not be located.
NotAllowedInCurrentState - if the Supervisor cluster doesn't support Supervisor Services, or if the Supervisor Service cannot be created in the current state, e.g. the supervisor service version is in the State#DEACTIVATED state.
Unauthenticated - if the user cannot be authenticated.
Unauthorized - if the user does not have the SupervisorServices.Manage privilege on the specified cluster.

Parameters:

cluster - Identifier for the Supervisor cluster on which to create the service. The parameter must be an identifier for the resource type: ClusterComputeResource.

spec - Specification for the Supervisor Service on the cluster.

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

create

void create(java.lang.String cluster,
            ClusterSupervisorServicesTypes.CreateSpec spec,
            AsyncCallback<java.lang.Void> asyncCallback,
            InvocationConfig invocationConfig)

Create a Supervisor Service on the specified vSphere Supervisor cluster. This method will apply the Supervisor Service version's service definition on the cluster. This method is possible only when the Supervisor Service and Supervisor Service version are in the State#ACTIVATED state. 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.
AlreadyExists - if a Supervisor Service with the ID supervisorService exists on the Supervisor cluster
NotFound - if the specified cluster with ID cluster or Supervisor Service with the ID supervisorService or version with the ID {param.name version} could not be located.
NotAllowedInCurrentState - if the Supervisor cluster doesn't support Supervisor Services, or if the Supervisor Service cannot be created in the current state, e.g. the supervisor service version is in the State#DEACTIVATED state.
Unauthenticated - if the user cannot be authenticated.
Unauthorized - if the user does not have the SupervisorServices.Manage privilege on the specified cluster.

Parameters:

cluster - Identifier for the Supervisor cluster on which to create the service. The parameter must be an identifier for the resource type: ClusterComputeResource.

spec - Specification for the Supervisor Service on the cluster.

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

invocationConfig - Configuration for the method invocation.

list

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

Return the summaries about all Supervisor Services on the specified vSphere Supervisor cluster. 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.

Parameters:

cluster - Identifier for the cluster on which to list the services. The parameter must be an identifier for the resource type: ClusterComputeResource.

Returns:

The list of summaries of all Supervisor Services on the cluster.

Throws:

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

NotFound - if Supervisor cluster with the ID cluster could not be located.

NotAllowedInCurrentState - if the Supervisor cluster doesn't support Supervisor Services.

Unauthenticated - if the user cannot be authenticated.

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

list

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

Return the summaries about all Supervisor Services on the specified vSphere Supervisor cluster. 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.

Parameters:

cluster - Identifier for the cluster on which to list the services. The parameter must be an identifier for the resource type: ClusterComputeResource.

invocationConfig - Configuration for the method invocation.

Returns:

The list of summaries of all Supervisor Services on the cluster.

Throws:

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

NotFound - if Supervisor cluster with the ID cluster could not be located.

NotAllowedInCurrentState - if the Supervisor cluster doesn't support Supervisor Services.

Unauthenticated - if the user cannot be authenticated.

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

list

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

Return the summaries about all Supervisor Services on the specified vSphere Supervisor cluster. 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.

Invocation Result:
The list of summaries of all Supervisor Services on the cluster.

Operation Errors:
Error - if the system reports an error while responding to the request.
NotFound - if Supervisor cluster with the ID cluster could not be located.
NotAllowedInCurrentState - if the Supervisor cluster doesn't support Supervisor Services.
Unauthenticated - if the user cannot be authenticated.
Unauthorized - if the user does not have the System.Read privilege on the specified cluster.

Parameters:

cluster - Identifier for the cluster on which to list the services. 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<ClusterSupervisorServicesTypes.Summary>> asyncCallback,
          InvocationConfig invocationConfig)

Return the summaries about all Supervisor Services on the specified vSphere Supervisor cluster. 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.

Invocation Result:
The list of summaries of all Supervisor Services on the cluster.

Operation Errors:
Error - if the system reports an error while responding to the request.
NotFound - if Supervisor cluster with the ID cluster could not be located.
NotAllowedInCurrentState - if the Supervisor cluster doesn't support Supervisor Services.
Unauthenticated - if the user cannot be authenticated.
Unauthorized - if the user does not have the System.Read privilege on the specified cluster.

Parameters:

cluster - Identifier for the cluster on which to list the services. 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.

get

ClusterSupervisorServicesTypes.Info get(java.lang.String cluster,
                                        java.lang.String supervisorService)

Return information about the specific Supervisor Service on the specified vSphere Supervisor cluster. 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.

Parameters:

cluster - Identifier for the cluster on which to get the service. The parameter must be an identifier for the resource type: ClusterComputeResource.

supervisorService - Identifier for the Supervisor Service. The parameter must be an identifier for the resource type: com.vmware.vcenter.namespace_management.SupervisorService.

Returns:

The information for the specified Supervisor Service on the specified cluster.

Throws:

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

NotFound - if Supervisor cluster with the ID cluster or the Supervisor Service does not exist on the Supervisor cluster.

NotAllowedInCurrentState - if the Supervisor cluster doesn't support Supervisor Services.

Unauthenticated - if the user cannot be authenticated.

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

get

ClusterSupervisorServicesTypes.Info get(java.lang.String cluster,
                                        java.lang.String supervisorService,
                                        InvocationConfig invocationConfig)

Return information about the specific Supervisor Service on the specified vSphere Supervisor cluster. 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.

Parameters:

cluster - Identifier for the cluster on which to get the service. The parameter must be an identifier for the resource type: ClusterComputeResource.

supervisorService - Identifier for the Supervisor Service. The parameter must be an identifier for the resource type: com.vmware.vcenter.namespace_management.SupervisorService.

invocationConfig - Configuration for the method invocation.

Returns:

The information for the specified Supervisor Service on the specified cluster.

Throws:

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

NotFound - if Supervisor cluster with the ID cluster or the Supervisor Service does not exist on the Supervisor cluster.

NotAllowedInCurrentState - if the Supervisor cluster doesn't support Supervisor Services.

Unauthenticated - if the user cannot be authenticated.

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

get

void get(java.lang.String cluster,
         java.lang.String supervisorService,
         AsyncCallback<ClusterSupervisorServicesTypes.Info> asyncCallback)

Return information about the specific Supervisor Service on the specified vSphere Supervisor cluster. 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.

Invocation Result:
The information for the specified Supervisor Service on the specified cluster.

Operation Errors:
Error - if the system reports an error while responding to the request.
NotFound - if Supervisor cluster with the ID cluster or the Supervisor Service does not exist on the Supervisor cluster.
NotAllowedInCurrentState - if the Supervisor cluster doesn't support Supervisor Services.
Unauthenticated - if the user cannot be authenticated.
Unauthorized - if the user does not have the System.Read privilege on the specified cluster.

Parameters:

cluster - Identifier for the cluster on which to get the service. The parameter must be an identifier for the resource type: ClusterComputeResource.

supervisorService - Identifier for the Supervisor Service. The parameter must be an identifier for the resource type: com.vmware.vcenter.namespace_management.SupervisorService.

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

get

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

Return information about the specific Supervisor Service on the specified vSphere Supervisor cluster. 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.

Invocation Result:
The information for the specified Supervisor Service on the specified cluster.

Operation Errors:
Error - if the system reports an error while responding to the request.
NotFound - if Supervisor cluster with the ID cluster or the Supervisor Service does not exist on the Supervisor cluster.
NotAllowedInCurrentState - if the Supervisor cluster doesn't support Supervisor Services.
Unauthenticated - if the user cannot be authenticated.
Unauthorized - if the user does not have the System.Read privilege on the specified cluster.

Parameters:

cluster - Identifier for the cluster on which to get the service. The parameter must be an identifier for the resource type: ClusterComputeResource.

supervisorService - Identifier for the Supervisor Service. The parameter must be an identifier for the resource type: com.vmware.vcenter.namespace_management.SupervisorService.

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

invocationConfig - Configuration for the method invocation.

delete

void delete(java.lang.String cluster,
            java.lang.String supervisorService)

Delete a Supervisor Service on the specified vSphere Supervisor cluster. This method will remove the Supervisor Service with the specified identifier from the cluster, by removing the corresponding namespace and deleting the operator(s) associated with the Supervisor Service. Note that this operation doesn't deal with the application instances that are created by the associated operator(s), so existing application instances could be orphaned if users don't clean or migrate them. 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.

Parameters:

cluster - Identifier for the Supervisor cluster from which to delete the service. The parameter must be an identifier for the resource type: ClusterComputeResource.

supervisorService - Identifier for the Supervisor Service. The parameter must be an identifier for the resource type: com.vmware.vcenter.namespace_management.SupervisorService.

Throws:

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

NotFound - if Supervisor cluster with the ID cluster or the Supervisor Service does not exist on the Supervisor cluster.

NotAllowedInCurrentState - if the Supervisor cluster doesn't support Supervisor Services.

Unauthenticated - if the user cannot be authenticated.

Unauthorized - if the user does not have the SupervisorServices.Manage privilege on the specified cluster.

delete

void delete(java.lang.String cluster,
            java.lang.String supervisorService,
            InvocationConfig invocationConfig)

Delete a Supervisor Service on the specified vSphere Supervisor cluster. This method will remove the Supervisor Service with the specified identifier from the cluster, by removing the corresponding namespace and deleting the operator(s) associated with the Supervisor Service. Note that this operation doesn't deal with the application instances that are created by the associated operator(s), so existing application instances could be orphaned if users don't clean or migrate them. 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.

Parameters:

cluster - Identifier for the Supervisor cluster from which to delete the service. The parameter must be an identifier for the resource type: ClusterComputeResource.

supervisorService - Identifier for the Supervisor Service. The parameter must be an identifier for the resource type: com.vmware.vcenter.namespace_management.SupervisorService.

invocationConfig - Configuration for the method invocation.

Throws:

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

NotFound - if Supervisor cluster with the ID cluster or the Supervisor Service does not exist on the Supervisor cluster.

NotAllowedInCurrentState - if the Supervisor cluster doesn't support Supervisor Services.

Unauthenticated - if the user cannot be authenticated.

Unauthorized - if the user does not have the SupervisorServices.Manage privilege on the specified cluster.

delete

void delete(java.lang.String cluster,
            java.lang.String supervisorService,
            AsyncCallback<java.lang.Void> asyncCallback)

Delete a Supervisor Service on the specified vSphere Supervisor cluster. This method will remove the Supervisor Service with the specified identifier from the cluster, by removing the corresponding namespace and deleting the operator(s) associated with the Supervisor Service. Note that this operation doesn't deal with the application instances that are created by the associated operator(s), so existing application instances could be orphaned if users don't clean or migrate them. 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.
NotFound - if Supervisor cluster with the ID cluster or the Supervisor Service does not exist on the Supervisor cluster.
NotAllowedInCurrentState - if the Supervisor cluster doesn't support Supervisor Services.
Unauthenticated - if the user cannot be authenticated.
Unauthorized - if the user does not have the SupervisorServices.Manage privilege on the specified cluster.

Parameters:

cluster - Identifier for the Supervisor cluster from which to delete the service. The parameter must be an identifier for the resource type: ClusterComputeResource.

supervisorService - Identifier for the Supervisor Service. The parameter must be an identifier for the resource type: com.vmware.vcenter.namespace_management.SupervisorService.

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

delete

void delete(java.lang.String cluster,
            java.lang.String supervisorService,
            AsyncCallback<java.lang.Void> asyncCallback,
            InvocationConfig invocationConfig)

Delete a Supervisor Service on the specified vSphere Supervisor cluster. This method will remove the Supervisor Service with the specified identifier from the cluster, by removing the corresponding namespace and deleting the operator(s) associated with the Supervisor Service. Note that this operation doesn't deal with the application instances that are created by the associated operator(s), so existing application instances could be orphaned if users don't clean or migrate them. 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.
NotFound - if Supervisor cluster with the ID cluster or the Supervisor Service does not exist on the Supervisor cluster.
NotAllowedInCurrentState - if the Supervisor cluster doesn't support Supervisor Services.
Unauthenticated - if the user cannot be authenticated.
Unauthorized - if the user does not have the SupervisorServices.Manage privilege on the specified cluster.

Parameters:

cluster - Identifier for the Supervisor cluster from which to delete the service. The parameter must be an identifier for the resource type: ClusterComputeResource.

supervisorService - Identifier for the Supervisor Service. The parameter must be an identifier for the resource type: com.vmware.vcenter.namespace_management.SupervisorService.

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

invocationConfig - Configuration for the method invocation.

set

void set(java.lang.String cluster,
         java.lang.String supervisorService,
         ClusterSupervisorServicesTypes.SetSpec spec)

Set a new configuration to the specified Supervisor Service on the specified vSphere Supervisor cluster. This method will apply the new Supervisor Service version's service definition to the existing Supervisor Service on the cluster. This method requires that the specified Supervisor Service is already installed in the specified vSphere Supervisor cluster. Note that this operation doesn't interfere with the application instances that are created by the associated operator(s). So users should make sure the new version is still compatible with the existing application instances. 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.

Parameters:

cluster - Identifier for the Supervisor cluster from which to delete the service. The parameter must be an identifier for the resource type: ClusterComputeResource.

supervisorService - Identifier for the Supervisor Service. The parameter must be an identifier for the resource type: com.vmware.vcenter.namespace_management.SupervisorService.

spec - Specification for the Supervisor Service on the cluster.

Throws:

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

InvalidArgument - if spec contains any errors.

NotFound - if Supervisor cluster with the ID cluster or Supervisor Service with the ID supervisorService or version with the ID {param.name version} could not be located, or the Supervisor Service does not exist on the Supervisor cluster.

NotAllowedInCurrentState - if the Supervisor cluster doesn't support Supervisor Services or the specified version is not in the State#ACTIVATED state.

Unauthenticated - if the user cannot be authenticated.

Unauthorized - if the user does not have the SupervisorServices.Manage privilege on the specified cluster.

set

void set(java.lang.String cluster,
         java.lang.String supervisorService,
         ClusterSupervisorServicesTypes.SetSpec spec,
         InvocationConfig invocationConfig)

Set a new configuration to the specified Supervisor Service on the specified vSphere Supervisor cluster. This method will apply the new Supervisor Service version's service definition to the existing Supervisor Service on the cluster. This method requires that the specified Supervisor Service is already installed in the specified vSphere Supervisor cluster. Note that this operation doesn't interfere with the application instances that are created by the associated operator(s). So users should make sure the new version is still compatible with the existing application instances. 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.

Parameters:

cluster - Identifier for the Supervisor cluster from which to delete the service. The parameter must be an identifier for the resource type: ClusterComputeResource.

supervisorService - Identifier for the Supervisor Service. The parameter must be an identifier for the resource type: com.vmware.vcenter.namespace_management.SupervisorService.

spec - Specification for the Supervisor Service on the cluster.

invocationConfig - Configuration for the method invocation.

Throws:

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

InvalidArgument - if spec contains any errors.

NotFound - if Supervisor cluster with the ID cluster or Supervisor Service with the ID supervisorService or version with the ID {param.name version} could not be located, or the Supervisor Service does not exist on the Supervisor cluster.

NotAllowedInCurrentState - if the Supervisor cluster doesn't support Supervisor Services or the specified version is not in the State#ACTIVATED state.

Unauthenticated - if the user cannot be authenticated.

Unauthorized - if the user does not have the SupervisorServices.Manage privilege on the specified cluster.

set

void set(java.lang.String cluster,
         java.lang.String supervisorService,
         ClusterSupervisorServicesTypes.SetSpec spec,
         AsyncCallback<java.lang.Void> asyncCallback)

Set a new configuration to the specified Supervisor Service on the specified vSphere Supervisor cluster. This method will apply the new Supervisor Service version's service definition to the existing Supervisor Service on the cluster. This method requires that the specified Supervisor Service is already installed in the specified vSphere Supervisor cluster. Note that this operation doesn't interfere with the application instances that are created by the associated operator(s). So users should make sure the new version is still compatible with the existing application instances. 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.
NotFound - if Supervisor cluster with the ID cluster or Supervisor Service with the ID supervisorService or version with the ID {param.name version} could not be located, or the Supervisor Service does not exist on the Supervisor cluster.
NotAllowedInCurrentState - if the Supervisor cluster doesn't support Supervisor Services or the specified version is not in the State#ACTIVATED state.
Unauthenticated - if the user cannot be authenticated.
Unauthorized - if the user does not have the SupervisorServices.Manage privilege on the specified cluster.

Parameters:

cluster - Identifier for the Supervisor cluster from which to delete the service. The parameter must be an identifier for the resource type: ClusterComputeResource.

supervisorService - Identifier for the Supervisor Service. The parameter must be an identifier for the resource type: com.vmware.vcenter.namespace_management.SupervisorService.

spec - Specification for the Supervisor Service on the cluster.

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

set

void set(java.lang.String cluster,
         java.lang.String supervisorService,
         ClusterSupervisorServicesTypes.SetSpec spec,
         AsyncCallback<java.lang.Void> asyncCallback,
         InvocationConfig invocationConfig)

Set a new configuration to the specified Supervisor Service on the specified vSphere Supervisor cluster. This method will apply the new Supervisor Service version's service definition to the existing Supervisor Service on the cluster. This method requires that the specified Supervisor Service is already installed in the specified vSphere Supervisor cluster. Note that this operation doesn't interfere with the application instances that are created by the associated operator(s). So users should make sure the new version is still compatible with the existing application instances. 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.
NotFound - if Supervisor cluster with the ID cluster or Supervisor Service with the ID supervisorService or version with the ID {param.name version} could not be located, or the Supervisor Service does not exist on the Supervisor cluster.
NotAllowedInCurrentState - if the Supervisor cluster doesn't support Supervisor Services or the specified version is not in the State#ACTIVATED state.
Unauthenticated - if the user cannot be authenticated.
Unauthorized - if the user does not have the SupervisorServices.Manage privilege on the specified cluster.

Parameters:

cluster - Identifier for the Supervisor cluster from which to delete the service. The parameter must be an identifier for the resource type: ClusterComputeResource.

supervisorService - Identifier for the Supervisor Service. The parameter must be an identifier for the resource type: com.vmware.vcenter.namespace_management.SupervisorService.

spec - Specification for the Supervisor Service on the cluster.

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

invocationConfig - Configuration for the method invocation.