com.vmware.appliance.recovery.backup

Interface SystemName

All Superinterfaces:

Service, SystemNameTypes

All Known Implementing Classes:

SystemNameStub

public interface SystemName
extends Service, SystemNameTypes

The SystemName interface provides methods to enumerate system names of appliance backups. This interface was added in vSphere API 6.7.

Method Summary

Methods

Modifier and Type	Method and Description
java.util.List<java.lang.String>	list(LocationSpec locSpec) Returns a list of system names for which backup archives exist under locSpec.
void	list(LocationSpec locSpec, AsyncCallback<java.util.List<java.lang.String>> asyncCallback) Returns a list of system names for which backup archives exist under locSpec.
void	list(LocationSpec locSpec, AsyncCallback<java.util.List<java.lang.String>> asyncCallback, InvocationConfig invocationConfig) Returns a list of system names for which backup archives exist under locSpec.
java.util.List<java.lang.String>	list(LocationSpec locSpec, InvocationConfig invocationConfig) Returns a list of system names for which backup archives exist under locSpec.

Method Detail

list

java.util.List<java.lang.String> list(LocationSpec locSpec)

Returns a list of system names for which backup archives exist under locSpec. 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

Returns:

list of system names The return value will contain identifiers for the resource type: com.vmware.appliance.recovery.backup.system_name.

Throws:

NotFound - if locSpec doesn't refer to an existing location on the backup server.

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

list

java.util.List<java.lang.String> list(LocationSpec locSpec,
                                    InvocationConfig invocationConfig)

Returns a list of system names for which backup archives exist under locSpec. 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

invocationConfig - Configuration for the method invocation.

Returns:

list of system names The return value will contain identifiers for the resource type: com.vmware.appliance.recovery.backup.system_name.

Throws:

NotFound - if locSpec doesn't 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,
        AsyncCallback<java.util.List<java.lang.String>> asyncCallback)

Returns a list of system names for which backup archives exist under locSpec. 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 system names The return value will contain identifiers for the resource type: com.vmware.appliance.recovery.backup.system_name.

Operation Errors:
NotFound - if locSpec doesn't refer to an existing location on the backup server.
Error - if any error occurs during the execution of the operation.

Parameters:

locSpec - LocationSpec Structure

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

list

void list(LocationSpec locSpec,
        AsyncCallback<java.util.List<java.lang.String>> asyncCallback,
        InvocationConfig invocationConfig)

Returns a list of system names for which backup archives exist under locSpec. 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 system names The return value will contain identifiers for the resource type: com.vmware.appliance.recovery.backup.system_name.

Operation Errors:
NotFound - if locSpec doesn't refer to an existing location on the backup server.
Error - if any error occurs during the execution of the operation.

Parameters:

locSpec - LocationSpec Structure

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

invocationConfig - Configuration for the method invocation.