Skip to content
Processing Framework

TrimbleCloud.Processing.models package

Submodules

TrimbleCloud.Processing.models.acr_token module

class TrimbleCloud.Processing.models.acr_token.ACRToken

Bases: TypedDict

TypedDict representation of an ACR token object

status

The status of the ACR token request

login_command

The command used to login to docker before tagging and pushing an image

  • Type: str

tag_command

The command used to tag an image for upload

  • Type: str

push_command

The command used to push a tagged image into the system

  • Type: str

login_command : str

push_command : str

status : ACRTokenRequestStatus

tag_command : str

TrimbleCloud.Processing.models.acr_token_request_status module

class TrimbleCloud.Processing.models.acr_token_request_status.ACRTokenRequestStatus(value)

Bases: str, Enum

Represents the status of an ACR token request

GENERATING

The ACR token has been requested and is being generated

AVAILABLE

The ACR token is ready for use

UNAVAILABLE

The ACR token can not be used

IMAGE_RECEIVED

An image has been uploaded to ACR using the token

AVAILABLE = ‘AVAILABLE’

GENERATING = ‘GENERATING’

IMAGE_RECEIVED = ‘IMAGE_RECEIVED’

UNAVAILABLE = ‘UNAVAILABLE’

TrimbleCloud.Processing.models.computing module

class TrimbleCloud.Processing.models.computing.Computing

Bases: TypedDict

TypedDict representation of Computing object

cpu

The amount of CPU to assign to a single instance of an Engine. Constraints: Min 0.1 and less than or equal to Owner’s remaining allotment of CPU

  • Type: float

memory

The amount of Memory to assign to a single instance of an Engine. Constraints: Min 1 and less than or equal to Owner’s remaining allotment of Memory

  • Type: int

cpu : float

memory : int

TrimbleCloud.Processing.models.container_upload module

class TrimbleCloud.Processing.models.container_upload.ContainerUpload

Bases: TypedDict

TypedDict representation of a Container Upload object

acr_token

Contains information relevant to an ACR upload token

acr_token : ACRToken

TrimbleCloud.Processing.models.data_type module

class TrimbleCloud.Processing.models.data_type.DataType(value)

Bases: str, Enum

Represents the data type of a parameter

STRING

String text surrounded by double quotes

SINGLE_CHOICE

Value must match an item in the options field

BOOLEAN

Boolean true/false (not surrounded by quotes)

ARRAY

A list of parameters of any type

OBJECT

Any valid JSON object

NUMBER

An integer or a float

WILDCARD

Any type of data

ARRAY = ‘array’

BOOLEAN = ‘boolean’

NUMBER = ‘number’

OBJECT = ‘object’

SINGLE_CHOICE = ‘single_choice’

STRING = ‘string’

WILDCARD = ‘wildcard’

TrimbleCloud.Processing.models.deployment module

class TrimbleCloud.Processing.models.deployment.Deployment

Bases: TypedDict

TypedDict representation of a Deployment object

id

The unique identifier for the Deployment

  • Type: str

name

Deployment name

  • Type: str

identifier

Deployment Identifier

  • Type: str

account_id

The TID account identifier of the owner of this Deployment

  • Type: str

client_id

The TID subject identifier (client ID) of the owner of this Deployment

  • Type: str

description

A description of the Deployment and its function

  • Type: str

status

The status of the Deployment

active_engine

The Engine ID that is connected to this Deployment

  • Type: str

regions

The location(s) this resource can run in

  • Type: list

scaling

The configuration object to define minimum and maximum number of concurrent Engines that can be running simultaneously

computing

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

operations

This object will provide the identifiers and their respective id for all Operations associated with this Deployment

  • Type: dict

secrets

This object will provide the identifiers and their respective id for all Secrets associated with this Deployment

  • Type: dict

public

The state of the Deployment’s publication

  • Type: bool

created_at

Timestamp for the Deployment’s creation

  • Type: str

updated_at

Timestamp for the Deployment’s latest update

  • Type: str

account_id : str

active_engine : str

client_id : str

computing : Computing

created_at : str

description : str

id : str

identifier : str

name : str

operations : Dict[str, Any]

public : bool

regions : List[str]

scaling : Scaling

secrets : Dict[str, Any]

status : DeploymentStatus

updated_at : str

TrimbleCloud.Processing.models.deployment_secret module

class TrimbleCloud.Processing.models.deployment_secret.DeploymentSecret

Bases: TypedDict

TypedDict representation of a Deployment Secret object

id

The unique identifier for the Secret

  • Type: str

identifier

A Deployment Secret identifier is unique within the system

  • Type: str

name

Name of the Secret

  • Type: str

value

A Base64 encoded string of the Secret value

  • Type: str

description

A description of the Secret

  • Type: str

status

Secret status

  • Type: str

account_id

The TID account identifier of the owner of this Deployment Secret

  • Type: str

client_id

The TID subject identifier (client ID) of the owner of this Deployment Secret

  • Type: str

regions

The locations this Deployment Secret is available in

  • Type: list[str]

created_at

Timestamp for the Secret’s creation

  • Type: str

updated_at

Timestamp for the Secret’s latest update

  • Type: str

account_id : str

client_id : str

created_at : str

description : str

id : str

identifier : str

name : str

regions : List[str]

status : str

updated_at : str

value : str

TrimbleCloud.Processing.models.deployment_status module

class TrimbleCloud.Processing.models.deployment_status.DeploymentStatus(value)

Bases: str, Enum

Represents the status of a Deployment

SUBMITTED

The Deployment object has been created in the system but the Cloud resource creation has not begun

PREPARING

This is a ‘processing’ state that is entered anytime a request to modify the Deployment is received. This will block any other requests to modify the Deployment until the processing is complete.

UPDATING

This is a ‘processing’ state that is entered anytime a request to modify the Deployment is received. This will block any other requests to modify the Deployment until the processing is complete.

