com.vmware.appliance

Interface Health

All Superinterfaces:

HealthTypes, Service

All Known Implementing Classes:

HealthStub

public interface Health
extends Service, HealthTypes

The Health interface provides methods to retrieve the appliance health information. This interface was added in vSphere API 6.7.

Method Summary

Methods

Modifier and Type	Method and Description
java.util.List<Notification>	messages(java.lang.String item) Get health messages.
void	messages(java.lang.String item, AsyncCallback<java.util.List<Notification>> asyncCallback) Get health messages.
void	messages(java.lang.String item, AsyncCallback<java.util.List<Notification>> asyncCallback, InvocationConfig invocationConfig) Get health messages.
java.util.List<Notification>	messages(java.lang.String item, InvocationConfig invocationConfig) Get health messages.

Method Detail

messages

java.util.List<Notification> messages(java.lang.String item)

Get health messages. This method was added in vSphere API 6.7.

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

Parameters:

item - ID of the data item The parameter must be an identifier for the resource type: com.vmware.appliance.health.

Returns:

List of the health messages

Throws:

NotFound - Unknown health item

Error - Generic error

messages

java.util.List<Notification> messages(java.lang.String item,
                                    InvocationConfig invocationConfig)

Get health messages. This method was added in vSphere API 6.7.

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:

item - ID of the data item The parameter must be an identifier for the resource type: com.vmware.appliance.health.

invocationConfig - Configuration for the method invocation.

Returns:

List of the health messages

Throws:

NotFound - Unknown health item

Error - Generic error

messages

void messages(java.lang.String item,
            AsyncCallback<java.util.List<Notification>> asyncCallback)

Get health messages. This method was added in vSphere API 6.7.

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

Operation Result:
List of the health messages

Operation Errors:
NotFound - Unknown health item
Error - Generic error

Parameters:

item - ID of the data item The parameter must be an identifier for the resource type: com.vmware.appliance.health.

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

messages

void messages(java.lang.String item,
            AsyncCallback<java.util.List<Notification>> asyncCallback,
            InvocationConfig invocationConfig)

Get health messages. This method was added in vSphere API 6.7.

Asynchronous method overload. Result of the invocation will be reported via the specified asyncCallback. Use invocationConfig to specify configuration for this particular invocation.

Operation Result:
List of the health messages

Operation Errors:
NotFound - Unknown health item
Error - Generic error

Parameters:

item - ID of the data item The parameter must be an identifier for the resource type: com.vmware.appliance.health.

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

invocationConfig - Configuration for the method invocation.