Skip to content
Processing Framework

TrimbleCloud.Processing

TrimbleCloud.Processing

Contents

ACRToken type

Namespace

TrimbleCloud.Processing.Model

Summary

ACR Token

LoginCommand property

Summary

ACR Token login command

PushCommand property

Summary

ACR Token push command

TagCommand property

Summary

ACR Token tag command

UploadStatus property

Summary

ACR Token upload status

APIBase type

Namespace

TrimbleCloud.Processing

Summary

Base class for API requests

GetRequestId(message) method

Summary

Extracts the request ID from the HTTP response headers

Returns

The request ID if present, otherwise an empty string

Parameters
NameTypeDescription
messageSystem.Net.Http.HttpResponseMessageThe HTTP response message

ThrowErrorAsync(response) method

Summary

Throws a TrimbleServiceException for HTTP error responses

Parameters
NameTypeDescription
responseSystem.Net.Http.HttpResponseMessageThe HTTP response message
Exceptions
NameDescription
TrimbleCloud.Processing.TrimbleServiceExceptionAlways thrown with error details (includes ArgumentNullException as inner exception if response is null)

Attempt type

Namespace

TrimbleCloud.Processing.Model

Summary

Latest attempt details for the execution

BoundParameters property

Summary

Mapping of Operation-specified output parameter names to output parameter values for this attempt.

CompletedAt property

Summary

The time the attempt completed

FailedAt property

Summary

The time the attempt failed

Status property

Summary

Attempt progress status

SubmittedAt property

Summary

The time the attempt was submitted

AutoScaling type

Namespace

TrimbleCloud.Processing.Model

Summary

Auto-scaling configuration

MaxCount property

Summary

Maximum count

MinCount property

Summary

Minimum count

Client type

Namespace

TrimbleCloud.Processing.Model

Summary

Client model

access_level property

name property

ClientsAPI type

Namespace

TrimbleCloud.Processing

Summary

API Methods relating to Trimble Cloud Platform Processing Framework executions

Read() method

Summary

Read the current client

Returns

A Task that resolves to the current client on completion

Parameters

This method has no parameters.

Exceptions
NameDescription
System.ExceptionThrown when the current client cannot be read

Compute type

Namespace

TrimbleCloud.Processing.Model

Summary

The configuration object to define the Engine-compute resources for memory and CPU allocation.

CPU property

Summary

The amount of CPU to assign to a single instance of an Engine.

GpuCount property

Summary

Optional GPU count for the Engine compute profile.

GpuType property

Summary

Optional GPU type for the Engine compute profile.

Interruptible property

Summary

Whether the compute should be scheduled as interruptible/preemptible.

Memory property

Summary

The amount of Memory to assign to a single instance of an Engine. The unit for this property is megabytes. For example, if an Engine requires 1GB of memory, then the `deployment.computing.memory` specification will be `1024`

Validate() method

Summary

Validate the compute parameters.

Parameters

This method has no parameters.

Constants type

Namespace

TrimbleCloud.Processing

Summary

Constants used by the Trimble Cloud Processing Framework

ContainerUpload type

Namespace

TrimbleCloud.Processing.Model

Summary

Container upload

AcrToken property

Summary

ACR Token

ContainerUploadStatus type

Namespace

TrimbleCloud.Processing.Model

Summary

Container upload status

AVAILABLE constants

Summary

Available

GENERATING constants

Summary

Generating

IMAGE_RECEIVED constants

Summary

Image received

UNAVAILABLE constants

Summary

Unavailable

UNKNOWN constants

Summary

Unknown status

DataType type

Namespace

TrimbleCloud.Processing.Model

Summary

Data type of the parameter

Array constants

Summary

A list of parameters of any type

Boolean constants

Summary

Boolean true/false (not surrounded by quotes)

Number constants

Summary

An integer or a float

Object constants

Summary

Any valid JSON object

SingleChoice constants

Summary

Value must match an item in the options field

String constants

Summary

String text surrounded by double quotes

Unknown constants

Summary

Unknown type

Wildcard constants

Summary

Wildcard type

Deployment type

Namespace

TrimbleCloud.Processing.Model

Summary

Deployment create model

AccountId property

Summary

The account ID of the Deployment owner

AutoScaling property

Summary

Auto scaling configuration

ClientId property

Summary

The client ID of the Deployment owner

Compute property

Summary

The configuration object to define the Engine-compute resources for memory and CPU allocation.

Description property

Summary

The description of the deployment.

EngineId property

Summary

The Engine Identifier to use for this deployment.

Identifier property

Summary

A Deployment Identifier is unique within the system.

Name property

Summary

The name of the deployment.

Operations property

Summary

Optional projection of operations for specialized responses

Owner property

Summary

The owner of the Deployment

Regions property

Summary

region to deploy the deployment

Secrets property

Summary

Optional projection of secrets for specialized responses

Status property

Summary

Deployment status

Trn property

Summary

TRN value of the Deployment

DeploymentCreate type

Namespace

TrimbleCloud.Processing.Model

Summary

Deployment create model

AutoScaling property

Summary

Auto scaling configuration

Compute property

Summary

The configuration object to define the Engine-compute resources for memory and CPU allocation.

Description property

Summary

The description of the deployment.

EngineId property

Summary

The Engine Identifier to use for this deployment.

Identifier property

Summary

A Deployment Identifier is unique within the system.

Name property

Summary

The name of the deployment.

Regions property

Summary

The region this Deployment can run in

Validate() method

Summary

Validate the deployment creation parameters.

Parameters

This method has no parameters.

DeploymentListFilter type

Namespace

TrimbleCloud.Processing.Model

Summary

Deployment List Filters

AccountId property

Summary

Filters resources by the Owner’s TID account identifier.

ActiveEngine property

Summary

The active engine of a deployment

ClientId property

Summary

Filters resources by the Owner’s TID subject identifier (client ID).

Owner property

Summary

Filters a resource based on owner

Status property

Summary

Filters a resource based on status.

DeploymentSecret type

Namespace

TrimbleCloud.Processing.Model

Summary

Represents the Deployment Secret.

AccountId property

Summary

The account ID of the Deployment secret owner

ClientId property

Summary

The client ID of the Deployment secret owner

Description property

Summary

Deployment Secret description

Identifier property

Summary

The expected identifier of a Deployment Secret.

Name property

Summary

The name of the Deployment Secret.

Owner property

Summary

The owner of the Deployment secret

Regions property

Summary

The regions where the Deployment Secret is available.

Status property

Summary

Deployment status

Trn property

Summary

TRN value of the deployment secret

Value property

Summary

The value of the Deployment Secret.

DeploymentSecretCreate type

Namespace

TrimbleCloud.Processing.Model

Summary

Represents a deployment secret creation.

Description property

Summary

Deployment Secret description

Identifier property

Summary

The expected identifier of a Deployment Secret.

Name property

Summary

The name of the Deployment Secret.

Value property

Summary

The value of the Deployment Secret.

Validate() method

Summary

Validate the deployment secret creation parameters.

Parameters

This method has no parameters.

DeploymentSecretUpdate type

Namespace

TrimbleCloud.Processing.Model

Summary

Represents the updation parameters for the deployment secret.

Description property

Summary

Deployment Secret description

Name property