AVAILABLE

The container image has successfully been ingested into the system and this Deployment is now ready to be referenced in a Deployment

RETIRING

The Deployment is being retired and can not be used

RETIRED

The Deployment has been retired and can no not be used

FAILED

The Deployment failed in a process and can not be used

DELETING

This is a ‘processing’ state that is entered anytime a request to delete the resource is made

ROLLED_BACK

The Deployment has been rolled back to a previous version

AVAILABLE = ‘AVAILABLE’

DELETING = ‘DELETING’

FAILED = ‘FAILED’

PREPARING = ‘PREPARING’

RETIRED = ‘RETIRED’

RETIRING = ‘RETIRING’

ROLLED_BACK = ‘ROLLED_BACK’

SUBMITTED = ‘SUBMITTED’

UPDATING = ‘UPDATING’

TrimbleCloud.Processing.models.engine module

class TrimbleCloud.Processing.models.engine.Engine

Bases: TypedDict

TypedDict representation of an Engine object

id

The unique identifier for the Engine

  • Type: str

name

Engine name

  • Type: str

identifier

Engine identifier, unique within the system

  • Type: str

tag

Engine tag

  • Type: str

account_id

The TID account identifier of the owner of this Engine

  • Type: str

client_id

The TID subject identifier (client ID) of the owner of this Engine

  • Type: str

description

A description of the Engine and its function

  • Type: str

status

The status of the Engine

ingestion_type

The method of uploading a container image into the system

os

Which OS for the Engine to use

os_build

Specify which OS build to use. This is a required parameter for Windows Engines only

env_vars

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

secret_variables

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

secret_files

Secret files that are stored and ingested into the Engine’s container

container_upload

Contains information on how to upload a container

regions

The location(s) this resource can run in

  • Type: list[str]

public

The state of the Engine’s publication

  • Type: bool

created_at

Timestamp for the Engine’s creation

  • Type: str

updated_at

Timestamp for the Engine’s latest update

  • Type: str

account_id : str

client_id : str

container_upload : ContainerUpload

created_at : str

description : str

env_vars : List[EnvironmentVariable]

id : str

identifier : str

ingestion_type : IngestionType

name : str

os : OSType

os_build : OSBuild

public : bool

regions : List[str]

secret_files : List[SecretFile]

secret_variables : List[SecretVariable]

status : EngineStatus

tag : str

updated_at : str

TrimbleCloud.Processing.models.engine_status module

class TrimbleCloud.Processing.models.engine_status.EngineStatus(value)

Bases: str, Enum

Represents the status of an Engine

SUBMITTED

The Engine object has been created in our system but the Cloud resource creation has not begun

GENERATING_ACR_TOKEN

The Cloud resource creation has successfully begun and the system is generating your credentials

AWAITING_IMAGE_UPLOAD

Your credentials have successfully generated and the system is waiting for you to upload your container image using the provided commands

PREPARING

This is a ‘processing’ state that is entered anytime a request to modify the Engine is received. This will block any other requests to modify the Engine until the processing is complete.

AVAILABLE

The container image has successfully been ingested into our system and this Engine is now ready to be referenced in a Deployment

FAILED

The Engine failed in a process and can not be used

RETIRING

The Engine is being retired and can not be used

RETIRED

The Engine has been retired and can no not be used

AVAILABLE = ‘AVAILABLE’

AWAITING_IMAGE_UPLOAD = ‘AWAITING_IMAGE_UPLOAD’

FAILED = ‘FAILED’

GENERATING_ACR_TOKEN = ‘GENERATING_ACR_TOKEN’

PREPARING = ‘PREPARING’

RETIRED = ‘RETIRED’

RETIRING = ‘RETIRING’

SUBMITTED = ‘SUBMITTED’

TrimbleCloud.Processing.models.environment_variable module

class TrimbleCloud.Processing.models.environment_variable.EnvironmentVariable

Bases: TypedDict

TypedDict representation of an Environment Variable object

value

The value for this environment variable

  • Type: str

container_var_name

The name of the environment variable inside the container (the Engine’s source code)

  • Type: str

container_var_name : str

value : str

TrimbleCloud.Processing.models.execution module

class TrimbleCloud.Processing.models.execution.Execution

Bases: TypedDict

TypedDict representation of an Execution object

id

The unique identifier for the Execution

  • Type: str

procedure_id

The unique identifier of the target Procedure

  • Type: str

data_export

Whether or not the execution’s data will be available for export

  • Type: bool

region

Region name for the Execution to run in

  • Type: str

parameters

Mapping of Procedure-specified parameter names to parameter values

  • Type: dict[str, str]

procedure_identifier

The identifier of the target Procedure for Execution

  • Type: str

procedure_version

The version of the target Procedure for Execution

  • Type: int

progress

The execution status of an Execution describes its processing status

metadata

User-specified metadata to be associated with the Execution

  • Type: str

created_at

Timestamp for the Execution’s creation

  • Type: str

updated_at

Timestamp for Execution’s latest update

  • Type: str

submitted_at

Timestamp for Execution’s latest submission (start)

  • Type: str

completed_at

Timestamp for Execution’s completion, if applicable

  • Type: str

failed_at

Timestamp for Execution’s failure, if applicable

  • Type: str

bound_parameters

Mapping of Operation-specified output parameter names to output parameter values

  • Type: dict

bound_parameters : dict

completed_at : str

created_at : str

data_export : bool

failed_at : str

id : str

metadata : str

parameters : Dict[str, str]

procedure_id : str

procedure_identifier : str

procedure_version : int

progress : Progress

region : str

submitted_at : str

updated_at : str

TrimbleCloud.Processing.models.execution_status module

class TrimbleCloud.Processing.models.execution_status.ExecutionStatus(value)

Bases: str, Enum

