Automation outputs

This page will present examples and details about each type of automation outputs. For most output types, there are examples of how to define outputs that produce a single value or multiple values (list).

String

This input object represents a string value and its type is str.

Example:

string_output = Output(
    str, 
    name='String output',
    description='A string output.'
)

Attributes:

name - String. Name of the string output.
description - String. Text description that provides more details about the string output.

Boolean

Boolean output whose type is defined as bool. Possible values can be Null, True or False.

Example:

boolean_output = Output(
    bool, 
    name='Boolean output',
    description='A boolean output.'
)

Attributes:

name - String. Name of the boolean output.
description - String. Text description that provides more details about the boolean output.

Integer

Integer input whose type is defined as int. Does not allow values like 0.3 as they are considered as a float.

Example:

integer_output = Output(
    int, 
    name='Integer output',
    description='An integer output.'
)

Attributes:

name - String. Name of the integer output.
description - String. Text description that provides more details about the integer output.

Float

Float input whose type is defined as float.

Example:

float_output = Output(
    float, 
    name='Float output',
    description='A float output.'
)

Attributes:

name - String. Name of the integer output.
description - String. Text description that provides more details about the integer output.

File

This output object represents a Platform file.

Example:

output_file = Output(
    File, 
    name='Single file output', 
    description='A single file output'
)

Attributes:

name - String. Name of the File output.
description - String. Text description that provides more details about the File output.

Multiple-file outputs

When multiple files need to be produced on a single output, the type of output in the example above needs to be changed to List[File] as shown below:

output_file = Output(
    List[File], 
    name='Multiple file output', 
    description='A multi-file output'
)

Folder

This output object represents a folder on the Platform.

Example:

folder_output = Output(
    Folder,
    name='Single folder output',
    description='A folder output'
)

Attributes:

name - String. Name of the Folder output.
description - String. Text description that provides more details about the Folder output.

Multiple-folder outputs

When multiple folders need to be produced on a single output, the type of output in the example above needs to be changed to List[Folder] as shown below:

folders_output = Output(
    List[Folder], 
    name='Multi-folder output',
    description='Multiple folders output'
)

VolumeFile

This output type produces a file on a volume that is attached to the Platform.

Example:

volume_file_output = Output( 
    VolumeFile, 
    name='Single volume file output',
    description='Multiple volume file output description'
)

Attributes:

name - String. Name of the VolumeFile output.
description - String. Text description that provides more details about the VolumeFile output.

To convert a file that has already been exported to a volume into a VolumeFile object that can become an automation output, use the VolumeFile.from_file() utility function, as shown in the example below:

class Main(Step):
    out = Output(VolumeFile)
     
    def execute(self):
        file = ExportFile('My export', to_volume=myVolume, file=myFile).exported_file
        self.out = VolumeFile.from_file(file)

Multiple volume file outputs

When multiple volume files need to be produced on a single output, the type of output in the example above needs to be changed to List[VolumeFile] as shown below:

volume_files_output = Output( 
    List[VolumeFile], 
    name='Multiple volume files output',
    description='Single file description'
)

VolumeFolder

This output type produces a folder on a volume that is attached to the Platform.

Example:

volume_folder_output = Output(
    VolumeFolder, 
    name='Single volume folder output',
    description='Volume folder output description'
)

Attributes:

name - String. Name of the VolumeFolder output.
description - String. Text description that provides more details about the VolumeFolder output.

Multiple volume folder outputs

When multiple volume folders need to be produced on a single output, the type of output in the example above needs to be changed to List[VolumeFolder] as shown below:

volume_folders_output = Output(
    List[VolumeFolder], 
    name='Multiple volume folders output',
    description='Multiple volume folders output description'
)

Task

This output type creates a task on the Platform and its type is Task. This Platform-specific type is only supported for outputs, but not for inputs.

Example:

task_output = Output(
    Task, 
    name='Single task output',
    description='Single task output description'
)

Attributes:

name - String. Name of the Task output.
description - String. Text description that provides more details about the Task output.

Multi-task outputs

When multiple tasks need to be produced on a single output, the type of output in the example above needs to be changed to List[Task] as shown below:

tasks_output = Output(
    List[Task], 
    name='Multiple tasks output',
    description='Multiple tasks output description'
)

Project

This output type creates a project on the Platform and its type is Project.

Example:

Output(
    Project, 
    name='Project output', 
    description='Project output description'
)

Attributes:

name - String. Name of the Project output.
description - String. Text description that provides more details about the Project output.