Summary

The name of the Deployment Secret.

Value property

Summary

The value of the Deployment Secret.

Validate() method

Summary

Validate the deployment creation parameters.

Parameters

This method has no parameters.

Exceptions
NameDescription
System.ArgumentException

DeploymentSecretsAPI type

Namespace

TrimbleCloud.Processing

Summary

Deployment Secrets API Resource

Create(deploymentId,deploymentSecretCreate) method

Summary

Create a deployment secret

Returns

A Task that resolves to the created deployment secret on completion

Parameters
NameTypeDescription
deploymentIdSystem.StringThe id of the deployment
deploymentSecretCreateTrimbleCloud.Processing.Model.DeploymentSecretCreateThe value of the deployment secret to create
Exceptions
NameDescription
System.ExceptionThrown when a deployment secret cannot be created
TrimbleCloud.Processing.ValidationExceptionThrown when the deployment secret is invalid

Delete(deploymentId,deploymentSecretId) method

Summary

Delete a deployment secret

Returns

An awaitiable Task

Parameters
NameTypeDescription
deploymentIdSystem.StringThe id of the deployment
deploymentSecretIdSystem.StringThe identifier of the deployment secret to delete
Exceptions
NameDescription
System.ExceptionThrown when deployment secret cannot be deleted

Get(deploymentId,deploymentSecretId) method

Summary

Get deployment secret by id

Returns

A Task that resolves to the requested deployment secret on completion

Parameters
NameTypeDescription
deploymentIdSystem.StringThe id of the deployment
deploymentSecretIdSystem.StringThe identifier of the deployment secret to read
Exceptions
NameDescription
System.ExceptionThrown when deployment secret cannot be read

GetList(deploymentId) method

Summary

Get a list of deployment secret

Returns

An asynchronous list of deployment secrets for the deployment

Parameters
NameTypeDescription
deploymentIdSystem.StringThe id of the deployment

List(deploymentId,page,pageSize,filters) method

Summary

Get a list of deployment secrets

Returns

An asynchronous list of deployment secrets for the deployment

Parameters
NameTypeDescription
deploymentIdSystem.StringThe id of the deployment
pageSystem.Int32The page number
pageSizeSystem.Int32The number of items per page
filtersTrimbleCloud.Processing.Model.DeploymentSecretsListFilterOptional filters to apply to the list

Retire(deploymentId,deploymentSecretId) method

Summary

Retire a deployment secret

Returns

A Task that resolves to the retired deployment secret on completion

Parameters
NameTypeDescription
deploymentIdSystem.StringThe id of the deployment
deploymentSecretIdSystem.StringThe identifier of the deployment secret to retire
Exceptions
NameDescription
System.ExceptionThrown when deployment secret cannot be retired

Update(deploymentId,deploymentSecretId,deploymentSecretUpdate) method

Summary

Update a deployment secret

Returns

A Task that resolves to the updated deployment secret on completion

Parameters
NameTypeDescription
deploymentIdSystem.StringThe id of the deployment
deploymentSecretIdSystem.StringThe identifier of the deployment secret to update
deploymentSecretUpdateTrimbleCloud.Processing.Model.DeploymentSecretUpdateThe value of the deployment secret to update
Exceptions
NameDescription
System.ExceptionThrown when deployment secret cannot be updated

DeploymentSecretsListFilter type

Namespace

TrimbleCloud.Processing.Model

Summary

Deployment Secrets List Filters

AccountId property

Summary

Filters resources by the Owner’s TID account identifier.

ClientId property

Summary

Filters resources by the Owner’s TID subject identifier (client ID).

Owner property

Summary

Filters resources by the Owner’s internal name. This is a legacy parameter; prefer using ClientId or AccountId instead.

DeploymentStatus type

Namespace

TrimbleCloud.Processing.Model

Summary

Deployment status

AVAILABLE constants

Summary

available

DELETING constants

Summary

Deleting

FAILED constants

Summary

failed

PREPARING constants

Summary

Preparing

RETIRED constants

Summary

retired

RETIRING constants

Summary

being retired

SUBMITTED constants

Summary

submitted

UNKNOWN constants

Summary

Unknown status

UPDATING constants

Summary

Updating

DeploymentUpdate type

Namespace

TrimbleCloud.Processing.Model

Summary

Represents the updation parameters for the deployment.

AutoScaling property

Summary

Auto scaling configuration

Compute property

Summary

The configuration object to define the Engine-compute resources for memory and CPU allocation.

Description property

Summary

Deployment description

EngineId property

Summary

The Engine ID that is connected to this Deployment.

Name property

Summary

The name of the Deployment. Max 64 chars

Regions property

Summary

The region this Deployment can run in

Validate() method

Summary

Validate the deployment updation parameters.

Parameters

This method has no parameters.

Exceptions
NameDescription
System.ArgumentException

DeploymentsAPI type

Namespace

TrimbleCloud.Processing

Summary

Deployments API Resource

Create(deploymentCreate) method

Summary

Create a deployment

Returns

A Task that resolves to the created deployment on completion

Parameters
NameTypeDescription
deploymentCreateTrimbleCloud.Processing.Model.DeploymentCreateThe value of the deployment to create
Exceptions
NameDescription
System.ExceptionThrown when an deployment cannot be created
TrimbleCloud.Processing.ValidationExceptionThrown when the deployment creation parameters are invalid

Delete(id) method

Summary

Delete a deployment

Returns

True if deletion succeeded

Parameters
NameTypeDescription
idSystem.StringThe identifier of the deployment to delete
Exceptions
NameDescription
System.ExceptionThrown when a deployment cannot be deleted

Get(id) method

Summary

Get deployment by id

Returns

A Task that resolves to the requested deployment on completion

Parameters
NameTypeDescription
idSystem.StringThe identifier of the deployment to read
Exceptions
NameDescription
System.ExceptionThrown when the deployment cannot be read

GetList(engineId) method

Summary

Get a list of deployments

Returns

An asynchronous list of deployments

Parameters
NameTypeDescription
engineIdSystem.StringThe id of the engine

List(page,pageSize,filters) method

Summary

Get a list of deployments

Returns

An asynchronous list of deployments

Parameters
NameTypeDescription
pageSystem.Int32The page number
pageSizeSystem.Int32The number of items per page
filtersTrimbleCloud.Processing.Model.DeploymentListFilterThe filters to apply

Retire(id) method

Summary

Retire a Deployment

Returns

A Task that resolves to the retired deployment on completion

Parameters
NameTypeDescription
idSystem.StringThe identifier of the deployment to retire
Exceptions
NameDescription
System.ExceptionThrown when a deployment cannot be retired

Update(id,deploymentUpdate) method

Summary

Update a deployment

Returns

A Task that resolves to the updated deployment on completion

Parameters
NameTypeDescription
idSystem.StringThe identifier of the deployment to update
deploymentUpdateTrimbleCloud.Processing.Model.DeploymentUpdateThe value of the deployment to update
Exceptions
NameDescription
System.ExceptionThrown when the deployment cannot be updated

Engine type

Namespace

TrimbleCloud.Processing.Model

Summary

Represents the creation parameters for an engine.

AccountId property

Summary

The account ID of the Engine owner

ClientId property

Summary

The client ID of the Engine owner

