com.vmware.vcenter.namespace_management.supervisors

Interface Summary

All Superinterfaces:

Service, SummaryTypes

All Known Implementing Classes:

SummaryStub

public interface Summary
extends Service, SummaryTypes

The Summary interface provides methods to retrieve the current states of Supervisors.

Only the basic information of the given Supervisor is being queried.

. This interface was added in vSphere API 8.0.0.1.

Nested Class Summary

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

SummaryTypes.ConfigStatus, SummaryTypes.FilterSpec, SummaryTypes.Info, SummaryTypes.KubernetesStatus, SummaryTypes.ListItem, SummaryTypes.ListResult, SummaryTypes.Stats

Field Summary

Fields inherited from interface com.vmware.vcenter.namespace_management.supervisors.SummaryTypes

_VAPI_SERVICE_ID

Method Summary

Modifier and Type	Method and Description
SummaryTypes.Info	get(java.lang.String supervisor) Queries the current state of the specified Supervisor.
void	get(java.lang.String supervisor, AsyncCallback<SummaryTypes.Info> asyncCallback) Queries the current state of the specified Supervisor.
void	get(java.lang.String supervisor, AsyncCallback<SummaryTypes.Info> asyncCallback, InvocationConfig invocationConfig) Queries the current state of the specified Supervisor.
SummaryTypes.Info	get(java.lang.String supervisor, InvocationConfig invocationConfig) Queries the current state of the specified Supervisor.
SummaryTypes.ListResult	list(SummaryTypes.FilterSpec filter) Queries the current state of all Supervisors.
void	list(SummaryTypes.FilterSpec filter, AsyncCallback<SummaryTypes.ListResult> asyncCallback) Queries the current state of all Supervisors.
void	list(SummaryTypes.FilterSpec filter, AsyncCallback<SummaryTypes.ListResult> asyncCallback, InvocationConfig invocationConfig) Queries the current state of all Supervisors.
SummaryTypes.ListResult	list(SummaryTypes.FilterSpec filter, InvocationConfig invocationConfig) Queries the current state of all Supervisors.

Method Detail

get

SummaryTypes.Info get(java.lang.String supervisor)

Queries the current state of the specified Supervisor. 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.

Parameters:

supervisor - the identifier for a supervisor The parameter must be an identifier for the resource type: com.vmware.vcenter.namespace_management.supervisor.Supervisor.

Returns:

SummaryTypes.Info of the Supervisor matching the provided identifier.

Throws:

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

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

NotFound - if the Supervisor matching the ID does not exist.

Unauthenticated - if the user can not be authenticated.

Unauthenticated - if the user can not be authenticated.

Unauthorized - if the user does not have Namespaces.Manage privilege and the System.Read privilege on all vSphere Clusters hosting the Supervisor.

get

SummaryTypes.Info get(java.lang.String supervisor,
                      InvocationConfig invocationConfig)

Queries the current state of the specified Supervisor. 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.

Parameters:

supervisor - the identifier for a supervisor The parameter must be an identifier for the resource type: com.vmware.vcenter.namespace_management.supervisor.Supervisor.

invocationConfig - Configuration for the method invocation.

Returns:

SummaryTypes.Info of the Supervisor matching the provided identifier.

Throws:

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

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

NotFound - if the Supervisor matching the ID does not exist.

Unauthenticated - if the user can not be authenticated.

Unauthenticated - if the user can not be authenticated.

Unauthorized - if the user does not have Namespaces.Manage privilege and the System.Read privilege on all vSphere Clusters hosting the Supervisor.

get

void get(java.lang.String supervisor,
         AsyncCallback<SummaryTypes.Info> asyncCallback)

Queries the current state of the specified Supervisor. 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:
SummaryTypes.Info of the Supervisor matching the provided identifier.

Operation Errors:
Error - if the system reports an error while responding to the request.
Error - if the system reports an error while responding to the request.
NotFound - if the Supervisor matching the ID does not exist.
Unauthenticated - if the user can not be authenticated.
Unauthenticated - if the user can not be authenticated.
Unauthorized - if the user does not have Namespaces.Manage privilege and the System.Read privilege on all vSphere Clusters hosting the Supervisor.

