com.vmware.vcenter.deployment

Interface ImportHistory

All Superinterfaces:

ImportHistoryTypes, Service

All Known Implementing Classes:

ImportHistoryStub

public interface ImportHistory
extends Service, ImportHistoryTypes

The ImportHistory interface provides methods for managing the import of vCenter historical data, e.g. Tasks, Events and Statistics, when is is imported separately from the upgrade or migration process. This interface was added in vSphere API 6.7.

Nested Class Summary

Nested classes/interfaces inherited from interface com.vmware.vcenter.deployment.ImportHistoryTypes

ImportHistoryTypes.CreateSpec, ImportHistoryTypes.Info

Method Summary

Methods

Modifier and Type	Method and Description
void	cancel() Cancels the task for importing vCenter historical data.
void	cancel(AsyncCallback<java.lang.Void> asyncCallback) Cancels the task for importing vCenter historical data.
void	cancel(AsyncCallback<java.lang.Void> asyncCallback, InvocationConfig invocationConfig) Cancels the task for importing vCenter historical data.
void	cancel(InvocationConfig invocationConfig) Cancels the task for importing vCenter historical data.
ImportHistoryTypes.Info	get() Get the current status of the vCenter historical data import.
void	get(AsyncCallback<ImportHistoryTypes.Info> asyncCallback) Get the current status of the vCenter historical data import.
void	get(AsyncCallback<ImportHistoryTypes.Info> asyncCallback, InvocationConfig invocationConfig) Get the current status of the vCenter historical data import.
ImportHistoryTypes.Info	get(InvocationConfig invocationConfig) Get the current status of the vCenter historical data import.
void	pause() Pauses the task for importing vCenter historical data.
void	pause(AsyncCallback<java.lang.Void> asyncCallback) Pauses the task for importing vCenter historical data.
void	pause(AsyncCallback<java.lang.Void> asyncCallback, InvocationConfig invocationConfig) Pauses the task for importing vCenter historical data.
void	pause(InvocationConfig invocationConfig) Pauses the task for importing vCenter historical data.
void	resume() Resumes the task for importing vCenter historical data.
void	resume(AsyncCallback<java.lang.Void> asyncCallback) Resumes the task for importing vCenter historical data.
void	resume(AsyncCallback<java.lang.Void> asyncCallback, InvocationConfig invocationConfig) Resumes the task for importing vCenter historical data.
void	resume(InvocationConfig invocationConfig) Resumes the task for importing vCenter historical data.
void	start(ImportHistoryTypes.CreateSpec spec) Creates and starts task for importing vCenter historical data.
void	start(ImportHistoryTypes.CreateSpec spec, AsyncCallback<java.lang.Void> asyncCallback) Creates and starts task for importing vCenter historical data.
void	start(ImportHistoryTypes.CreateSpec spec, AsyncCallback<java.lang.Void> asyncCallback, InvocationConfig invocationConfig) Creates and starts task for importing vCenter historical data.
void	start(ImportHistoryTypes.CreateSpec spec, InvocationConfig invocationConfig) Creates and starts task for importing vCenter historical data.

Method Detail

get

ImportHistoryTypes.Info get()

Get the current status of the vCenter historical data import. 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:

Info structure containing the status information about the historical data import status.

Throws:

Unauthenticated - if the caller is not authenticated.

Unauthorized - if the caller is not authorized to perform the method.

Error - Generic error

get

ImportHistoryTypes.Info get(InvocationConfig invocationConfig)

Get the current status of the vCenter historical data import. 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:

Info structure containing the status information about the historical data import status.

Throws:

Unauthenticated - if the caller is not authenticated.

Unauthorized - if the caller is not authorized to perform the method.

Error - Generic error

get

void get(AsyncCallback<ImportHistoryTypes.Info> asyncCallback)

Get the current status of the vCenter historical data import. 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 containing the status information about the historical data import status.

Operation Errors:
Unauthenticated - if the caller is not authenticated.
Unauthorized - if the caller is not authorized to perform the method.
Error - Generic error

Parameters:

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

get

void get(AsyncCallback<ImportHistoryTypes.Info> asyncCallback,
       InvocationConfig invocationConfig)

Get the current status of the vCenter historical data import. 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 containing the status information about the historical data import status.

Operation Errors:
Unauthenticated - if the caller is not authenticated.
Unauthorized - if the caller is not authorized to perform the method.
Error - Generic error

Parameters:

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

invocationConfig - Configuration for the method invocation.

start

void start(ImportHistoryTypes.CreateSpec spec)

Creates and starts task for importing vCenter historical data. 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:

spec - An optional CreateSpec info that can be passed for creating a new historical data import task and starts it. If null, default value will be:

• name : vcenter.deployment.history.import
• description : vCenter Server history import

Throws:

