com.vmware.esx.settings.depots

Interface SyncSchedule

All Superinterfaces:

Service, SyncScheduleTypes

All Known Implementing Classes:

SyncScheduleStub

public interface SyncSchedule
extends Service, SyncScheduleTypes

The SyncSchedule interface provides methods to manage Schedule of Online Software Depot sync.

Nested Class Summary

Nested classes/interfaces inherited from interface com.vmware.esx.settings.depots.SyncScheduleTypes

SyncScheduleTypes.DayOfWeek, SyncScheduleTypes.Recurrence, SyncScheduleTypes.Schedule, SyncScheduleTypes.Spec

Field Summary

Fields inherited from interface com.vmware.esx.settings.depots.SyncScheduleTypes

_VAPI_SERVICE_ID

Method Summary

Modifier and Type	Method and Description
SyncScheduleTypes.Spec	get() Returns the currently configured software depot sync schedule.
void	get(AsyncCallback<SyncScheduleTypes.Spec> asyncCallback) Returns the currently configured software depot sync schedule.
void	get(AsyncCallback<SyncScheduleTypes.Spec> asyncCallback, InvocationConfig invocationConfig) Returns the currently configured software depot sync schedule.
SyncScheduleTypes.Spec	get(InvocationConfig invocationConfig) Returns the currently configured software depot sync schedule.
void	set(SyncScheduleTypes.Spec spec) Sets the software depot sync schedule.
void	set(SyncScheduleTypes.Spec spec, AsyncCallback<java.lang.Void> asyncCallback) Sets the software depot sync schedule.
void	set(SyncScheduleTypes.Spec spec, AsyncCallback<java.lang.Void> asyncCallback, InvocationConfig invocationConfig) Sets the software depot sync schedule.
void	set(SyncScheduleTypes.Spec spec, InvocationConfig invocationConfig) Sets the software depot sync schedule.

Method Detail

get

SyncScheduleTypes.Spec get()

Returns the currently configured software depot sync schedule.

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

Returns:

Currently configured sync schedule.

Throws:

Unauthenticated - if the caller is not authenticated.

ServiceUnavailable - If the service is not available.

Error - If there is some unknown error. The accompanying error message will give more details about the failure.

Unauthorized - if you do not have all of the privileges described as follows:

• Method execution requires VcIntegrity.lifecycleSettings.Read.

get

SyncScheduleTypes.Spec get(InvocationConfig invocationConfig)

Returns the currently configured software depot sync schedule.

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:

Currently configured sync schedule.

Throws:

Unauthenticated - if the caller is not authenticated.

ServiceUnavailable - If the service is not available.

Error - If there is some unknown error. The accompanying error message will give more details about the failure.

Unauthorized - if you do not have all of the privileges described as follows:

• Method execution requires VcIntegrity.lifecycleSettings.Read.

get

void get(AsyncCallback<SyncScheduleTypes.Spec> asyncCallback)

Returns the currently configured software depot sync schedule.

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

Invocation Result:
Currently configured sync schedule.

Operation Errors:
Unauthenticated - if the caller is not authenticated.
ServiceUnavailable - If the service is not available.
Error - If there is some unknown error. The accompanying error message will give more details about the failure.
Unauthorized - if you do not have all of the privileges described as follows:

• Method execution requires VcIntegrity.lifecycleSettings.Read.

Parameters:

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

get

void get(AsyncCallback<SyncScheduleTypes.Spec> asyncCallback,
         InvocationConfig invocationConfig)

Returns the currently configured software depot sync schedule.

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:
Currently configured sync schedule.

Operation Errors:
Unauthenticated - if the caller is not authenticated.
ServiceUnavailable - If the service is not available.
Error - If there is some unknown error. The accompanying error message will give more details about the failure.
Unauthorized - if you do not have all of the privileges described as follows:

• Method execution requires VcIntegrity.lifecycleSettings.Read.

Parameters:

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

invocationConfig - Configuration for the method invocation.

set

void set(SyncScheduleTypes.Spec spec)

Sets the software depot sync schedule.

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

Parameters:

spec - Information of the software depot sync schedule. If null, it will be reset to the default schedule, which is daily at a random hour chosen when this API is called.

Throws:

Unauthenticated - if the caller is not authenticated.

ServiceUnavailable - If the service is not available.

InvalidArgument - If SyncScheduleTypes.Spec.getSchedule() is unset while SyncScheduleTypes.Spec.getEnabled() is set to true or if any of the values is not within valid range.

Error - If there is some unknown error. The accompanying error message will give more details about the failure.

Unauthorized - if you do not have all of the privileges described as follows:

• Method execution requires VcIntegrity.lifecycleSettings.Write.

set

void set(SyncScheduleTypes.Spec spec,
         InvocationConfig invocationConfig)

Sets the software depot sync schedule.

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:

spec - Information of the software depot sync schedule. If null, it will be reset to the default schedule, which is daily at a random hour chosen when this API is called.

invocationConfig - Configuration for the method invocation.

Throws:

Unauthenticated - if the caller is not authenticated.

ServiceUnavailable - If the service is not available.

InvalidArgument - If SyncScheduleTypes.Spec.getSchedule() is unset while SyncScheduleTypes.Spec.getEnabled() is set to true or if any of the values is not within valid range.

Error - If there is some unknown error. The accompanying error message will give more details about the failure.

Unauthorized - if you do not have all of the privileges described as follows:

• Method execution requires VcIntegrity.lifecycleSettings.Write.

set

void set(SyncScheduleTypes.Spec spec,
         AsyncCallback<java.lang.Void> asyncCallback)

Sets the software depot sync schedule.

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

Operation Errors:
Unauthenticated - if the caller is not authenticated.
ServiceUnavailable - If the service is not available.
InvalidArgument - If SyncScheduleTypes.Spec.getSchedule() is unset while SyncScheduleTypes.Spec.getEnabled() is set to true or if any of the values is not within valid range.
Error - If there is some unknown error. The accompanying error message will give more details about the failure.
Unauthorized - if you do not have all of the privileges described as follows:

• Method execution requires VcIntegrity.lifecycleSettings.Write.

Parameters:

spec - Information of the software depot sync schedule. If null, it will be reset to the default schedule, which is daily at a random hour chosen when this API is called.

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

set

void set(SyncScheduleTypes.Spec spec,
         AsyncCallback<java.lang.Void> asyncCallback,
         InvocationConfig invocationConfig)

Sets the software depot sync schedule.

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:
Unauthenticated - if the caller is not authenticated.
ServiceUnavailable - If the service is not available.
InvalidArgument - If SyncScheduleTypes.Spec.getSchedule() is unset while SyncScheduleTypes.Spec.getEnabled() is set to true or if any of the values is not within valid range.
Error - If there is some unknown error. The accompanying error message will give more details about the failure.
Unauthorized - if you do not have all of the privileges described as follows:

• Method execution requires VcIntegrity.lifecycleSettings.Write.

Parameters:

spec - Information of the software depot sync schedule. If null, it will be reset to the default schedule, which is daily at a random hour chosen when this API is called.

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

invocationConfig - Configuration for the method invocation.