Represents the execution status of an object

NOT_READY

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

READY

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

SUSPENDED

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

NOT_READY = ‘NOT_READY’

READY = ‘READY’

SUSPENDED = ‘SUSPENDED’

TrimbleCloud.Processing.models.ingestion_type module

class TrimbleCloud.Processing.models.ingestion_type.IngestionType(value)

Bases: str, Enum

Represents the method of uploading a container image into the system. Currently the only option is a temporary ACR token upload.

ACR_TOKEN

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

ACR_TOKEN = ‘acr_token’

TrimbleCloud.Processing.models.input module

class TrimbleCloud.Processing.models.input.Input

Bases: TypedDict

TypedDict representation of an Input object in an Operation

data_types

List of accepted input data types

  • Type: list[str]

optional

Whether the input file is optional or not

  • Type: bool

name

Human readable name of the input

  • Type: str

description

Descriptive text for the input type

  • Type: str

data_types : List[str]

description : str

name : str

optional : bool

TrimbleCloud.Processing.models.op_input module

class TrimbleCloud.Processing.models.op_input.OpInput

Bases: TypedDict

TypedDict representation of an Operation’s input object in an Operation Chain

sources

Array wrapper for the source of an Operation’s input

  • Type: list[str]

data_types

Type of data output from the Operation

  • Type: str

data_types : str

sources : List[str]

TrimbleCloud.Processing.models.op_output module

class TrimbleCloud.Processing.models.op_output.OpOutput

Bases: TypedDict

TypedDict representation of an Operation’s output object in an Operation Chain

data_type

Type of data output from the Operation

  • Type: str

description

Descriptive text for the output and its type

  • Type: str

name

Human readable name of the output

  • Type: str

data_type : str

description : str

name : str

TrimbleCloud.Processing.models.op_parameter module

class TrimbleCloud.Processing.models.op_parameter.OpParameter

Bases: TypedDict

TypedDict representation of an Operation’s parameter object in an Operation Chain

source

The source of the Operation parameter. The source could be a Procedure parameter input by the user or another Operation’s output parameter.

  • Type: str

optional

Whether the parameter is optional or required

  • Type: bool

optional : bool

source : str

TrimbleCloud.Processing.models.operation module

class TrimbleCloud.Processing.models.operation.Operation

Bases: TypedDict

TypedDict representation of an Operation object

id

The unique identifier for the Operation

  • Type: str

identifier

Unique identifier string for the Operation

  • Type: str

version

The version of the Operation

  • Type: int

deployment_identifier

The identifier of the Deployment that supports this Operation

  • Type: str

regions

List of regions where Operation is allowed to run in

  • Type: list[str]

public

Whether the Operation should be public or not

  • Type: bool

status

The status of the Operation

execution_status

The execution status of the Operation

account_id

The TID account identifier of the owner of this Operation

  • Type: str

client_id

The TID subject identifier (client ID) of the owner of this Operation

  • Type: str

name

The name of the Operation

  • Type: str

description

A description of the Operation and its function

  • Type: str

engine_name

The name of the backend engine that supports this Operation

  • Type: str

shared_with

List of identities with whom this Operation has been shared. Each entry contains an account_id 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.

parameters

Parameter objects attached to the Operation

output_parameters

Parameter objects that define values to be output from an Operation

inputs

Named inputs for the Operation

outputs

Named outputs for the Operation

dynamic_output

Indicates whether or not the Output content is considered dynamic

  • Type: bool

deprecation_message

A message indicating that the Operation is deprecated

  • Type: str

retired_after

The date after which the Operation is retired

  • Type: str

account_id : str

client_id : str

deployment_identifier : str

deprecation_message : str

description : str

dynamic_output : bool

engine_name : str

execution_status : ExecutionStatus

id : str

identifier : str

inputs : Dict[str, Input]

name : str

output_parameters : Dict[str, OutputParameter]

outputs : Dict[str, Output]

parameters : Dict[str, Parameter]

public : bool

regions : List[str]

retired_after : str

shared_with : List[SharedWithIdentity]

status : Status

version : int

TrimbleCloud.Processing.models.operation_chain module

class TrimbleCloud.Processing.models.operation_chain.OperationChain

Bases: TypedDict

TypedDict representation of an Operation Chain object in a Procedure

This is where the user specifies which Procedures make up the Procedure and how those Operations chain together.

identifier

Unique identifier string for the operation

  • Type: str

version

The version of the Operation

  • Type: int

engine_name

The name of the backend engine that supports this operation

  • Type: str

encrypted_parameters

List of Operation parameters defined with encrypted: true

  • Type: list[str]

parameters

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

inputs

Named inputs for the Operation

outputs

Outputs should be defined in the Procedure definition only when a Switcher Operation is being utilized. If no Switcher is being specified, then outputs should not be defined.

output_parameters

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

name

Human-readable name of the Operation

  • Type: str

description

A description of an operation and its function

  • Type: str

description : str

encrypted_parameters : List[str]

engine_name : str

identifier : str

inputs : Dict[str, OpInput]

name : str

output_parameters : Dict[str, OutputParameter]

outputs : Dict[str, OpOutput]

parameters : Dict[str, OpParameter]

version : int

TrimbleCloud.Processing.models.os_build module

class TrimbleCloud.Processing.models.os_build.OSBuild(value)

Bases: str, Enum

Represents the OS build of the Engine

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 2019 OS build

WINDOWS_SERVER_2022

Windows Server 2022 OS build

WINDOWS_SERVER_2019 = ‘10.0.17763’

WINDOWS_SERVER_2022 = ‘10.0.20348’

TrimbleCloud.Processing.models.os_type module

class TrimbleCloud.Processing.models.os_type.OSType(value)

Bases: str, Enum

Represents the OS of the Engine

LINUX

Linux Engine

WINDOWS

Windows Engine

