Skip to content

UpdateOperationParameters

@trimblecloudplatform/trimblecloud.processing


@trimblecloudplatform/trimblecloud.processing / UpdateOperationParameters

Interface: UpdateOperationParameters

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

Operation parameters that can updated.

Properties

deploymentIdentifier?

optional deploymentIdentifier: string

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

The identifier of the Deployment that supports this Operation.


deprecationMessage?

optional deprecationMessage: string

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

Optional string parameter.


description?

optional description: string

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

The description of the Operation.


dynamicOutput?

optional dynamicOutput: boolean

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

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


engineName?

optional engineName: string

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

The name of the backend engine that supports this Operation.


identifier?

optional identifier: string

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

Unique identifier string for the Operation.


inputs?

optional inputs: Record<string, InputParam>

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

Named inputs for the Operation.


name?

optional name: string

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

The name of the Operation.


outputParameters?

optional outputParameters: Record<string, OutputParameter>

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

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:439

Named outputs for the Operation.


parameters?

optional parameters: Record<string, Parameter>

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

A list of parameter objects attached to the Operation.


public?

optional public: boolean

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

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:387

Allowable locations that a particular Operation can run in.


retiredAfter?

optional retiredAfter: string

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

Optional string parameter.


sharedWith?

optional sharedWith: string[]

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

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:419

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.


version?

optional version: number

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

The version of the Operation.