OperationInProcedure

@trimblecloudplatform/trimblecloud.processing

---

@trimblecloudplatform/trimblecloud.processing / OperationInProcedure

Interface: OperationInProcedure

Defined in: src/models/procedures.ts:106

Properties

description?

optional description: string

Defined in: src/models/procedures.ts:150

A description of an operation and its function.

---

encryptedParameters?

optional encryptedParameters: string[]

Defined in: src/models/procedures.ts:126

List of Operation parameters defined with encrypted?: true

---

engineName?

optional engineName: string

Defined in: src/models/procedures.ts:122

The name of the backend engine that supports this operation.

---

id?

optional id: string

Defined in: src/models/procedures.ts:114

The unique identifier for the Operation, read-only and assigned at creation time.

---

identifier

identifier: string

Defined in: src/models/procedures.ts:110

Unique identifier string for the operation.

---

inputs?

optional inputs: Record<string, OperationInputs>

Defined in: src/models/procedures.ts:134

Named inputs for the Operation.

---

name?

optional name: string

Defined in: src/models/procedures.ts:146

Human-readable name of the Operation.

---

outputParameters?

optional outputParameters: Record<string, OperationOutputParameters>

Defined in: src/models/procedures.ts:142

A list of parameter objects that define values to be output from an Operation.

---

outputs?

optional outputs: Record<string, OperationOutputs>

Defined in: src/models/procedures.ts:138

A Procedure Operation does not require Output Ports to be defined in the Procedure definition except for the case when a Switcher Operation is being utilized.

---

parameters?

optional parameters: Record<string, OperationParameters>

Defined in: src/models/procedures.ts:130

Parameters for the Operation. Each Operation can have 0 or more parameters.

---

version

version: number

Defined in: src/models/procedures.ts:118

The version of the Operation.