LINUX = ‘linux’

WINDOWS = ‘windows’

TrimbleCloud.Processing.models.output module

class TrimbleCloud.Processing.models.output.Output

Bases: TypedDict

TypedDict representation of an Output object in an Operation

data_type

Type of data output from the Operation

  • Type: str

description

Descriptive text for the output and its type

  • Type: str

name

Human readable name of the output

  • Type: str

data_type : str

description : str

name : str

TrimbleCloud.Processing.models.output_parameter module

class TrimbleCloud.Processing.models.output_parameter.OutputParameter

Bases: TypedDict

TypedDict representation of an Operation’s output parameter

type

Data type of the output parameter

optional

Whether the parameter is optional or required

  • Type: bool

description

Descriptive text for the output parameter

  • Type: str

name

Human readable name of the output parameter

  • Type: str

description : str

name : str

optional : bool

type : DataType

TrimbleCloud.Processing.models.parameter module

class TrimbleCloud.Processing.models.parameter.Parameter

Bases: TypedDict

TypedDict representation of a parameter object in an Operation

Parameter defines the options and arguments supplied to the Operation.

type

The data type of the parameter

optional

Describes whether the parameter is required or optional

  • Type: bool

name

Human-readable name for the parameter

  • Type: str

description

Descriptive text for the input parameter

  • Type: str

encrypted

Indicates that the parameter contains sensitive information

  • Type: bool

description : str

encrypted : bool

name : str

optional : bool

type : DataType

TrimbleCloud.Processing.models.procedure module

class TrimbleCloud.Processing.models.procedure.Procedure

Bases: TypedDict

TypedDict representation of a Procedure object

id

The unique identifier for the Procedure

  • Type: str

identifier

Unique identifier string for the Procedure

  • Type: str

version

The version of the Procedure

  • Type: int

account_id

The TID account identifier of the owner of this Procedure

  • Type: str

client_id

The TID subject identifier (client ID) of the owner of this Procedure

  • Type: str

name

The name of the Procedure

  • Type: str

description

A description of the Procedure and its function

  • Type: str

status

The status of the Procedure

execution_status

The execution status of the Procedure

tags

List of tags (as strings) associated with the Procedure

  • Type: str

documentation_url

Optional URL to reference external documentation for the Procedure

  • Type: str

retired_after

The date after which the Procedure is retired

  • Type: str

shared_with

List of identities with whom this Procedure has been shared. Each entry contains an account_id 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.

public

Whether the Procedure should be public or not

  • Type: bool

regions

List of regions where Procedure is allowed to run in

  • Type: list[str]

default_region

Region name the Procedure should execute in by default

  • Type: str

operations

Mapping of Procedure names and definitions

parameters

Parameter mappings for the Procedures contained within the Procedure

account_id : str

client_id : str

default_region : str

description : str

documentation_url : str

execution_status : ExecutionStatus

id : str

identifier : str

name : str

operations : Dict[str, OperationChain]

parameters : Dict[str, ProcedureParameter]

public : bool

regions : List[str]

retired_after : str

shared_with : List[SharedWithIdentity]

status : Status

tags : str

version : int

TrimbleCloud.Processing.models.procedure_parameter module

class TrimbleCloud.Processing.models.procedure_parameter.ProcedureParameter

Bases: TypedDict

TypedDict representation of a parameter object in a Procedure

type

The type of the Procedure parameter

  • Type: str

default_value

The default value for the Procedure parameter

  • Type: str

name

Human readable name for the Procedure parameter

  • Type: str

description

Description for the Procedure parameter

  • Type: str

source

String parameter

  • Type: str

value

Value of the parameter

  • Type: str

default_value : str

description : str

name : str

source : str

type : str

value : str

TrimbleCloud.Processing.models.progress module

class TrimbleCloud.Processing.models.progress.Progress(value)

Bases: str, Enum

Represents the progress of an Execution

UNSUBMITTED

The execution was not successfully submitted to SWF

SUBMITTED

The execution was successfully submitted to SWF for handling by the Decider

WAITING

The underlying procedure is locked, causing the execution to wait for the procedure to be unlocked

QUEUED

Execution has been submitted for processing and is waiting in a processing queue

EXECUTING

The decider has handled the Execution and is waiting for operations to be processed

FAILED

Processing of one or more Operations failed

FINISHED

Processing has been completed

EXECUTING = ‘EXECUTING’

FAILED = ‘FAILED’

FINISHED = ‘FINISHED’

QUEUED = ‘QUEUED’

SUBMITTED = ‘SUBMITTED’

UNSUBMITTED = ‘UNSUBMITTED’

WAITING = ‘WAITING’

TrimbleCloud.Processing.models.scaling module

class TrimbleCloud.Processing.models.scaling.Scaling

Bases: TypedDict

TypedDict representation of a Scaling object

It defines the minimum and maximum number of concurrent Engines that can be running simultaneously.

min

The minimum number of Engines that can be running simultaneously. Constraints: Min 0

  • Type: int

max

The maximum number of Engines that can be running simultaneously. Constraints: Min 0

  • Type: int

max : int

min : int

TrimbleCloud.Processing.models.secret_file module

class TrimbleCloud.Processing.models.secret_file.SecretFile

Bases: TypedDict

TypedDict representation of a Secret file object

secret_identifier

The expected identifier of a Deployment Secret

  • Type: str

container_file_path

The file path of an ingested Deployment Secret file

  • Type: str

container_file_path : str

secret_identifier : str

TrimbleCloud.Processing.models.secret_variable module

class TrimbleCloud.Processing.models.secret_variable.SecretVariable

Bases: TypedDict

TypedDict representation of a Secret Variable object

secret_identifier

The expected identifier of a Deployment Secret

  • Type: str

container_var_name

The name of the environment variable inside the container (the Engine’s source code)

  • Type: str

