com.vmware.appliance.recovery.backup

Class SchedulesStub

java.lang.Object

com.vmware.vapi.internal.bindings.Stub

com.vmware.appliance.recovery.backup.SchedulesStub

All Implemented Interfaces:

Schedules, SchedulesTypes, Service

public class SchedulesStub
extends com.vmware.vapi.internal.bindings.Stub
implements Schedules

Remote stub implementation of the Schedules 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.SchedulesTypes

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

Field Summary

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

apiProvider, converter, ifaceId, securityContext

Constructor Summary

Constructors

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

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.

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

SchedulesStub

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

SchedulesStub

public SchedulesStub(ApiProvider apiProvider,
             StubConfigurationBase config)

Method Detail

list

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

Description copied from interface: Schedules

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.

Specified by:

list in interface Schedules

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.

list

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

Description copied from interface: Schedules

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.

Specified by:

list in interface Schedules

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.

list

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

Description copied from interface: Schedules

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.

Specified by:

list in interface Schedules

Parameters:

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

list

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

Description copied from interface: Schedules

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.

Specified by:

list in interface Schedules

Parameters:

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

invocationConfig - Configuration for the method invocation.

run

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

Description copied from interface: Schedules

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.

Specified by:

run in interface Schedules

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

run

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

Description copied from interface: Schedules

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.

Specified by:

run in interface Schedules

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

run

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

Description copied from interface: Schedules

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.

Specified by:

run in interface Schedules

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

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

Description copied from interface: Schedules

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.

Specified by:

run in interface Schedules

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

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

Description copied from interface: Schedules

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.

Specified by:

get in interface Schedules

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

get

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

Description copied from interface: Schedules

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.

Specified by:

get in interface Schedules

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

get

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

Description copied from interface: Schedules

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.

Specified by:

get in interface Schedules

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

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

Description copied from interface: Schedules

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.

Specified by:

get in interface Schedules

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

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

Description copied from interface: Schedules

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.

Specified by:

create in interface Schedules

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

create

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

Description copied from interface: Schedules

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.

Specified by:

create in interface Schedules

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.

create

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

Description copied from interface: Schedules

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.

Specified by:

create in interface Schedules

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

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

Description copied from interface: Schedules

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.

Specified by:

create in interface Schedules

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

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

Description copied from interface: Schedules

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.

Specified by:

update in interface Schedules

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

update

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

Description copied from interface: Schedules

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.

Specified by:

update in interface Schedules

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.

update

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

Description copied from interface: Schedules

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.

Specified by:

update in interface Schedules

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

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

Description copied from interface: Schedules

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.

Specified by:

update in interface Schedules

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

public void delete(java.lang.String schedule)

Description copied from interface: Schedules

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.

Specified by:

delete in interface Schedules

Parameters:

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

delete

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

Description copied from interface: Schedules

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.

Specified by:

delete in interface Schedules

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.

delete

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

Description copied from interface: Schedules

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.

Specified by:

delete in interface Schedules

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

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

Description copied from interface: Schedules

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.

Specified by:

delete in interface Schedules

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.