com.vmware.appliance.recovery.backup.system_name

Class ArchiveStub

java.lang.Object

com.vmware.vapi.internal.bindings.Stub

com.vmware.appliance.recovery.backup.system_name.ArchiveStub

All Implemented Interfaces:

Archive, ArchiveTypes, Service

public class ArchiveStub
extends com.vmware.vapi.internal.bindings.Stub
implements Archive

Remote stub implementation of the Archive API service.

WARNING: Internal class, subject to change in future versions.

Nested Class Summary

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

ArchiveTypes.FilterSpec, ArchiveTypes.Info, ArchiveTypes.Summary

Field Summary

Fields inherited from class com.vmware.vapi.internal.bindings.Stub

apiProvider, converter, ifaceId, securityContext

Constructor Summary

Constructors

Constructor and Description
ArchiveStub(ApiProvider apiProvider, StubConfigurationBase config)
ArchiveStub(ApiProvider apiProvider, com.vmware.vapi.internal.bindings.TypeConverter typeConverter, StubConfigurationBase config)

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.

Methods inherited from class com.vmware.vapi.internal.bindings.Stub

invokeMethod, invokeMethodAsync, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

ArchiveStub

public ArchiveStub(ApiProvider apiProvider,
           com.vmware.vapi.internal.bindings.TypeConverter typeConverter,
           StubConfigurationBase config)

ArchiveStub

public ArchiveStub(ApiProvider apiProvider,
           StubConfigurationBase config)

Method Detail

get

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

Description copied from interface: 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.

Specified by:

get in interface Archive

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.

get

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

Description copied from interface: 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. Use invocationConfig to specify configuration for this particular invocation.

Specified by:

get in interface Archive

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.

get

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

Description copied from interface: Archive

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.

Specified by:

get in interface Archive

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

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

Description copied from interface: Archive

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.

Specified by:

get in interface Archive

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

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

Description copied from interface: Archive

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.

Specified by:

list in interface Archive

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.

list

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

Description copied from interface: Archive

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.

Specified by:

list in interface Archive

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.

list

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

Description copied from interface: Archive

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.

Specified by:

list in interface Archive

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

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

Description copied from interface: Archive

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.

Specified by:

list in interface Archive

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.