com.vmware.appliance.recovery.backup.system_name

Interface Archive

All Superinterfaces:

ArchiveTypes, Service

All Known Implementing Classes:

ArchiveStub

public interface Archive
extends Service, ArchiveTypes

The Archive interface provides methods to get the backup information. This interface was added in vSphere API 6.7.

Nested Class Summary

Nested classes/interfaces inherited from interface com.vmware.appliance.recovery.backup.system_name.ArchiveTypes

ArchiveTypes.FilterSpec, ArchiveTypes.Info, ArchiveTypes.Summary

Method Summary

Methods

Modifier and Type	Method and Description
ArchiveTypes.Info	get(LocationSpec spec, java.lang.String systemName, java.lang.String archive) Returns the information for backup corresponding to given backup location and system name.
void	get(LocationSpec spec, java.lang.String systemName, java.lang.String archive, AsyncCallback<ArchiveTypes.Info> asyncCallback) Returns the information for backup corresponding to given backup location and system name.
void	get(LocationSpec spec, java.lang.String systemName, java.lang.String archive, AsyncCallback<ArchiveTypes.Info> asyncCallback, InvocationConfig invocationConfig) Returns the information for backup corresponding to given backup location and system name.
ArchiveTypes.Info	get(LocationSpec spec, java.lang.String systemName, java.lang.String archive, InvocationConfig invocationConfig) Returns the information for backup corresponding to given backup location and system name.
java.util.List<ArchiveTypes.Summary>	list(LocationSpec locSpec, java.lang.String systemName, ArchiveTypes.FilterSpec filterSpec) Returns information about backup archives corresponding to given backup location and system name, which match the ArchiveTypes.FilterSpec.
void	list(LocationSpec locSpec, java.lang.String systemName, ArchiveTypes.FilterSpec filterSpec, AsyncCallback<java.util.List<ArchiveTypes.Summary>> asyncCallback) Returns information about backup archives corresponding to given backup location and system name, which match the ArchiveTypes.FilterSpec.
void	list(LocationSpec locSpec, java.lang.String systemName, ArchiveTypes.FilterSpec filterSpec, AsyncCallback<java.util.List<ArchiveTypes.Summary>> asyncCallback, InvocationConfig invocationConfig) Returns information about backup archives corresponding to given backup location and system name, which match the ArchiveTypes.FilterSpec.
java.util.List<ArchiveTypes.Summary>	list(LocationSpec locSpec, java.lang.String systemName, ArchiveTypes.FilterSpec filterSpec, InvocationConfig invocationConfig) Returns information about backup archives corresponding to given backup location and system name, which match the ArchiveTypes.FilterSpec.

Method Detail

get

ArchiveTypes.Info get(LocationSpec spec,
                    java.lang.String systemName,
                    java.lang.String archive)

Returns the information for backup corresponding to given backup location and system name. 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:

spec - LocationSpec Structure.

systemName - System name identifier. The parameter must be an identifier for the resource type: com.vmware.appliance.recovery.backup.system_name.

archive - Archive identifier. The parameter must be an identifier for the resource type: com.vmware.appliance.recovery.backup.system_name.archive.

Returns:

Info Structure.

Throws:

NotFound - if backup does not exist.

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

get

ArchiveTypes.Info get(LocationSpec spec,
                    java.lang.String systemName,
                    java.lang.String archive,
                    InvocationConfig invocationConfig)

Returns the information for backup corresponding to given backup location and system name. 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:

spec - LocationSpec Structure.

systemName - System name identifier. The parameter must be an identifier for the resource type: com.vmware.appliance.recovery.backup.system_name.

archive - Archive identifier. The parameter must be an identifier for the resource type: com.vmware.appliance.recovery.backup.system_name.archive.

invocationConfig - Configuration for the method invocation.

Returns:

Info Structure.

Throws:

NotFound - if backup does not exist.

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

get

void get(LocationSpec spec,
       java.lang.String systemName,
       java.lang.String archive,
       AsyncCallback<ArchiveTypes.Info> asyncCallback)

Returns the information for backup corresponding to given backup location and system name. 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:
Info Structure.