ContainerUpload property

Summary

Container upload

Description property

Summary

Engine description

EnvironmentVariables property

Summary

Environment variables that are stored and ingested into the Engine’s container

Identifier property

Summary

Engine identifier, unique within the system

IngestionType property

Summary

Engine ingestion type. Currently the only option is a temporary ACR token upload

Name property

Summary

The name of the Engine. Max 64 chars

OSBuild property

Summary

Engine OS build. Specify which OS build to use. This is a required parameter for Windows Engines only. At this time, the Engines API directly supports Windows Server 2019 (10.0.17763), and can optionally support Windows Server 2022 (10.0.20348). If the latter is needed, please contact the team for assistance. Windows Server 2019 Windows Server 2022

OSType property

Summary

Engine OS type

Owner property

Summary

The owner of the Engine

Regions property

Summary

Engine region

SecretFiles property

Summary

Secret files

SecretVariables property

Summary

Secret variables

Status property

Summary

Engine status

StatusMessage property

Summary

Engine status message

Tag property

Summary

Engine tag

Trn property

Summary

TRN value of the Engine

EngineCreate type

Namespace

TrimbleCloud.Processing.Model

Summary

Represents the creation parameters for an engine.

Description property

Summary

Engine description

EnvironmentVariables property

Summary

Environment variables that are stored and ingested into the Engine’s container

Identifier property

Summary

Engine identifier, unique within the system

IngestionType property

Summary

Engine ingestion type. Currently the only option is a temporary ACR token upload

Name property

Summary

The name of the Engine. Max 64 chars

OSBuild property

Summary

Engine OS build. Specify which OS build to use. This is a required parameter for Windows Engines only. At this time, the Engines API directly supports Windows Server 2019 (10.0.17763), and can optionally support Windows Server 2022 (10.0.20348). If the latter is needed, please contact the team for assistance. Windows Server 2019 Windows Server 2022

OSType property

Summary

Engine OS type

Regions property

Summary

Engine region

SecretFiles property

Summary

Secret files

SecretVariables property

Summary

Secret variables

Tag property

Summary

Engine tag

Validate() method

Summary

Validate the engine creation parameters.

Parameters

This method has no parameters.

Exceptions
NameDescription
System.ArgumentException

EngineListFilter type

Namespace

TrimbleCloud.Processing.Model

Summary

Create Engine List Filters

AccountId property

Summary

Filters resources by the Owner’s TID account identifier.

ClientId property

Summary

Filters resources by the Owner’s TID subject identifier (client ID).

OSType property

Summary

Filters a resource based on the Operating System name.

Owner property

Summary

Filters a resource based on the owner name.

Status property

Summary

Filters a resource based on execution status.

EngineStatus type

Namespace

TrimbleCloud.Processing.Model

Summary

Engine status

AVAILABLE constants

Summary

Engine is available

AWAITING_IMAGE_UPLOAD constants

Summary

Awaiting image upload

FAILED constants

Summary

Engine is failed

GENERATING_TOKEN constants

Summary

Generating token

PREPARING constants

Summary

Image uploaded

RETIRED constants

Summary

Engine is retired

RETIRING constants

Summary

Engine is being retired

SUBMITTED constants

Summary

Engine is submitted

UNKNOWN constants

Summary

Unknown status

EngineUpdate type

Namespace

TrimbleCloud.Processing.Model

Summary

Represents the updation parameters for an engine.

Description property

Summary

Engine description

Name property

Summary

The name of the Engine. Max 64 chars

Validate() method

Summary

Validate the engine creation parameters.

Parameters

This method has no parameters.

Exceptions
NameDescription
TrimbleCloud.Processing.ValidationException

EnginesAPI type

Namespace

TrimbleCloud.Processing

Summary

Engines API Resource

Create(engineCreate) method

Summary

Create an engine

Returns

A Task that resolves to the created engine on completion

Parameters
NameTypeDescription
engineCreateTrimbleCloud.Processing.Model.EngineCreateThe value of the engine to create
Exceptions
NameDescription
System.ExceptionThrown when an engine cannot be created
TrimbleCloud.Processing.ValidationExceptionThrown when the engine update is invalid

Delete(id) method

Summary

Delete an engine

Returns

An awaitiable Task

Parameters
NameTypeDescription
idSystem.StringThe identifier of the engine to delete
Exceptions
NameDescription
System.ExceptionThrown when engine cannot be deleted

Get(id) method

Summary

Get an engine by id

Returns

A Task that resolves to the requested engine on completion

Parameters
NameTypeDescription
idSystem.StringThe identifier of the engine to read
Exceptions
NameDescription
System.ExceptionThrown when an engine cannot be read

GetList() method

Summary

Get a list of engines

Returns

An asynchronous list of engines

Parameters

This method has no parameters.

List(page,pageSize,filters) method

Summary

Get a list of engines

Returns

An asynchronous list of engines

Parameters
NameTypeDescription
pageSystem.Int32The page number
pageSizeSystem.Int32The number of items per page
filtersTrimbleCloud.Processing.Model.EngineListFilterThe filters to apply

Retire(id) method

Summary

Retire an engine

Returns

A Task that resolves to the retired engine on completion

Parameters
NameTypeDescription
idSystem.StringThe identifier of the engine to retire
Exceptions
NameDescription
System.ExceptionThrown when an engine cannot be retired

Update(id,engineUpdate) method

Summary

Update an engine

Returns

A Task that resolves to the updated engine on completion

Parameters
NameTypeDescription
idSystem.StringThe identifier of the engine to update
engineUpdateTrimbleCloud.Processing.Model.EngineUpdateThe value of the engine to update
Exceptions
NameDescription
System.ExceptionThrown when an engine cannot be updated
TrimbleCloud.Processing.ValidationExceptionThrown when the engine update is invalid

EnumConverter`1 type

Namespace

TrimbleCloud.Processing

Summary

Generic converter for enums

ReadJson() method

Summary

Read an enum value from a JSON string

Parameters

This method has no parameters.

EnumHelper`1 type

Namespace

TrimbleCloud.Processing.Helper

Summary

Helper class for Enum

GetEnumMemberValue() method

Summary

Get the EnumMember value of an Enum

Parameters

This method has no parameters.

EnvironmentVariable type

Namespace

TrimbleCloud.Processing.Model

Summary

Represents the environment variables.

Name property

Summary

The name of the environment variable.

Value property

Summary

The value of the environment variable.

Validate() method

Summary

Validate the environment variables.

Parameters

This method has no parameters.

Execution type

Namespace

TrimbleCloud.Processing.Model

Summary

Execution model

BoundParameters property

Summary

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 property

Summary

The time the execution is completed

DataExport property

Summary

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

ExecutionScheduleId property

Summary

ID of the execution schedule that created this execution.

ExecutionStatus property

Summary

The logical execution status (READY/NOT_READY/etc.)

FailedAt property

Summary

The time the execution is failed

LatestAttempt property

Summary

The latest execution attempt summary

Metadata property

Summary

The metadata of the execution.

Parameters property

Summary

Mapping of Procedure-specified parameter names to parameter values.

Procedure property

Summary

The underlying Procedure definition. Only included in the Execution response when the details parameter is set to true. This parameter is restricted to BACKEND access level only. Default is false.