container_var_name : str

secret_identifier : str

TrimbleCloud.Processing.models.shared_with_identity module

class TrimbleCloud.Processing.models.shared_with_identity.SharedWithIdentity

Bases: dict

TypedDict representation of a SharedWith identity object

account_id

The TID account identifier to share with.

  • Type: str

client_id

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

  • Type: str

account_id : str

client_id : str

TrimbleCloud.Processing.models.status module

class TrimbleCloud.Processing.models.status.Status(value)

Bases: str, Enum

Represents the status of an object

MUTABLE

The object is new and can still be altered

EXECUTABLE

The object is ready to be executed and can no longer be altered

RETIRED

The object has been retired from service and can no longer be executed

EXECUTABLE = ‘EXECUTABLE’

MUTABLE = ‘MUTABLE’

RETIRED = ‘RETIRED’

Module contents

class TrimbleCloud.Processing.models.ACRToken

Bases: TypedDict

TypedDict representation of an ACR token object

status

The status of the ACR token request

login_command

The command used to login to docker before tagging and pushing an image

  • Type: str

tag_command

The command used to tag an image for upload

  • Type: str

push_command

The command used to push a tagged image into the system

  • Type: str

login_command : str

push_command : str

status : ACRTokenRequestStatus

tag_command : str

class TrimbleCloud.Processing.models.ACRTokenRequestStatus(value)

Bases: str, Enum

Represents the status of an ACR token request

GENERATING

The ACR token has been requested and is being generated

AVAILABLE

The ACR token is ready for use

UNAVAILABLE

The ACR token can not be used

IMAGE_RECEIVED

An image has been uploaded to ACR using the token

AVAILABLE = ‘AVAILABLE’

GENERATING = ‘GENERATING’

IMAGE_RECEIVED = ‘IMAGE_RECEIVED’

UNAVAILABLE = ‘UNAVAILABLE’

class TrimbleCloud.Processing.models.Computing

Bases: TypedDict

TypedDict representation of Computing object

cpu

The amount of CPU to assign to a single instance of an Engine. Constraints: Min 0.1 and less than or equal to Owner’s remaining allotment of CPU

  • Type: float

memory

The amount of Memory to assign to a single instance of an Engine. Constraints: Min 1 and less than or equal to Owner’s remaining allotment of Memory

  • Type: int

cpu : float

memory : int

class TrimbleCloud.Processing.models.ContainerUpload

Bases: TypedDict

TypedDict representation of a Container Upload object

acr_token

Contains information relevant to an ACR upload token

acr_token : ACRToken

class TrimbleCloud.Processing.models.DataType(value)

Bases: str, Enum

Represents the data type of a parameter

STRING

String text surrounded by double quotes

SINGLE_CHOICE

Value must match an item in the options field

BOOLEAN

Boolean true/false (not surrounded by quotes)

ARRAY

A list of parameters of any type

OBJECT

Any valid JSON object

NUMBER

An integer or a float

WILDCARD

Any type of data

ARRAY = ‘array’

BOOLEAN = ‘boolean’

NUMBER = ‘number’

OBJECT = ‘object’

SINGLE_CHOICE = ‘single_choice’

STRING = ‘string’

WILDCARD = ‘wildcard’

class TrimbleCloud.Processing.models.Deployment

Bases: TypedDict

TypedDict representation of a Deployment object

id

The unique identifier for the Deployment

  • Type: str

name

Deployment name

  • Type: str

identifier

Deployment Identifier

  • Type: str

account_id

The TID account identifier of the owner of this Deployment

  • Type: str

client_id

The TID subject identifier (client ID) of the owner of this Deployment

  • Type: str

description

A description of the Deployment and its function

  • Type: str

status

The status of the Deployment

active_engine

The Engine ID that is connected to this Deployment

  • Type: str

regions

The location(s) this resource can run in

  • Type: list

scaling

The configuration object to define minimum and maximum number of concurrent Engines that can be running simultaneously

computing

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

operations

This object will provide the identifiers and their respective id for all Operations associated with this Deployment

  • Type: dict

secrets

This object will provide the identifiers and their respective id for all Secrets associated with this Deployment

  • Type: dict

public

The state of the Deployment’s publication

  • Type: bool

created_at

Timestamp for the Deployment’s creation

  • Type: str

updated_at

Timestamp for the Deployment’s latest update

  • Type: str

account_id : str

active_engine : str

client_id : str

computing : Computing

created_at : str

description : str

id : str

identifier : str

name : str

operations : Dict[str, Any]

public : bool

regions : List[str]

scaling : Scaling

secrets : Dict[str, Any]

status : DeploymentStatus

updated_at : str

class TrimbleCloud.Processing.models.DeploymentSecret

Bases: TypedDict

TypedDict representation of a Deployment Secret object

id

The unique identifier for the Secret

  • Type: str

identifier

A Deployment Secret identifier is unique within the system

  • Type: str

name

Name of the Secret

  • Type: str

value

A Base64 encoded string of the Secret value

  • Type: str

description

A description of the Secret

  • Type: str

status

Secret status

  • Type: str

account_id

The TID account identifier of the owner of this Deployment Secret

  • Type: str

client_id

The TID subject identifier (client ID) of the owner of this Deployment Secret

  • Type: str

regions

The locations this Deployment Secret is available in

  • Type: list[str]

created_at

Timestamp for the Secret’s creation

  • Type: str

updated_at

Timestamp for the Secret’s latest update

  • Type: str

account_id : str

client_id : str

created_at : str

description : str

id : str

identifier : str

name : str

regions : List[str]

status : str

updated_at : str

value : str

class TrimbleCloud.Processing.models.DeploymentStatus(value)

Bases: str, Enum

Represents the status of a Deployment

SUBMITTED

The Deployment object has been created in the system but the Cloud resource creation has not begun

PREPARING

