Options
All
  • Public
  • Public/Protected
  • All
Menu

Task.

Hierarchy

  • Task

Index

Constructors

constructor

Accessors

companyId

companyId:

Get company id.

complete

complete:

Indicates whether the task is complete.

endTime

endTime:

Gets the end time of the task.

entityName

entityName:

Gets the tasks entity name

entityUuid

entityUuid:

Gets the UUID of the entity that is associated with the task.

initiatedFromIlandApi

initiatedFromIlandApi:

Indicates whether the task was initiated from the iland API.

initiationTime

initiationTime:

Gets the date/time that the task was received/queued by the API.

json

json:

Gets the raw JSON object from the API.

locationId

locationId:

Gets the datacenter location ID of the task.

message

message:

Gets the message associated with the task, if there is one. The message may provide extra information if the task ended with an error status.

operation

operation:

Gets the task's operation identifier.

operationDescription

operationDescription:

Returns an operation description that may provide more detail about the operation that the task is associated with.

orgUuid

orgUuid:

Returns the UUID of the organization that the task is associated with.

otherAttributes

otherAttributes:

Gets a map of additional task details that are specific to the task operation type.

parentTaskUuid

parentTaskUuid:

If this is a sub-task, returns the UUID of the parent task, otherwise null.

progress

progress:

Gets the task progress as a percentage.

startTime

startTime:

Gets the start time of the task, if the task has started. If the task is still queued, returns null.

status

status:

Indicates the status of the task.

subTasks

subTasks:

Gets the task's sub-tasks, if this is a composite task.

taskId

taskId:

If this task is a wrapper for a task from another service (vCloud director, Zerto, etc), this will return the ID of the task known to that service. Otherwise returns Uhe task UUID.

taskType

taskType:

Gets the task type.

userFullName

userFullName:

Gets the full name of the user that initiated the task.

username

username:

Gets the username of the user that initiated the task.

uuid

uuid:

Gets the UUID of the task.

Methods

cancelTask

  • cancelTask(): Promise<any>
  • Cancels a task. Only supported for active, top-level catalog upload tasks.

    Returns Promise<any>

getObservable

  • getObservable(): Observable<Task>
  • Gets an observable that is updated as the progress or status of the task changes.

    Returns Observable<Task>

    task observable

getPromise

  • getPromise(): Promise<Task>
  • Gets a promise that resolves or rejects when the task is complete. An error status will cause rejection.

    Returns Promise<Task>

    completion promise

refresh

  • refresh(): Promise<Task>
  • Retrieves a new representation of the task from the API.

    Returns Promise<Task>

    promise that resolves with updated task

toString

  • toString(): string

Static getTask

  • getTask(taskUuid: string): Promise<Task>
  • Gets a Task by UUID.

    Parameters

    • taskUuid: string

      the task uuid

    Returns Promise<Task>

    promise that resolves with the Task

Static getTasks

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method

Generated using TypeDoc