Skip to content
Processing Framework

Execution

@trimblecloudplatform/trimblecloud.processing

@trimblecloudplatform/trimblecloud.processing / Execution

Class: Execution

Defined in: src/models/executions.ts:22

The Execution object.

Constructors

Constructor

new Execution(): Execution

Returns

Execution

Properties

boundParameters?

optional boundParameters: Record<string, BoundType>

Defined in: src/models/executions.ts:61

Mapping of Operation-specified output parameter names to output parameter values. This is where Operation output parameters are written once an Operation within the Execution completes.

completedAt?

optional completedAt: string

Defined in: src/models/executions.ts:91

Timestamp for Execution’s completion, if applicable.

createdAt?

optional createdAt: string

Defined in: src/models/executions.ts:76

Timestamp for the Execution’s creation.

dataExport?

optional dataExport: boolean

Defined in: src/models/executions.ts:31

Whether or not the execution’s data will be available for export. Default to false.

failedAt?

optional failedAt: string

Defined in: src/models/executions.ts:96

Timestamp for Execution’s failure, if applicable.

id?

optional id: string

Defined in: src/models/executions.ts:66

The unique identifier for the Execution, read-only and assigned at creation time. Used to perform actions on specific Execution through the API.

metadata?

optional metadata: string

Defined in: src/models/executions.ts:56

User-specified metadata to be associated with the Execution.

parameters?

optional parameters: Record<string, string | object>

Defined in: src/models/executions.ts:41

Mapping of Procedure-specified parameter names to parameter values.

procedureId?

optional procedureId: string

Defined in: src/models/executions.ts:26

The unique identifier of the target Procedure.

procedureIdentifier?

optional procedureIdentifier: string

Defined in: src/models/executions.ts:46

The identifier of the target Procedure for Execution.

procedureVersion?

optional procedureVersion: number

Defined in: src/models/executions.ts:51

The version of the target Procedure for Execution.

progress?

optional progress: Progress

Defined in: src/models/executions.ts:71

The execution_status of an Execution describes its processing status. Allowed: UNSUBMITTED┃SUBMITTED┃WAITING┃QUEUED┃EXECUTING┃FAILED┃FINISHED

region?

optional region: string

Defined in: src/models/executions.ts:36

Region name for the Execution to run in. Must be a name seen in the Procedure’s regions list. If not provided, then default_region of the Procedure is used.

submittedAt?

optional submittedAt: string

Defined in: src/models/executions.ts:86

Timestamp for Execution’s latest submission (start)

updatedAt?

optional updatedAt: string

Defined in: src/models/executions.ts:81

Timestamp for Execution’s latest update