VMware vSphere Automation SDK for .NET 7.0.0.1
vmware::vcenter::deployment::ImportHistoryStub Class Reference

Remote stub implementation of the ImportHistory API service. More...

Inherits vmware::vcenter::deployment::ImportHistory.

List of all members.

Public Member Functions

 ImportHistoryStub (vmware.vapi.core.IApiProvider iApiProvider, vmware.vapi.bindings.TypeConverter typeConverter, vmware.vapi.bindings.IStubConfiguration config)
 ImportHistoryStub (vmware.vapi.core.IApiProvider iApiProvider, vmware.vapi.bindings.IStubConfiguration config)
vmware.vcenter.deployment.ImportHistoryTypes.Info Get ()
 Get the current status of the vCenter historical data import.
vmware.vcenter.deployment.ImportHistoryTypes.Info Get (global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
 Get the current status of the vCenter historical data import.
global::System.Threading.Tasks.Task
< vmware.vcenter.deployment.ImportHistoryTypes.Info
GetAsync ()
 Get the current status of the vCenter historical data import.
global::System.Threading.Tasks.Task
< vmware.vcenter.deployment.ImportHistoryTypes.Info
GetAsync (global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
 Get the current status of the vCenter historical data import.
void Start (vmware.vcenter.deployment.ImportHistoryTypes.CreateSpec spec)
 Creates and starts task for importing vCenter historical data.
void Start (vmware.vcenter.deployment.ImportHistoryTypes.CreateSpec spec, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
 Creates and starts task for importing vCenter historical data.
global::System.Threading.Tasks.Task StartAsync (vmware.vcenter.deployment.ImportHistoryTypes.CreateSpec spec)
 Creates and starts task for importing vCenter historical data.
global::System.Threading.Tasks.Task StartAsync (vmware.vcenter.deployment.ImportHistoryTypes.CreateSpec spec, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
 Creates and starts task for importing vCenter historical data.
void Pause ()
 Pauses the task for importing vCenter historical data.
void Pause (global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
 Pauses the task for importing vCenter historical data.
global::System.Threading.Tasks.Task PauseAsync ()
 Pauses the task for importing vCenter historical data.
global::System.Threading.Tasks.Task PauseAsync (global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
 Pauses the task for importing vCenter historical data.
void Resume ()
 Resumes the task for importing vCenter historical data.
void Resume (global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
 Resumes the task for importing vCenter historical data.
global::System.Threading.Tasks.Task ResumeAsync ()
 Resumes the task for importing vCenter historical data.
global::System.Threading.Tasks.Task ResumeAsync (global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
 Resumes the task for importing vCenter historical data.
void Cancel ()
 Cancels the task for importing vCenter historical data.
void Cancel (global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
 Cancels the task for importing vCenter historical data.
global::System.Threading.Tasks.Task CancelAsync ()
 Cancels the task for importing vCenter historical data.
global::System.Threading.Tasks.Task CancelAsync (global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
 Cancels the task for importing vCenter historical data.

Detailed Description

Remote stub implementation of the ImportHistory API service.


Constructor & Destructor Documentation

vmware::vcenter::deployment::ImportHistoryStub::ImportHistoryStub ( vmware.vapi.core.IApiProvider  iApiProvider,
vmware.vapi.bindings.TypeConverter  typeConverter,
vmware.vapi.bindings.IStubConfiguration  config 
) [inline]
vmware::vcenter::deployment::ImportHistoryStub::ImportHistoryStub ( vmware.vapi.core.IApiProvider  iApiProvider,
vmware.vapi.bindings.IStubConfiguration  config 
) [inline]

Member Function Documentation

void vmware::vcenter::deployment::ImportHistoryStub::Cancel ( ) [inline]

Cancels the task for importing vCenter historical data.

This method was added in vSphere API 6.7.

Exceptions:
vmware.vapi.std.errors.Unauthenticatedif the caller is not authenticated.
vmware.vapi.std.errors.Unauthorizedif the caller is not authorized to perform the method.
vmware.vapi.std.errors.NotAllowedInCurrentStateif 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
vmware.vapi.std.errors.AlreadyInDesiredStateif vCenter historical data import task is already canceled.
vmware.vapi.std.errors.ErrorGeneric error.

Implements vmware::vcenter::deployment::ImportHistory.

void vmware::vcenter::deployment::ImportHistoryStub::Cancel ( global::System.Action< vmware.vapi.std.Progress >  _progress,
vmware.vapi.bindings.client.InvocationConfig  _invocationConfig 
) [inline]

Cancels the task for importing vCenter historical data.

This method was added in vSphere API 6.7.

Exceptions:
vmware.vapi.std.errors.Unauthenticatedif the caller is not authenticated.
vmware.vapi.std.errors.Unauthorizedif the caller is not authorized to perform the method.
vmware.vapi.std.errors.NotAllowedInCurrentStateif 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
vmware.vapi.std.errors.AlreadyInDesiredStateif vCenter historical data import task is already canceled.
vmware.vapi.std.errors.ErrorGeneric error.

Implements vmware::vcenter::deployment::ImportHistory.

global::System.Threading.Tasks.Task vmware::vcenter::deployment::ImportHistoryStub::CancelAsync ( ) [inline]

Cancels the task for importing vCenter historical data.

This method was added in vSphere API 6.7.

Exceptions:
vmware.vapi.std.errors.Unauthenticatedif the caller is not authenticated.
vmware.vapi.std.errors.Unauthorizedif the caller is not authorized to perform the method.
vmware.vapi.std.errors.NotAllowedInCurrentStateif 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
vmware.vapi.std.errors.AlreadyInDesiredStateif vCenter historical data import task is already canceled.
vmware.vapi.std.errors.ErrorGeneric error.

Implements vmware::vcenter::deployment::ImportHistory.

global::System.Threading.Tasks.Task vmware::vcenter::deployment::ImportHistoryStub::CancelAsync ( global::System.Action< vmware.vapi.std.Progress >  _progress,
vmware.vapi.bindings.client.InvocationConfig  _invocationConfig 
) [inline]

Cancels the task for importing vCenter historical data.

This method was added in vSphere API 6.7.

Exceptions:
vmware.vapi.std.errors.Unauthenticatedif the caller is not authenticated.
vmware.vapi.std.errors.Unauthorizedif the caller is not authorized to perform the method.
vmware.vapi.std.errors.NotAllowedInCurrentStateif 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
vmware.vapi.std.errors.AlreadyInDesiredStateif vCenter historical data import task is already canceled.
vmware.vapi.std.errors.ErrorGeneric error.

Implements vmware::vcenter::deployment::ImportHistory.

vmware.vcenter.deployment.ImportHistoryTypes.Info vmware::vcenter::deployment::ImportHistoryStub::Get ( ) [inline]

Get the current status of the vCenter historical data import.

This method was added in vSphere API 6.7.

Exceptions:
vmware.vapi.std.errors.Unauthenticatedif the caller is not authenticated.
vmware.vapi.std.errors.Unauthorizedif the caller is not authorized to perform the method.
vmware.vapi.std.errors.ErrorGeneric error
Returns:
Info structure containing the status information about the historical data import status.

Implements vmware::vcenter::deployment::ImportHistory.

vmware.vcenter.deployment.ImportHistoryTypes.Info vmware::vcenter::deployment::ImportHistoryStub::Get ( global::System.Action< vmware.vapi.std.Progress >  _progress,
vmware.vapi.bindings.client.InvocationConfig  _invocationConfig 
) [inline]

Get the current status of the vCenter historical data import.

This method was added in vSphere API 6.7.

Exceptions:
vmware.vapi.std.errors.Unauthenticatedif the caller is not authenticated.
vmware.vapi.std.errors.Unauthorizedif the caller is not authorized to perform the method.
vmware.vapi.std.errors.ErrorGeneric error
Returns:
Info structure containing the status information about the historical data import status.

Implements vmware::vcenter::deployment::ImportHistory.

global::System.Threading.Tasks.Task<vmware.vcenter.deployment.ImportHistoryTypes.Info> vmware::vcenter::deployment::ImportHistoryStub::GetAsync ( global::System.Action< vmware.vapi.std.Progress >  _progress,
vmware.vapi.bindings.client.InvocationConfig  _invocationConfig 
) [inline]

Get the current status of the vCenter historical data import.

This method was added in vSphere API 6.7.

Exceptions:
vmware.vapi.std.errors.Unauthenticatedif the caller is not authenticated.
vmware.vapi.std.errors.Unauthorizedif the caller is not authorized to perform the method.
vmware.vapi.std.errors.ErrorGeneric error
Returns:
Info structure containing the status information about the historical data import status.

Implements vmware::vcenter::deployment::ImportHistory.

global::System.Threading.Tasks.Task<vmware.vcenter.deployment.ImportHistoryTypes.Info> vmware::vcenter::deployment::ImportHistoryStub::GetAsync ( ) [inline]

Get the current status of the vCenter historical data import.

This method was added in vSphere API 6.7.

Exceptions:
vmware.vapi.std.errors.Unauthenticatedif the caller is not authenticated.
vmware.vapi.std.errors.Unauthorizedif the caller is not authorized to perform the method.
vmware.vapi.std.errors.ErrorGeneric error
Returns:
Info structure containing the status information about the historical data import status.

Implements vmware::vcenter::deployment::ImportHistory.

void vmware::vcenter::deployment::ImportHistoryStub::Pause ( ) [inline]

Pauses the task for importing vCenter historical data.

This method was added in vSphere API 6.7.

Exceptions:
vmware.vapi.std.errors.Unauthenticatedif the caller is not authenticated.
vmware.vapi.std.errors.Unauthorizedif the caller is not authorized to perform the method.
vmware.vapi.std.errors.NotAllowedInCurrentStateif vCenter historical data import task cannot be paused at this time. Pause can be accepted only in vmware.cis.task.Status.RUNNING state.
vmware.vapi.std.errors.AlreadyInDesiredStateif vCenter historical data import task is already paused
vmware.vapi.std.errors.ErrorGeneric error

Implements vmware::vcenter::deployment::ImportHistory.

void vmware::vcenter::deployment::ImportHistoryStub::Pause ( global::System.Action< vmware.vapi.std.Progress >  _progress,
vmware.vapi.bindings.client.InvocationConfig  _invocationConfig 
) [inline]

Pauses the task for importing vCenter historical data.

This method was added in vSphere API 6.7.

Exceptions:
vmware.vapi.std.errors.Unauthenticatedif the caller is not authenticated.
vmware.vapi.std.errors.Unauthorizedif the caller is not authorized to perform the method.
vmware.vapi.std.errors.NotAllowedInCurrentStateif vCenter historical data import task cannot be paused at this time. Pause can be accepted only in vmware.cis.task.Status.RUNNING state.
vmware.vapi.std.errors.AlreadyInDesiredStateif vCenter historical data import task is already paused
vmware.vapi.std.errors.ErrorGeneric error

Implements vmware::vcenter::deployment::ImportHistory.

global::System.Threading.Tasks.Task vmware::vcenter::deployment::ImportHistoryStub::PauseAsync ( ) [inline]

Pauses the task for importing vCenter historical data.

This method was added in vSphere API 6.7.

Exceptions:
vmware.vapi.std.errors.Unauthenticatedif the caller is not authenticated.
vmware.vapi.std.errors.Unauthorizedif the caller is not authorized to perform the method.
vmware.vapi.std.errors.NotAllowedInCurrentStateif vCenter historical data import task cannot be paused at this time. Pause can be accepted only in vmware.cis.task.Status.RUNNING state.
vmware.vapi.std.errors.AlreadyInDesiredStateif vCenter historical data import task is already paused
vmware.vapi.std.errors.ErrorGeneric error

Implements vmware::vcenter::deployment::ImportHistory.

global::System.Threading.Tasks.Task vmware::vcenter::deployment::ImportHistoryStub::PauseAsync ( global::System.Action< vmware.vapi.std.Progress >  _progress,
vmware.vapi.bindings.client.InvocationConfig  _invocationConfig 
) [inline]

Pauses the task for importing vCenter historical data.

This method was added in vSphere API 6.7.

Exceptions:
vmware.vapi.std.errors.Unauthenticatedif the caller is not authenticated.
vmware.vapi.std.errors.Unauthorizedif the caller is not authorized to perform the method.
vmware.vapi.std.errors.NotAllowedInCurrentStateif vCenter historical data import task cannot be paused at this time. Pause can be accepted only in vmware.cis.task.Status.RUNNING state.
vmware.vapi.std.errors.AlreadyInDesiredStateif vCenter historical data import task is already paused
vmware.vapi.std.errors.ErrorGeneric error

Implements vmware::vcenter::deployment::ImportHistory.

void vmware::vcenter::deployment::ImportHistoryStub::Resume ( ) [inline]

Resumes the task for importing vCenter historical data.

This method was added in vSphere API 6.7.

Exceptions:
vmware.vapi.std.errors.Unauthenticatedif the caller is not authenticated.
vmware.vapi.std.errors.Unauthorizedif the caller is not authorized to perform the method.
vmware.vapi.std.errors.NotAllowedInCurrentStateif vCenter historical data import task cannot be resumed at this state. Resume can be accepted only in vmware.cis.task.Status.BLOCKED state
vmware.vapi.std.errors.AlreadyInDesiredStateif vCenter historical data import task is already resumed.
vmware.vapi.std.errors.ErrorGeneric error.

Implements vmware::vcenter::deployment::ImportHistory.

void vmware::vcenter::deployment::ImportHistoryStub::Resume ( global::System.Action< vmware.vapi.std.Progress >  _progress,
vmware.vapi.bindings.client.InvocationConfig  _invocationConfig 
) [inline]

Resumes the task for importing vCenter historical data.

This method was added in vSphere API 6.7.

Exceptions:
vmware.vapi.std.errors.Unauthenticatedif the caller is not authenticated.
vmware.vapi.std.errors.Unauthorizedif the caller is not authorized to perform the method.
vmware.vapi.std.errors.NotAllowedInCurrentStateif vCenter historical data import task cannot be resumed at this state. Resume can be accepted only in vmware.cis.task.Status.BLOCKED state
vmware.vapi.std.errors.AlreadyInDesiredStateif vCenter historical data import task is already resumed.
vmware.vapi.std.errors.ErrorGeneric error.

Implements vmware::vcenter::deployment::ImportHistory.

global::System.Threading.Tasks.Task vmware::vcenter::deployment::ImportHistoryStub::ResumeAsync ( ) [inline]

Resumes the task for importing vCenter historical data.

This method was added in vSphere API 6.7.

Exceptions:
vmware.vapi.std.errors.Unauthenticatedif the caller is not authenticated.
vmware.vapi.std.errors.Unauthorizedif the caller is not authorized to perform the method.
vmware.vapi.std.errors.NotAllowedInCurrentStateif vCenter historical data import task cannot be resumed at this state. Resume can be accepted only in vmware.cis.task.Status.BLOCKED state
vmware.vapi.std.errors.AlreadyInDesiredStateif vCenter historical data import task is already resumed.
vmware.vapi.std.errors.ErrorGeneric error.

Implements vmware::vcenter::deployment::ImportHistory.

global::System.Threading.Tasks.Task vmware::vcenter::deployment::ImportHistoryStub::ResumeAsync ( global::System.Action< vmware.vapi.std.Progress >  _progress,
vmware.vapi.bindings.client.InvocationConfig  _invocationConfig 
) [inline]

Resumes the task for importing vCenter historical data.

This method was added in vSphere API 6.7.

Exceptions:
vmware.vapi.std.errors.Unauthenticatedif the caller is not authenticated.
vmware.vapi.std.errors.Unauthorizedif the caller is not authorized to perform the method.
vmware.vapi.std.errors.NotAllowedInCurrentStateif vCenter historical data import task cannot be resumed at this state. Resume can be accepted only in vmware.cis.task.Status.BLOCKED state
vmware.vapi.std.errors.AlreadyInDesiredStateif vCenter historical data import task is already resumed.
vmware.vapi.std.errors.ErrorGeneric error.

Implements vmware::vcenter::deployment::ImportHistory.

void vmware::vcenter::deployment::ImportHistoryStub::Start ( vmware.vcenter.deployment.ImportHistoryTypes.CreateSpec  spec,
global::System.Action< vmware.vapi.std.Progress >  _progress,
vmware.vapi.bindings.client.InvocationConfig  _invocationConfig 
) [inline]

Creates and starts task for importing vCenter historical data.

This method was added in vSphere API 6.7.

Exceptions:
vmware.vapi.std.errors.Unauthenticatedif the caller is not authenticated.
vmware.vapi.std.errors.Unauthorizedif the caller is not authorized to perform the method.
vmware.vapi.std.errors.NotAllowedInCurrentStateif 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
vmware.vapi.std.errors.AlreadyInDesiredStateif vCenter historical data import task has already being started.
vmware.vapi.std.errors.ErrorGeneric error
Parameters:
specAn optional ImportHistory.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
_progressProgress notification call back
_invocationConfigConfiguration for the method invocation

Implements vmware::vcenter::deployment::ImportHistory.

void vmware::vcenter::deployment::ImportHistoryStub::Start ( vmware.vcenter.deployment.ImportHistoryTypes.CreateSpec  spec) [inline]

Creates and starts task for importing vCenter historical data.

This method was added in vSphere API 6.7.

Exceptions:
vmware.vapi.std.errors.Unauthenticatedif the caller is not authenticated.
vmware.vapi.std.errors.Unauthorizedif the caller is not authorized to perform the method.
vmware.vapi.std.errors.NotAllowedInCurrentStateif 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
vmware.vapi.std.errors.AlreadyInDesiredStateif vCenter historical data import task has already being started.
vmware.vapi.std.errors.ErrorGeneric error
Parameters:
specAn optional ImportHistory.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

Implements vmware::vcenter::deployment::ImportHistory.

global::System.Threading.Tasks.Task vmware::vcenter::deployment::ImportHistoryStub::StartAsync ( vmware.vcenter.deployment.ImportHistoryTypes.CreateSpec  spec,
global::System.Action< vmware.vapi.std.Progress >  _progress,
vmware.vapi.bindings.client.InvocationConfig  _invocationConfig 
) [inline]

Creates and starts task for importing vCenter historical data.

This method was added in vSphere API 6.7.

Exceptions:
vmware.vapi.std.errors.Unauthenticatedif the caller is not authenticated.
vmware.vapi.std.errors.Unauthorizedif the caller is not authorized to perform the method.
vmware.vapi.std.errors.NotAllowedInCurrentStateif 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
vmware.vapi.std.errors.AlreadyInDesiredStateif vCenter historical data import task has already being started.
vmware.vapi.std.errors.ErrorGeneric error
Parameters:
specAn optional ImportHistory.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
_progressProgress notification call back
_invocationConfigConfiguration for the method invocation

Implements vmware::vcenter::deployment::ImportHistory.

global::System.Threading.Tasks.Task vmware::vcenter::deployment::ImportHistoryStub::StartAsync ( vmware.vcenter.deployment.ImportHistoryTypes.CreateSpec  spec) [inline]

Creates and starts task for importing vCenter historical data.

This method was added in vSphere API 6.7.

Exceptions:
vmware.vapi.std.errors.Unauthenticatedif the caller is not authenticated.
vmware.vapi.std.errors.Unauthorizedif the caller is not authorized to perform the method.
vmware.vapi.std.errors.NotAllowedInCurrentStateif 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
vmware.vapi.std.errors.AlreadyInDesiredStateif vCenter historical data import task has already being started.
vmware.vapi.std.errors.ErrorGeneric error
Parameters:
specAn optional ImportHistory.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

Implements vmware::vcenter::deployment::ImportHistory.


The documentation for this class was generated from the following file: