com.vmware.vcenter.namespace_management.supervisors.recovery.backup

Interface Archives

All Superinterfaces:

ArchivesTypes, com.vmware.vapi.bindings.Service

All Known Implementing Classes:

ArchivesStub

public interface Archives
extends com.vmware.vapi.bindings.Service, ArchivesTypes

The Archives interface provides methods to manage Supervisor Backup archives stored on vCenter Server Appliance file system. This interface was added in vSphere API 8.0.3.0.

Nested Class Summary

Nested classes/interfaces inherited from interface com.vmware.vcenter.namespace_management.supervisors.recovery.backup.ArchivesTypes

ArchivesTypes.FilterSpec, ArchivesTypes.Info

Field Summary

Fields inherited from interface com.vmware.vcenter.namespace_management.supervisors.recovery.backup.ArchivesTypes

_VAPI_SERVICE_ID

Method Summary

Modifier and Type	Method and Description
java.util.List<ArchivesTypes.Info>	list(ArchivesTypes.FilterSpec filter) List all Backup archives that are stored on vCenter Server Appliance file system.
void	list(ArchivesTypes.FilterSpec filter, com.vmware.vapi.bindings.client.AsyncCallback<java.util.List<ArchivesTypes.Info>> asyncCallback) List all Backup archives that are stored on vCenter Server Appliance file system.
void	list(ArchivesTypes.FilterSpec filter, com.vmware.vapi.bindings.client.AsyncCallback<java.util.List<ArchivesTypes.Info>> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) List all Backup archives that are stored on vCenter Server Appliance file system.
java.util.List<ArchivesTypes.Info>	list(ArchivesTypes.FilterSpec filter, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) List all Backup archives that are stored on vCenter Server Appliance file system.

Method Detail

list

java.util.List<ArchivesTypes.Info> list(ArchivesTypes.FilterSpec filter)

List all Backup archives that are stored on vCenter Server Appliance file system. Optionally, apply the filter to Backup archives that match the criteria in the {#link FilterSpec}. This method was added in vSphere API 8.0.3.0.

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

Parameters:

filter - Set of parameters that can be used to constrain the results of the method. if null all records will be returned.

Returns:

Information about Backup archives stored on vCenter Server Appliance file system matching the {#link FilterSpec}.

Throws:

Error - if the system reports an error while responding to the request.

Unauthenticated - if the user cannot be authenticated.

Unauthorized - if the user is missing the System.Read privilege.

list

java.util.List<ArchivesTypes.Info> list(ArchivesTypes.FilterSpec filter,
                                        com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

List all Backup archives that are stored on vCenter Server Appliance file system. Optionally, apply the filter to Backup archives that match the criteria in the {#link FilterSpec}. This method was added in vSphere API 8.0.3.0.

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 - Set of parameters that can be used to constrain the results of the method. if null all records will be returned.

invocationConfig - Configuration for the method invocation.

Returns:

Information about Backup archives stored on vCenter Server Appliance file system matching the {#link FilterSpec}.

Throws:

Error - if the system reports an error while responding to the request.

Unauthenticated - if the user cannot be authenticated.

Unauthorized - if the user is missing the System.Read privilege.

list

void list(ArchivesTypes.FilterSpec filter,
          com.vmware.vapi.bindings.client.AsyncCallback<java.util.List<ArchivesTypes.Info>> asyncCallback)

List all Backup archives that are stored on vCenter Server Appliance file system. Optionally, apply the filter to Backup archives that match the criteria in the {#link FilterSpec}. This method was added in vSphere API 8.0.3.0.

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

Invocation Result:
Information about Backup archives stored on vCenter Server Appliance file system matching the {#link FilterSpec}.

Operation Errors:
Error - if the system reports an error while responding to the request.
Unauthenticated - if the user cannot be authenticated.
Unauthorized - if the user is missing the System.Read privilege.

Parameters:

filter - Set of parameters that can be used to constrain the results of the method. if null all records will be returned.

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

list

void list(ArchivesTypes.FilterSpec filter,
          com.vmware.vapi.bindings.client.AsyncCallback<java.util.List<ArchivesTypes.Info>> asyncCallback,
          com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

List all Backup archives that are stored on vCenter Server Appliance file system. Optionally, apply the filter to Backup archives that match the criteria in the {#link FilterSpec}. This method was added in vSphere API 8.0.3.0.

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:
Information about Backup archives stored on vCenter Server Appliance file system matching the {#link FilterSpec}.

Operation Errors:
Error - if the system reports an error while responding to the request.
Unauthenticated - if the user cannot be authenticated.
Unauthorized - if the user is missing the System.Read privilege.

Parameters:

filter - Set of parameters that can be used to constrain the results of the method. if null all records will be returned.

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

invocationConfig - Configuration for the method invocation.