This is a ‘processing’ state that is entered anytime a request to modify the Deployment is received. This will block any other requests to modify the Deployment until the processing is complete.

UPDATING

This is a ‘processing’ state that is entered anytime a request to modify the Deployment is received. This will block any other requests to modify the Deployment until the processing is complete.

AVAILABLE

The container image has successfully been ingested into the system and this Deployment is now ready to be referenced in a Deployment

RETIRING

The Deployment is being retired and can not be used

RETIRED

The Deployment has been retired and can no not be used

FAILED

The Deployment failed in a process and can not be used

DELETING

This is a ‘processing’ state that is entered anytime a request to delete the resource is made

ROLLED_BACK

The Deployment has been rolled back to a previous version

AVAILABLE = ‘AVAILABLE’

DELETING = ‘DELETING’

FAILED = ‘FAILED’

PREPARING = ‘PREPARING’

RETIRED = ‘RETIRED’

RETIRING = ‘RETIRING’

ROLLED_BACK = ‘ROLLED_BACK’

SUBMITTED = ‘SUBMITTED’

UPDATING = ‘UPDATING’

class TrimbleCloud.Processing.models.Engine

Bases: TypedDict

TypedDict representation of an Engine object

id

The unique identifier for the Engine

  • Type: str

name

Engine name

  • Type: str

identifier

Engine identifier, unique within the system

  • Type: str

tag

Engine tag

  • Type: str

account_id

The TID account identifier of the owner of this Engine

  • Type: str

client_id

The TID subject identifier (client ID) of the owner of this Engine

  • Type: str

description

A description of the Engine and its function

  • Type: str

status

The status of the Engine

ingestion_type

The method of uploading a container image into the system

os

Which OS for the Engine to use

os_build

Specify which OS build to use. This is a required parameter for Windows Engines only

env_vars

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

secret_variables

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

secret_files

Secret files that are stored and ingested into the Engine’s container

container_upload

Contains information on how to upload a container

regions

The location(s) this resource can run in

  • Type: list[str]

public

The state of the Engine’s publication

  • Type: bool

created_at

Timestamp for the Engine’s creation

  • Type: str

updated_at

Timestamp for the Engine’s latest update

  • Type: str

account_id : str

client_id : str

container_upload : ContainerUpload

created_at : str

description : str

env_vars : List[EnvironmentVariable]

id : str

identifier : str

ingestion_type : IngestionType

name : str

os : OSType

os_build : OSBuild

public : bool

regions : List[str]

secret_files : List[SecretFile]

secret_variables : List[SecretVariable]

status : EngineStatus

tag : str

updated_at : str

class TrimbleCloud.Processing.models.EngineStatus(value)

Bases: str, Enum

Represents the status of an Engine

SUBMITTED

The Engine object has been created in our system but the Cloud resource creation has not begun

GENERATING_ACR_TOKEN

The Cloud resource creation has successfully begun and the system is generating your credentials

AWAITING_IMAGE_UPLOAD

Your credentials have successfully generated and the system is waiting for you to upload your container image using the provided commands

PREPARING

This is a ‘processing’ state that is entered anytime a request to modify the Engine is received. This will block any other requests to modify the Engine until the processing is complete.

AVAILABLE

The container image has successfully been ingested into our system and this Engine is now ready to be referenced in a Deployment

FAILED

The Engine failed in a process and can not be used

RETIRING

The Engine is being retired and can not be used

RETIRED

The Engine has been retired and can no not be used

AVAILABLE = ‘AVAILABLE’

AWAITING_IMAGE_UPLOAD = ‘AWAITING_IMAGE_UPLOAD’

FAILED = ‘FAILED’

GENERATING_ACR_TOKEN = ‘GENERATING_ACR_TOKEN’

PREPARING = ‘PREPARING’

RETIRED = ‘RETIRED’

RETIRING = ‘RETIRING’

SUBMITTED = ‘SUBMITTED’

class TrimbleCloud.Processing.models.EnvironmentVariable

Bases: TypedDict

TypedDict representation of an Environment Variable object

value

The value for this environment variable

  • Type: str

container_var_name

The name of the environment variable inside the container (the Engine’s source code)

  • Type: str

container_var_name : str

value : str

class TrimbleCloud.Processing.models.Execution

Bases: TypedDict

TypedDict representation of an Execution object

id

The unique identifier for the Execution

  • Type: str

procedure_id

The unique identifier of the target Procedure

  • Type: str

data_export

Whether or not the execution’s data will be available for export

  • Type: bool

region

Region name for the Execution to run in

  • Type: str

parameters

Mapping of Procedure-specified parameter names to parameter values

  • Type: dict[str, str]

procedure_identifier

The identifier of the target Procedure for Execution

  • Type: str

procedure_version

The version of the target Procedure for Execution

  • Type: int

progress

The execution status of an Execution describes its processing status

metadata

User-specified metadata to be associated with the Execution

  • Type: str

created_at

Timestamp for the Execution’s creation

  • Type: str

updated_at

Timestamp for Execution’s latest update

  • Type: str

submitted_at

Timestamp for Execution’s latest submission (start)

  • Type: str

completed_at

Timestamp for Execution’s completion, if applicable

  • Type: str

failed_at

Timestamp for Execution’s failure, if applicable

  • Type: str

bound_parameters

Mapping of Operation-specified output parameter names to output parameter values

  • Type: dict

bound_parameters : dict

completed_at : str

created_at : str

data_export : bool

failed_at : str

id : str

metadata : str

parameters : Dict[str, str]

procedure_id : str

procedure_identifier : str

procedure_version : int

progress : Progress

region : str

submitted_at : str

updated_at : str

class TrimbleCloud.Processing.models.ExecutionStatus(value)

Bases: str, Enum

Represents the execution status of an object

NOT_READY

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

READY

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

SUSPENDED

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