ProcedureId property

Summary

ID of the procedure to execute.

ProcedureIdentifier property

Summary

The identifier of the Procedure that supports this Operation.

ProcedureVersion property

Summary

The version of the Procedure that supports this Operation.

Region property

Summary

region where the execution will be run.

Status property

Summary

Execution status

SubmittedAt property

Summary

The time the execution was submitted

ExecutionActivity type

Namespace

TrimbleCloud.Processing.Model

Summary

Execution Activity response class model

ActivityId property

Summary

Activity Id

HistoricalInfo property

Summary

Historical Information about the activity

ExecutionCreate type

Namespace

TrimbleCloud.Processing.Model

Summary

ExecutionCreate

BoundParameters property

Summary

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.

DataExport property

Summary

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

Metadata property

Summary

The metadata of the execution.

Parameters property

Summary

Mapping of Procedure-specified parameter names to parameter values.

ProcedureId property

Summary

ID of the procedure to execute.

ProcedureIdentifier property

Summary

The identifier of the Procedure that supports this Operation.

ProcedureVersion property

Summary

The version of the Procedure that supports this Operation.

Region property

Summary

region where the execution will be run.

ToJson() method

Summary

Converts the object to a JSON string

Parameters

This method has no parameters.

Validate() method

Summary

Validate the creation of an execution

Parameters

This method has no parameters.

ExecutionEngineRequest type

Namespace

TrimbleCloud.Processing.Model

Summary

Request payload for posting engine data/logs for an execution.

ExecutionId property

Summary

The execution identifier.

OutputPath property

Summary

Output path provided by the engine.

Validate() method

Summary

Validate the request payload.

Parameters

This method has no parameters.

ExecutionEvent type

Namespace

TrimbleCloud.Processing.Model

Summary

Execution Event response class model

Contents property

Summary

The type of Execution Event that is being described. It can be either object or string.

CreatedAt property

Summary

Created At

Type property

Summary

The type of Execution Event that is being described.

UpdatedAt property

Summary

Updated At

ExecutionListFilter type

Namespace

TrimbleCloud.Processing.Model

Summary

Execution List Filters

CompletedAfter property

Summary

Filter results that have a completed_at time that is after the supplied value.

CompletedBefore property

Summary

Filter results that have a completed_at time that is before the supplied value.

CreatedAfter property

Summary

Filter results that have a created_at time that is after the supplied value.

CreatedBefore property

Summary

Filter results that have a created_at time that is before the supplied value.

ExecutionStatus property

Summary

Filters a resource based on execution status.

ProcedureId property

Summary

Filters a resource based on the procedure identifier.

SortBy property

Summary

Sort by field

ExecutionProgressStatus type

Namespace

TrimbleCloud.Processing.Model.Execution

Summary

Execution status enumeration

EXECUTING constants

Summary

Execution is currently being executed

FAILED constants

Summary

Execution has failed

FINISHED constants

Summary

Execution has been completed

QUEUED constants

Summary

Execution is queued

SUBMITTED constants

Summary

Execution has been submitted and is waiting to be processed

UNKNOWN constants

Summary

Unknown status

UNSUBMITTED constants

Summary

Execution has not been submitted yet

WAITING constants

Summary

Execution is currently being waited

ExecutionSortBy type

Namespace

TrimbleCloud.Processing.Model

Summary

Sort options for execution list

CompletedAtAscending constants

Summary

Sort by completed_at in ascending order

CompletedAtDescending constants

Summary

Sort by completed_at in descending order

CreatedAtAscending constants

Summary

Sort by created_at in ascending order

CreatedAtDescending constants

Summary

Sort by created_at in descending order

ExecutionStatus type

Namespace

TrimbleCloud.Processing.Model

Summary

The execution status of the operation.

NOT_READY constants

Summary

This Operation cannot be used to create any Procedures and thus cannot be part of an execution.

READY constants

Summary

This Operation can now by used to create Procedures and thus be part of executions.

SUSPENDED constants

Summary

The processing of this Operation has been suspended and cannot be part of executions.

UNKNOWN constants

Summary

Unknown status

ExecutionsAPI type

Namespace

TrimbleCloud.Processing

Summary

API Methods relating to Trimble Cloud Platform Processing Framework executions

Create(executionCreate) method

Summary

Create an execution

Returns

A Task that resolves to the created execution on completion

Parameters
NameTypeDescription
executionCreateTrimbleCloud.Processing.Model.ExecutionCreateThe value of the execution to create
Exceptions
NameDescription
System.ExceptionThrown when an execution cannot be created

Get(id,details) method

Summary

Get an execution by id

Returns

A Task that resolves to the requested execution on completion

Parameters
NameTypeDescription
idSystem.StringThe identifier of the execution to read
detailsSystem.Nullable{System.Boolean}Optional flag to request detailed view
Exceptions
NameDescription
System.ExceptionThrown when an execution cannot be read

GetExecutionData(engineDataRequest) method

Summary

Post engine data for executions

Returns

A Task that resolves to the execution response on completion

Parameters
NameTypeDescription
engineDataRequestTrimbleCloud.Processing.Model.ExecutionEngineRequestEngine data request payload

GetExecutionLogs(engineLogsRequest) method

Summary

Post engine logs for executions

Returns

A Task that resolves to the execution response on completion

Parameters
NameTypeDescription
engineLogsRequestTrimbleCloud.Processing.Model.ExecutionEngineRequestEngine logs request payload

List(page,pageSize,filters) method

Summary

Get a list of executions

Returns

An asynchronous list of executions

Parameters
NameTypeDescription
pageSystem.Int32The page number to retrieve
pageSizeSystem.Int32The number of items per page
filtersTrimbleCloud.Processing.Model.ExecutionListFilterThe filters to apply to the list

ListActivities(executionId,page,pageSize) method

Summary

Get a list of execution activities

Returns

An asynchronous list of execution activities

Parameters
NameTypeDescription
executionIdSystem.StringThe identifier of the execution to retrieve activities for
pageSystem.Int32The page number to retrieve
pageSizeSystem.Int32The number of items per page

ListEvents(executionId,page,pageSize) method

Summary

Get the events tied to an Execution. Events are logged by the Log Events for an Execution request.

Returns

An asynchronous list of execution events

Parameters
NameTypeDescription
executionIdSystem.StringThe identifier of the execution to retrieve activities for
pageSystem.Int32The page number to retrieve
pageSizeSystem.Int32The number of items per page

HistoricalInfo type

Namespace

TrimbleCloud.Processing.Model

Summary

Historical Info class

ActivityTaskCompleted property

Summary

Activity Task Completed

ActivityTaskScheduled property

Summary

Activity Task Scheduled

ActivityTaskStarted property

Summary

Activity Task Started

HttpClientResponse type

Namespace

TrimbleCloud.Processing

Summary

HTTP client response implementation for the common Response class

#ctor(requestId,responseMessage) constructor

Summary

Initializes a new instance of the HttpClientResponse class

Parameters
NameTypeDescription
requestIdSystem.StringThe request ID
responseMessageSystem.Net.Http.HttpResponseMessageThe HTTP response message

ContentLength property

Summary

Gets the content length of the response

IsError property

Summary

Gets a value indicating whether this response represents an error

Metadata property