Operation Errors:
NotFound - if backup does not exist.
Error - if any error occurs during the execution of the operation.

Parameters:

spec - LocationSpec Structure.

systemName - System name identifier. The parameter must be an identifier for the resource type: com.vmware.appliance.recovery.backup.system_name.

archive - Archive identifier. The parameter must be an identifier for the resource type: com.vmware.appliance.recovery.backup.system_name.archive.

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

get

void get(LocationSpec spec,
       java.lang.String systemName,
       java.lang.String archive,
       AsyncCallback<ArchiveTypes.Info> asyncCallback,
       InvocationConfig invocationConfig)

Returns the information for backup corresponding to given backup location and system name. 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:
Info Structure.

Operation Errors:
NotFound - if backup does not exist.
Error - if any error occurs during the execution of the operation.

Parameters:

spec - LocationSpec Structure.

systemName - System name identifier. The parameter must be an identifier for the resource type: com.vmware.appliance.recovery.backup.system_name.

archive - Archive identifier. The parameter must be an identifier for the resource type: com.vmware.appliance.recovery.backup.system_name.archive.

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

invocationConfig - Configuration for the method invocation.

list

java.util.List<ArchiveTypes.Summary> list(LocationSpec locSpec,
                                        java.lang.String systemName,
                                        ArchiveTypes.FilterSpec filterSpec)

Returns information about backup archives corresponding to given backup location and system name, which match the ArchiveTypes.FilterSpec. 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:

locSpec - LocationSpec Structure.

systemName - System name identifier. The parameter must be an identifier for the resource type: com.vmware.appliance.recovery.backup.system_name.

filterSpec - Specification of matching backups for which information should be returned.

Returns:

Commonly used information about the backup archives.

Throws:

NotFound - if combination of locSpec and system name does not refer to an existing location on the backup server.

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

list

java.util.List<ArchiveTypes.Summary> list(LocationSpec locSpec,
                                        java.lang.String systemName,
                                        ArchiveTypes.FilterSpec filterSpec,
                                        InvocationConfig invocationConfig)

Returns information about backup archives corresponding to given backup location and system name, which match the ArchiveTypes.FilterSpec. 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:

locSpec - LocationSpec Structure.

systemName - System name identifier. The parameter must be an identifier for the resource type: com.vmware.appliance.recovery.backup.system_name.

filterSpec - Specification of matching backups for which information should be returned.

invocationConfig - Configuration for the method invocation.

Returns:

Commonly used information about the backup archives.

Throws:

NotFound - if combination of locSpec and system name does not refer to an existing location on the backup server.

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

list

void list(LocationSpec locSpec,
        java.lang.String systemName,
        ArchiveTypes.FilterSpec filterSpec,
        AsyncCallback<java.util.List<ArchiveTypes.Summary>> asyncCallback)

Returns information about backup archives corresponding to given backup location and system name, which match the ArchiveTypes.FilterSpec. 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:
Commonly used information about the backup archives.

Operation Errors:
NotFound - if combination of locSpec and system name does not refer to an existing location on the backup server.
Error - if any error occurs during the execution of the operation.

Parameters:

locSpec - LocationSpec Structure.

systemName - System name identifier. The parameter must be an identifier for the resource type: com.vmware.appliance.recovery.backup.system_name.

filterSpec - Specification of matching backups for which information should be returned.

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

list

void list(LocationSpec locSpec,
        java.lang.String systemName,
        ArchiveTypes.FilterSpec filterSpec,
        AsyncCallback<java.util.List<ArchiveTypes.Summary>> asyncCallback,
        InvocationConfig invocationConfig)

Returns information about backup archives corresponding to given backup location and system name, which match the ArchiveTypes.FilterSpec. 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:
Commonly used information about the backup archives.

Operation Errors:
NotFound - if combination of locSpec and system name does not refer to an existing location on the backup server.
Error - if any error occurs during the execution of the operation.

Parameters:

locSpec - LocationSpec Structure.

systemName - System name identifier. The parameter must be an identifier for the resource type: com.vmware.appliance.recovery.backup.system_name.

filterSpec - Specification of matching backups for which information should be returned.

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

invocationConfig - Configuration for the method invocation.