Parameters:

supervisor - the identifier for a supervisor The parameter must be an identifier for the resource type: com.vmware.vcenter.namespace_management.supervisor.Supervisor.

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

get

void get(java.lang.String supervisor,
         AsyncCallback<SummaryTypes.Info> asyncCallback,
         InvocationConfig invocationConfig)

Queries the current state of the specified Supervisor. 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:
SummaryTypes.Info of the Supervisor matching the provided identifier.

Operation Errors:
Error - if the system reports an error while responding to the request.
Error - if the system reports an error while responding to the request.
NotFound - if the Supervisor matching the ID does not exist.
Unauthenticated - if the user can not be authenticated.
Unauthenticated - if the user can not be authenticated.
Unauthorized - if the user does not have Namespaces.Manage privilege and the System.Read privilege on all vSphere Clusters hosting the Supervisor.

Parameters:

supervisor - the identifier for a supervisor The parameter must be an identifier for the resource type: com.vmware.vcenter.namespace_management.supervisor.Supervisor.

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

invocationConfig - Configuration for the method invocation.

list

SummaryTypes.ListResult list(SummaryTypes.FilterSpec filter)

Queries the current state of all Supervisors. Optionally, apply the filter to Supervisors that match the criteria in the SummaryTypes.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.

Parameters:

filter - Set of parameters that can be used to constrain the results of the method. if null all records will be returned.

Returns:

ListResult of SummaryTypes.Info of all Supervisors matching the criteria in the SummaryTypes.FilterSpec.

Throws:

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

Unauthenticated - if the user can not be authenticated.

Unauthorized - if the user does not have Namespaces.Manage privilege and the System.Read privilege on all vSphere Clusters hosting the Supervisor.

list

SummaryTypes.ListResult list(SummaryTypes.FilterSpec filter,
                             InvocationConfig invocationConfig)

Queries the current state of all Supervisors. Optionally, apply the filter to Supervisors that match the criteria in the SummaryTypes.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.

Parameters:

filter - Set of parameters that can be used to constrain the results of the method. if null all records will be returned.

invocationConfig - Configuration for the method invocation.

Returns:

ListResult of SummaryTypes.Info of all Supervisors matching the criteria in the SummaryTypes.FilterSpec.

Throws:

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

Unauthenticated - if the user can not be authenticated.

Unauthorized - if the user does not have Namespaces.Manage privilege and the System.Read privilege on all vSphere Clusters hosting the Supervisor.

list

void list(SummaryTypes.FilterSpec filter,
          AsyncCallback<SummaryTypes.ListResult> asyncCallback)

Queries the current state of all Supervisors. Optionally, apply the filter to Supervisors that match the criteria in the SummaryTypes.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:
ListResult of SummaryTypes.Info of all Supervisors matching the criteria in the SummaryTypes.FilterSpec.

Operation Errors:
Error - if the system reports an error while responding to the request.
Unauthenticated - if the user can not be authenticated.
Unauthorized - if the user does not have Namespaces.Manage privilege and the System.Read privilege on all vSphere Clusters hosting the Supervisor.

Parameters:

filter - Set of parameters that can be used to constrain the results of the method. if null all records will be returned.

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

list

void list(SummaryTypes.FilterSpec filter,
          AsyncCallback<SummaryTypes.ListResult> asyncCallback,
          InvocationConfig invocationConfig)

Queries the current state of all Supervisors. Optionally, apply the filter to Supervisors that match the criteria in the SummaryTypes.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:
ListResult of SummaryTypes.Info of all Supervisors matching the criteria in the SummaryTypes.FilterSpec.

Operation Errors:
Error - if the system reports an error while responding to the request.
Unauthenticated - if the user can not be authenticated.
Unauthorized - if the user does not have Namespaces.Manage privilege and the System.Read privilege on all vSphere Clusters hosting the Supervisor.

Parameters:

filter - Set of parameters that can be used to constrain the results of the method. if null all records will be returned.

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

invocationConfig - Configuration for the method invocation.