Summary

Gets the response headers as metadata

ReasonPhrase property

Summary

Gets the HTTP reason phrase

RequestId property

Summary

Gets or sets the request ID

Status property

Summary

Gets the HTTP status code

Dispose() method

Summary

Disposes the underlying HTTP response message

Parameters

This method has no parameters.

ToString() method

Summary

Returns the string representation of the HTTP response

Returns

String representation of the response

Parameters

This method has no parameters.

IPage`1 type

Namespace

TrimbleCloud.Processing

Summary

Defines a page interface

Generic Types
NameDescription
TThe type of item in the page.

CurrentPage property

Summary

The number of items in the page.

Items property

Summary

The items in the page.

PageSize property

Summary

The number of items per page.

TotalItems property

Summary

The total number of items available.

TotalPages property

Summary

The total number of pages available.

IngestionType type

Namespace

TrimbleCloud.Processing.Model

Summary

Ingestion type

ACRToken constants

Summary

A unique and temporary ACR token will be generated on your behalf so that you may upload a container image into our system. The API will provide a set of commands in the ‘container_upload’ object that will allow you login and upload your container image.

Unknown constants

Summary

Unknown status

Input type

Namespace

TrimbleCloud.Processing.Model

Summary

Input parameters for an operation

DataTypes property

Summary

List of accepted input data types.

Description property

Summary

Description of the input

Name property

Summary

Name of the input

Optional property

Summary

Is the parameter optional. Defaults to false

Validate() method

Summary

Validate the inputs

Parameters

This method has no parameters.

ListFilterBase type

Namespace

TrimbleCloud.Processing.Model

Summary

List Filter Base

Identifier property

Summary

Identifier of the resource

Region property

Summary

Region

OSType type

Namespace

TrimbleCloud.Processing.Model

Summary

OS Type

Linux constants

Summary

Create a linux Engine.

Unknown constants

Summary

Unknown status

Windows constants

Summary

Create a windows Engine.

OpInput type

Namespace

TrimbleCloud.Processing.Model

Summary

Operation input class

OpInput type

Namespace

TrimbleCloud.Processing.Model.Procedure.OperationChain

Summary

Operation input class

DataTypes property

Sources property

DataTypes property

Sources property

OpOutput type

Namespace

TrimbleCloud.Processing.Model

Summary

Operation output class

OpOutput type

Namespace

TrimbleCloud.Processing.Model.Procedure.OperationChain

Summary

Operation output class

DataType property

Description property

Name property

DataType property

Description property

Name property

OpParamater type

Namespace

TrimbleCloud.Processing.Model.Procedure.OperationChain

Summary

Operation parameter class

Optional property

Summary

Is the parameter optional. Defaults to false

Source property

Summary

The source of the Operation parameter

OpParameter type

Namespace

TrimbleCloud.Processing.Model

Summary

Operation parameter class

Optional property

Summary

Is the parameter optional. Defaults to false

Source property

Summary

The source of the Operation parameter

Operation type

Namespace

TrimbleCloud.Processing.Model

Summary

Operation model

AccountId property

Summary

The account ID of the Operation owner

ClientId property

Summary

The client ID of the Operation owner

DeploymentIdentifier property

Summary

The identifier of the Deployment that supports this Operation.

DeprecationMessage property

Summary

Message given to indicate impending retirement/deprecation

Description property

Summary

The description of the operation.

DynamicOutput property

Summary

Indicates whether or not the Output content is considered dynamic or not. In all cases except for the Switcher Operation, this will be false

EngineName property

Summary

The name of the backend engine that supports this Operation. (Deprecated: Use DeploymentIdentifier instead.)

ExecutionStatus property

Summary

The execution status of the operation.

Identifier property

Summary

The identifier of the operation.

Inputs property

Summary

Named inputs for the Operation. This is an object containing one or more inputs that describe the data types which will be accepted as input to the Operation.

IsPublic property

Summary

The state of the Operation’s publication. If true, the Operation is available for public use. This is not unlike sharing it with every other User in the system. If this field is false, then it follows the normal rules with regard to sharing and individual ownership.

Name property

Summary

The name of the operation.

OutputParameters property

Summary

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

Outputs property

Summary

Named outputs for the Operation. This is an object containing one or more outputs that emit data. Each such output specifies a single output data type.

Owner property

Summary

The owner of the Operation

Parameters property

Summary

A list of parameter objects attached to the Operation.

Regions property

Summary

Allowable locations that a particular Operation can run in.

RetriedAfter property

Summary

Timestamp indicating when this Operation will move to RETIRED status, and will no longer be executable

SharedWith property

Summary

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

SharedWithEntries property

Summary

List of identities with whom this Operation has been shared. Each entry contains an account_id (required) and optionally a client_id.

Status property

Summary

The status of the operation.

Version property

Summary

The version of the operation.

OperationChain type

Namespace

TrimbleCloud.Processing.Model

Summary

OperationChain class

OperationChain type

Namespace

TrimbleCloud.Processing.Model.Procedure

Summary

OperationChain class

Description property

Summary

The description of the operation.

EngineName property

Summary

name of the Engine

Identifier property

Summary

The identifier of the operation.

Inputs property

Name property

Summary

The name of the operation.

OutputParameters property

Summary

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

Parameters property

Version property

Summary

The version of the operation.

Description property

Summary

The description of the operation.

EncryptedParameters property

Summary

List of encrypted parameters

EngineName property

Summary

name of the Engine

Identifier property

Summary

The identifier of the operation.

Inputs property

Name property

Summary

The name of the operation.

OutputParameters property

Summary

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

Outputs property

Parameters property

Version property

Summary

The version of the operation.

Validate() method

Summary

Validate the Operation object.

Parameters

This method has no parameters.

Exceptions
NameDescription
TrimbleCloud.Processing.ValidationException

OperationCreate type

Namespace

TrimbleCloud.Processing.Model

Summary

Represents OperationCreate.

DeploymentIdentifier property

Summary

The identifier of the Deployment that supports this Operation.

Description property

Summary

The description of the operation.

DynamicOutput property

Summary

Indicates whether or not the Output content is considered dynamic or not. In all cases except for the Switcher Operation, this will be false

EngineName property

Summary

The name of the backend engine that supports this Operation. (Deprecated: Use DeploymentIdentifier instead.)

Identifier property

Summary

The identifier of the operation.

Inputs property

Summary

Named inputs for the Operation. This is an object containing one or more inputs that describe the data types which will be accepted as input to the Operation.

IsPublic property

Summary

The state of the Operation’s publication. (Deprecated: Use Publish method to make an Operation public.)

Name property

Summary

The name of the operation.

OutputParameters property

Summary

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

Outputs property

Summary

Named outputs for the Operation. This is an object containing one or more outputs that emit data. Each such output specifies a single output data type.

Parameters property

Summary

A list of parameter objects attached to the Operation.

Regions property

Summary

Allowable locations that a particular Operation can run in.

SharedWith property

Summary

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

SharedWithEntries property

Summary

List of identities with whom this Operation has been shared. Each entry contains an account_id (required) and optionally a client_id. An entry with only account_id grants access to all clients in that account. An entry with both client_id and account_id grants access to that specific client only. Sending an array replaces the existing list, not append to it.

Version property

Summary

The version of the operation.

Validate() method

Summary

Validate the operation creation parameters.

Parameters

This method has no parameters.

OperationListFilter type

Namespace

TrimbleCloud.Processing.Model

Summary

Operation List Filters

DeploymentIdentifier property

Summary

Filters a resource based on the Deployment identifier.

EngineName property

Summary

Filters a resource based on the Engine name.

ExecutionStatus property

Summary

Filters a resource based on execution status.

ProcedureId property

Summary

Filters a resource based on the Procedure identifier.

Public property

Summary

Filters results by public status

Status property

Summary

Filters a resource based on status

OperationUpdate type

Namespace

TrimbleCloud.Processing.Model

Summary

Represents OperationUpdate.

DeploymentIdentifier property

Summary

The identifier of the Deployment that supports this Operation.

Description property

Summary

The description of the operation.

DynamicOutput property

Summary

Indicates whether or not the Output content is considered dynamic or not. In all cases except for the Switcher Operation, this will be false

EngineName property

Summary

The name of the backend engine that supports this Operation. (Deprecated: Use DeploymentIdentifier instead.)

Identifier property

Summary

The identifier of the operation.

Inputs property

Summary

Named inputs for the Operation. This is an object containing one or more inputs that describe the data types which will be accepted as input to the Operation.

IsPublic property

Summary

The state of the Operation’s publication. If true, the Operation is available for public use. This is not unlike sharing it with every other User in the system. If this field is false, then it follows the normal rules with regard to sharing and individual ownership.

Name property

Summary

The name of the operation.

OutputParameters property

Summary

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

Outputs property

Summary

Named outputs for the Operation. This is an object containing one or more outputs that emit data. Each such output specifies a single output data type.

Parameters property

Summary

A list of parameter objects attached to the Operation.

Regions property

Summary

Allowable locations that a particular Operation can run in.

SharedWith property

Summary

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

SharedWithEntries property

Summary

List of identities with whom this Operation has been shared. Each entry contains an account_id (required) and optionally a client_id. An entry with only account_id grants access to all clients in that account. An entry with both client_id and account_id grants access to that specific client only. Sending an array replaces the existing list, not append to it.

Version property

Summary

The version of the operation.

Validate() method

Summary

Validate the operation creation parameters.

Parameters

This method has no parameters.

OperationsAPI type

Namespace

TrimbleCloud.Processing

Summary

API Methods relating to Trimble Cloud Platform Processing Framework operations

Approve(id) method

Summary

Approve an operation

Returns

A Task that resolves to the approved operation on completion

Parameters
NameTypeDescription
idSystem.StringThe identifier of the operation to approve
Exceptions
NameDescription
System.ExceptionThrown when a operation cannot be approved

Clone(id) method

Summary

Clone an operation

Returns

A Task that resolves to the newly cloned operation on completion

Parameters
NameTypeDescription
idSystem.StringThe identifier of the operation to clone
Exceptions
NameDescription
System.ExceptionThrown when a operation cannot be cloned

Create(operationCreate) method

Summary

Create an operation

Returns

A Task that resolves to the created operation on completion

Parameters
NameTypeDescription
operationCreateTrimbleCloud.Processing.Model.OperationCreateThe value of the operation to create
Exceptions
NameDescription
System.ExceptionThrown when an operation cannot be created
TrimbleCloud.Processing.ValidationExceptionThrown when the operation update is invalid

Delete(id) method

Summary

Delete an operation

Returns

An awaitiable Task

Parameters
NameTypeDescription
idSystem.StringThe identifier of the operation to delete
Exceptions
NameDescription
System.ExceptionThrown when a operation cannot be deleted

Get(id) method

Summary

Get an operation by id

Returns

A Task that resolves to the requested operation on completion

Parameters
NameTypeDescription
idSystem.StringThe identifier of the operation to read
Exceptions
NameDescription
System.ExceptionThrown when a operation cannot be read

GetList(include_public) method

Summary

Get a list of operations

Returns

An asynchronous list of operations

Parameters
NameTypeDescription
include_publicSystem.BooleanWhether to include public operations in the returned list

List(page,pageSize,filters) method

Summary

Get a list of operations

Returns

An asynchronous list of operations

Parameters
NameTypeDescription
pageSystem.Int32The page number to retrieve
pageSizeSystem.Int32The number of items per page
filtersTrimbleCloud.Processing.Model.OperationListFilterThe filters to apply to the list

Publish(id) method

Summary

Publish an operation

Returns

A Task that resolves to the published operation on completion

Parameters
NameTypeDescription
idSystem.StringThe identifier of the operation to publish
Exceptions
NameDescription
System.ExceptionThrown when a operation cannot be published

Retire(id) method

Summary

Retire an operation

Returns

A Task that resolves to the retired operation on completion

Parameters
NameTypeDescription
idSystem.StringThe identifier of the operation to retire
Exceptions
NameDescription
System.ExceptionThrown when a operation cannot be retired

Update(id,operationUpdate) method

Summary

Update an operation

Returns

A Task that resolves to the updated operation on completion

Parameters
NameTypeDescription
idSystem.StringThe identifier of the operation to update
operationUpdateTrimbleCloud.Processing.Model.OperationUpdateThe value of the operation to update
Exceptions
NameDescription
System.ExceptionThrown when a operation cannot be updated
TrimbleCloud.Processing.ValidationExceptionThrown when the operation update is invalid

Output type

Namespace

TrimbleCloud.Processing.Model

Summary

Input parameters for an operation

DataType property

Summary

Type of data output from the Operation

Description property

Summary

Description of the output

Name property

Summary

Name of the output

Validate() method

Summary

Validate the output

Parameters

This method has no parameters.

OutputParameter type

Namespace

TrimbleCloud.Processing.Model

Summary

Represents a OutputParameter.

Description property

Summary

A description of the parameter

Name property

Summary

Human-readable name for the parameter.

Optional property

Summary

Is the parameter optional. Defaults to false

Type property

Summary

The type of the parameter.

Validate() method

Summary

Validate the parameter.

Parameters

This method has no parameters.

Exceptions
NameDescription
TrimbleCloud.Processing.ValidationException

Page`1 type

