UseWorkflow 0.29.0-beta API

All Implemented Interfaces:

io.typeflows.util.Renderable
```
public final class UseWorkflow
extends Step
                    
```
A workflow step that calls a reusable workflow.
UseWorkflow enables the invocation of reusable workflows, which are workflows designed to be called by other workflows. This promotes modularity and code reuse across different workflow definitions. Reusable workflows can accept inputs, produce outputs, and use secrets passed from the calling workflow. The workflow reference can point to local workflows in the same repository or external workflows in other repositories, supporting both workflow composition and cross-repository automation patterns.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`public final class`	`UseWorkflow.DSL`
`public class`	`UseWorkflow.Companion`

Field Summary

Fields
Modifier and Type	Field	Description
`public final String`	`workflow`
`public final List<Output<?>>`	`outputs`
`public final List<Secret<?>>`	`secrets`
`public final Map<String, Object>`	`env`
`public final Map<String, Object>`	`with`
`public final Integer`	`timeoutMinutes`
`public final Boolean`	`continueOnError`
`public final Path`	`workingDirectory`
`private final String`	`name`
`public final String`	`id`
`public final Expression`	`condition`
`public final Map<String, Object>`	`extra`
`public final static UseWorkflow.Companion`	`Companion`

Constructor Summary

Constructors
Constructor	Description

Enum Constant Summary

Enum Constants
Enum Constant	Description

Method Summary

Modifier and Type	Method	Description
`final String`	`getName()`
`Map<String, Object>`	`render()`
`final static UseWorkflow`	`create(String workflow, String name, Configure<UseWorkflow.DSL> step)`	Creates and configures a UseWorkflow instance.
`final static UseWorkflow`	`create(String workflow, String name)`	Creates and configures a UseWorkflow instance.
`final static UseWorkflow`	`create(String workflow)`	Creates and configures a UseWorkflow instance.

Methods inherited from class io.typeflows.util.Base
equals, hashCode, toString
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
- Method Detail
  - getName
```
 final String getName()
```
  - render
```
 Map<String, Object> render()
```
  - create
```
@JvmOverloads() final static UseWorkflow create(String workflow, String name, Configure<UseWorkflow.DSL> step)
```
    Creates and configures a UseWorkflow instance.
    
    Parameters:
    
    workflow - The workflow reference (local path or external reference)
    
    name - Optional name for the step (for logging and identification)
    
    step - Configuration lambda to customize the step
    
    Returns:
    
    Configured UseWorkflow instance
  - create
```
@JvmOverloads() final static UseWorkflow create(String workflow, String name)
```
    Creates and configures a UseWorkflow instance.
    
    Parameters:
    
    workflow - The workflow reference (local path or external reference)
    
    name - Optional name for the step (for logging and identification)
    
    Returns:
    
    Configured UseWorkflow instance
  - create
```
@JvmOverloads() final static UseWorkflow create(String workflow)
```
    Creates and configures a UseWorkflow instance.
    
    Parameters:
    
    workflow - The workflow reference (local path or external reference)
    
    Returns:
    
    Configured UseWorkflow instance