Unauthenticated - if the caller is not authenticated.

Unauthorized - if the caller is not authorized to perform the method.

NotAllowedInCurrentState - if vCenter historical data import task cannot be started at this time. This can happen in the following cases:

• If historical data import has already been canceled because a canceled task cannot be re-started
• If historical data import has already been completed because a completed task cannot be re-started
• If historical data import has already been paused because a paused task can only be resumed or canceled

AlreadyInDesiredState - if vCenter historical data import task has already being started.

Error - Generic error

start

void start(ImportHistoryTypes.CreateSpec spec,
         InvocationConfig invocationConfig)

Creates and starts task for importing vCenter historical data. 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:

spec - An optional CreateSpec info that can be passed for creating a new historical data import task and starts it. If null, default value will be:

• name : vcenter.deployment.history.import
• description : vCenter Server history import

invocationConfig - Configuration for the method invocation.

Throws:

Unauthenticated - if the caller is not authenticated.

Unauthorized - if the caller is not authorized to perform the method.

NotAllowedInCurrentState - if vCenter historical data import task cannot be started at this time. This can happen in the following cases:

• If historical data import has already been canceled because a canceled task cannot be re-started
• If historical data import has already been completed because a completed task cannot be re-started
• If historical data import has already been paused because a paused task can only be resumed or canceled

AlreadyInDesiredState - if vCenter historical data import task has already being started.

Error - Generic error

start

void start(ImportHistoryTypes.CreateSpec spec,
         AsyncCallback<java.lang.Void> asyncCallback)

Creates and starts task for importing vCenter historical data. 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:
Unauthenticated - if the caller is not authenticated.
Unauthorized - if the caller is not authorized to perform the method.
NotAllowedInCurrentState - if vCenter historical data import task cannot be started at this time. This can happen in the following cases:

• If historical data import has already been canceled because a canceled task cannot be re-started
• If historical data import has already been completed because a completed task cannot be re-started
• If historical data import has already been paused because a paused task can only be resumed or canceled

AlreadyInDesiredState - if vCenter historical data import task has already being started.
Error - Generic error

Parameters:

spec - An optional CreateSpec info that can be passed for creating a new historical data import task and starts it. If null, default value will be:

• name : vcenter.deployment.history.import
• description : vCenter Server history import

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

start

void start(ImportHistoryTypes.CreateSpec spec,
         AsyncCallback<java.lang.Void> asyncCallback,
         InvocationConfig invocationConfig)

Creates and starts task for importing vCenter historical data. 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:
Unauthenticated - if the caller is not authenticated.
Unauthorized - if the caller is not authorized to perform the method.
NotAllowedInCurrentState - if vCenter historical data import task cannot be started at this time. This can happen in the following cases:

• If historical data import has already been canceled because a canceled task cannot be re-started
• If historical data import has already been completed because a completed task cannot be re-started
• If historical data import has already been paused because a paused task can only be resumed or canceled

AlreadyInDesiredState - if vCenter historical data import task has already being started.
Error - Generic error

Parameters:

spec - An optional CreateSpec info that can be passed for creating a new historical data import task and starts it. If null, default value will be:

• name : vcenter.deployment.history.import
• description : vCenter Server history import

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

invocationConfig - Configuration for the method invocation.

pause

void pause()

Pauses the task for importing vCenter historical data. This method was added in vSphere API 6.7.

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

Throws:

Unauthenticated - if the caller is not authenticated.

Unauthorized - if the caller is not authorized to perform the method.

NotAllowedInCurrentState - if vCenter historical data import task cannot be paused at this time. Pause can be accepted only in Status#RUNNING state

AlreadyInDesiredState - if vCenter historical data import task is already paused

Error - Generic error

pause

void pause(InvocationConfig invocationConfig)

Pauses the task for importing vCenter historical data. 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.

Throws:

Unauthenticated - if the caller is not authenticated.

Unauthorized - if the caller is not authorized to perform the method.

NotAllowedInCurrentState - if vCenter historical data import task cannot be paused at this time. Pause can be accepted only in Status#RUNNING state

AlreadyInDesiredState - if vCenter historical data import task is already paused

Error - Generic error

pause

void pause(AsyncCallback<java.lang.Void> asyncCallback)

Pauses the task for importing vCenter historical data. 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:
Unauthenticated - if the caller is not authenticated.
Unauthorized - if the caller is not authorized to perform the method.
NotAllowedInCurrentState - if vCenter historical data import task cannot be paused at this time. Pause can be accepted only in Status#RUNNING state
AlreadyInDesiredState - if vCenter historical data import task is already paused
Error - Generic error

Parameters:

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

pause

void pause(AsyncCallback<java.lang.Void> asyncCallback,
         InvocationConfig invocationConfig)