Namespace

TrimbleCloud.Processing

Summary

Defines a page in responses.

Generic Types
NameDescription
TType of the page content items

CurrentPage property

Summary

The number of items in the page.

Items property

Summary

The items in the page.

PageSize property

Summary

The number of items per page.

TotalItems property

Summary

The total number of items available.

TotalPages property

Summary

The total number of pages available.

GetEnumerator() method

Summary

Returns an enumerator that iterates through the collection.

Returns

A an enumerator that can be used to iterate through the collection.

Parameters

This method has no parameters.

System#Collections#IEnumerable#GetEnumerator() method

Summary

Returns an enumerator that iterates through the collection.

Returns

A an enumerator that can be used to iterate through the collection.

Parameters

This method has no parameters.

Parameter type

Namespace

TrimbleCloud.Processing.Model

Summary

Represents a parameter.

Description property

Summary

A description of the parameter

Encrypted property

Summary

Indicates that the parameter contains sensitive information. Defaults to false

Name property

Summary

Human-readable name for the parameter.

Optional property

Summary

Is the parameter optional. Defaults to false

Options property

Summary

List of options for the parameter

Type property

Summary

The type of the parameter.

Validate() method

Summary

Validate the parameter.

Parameters

This method has no parameters.

Exceptions
NameDescription
TrimbleCloud.Processing.ValidationException

