com.vmware.esx.settings.clusters.configuration.reports

Interface LastApplyResult

All Superinterfaces:

LastApplyResultTypes, Service

All Known Implementing Classes:

LastApplyResultStub

public interface LastApplyResult
extends Service, LastApplyResultTypes

The LastApplyResult interface provides methods to get the most recent available result of applying the configuration to all hosts within a 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.reports.LastApplyResultTypes

_VAPI_SERVICE_ID

Method Summary

Modifier and Type	Method and Description
ConfigurationTypes.ApplyResult	get(java.lang.String cluster) Returns the most recent available result of applying the configuration document to all hosts within the cluster.
void	get(java.lang.String cluster, AsyncCallback<ConfigurationTypes.ApplyResult> asyncCallback) Returns the most recent available result of applying the configuration document to all hosts within the cluster.
void	get(java.lang.String cluster, AsyncCallback<ConfigurationTypes.ApplyResult> asyncCallback, InvocationConfig invocationConfig) Returns the most recent available result of applying the configuration document to all hosts within the cluster.
ConfigurationTypes.ApplyResult	get(java.lang.String cluster, InvocationConfig invocationConfig) Returns the most recent available result of applying the configuration document to all hosts within the cluster.

Method Detail

get

ConfigurationTypes.ApplyResult get(java.lang.String cluster)

Returns the most recent available result of applying the configuration document to all hosts within 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 - The cluster identifier. The parameter must be an identifier for the resource type: ClusterComputeResource.

Returns:

Most recent available result of applying the desired configuration to all hosts within the cluster.

Throws:

Error - If there is an unknown internal error. The accompanying error message will give more details about the failure.

NotFound - If there is no cluster associated with cluster in the system or if there is no result associated with the cluster cluster

ServiceUnavailable - If the service is not available.

Unauthenticated - if the caller is not authenticated.

Unauthorized - if the caller does not have the necessary privileges to perform the request.

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

ConfigurationTypes.ApplyResult get(java.lang.String cluster,
                                   InvocationConfig invocationConfig)

Returns the most recent available result of applying the configuration document to all hosts within 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 - The cluster identifier. The parameter must be an identifier for the resource type: ClusterComputeResource.

invocationConfig - Configuration for the method invocation.

Returns:

Most recent available result of applying the desired configuration to all hosts within the cluster.

Throws:

Error - If there is an unknown internal error. The accompanying error message will give more details about the failure.

NotFound - If there is no cluster associated with cluster in the system or if there is no result associated with the cluster cluster

ServiceUnavailable - If the service is not available.

Unauthenticated - if the caller is not authenticated.

Unauthorized - if the caller does not have the necessary privileges to perform the request.

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<ConfigurationTypes.ApplyResult> asyncCallback)

Returns the most recent available result of applying the configuration document to all hosts within 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:
Most recent available result of applying the desired configuration to all hosts within the cluster.

Operation Errors:
Error - If there is an unknown internal error. The accompanying error message will give more details about the failure.
NotFound - If there is no cluster associated with cluster in the system or if there is no result associated with the cluster cluster
ServiceUnavailable - If the service is not available.
Unauthenticated - if the caller is not authenticated.
Unauthorized - if the caller does not have the necessary privileges to perform the request.
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 - The cluster identifier. 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<ConfigurationTypes.ApplyResult> asyncCallback,
         InvocationConfig invocationConfig)

Returns the most recent available result of applying the configuration document to all hosts within 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:
Most recent available result of applying the desired configuration to all hosts within the cluster.

Operation Errors:
Error - If there is an unknown internal error. The accompanying error message will give more details about the failure.
NotFound - If there is no cluster associated with cluster in the system or if there is no result associated with the cluster cluster
ServiceUnavailable - If the service is not available.
Unauthenticated - if the caller is not authenticated.
Unauthorized - if the caller does not have the necessary privileges to perform the request.
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 - The cluster identifier. 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.