vmware::cis::TasksStub Class Reference

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

Inherits vmware::cis::Tasks.

List of all members.

Public Member Functions
	TasksStub (vmware.vapi.core.IApiProvider iApiProvider, vmware.vapi.bindings.TypeConverter typeConverter, vmware.vapi.bindings.IStubConfiguration config)
	TasksStub (vmware.vapi.core.IApiProvider iApiProvider, vmware.vapi.bindings.IStubConfiguration config)
vmware.cis.task.Info	Get (string task, vmware.cis.TasksTypes.GetSpec spec)
	Returns information about a task.
vmware.cis.task.Info	Get (string task, vmware.cis.TasksTypes.GetSpec spec, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
	Returns information about a task.
global::System.Threading.Tasks.Task < vmware.cis.task.Info >	GetAsync (string task, vmware.cis.TasksTypes.GetSpec spec)
	Returns information about a task.
global::System.Threading.Tasks.Task < vmware.cis.task.Info >	GetAsync (string task, vmware.cis.TasksTypes.GetSpec spec, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
	Returns information about a task.
global::System.Collections.Generic.Dictionary < string, vmware.cis.task.Info >	List (vmware.cis.TasksTypes.FilterSpec filterSpec, vmware.cis.TasksTypes.GetSpec resultSpec)
	Returns information about at most 1000 visible (subject to permission checks) tasks matching the Tasks.FilterSpec .
global::System.Collections.Generic.Dictionary < string, vmware.cis.task.Info >	List (vmware.cis.TasksTypes.FilterSpec filterSpec, vmware.cis.TasksTypes.GetSpec resultSpec, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
	Returns information about at most 1000 visible (subject to permission checks) tasks matching the Tasks.FilterSpec .
global::System.Threading.Tasks.Task < global::System.Collections.Generic.Dictionary < string, vmware.cis.task.Info > >	ListAsync (vmware.cis.TasksTypes.FilterSpec filterSpec, vmware.cis.TasksTypes.GetSpec resultSpec)
	Returns information about at most 1000 visible (subject to permission checks) tasks matching the Tasks.FilterSpec .
global::System.Threading.Tasks.Task < global::System.Collections.Generic.Dictionary < string, vmware.cis.task.Info > >	ListAsync (vmware.cis.TasksTypes.FilterSpec filterSpec, vmware.cis.TasksTypes.GetSpec resultSpec, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
	Returns information about at most 1000 visible (subject to permission checks) tasks matching the Tasks.FilterSpec .
void	Cancel (string task)
	Cancel a running operation associated with the task.
void	Cancel (string task, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
	Cancel a running operation associated with the task.
global::System.Threading.Tasks.Task	CancelAsync (string task)
	Cancel a running operation associated with the task.
global::System.Threading.Tasks.Task	CancelAsync (string task, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
	Cancel a running operation associated with the task.

---

Detailed Description

Remote stub implementation of the Tasks API service.

---

Constructor & Destructor Documentation

vmware::cis::TasksStub::TasksStub	(	vmware.vapi.core.IApiProvider	iApiProvider,
		vmware.vapi.bindings.TypeConverter	typeConverter,
		vmware.vapi.bindings.IStubConfiguration	config
	)		[inline]

vmware::cis::TasksStub::TasksStub	(	vmware.vapi.core.IApiProvider	iApiProvider,
		vmware.vapi.bindings.IStubConfiguration	config
	)		[inline]

---

Member Function Documentation

void vmware::cis::TasksStub::Cancel

(

string

task

)

[inline]

Cancel a running operation associated with the task.

This is the best effort attempt. Operation may not be cancelled anymore once it reaches certain stage. This method was added in vSphere API 6.7.1.

Exceptions:

vmware.vapi.std.errors.Error	if the system reports an error while responding to the request.
vmware.vapi.std.errors.NotAllowedInCurrentState	if the task is already canceled or completed.
vmware.vapi.std.errors.NotFound	if the task is not found.
vmware.vapi.std.errors.ResourceInaccessible	if the task's state cannot be accessed.
vmware.vapi.std.errors.ServiceUnavailable	if the system is unable to communicate with a service to complete the request.
vmware.vapi.std.errors.Unauthenticated	if the user can not be authenticated.
vmware.vapi.std.errors.Unauthorized	if the user doesn't have the required privileges.
vmware.vapi.std.errors.Unsupported	if the task is not cancelable.

Parameters:

task	Task identifier. The parameter must be an identifier for the resource type: com.vmware.cis.task .

Implements vmware::cis::Tasks.

void vmware::cis::TasksStub::Cancel	(	string	task,
		global::System.Action< vmware.vapi.std.Progress >	_progress,
		vmware.vapi.bindings.client.InvocationConfig	_invocationConfig
	)		[inline]

Cancel a running operation associated with the task.

This is the best effort attempt. Operation may not be cancelled anymore once it reaches certain stage. This method was added in vSphere API 6.7.1.

Exceptions:

vmware.vapi.std.errors.Error	if the system reports an error while responding to the request.
vmware.vapi.std.errors.NotAllowedInCurrentState	if the task is already canceled or completed.
vmware.vapi.std.errors.NotFound	if the task is not found.
vmware.vapi.std.errors.ResourceInaccessible	if the task's state cannot be accessed.
vmware.vapi.std.errors.ServiceUnavailable	if the system is unable to communicate with a service to complete the request.
vmware.vapi.std.errors.Unauthenticated	if the user can not be authenticated.
vmware.vapi.std.errors.Unauthorized	if the user doesn't have the required privileges.
vmware.vapi.std.errors.Unsupported	if the task is not cancelable.

Parameters:

task	Task identifier. The parameter must be an identifier for the resource type: com.vmware.cis.task .
_progress	Progress notification call back
_invocationConfig	Configuration for the method invocation

Implements vmware::cis::Tasks.

global::System.Threading.Tasks.Task vmware::cis::TasksStub::CancelAsync

(

string

task

)

[inline]

Cancel a running operation associated with the task.

This is the best effort attempt. Operation may not be cancelled anymore once it reaches certain stage. This method was added in vSphere API 6.7.1.

Exceptions:

vmware.vapi.std.errors.Error	if the system reports an error while responding to the request.
vmware.vapi.std.errors.NotAllowedInCurrentState	if the task is already canceled or completed.
vmware.vapi.std.errors.NotFound	if the task is not found.
vmware.vapi.std.errors.ResourceInaccessible	if the task's state cannot be accessed.
vmware.vapi.std.errors.ServiceUnavailable	if the system is unable to communicate with a service to complete the request.
vmware.vapi.std.errors.Unauthenticated	if the user can not be authenticated.
vmware.vapi.std.errors.Unauthorized	if the user doesn't have the required privileges.
vmware.vapi.std.errors.Unsupported	if the task is not cancelable.

Parameters:

task	Task identifier. The parameter must be an identifier for the resource type: com.vmware.cis.task .

Implements vmware::cis::Tasks.

global::System.Threading.Tasks.Task vmware::cis::TasksStub::CancelAsync	(	string	task,
		global::System.Action< vmware.vapi.std.Progress >	_progress,
		vmware.vapi.bindings.client.InvocationConfig	_invocationConfig
	)		[inline]

Cancel a running operation associated with the task.

This is the best effort attempt. Operation may not be cancelled anymore once it reaches certain stage. This method was added in vSphere API 6.7.1.

Exceptions:

vmware.vapi.std.errors.Error	if the system reports an error while responding to the request.
vmware.vapi.std.errors.NotAllowedInCurrentState	if the task is already canceled or completed.
vmware.vapi.std.errors.NotFound	if the task is not found.
vmware.vapi.std.errors.ResourceInaccessible	if the task's state cannot be accessed.
vmware.vapi.std.errors.ServiceUnavailable	if the system is unable to communicate with a service to complete the request.
vmware.vapi.std.errors.Unauthenticated	if the user can not be authenticated.
vmware.vapi.std.errors.Unauthorized	if the user doesn't have the required privileges.
vmware.vapi.std.errors.Unsupported	if the task is not cancelable.

Parameters:

task	Task identifier. The parameter must be an identifier for the resource type: com.vmware.cis.task .
_progress	Progress notification call back
_invocationConfig	Configuration for the method invocation

Implements vmware::cis::Tasks.

vmware.cis.task.Info vmware::cis::TasksStub::Get	(	string	task,
		vmware.cis.TasksTypes.GetSpec	spec,
		global::System.Action< vmware.vapi.std.Progress >	_progress,
		vmware.vapi.bindings.client.InvocationConfig	_invocationConfig
	)		[inline]

Returns information about a task.

This method was added in vSphere API 6.7.1.

Exceptions:

vmware.vapi.std.errors.Error	if the system reports an error while responding to the request.
vmware.vapi.std.errors.NotFound	if the task is not found.
vmware.vapi.std.errors.ResourceInaccessible	if the task's state cannot be accessed.
vmware.vapi.std.errors.ServiceUnavailable	if the system is unable to communicate with a service to complete the request.
vmware.vapi.std.errors.Unauthenticated	if the user can not be authenticated.
vmware.vapi.std.errors.Unauthorized	if the user doesn't have the required privileges.

Parameters:

task	Task identifier. The parameter must be an identifier for the resource type: com.vmware.cis.task .
spec	Specification on what to get for a task. If null, the behavior is equivalent to a Tasks.GetSpec with all fields null which means only the data described in task.Info will be returned and the result of the operation will be return.
_progress	Progress notification call back
_invocationConfig	Configuration for the method invocation

Returns:

Information about the specified task.

Implements vmware::cis::Tasks.

vmware.cis.task.Info vmware::cis::TasksStub::Get	(	string	task,
		vmware.cis.TasksTypes.GetSpec	spec
	)		[inline]

Returns information about a task.

This method was added in vSphere API 6.7.1.

Exceptions:

vmware.vapi.std.errors.Error	if the system reports an error while responding to the request.
vmware.vapi.std.errors.NotFound	if the task is not found.
vmware.vapi.std.errors.ResourceInaccessible	if the task's state cannot be accessed.
vmware.vapi.std.errors.ServiceUnavailable	if the system is unable to communicate with a service to complete the request.
vmware.vapi.std.errors.Unauthenticated	if the user can not be authenticated.
vmware.vapi.std.errors.Unauthorized	if the user doesn't have the required privileges.

Parameters:

task	Task identifier. The parameter must be an identifier for the resource type: com.vmware.cis.task .
spec	Specification on what to get for a task. If null, the behavior is equivalent to a Tasks.GetSpec with all fields null which means only the data described in task.Info will be returned and the result of the operation will be return.

Returns:

Information about the specified task.

Implements vmware::cis::Tasks.

global::System.Threading.Tasks.Task<vmware.cis.task.Info> vmware::cis::TasksStub::GetAsync	(	string	task,
		vmware.cis.TasksTypes.GetSpec	spec,
		global::System.Action< vmware.vapi.std.Progress >	_progress,
		vmware.vapi.bindings.client.InvocationConfig	_invocationConfig
	)		[inline]

Returns information about a task.

This method was added in vSphere API 6.7.1.

Exceptions:

vmware.vapi.std.errors.Error	if the system reports an error while responding to the request.
vmware.vapi.std.errors.NotFound	if the task is not found.
vmware.vapi.std.errors.ResourceInaccessible	if the task's state cannot be accessed.
vmware.vapi.std.errors.ServiceUnavailable	if the system is unable to communicate with a service to complete the request.
vmware.vapi.std.errors.Unauthenticated	if the user can not be authenticated.
vmware.vapi.std.errors.Unauthorized	if the user doesn't have the required privileges.

Parameters:

task	Task identifier. The parameter must be an identifier for the resource type: com.vmware.cis.task .
spec	Specification on what to get for a task. If null, the behavior is equivalent to a Tasks.GetSpec with all fields null which means only the data described in task.Info will be returned and the result of the operation will be return.
_progress	Progress notification call back
_invocationConfig	Configuration for the method invocation

Returns:

Information about the specified task.

Implements vmware::cis::Tasks.

global::System.Threading.Tasks.Task<vmware.cis.task.Info> vmware::cis::TasksStub::GetAsync	(	string	task,
		vmware.cis.TasksTypes.GetSpec	spec
	)		[inline]

Returns information about a task.

This method was added in vSphere API 6.7.1.

Exceptions:

vmware.vapi.std.errors.Error	if the system reports an error while responding to the request.
vmware.vapi.std.errors.NotFound	if the task is not found.
vmware.vapi.std.errors.ResourceInaccessible	if the task's state cannot be accessed.
vmware.vapi.std.errors.ServiceUnavailable	if the system is unable to communicate with a service to complete the request.
vmware.vapi.std.errors.Unauthenticated	if the user can not be authenticated.
vmware.vapi.std.errors.Unauthorized	if the user doesn't have the required privileges.

Parameters:

task	Task identifier. The parameter must be an identifier for the resource type: com.vmware.cis.task .
spec	Specification on what to get for a task. If null, the behavior is equivalent to a Tasks.GetSpec with all fields null which means only the data described in task.Info will be returned and the result of the operation will be return.

Returns:

Information about the specified task.

Implements vmware::cis::Tasks.

global::System.Collections.Generic.Dictionary<string, vmware.cis.task.Info> vmware::cis::TasksStub::List	(	vmware.cis.TasksTypes.FilterSpec	filterSpec,
		vmware.cis.TasksTypes.GetSpec	resultSpec,
		global::System.Action< vmware.vapi.std.Progress >	_progress,
		vmware.vapi.bindings.client.InvocationConfig	_invocationConfig
	)		[inline]

Returns information about at most 1000 visible (subject to permission checks) tasks matching the Tasks.FilterSpec .

All tasks must be in the same provider. This method was added in vSphere API 6.7.1.

Exceptions:

vmware.vapi.std.errors.InvalidArgument	if any of the specified parameters are invalid.
vmware.vapi.std.errors.ResourceInaccessible	if a task's state cannot be accessed or over 1000 tasks matching the Tasks.FilterSpec .
vmware.vapi.std.errors.ServiceUnavailable	if the system is unable to communicate with a service to complete the request.
vmware.vapi.std.errors.Unauthenticated	if the user can not be authenticated.
vmware.vapi.std.errors.Unauthorized	if the user doesn't have the required privileges.

Parameters:

filterSpec	Specification of matching tasks. This is currently required. In the future, if it is null, the behavior is equivalent to a Tasks.FilterSpec with all fields null which means all tasks match the filter.
resultSpec	Specification of what to return for a task. If null, the behavior is equivalent to a Tasks.GetSpec with all fields null which means only the data describe in task.Info will be returned and the result of the operation will be return.
_progress	Progress notification call back
_invocationConfig	Configuration for the method invocation

Returns:

Map of task identifier to information about the task. The key in the result map will be an identifier for the resource type: com.vmware.cis.task .

Implements vmware::cis::Tasks.

global::System.Collections.Generic.Dictionary<string, vmware.cis.task.Info> vmware::cis::TasksStub::List	(	vmware.cis.TasksTypes.FilterSpec	filterSpec,
		vmware.cis.TasksTypes.GetSpec	resultSpec
	)		[inline]

Returns information about at most 1000 visible (subject to permission checks) tasks matching the Tasks.FilterSpec .

All tasks must be in the same provider. This method was added in vSphere API 6.7.1.

Exceptions:

vmware.vapi.std.errors.InvalidArgument	if any of the specified parameters are invalid.
vmware.vapi.std.errors.ResourceInaccessible	if a task's state cannot be accessed or over 1000 tasks matching the Tasks.FilterSpec .
vmware.vapi.std.errors.ServiceUnavailable	if the system is unable to communicate with a service to complete the request.
vmware.vapi.std.errors.Unauthenticated	if the user can not be authenticated.
vmware.vapi.std.errors.Unauthorized	if the user doesn't have the required privileges.

Parameters:

filterSpec	Specification of matching tasks. This is currently required. In the future, if it is null, the behavior is equivalent to a Tasks.FilterSpec with all fields null which means all tasks match the filter.
resultSpec	Specification of what to return for a task. If null, the behavior is equivalent to a Tasks.GetSpec with all fields null which means only the data describe in task.Info will be returned and the result of the operation will be return.

Returns:

Map of task identifier to information about the task. The key in the result map will be an identifier for the resource type: com.vmware.cis.task .

Implements vmware::cis::Tasks.

global::System.Threading.Tasks.Task<global::System.Collections.Generic.Dictionary<string, vmware.cis.task.Info> > vmware::cis::TasksStub::ListAsync	(	vmware.cis.TasksTypes.FilterSpec	filterSpec,
		vmware.cis.TasksTypes.GetSpec	resultSpec,
		global::System.Action< vmware.vapi.std.Progress >	_progress,
		vmware.vapi.bindings.client.InvocationConfig	_invocationConfig
	)		[inline]

Returns information about at most 1000 visible (subject to permission checks) tasks matching the Tasks.FilterSpec .

All tasks must be in the same provider. This method was added in vSphere API 6.7.1.

Exceptions:

vmware.vapi.std.errors.InvalidArgument	if any of the specified parameters are invalid.
vmware.vapi.std.errors.ResourceInaccessible	if a task's state cannot be accessed or over 1000 tasks matching the Tasks.FilterSpec .
vmware.vapi.std.errors.ServiceUnavailable	if the system is unable to communicate with a service to complete the request.
vmware.vapi.std.errors.Unauthenticated	if the user can not be authenticated.
vmware.vapi.std.errors.Unauthorized	if the user doesn't have the required privileges.

Parameters:

filterSpec	Specification of matching tasks. This is currently required. In the future, if it is null, the behavior is equivalent to a Tasks.FilterSpec with all fields null which means all tasks match the filter.
resultSpec	Specification of what to return for a task. If null, the behavior is equivalent to a Tasks.GetSpec with all fields null which means only the data describe in task.Info will be returned and the result of the operation will be return.
_progress	Progress notification call back
_invocationConfig	Configuration for the method invocation

Returns:

Map of task identifier to information about the task. The key in the result map will be an identifier for the resource type: com.vmware.cis.task .

Implements vmware::cis::Tasks.

global::System.Threading.Tasks.Task<global::System.Collections.Generic.Dictionary<string, vmware.cis.task.Info> > vmware::cis::TasksStub::ListAsync	(	vmware.cis.TasksTypes.FilterSpec	filterSpec,
		vmware.cis.TasksTypes.GetSpec	resultSpec
	)		[inline]

Returns information about at most 1000 visible (subject to permission checks) tasks matching the Tasks.FilterSpec .

All tasks must be in the same provider. This method was added in vSphere API 6.7.1.

Exceptions:

vmware.vapi.std.errors.InvalidArgument	if any of the specified parameters are invalid.
vmware.vapi.std.errors.ResourceInaccessible	if a task's state cannot be accessed or over 1000 tasks matching the Tasks.FilterSpec .
vmware.vapi.std.errors.ServiceUnavailable	if the system is unable to communicate with a service to complete the request.
vmware.vapi.std.errors.Unauthenticated	if the user can not be authenticated.
vmware.vapi.std.errors.Unauthorized	if the user doesn't have the required privileges.

Parameters:

filterSpec	Specification of matching tasks. This is currently required. In the future, if it is null, the behavior is equivalent to a Tasks.FilterSpec with all fields null which means all tasks match the filter.
resultSpec	Specification of what to return for a task. If null, the behavior is equivalent to a Tasks.GetSpec with all fields null which means only the data describe in task.Info will be returned and the result of the operation will be return.

Returns:

Map of task identifier to information about the task. The key in the result map will be an identifier for the resource type: com.vmware.cis.task .

Implements vmware::cis::Tasks.

---

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

• TasksStub.cs