Procedure type

Namespace

TrimbleCloud.Processing.Model

Summary

Procedure model

AccountId property

Summary

The account ID of the Procedure owner

ClientId property

Summary

The client ID of the Procedure owner

DefaultRegion property

Summary

The default region for the Procedure

Description property

Summary

Description of the Procedure

DocumentationUrl property

Summary

URL to external documentation for the Procedure

ExecutionStatus property

Summary

The execution status of the Procedure

Identifier property

Summary

Identifier of the Procedure

IsPublic property

Summary

IsPublic

Name property

Summary

The name of the Procedure

Operations property

Remarks

This is the definition of Procedure contents and how inputs & outputs are linked together between individual Operations

Owner property

Summary

The owner of the Procedure

Parameters property

Remarks

The user will specify parameter values via these mapping names

Regions property

Summary

regions

RetriedAfter property

Summary

Timestamp indicating when this Operation will move to RETIRED status, and will no longer be executable

SharedWith property

Summary

List of names of Users with whom this Procedure has been shared.

SharedWithEntries property

Summary

List of identities with whom this Procedure has been shared. Each entry contains an account_id (required) and optionally a client_id.

Status property

Summary

The status of the Procedure

Tags property

Summary

List of tags (as strings) associated with the Procedure.

Version property

Summary

The version of the Procedure

ProcedureCreate type

Namespace

TrimbleCloud.Processing.Model

Summary

ProcedureCreate model

DefaultRegion property

Summary

The default region for the Procedure

Description property

Summary

Description of the Procedure

DocumentationUrl property

Summary

URL to external documentation for the Procedure

Identifier property

Summary

Identifier of the Procedure

Name property

Summary

The name of the Procedure

Operations property

Remarks

This is the definition of Procedure contents and how inputs & outputs are linked together between individual Operations

ProcedureParameters property

Remarks

The user will specify parameter values via these mapping names

SharedWith property

Summary

List of names of Users with whom this Procedure has been shared.

SharedWithEntries property

Summary

List of identities with whom this Procedure has been shared. Each entry contains an account_id (required) and optionally a client_id. An entry with only account_id grants access to all clients in that account. An entry with both client_id and account_id grants access to that specific client only. Sending an array replaces the existing list, not append to it.

Tags property

Summary

List of tags (as strings) associated with the Procedure.

Version property

Summary

The version of the Procedure

Validate() method

Summary

Validate the ProcedureCreate object.

Parameters

This method has no parameters.

Exceptions
NameDescription
TrimbleCloud.Processing.ValidationException

ProcedureListFilter type

Namespace

TrimbleCloud.Processing.Model

Summary

Procedure List Filters

ExecutionStatus property

Summary

Filters a resource based on execution status.

OperationId property

Summary

Filters a resource based on the operation id.

Public property

Summary

Filters results by public status

Status property

Summary

Filters a resource based on status

ProcedureParameter type

Namespace

TrimbleCloud.Processing.Model

Summary

Parmeter class

DefaultValue property

Description property

Name property

Source property

Type property

Value property

ProcedureUpdate type

Namespace

TrimbleCloud.Processing.Model

Summary

ProcedureUpdate model

DefaultRegion property

Summary

The default region for the Procedure

Description property

Summary

Description of the Procedure

DocumentationUrl property

Summary

URL to external documentation for the Procedure

Identifier property

Summary

Identifier of the Procedure

Name property

Summary

The name of the Procedure

Operations property

Remarks

This is the definition of Procedure contents and how inputs & outputs are linked together between individual Operations

ProcedureParameters property

Remarks

The user will specify parameter values via these mapping names

SharedWith property

Summary

List of names of Users with whom this Procedure has been shared.

SharedWithEntries property

Summary

List of identities with whom this Procedure has been shared. Each entry contains an account_id (required) and optionally a client_id. An entry with only account_id grants access to all clients in that account. An entry with both client_id and account_id grants access to that specific client only. Sending an array replaces the existing list, not append to it.

Tags property

Summary

List of tags (as strings) associated with the Procedure.

Version property

Summary

The version of the Procedure

Validate() method

Summary

Validate the ProcedureCreate object.

Parameters

This method has no parameters.

Exceptions
NameDescription
TrimbleCloud.Processing.ValidationException

ProceduresAPI type

Namespace

TrimbleCloud.Processing

Summary

API Methods relating to Trimble Cloud Platform Processing Framework procedures

Approve(id) method

Summary

Approve a procedure

Returns

A Task that resolves to the approved procedure on completion

Parameters
NameTypeDescription
idSystem.StringThe identifier of the procedure to approve
Exceptions
NameDescription
System.ExceptionThrown when a procedure cannot be approved

Create(procedureCreate) method

Summary

Create a procedure

Returns

A Task that resolves to the created procedure on completion

Parameters
NameTypeDescription
procedureCreateTrimbleCloud.Processing.Model.ProcedureCreateThe value of the procedure to create
Exceptions
NameDescription
System.ExceptionThrown when a procedure cannot be created

Delete(id) method

Summary

Delete a procedure

Returns

An awaitiable Task

Parameters
NameTypeDescription
idSystem.StringThe identifier of the procedure to delete
Exceptions
NameDescription
System.ExceptionThrown when a procedure cannot be deleted

Get(id,procedureView) method

Summary

Get a procedure by id

Returns

A Task that resolves to the requested procedure on completion

Parameters
NameTypeDescription
idSystem.StringThe identifier of the procedure to read
procedureViewSystem.StringOptional procedure view (passed as procedure-view)
Exceptions
NameDescription
System.ExceptionThrown when a procedure cannot be read

GetList(include_public) method

Summary

Get a list of procedures

Returns

An asynchronous list of procedures

Parameters
NameTypeDescription
include_publicSystem.BooleanWhether to include public procedures in the returned list

List(page,pageSize,filters) method

Summary

Get a list of procedures

Returns

An asynchronous list of procedures

Parameters
NameTypeDescription
pageSystem.Int32The page number to retrieve
pageSizeSystem.Int32The number of items per page
filtersTrimbleCloud.Processing.Model.ProcedureListFilterThe filters to apply to the list

Publish(id) method

Summary

Publish a procedure

Returns

A Task that resolves to the published procedure on completion

Parameters
NameTypeDescription
idSystem.StringThe identifier of the procedure to publish
Exceptions
NameDescription
System.ExceptionThrown when a procedure cannot be published

Retire(id) method

Summary

Retire a procedure

Returns

A Task that resolves to the retired procedure on completion

Parameters
NameTypeDescription
idSystem.StringThe identifier of the procedure to retire
Exceptions
NameDescription
System.ExceptionThrown when a procedure cannot be retired

Update(id,procedureUpdate) method

Summary

Update a procedure

Returns

A Task that resolves to the updated procedure on completion

Parameters
NameTypeDescription
idSystem.StringThe identifier of the procedure to update
procedureUpdateTrimbleCloud.Processing.Model.ProcedureUpdateThe value of the procedure to update
Exceptions
NameDescription
System.ExceptionThrown when a procedure cannot be updated

