TrimbleCloud.Processing
TrimbleCloud.Processing
Section titled “TrimbleCloud.Processing”Contents
Section titled “Contents”- ACRToken
- APIBase
- Attempt
- AutoScaling
- Client
- ClientsAPI
- Compute
- Constants
- ContainerUpload
- ContainerUploadStatus
- DataType
- Deployment
- DeploymentCreate
- DeploymentListFilter
- DeploymentSecret
- DeploymentSecretCreate
- DeploymentSecretUpdate
- DeploymentSecretsAPI
- DeploymentSecretsListFilter
- DeploymentStatus
- DeploymentUpdate
- DeploymentsAPI
- Engine
- EngineCreate
- EngineListFilter
- EngineStatus
- EngineUpdate
- EnginesAPI
- EnumConverter`1
- EnumHelper`1
- EnvironmentVariable
- Execution
- ExecutionActivity
- ExecutionCreate
- ExecutionEngineRequest
- ExecutionEvent
- ExecutionListFilter
- ExecutionProgressStatus
- ExecutionSortBy
- ExecutionStatus
- ExecutionsAPI
- HistoricalInfo
- HttpClientResponse
- IPage`1
- IngestionType
- Input
- ListFilterBase
- OSType
- OpInput
- OpInput
- OpOutput
- OpOutput
- OpParamater
- OpParameter
- Operation
- OperationChain
- OperationChain
- OperationCreate
- OperationListFilter
- OperationUpdate
- OperationsAPI
- Output
- OutputParameter
- Page`1
- Parameter
- Procedure
- ProcedureCreate
- ProcedureListFilter
- ProcedureParameter
- ProcedureUpdate
- ProceduresAPI
- ProcessingClient
- QueryStringFormatter`1
- Resource
- Response
- Response`1
- SecretFile
- SecretVariable
- SharedWithEntry
- Status
- TrimbleServiceException
- ValidationException
ACRToken type
Section titled “ACRToken type”Namespace
Section titled “Namespace”TrimbleCloud.Processing.Model
Summary
Section titled “Summary”ACR Token
LoginCommand property
Section titled “LoginCommand property”Summary
Section titled “Summary”ACR Token login command
PushCommand property
Section titled “PushCommand property”Summary
Section titled “Summary”ACR Token push command
TagCommand property
Section titled “TagCommand property”Summary
Section titled “Summary”ACR Token tag command
UploadStatus property
Section titled “UploadStatus property”Summary
Section titled “Summary”ACR Token upload status
APIBase type
Section titled “APIBase type”Namespace
Section titled “Namespace”TrimbleCloud.Processing
Summary
Section titled “Summary”Base class for API requests
GetRequestId(message) method
Section titled “GetRequestId(message) method”Summary
Section titled “Summary”Extracts the request ID from the HTTP response headers
Returns
Section titled “Returns”The request ID if present, otherwise an empty string
Parameters
Section titled “Parameters”| Name | Type | Description |
|---|---|---|
| message | System.Net.Http.HttpResponseMessage | The HTTP response message |
ThrowErrorAsync(response) method
Section titled “ThrowErrorAsync(response) method”Summary
Section titled “Summary”Throws a TrimbleServiceException for HTTP error responses
Parameters
Section titled “Parameters”| Name | Type | Description |
|---|---|---|
| response | System.Net.Http.HttpResponseMessage | The HTTP response message |
Exceptions
Section titled “Exceptions”| Name | Description |
|---|---|
| TrimbleCloud.Processing.TrimbleServiceException | Always thrown with error details (includes ArgumentNullException as inner exception if response is null) |
Attempt type
Section titled “Attempt type”Namespace
Section titled “Namespace”TrimbleCloud.Processing.Model
Summary
Section titled “Summary”Latest attempt details for the execution
BoundParameters property
Section titled “BoundParameters property”Summary
Section titled “Summary”Mapping of Operation-specified output parameter names to output parameter values for this attempt.
CompletedAt property
Section titled “CompletedAt property”Summary
Section titled “Summary”The time the attempt completed
FailedAt property
Section titled “FailedAt property”Summary
Section titled “Summary”The time the attempt failed
Status property
Section titled “Status property”Summary
Section titled “Summary”Attempt progress status
SubmittedAt property
Section titled “SubmittedAt property”Summary
Section titled “Summary”The time the attempt was submitted
AutoScaling type
Section titled “AutoScaling type”Namespace
Section titled “Namespace”TrimbleCloud.Processing.Model
Summary
Section titled “Summary”Auto-scaling configuration
MaxCount property
Section titled “MaxCount property”Summary
Section titled “Summary”Maximum count
MinCount property
Section titled “MinCount property”Summary
Section titled “Summary”Minimum count
Client type
Section titled “Client type”Namespace
Section titled “Namespace”TrimbleCloud.Processing.Model
Summary
Section titled “Summary”Client model
access_level property
Section titled “access_level property”name property
Section titled “name property”ClientsAPI type
Section titled “ClientsAPI type”Namespace
Section titled “Namespace”TrimbleCloud.Processing
Summary
Section titled “Summary”API Methods relating to Trimble Cloud Platform Processing Framework executions
Read() method
Section titled “Read() method”Summary
Section titled “Summary”Read the current client
Returns
Section titled “Returns”A Task that resolves to the current client on completion
Parameters
Section titled “Parameters”This method has no parameters.
Exceptions
Section titled “Exceptions”| Name | Description |
|---|---|
| System.Exception | Thrown when the current client cannot be read |
Compute type
Section titled “Compute type”Namespace
Section titled “Namespace”TrimbleCloud.Processing.Model
Summary
Section titled “Summary”The configuration object to define the Engine-compute resources for memory and CPU allocation.
CPU property
Section titled “CPU property”Summary
Section titled “Summary”The amount of CPU to assign to a single instance of an Engine.
GpuCount property
Section titled “GpuCount property”Summary
Section titled “Summary”Optional GPU count for the Engine compute profile.
GpuType property
Section titled “GpuType property”Summary
Section titled “Summary”Optional GPU type for the Engine compute profile.
Interruptible property
Section titled “Interruptible property”Summary
Section titled “Summary”Whether the compute should be scheduled as interruptible/preemptible.
Memory property
Section titled “Memory property”Summary
Section titled “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
Section titled “Validate() method”Summary
Section titled “Summary”Validate the compute parameters.
Parameters
Section titled “Parameters”This method has no parameters.
Constants type
Section titled “Constants type”Namespace
Section titled “Namespace”TrimbleCloud.Processing
Summary
Section titled “Summary”Constants used by the Trimble Cloud Processing Framework
ContainerUpload type
Section titled “ContainerUpload type”Namespace
Section titled “Namespace”TrimbleCloud.Processing.Model
Summary
Section titled “Summary”Container upload
AcrToken property
Section titled “AcrToken property”Summary
Section titled “Summary”ACR Token
ContainerUploadStatus type
Section titled “ContainerUploadStatus type”Namespace
Section titled “Namespace”TrimbleCloud.Processing.Model
Summary
Section titled “Summary”Container upload status
AVAILABLE constants
Section titled “AVAILABLE constants”Summary
Section titled “Summary”Available
GENERATING constants
Section titled “GENERATING constants”Summary
Section titled “Summary”Generating
IMAGE_RECEIVED constants
Section titled “IMAGE_RECEIVED constants”Summary
Section titled “Summary”Image received
UNAVAILABLE constants
Section titled “UNAVAILABLE constants”Summary
Section titled “Summary”Unavailable
UNKNOWN constants
Section titled “UNKNOWN constants”Summary
Section titled “Summary”Unknown status
DataType type
Section titled “DataType type”Namespace
Section titled “Namespace”TrimbleCloud.Processing.Model
Summary
Section titled “Summary”Data type of the parameter
Array constants
Section titled “Array constants”Summary
Section titled “Summary”A list of parameters of any type
Boolean constants
Section titled “Boolean constants”Summary
Section titled “Summary”Boolean true/false (not surrounded by quotes)
Number constants
Section titled “Number constants”Summary
Section titled “Summary”An integer or a float
Object constants
Section titled “Object constants”Summary
Section titled “Summary”Any valid JSON object
SingleChoice constants
Section titled “SingleChoice constants”Summary
Section titled “Summary”Value must match an item in the options field
String constants
Section titled “String constants”Summary
Section titled “Summary”String text surrounded by double quotes
Unknown constants
Section titled “Unknown constants”Summary
Section titled “Summary”Unknown type
Wildcard constants
Section titled “Wildcard constants”Summary
Section titled “Summary”Wildcard type
Deployment type
Section titled “Deployment type”Namespace
Section titled “Namespace”TrimbleCloud.Processing.Model
Summary
Section titled “Summary”Deployment create model
AccountId property
Section titled “AccountId property”Summary
Section titled “Summary”The account ID of the Deployment owner
AutoScaling property
Section titled “AutoScaling property”Summary
Section titled “Summary”Auto scaling configuration
ClientId property
Section titled “ClientId property”Summary
Section titled “Summary”The client ID of the Deployment owner
Compute property
Section titled “Compute property”Summary
Section titled “Summary”The configuration object to define the Engine-compute resources for memory and CPU allocation.
Description property
Section titled “Description property”Summary
Section titled “Summary”The description of the deployment.
EngineId property
Section titled “EngineId property”Summary
Section titled “Summary”The Engine Identifier to use for this deployment.
Identifier property
Section titled “Identifier property”Summary
Section titled “Summary”A Deployment Identifier is unique within the system.
Name property
Section titled “Name property”Summary
Section titled “Summary”The name of the deployment.
Operations property
Section titled “Operations property”Summary
Section titled “Summary”Optional projection of operations for specialized responses
Owner property
Section titled “Owner property”Summary
Section titled “Summary”The owner of the Deployment
Regions property
Section titled “Regions property”Summary
Section titled “Summary”region to deploy the deployment
Secrets property
Section titled “Secrets property”Summary
Section titled “Summary”Optional projection of secrets for specialized responses
Status property
Section titled “Status property”Summary
Section titled “Summary”Deployment status
Trn property
Section titled “Trn property”Summary
Section titled “Summary”TRN value of the Deployment
DeploymentCreate type
Section titled “DeploymentCreate type”Namespace
Section titled “Namespace”TrimbleCloud.Processing.Model
Summary
Section titled “Summary”Deployment create model
AutoScaling property
Section titled “AutoScaling property”Summary
Section titled “Summary”Auto scaling configuration
Compute property
Section titled “Compute property”Summary
Section titled “Summary”The configuration object to define the Engine-compute resources for memory and CPU allocation.
Description property
Section titled “Description property”Summary
Section titled “Summary”The description of the deployment.
EngineId property
Section titled “EngineId property”Summary
Section titled “Summary”The Engine Identifier to use for this deployment.
Identifier property
Section titled “Identifier property”Summary
Section titled “Summary”A Deployment Identifier is unique within the system.
Name property
Section titled “Name property”Summary
Section titled “Summary”The name of the deployment.
Regions property
Section titled “Regions property”Summary
Section titled “Summary”The region this Deployment can run in
Validate() method
Section titled “Validate() method”Summary
Section titled “Summary”Validate the deployment creation parameters.
Parameters
Section titled “Parameters”This method has no parameters.
DeploymentListFilter type
Section titled “DeploymentListFilter type”Namespace
Section titled “Namespace”TrimbleCloud.Processing.Model
Summary
Section titled “Summary”Deployment List Filters
AccountId property
Section titled “AccountId property”Summary
Section titled “Summary”Filters resources by the Owner’s TID account identifier.
ActiveEngine property
Section titled “ActiveEngine property”Summary
Section titled “Summary”The active engine of a deployment
ClientId property
Section titled “ClientId property”Summary
Section titled “Summary”Filters resources by the Owner’s TID subject identifier (client ID).
Owner property
Section titled “Owner property”Summary
Section titled “Summary”Filters a resource based on owner
Status property
Section titled “Status property”Summary
Section titled “Summary”Filters a resource based on status.
DeploymentSecret type
Section titled “DeploymentSecret type”Namespace
Section titled “Namespace”TrimbleCloud.Processing.Model
Summary
Section titled “Summary”Represents the Deployment Secret.
AccountId property
Section titled “AccountId property”Summary
Section titled “Summary”The account ID of the Deployment secret owner
ClientId property
Section titled “ClientId property”Summary
Section titled “Summary”The client ID of the Deployment secret owner
Description property
Section titled “Description property”Summary
Section titled “Summary”Deployment Secret description
Identifier property
Section titled “Identifier property”Summary
Section titled “Summary”The expected identifier of a Deployment Secret.
Name property
Section titled “Name property”Summary
Section titled “Summary”The name of the Deployment Secret.
Owner property
Section titled “Owner property”Summary
Section titled “Summary”The owner of the Deployment secret
Regions property
Section titled “Regions property”Summary
Section titled “Summary”The regions where the Deployment Secret is available.
Status property
Section titled “Status property”Summary
Section titled “Summary”Deployment status
Trn property
Section titled “Trn property”Summary
Section titled “Summary”TRN value of the deployment secret
Value property
Section titled “Value property”Summary
Section titled “Summary”The value of the Deployment Secret.
DeploymentSecretCreate type
Section titled “DeploymentSecretCreate type”Namespace
Section titled “Namespace”TrimbleCloud.Processing.Model
Summary
Section titled “Summary”Represents a deployment secret creation.
Description property
Section titled “Description property”Summary
Section titled “Summary”Deployment Secret description
Identifier property
Section titled “Identifier property”Summary
Section titled “Summary”The expected identifier of a Deployment Secret.
Name property
Section titled “Name property”Summary
Section titled “Summary”The name of the Deployment Secret.
Value property
Section titled “Value property”Summary
Section titled “Summary”The value of the Deployment Secret.
Validate() method
Section titled “Validate() method”Summary
Section titled “Summary”Validate the deployment secret creation parameters.
Parameters
Section titled “Parameters”This method has no parameters.
DeploymentSecretUpdate type
Section titled “DeploymentSecretUpdate type”Namespace
Section titled “Namespace”TrimbleCloud.Processing.Model
Summary
Section titled “Summary”Represents the updation parameters for the deployment secret.
Description property
Section titled “Description property”Summary
Section titled “Summary”Deployment Secret description
Name property
Section titled “Name property”Summary
Section titled “Summary”The name of the Deployment Secret.
Value property
Section titled “Value property”Summary
Section titled “Summary”The value of the Deployment Secret.
Validate() method
Section titled “Validate() method”Summary
Section titled “Summary”Validate the deployment creation parameters.
Parameters
Section titled “Parameters”This method has no parameters.
Exceptions
Section titled “Exceptions”| Name | Description |
|---|---|
| System.ArgumentException |
DeploymentSecretsAPI type
Section titled “DeploymentSecretsAPI type”Namespace
Section titled “Namespace”TrimbleCloud.Processing
Summary
Section titled “Summary”Deployment Secrets API Resource
Create(deploymentId,deploymentSecretCreate) method
Section titled “Create(deploymentId,deploymentSecretCreate) method”Summary
Section titled “Summary”Create a deployment secret
Returns
Section titled “Returns”A Task that resolves to the created deployment secret on completion
Parameters
Section titled “Parameters”| Name | Type | Description |
|---|---|---|
| deploymentId | System.String | The id of the deployment |
| deploymentSecretCreate | TrimbleCloud.Processing.Model.DeploymentSecretCreate | The value of the deployment secret to create |
Exceptions
Section titled “Exceptions”| Name | Description |
|---|---|
| System.Exception | Thrown when a deployment secret cannot be created |
| TrimbleCloud.Processing.ValidationException | Thrown when the deployment secret is invalid |
Delete(deploymentId,deploymentSecretId) method
Section titled “Delete(deploymentId,deploymentSecretId) method”Summary
Section titled “Summary”Delete a deployment secret
Returns
Section titled “Returns”An awaitiable Task
Parameters
Section titled “Parameters”| Name | Type | Description |
|---|---|---|
| deploymentId | System.String | The id of the deployment |
| deploymentSecretId | System.String | The identifier of the deployment secret to delete |
Exceptions
Section titled “Exceptions”| Name | Description |
|---|---|
| System.Exception | Thrown when deployment secret cannot be deleted |
Get(deploymentId,deploymentSecretId) method
Section titled “Get(deploymentId,deploymentSecretId) method”Summary
Section titled “Summary”Get deployment secret by id
Returns
Section titled “Returns”A Task that resolves to the requested deployment secret on completion
Parameters
Section titled “Parameters”| Name | Type | Description |
|---|---|---|
| deploymentId | System.String | The id of the deployment |
| deploymentSecretId | System.String | The identifier of the deployment secret to read |
Exceptions
Section titled “Exceptions”| Name | Description |
|---|---|
| System.Exception | Thrown when deployment secret cannot be read |
GetList(deploymentId) method
Section titled “GetList(deploymentId) method”Summary
Section titled “Summary”Get a list of deployment secret
Returns
Section titled “Returns”An asynchronous list of deployment secrets for the deployment
Parameters
Section titled “Parameters”| Name | Type | Description |
|---|---|---|
| deploymentId | System.String | The id of the deployment |
List(deploymentId,page,pageSize,filters) method
Section titled “List(deploymentId,page,pageSize,filters) method”Summary
Section titled “Summary”Get a list of deployment secrets
Returns
Section titled “Returns”An asynchronous list of deployment secrets for the deployment
Parameters
Section titled “Parameters”| Name | Type | Description |
|---|---|---|
| deploymentId | System.String | The id of the deployment |
| page | System.Int32 | The page number |
| pageSize | System.Int32 | The number of items per page |
| filters | TrimbleCloud.Processing.Model.DeploymentSecretsListFilter | Optional filters to apply to the list |
Retire(deploymentId,deploymentSecretId) method
Section titled “Retire(deploymentId,deploymentSecretId) method”Summary
Section titled “Summary”Retire a deployment secret
Returns
Section titled “Returns”A Task that resolves to the retired deployment secret on completion
Parameters
Section titled “Parameters”| Name | Type | Description |
|---|---|---|
| deploymentId | System.String | The id of the deployment |
| deploymentSecretId | System.String | The identifier of the deployment secret to retire |
Exceptions
Section titled “Exceptions”| Name | Description |
|---|---|
| System.Exception | Thrown when deployment secret cannot be retired |
Update(deploymentId,deploymentSecretId,deploymentSecretUpdate) method
Section titled “Update(deploymentId,deploymentSecretId,deploymentSecretUpdate) method”Summary
Section titled “Summary”Update a deployment secret
Returns
Section titled “Returns”A Task that resolves to the updated deployment secret on completion
Parameters
Section titled “Parameters”| Name | Type | Description |
|---|---|---|
| deploymentId | System.String | The id of the deployment |
| deploymentSecretId | System.String | The identifier of the deployment secret to update |
| deploymentSecretUpdate | TrimbleCloud.Processing.Model.DeploymentSecretUpdate | The value of the deployment secret to update |
Exceptions
Section titled “Exceptions”| Name | Description |
|---|---|
| System.Exception | Thrown when deployment secret cannot be updated |
DeploymentSecretsListFilter type
Section titled “DeploymentSecretsListFilter type”Namespace
Section titled “Namespace”TrimbleCloud.Processing.Model
Summary
Section titled “Summary”Deployment Secrets List Filters
AccountId property
Section titled “AccountId property”Summary
Section titled “Summary”Filters resources by the Owner’s TID account identifier.
ClientId property
Section titled “ClientId property”Summary
Section titled “Summary”Filters resources by the Owner’s TID subject identifier (client ID).
Owner property
Section titled “Owner property”Summary
Section titled “Summary”Filters resources by the Owner’s internal name. This is a legacy parameter; prefer using ClientId or AccountId instead.
DeploymentStatus type
Section titled “DeploymentStatus type”Namespace
Section titled “Namespace”TrimbleCloud.Processing.Model
Summary
Section titled “Summary”Deployment status
AVAILABLE constants
Section titled “AVAILABLE constants”Summary
Section titled “Summary”available
DELETING constants
Section titled “DELETING constants”Summary
Section titled “Summary”Deleting
FAILED constants
Section titled “FAILED constants”Summary
Section titled “Summary”failed
PREPARING constants
Section titled “PREPARING constants”Summary
Section titled “Summary”Preparing
RETIRED constants
Section titled “RETIRED constants”Summary
Section titled “Summary”retired
RETIRING constants
Section titled “RETIRING constants”Summary
Section titled “Summary”being retired
SUBMITTED constants
Section titled “SUBMITTED constants”Summary
Section titled “Summary”submitted
UNKNOWN constants
Section titled “UNKNOWN constants”Summary
Section titled “Summary”Unknown status
UPDATING constants
Section titled “UPDATING constants”Summary
Section titled “Summary”Updating
DeploymentUpdate type
Section titled “DeploymentUpdate type”Namespace
Section titled “Namespace”TrimbleCloud.Processing.Model
Summary
Section titled “Summary”Represents the updation parameters for the deployment.
AutoScaling property
Section titled “AutoScaling property”Summary
Section titled “Summary”Auto scaling configuration
Compute property
Section titled “Compute property”Summary
Section titled “Summary”The configuration object to define the Engine-compute resources for memory and CPU allocation.
Description property
Section titled “Description property”Summary
Section titled “Summary”Deployment description
EngineId property
Section titled “EngineId property”Summary
Section titled “Summary”The Engine ID that is connected to this Deployment.
Name property
Section titled “Name property”Summary
Section titled “Summary”The name of the Deployment. Max 64 chars
Regions property
Section titled “Regions property”Summary
Section titled “Summary”The region this Deployment can run in
Validate() method
Section titled “Validate() method”Summary
Section titled “Summary”Validate the deployment updation parameters.
Parameters
Section titled “Parameters”This method has no parameters.
Exceptions
Section titled “Exceptions”| Name | Description |
|---|---|
| System.ArgumentException |
DeploymentsAPI type
Section titled “DeploymentsAPI type”Namespace
Section titled “Namespace”TrimbleCloud.Processing
Summary
Section titled “Summary”Deployments API Resource
Create(deploymentCreate) method
Section titled “Create(deploymentCreate) method”Summary
Section titled “Summary”Create a deployment
Returns
Section titled “Returns”A Task that resolves to the created deployment on completion
Parameters
Section titled “Parameters”| Name | Type | Description |
|---|---|---|
| deploymentCreate | TrimbleCloud.Processing.Model.DeploymentCreate | The value of the deployment to create |
Exceptions
Section titled “Exceptions”| Name | Description |
|---|---|
| System.Exception | Thrown when an deployment cannot be created |
| TrimbleCloud.Processing.ValidationException | Thrown when the deployment creation parameters are invalid |
Delete(id) method
Section titled “Delete(id) method”Summary
Section titled “Summary”Delete a deployment
Returns
Section titled “Returns”True if deletion succeeded
Parameters
Section titled “Parameters”| Name | Type | Description |
|---|---|---|
| id | System.String | The identifier of the deployment to delete |
Exceptions
Section titled “Exceptions”| Name | Description |
|---|---|
| System.Exception | Thrown when a deployment cannot be deleted |
Get(id) method
Section titled “Get(id) method”Summary
Section titled “Summary”Get deployment by id
Returns
Section titled “Returns”A Task that resolves to the requested deployment on completion
Parameters
Section titled “Parameters”| Name | Type | Description |
|---|---|---|
| id | System.String | The identifier of the deployment to read |
Exceptions
Section titled “Exceptions”| Name | Description |
|---|---|
| System.Exception | Thrown when the deployment cannot be read |
GetList(engineId) method
Section titled “GetList(engineId) method”Summary
Section titled “Summary”Get a list of deployments
Returns
Section titled “Returns”An asynchronous list of deployments
Parameters
Section titled “Parameters”| Name | Type | Description |
|---|---|---|
| engineId | System.String | The id of the engine |
List(page,pageSize,filters) method
Section titled “List(page,pageSize,filters) method”Summary
Section titled “Summary”Get a list of deployments
Returns
Section titled “Returns”An asynchronous list of deployments
Parameters
Section titled “Parameters”| Name | Type | Description |
|---|---|---|
| page | System.Int32 | The page number |
| pageSize | System.Int32 | The number of items per page |
| filters | TrimbleCloud.Processing.Model.DeploymentListFilter | The filters to apply |
Retire(id) method
Section titled “Retire(id) method”Summary
Section titled “Summary”Retire a Deployment
Returns
Section titled “Returns”A Task that resolves to the retired deployment on completion
Parameters
Section titled “Parameters”| Name | Type | Description |
|---|---|---|
| id | System.String | The identifier of the deployment to retire |
Exceptions
Section titled “Exceptions”| Name | Description |
|---|---|
| System.Exception | Thrown when a deployment cannot be retired |
Update(id,deploymentUpdate) method
Section titled “Update(id,deploymentUpdate) method”Summary
Section titled “Summary”Update a deployment
Returns
Section titled “Returns”A Task that resolves to the updated deployment on completion
Parameters
Section titled “Parameters”| Name | Type | Description |
|---|---|---|
| id | System.String | The identifier of the deployment to update |
| deploymentUpdate | TrimbleCloud.Processing.Model.DeploymentUpdate | The value of the deployment to update |
Exceptions
Section titled “Exceptions”| Name | Description |
|---|---|
| System.Exception | Thrown when the deployment cannot be updated |
Engine type
Section titled “Engine type”Namespace
Section titled “Namespace”TrimbleCloud.Processing.Model
Summary
Section titled “Summary”Represents the creation parameters for an engine.
AccountId property
Section titled “AccountId property”Summary
Section titled “Summary”The account ID of the Engine owner
ClientId property
Section titled “ClientId property”Summary
Section titled “Summary”The client ID of the Engine owner
ContainerUpload property
Section titled “ContainerUpload property”Summary
Section titled “Summary”Container upload
Description property
Section titled “Description property”Summary
Section titled “Summary”Engine description
EnvironmentVariables property
Section titled “EnvironmentVariables property”Summary
Section titled “Summary”Environment variables that are stored and ingested into the Engine’s container
Identifier property
Section titled “Identifier property”Summary
Section titled “Summary”Engine identifier, unique within the system
IngestionType property
Section titled “IngestionType property”Summary
Section titled “Summary”Engine ingestion type. Currently the only option is a temporary ACR token upload
Name property
Section titled “Name property”Summary
Section titled “Summary”The name of the Engine. Max 64 chars
OSBuild property
Section titled “OSBuild property”Summary
Section titled “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
Section titled “OSType property”Summary
Section titled “Summary”Engine OS type
Owner property
Section titled “Owner property”Summary
Section titled “Summary”The owner of the Engine
Regions property
Section titled “Regions property”Summary
Section titled “Summary”Engine region
SecretFiles property
Section titled “SecretFiles property”Summary
Section titled “Summary”Secret files
SecretVariables property
Section titled “SecretVariables property”Summary
Section titled “Summary”Secret variables
Status property
Section titled “Status property”Summary
Section titled “Summary”Engine status
StatusMessage property
Section titled “StatusMessage property”Summary
Section titled “Summary”Engine status message
Tag property
Section titled “Tag property”Summary
Section titled “Summary”Engine tag
Trn property
Section titled “Trn property”Summary
Section titled “Summary”TRN value of the Engine
EngineCreate type
Section titled “EngineCreate type”Namespace
Section titled “Namespace”TrimbleCloud.Processing.Model
Summary
Section titled “Summary”Represents the creation parameters for an engine.
Description property
Section titled “Description property”Summary
Section titled “Summary”Engine description
EnvironmentVariables property
Section titled “EnvironmentVariables property”Summary
Section titled “Summary”Environment variables that are stored and ingested into the Engine’s container
Identifier property
Section titled “Identifier property”Summary
Section titled “Summary”Engine identifier, unique within the system
IngestionType property
Section titled “IngestionType property”Summary
Section titled “Summary”Engine ingestion type. Currently the only option is a temporary ACR token upload
Name property
Section titled “Name property”Summary
Section titled “Summary”The name of the Engine. Max 64 chars
OSBuild property
Section titled “OSBuild property”Summary
Section titled “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
Section titled “OSType property”Summary
Section titled “Summary”Engine OS type
Regions property
Section titled “Regions property”Summary
Section titled “Summary”Engine region
SecretFiles property
Section titled “SecretFiles property”Summary
Section titled “Summary”Secret files
SecretVariables property
Section titled “SecretVariables property”Summary
Section titled “Summary”Secret variables
Tag property
Section titled “Tag property”Summary
Section titled “Summary”Engine tag
Validate() method
Section titled “Validate() method”Summary
Section titled “Summary”Validate the engine creation parameters.
Parameters
Section titled “Parameters”This method has no parameters.
Exceptions
Section titled “Exceptions”| Name | Description |
|---|---|
| System.ArgumentException |
EngineListFilter type
Section titled “EngineListFilter type”Namespace
Section titled “Namespace”TrimbleCloud.Processing.Model
Summary
Section titled “Summary”Create Engine List Filters
AccountId property
Section titled “AccountId property”Summary
Section titled “Summary”Filters resources by the Owner’s TID account identifier.
ClientId property
Section titled “ClientId property”Summary
Section titled “Summary”Filters resources by the Owner’s TID subject identifier (client ID).
OSType property
Section titled “OSType property”Summary
Section titled “Summary”Filters a resource based on the Operating System name.
Owner property
Section titled “Owner property”Summary
Section titled “Summary”Filters a resource based on the owner name.
Status property
Section titled “Status property”Summary
Section titled “Summary”Filters a resource based on execution status.
EngineStatus type
Section titled “EngineStatus type”Namespace
Section titled “Namespace”TrimbleCloud.Processing.Model
Summary
Section titled “Summary”Engine status
AVAILABLE constants
Section titled “AVAILABLE constants”Summary
Section titled “Summary”Engine is available
AWAITING_IMAGE_UPLOAD constants
Section titled “AWAITING_IMAGE_UPLOAD constants”Summary
Section titled “Summary”Awaiting image upload
FAILED constants
Section titled “FAILED constants”Summary
Section titled “Summary”Engine is failed
GENERATING_TOKEN constants
Section titled “GENERATING_TOKEN constants”Summary
Section titled “Summary”Generating token
PREPARING constants
Section titled “PREPARING constants”Summary
Section titled “Summary”Image uploaded
RETIRED constants
Section titled “RETIRED constants”Summary
Section titled “Summary”Engine is retired
RETIRING constants
Section titled “RETIRING constants”Summary
Section titled “Summary”Engine is being retired
SUBMITTED constants
Section titled “SUBMITTED constants”Summary
Section titled “Summary”Engine is submitted
UNKNOWN constants
Section titled “UNKNOWN constants”Summary
Section titled “Summary”Unknown status
EngineUpdate type
Section titled “EngineUpdate type”Namespace
Section titled “Namespace”TrimbleCloud.Processing.Model
Summary
Section titled “Summary”Represents the updation parameters for an engine.
Description property
Section titled “Description property”Summary
Section titled “Summary”Engine description
Name property
Section titled “Name property”Summary
Section titled “Summary”The name of the Engine. Max 64 chars
Validate() method
Section titled “Validate() method”Summary
Section titled “Summary”Validate the engine creation parameters.
Parameters
Section titled “Parameters”This method has no parameters.
Exceptions
Section titled “Exceptions”| Name | Description |
|---|---|
| TrimbleCloud.Processing.ValidationException |
EnginesAPI type
Section titled “EnginesAPI type”Namespace
Section titled “Namespace”TrimbleCloud.Processing
Summary
Section titled “Summary”Engines API Resource
Create(engineCreate) method
Section titled “Create(engineCreate) method”Summary
Section titled “Summary”Create an engine
Returns
Section titled “Returns”A Task that resolves to the created engine on completion
Parameters
Section titled “Parameters”| Name | Type | Description |
|---|---|---|
| engineCreate | TrimbleCloud.Processing.Model.EngineCreate | The value of the engine to create |
Exceptions
Section titled “Exceptions”| Name | Description |
|---|---|
| System.Exception | Thrown when an engine cannot be created |
| TrimbleCloud.Processing.ValidationException | Thrown when the engine update is invalid |
Delete(id) method
Section titled “Delete(id) method”Summary
Section titled “Summary”Delete an engine
Returns
Section titled “Returns”An awaitiable Task
Parameters
Section titled “Parameters”| Name | Type | Description |
|---|---|---|
| id | System.String | The identifier of the engine to delete |
Exceptions
Section titled “Exceptions”| Name | Description |
|---|---|
| System.Exception | Thrown when engine cannot be deleted |
Get(id) method
Section titled “Get(id) method”Summary
Section titled “Summary”Get an engine by id
Returns
Section titled “Returns”A Task that resolves to the requested engine on completion
Parameters
Section titled “Parameters”| Name | Type | Description |
|---|---|---|
| id | System.String | The identifier of the engine to read |
Exceptions
Section titled “Exceptions”| Name | Description |
|---|---|
| System.Exception | Thrown when an engine cannot be read |
GetList() method
Section titled “GetList() method”Summary
Section titled “Summary”Get a list of engines
Returns
Section titled “Returns”An asynchronous list of engines
Parameters
Section titled “Parameters”This method has no parameters.
List(page,pageSize,filters) method
Section titled “List(page,pageSize,filters) method”Summary
Section titled “Summary”Get a list of engines
Returns
Section titled “Returns”An asynchronous list of engines
Parameters
Section titled “Parameters”| Name | Type | Description |
|---|---|---|
| page | System.Int32 | The page number |
| pageSize | System.Int32 | The number of items per page |
| filters | TrimbleCloud.Processing.Model.EngineListFilter | The filters to apply |
Retire(id) method
Section titled “Retire(id) method”Summary
Section titled “Summary”Retire an engine
Returns
Section titled “Returns”A Task that resolves to the retired engine on completion
Parameters
Section titled “Parameters”| Name | Type | Description |
|---|---|---|
| id | System.String | The identifier of the engine to retire |
Exceptions
Section titled “Exceptions”| Name | Description |
|---|---|
| System.Exception | Thrown when an engine cannot be retired |
Update(id,engineUpdate) method
Section titled “Update(id,engineUpdate) method”Summary
Section titled “Summary”Update an engine
Returns
Section titled “Returns”A Task that resolves to the updated engine on completion
Parameters
Section titled “Parameters”| Name | Type | Description |
|---|---|---|
| id | System.String | The identifier of the engine to update |
| engineUpdate | TrimbleCloud.Processing.Model.EngineUpdate | The value of the engine to update |
Exceptions
Section titled “Exceptions”| Name | Description |
|---|---|
| System.Exception | Thrown when an engine cannot be updated |
| TrimbleCloud.Processing.ValidationException | Thrown when the engine update is invalid |
EnumConverter`1 type
Section titled “EnumConverter`1 type”Namespace
Section titled “Namespace”TrimbleCloud.Processing
Summary
Section titled “Summary”Generic converter for enums
ReadJson() method
Section titled “ReadJson() method”Summary
Section titled “Summary”Read an enum value from a JSON string
Parameters
Section titled “Parameters”This method has no parameters.
EnumHelper`1 type
Section titled “EnumHelper`1 type”Namespace
Section titled “Namespace”TrimbleCloud.Processing.Helper
Summary
Section titled “Summary”Helper class for Enum
GetEnumMemberValue() method
Section titled “GetEnumMemberValue() method”Summary
Section titled “Summary”Get the EnumMember value of an Enum
Parameters
Section titled “Parameters”This method has no parameters.
EnvironmentVariable type
Section titled “EnvironmentVariable type”Namespace
Section titled “Namespace”TrimbleCloud.Processing.Model
Summary
Section titled “Summary”Represents the environment variables.
Name property
Section titled “Name property”Summary
Section titled “Summary”The name of the environment variable.
Value property
Section titled “Value property”Summary
Section titled “Summary”The value of the environment variable.
Validate() method
Section titled “Validate() method”Summary
Section titled “Summary”Validate the environment variables.
Parameters
Section titled “Parameters”This method has no parameters.
Execution type
Section titled “Execution type”Namespace
Section titled “Namespace”TrimbleCloud.Processing.Model
Summary
Section titled “Summary”Execution model
BoundParameters property
Section titled “BoundParameters property”Summary
Section titled “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
Section titled “CompletedAt property”Summary
Section titled “Summary”The time the execution is completed
DataExport property
Section titled “DataExport property”Summary
Section titled “Summary”Whether or not the execution’s data will be available for export. Default to false.
ExecutionScheduleId property
Section titled “ExecutionScheduleId property”Summary
Section titled “Summary”ID of the execution schedule that created this execution.
ExecutionStatus property
Section titled “ExecutionStatus property”Summary
Section titled “Summary”The logical execution status (READY/NOT_READY/etc.)
FailedAt property
Section titled “FailedAt property”Summary
Section titled “Summary”The time the execution is failed
LatestAttempt property
Section titled “LatestAttempt property”Summary
Section titled “Summary”The latest execution attempt summary
Metadata property
Section titled “Metadata property”Summary
Section titled “Summary”The metadata of the execution.
Parameters property
Section titled “Parameters property”Summary
Section titled “Summary”Mapping of Procedure-specified parameter names to parameter values.
Procedure property
Section titled “Procedure property”Summary
Section titled “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
Section titled “ProcedureId property”Summary
Section titled “Summary”ID of the procedure to execute.
ProcedureIdentifier property
Section titled “ProcedureIdentifier property”Summary
Section titled “Summary”The identifier of the Procedure that supports this Operation.
ProcedureVersion property
Section titled “ProcedureVersion property”Summary
Section titled “Summary”The version of the Procedure that supports this Operation.
Region property
Section titled “Region property”Summary
Section titled “Summary”region where the execution will be run.
Status property
Section titled “Status property”Summary
Section titled “Summary”Execution status
SubmittedAt property
Section titled “SubmittedAt property”Summary
Section titled “Summary”The time the execution was submitted
ExecutionActivity type
Section titled “ExecutionActivity type”Namespace
Section titled “Namespace”TrimbleCloud.Processing.Model
Summary
Section titled “Summary”Execution Activity response class model
ActivityId property
Section titled “ActivityId property”Summary
Section titled “Summary”Activity Id
HistoricalInfo property
Section titled “HistoricalInfo property”Summary
Section titled “Summary”Historical Information about the activity
ExecutionCreate type
Section titled “ExecutionCreate type”Namespace
Section titled “Namespace”TrimbleCloud.Processing.Model
Summary
Section titled “Summary”ExecutionCreate
BoundParameters property
Section titled “BoundParameters property”Summary
Section titled “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
Section titled “DataExport property”Summary
Section titled “Summary”Whether or not the execution’s data will be available for export. Default to false.
Metadata property
Section titled “Metadata property”Summary
Section titled “Summary”The metadata of the execution.
Parameters property
Section titled “Parameters property”Summary
Section titled “Summary”Mapping of Procedure-specified parameter names to parameter values.
ProcedureId property
Section titled “ProcedureId property”Summary
Section titled “Summary”ID of the procedure to execute.
ProcedureIdentifier property
Section titled “ProcedureIdentifier property”Summary
Section titled “Summary”The identifier of the Procedure that supports this Operation.
ProcedureVersion property
Section titled “ProcedureVersion property”Summary
Section titled “Summary”The version of the Procedure that supports this Operation.
Region property
Section titled “Region property”Summary
Section titled “Summary”region where the execution will be run.
ToJson() method
Section titled “ToJson() method”Summary
Section titled “Summary”Converts the object to a JSON string
Parameters
Section titled “Parameters”This method has no parameters.
Validate() method
Section titled “Validate() method”Summary
Section titled “Summary”Validate the creation of an execution
Parameters
Section titled “Parameters”This method has no parameters.
ExecutionEngineRequest type
Section titled “ExecutionEngineRequest type”Namespace
Section titled “Namespace”TrimbleCloud.Processing.Model
Summary
Section titled “Summary”Request payload for posting engine data/logs for an execution.
ExecutionId property
Section titled “ExecutionId property”Summary
Section titled “Summary”The execution identifier.
OutputPath property
Section titled “OutputPath property”Summary
Section titled “Summary”Output path provided by the engine.
Validate() method
Section titled “Validate() method”Summary
Section titled “Summary”Validate the request payload.
Parameters
Section titled “Parameters”This method has no parameters.
ExecutionEvent type
Section titled “ExecutionEvent type”Namespace
Section titled “Namespace”TrimbleCloud.Processing.Model
Summary
Section titled “Summary”Execution Event response class model
Contents property
Section titled “Contents property”Summary
Section titled “Summary”The type of Execution Event that is being described. It can be either object or string.
CreatedAt property
Section titled “CreatedAt property”Summary
Section titled “Summary”Created At
Type property
Section titled “Type property”Summary
Section titled “Summary”The type of Execution Event that is being described.
UpdatedAt property
Section titled “UpdatedAt property”Summary
Section titled “Summary”Updated At
ExecutionListFilter type
Section titled “ExecutionListFilter type”Namespace
Section titled “Namespace”TrimbleCloud.Processing.Model
Summary
Section titled “Summary”Execution List Filters
CompletedAfter property
Section titled “CompletedAfter property”Summary
Section titled “Summary”Filter results that have a completed_at time that is after the supplied value.
CompletedBefore property
Section titled “CompletedBefore property”Summary
Section titled “Summary”Filter results that have a completed_at time that is before the supplied value.
CreatedAfter property
Section titled “CreatedAfter property”Summary
Section titled “Summary”Filter results that have a created_at time that is after the supplied value.
CreatedBefore property
Section titled “CreatedBefore property”Summary
Section titled “Summary”Filter results that have a created_at time that is before the supplied value.
ExecutionStatus property
Section titled “ExecutionStatus property”Summary
Section titled “Summary”Filters a resource based on execution status.
ProcedureId property
Section titled “ProcedureId property”Summary
Section titled “Summary”Filters a resource based on the procedure identifier.
SortBy property
Section titled “SortBy property”Summary
Section titled “Summary”Sort by field
ExecutionProgressStatus type
Section titled “ExecutionProgressStatus type”Namespace
Section titled “Namespace”TrimbleCloud.Processing.Model.Execution
Summary
Section titled “Summary”Execution status enumeration
EXECUTING constants
Section titled “EXECUTING constants”Summary
Section titled “Summary”Execution is currently being executed
FAILED constants
Section titled “FAILED constants”Summary
Section titled “Summary”Execution has failed
FINISHED constants
Section titled “FINISHED constants”Summary
Section titled “Summary”Execution has been completed
QUEUED constants
Section titled “QUEUED constants”Summary
Section titled “Summary”Execution is queued
SUBMITTED constants
Section titled “SUBMITTED constants”Summary
Section titled “Summary”Execution has been submitted and is waiting to be processed
UNKNOWN constants
Section titled “UNKNOWN constants”Summary
Section titled “Summary”Unknown status
UNSUBMITTED constants
Section titled “UNSUBMITTED constants”Summary
Section titled “Summary”Execution has not been submitted yet
WAITING constants
Section titled “WAITING constants”Summary
Section titled “Summary”Execution is currently being waited
ExecutionSortBy type
Section titled “ExecutionSortBy type”Namespace
Section titled “Namespace”TrimbleCloud.Processing.Model
Summary
Section titled “Summary”Sort options for execution list
CompletedAtAscending constants
Section titled “CompletedAtAscending constants”Summary
Section titled “Summary”Sort by completed_at in ascending order
CompletedAtDescending constants
Section titled “CompletedAtDescending constants”Summary
Section titled “Summary”Sort by completed_at in descending order
CreatedAtAscending constants
Section titled “CreatedAtAscending constants”Summary
Section titled “Summary”Sort by created_at in ascending order
CreatedAtDescending constants
Section titled “CreatedAtDescending constants”Summary
Section titled “Summary”Sort by created_at in descending order
ExecutionStatus type
Section titled “ExecutionStatus type”Namespace
Section titled “Namespace”TrimbleCloud.Processing.Model
Summary
Section titled “Summary”The execution status of the operation.
NOT_READY constants
Section titled “NOT_READY constants”Summary
Section titled “Summary”This Operation cannot be used to create any Procedures and thus cannot be part of an execution.
READY constants
Section titled “READY constants”Summary
Section titled “Summary”This Operation can now by used to create Procedures and thus be part of executions.
SUSPENDED constants
Section titled “SUSPENDED constants”Summary
Section titled “Summary”The processing of this Operation has been suspended and cannot be part of executions.
UNKNOWN constants
Section titled “UNKNOWN constants”Summary
Section titled “Summary”Unknown status
ExecutionsAPI type
Section titled “ExecutionsAPI type”Namespace
Section titled “Namespace”TrimbleCloud.Processing
Summary
Section titled “Summary”API Methods relating to Trimble Cloud Platform Processing Framework executions
Create(executionCreate) method
Section titled “Create(executionCreate) method”Summary
Section titled “Summary”Create an execution
Returns
Section titled “Returns”A Task that resolves to the created execution on completion
Parameters
Section titled “Parameters”| Name | Type | Description |
|---|---|---|
| executionCreate | TrimbleCloud.Processing.Model.ExecutionCreate | The value of the execution to create |
Exceptions
Section titled “Exceptions”| Name | Description |
|---|---|
| System.Exception | Thrown when an execution cannot be created |
Get(id,details) method
Section titled “Get(id,details) method”Summary
Section titled “Summary”Get an execution by id
Returns
Section titled “Returns”A Task that resolves to the requested execution on completion
Parameters
Section titled “Parameters”| Name | Type | Description |
|---|---|---|
| id | System.String | The identifier of the execution to read |
| details | System.Nullable{System.Boolean} | Optional flag to request detailed view |
Exceptions
Section titled “Exceptions”| Name | Description |
|---|---|
| System.Exception | Thrown when an execution cannot be read |
GetExecutionData(engineDataRequest) method
Section titled “GetExecutionData(engineDataRequest) method”Summary
Section titled “Summary”Post engine data for executions
Returns
Section titled “Returns”A Task that resolves to the execution response on completion
Parameters
Section titled “Parameters”| Name | Type | Description |
|---|---|---|
| engineDataRequest | TrimbleCloud.Processing.Model.ExecutionEngineRequest | Engine data request payload |
GetExecutionLogs(engineLogsRequest) method
Section titled “GetExecutionLogs(engineLogsRequest) method”Summary
Section titled “Summary”Post engine logs for executions
Returns
Section titled “Returns”A Task that resolves to the execution response on completion
Parameters
Section titled “Parameters”| Name | Type | Description |
|---|---|---|
| engineLogsRequest | TrimbleCloud.Processing.Model.ExecutionEngineRequest | Engine logs request payload |
List(page,pageSize,filters) method
Section titled “List(page,pageSize,filters) method”Summary
Section titled “Summary”Get a list of executions
Returns
Section titled “Returns”An asynchronous list of executions
Parameters
Section titled “Parameters”| Name | Type | Description |
|---|---|---|
| page | System.Int32 | The page number to retrieve |
| pageSize | System.Int32 | The number of items per page |
| filters | TrimbleCloud.Processing.Model.ExecutionListFilter | The filters to apply to the list |
ListActivities(executionId,page,pageSize) method
Section titled “ListActivities(executionId,page,pageSize) method”Summary
Section titled “Summary”Get a list of execution activities
Returns
Section titled “Returns”An asynchronous list of execution activities
Parameters
Section titled “Parameters”| Name | Type | Description |
|---|---|---|
| executionId | System.String | The identifier of the execution to retrieve activities for |
| page | System.Int32 | The page number to retrieve |
| pageSize | System.Int32 | The number of items per page |
ListEvents(executionId,page,pageSize) method
Section titled “ListEvents(executionId,page,pageSize) method”Summary
Section titled “Summary”Get the events tied to an Execution. Events are logged by the Log Events for an Execution request.
Returns
Section titled “Returns”An asynchronous list of execution events
Parameters
Section titled “Parameters”| Name | Type | Description |
|---|---|---|
| executionId | System.String | The identifier of the execution to retrieve activities for |
| page | System.Int32 | The page number to retrieve |
| pageSize | System.Int32 | The number of items per page |
HistoricalInfo type
Section titled “HistoricalInfo type”Namespace
Section titled “Namespace”TrimbleCloud.Processing.Model
Summary
Section titled “Summary”Historical Info class
ActivityTaskCompleted property
Section titled “ActivityTaskCompleted property”Summary
Section titled “Summary”Activity Task Completed
ActivityTaskScheduled property
Section titled “ActivityTaskScheduled property”Summary
Section titled “Summary”Activity Task Scheduled
ActivityTaskStarted property
Section titled “ActivityTaskStarted property”Summary
Section titled “Summary”Activity Task Started
HttpClientResponse type
Section titled “HttpClientResponse type”Namespace
Section titled “Namespace”TrimbleCloud.Processing
Summary
Section titled “Summary”HTTP client response implementation for the common Response class
#ctor(requestId,responseMessage) constructor
Section titled “#ctor(requestId,responseMessage) constructor”Summary
Section titled “Summary”Initializes a new instance of the HttpClientResponse class
Parameters
Section titled “Parameters”| Name | Type | Description |
|---|---|---|
| requestId | System.String | The request ID |
| responseMessage | System.Net.Http.HttpResponseMessage | The HTTP response message |
ContentLength property
Section titled “ContentLength property”Summary
Section titled “Summary”Gets the content length of the response
IsError property
Section titled “IsError property”Summary
Section titled “Summary”Gets a value indicating whether this response represents an error
Metadata property
Section titled “Metadata property”Summary
Section titled “Summary”Gets the response headers as metadata
ReasonPhrase property
Section titled “ReasonPhrase property”Summary
Section titled “Summary”Gets the HTTP reason phrase
RequestId property
Section titled “RequestId property”Summary
Section titled “Summary”Gets or sets the request ID
Status property
Section titled “Status property”Summary
Section titled “Summary”Gets the HTTP status code
Dispose() method
Section titled “Dispose() method”Summary
Section titled “Summary”Disposes the underlying HTTP response message
Parameters
Section titled “Parameters”This method has no parameters.
ToString() method
Section titled “ToString() method”Summary
Section titled “Summary”Returns the string representation of the HTTP response
Returns
Section titled “Returns”String representation of the response
Parameters
Section titled “Parameters”This method has no parameters.
IPage`1 type
Section titled “IPage`1 type”Namespace
Section titled “Namespace”TrimbleCloud.Processing
Summary
Section titled “Summary”Defines a page interface
Generic Types
Section titled “Generic Types”| Name | Description |
|---|---|
| T | The type of item in the page. |
CurrentPage property
Section titled “CurrentPage property”Summary
Section titled “Summary”The number of items in the page.
Items property
Section titled “Items property”Summary
Section titled “Summary”The items in the page.
PageSize property
Section titled “PageSize property”Summary
Section titled “Summary”The number of items per page.
TotalItems property
Section titled “TotalItems property”Summary
Section titled “Summary”The total number of items available.
TotalPages property
Section titled “TotalPages property”Summary
Section titled “Summary”The total number of pages available.
IngestionType type
Section titled “IngestionType type”Namespace
Section titled “Namespace”TrimbleCloud.Processing.Model
Summary
Section titled “Summary”Ingestion type
ACRToken constants
Section titled “ACRToken constants”Summary
Section titled “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
Section titled “Unknown constants”Summary
Section titled “Summary”Unknown status
Input type
Section titled “Input type”Namespace
Section titled “Namespace”TrimbleCloud.Processing.Model
Summary
Section titled “Summary”Input parameters for an operation
DataTypes property
Section titled “DataTypes property”Summary
Section titled “Summary”List of accepted input data types.
Description property
Section titled “Description property”Summary
Section titled “Summary”Description of the input
Name property
Section titled “Name property”Summary
Section titled “Summary”Name of the input
Optional property
Section titled “Optional property”Summary
Section titled “Summary”Is the parameter optional. Defaults to false
Validate() method
Section titled “Validate() method”Summary
Section titled “Summary”Validate the inputs
Parameters
Section titled “Parameters”This method has no parameters.
ListFilterBase type
Section titled “ListFilterBase type”Namespace
Section titled “Namespace”TrimbleCloud.Processing.Model
Summary
Section titled “Summary”List Filter Base
Identifier property
Section titled “Identifier property”Summary
Section titled “Summary”Identifier of the resource
Region property
Section titled “Region property”Summary
Section titled “Summary”Region
OSType type
Section titled “OSType type”Namespace
Section titled “Namespace”TrimbleCloud.Processing.Model
Summary
Section titled “Summary”OS Type
Linux constants
Section titled “Linux constants”Summary
Section titled “Summary”Create a linux Engine.
Unknown constants
Section titled “Unknown constants”Summary
Section titled “Summary”Unknown status
Windows constants
Section titled “Windows constants”Summary
Section titled “Summary”Create a windows Engine.
OpInput type
Section titled “OpInput type”Namespace
Section titled “Namespace”TrimbleCloud.Processing.Model
Summary
Section titled “Summary”Operation input class
OpInput type
Section titled “OpInput type”Namespace
Section titled “Namespace”TrimbleCloud.Processing.Model.Procedure.OperationChain
Summary
Section titled “Summary”Operation input class
DataTypes property
Section titled “DataTypes property”Sources property
Section titled “Sources property”DataTypes property
Section titled “DataTypes property”Sources property
Section titled “Sources property”OpOutput type
Section titled “OpOutput type”Namespace
Section titled “Namespace”TrimbleCloud.Processing.Model
Summary
Section titled “Summary”Operation output class
OpOutput type
Section titled “OpOutput type”Namespace
Section titled “Namespace”TrimbleCloud.Processing.Model.Procedure.OperationChain
Summary
Section titled “Summary”Operation output class
DataType property
Section titled “DataType property”Description property
Section titled “Description property”Name property
Section titled “Name property”DataType property
Section titled “DataType property”Description property
Section titled “Description property”Name property
Section titled “Name property”OpParamater type
Section titled “OpParamater type”Namespace
Section titled “Namespace”TrimbleCloud.Processing.Model.Procedure.OperationChain
Summary
Section titled “Summary”Operation parameter class
Optional property
Section titled “Optional property”Summary
Section titled “Summary”Is the parameter optional. Defaults to false
Source property
Section titled “Source property”Summary
Section titled “Summary”The source of the Operation parameter
OpParameter type
Section titled “OpParameter type”Namespace
Section titled “Namespace”TrimbleCloud.Processing.Model
Summary
Section titled “Summary”Operation parameter class
Optional property
Section titled “Optional property”Summary
Section titled “Summary”Is the parameter optional. Defaults to false
Source property
Section titled “Source property”Summary
Section titled “Summary”The source of the Operation parameter
Operation type
Section titled “Operation type”Namespace
Section titled “Namespace”TrimbleCloud.Processing.Model
Summary
Section titled “Summary”Operation model
AccountId property
Section titled “AccountId property”Summary
Section titled “Summary”The account ID of the Operation owner
ClientId property
Section titled “ClientId property”Summary
Section titled “Summary”The client ID of the Operation owner
DeploymentIdentifier property
Section titled “DeploymentIdentifier property”Summary
Section titled “Summary”The identifier of the Deployment that supports this Operation.
DeprecationMessage property
Section titled “DeprecationMessage property”Summary
Section titled “Summary”Message given to indicate impending retirement/deprecation
Description property
Section titled “Description property”Summary
Section titled “Summary”The description of the operation.
DynamicOutput property
Section titled “DynamicOutput property”Summary
Section titled “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
Section titled “EngineName property”Summary
Section titled “Summary”The name of the backend engine that supports this Operation. (Deprecated: Use DeploymentIdentifier instead.)
ExecutionStatus property
Section titled “ExecutionStatus property”Summary
Section titled “Summary”The execution status of the operation.
Identifier property
Section titled “Identifier property”Summary
Section titled “Summary”The identifier of the operation.
Inputs property
Section titled “Inputs property”Summary
Section titled “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
Section titled “IsPublic property”Summary
Section titled “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
Section titled “Name property”Summary
Section titled “Summary”The name of the operation.
OutputParameters property
Section titled “OutputParameters property”Summary
Section titled “Summary”A list of parameter objects that define values to be output from an Operation.
Outputs property
Section titled “Outputs property”Summary
Section titled “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
Section titled “Owner property”Summary
Section titled “Summary”The owner of the Operation
Parameters property
Section titled “Parameters property”Summary
Section titled “Summary”A list of parameter objects attached to the Operation.
Regions property
Section titled “Regions property”Summary
Section titled “Summary”Allowable locations that a particular Operation can run in.
RetriedAfter property
Section titled “RetriedAfter property”Summary
Section titled “Summary”Timestamp indicating when this Operation will move to RETIRED status, and will no longer be executable
SharedWith property
Section titled “SharedWith property”Summary
Section titled “Summary”List of names of Users with whom this Operation has been shared.
SharedWithEntries property
Section titled “SharedWithEntries property”Summary
Section titled “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
Section titled “Status property”Summary
Section titled “Summary”The status of the operation.
Version property
Section titled “Version property”Summary
Section titled “Summary”The version of the operation.
OperationChain type
Section titled “OperationChain type”Namespace
Section titled “Namespace”TrimbleCloud.Processing.Model
Summary
Section titled “Summary”OperationChain class
OperationChain type
Section titled “OperationChain type”Namespace
Section titled “Namespace”TrimbleCloud.Processing.Model.Procedure
Summary
Section titled “Summary”OperationChain class
Description property
Section titled “Description property”Summary
Section titled “Summary”The description of the operation.
EngineName property
Section titled “EngineName property”Summary
Section titled “Summary”name of the Engine
Identifier property
Section titled “Identifier property”Summary
Section titled “Summary”The identifier of the operation.
Inputs property
Section titled “Inputs property”Name property
Section titled “Name property”Summary
Section titled “Summary”The name of the operation.
OutputParameters property
Section titled “OutputParameters property”Summary
Section titled “Summary”A list of parameter objects that define values to be output from an Operation.
Parameters property
Section titled “Parameters property”Version property
Section titled “Version property”Summary
Section titled “Summary”The version of the operation.
Description property
Section titled “Description property”Summary
Section titled “Summary”The description of the operation.
EncryptedParameters property
Section titled “EncryptedParameters property”Summary
Section titled “Summary”List of encrypted parameters
EngineName property
Section titled “EngineName property”Summary
Section titled “Summary”name of the Engine
Identifier property
Section titled “Identifier property”Summary
Section titled “Summary”The identifier of the operation.
Inputs property
Section titled “Inputs property”Name property
Section titled “Name property”Summary
Section titled “Summary”The name of the operation.
OutputParameters property
Section titled “OutputParameters property”Summary
Section titled “Summary”A list of parameter objects that define values to be output from an Operation.
Outputs property
Section titled “Outputs property”Parameters property
Section titled “Parameters property”Version property
Section titled “Version property”Summary
Section titled “Summary”The version of the operation.
Validate() method
Section titled “Validate() method”Summary
Section titled “Summary”Validate the Operation object.
Parameters
Section titled “Parameters”This method has no parameters.
Exceptions
Section titled “Exceptions”| Name | Description |
|---|---|
| TrimbleCloud.Processing.ValidationException |
OperationCreate type
Section titled “OperationCreate type”Namespace
Section titled “Namespace”TrimbleCloud.Processing.Model
Summary
Section titled “Summary”Represents OperationCreate.
DeploymentIdentifier property
Section titled “DeploymentIdentifier property”Summary
Section titled “Summary”The identifier of the Deployment that supports this Operation.
Description property
Section titled “Description property”Summary
Section titled “Summary”The description of the operation.
DynamicOutput property
Section titled “DynamicOutput property”Summary
Section titled “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
Section titled “EngineName property”Summary
Section titled “Summary”The name of the backend engine that supports this Operation. (Deprecated: Use DeploymentIdentifier instead.)
Identifier property
Section titled “Identifier property”Summary
Section titled “Summary”The identifier of the operation.
Inputs property
Section titled “Inputs property”Summary
Section titled “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
Section titled “IsPublic property”Summary
Section titled “Summary”The state of the Operation’s publication. (Deprecated: Use Publish method to make an Operation public.)
Name property
Section titled “Name property”Summary
Section titled “Summary”The name of the operation.
OutputParameters property
Section titled “OutputParameters property”Summary
Section titled “Summary”A list of parameter objects that define values to be output from an Operation.
Outputs property
Section titled “Outputs property”Summary
Section titled “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
Section titled “Parameters property”Summary
Section titled “Summary”A list of parameter objects attached to the Operation.
Regions property
Section titled “Regions property”Summary
Section titled “Summary”Allowable locations that a particular Operation can run in.
SharedWith property
Section titled “SharedWith property”Summary
Section titled “Summary”List of names of Users with whom this Operation has been shared.
SharedWithEntries property
Section titled “SharedWithEntries property”Summary
Section titled “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
Section titled “Version property”Summary
Section titled “Summary”The version of the operation.
Validate() method
Section titled “Validate() method”Summary
Section titled “Summary”Validate the operation creation parameters.
Parameters
Section titled “Parameters”This method has no parameters.
OperationListFilter type
Section titled “OperationListFilter type”Namespace
Section titled “Namespace”TrimbleCloud.Processing.Model
Summary
Section titled “Summary”Operation List Filters
DeploymentIdentifier property
Section titled “DeploymentIdentifier property”Summary
Section titled “Summary”Filters a resource based on the Deployment identifier.
EngineName property
Section titled “EngineName property”Summary
Section titled “Summary”Filters a resource based on the Engine name.
ExecutionStatus property
Section titled “ExecutionStatus property”Summary
Section titled “Summary”Filters a resource based on execution status.
ProcedureId property
Section titled “ProcedureId property”Summary
Section titled “Summary”Filters a resource based on the Procedure identifier.
Public property
Section titled “Public property”Summary
Section titled “Summary”Filters results by public status
Status property
Section titled “Status property”Summary
Section titled “Summary”Filters a resource based on status
OperationUpdate type
Section titled “OperationUpdate type”Namespace
Section titled “Namespace”TrimbleCloud.Processing.Model
Summary
Section titled “Summary”Represents OperationUpdate.
DeploymentIdentifier property
Section titled “DeploymentIdentifier property”Summary
Section titled “Summary”The identifier of the Deployment that supports this Operation.
Description property
Section titled “Description property”Summary
Section titled “Summary”The description of the operation.
DynamicOutput property
Section titled “DynamicOutput property”Summary
Section titled “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
Section titled “EngineName property”Summary
Section titled “Summary”The name of the backend engine that supports this Operation. (Deprecated: Use DeploymentIdentifier instead.)
Identifier property
Section titled “Identifier property”Summary
Section titled “Summary”The identifier of the operation.
Inputs property
Section titled “Inputs property”Summary
Section titled “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
Section titled “IsPublic property”Summary
Section titled “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
Section titled “Name property”Summary
Section titled “Summary”The name of the operation.
OutputParameters property
Section titled “OutputParameters property”Summary
Section titled “Summary”A list of parameter objects that define values to be output from an Operation.
Outputs property
Section titled “Outputs property”Summary
Section titled “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
Section titled “Parameters property”Summary
Section titled “Summary”A list of parameter objects attached to the Operation.
Regions property
Section titled “Regions property”Summary
Section titled “Summary”Allowable locations that a particular Operation can run in.
SharedWith property
Section titled “SharedWith property”Summary
Section titled “Summary”List of names of Users with whom this Operation has been shared.
SharedWithEntries property
Section titled “SharedWithEntries property”Summary
Section titled “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
Section titled “Version property”Summary
Section titled “Summary”The version of the operation.
Validate() method
Section titled “Validate() method”Summary
Section titled “Summary”Validate the operation creation parameters.
Parameters
Section titled “Parameters”This method has no parameters.
OperationsAPI type
Section titled “OperationsAPI type”Namespace
Section titled “Namespace”TrimbleCloud.Processing
Summary
Section titled “Summary”API Methods relating to Trimble Cloud Platform Processing Framework operations
Approve(id) method
Section titled “Approve(id) method”Summary
Section titled “Summary”Approve an operation
Returns
Section titled “Returns”A Task that resolves to the approved operation on completion
Parameters
Section titled “Parameters”| Name | Type | Description |
|---|---|---|
| id | System.String | The identifier of the operation to approve |
Exceptions
Section titled “Exceptions”| Name | Description |
|---|---|
| System.Exception | Thrown when a operation cannot be approved |
Clone(id) method
Section titled “Clone(id) method”Summary
Section titled “Summary”Clone an operation
Returns
Section titled “Returns”A Task that resolves to the newly cloned operation on completion
Parameters
Section titled “Parameters”| Name | Type | Description |
|---|---|---|
| id | System.String | The identifier of the operation to clone |
Exceptions
Section titled “Exceptions”| Name | Description |
|---|---|
| System.Exception | Thrown when a operation cannot be cloned |
Create(operationCreate) method
Section titled “Create(operationCreate) method”Summary
Section titled “Summary”Create an operation
Returns
Section titled “Returns”A Task that resolves to the created operation on completion
Parameters
Section titled “Parameters”| Name | Type | Description |
|---|---|---|
| operationCreate | TrimbleCloud.Processing.Model.OperationCreate | The value of the operation to create |
Exceptions
Section titled “Exceptions”| Name | Description |
|---|---|
| System.Exception | Thrown when an operation cannot be created |
| TrimbleCloud.Processing.ValidationException | Thrown when the operation update is invalid |
Delete(id) method
Section titled “Delete(id) method”Summary
Section titled “Summary”Delete an operation
Returns
Section titled “Returns”An awaitiable Task
Parameters
Section titled “Parameters”| Name | Type | Description |
|---|---|---|
| id | System.String | The identifier of the operation to delete |
Exceptions
Section titled “Exceptions”| Name | Description |
|---|---|
| System.Exception | Thrown when a operation cannot be deleted |
Get(id) method
Section titled “Get(id) method”Summary
Section titled “Summary”Get an operation by id
Returns
Section titled “Returns”A Task that resolves to the requested operation on completion
Parameters
Section titled “Parameters”| Name | Type | Description |
|---|---|---|
| id | System.String | The identifier of the operation to read |
Exceptions
Section titled “Exceptions”| Name | Description |
|---|---|
| System.Exception | Thrown when a operation cannot be read |
GetList(include_public) method
Section titled “GetList(include_public) method”Summary
Section titled “Summary”Get a list of operations
Returns
Section titled “Returns”An asynchronous list of operations
Parameters
Section titled “Parameters”| Name | Type | Description |
|---|---|---|
| include_public | System.Boolean | Whether to include public operations in the returned list |
List(page,pageSize,filters) method
Section titled “List(page,pageSize,filters) method”Summary
Section titled “Summary”Get a list of operations
Returns
Section titled “Returns”An asynchronous list of operations
Parameters
Section titled “Parameters”| Name | Type | Description |
|---|---|---|
| page | System.Int32 | The page number to retrieve |
| pageSize | System.Int32 | The number of items per page |
| filters | TrimbleCloud.Processing.Model.OperationListFilter | The filters to apply to the list |
Publish(id) method
Section titled “Publish(id) method”Summary
Section titled “Summary”Publish an operation
Returns
Section titled “Returns”A Task that resolves to the published operation on completion
Parameters
Section titled “Parameters”| Name | Type | Description |
|---|---|---|
| id | System.String | The identifier of the operation to publish |
Exceptions
Section titled “Exceptions”| Name | Description |
|---|---|
| System.Exception | Thrown when a operation cannot be published |
Retire(id) method
Section titled “Retire(id) method”Summary
Section titled “Summary”Retire an operation
Returns
Section titled “Returns”A Task that resolves to the retired operation on completion
Parameters
Section titled “Parameters”| Name | Type | Description |
|---|---|---|
| id | System.String | The identifier of the operation to retire |
Exceptions
Section titled “Exceptions”| Name | Description |
|---|---|
| System.Exception | Thrown when a operation cannot be retired |
Update(id,operationUpdate) method
Section titled “Update(id,operationUpdate) method”Summary
Section titled “Summary”Update an operation
Returns
Section titled “Returns”A Task that resolves to the updated operation on completion
Parameters
Section titled “Parameters”| Name | Type | Description |
|---|---|---|
| id | System.String | The identifier of the operation to update |
| operationUpdate | TrimbleCloud.Processing.Model.OperationUpdate | The value of the operation to update |
Exceptions
Section titled “Exceptions”| Name | Description |
|---|---|
| System.Exception | Thrown when a operation cannot be updated |
| TrimbleCloud.Processing.ValidationException | Thrown when the operation update is invalid |
Output type
Section titled “Output type”Namespace
Section titled “Namespace”TrimbleCloud.Processing.Model
Summary
Section titled “Summary”Input parameters for an operation
DataType property
Section titled “DataType property”Summary
Section titled “Summary”Type of data output from the Operation
Description property
Section titled “Description property”Summary
Section titled “Summary”Description of the output
Name property
Section titled “Name property”Summary
Section titled “Summary”Name of the output
Validate() method
Section titled “Validate() method”Summary
Section titled “Summary”Validate the output
Parameters
Section titled “Parameters”This method has no parameters.
OutputParameter type
Section titled “OutputParameter type”Namespace
Section titled “Namespace”TrimbleCloud.Processing.Model
Summary
Section titled “Summary”Represents a OutputParameter.
Description property
Section titled “Description property”Summary
Section titled “Summary”A description of the parameter
Name property
Section titled “Name property”Summary
Section titled “Summary”Human-readable name for the parameter.
Optional property
Section titled “Optional property”Summary
Section titled “Summary”Is the parameter optional. Defaults to false
Type property
Section titled “Type property”Summary
Section titled “Summary”The type of the parameter.
Validate() method
Section titled “Validate() method”Summary
Section titled “Summary”Validate the parameter.
Parameters
Section titled “Parameters”This method has no parameters.
Exceptions
Section titled “Exceptions”| Name | Description |
|---|---|
| TrimbleCloud.Processing.ValidationException |
Page`1 type
Section titled “Page`1 type”Namespace
Section titled “Namespace”TrimbleCloud.Processing
Summary
Section titled “Summary”Defines a page in responses.
Generic Types
Section titled “Generic Types”| Name | Description |
|---|---|
| T | Type of the page content items |
CurrentPage property
Section titled “CurrentPage property”Summary
Section titled “Summary”The number of items in the page.
Items property
Section titled “Items property”Summary
Section titled “Summary”The items in the page.
PageSize property
Section titled “PageSize property”Summary
Section titled “Summary”The number of items per page.
TotalItems property
Section titled “TotalItems property”Summary
Section titled “Summary”The total number of items available.
TotalPages property
Section titled “TotalPages property”Summary
Section titled “Summary”The total number of pages available.
GetEnumerator() method
Section titled “GetEnumerator() method”Summary
Section titled “Summary”Returns an enumerator that iterates through the collection.
Returns
Section titled “Returns”A an enumerator that can be used to iterate through the collection.
Parameters
Section titled “Parameters”This method has no parameters.
System#Collections#IEnumerable#GetEnumerator() method
Section titled “System#Collections#IEnumerable#GetEnumerator() method”Summary
Section titled “Summary”Returns an enumerator that iterates through the collection.
Returns
Section titled “Returns”A an enumerator that can be used to iterate through the collection.
Parameters
Section titled “Parameters”This method has no parameters.
Parameter type
Section titled “Parameter type”Namespace
Section titled “Namespace”TrimbleCloud.Processing.Model
Summary
Section titled “Summary”Represents a parameter.
Description property
Section titled “Description property”Summary
Section titled “Summary”A description of the parameter
Encrypted property
Section titled “Encrypted property”Summary
Section titled “Summary”Indicates that the parameter contains sensitive information. Defaults to false
Name property
Section titled “Name property”Summary
Section titled “Summary”Human-readable name for the parameter.
Optional property
Section titled “Optional property”Summary
Section titled “Summary”Is the parameter optional. Defaults to false
Options property
Section titled “Options property”Summary
Section titled “Summary”List of options for the parameter
Type property
Section titled “Type property”Summary
Section titled “Summary”The type of the parameter.
Validate() method
Section titled “Validate() method”Summary
Section titled “Summary”Validate the parameter.
Parameters
Section titled “Parameters”This method has no parameters.
Exceptions
Section titled “Exceptions”| Name | Description |
|---|---|
| TrimbleCloud.Processing.ValidationException |
Procedure type
Section titled “Procedure type”Namespace
Section titled “Namespace”TrimbleCloud.Processing.Model
Summary
Section titled “Summary”Procedure model
AccountId property
Section titled “AccountId property”Summary
Section titled “Summary”The account ID of the Procedure owner
ClientId property
Section titled “ClientId property”Summary
Section titled “Summary”The client ID of the Procedure owner
DefaultRegion property
Section titled “DefaultRegion property”Summary
Section titled “Summary”The default region for the Procedure
Description property
Section titled “Description property”Summary
Section titled “Summary”Description of the Procedure
DocumentationUrl property
Section titled “DocumentationUrl property”Summary
Section titled “Summary”URL to external documentation for the Procedure
ExecutionStatus property
Section titled “ExecutionStatus property”Summary
Section titled “Summary”The execution status of the Procedure
Identifier property
Section titled “Identifier property”Summary
Section titled “Summary”Identifier of the Procedure
IsPublic property
Section titled “IsPublic property”Summary
Section titled “Summary”IsPublic
Name property
Section titled “Name property”Summary
Section titled “Summary”The name of the Procedure
Operations property
Section titled “Operations property”Remarks
Section titled “Remarks”This is the definition of Procedure contents and how inputs & outputs are linked together between individual Operations
Owner property
Section titled “Owner property”Summary
Section titled “Summary”The owner of the Procedure
Parameters property
Section titled “Parameters property”Remarks
Section titled “Remarks”The user will specify parameter values via these mapping names
Regions property
Section titled “Regions property”Summary
Section titled “Summary”regions
RetriedAfter property
Section titled “RetriedAfter property”Summary
Section titled “Summary”Timestamp indicating when this Operation will move to RETIRED status, and will no longer be executable
SharedWith property
Section titled “SharedWith property”Summary
Section titled “Summary”List of names of Users with whom this Procedure has been shared.
SharedWithEntries property
Section titled “SharedWithEntries property”Summary
Section titled “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
Section titled “Status property”Summary
Section titled “Summary”The status of the Procedure
Tags property
Section titled “Tags property”Summary
Section titled “Summary”List of tags (as strings) associated with the Procedure.
Version property
Section titled “Version property”Summary
Section titled “Summary”The version of the Procedure
ProcedureCreate type
Section titled “ProcedureCreate type”Namespace
Section titled “Namespace”TrimbleCloud.Processing.Model
Summary
Section titled “Summary”ProcedureCreate model
DefaultRegion property
Section titled “DefaultRegion property”Summary
Section titled “Summary”The default region for the Procedure
Description property
Section titled “Description property”Summary
Section titled “Summary”Description of the Procedure
DocumentationUrl property
Section titled “DocumentationUrl property”Summary
Section titled “Summary”URL to external documentation for the Procedure
Identifier property
Section titled “Identifier property”Summary
Section titled “Summary”Identifier of the Procedure
Name property
Section titled “Name property”Summary
Section titled “Summary”The name of the Procedure
Operations property
Section titled “Operations property”Remarks
Section titled “Remarks”This is the definition of Procedure contents and how inputs & outputs are linked together between individual Operations
ProcedureParameters property
Section titled “ProcedureParameters property”Remarks
Section titled “Remarks”The user will specify parameter values via these mapping names
SharedWith property
Section titled “SharedWith property”Summary
Section titled “Summary”List of names of Users with whom this Procedure has been shared.
SharedWithEntries property
Section titled “SharedWithEntries property”Summary
Section titled “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
Section titled “Tags property”Summary
Section titled “Summary”List of tags (as strings) associated with the Procedure.
Version property
Section titled “Version property”Summary
Section titled “Summary”The version of the Procedure
Validate() method
Section titled “Validate() method”Summary
Section titled “Summary”Validate the ProcedureCreate object.
Parameters
Section titled “Parameters”This method has no parameters.
Exceptions
Section titled “Exceptions”| Name | Description |
|---|---|
| TrimbleCloud.Processing.ValidationException |
ProcedureListFilter type
Section titled “ProcedureListFilter type”Namespace
Section titled “Namespace”TrimbleCloud.Processing.Model
Summary
Section titled “Summary”Procedure List Filters
ExecutionStatus property
Section titled “ExecutionStatus property”Summary
Section titled “Summary”Filters a resource based on execution status.
OperationId property
Section titled “OperationId property”Summary
Section titled “Summary”Filters a resource based on the operation id.
Public property
Section titled “Public property”Summary
Section titled “Summary”Filters results by public status
Status property
Section titled “Status property”Summary
Section titled “Summary”Filters a resource based on status
ProcedureParameter type
Section titled “ProcedureParameter type”Namespace
Section titled “Namespace”TrimbleCloud.Processing.Model
Summary
Section titled “Summary”Parmeter class
DefaultValue property
Section titled “DefaultValue property”Description property
Section titled “Description property”Name property
Section titled “Name property”Source property
Section titled “Source property”Type property
Section titled “Type property”Value property
Section titled “Value property”ProcedureUpdate type
Section titled “ProcedureUpdate type”Namespace
Section titled “Namespace”TrimbleCloud.Processing.Model
Summary
Section titled “Summary”ProcedureUpdate model
DefaultRegion property
Section titled “DefaultRegion property”Summary
Section titled “Summary”The default region for the Procedure
Description property
Section titled “Description property”Summary
Section titled “Summary”Description of the Procedure
DocumentationUrl property
Section titled “DocumentationUrl property”Summary
Section titled “Summary”URL to external documentation for the Procedure
Identifier property
Section titled “Identifier property”Summary
Section titled “Summary”Identifier of the Procedure
Name property
Section titled “Name property”Summary
Section titled “Summary”The name of the Procedure
Operations property
Section titled “Operations property”Remarks
Section titled “Remarks”This is the definition of Procedure contents and how inputs & outputs are linked together between individual Operations
ProcedureParameters property
Section titled “ProcedureParameters property”Remarks
Section titled “Remarks”The user will specify parameter values via these mapping names
SharedWith property
Section titled “SharedWith property”Summary
Section titled “Summary”List of names of Users with whom this Procedure has been shared.
SharedWithEntries property
Section titled “SharedWithEntries property”Summary
Section titled “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
Section titled “Tags property”Summary
Section titled “Summary”List of tags (as strings) associated with the Procedure.
Version property
Section titled “Version property”Summary
Section titled “Summary”The version of the Procedure
Validate() method
Section titled “Validate() method”Summary
Section titled “Summary”Validate the ProcedureCreate object.
Parameters
Section titled “Parameters”This method has no parameters.
Exceptions
Section titled “Exceptions”| Name | Description |
|---|---|
| TrimbleCloud.Processing.ValidationException |
ProceduresAPI type
Section titled “ProceduresAPI type”Namespace
Section titled “Namespace”TrimbleCloud.Processing
Summary
Section titled “Summary”API Methods relating to Trimble Cloud Platform Processing Framework procedures
Approve(id) method
Section titled “Approve(id) method”Summary
Section titled “Summary”Approve a procedure
Returns
Section titled “Returns”A Task that resolves to the approved procedure on completion
Parameters
Section titled “Parameters”| Name | Type | Description |
|---|---|---|
| id | System.String | The identifier of the procedure to approve |
Exceptions
Section titled “Exceptions”| Name | Description |
|---|---|
| System.Exception | Thrown when a procedure cannot be approved |
Create(procedureCreate) method
Section titled “Create(procedureCreate) method”Summary
Section titled “Summary”Create a procedure
Returns
Section titled “Returns”A Task that resolves to the created procedure on completion
Parameters
Section titled “Parameters”| Name | Type | Description |
|---|---|---|
| procedureCreate | TrimbleCloud.Processing.Model.ProcedureCreate | The value of the procedure to create |
Exceptions
Section titled “Exceptions”| Name | Description |
|---|---|
| System.Exception | Thrown when a procedure cannot be created |
Delete(id) method
Section titled “Delete(id) method”Summary
Section titled “Summary”Delete a procedure
Returns
Section titled “Returns”An awaitiable Task
Parameters
Section titled “Parameters”| Name | Type | Description |
|---|---|---|
| id | System.String | The identifier of the procedure to delete |
Exceptions
Section titled “Exceptions”| Name | Description |
|---|---|
| System.Exception | Thrown when a procedure cannot be deleted |
Get(id,procedureView) method
Section titled “Get(id,procedureView) method”Summary
Section titled “Summary”Get a procedure by id
Returns
Section titled “Returns”A Task that resolves to the requested procedure on completion
Parameters
Section titled “Parameters”| Name | Type | Description |
|---|---|---|
| id | System.String | The identifier of the procedure to read |
| procedureView | System.String | Optional procedure view (passed as procedure-view) |
Exceptions
Section titled “Exceptions”| Name | Description |
|---|---|
| System.Exception | Thrown when a procedure cannot be read |
GetList(include_public) method
Section titled “GetList(include_public) method”Summary
Section titled “Summary”Get a list of procedures
Returns
Section titled “Returns”An asynchronous list of procedures
Parameters
Section titled “Parameters”| Name | Type | Description |
|---|---|---|
| include_public | System.Boolean | Whether to include public procedures in the returned list |
List(page,pageSize,filters) method
Section titled “List(page,pageSize,filters) method”Summary
Section titled “Summary”Get a list of procedures
Returns
Section titled “Returns”An asynchronous list of procedures
Parameters
Section titled “Parameters”| Name | Type | Description |
|---|---|---|
| page | System.Int32 | The page number to retrieve |
| pageSize | System.Int32 | The number of items per page |
| filters | TrimbleCloud.Processing.Model.ProcedureListFilter | The filters to apply to the list |
Publish(id) method
Section titled “Publish(id) method”Summary
Section titled “Summary”Publish a procedure
Returns
Section titled “Returns”A Task that resolves to the published procedure on completion
Parameters
Section titled “Parameters”| Name | Type | Description |
|---|---|---|
| id | System.String | The identifier of the procedure to publish |
Exceptions
Section titled “Exceptions”| Name | Description |
|---|---|
| System.Exception | Thrown when a procedure cannot be published |
Retire(id) method
Section titled “Retire(id) method”Summary
Section titled “Summary”Retire a procedure
Returns
Section titled “Returns”A Task that resolves to the retired procedure on completion
Parameters
Section titled “Parameters”| Name | Type | Description |
|---|---|---|
| id | System.String | The identifier of the procedure to retire |
Exceptions
Section titled “Exceptions”| Name | Description |
|---|---|
| System.Exception | Thrown when a procedure cannot be retired |
Update(id,procedureUpdate) method
Section titled “Update(id,procedureUpdate) method”Summary
Section titled “Summary”Update a procedure
Returns
Section titled “Returns”A Task that resolves to the updated procedure on completion
Parameters
Section titled “Parameters”| Name | Type | Description |
|---|---|---|
| id | System.String | The identifier of the procedure to update |
| procedureUpdate | TrimbleCloud.Processing.Model.ProcedureUpdate | The value of the procedure to update |
Exceptions
Section titled “Exceptions”| Name | Description |
|---|---|
| System.Exception | Thrown when a procedure cannot be updated |
ProcessingClient type
Section titled “ProcessingClient type”Namespace
Section titled “Namespace”TrimbleCloud.Processing
Summary
Section titled “Summary”A client for the Trimble Cloud Platform Processing Framework
Example
Section titled “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
Section titled “#ctor(clientProvider) constructor”Summary
Section titled “Summary”Public constructor for a Processing Client
Parameters
Section titled “Parameters”| Name | Type | Description |
|---|---|---|
| clientProvider | Trimble.ID.IHttpClientProvider | A provider of a pre-configured HttpClient used for API calls made by this client |
DeploymentSecrets property
Section titled “DeploymentSecrets property”Deployments property
Section titled “Deployments property”Engines property
Section titled “Engines property”Executions property
Section titled “Executions property”Operations property
Section titled “Operations property”Procedures property
Section titled “Procedures property”QueryStringFormatter`1 type
Section titled “QueryStringFormatter`1 type”Namespace
Section titled “Namespace”TrimbleCloud.Processing.Helper
Summary
Section titled “Summary”Query String Formatter
ToQueryString() method
Section titled “ToQueryString() method”Summary
Section titled “Summary”Convert the filter to query string
Parameters
Section titled “Parameters”This method has no parameters.
Resource type
Section titled “Resource type”Namespace
Section titled “Namespace”TrimbleCloud.Processing.Model
Summary
Section titled “Summary”Represents a resource.
CreatedAt property
Section titled “CreatedAt property”Summary
Section titled “Summary”Resouce creation date time
Id property
Section titled “Id property”Summary
Section titled “Summary”Gets resource Id
UpdatedAt property
Section titled “UpdatedAt property”Summary
Section titled “Summary”Resouce updation date time
Response type
Section titled “Response type”Namespace
Section titled “Namespace”TrimbleCloud.Processing
Summary
Section titled “Summary”Represents a response.
ContentLength property
Section titled “ContentLength property”Summary
Section titled “Summary”Returns the content length of the HTTP response.
IsError property
Section titled “IsError property”Summary
Section titled “Summary”Indicates whether the status code of the returned response is considered an error code.
Metadata property
Section titled “Metadata property”Summary
Section titled “Summary”Get the HTTP response headers.
ReasonPhrase property
Section titled “ReasonPhrase property”Summary
Section titled “Summary”Gets the HTTP reason phrase.
RequestId property
Section titled “RequestId property”Summary
Section titled “Summary”Gets the client request id that was sent to the server as tcp-request-id headers.
ResponseContent property
Section titled “ResponseContent property”Summary
Section titled “Summary”Gets or sets the response content body.
Status property
Section titled “Status property”Summary
Section titled “Summary”Gets the HTTP status code.
Dispose() method
Section titled “Dispose() method”Summary
Section titled “Summary”Frees resources held by this Response instance.
Parameters
Section titled “Parameters”This method has no parameters.
FromValue``1(value,response) method
Section titled “FromValue``1(value,response) method”Summary
Section titled “Summary”Creates a new instance of Response`1 with the provided value and HTTP response.
Returns
Section titled “Returns”A new instance of Response`1 with the provided value and HTTP response.
Parameters
Section titled “Parameters”| Name | Type | Description |
|---|---|---|
| value | ``0 | The value. |
| response | TrimbleCloud.Processing.Response | The HTTP response. |
Generic Types
Section titled “Generic Types”| Name | Description |
|---|---|
| T | The type of the value. |
ToString() method
Section titled “ToString() method”Summary
Section titled “Summary”Returns the string representation of this Response.
Returns
Section titled “Returns”The string representation of this Response
Parameters
Section titled “Parameters”This method has no parameters.
Response`1 type
Section titled “Response`1 type”Namespace
Section titled “Namespace”TrimbleCloud.Processing
Summary
Section titled “Summary”Represents a response.
Generic Types
Section titled “Generic Types”| Name | Description |
|---|---|
| T | The type of returned value. |
Data property
Section titled “Data property”Summary
Section titled “Summary”Gets the value returned by the service. Accessing this property will throw if HasData is false.
HasData property
Section titled “HasData property”Summary
Section titled “Summary”Gets a value indicating whether the current instance has a valid value of its underlying type.
GetResponse() method
Section titled “GetResponse() method”Summary
Section titled “Summary”Get HTTP raw response
Parameters
Section titled “Parameters”This method has no parameters.
op_Implicit(response) method
Section titled “op_Implicit(response) method”Summary
Section titled “Summary”Returns the value of this Response`1 object.
Parameters
Section titled “Parameters”| Name | Type | Description |
|---|---|---|
| response | TrimbleCloud.Processing.Response{`0})~`0 | The Response`1 instance. |
SecretFile type
Section titled “SecretFile type”Namespace
Section titled “Namespace”TrimbleCloud.Processing.Model
Summary
Section titled “Summary”Secret files
FilePath property
Section titled “FilePath property”Summary
Section titled “Summary”The file path of an ingested Deployment Secret file.
Identifier property
Section titled “Identifier property”Summary
Section titled “Summary”The expected identifier of a Deployment Secret.
SecretVariable type
Section titled “SecretVariable type”Namespace
Section titled “Namespace”TrimbleCloud.Processing.Model
Summary
Section titled “Summary”Secret variables
Identifier property
Section titled “Identifier property”Summary
Section titled “Summary”The expected identifier of a Deployment Secret.
VariableName property
Section titled “VariableName property”Summary
Section titled “Summary”The name of the environment variable inside the container.
SharedWithEntry type
Section titled “SharedWithEntry type”Namespace
Section titled “Namespace”TrimbleCloud.Processing.Model
Summary
Section titled “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
Section titled “AccountId property”Summary
Section titled “Summary”The TID account identifier to share with. Required.
ClientId property
Section titled “ClientId property”Summary
Section titled “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
Section titled “Status type”Namespace
Section titled “Namespace”TrimbleCloud.Processing.Model
Summary
Section titled “Summary”The status of the operation.
DELETING constants
Section titled “DELETING constants”Summary
Section titled “Summary”DELETING status
EXECUTABLE constants
Section titled “EXECUTABLE constants”Summary
Section titled “Summary”EXECUTABLE status
MUTABLE constants
Section titled “MUTABLE constants”Summary
Section titled “Summary”MUTABLE status
RETIRED constants
Section titled “RETIRED constants”Summary
Section titled “Summary”RETIRED status
UNKNOWN constants
Section titled “UNKNOWN constants”Summary
Section titled “Summary”Unknown status
TrimbleServiceException type
Section titled “TrimbleServiceException type”Namespace
Section titled “Namespace”TrimbleCloud.Processing
Summary
Section titled “Summary”Exception for Trimble service API errors
#ctor(message,response) constructor
Section titled “#ctor(message,response) constructor”Summary
Section titled “Summary”Constructor used by the SDK to create service exceptions with complete error information.
Parameters
Section titled “Parameters”| Name | Type | Description |
|---|---|---|
| message | System.String | Error message |
| response | TrimbleCloud.Processing.Response | Response object that led to the exception |
#ctor() constructor
Section titled “#ctor() constructor”Summary
Section titled “Summary”Constructor used by the SDK to create service exceptions with complete error information.
Parameters
Section titled “Parameters”This constructor has no parameters.
#ctor(message,response,innerException) constructor
Section titled “#ctor(message,response,innerException) constructor”Summary
Section titled “Summary”Constructor used by the SDK to create service exceptions with complete error information.
Parameters
Section titled “Parameters”| Name | Type | Description |
|---|---|---|
| message | System.String | Error message |
| response | TrimbleCloud.Processing.Response | Response object that led to the exception |
| innerException | System.Exception | Inner exception if any |
#ctor(info,context) constructor
Section titled “#ctor(info,context) constructor”Summary
Section titled “Summary”Constructor for deserialization
Parameters
Section titled “Parameters”| Name | Type | Description |
|---|---|---|
| info | System.Runtime.Serialization.SerializationInfo | The SerializationInfo that holds the serialized object data |
| context | System.Runtime.Serialization.StreamingContext | The StreamingContext that contains contextual information about the source or destination |
_response constants
Section titled “_response constants”Summary
Section titled “Summary”Gets the response, if any, that led to the exception.
RequestId property
Section titled “RequestId property”Summary
Section titled “Summary”Gets the request ID for tracking and support purposes.
StatusCode property
Section titled “StatusCode property”Summary
Section titled “Summary”Gets the HTTP status code of the response. Returns 0 if response was not received.
GetObjectData() method
Section titled “GetObjectData() method”Summary
Section titled “Summary”Inherit from parent.
Parameters
Section titled “Parameters”This method has no parameters.
GetRawResponse() method
Section titled “GetRawResponse() method”Summary
Section titled “Summary”Gets the response, if any, that led to the exception.
Returns
Section titled “Returns”The response that caused this exception, or null if not available
Parameters
Section titled “Parameters”This method has no parameters.
ToString() method
Section titled “ToString() method”Summary
Section titled “Summary”Returns a string representation of the exception
Returns
Section titled “Returns”Formatted error message
Parameters
Section titled “Parameters”This method has no parameters.
ValidationException type
Section titled “ValidationException type”Namespace
Section titled “Namespace”TrimbleCloud.Processing
Summary
Section titled “Summary”Represents an exception that occurs during validation.
#ctor(message) constructor
Section titled “#ctor(message) constructor”Summary
Section titled “Summary”Initializes a new instance of the ValidationException class.
Parameters
Section titled “Parameters”| Name | Type | Description |
|---|---|---|
| message | System.String | Exception message. |
#ctor(message,innerException) constructor
Section titled “#ctor(message,innerException) constructor”Summary
Section titled “Summary”Initializes a new instance of the ValidationException class.
Parameters
Section titled “Parameters”| Name | Type | Description |
|---|---|---|
| message | System.String | Exception message. |
| innerException | System.Exception | Inner exception. |
#ctor(message,errors) constructor
Section titled “#ctor(message,errors) constructor”Summary
Section titled “Summary”Initializes a new instance of the ValidationException class.
Parameters
Section titled “Parameters”| Name | Type | Description |
|---|---|---|
| message | System.String | Exception message. |
| errors | System.Collections.Generic.IEnumerable{System.String} | List of errors. |
Errors property
Section titled “Errors property”Summary
Section titled “Summary”Gets the list of errors.