com.vmware.appliance.recovery.backup

Interface Schedules

All Superinterfaces:

SchedulesTypes, Service

All Known Implementing Classes:

SchedulesStub

public interface Schedules
extends Service, SchedulesTypes

The Schedules interface provides methods to be performed to manage backup schedules. This interface was added in vSphere API 6.7.

Nested Class Summary

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

SchedulesTypes.CreateSpec, SchedulesTypes.DayOfWeek, SchedulesTypes.Info, SchedulesTypes.RecurrenceInfo, SchedulesTypes.RetentionInfo, SchedulesTypes.UpdateSpec

Method Summary

Methods

Modifier and Type	Method and Description
void	create(java.lang.String schedule, SchedulesTypes.CreateSpec spec) Creates a schedule.
void	create(java.lang.String schedule, SchedulesTypes.CreateSpec spec, AsyncCallback<java.lang.Void> asyncCallback) Creates a schedule.
void	create(java.lang.String schedule, SchedulesTypes.CreateSpec spec, AsyncCallback<java.lang.Void> asyncCallback, InvocationConfig invocationConfig) Creates a schedule.
void	create(java.lang.String schedule, SchedulesTypes.CreateSpec spec, InvocationConfig invocationConfig) Creates a schedule.
void	delete(java.lang.String schedule) Deletes an existing schedule.
void	delete(java.lang.String schedule, AsyncCallback<java.lang.Void> asyncCallback) Deletes an existing schedule.
void	delete(java.lang.String schedule, AsyncCallback<java.lang.Void> asyncCallback, InvocationConfig invocationConfig) Deletes an existing schedule.
void	delete(java.lang.String schedule, InvocationConfig invocationConfig) Deletes an existing schedule.
SchedulesTypes.Info	get(java.lang.String schedule) Returns an existing schedule information based on id.
void	get(java.lang.String schedule, AsyncCallback<SchedulesTypes.Info> asyncCallback) Returns an existing schedule information based on id.
void	get(java.lang.String schedule, AsyncCallback<SchedulesTypes.Info> asyncCallback, InvocationConfig invocationConfig) Returns an existing schedule information based on id.
SchedulesTypes.Info	get(java.lang.String schedule, InvocationConfig invocationConfig) Returns an existing schedule information based on id.
java.util.Map<java.lang.String,SchedulesTypes.Info>	list() Returns a list of existing schedules with details.
void	list(AsyncCallback<java.util.Map<java.lang.String,SchedulesTypes.Info>> asyncCallback) Returns a list of existing schedules with details.
void	list(AsyncCallback<java.util.Map<java.lang.String,SchedulesTypes.Info>> asyncCallback, InvocationConfig invocationConfig) Returns a list of existing schedules with details.
java.util.Map<java.lang.String,SchedulesTypes.Info>	list(InvocationConfig invocationConfig) Returns a list of existing schedules with details.
JobTypes.BackupJobStatus	run(java.lang.String schedule, java.lang.String comment) Initiate backup with the specified schedule.
void	run(java.lang.String schedule, java.lang.String comment, AsyncCallback<JobTypes.BackupJobStatus> asyncCallback) Initiate backup with the specified schedule.
void	run(java.lang.String schedule, java.lang.String comment, AsyncCallback<JobTypes.BackupJobStatus> asyncCallback, InvocationConfig invocationConfig) Initiate backup with the specified schedule.
JobTypes.BackupJobStatus	run(java.lang.String schedule, java.lang.String comment, InvocationConfig invocationConfig) Initiate backup with the specified schedule.
void	update(java.lang.String schedule, SchedulesTypes.UpdateSpec spec) Updates a schedule.
void	update(java.lang.String schedule, SchedulesTypes.UpdateSpec spec, AsyncCallback<java.lang.Void> asyncCallback) Updates a schedule.
void	update(java.lang.String schedule, SchedulesTypes.UpdateSpec spec, AsyncCallback<java.lang.Void> asyncCallback, InvocationConfig invocationConfig) Updates a schedule.
void	update(java.lang.String schedule, SchedulesTypes.UpdateSpec spec, InvocationConfig invocationConfig) Updates a schedule.

Method Detail

list

java.util.Map<java.lang.String,SchedulesTypes.Info> list()

Returns a list of existing schedules with details. This method was added in vSphere API 6.7.

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

Returns:

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

Throws:

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

list

java.util.Map<java.lang.String,SchedulesTypes.Info> list(InvocationConfig invocationConfig)

Returns a list of existing schedules with details. 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:

invocationConfig - Configuration for the method invocation.

Returns:

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

Throws:

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

list

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

Returns a list of existing schedules with details. 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:
Map of schedule id to Info Structure The key in the return value Map will be an identifier for the resource type: com.vmware.appliance.recovery.backup.schedule.

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

Parameters:

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

list

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

Returns a list of existing schedules with details. 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:
Map of schedule id to Info Structure The key in the return value Map will be an identifier for the resource type: com.vmware.appliance.recovery.backup.schedule.

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