ProcessingClient type

Namespace

TrimbleCloud.Processing

Summary

A client for the Trimble Cloud Platform Processing Framework

Example
const TOKEN = "...";
const BASE_URL = "https://api-usw2.trimblepaas.com/processing-v1.0";
var tokenProvider = new FixedTokenProvider(TOKEN);
var httpclientProvider = new BearerTokenHttpClientProvider(tokenProvider, new Uri(BASE_URL, UriKind.Absolute));
var processingClient = new ProcessingClient(httpclientProvider);
var operations = await processingClient.Operations.GetList().GetItems();
var proceduress = await processingClient.Procedures.GetList().GetItems();
var execution = await processingClient.Executions.Create(new Execution() { ... });
var engine = await processingClient.Engines.Create(new Engine() { ... });
var deployment = await processingClient.Deployments.Create(new Deployment() { ... });
var deploymentSecret = await processingClient.DeploymentSecrets.Create(new DeploymentSecret() { ... });

#ctor(clientProvider) constructor

Summary

Public constructor for a Processing Client

Parameters
NameTypeDescription
clientProviderTrimble.ID.IHttpClientProviderA provider of a pre-configured HttpClient used for API calls made by this client

DeploymentSecrets property

Deployments property

Engines property

Executions property

Operations property

Procedures property

QueryStringFormatter`1 type

Namespace

TrimbleCloud.Processing.Helper

Summary

Query String Formatter

ToQueryString() method

Summary

Convert the filter to query string

Parameters

This method has no parameters.

Resource type

Namespace

TrimbleCloud.Processing.Model

Summary

Represents a resource.

CreatedAt property

Summary

Resouce creation date time

Id property

Summary

Gets resource Id

UpdatedAt property

Summary

Resouce updation date time

Response type

Namespace

TrimbleCloud.Processing

Summary

Represents a response.

ContentLength property

Summary

Returns the content length of the HTTP response.

IsError property

Summary

Indicates whether the status code of the returned response is considered an error code.

Metadata property

Summary

Get the HTTP response headers.

ReasonPhrase property

Summary

Gets the HTTP reason phrase.

RequestId property

Summary

Gets the client request id that was sent to the server as tcp-request-id headers.

ResponseContent property

Summary

Gets or sets the response content body.

Status property

Summary

Gets the HTTP status code.

Dispose() method

Summary

Frees resources held by this Response instance.

Parameters

This method has no parameters.

FromValue“1(value,response) method

Summary

Creates a new instance of Response`1 with the provided value and HTTP response.

Returns

A new instance of Response`1 with the provided value and HTTP response.

Parameters
NameTypeDescription
value“0The value.
responseTrimbleCloud.Processing.ResponseThe HTTP response.
Generic Types
NameDescription
TThe type of the value.

ToString() method

Summary

Returns the string representation of this Response.

Returns

The string representation of this Response

Parameters

This method has no parameters.

Response`1 type

Namespace

TrimbleCloud.Processing

Summary

Represents a response.

Generic Types
NameDescription
TThe type of returned value.

Data property

Summary

Gets the value returned by the service. Accessing this property will throw if HasData is false.

HasData property

Summary

Gets a value indicating whether the current instance has a valid value of its underlying type.

GetResponse() method

Summary

Get HTTP raw response

Parameters

This method has no parameters.

op_Implicit(response) method

Summary

Returns the value of this Response`1 object.

Parameters
NameTypeDescription
responseTrimbleCloud.Processing.Response{`0})~`0The Response`1 instance.

SecretFile type

Namespace

TrimbleCloud.Processing.Model

Summary

Secret files

FilePath property

Summary

The file path of an ingested Deployment Secret file.

Identifier property

Summary

The expected identifier of a Deployment Secret.

SecretVariable type

Namespace

TrimbleCloud.Processing.Model

Summary

Secret variables

Identifier property

Summary

The expected identifier of a Deployment Secret.

VariableName property

Summary

The name of the environment variable inside the container.

SharedWithEntry type

Namespace

TrimbleCloud.Processing.Model

Summary

Represents an identity with whom a resource has been shared. An entry with only AccountId grants access to all clients in that account. An entry with both ClientId and AccountId grants access to that specific client only.

AccountId property

Summary

The TID account identifier to share with. Required.

ClientId property

Summary

The TID subject identifier (client ID) to share with. When provided alongside AccountId, shares with that specific client. When omitted, shares with all clients in the specified account.

Status type

Namespace

TrimbleCloud.Processing.Model

Summary

The status of the operation.

DELETING constants

Summary

DELETING status

EXECUTABLE constants

Summary

EXECUTABLE status

MUTABLE constants

Summary

MUTABLE status

RETIRED constants

Summary

RETIRED status

UNKNOWN constants

Summary

Unknown status

TrimbleServiceException type

Namespace

TrimbleCloud.Processing

Summary

Exception for Trimble service API errors

#ctor(message,response) constructor

Summary

Constructor used by the SDK to create service exceptions with complete error information.

Parameters
NameTypeDescription
messageSystem.StringError message
responseTrimbleCloud.Processing.ResponseResponse object that led to the exception

#ctor() constructor

Summary

Constructor used by the SDK to create service exceptions with complete error information.

Parameters

This constructor has no parameters.

#ctor(message,response,innerException) constructor

Summary

Constructor used by the SDK to create service exceptions with complete error information.

Parameters
NameTypeDescription
messageSystem.StringError message
responseTrimbleCloud.Processing.ResponseResponse object that led to the exception
innerExceptionSystem.ExceptionInner exception if any

#ctor(info,context) constructor

Summary

Constructor for deserialization

Parameters
NameTypeDescription
infoSystem.Runtime.Serialization.SerializationInfoThe SerializationInfo that holds the serialized object data
contextSystem.Runtime.Serialization.StreamingContextThe StreamingContext that contains contextual information about the source or destination

_response constants

Summary

Gets the response, if any, that led to the exception.

RequestId property

Summary

Gets the request ID for tracking and support purposes.

StatusCode property

Summary

Gets the HTTP status code of the response. Returns 0 if response was not received.

GetObjectData() method

Summary

Inherit from parent.

Parameters

This method has no parameters.

GetRawResponse() method

Summary

Gets the response, if any, that led to the exception.

Returns

The response that caused this exception, or null if not available

Parameters

This method has no parameters.

ToString() method

Summary

Returns a string representation of the exception

Returns

Formatted error message

Parameters

This method has no parameters.

ValidationException type

Namespace

TrimbleCloud.Processing

Summary

Represents an exception that occurs during validation.

#ctor(message) constructor

Summary

Initializes a new instance of the ValidationException class.

Parameters
NameTypeDescription
messageSystem.StringException message.

#ctor(message,innerException) constructor

Summary

Initializes a new instance of the ValidationException class.

Parameters
NameTypeDescription
messageSystem.StringException message.
innerExceptionSystem.ExceptionInner exception.

#ctor(message,errors) constructor

Summary

Initializes a new instance of the ValidationException class.

Parameters
NameTypeDescription
messageSystem.StringException message.
errorsSystem.Collections.Generic.IEnumerable{System.String}List of errors.

Errors property

Summary

Gets the list of errors.