NOT_READY = ‘NOT_READY’

READY = ‘READY’

SUSPENDED = ‘SUSPENDED’

class TrimbleCloud.Processing.models.IngestionType(value)

Bases: str, Enum

Represents the method of uploading a container image into the system. Currently the only option is a temporary ACR token upload.

ACR_TOKEN

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

ACR_TOKEN = ‘acr_token’

class TrimbleCloud.Processing.models.Input

Bases: TypedDict

TypedDict representation of an Input object in an Operation

data_types

List of accepted input data types

  • Type: list[str]

optional

Whether the input file is optional or not

  • Type: bool

name

Human readable name of the input

  • Type: str

description

Descriptive text for the input type

  • Type: str

data_types : List[str]

description : str

name : str

optional : bool

class TrimbleCloud.Processing.models.OSBuild(value)

Bases: str, Enum

Represents the OS build of the Engine

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 2019 OS build

WINDOWS_SERVER_2022

Windows Server 2022 OS build

WINDOWS_SERVER_2019 = ‘10.0.17763’

WINDOWS_SERVER_2022 = ‘10.0.20348’

class TrimbleCloud.Processing.models.OSType(value)

Bases: str, Enum

Represents the OS of the Engine

LINUX

Linux Engine

WINDOWS

Windows Engine

LINUX = ‘linux’

WINDOWS = ‘windows’

class TrimbleCloud.Processing.models.OpInput

Bases: TypedDict

TypedDict representation of an Operation’s input object in an Operation Chain

sources

Array wrapper for the source of an Operation’s input

  • Type: list[str]

data_types

Type of data output from the Operation

  • Type: str

data_types : str

sources : List[str]

class TrimbleCloud.Processing.models.OpOutput

Bases: TypedDict

TypedDict representation of an Operation’s output object in an Operation Chain

data_type

Type of data output from the Operation

  • Type: str

description

Descriptive text for the output and its type

  • Type: str

name

Human readable name of the output

  • Type: str

data_type : str

description : str

name : str

class TrimbleCloud.Processing.models.OpParameter

Bases: TypedDict

TypedDict representation of an Operation’s parameter object in an Operation Chain

source

The source of the Operation parameter. The source could be a Procedure parameter input by the user or another Operation’s output parameter.

  • Type: str

optional

Whether the parameter is optional or required

  • Type: bool

optional : bool

source : str

class TrimbleCloud.Processing.models.Operation

Bases: TypedDict

TypedDict representation of an Operation object

id

The unique identifier for the Operation

  • Type: str

identifier

Unique identifier string for the Operation

  • Type: str

version

The version of the Operation

  • Type: int

deployment_identifier

The identifier of the Deployment that supports this Operation

  • Type: str

regions

List of regions where Operation is allowed to run in

  • Type: list[str]

public

Whether the Operation should be public or not

  • Type: bool

status

The status of the Operation

execution_status

The execution status of the Operation

account_id

The TID account identifier of the owner of this Operation

  • Type: str

client_id

The TID subject identifier (client ID) of the owner of this Operation

  • Type: str

name

The name of the Operation

  • Type: str

description

A description of the Operation and its function

  • Type: str

engine_name

The name of the backend engine that supports this Operation

  • Type: str

shared_with

List of identities with whom this Operation has been shared. Each entry contains an account_id 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.

parameters

Parameter objects attached to the Operation

output_parameters

Parameter objects that define values to be output from an Operation

inputs

Named inputs for the Operation

outputs

Named outputs for the Operation

dynamic_output

Indicates whether or not the Output content is considered dynamic

  • Type: bool

deprecation_message

A message indicating that the Operation is deprecated

  • Type: str

retired_after

The date after which the Operation is retired

  • Type: str

account_id : str

client_id : str

deployment_identifier : str

deprecation_message : str

description : str

dynamic_output : bool

engine_name : str

execution_status : ExecutionStatus

id : str

identifier : str

inputs : Dict[str, Input]

name : str

output_parameters : Dict[str, OutputParameter]

outputs : Dict[str, Output]

parameters : Dict[str, Parameter]

public : bool

regions : List[str]

retired_after : str

shared_with : List[SharedWithIdentity]

status : Status

version : int

class TrimbleCloud.Processing.models.OperationChain

Bases: TypedDict

TypedDict representation of an Operation Chain object in a Procedure

This is where the user specifies which Procedures make up the Procedure and how those Operations chain together.

identifier

Unique identifier string for the operation

  • Type: str

version

The version of the Operation

  • Type: int

engine_name

The name of the backend engine that supports this operation

  • Type: str

encrypted_parameters

List of Operation parameters defined with encrypted: true

  • Type: list[str]

parameters

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

inputs

Named inputs for the Operation

outputs

Outputs should be defined in the Procedure definition only when a Switcher Operation is being utilized. If no Switcher is being specified, then outputs should not be defined.

output_parameters

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

name

Human-readable name of the Operation

  • Type: str

description

A description of an operation and its function

  • Type: str

description : str

encrypted_parameters : List[str]

engine_name : str

identifier : str

inputs : Dict[str, OpInput]

name : str

output_parameters : Dict[str, OutputParameter]

outputs : Dict[str, OpOutput]

parameters : Dict[str, OpParameter]

version : int

class TrimbleCloud.Processing.models.Output

Bases: TypedDict

TypedDict representation of an Output object in an Operation

data_type

Type of data output from the Operation

  • Type: str

description

Descriptive text for the output and its type

  • Type: str

name

Human readable name of the output

  • Type: str

data_type : str

description : str

name : str

class TrimbleCloud.Processing.models.OutputParameter

Bases: TypedDict

TypedDict representation of an Operation’s output parameter

type

Data type of the output parameter

optional

Whether the parameter is optional or required

  • Type: bool

description

Descriptive text for the output parameter

  • Type: str