Parameters:

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

invocationConfig - Configuration for the method invocation.

run

JobTypes.BackupJobStatus run(java.lang.String schedule,
                           java.lang.String comment)

Initiate backup with the specified schedule. 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:

schedule - Identifier of the schedule The parameter must be an identifier for the resource type: com.vmware.appliance.recovery.backup.schedule.

comment - field that specifies the description for the backup. If null the backup will have an empty comment.

Returns:

BackupJobStatus Structure

Throws:

FeatureInUse - if a backup or restore is already in progress.

NotFound - if schedule associated with id does not exist.

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

run

JobTypes.BackupJobStatus run(java.lang.String schedule,
                           java.lang.String comment,
                           InvocationConfig invocationConfig)

Initiate backup with the specified schedule. 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:

schedule - Identifier of the schedule The parameter must be an identifier for the resource type: com.vmware.appliance.recovery.backup.schedule.

comment - field that specifies the description for the backup. If null the backup will have an empty comment.

invocationConfig - Configuration for the method invocation.

Returns:

BackupJobStatus Structure

Throws:

FeatureInUse - if a backup or restore is already in progress.

NotFound - if schedule associated with id does not exist.

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

run

void run(java.lang.String schedule,
       java.lang.String comment,
       AsyncCallback<JobTypes.BackupJobStatus> asyncCallback)

Initiate backup with the specified schedule. 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:
BackupJobStatus Structure

Operation Errors:
FeatureInUse - if a backup or restore is already in progress.
NotFound - if schedule associated with id does not exist.
Error - if any error occurs during the execution of the operation.

Parameters:

schedule - Identifier of the schedule The parameter must be an identifier for the resource type: com.vmware.appliance.recovery.backup.schedule.

comment - field that specifies the description for the backup. If null the backup will have an empty comment.

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

run

void run(java.lang.String schedule,
       java.lang.String comment,
       AsyncCallback<JobTypes.BackupJobStatus> asyncCallback,
       InvocationConfig invocationConfig)

Initiate backup with the specified schedule. 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:
BackupJobStatus Structure

Operation Errors:
FeatureInUse - if a backup or restore is already in progress.
NotFound - if schedule associated with id does not exist.
Error - if any error occurs during the execution of the operation.

Parameters:

schedule - Identifier of the schedule The parameter must be an identifier for the resource type: com.vmware.appliance.recovery.backup.schedule.

comment - field that specifies the description for the backup. If null the backup will have an empty comment.

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

invocationConfig - Configuration for the method invocation.

get

SchedulesTypes.Info get(java.lang.String schedule)

Returns an existing schedule information based on id. 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:

schedule - Identifier of the schedule The parameter must be an identifier for the resource type: com.vmware.appliance.recovery.backup.schedule.

Returns:

Info Structure

Throws:

NotFound - if schedule associated with id does not exist.

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

get

SchedulesTypes.Info get(java.lang.String schedule,
                      InvocationConfig invocationConfig)

Returns an existing schedule information based on id. 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:

schedule - Identifier of the schedule The parameter must be an identifier for the resource type: com.vmware.appliance.recovery.backup.schedule.

invocationConfig - Configuration for the method invocation.

Returns:

Info Structure

Throws:

NotFound - if schedule associated with id does not exist.

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

get

void get(java.lang.String schedule,
       AsyncCallback<SchedulesTypes.Info> asyncCallback)

Returns an existing schedule information based on id. 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 schedule associated with id does not exist.
Error - if any error occurs during the execution of the operation.

Parameters:

schedule - Identifier of the schedule The parameter must be an identifier for the resource type: com.vmware.appliance.recovery.backup.schedule.

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

get

void get(java.lang.String schedule,
       AsyncCallback<SchedulesTypes.Info> asyncCallback,
       InvocationConfig invocationConfig)

Returns an existing schedule information based on id. 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 schedule associated with id does not exist.
Error - if any error occurs during the execution of the operation.

Parameters:

schedule - Identifier of the schedule The parameter must be an identifier for the resource type: com.vmware.appliance.recovery.backup.schedule.

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

invocationConfig - Configuration for the method invocation.

create

void create(java.lang.String schedule,
          SchedulesTypes.CreateSpec spec)

Creates a schedule. 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:

schedule - Identifier of the schedule The parameter must be an identifier for the resource type: com.vmware.appliance.recovery.backup.schedule.

spec - CreateSpec Structure

Throws:

InvalidArgument - if provided with invalid schedule specification.

AlreadyExists - if the schedule with the given id already exists.

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

create

void create(java.lang.String schedule,
          SchedulesTypes.CreateSpec spec,
          InvocationConfig invocationConfig)

Creates a schedule. 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:

schedule - Identifier of the schedule The parameter must be an identifier for the resource type: com.vmware.appliance.recovery.backup.schedule.

spec - CreateSpec Structure

invocationConfig - Configuration for the method invocation.

Throws:

InvalidArgument - if provided with invalid schedule specification.

AlreadyExists - if the schedule with the given id already exists.

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

create

void create(java.lang.String schedule,
          SchedulesTypes.CreateSpec spec,
          AsyncCallback<java.lang.Void> asyncCallback)

Creates a schedule. This method was added in vSphere API 6.7.

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

Operation Errors:
InvalidArgument - if provided with invalid schedule specification.
AlreadyExists - if the schedule with the given id already exists.
Error - if any error occurs during the execution of the operation.

Parameters:

schedule - Identifier of the schedule The parameter must be an identifier for the resource type: com.vmware.appliance.recovery.backup.schedule.

spec - CreateSpec Structure

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

create

void create(java.lang.String schedule,
          SchedulesTypes.CreateSpec spec,
          AsyncCallback<java.lang.Void> asyncCallback,
          InvocationConfig invocationConfig)

Creates a schedule. 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 Errors:
InvalidArgument - if provided with invalid schedule specification.
AlreadyExists - if the schedule with the given id already exists.
Error - if any error occurs during the execution of the operation.

Parameters:

schedule - Identifier of the schedule The parameter must be an identifier for the resource type: com.vmware.appliance.recovery.backup.schedule.

spec - CreateSpec Structure

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

invocationConfig - Configuration for the method invocation.

update

void update(java.lang.String schedule,
          SchedulesTypes.UpdateSpec spec)

Updates a schedule. 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:

schedule - Identifier of the schedule The parameter must be an identifier for the resource type: com.vmware.appliance.recovery.backup.schedule.

spec - UpdateSpec Structure

Throws:

InvalidArgument - if provided with invalid schedule specification.

NotFound - if schedule associated with id does not exist.

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

update

void update(java.lang.String schedule,
          SchedulesTypes.UpdateSpec spec,
          InvocationConfig invocationConfig)

Updates a schedule. 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:

schedule - Identifier of the schedule The parameter must be an identifier for the resource type: com.vmware.appliance.recovery.backup.schedule.

spec - UpdateSpec Structure

invocationConfig - Configuration for the method invocation.

Throws:

InvalidArgument - if provided with invalid schedule specification.

NotFound - if schedule associated with id does not exist.

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

update

void update(java.lang.String schedule,
          SchedulesTypes.UpdateSpec spec,
          AsyncCallback<java.lang.Void> asyncCallback)

Updates a schedule. This method was added in vSphere API 6.7.

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

Operation Errors:
InvalidArgument - if provided with invalid schedule specification.
NotFound - if schedule associated with id does not exist.
Error - if any error occurs during the execution of the operation.

Parameters:

schedule - Identifier of the schedule The parameter must be an identifier for the resource type: com.vmware.appliance.recovery.backup.schedule.

spec - UpdateSpec Structure

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

update

void update(java.lang.String schedule,
          SchedulesTypes.UpdateSpec spec,
          AsyncCallback<java.lang.Void> asyncCallback,
          InvocationConfig invocationConfig)

Updates a schedule. 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 Errors:
InvalidArgument - if provided with invalid schedule specification.
NotFound - if schedule associated with id does not exist.
Error - if any error occurs during the execution of the operation.

Parameters:

schedule - Identifier of the schedule The parameter must be an identifier for the resource type: com.vmware.appliance.recovery.backup.schedule.

spec - UpdateSpec Structure

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

invocationConfig - Configuration for the method invocation.

delete

void delete(java.lang.String schedule)

Deletes an existing schedule. 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:

schedule - Identifier of the schedule The parameter must be an identifier for the resource type: com.vmware.appliance.recovery.backup.schedule.

Throws:

NotFound - if schedule associated with id does not exist.

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

delete

void delete(java.lang.String schedule,
          InvocationConfig invocationConfig)

Deletes an existing schedule. 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:

schedule - Identifier of the schedule The parameter must be an identifier for the resource type: com.vmware.appliance.recovery.backup.schedule.

invocationConfig - Configuration for the method invocation.

Throws:

NotFound - if schedule associated with id does not exist.

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

delete

void delete(java.lang.String schedule,
          AsyncCallback<java.lang.Void> asyncCallback)

Deletes an existing schedule. This method was added in vSphere API 6.7.

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

Operation Errors:
NotFound - if schedule associated with id does not exist.
Error - if any error occurs during the execution of the operation.

Parameters:

schedule - Identifier of the schedule The parameter must be an identifier for the resource type: com.vmware.appliance.recovery.backup.schedule.

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

delete

void delete(java.lang.String schedule,
          AsyncCallback<java.lang.Void> asyncCallback,
          InvocationConfig invocationConfig)

Deletes an existing schedule. 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 Errors:
NotFound - if schedule associated with id does not exist.
Error - if any error occurs during the execution of the operation.

Parameters:

schedule - Identifier of the schedule The parameter must be an identifier for the resource type: com.vmware.appliance.recovery.backup.schedule.

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

invocationConfig - Configuration for the method invocation.