com.vmware.esx.settings.clusters.configuration

Interface Schema

All Superinterfaces:

SchemaTypes, Service

All Known Implementing Classes:

SchemaStub

public interface Schema
extends Service, SchemaTypes

The Schema interface provides methods to manage the desired configuration schema of an ESX cluster. Warning: This interface is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

Field Summary

Fields inherited from interface com.vmware.esx.settings.clusters.configuration.SchemaTypes

_VAPI_SERVICE_ID

Method Summary

Modifier and Type	Method and Description
SchemaResult	get(java.lang.String cluster) Returns the configuration schema associated with the cluster.
void	get(java.lang.String cluster, AsyncCallback<SchemaResult> asyncCallback) Returns the configuration schema associated with the cluster.
void	get(java.lang.String cluster, AsyncCallback<SchemaResult> asyncCallback, InvocationConfig invocationConfig) Returns the configuration schema associated with the cluster.
SchemaResult	get(java.lang.String cluster, InvocationConfig invocationConfig) Returns the configuration schema associated with the cluster.

Method Detail

get

SchemaResult get(java.lang.String cluster)

Returns the configuration schema associated with the cluster. Warning: This method is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

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

Parameters:

cluster - Identifier of the cluster. The parameter must be an identifier for the resource type: ClusterComputeResource.

Returns:

The schema associated with the cluster

Throws:

Error - In case of an unknown internal error.

InvalidArgument - If the cluster is invalid

NotFound - If the schema associated with the cluster is not found

ServiceUnavailable - If the service is unavailable.

Unauthenticated - If the session is unauthenticated.

Unauthorized - if you do not have all of the privileges described as follows:

• Method execution requires VcIntegrity.ClusterConfiguration.View.
• The resource ClusterComputeResource referenced by the parameter cluster requires VcIntegrity.ClusterConfiguration.View.

get

SchemaResult get(java.lang.String cluster,
                 InvocationConfig invocationConfig)

Returns the configuration schema associated with the cluster. Warning: This method is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

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 of the cluster. The parameter must be an identifier for the resource type: ClusterComputeResource.

invocationConfig - Configuration for the method invocation.

Returns:

The schema associated with the cluster

Throws:

Error - In case of an unknown internal error.

InvalidArgument - If the cluster is invalid

NotFound - If the schema associated with the cluster is not found

ServiceUnavailable - If the service is unavailable.

Unauthenticated - If the session is unauthenticated.

Unauthorized - if you do not have all of the privileges described as follows:

• Method execution requires VcIntegrity.ClusterConfiguration.View.
• The resource ClusterComputeResource referenced by the parameter cluster requires VcIntegrity.ClusterConfiguration.View.

get

void get(java.lang.String cluster,
         AsyncCallback<SchemaResult> asyncCallback)

Returns the configuration schema associated with the cluster. Warning: This method is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

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

Invocation Result:
The schema associated with the cluster

Operation Errors:
Error - In case of an unknown internal error.
InvalidArgument - If the cluster is invalid
NotFound - If the schema associated with the cluster is not found
ServiceUnavailable - If the service is unavailable.
Unauthenticated - If the session is unauthenticated.
Unauthorized - if you do not have all of the privileges described as follows:

• Method execution requires VcIntegrity.ClusterConfiguration.View.
• The resource ClusterComputeResource referenced by the parameter cluster requires VcIntegrity.ClusterConfiguration.View.

Parameters:

cluster - Identifier of the cluster. The parameter must be an identifier for the resource type: ClusterComputeResource.

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

get

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

Returns the configuration schema associated with the cluster. Warning: This method is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

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 schema associated with the cluster

Operation Errors:
Error - In case of an unknown internal error.
InvalidArgument - If the cluster is invalid
NotFound - If the schema associated with the cluster is not found
ServiceUnavailable - If the service is unavailable.
Unauthenticated - If the session is unauthenticated.
Unauthorized - if you do not have all of the privileges described as follows:

• Method execution requires VcIntegrity.ClusterConfiguration.View.
• The resource ClusterComputeResource referenced by the parameter cluster requires VcIntegrity.ClusterConfiguration.View.

Parameters:

cluster - Identifier of the cluster. 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.