Pauses the task for importing vCenter historical data. 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:
Unauthenticated - if the caller is not authenticated.
Unauthorized - if the caller is not authorized to perform the method.
NotAllowedInCurrentState - if vCenter historical data import task cannot be paused at this time. Pause can be accepted only in Status#RUNNING state
AlreadyInDesiredState - if vCenter historical data import task is already paused
Error - Generic error

Parameters:

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

invocationConfig - Configuration for the method invocation.

resume

void resume()

Resumes the task for importing vCenter historical data. This method was added in vSphere API 6.7.

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

Throws:

Unauthenticated - if the caller is not authenticated.

Unauthorized - if the caller is not authorized to perform the method.

NotAllowedInCurrentState - if vCenter historical data import task cannot be resumed at this state. Resume can be accepted only in Status#BLOCKED state

AlreadyInDesiredState - if vCenter historical data import task is already resumed.

Error - Generic error.

resume

void resume(InvocationConfig invocationConfig)

Resumes the task for importing vCenter historical data. 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.

Throws:

Unauthenticated - if the caller is not authenticated.

Unauthorized - if the caller is not authorized to perform the method.

NotAllowedInCurrentState - if vCenter historical data import task cannot be resumed at this state. Resume can be accepted only in Status#BLOCKED state

AlreadyInDesiredState - if vCenter historical data import task is already resumed.

Error - Generic error.

resume

void resume(AsyncCallback<java.lang.Void> asyncCallback)

Resumes the task for importing vCenter historical data. 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:
Unauthenticated - if the caller is not authenticated.
Unauthorized - if the caller is not authorized to perform the method.
NotAllowedInCurrentState - if vCenter historical data import task cannot be resumed at this state. Resume can be accepted only in Status#BLOCKED state
AlreadyInDesiredState - if vCenter historical data import task is already resumed.
Error - Generic error.

Parameters:

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

resume

void resume(AsyncCallback<java.lang.Void> asyncCallback,
          InvocationConfig invocationConfig)

Resumes the task for importing vCenter historical data. 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:
Unauthenticated - if the caller is not authenticated.
Unauthorized - if the caller is not authorized to perform the method.
NotAllowedInCurrentState - if vCenter historical data import task cannot be resumed at this state. Resume can be accepted only in Status#BLOCKED state
AlreadyInDesiredState - if vCenter historical data import task is already resumed.
Error - Generic error.

Parameters:

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

invocationConfig - Configuration for the method invocation.

cancel

void cancel()

Cancels the task for importing vCenter historical data. This method was added in vSphere API 6.7.

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

Throws:

Unauthenticated - if the caller is not authenticated.

Unauthorized - if the caller is not authorized to perform the method.

NotAllowedInCurrentState - if vCenter historical data import task cannot be canceled at this state. This can happen in the following cases:

• If historical data import has not been started yet because a not running task cannot be canceled
• If historical data import has already been completed because a completed task cannot be canceled

AlreadyInDesiredState - if vCenter historical data import task is already canceled.

Error - Generic error.

cancel

void cancel(InvocationConfig invocationConfig)

Cancels the task for importing vCenter historical data. 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.

Throws:

Unauthenticated - if the caller is not authenticated.

Unauthorized - if the caller is not authorized to perform the method.

NotAllowedInCurrentState - if vCenter historical data import task cannot be canceled at this state. This can happen in the following cases:

• If historical data import has not been started yet because a not running task cannot be canceled
• If historical data import has already been completed because a completed task cannot be canceled

AlreadyInDesiredState - if vCenter historical data import task is already canceled.

Error - Generic error.

cancel

void cancel(AsyncCallback<java.lang.Void> asyncCallback)

Cancels the task for importing vCenter historical data. 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:
Unauthenticated - if the caller is not authenticated.
Unauthorized - if the caller is not authorized to perform the method.
NotAllowedInCurrentState - if vCenter historical data import task cannot be canceled at this state. This can happen in the following cases:

• If historical data import has not been started yet because a not running task cannot be canceled
• If historical data import has already been completed because a completed task cannot be canceled

AlreadyInDesiredState - if vCenter historical data import task is already canceled.
Error - Generic error.

Parameters:

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

cancel

void cancel(AsyncCallback<java.lang.Void> asyncCallback,
          InvocationConfig invocationConfig)

Cancels the task for importing vCenter historical data. 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:
Unauthenticated - if the caller is not authenticated.
Unauthorized - if the caller is not authorized to perform the method.
NotAllowedInCurrentState - if vCenter historical data import task cannot be canceled at this state. This can happen in the following cases:

• If historical data import has not been started yet because a not running task cannot be canceled
• If historical data import has already been completed because a completed task cannot be canceled

AlreadyInDesiredState - if vCenter historical data import task is already canceled.
Error - Generic error.

Parameters:

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

invocationConfig - Configuration for the method invocation.