Child pages
  • Admin API Complex Type job

This documentation is for a previous version of Flexiant Cloud Orchestrator. The most recent version is v5.0. For the most recent documentation please see here

Skip to end of metadata
Go to start of metadata

Description
The Job class is a virtual resource representing a job
Derived By
Extending virtualResource
Content Model
Contains elements as defined in the following table.

Component

Type

Occurs

Description

billingEntityUUID

string

0..1

The UUID of the Billing Entity to which the resource belongs

resourceCreateDate

dateTime

0..1

The creation date of the resource

resourceKey

resourceKey

0..*

The keys attached to the resource

resourceMetadata

resourceMetadata

0..1

The metadata attached to the resource

resourceName

string

0..1

The name of the resource

resourceState

resourceState

0..1

The state of the resource

resourceType

resourceType

0..1

The type of the resource

resourceUUID

string

0..1

The UUID of the resource (read-only)

clusterName

string

0..1

The name of the cluster in which the resource is located

clusterUUID

string

0..1

The UUID of the cluster in which the resource is located

customerName

string

0..1

The name of the customer that owns the resource

customerUUID

string

0..1

The UUID of the customer that owns the resource

productOfferName

string

0..1

The name of the product offer associated with the resource

productOfferUUID

string

0..1

The UUID of the product offer associated with the resource

vdcName

string

0..1

The name of the VDC in which the resource is contained

vdcUUID

string

0..1

The UUID of the VDC in which the resource is contained

itemUUID

string

0..1

The UUID of the resource to which the job relates

status

jobStatus

0..1

The current status of the job

startTime

dateTime

0..1

The start time of the job

endTime

dateTime

0..1

The end time of the job

itemDescription

string

0..1

The description of the item

scheduled

boolean

1..1

Whether the job is scheduled to run at a future date

info

string

0..1

Information concerning the job

jobType

jobType

0..1

The type of the job

userUUID

string

0..1

The UUID of the user that created the job

itemName

string

0..1

The name of the job item

itemType

resourceType

0..1

The type of the job item

parentJobUUID

string

0..1

The UUID of the parent job

userName

string

0..1

The name of the user that created the job

errorCode

string

0..1

Holds the error code of the Error which was thrown while processing the job or null if the job was successful or has not yet completed

Remarks
A job is an action within the system. Any non-instantenous action will be represented as a job.

  • No labels