Skip to content
Processing Framework

CreateOperationParameters

@trimblecloudplatform/trimblecloud.processing

@trimblecloudplatform/trimblecloud.processing / CreateOperationParameters

Interface: CreateOperationParameters

Defined in: src/models/operations.ts:289

Parameters passed while creating an operation.

Properties

deprecationMessage?

optional deprecationMessage: string

Defined in: src/models/operations.ts:356

Optional string parameter.

description?

optional description: string

Defined in: src/models/operations.ts:309

The description of the Operation.

dynamicOutput?

optional dynamicOutput: boolean

Defined in: src/models/operations.ts:351

Indicates whether or not the Output content is considered dynamic or not.

engineName?

optional engineName: string

Defined in: src/models/operations.ts:314

The name of the backend engine that supports this Operation.

inputs?

optional inputs: Record<string, InputParam>

Defined in: src/models/operations.ts:341

Named inputs for the Operation.

name?

optional name: string

Defined in: src/models/operations.ts:304

The name of the Operation.

outputParameters?

optional outputParameters: Record<string, OutputParameter>

Defined in: src/models/operations.ts:336

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

outputs?

optional outputs: Record<string, OutputParam>

Defined in: src/models/operations.ts:346

Named outputs for the Operation.

parameters?

optional parameters: Record<string, Parameter>

Defined in: src/models/operations.ts:331

A list of parameter objects attached to the Operation.

public?

optional public: boolean

Defined in: src/models/operations.ts:299

The state of the Operation’s publication. If true, the Operation is available for public use.

regions?

optional regions: string[]

Defined in: src/models/operations.ts:294

Allowable locations that a particular Operation can run in.

retiredAfter?

optional retiredAfter: string

Defined in: src/models/operations.ts:361

Optional string parameter.

sharedWith?

optional sharedWith: string[]

Defined in: src/models/operations.ts:319

Deprecated

Use sharedWithIdentities instead. List of names of Users with whom this Operation has been shared.

sharedWithIdentities?

optional sharedWithIdentities: SharedWithIdentity[]

Defined in: src/models/operations.ts:326

List of identities with whom this Operation has been shared. Each entry contains an accountId and optionally a clientId. Sending an array replaces the existing list, not appends to it.