Run.md

Run

a Run with only base properties

Properties

Name	Type	Description	Notes
id	string	the Run	[optional] [readonly] [default to undefined]
state	RunState		[optional] [default to undefined]
organizationId	string	the Organization id	[optional] [default to undefined]
createInfo	RunEditInfo	The details of the Run creation	[default to undefined]
workflowId	string	the Cosmo Tech compute cluster Argo Workflow Id to search	[optional] [default to undefined]
csmSimulationRun	string	the Cosmo Tech Simulation Run Id	[optional] [readonly] [default to undefined]
generateName	string	the base name for workflow name generation	[optional] [default to undefined]
workflowName	string	the Cosmo Tech compute cluster Argo Workflow Name	[optional] [default to undefined]
workspaceId	string	the Workspace Id	[optional] [readonly] [default to undefined]
workspaceKey	string	technical key for resource name convention and version grouping. Must be unique	[optional] [readonly] [default to undefined]
runnerId	string	the Runner Id	[optional] [readonly] [default to undefined]
solutionId	string	the Solution Id	[optional] [readonly] [default to undefined]
runTemplateId	string	the Solution Run Template id	[optional] [readonly] [default to undefined]
computeSize	string	the compute size needed for this Analysis. Standard sizes are basic and highcpu. Default is basic	[optional] [readonly] [default to undefined]
datasetList	Array<string>	the list of Dataset Id associated to this Run	[optional] [readonly] [default to undefined]
parametersValues	Array<RunTemplateParameterValue>	the list of Run Template parameters values	[optional] [readonly] [default to undefined]
nodeLabel	string	the node label request	[optional] [readonly] [default to undefined]
containers	Array<RunContainer>	the containers list. This information is not returned by the API.	[optional] [default to undefined]

Example

import { Run } from '@cosmotech/api-ts';

const instance: Run = {
    id,
    state,
    organizationId,
    createInfo,
    workflowId,
    csmSimulationRun,
    generateName,
    workflowName,
    workspaceId,
    workspaceKey,
    runnerId,
    solutionId,
    runTemplateId,
    computeSize,
    datasetList,
    parametersValues,
    nodeLabel,
    containers,
};

[Back to Model list] [Back to API list] [Back to README]