com.vmware.vcenter

Interface System

All Superinterfaces:

com.vmware.vapi.bindings.Service, SystemTypes

All Known Implementing Classes:

SystemStub

public interface System
extends com.vmware.vapi.bindings.Service, SystemTypes

The System interface contains methods for negotiating API communication parameters including release ID.

Software developers obtain a list of supported API release IDs from vCenter documentation or as part of the client library (SDK) they work with at the time they develop and test a solution. The software solution initiates a handshake by sending a prioritized list of release IDs supported by the solution. The server selects the first release ID it supports from the list.

Negotiating API release ID is necessary to use APIs utilizing inheritance based polymorphism. These include all VI/JSON APIs and a set of vSphere Automation APIs. vSphere Automation APIs that require API release ID state this in their documentation. Consult the Programming Guide and API reference documentation of specific methods for more information.

. This interface was added in vSphere API 8.0.2.0.

Nested Class Summary

Nested classes/interfaces inherited from interface com.vmware.vcenter.SystemTypes

SystemTypes.HelloResult, SystemTypes.HelloSpec

Field Summary

Fields inherited from interface com.vmware.vcenter.SystemTypes

_VAPI_SERVICE_ID

Method Summary

Modifier and Type	Method and Description
SystemTypes.HelloResult	hello(SystemTypes.HelloSpec spec) Negotiates common parameters for API communication.
void	hello(SystemTypes.HelloSpec spec, com.vmware.vapi.bindings.client.AsyncCallback<SystemTypes.HelloResult> asyncCallback) Negotiates common parameters for API communication.
void	hello(SystemTypes.HelloSpec spec, com.vmware.vapi.bindings.client.AsyncCallback<SystemTypes.HelloResult> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Negotiates common parameters for API communication.
SystemTypes.HelloResult	hello(SystemTypes.HelloSpec spec, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Negotiates common parameters for API communication.

Method Detail

hello

SystemTypes.HelloResult hello(SystemTypes.HelloSpec spec)

Negotiates common parameters for API communication.

This method selects mutually supported choices from the SystemTypes.HelloSpec.getApiReleases() list.

. This method was added in vSphere API 8.0.2.0.

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

Parameters:

spec - Client capabilities including list of supported API release IDs.

Returns:

Common parameters for API communication.

Throws:

InvalidArgument - if the list of client provided release IDs (SystemTypes.HelloSpec.getApiReleases()) is empty or the list is longer then 128 releases or given release ID is longer then 64 characters.

hello

SystemTypes.HelloResult hello(SystemTypes.HelloSpec spec,
                              com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Negotiates common parameters for API communication.

This method selects mutually supported choices from the SystemTypes.HelloSpec.getApiReleases() list.

. This method was added in vSphere API 8.0.2.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:

spec - Client capabilities including list of supported API release IDs.

invocationConfig - Configuration for the method invocation.

Returns:

Common parameters for API communication.

Throws:

InvalidArgument - if the list of client provided release IDs (SystemTypes.HelloSpec.getApiReleases()) is empty or the list is longer then 128 releases or given release ID is longer then 64 characters.

hello

void hello(SystemTypes.HelloSpec spec,
           com.vmware.vapi.bindings.client.AsyncCallback<SystemTypes.HelloResult> asyncCallback)

Negotiates common parameters for API communication.

This method selects mutually supported choices from the SystemTypes.HelloSpec.getApiReleases() list.

. This method was added in vSphere API 8.0.2.0.

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

Invocation Result:
Common parameters for API communication.

Operation Errors:
InvalidArgument - if the list of client provided release IDs (SystemTypes.HelloSpec.getApiReleases()) is empty or the list is longer then 128 releases or given release ID is longer then 64 characters.

Parameters:

spec - Client capabilities including list of supported API release IDs.

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

hello

void hello(SystemTypes.HelloSpec spec,
           com.vmware.vapi.bindings.client.AsyncCallback<SystemTypes.HelloResult> asyncCallback,
           com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Negotiates common parameters for API communication.

This method selects mutually supported choices from the SystemTypes.HelloSpec.getApiReleases() list.

. This method was added in vSphere API 8.0.2.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:
Common parameters for API communication.

Operation Errors:
InvalidArgument - if the list of client provided release IDs (SystemTypes.HelloSpec.getApiReleases()) is empty or the list is longer then 128 releases or given release ID is longer then 64 characters.

Parameters:

spec - Client capabilities including list of supported API release IDs.

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

invocationConfig - Configuration for the method invocation.