name

Human readable name of the output parameter

  • Type: str

description : str

name : str

optional : bool

type : DataType

class TrimbleCloud.Processing.models.Parameter

Bases: TypedDict

TypedDict representation of a parameter object in an Operation

Parameter defines the options and arguments supplied to the Operation.

type

The data type of the parameter

optional

Describes whether the parameter is required or optional

  • Type: bool

name

Human-readable name for the parameter

  • Type: str

description

Descriptive text for the input parameter

  • Type: str

encrypted

Indicates that the parameter contains sensitive information

  • Type: bool

description : str

encrypted : bool

name : str

optional : bool

type : DataType

class TrimbleCloud.Processing.models.Procedure

Bases: TypedDict

TypedDict representation of a Procedure object

id

The unique identifier for the Procedure

  • Type: str

identifier

Unique identifier string for the Procedure

  • Type: str

version

The version of the Procedure

  • Type: int

account_id

The TID account identifier of the owner of this Procedure

  • Type: str

client_id

The TID subject identifier (client ID) of the owner of this Procedure

  • Type: str

name

The name of the Procedure

  • Type: str

description

A description of the Procedure and its function

  • Type: str

status

The status of the Procedure

execution_status

The execution status of the Procedure

tags

List of tags (as strings) associated with the Procedure

  • Type: str

documentation_url

Optional URL to reference external documentation for the Procedure

  • Type: str

retired_after

The date after which the Procedure is retired

  • Type: str

shared_with

List of identities with whom this Procedure has been shared. Each entry contains an account_id 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.

public

Whether the Procedure should be public or not

  • Type: bool

regions

List of regions where Procedure is allowed to run in

  • Type: list[str]

default_region

Region name the Procedure should execute in by default

  • Type: str

operations

Mapping of Procedure names and definitions

parameters

Parameter mappings for the Procedures contained within the Procedure

account_id : str

client_id : str

default_region : str

description : str

documentation_url : str

execution_status : ExecutionStatus

id : str

identifier : str

name : str

operations : Dict[str, OperationChain]

parameters : Dict[str, ProcedureParameter]

public : bool

regions : List[str]

retired_after : str

shared_with : List[SharedWithIdentity]

status : Status

tags : str

version : int

class TrimbleCloud.Processing.models.ProcedureParameter

Bases: TypedDict

TypedDict representation of a parameter object in a Procedure

type

The type of the Procedure parameter

  • Type: str

default_value

The default value for the Procedure parameter

  • Type: str

name

Human readable name for the Procedure parameter

  • Type: str

description

Description for the Procedure parameter

  • Type: str

source

String parameter

  • Type: str

value

Value of the parameter

  • Type: str

default_value : str

description : str

name : str

source : str

type : str

value : str

class TrimbleCloud.Processing.models.Progress(value)

Bases: str, Enum

Represents the progress of an Execution

UNSUBMITTED

The execution was not successfully submitted to SWF

SUBMITTED

The execution was successfully submitted to SWF for handling by the Decider

WAITING

The underlying procedure is locked, causing the execution to wait for the procedure to be unlocked

QUEUED

Execution has been submitted for processing and is waiting in a processing queue

EXECUTING

The decider has handled the Execution and is waiting for operations to be processed

FAILED

Processing of one or more Operations failed

FINISHED

Processing has been completed

EXECUTING = ‘EXECUTING’

FAILED = ‘FAILED’

FINISHED = ‘FINISHED’

QUEUED = ‘QUEUED’

SUBMITTED = ‘SUBMITTED’

UNSUBMITTED = ‘UNSUBMITTED’

WAITING = ‘WAITING’

class TrimbleCloud.Processing.models.Scaling

Bases: TypedDict

TypedDict representation of a Scaling object

It defines the minimum and maximum number of concurrent Engines that can be running simultaneously.

min

The minimum number of Engines that can be running simultaneously. Constraints: Min 0

  • Type: int

max

The maximum number of Engines that can be running simultaneously. Constraints: Min 0

  • Type: int

max : int

min : int

class TrimbleCloud.Processing.models.SecretFile

Bases: TypedDict

TypedDict representation of a Secret file object

secret_identifier

The expected identifier of a Deployment Secret

  • Type: str

container_file_path

The file path of an ingested Deployment Secret file

  • Type: str

container_file_path : str

secret_identifier : str

class TrimbleCloud.Processing.models.SecretVariable

Bases: TypedDict

TypedDict representation of a Secret Variable object

secret_identifier

The expected identifier of a Deployment Secret

  • Type: str

container_var_name

The name of the environment variable inside the container (the Engine’s source code)

  • Type: str

container_var_name : str

secret_identifier : str

class TrimbleCloud.Processing.models.SharedWithIdentity

Bases: dict

TypedDict representation of a SharedWith identity object

account_id

The TID account identifier to share with.

  • Type: str

client_id

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

  • Type: str

account_id : str

client_id : str

class TrimbleCloud.Processing.models.Status(value)

Bases: str, Enum

Represents the status of an object

MUTABLE

The object is new and can still be altered

EXECUTABLE

The object is ready to be executed and can no longer be altered

RETIRED

The object has been retired from service and can no longer be executed

EXECUTABLE = ‘EXECUTABLE’

MUTABLE = ‘MUTABLE’

RETIRED = ‘RETIRED’

class TrimbleCloud.Processing.models.SyncPagedItem(*args: Any, **kwargs: Any)

Bases: Iterator[ReturnType]

by_page(current_page: int | None = 1) → Iterator[Iterator[ReturnType]]

Get an iterator of pages of objects, instead of an iterator of objects.

  • Parameters: current_page (int) – The current page number to start from. If specified, this generator will begin returning results from this point.
  • Returns: An iterator of pages (themselves iterator of objects)
  • Return type: iterator[iterator[ReturnType]]