com.vmware.appliance.recovery.backup.job

Interface Details

All Superinterfaces:

DetailsTypes, Service

All Known Implementing Classes:

DetailsStub

public interface Details
extends Service, DetailsTypes

The Details interface provides methods to get the details about backup jobs. This interface was added in vSphere API 6.7.

Nested Class Summary

Nested classes/interfaces inherited from interface com.vmware.appliance.recovery.backup.job.DetailsTypes

DetailsTypes.BuildInfo, DetailsTypes.FilterSpec, DetailsTypes.Info, DetailsTypes.Type

Field Summary

Fields inherited from interface com.vmware.appliance.recovery.backup.job.DetailsTypes

_VAPI_SERVICE_ID

Method Summary

Modifier and Type	Method and Description
java.util.Map<java.lang.String,DetailsTypes.Info>	list(DetailsTypes.FilterSpec filter) Returns detailed information about the current and historical backup jobs.
void	list(DetailsTypes.FilterSpec filter, AsyncCallback<java.util.Map<java.lang.String,DetailsTypes.Info>> asyncCallback) Returns detailed information about the current and historical backup jobs.
void	list(DetailsTypes.FilterSpec filter, AsyncCallback<java.util.Map<java.lang.String,DetailsTypes.Info>> asyncCallback, InvocationConfig invocationConfig) Returns detailed information about the current and historical backup jobs.
java.util.Map<java.lang.String,DetailsTypes.Info>	list(DetailsTypes.FilterSpec filter, InvocationConfig invocationConfig) Returns detailed information about the current and historical backup jobs.

Method Detail

list

java.util.Map<java.lang.String,DetailsTypes.Info> list(DetailsTypes.FilterSpec filter)

Returns detailed information about the current and historical backup jobs. 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:

filter - Specification of matching backup jobs for which information should be returned. If null, the behavior is equivalent to DetailsTypes.FilterSpec with all properties null which means all the backup jobs match the filter.

Returns:

Map of backup job identifier to Info Structure. The key in the return value Map will be an identifier for the resource type: com.vmware.appliance.recovery.backup.job.

Throws:

Error - if any error occurs during the execution of the operation.

list

java.util.Map<java.lang.String,DetailsTypes.Info> list(DetailsTypes.FilterSpec filter,
                                                       InvocationConfig invocationConfig)

Returns detailed information about the current and historical backup jobs. 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:

filter - Specification of matching backup jobs for which information should be returned. If null, the behavior is equivalent to DetailsTypes.FilterSpec with all properties null which means all the backup jobs match the filter.

invocationConfig - Configuration for the method invocation.

Returns:

Map of backup job identifier to Info Structure. The key in the return value Map will be an identifier for the resource type: com.vmware.appliance.recovery.backup.job.

Throws:

Error - if any error occurs during the execution of the operation.

list

void list(DetailsTypes.FilterSpec filter,
          AsyncCallback<java.util.Map<java.lang.String,DetailsTypes.Info>> asyncCallback)

Returns detailed information about the current and historical backup jobs. This method was added in vSphere API 6.7.

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

Invocation Result:
Map of backup job identifier to Info Structure. The key in the return value Map will be an identifier for the resource type: com.vmware.appliance.recovery.backup.job.

Operation Errors:
Error - if any error occurs during the execution of the operation.

Parameters:

filter - Specification of matching backup jobs for which information should be returned. If null, the behavior is equivalent to DetailsTypes.FilterSpec with all properties null which means all the backup jobs match the filter.

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

list

void list(DetailsTypes.FilterSpec filter,
          AsyncCallback<java.util.Map<java.lang.String,DetailsTypes.Info>> asyncCallback,
          InvocationConfig invocationConfig)

Returns detailed information about the current and historical backup jobs. 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.

Invocation Result:
Map of backup job identifier to Info Structure. The key in the return value Map will be an identifier for the resource type: com.vmware.appliance.recovery.backup.job.

Operation Errors:
Error - if any error occurs during the execution of the operation.

Parameters:

filter - Specification of matching backup jobs for which information should be returned. If null, the behavior is equivalent to DetailsTypes.FilterSpec with all properties null which means all the backup jobs match the filter.

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

invocationConfig - Configuration for the method invocation.