com.vmware.vapi.std.introspection

Interface Operation

All Superinterfaces:

OperationTypes, Service

All Known Implementing Classes:

OperationStub

public interface Operation
extends Service, OperationTypes

The Operation service provides operations to retrieve information about the operations present in a vAPI service.

Nested Class Summary

Nested classes/interfaces inherited from interface com.vmware.vapi.std.introspection.OperationTypes

OperationTypes.DataDefinition, OperationTypes.Info

Field Summary

Fields inherited from interface com.vmware.vapi.std.introspection.OperationTypes

_VAPI_SERVICE_ID

Method Summary

Modifier and Type	Method and Description
OperationTypes.Info	get(String serviceId, String operationId) Returns the OperationTypes.Info for a given vAPI operation.
void	get(String serviceId, String operationId, AsyncCallback<OperationTypes.Info> asyncCallback) Returns the OperationTypes.Info for a given vAPI operation.
void	get(String serviceId, String operationId, AsyncCallback<OperationTypes.Info> asyncCallback, InvocationConfig invocationConfig) Returns the OperationTypes.Info for a given vAPI operation.
OperationTypes.Info	get(String serviceId, String operationId, InvocationConfig invocationConfig) Returns the OperationTypes.Info for a given vAPI operation.
Set<String>	list(String serviceId) Returns the set of operation identifiers for a given vAPI service.
void	list(String serviceId, AsyncCallback<Set<String>> asyncCallback) Returns the set of operation identifiers for a given vAPI service.
void	list(String serviceId, AsyncCallback<Set<String>> asyncCallback, InvocationConfig invocationConfig) Returns the set of operation identifiers for a given vAPI service.
Set<String>	list(String serviceId, InvocationConfig invocationConfig) Returns the set of operation identifiers for a given vAPI service.

Method Detail

list

Set<String> list(String serviceId)

Returns the set of operation identifiers for a given vAPI service.

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

Parameters:

serviceId - service identifier. The parameter must be an identifier for the resource type: com.vmware.vapi.service.

Returns:

set of operation identifiers for a given vAPI service. The return value will contain identifiers for the resource type: com.vmware.vapi.operation.

Throws:

NotFound - If the service identifier does not exist.

list

Set<String> list(String serviceId,
                 InvocationConfig invocationConfig)

Returns the set of operation identifiers for a given vAPI service.

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:

serviceId - service identifier. The parameter must be an identifier for the resource type: com.vmware.vapi.service.

invocationConfig - Configuration for the method invocation.

Returns:

set of operation identifiers for a given vAPI service. The return value will contain identifiers for the resource type: com.vmware.vapi.operation.

Throws:

NotFound - If the service identifier does not exist.

list

void list(String serviceId,
          AsyncCallback<Set<String>> asyncCallback)

Returns the set of operation identifiers for a given vAPI service.

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

Invocation Result:
set of operation identifiers for a given vAPI service. The return value will contain identifiers for the resource type: com.vmware.vapi.operation.

Operation Errors:
NotFound - If the service identifier does not exist.

Parameters:

serviceId - service identifier. The parameter must be an identifier for the resource type: com.vmware.vapi.service.

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

list

void list(String serviceId,
          AsyncCallback<Set<String>> asyncCallback,
          InvocationConfig invocationConfig)

Returns the set of operation identifiers for a given vAPI service.

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:
set of operation identifiers for a given vAPI service. The return value will contain identifiers for the resource type: com.vmware.vapi.operation.

Operation Errors:
NotFound - If the service identifier does not exist.

Parameters:

serviceId - service identifier. The parameter must be an identifier for the resource type: com.vmware.vapi.service.

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

invocationConfig - Configuration for the method invocation.

get

OperationTypes.Info get(String serviceId,
                        String operationId)

Returns the OperationTypes.Info for a given vAPI operation.

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

Parameters:

serviceId - service identifier. The parameter must be an identifier for the resource type: com.vmware.vapi.service.

operationId - operation identifier. The parameter must be an identifier for the resource type: com.vmware.vapi.operation.

Returns:

OperationTypes.Info for a given vAPI operation.

Throws:

NotFound - If the operation identifier does not exist.

NotFound - If the service identifier does not exist.

get

OperationTypes.Info get(String serviceId,
                        String operationId,
                        InvocationConfig invocationConfig)

Returns the OperationTypes.Info for a given vAPI operation.

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:

serviceId - service identifier. The parameter must be an identifier for the resource type: com.vmware.vapi.service.

operationId - operation identifier. The parameter must be an identifier for the resource type: com.vmware.vapi.operation.

invocationConfig - Configuration for the method invocation.

Returns:

OperationTypes.Info for a given vAPI operation.

Throws:

NotFound - If the operation identifier does not exist.

NotFound - If the service identifier does not exist.

get

void get(String serviceId,
         String operationId,
         AsyncCallback<OperationTypes.Info> asyncCallback)

Returns the OperationTypes.Info for a given vAPI operation.

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

Invocation Result:
OperationTypes.Info for a given vAPI operation.

Operation Errors:
NotFound - If the operation identifier does not exist.
NotFound - If the service identifier does not exist.

Parameters:

serviceId - service identifier. The parameter must be an identifier for the resource type: com.vmware.vapi.service.

operationId - operation identifier. The parameter must be an identifier for the resource type: com.vmware.vapi.operation.

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

get

void get(String serviceId,
         String operationId,
         AsyncCallback<OperationTypes.Info> asyncCallback,
         InvocationConfig invocationConfig)

Returns the OperationTypes.Info for a given vAPI operation.

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:
OperationTypes.Info for a given vAPI operation.

Operation Errors:
NotFound - If the operation identifier does not exist.
NotFound - If the service identifier does not exist.

Parameters:

serviceId - service identifier. The parameter must be an identifier for the resource type: com.vmware.vapi.service.

operationId - operation identifier. The parameter must be an identifier for the resource type: com.vmware.vapi.operation.

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

invocationConfig - Configuration for the method invocation.