cdx-proto
    Preparing search index...

    Type Alias Workflow

    Workflow: Message<"cyclonedx.v1_6.Workflow"> & {
        bomRef: string;
        description?: string;
        inputs: cdx_16.InputType[];
        name?: string;
        outputs: cdx_16.OutputType[];
        properties: cdx_16.Property[];
        resourceReferences: cdx_16.ResourceReferenceChoice[];
        runtimeTopology: cdx_16.Dependency[];
        steps: cdx_16.Step[];
        taskDependencies: cdx_16.Dependency[];
        tasks: cdx_16.Task[];
        taskTypes: cdx_16.TaskType[];
        timeEnd?: Timestamp;
        timeStart?: Timestamp;
        trigger?: cdx_16.Trigger;
        uid: string;
        workspaces: cdx_16.Workspace[];
    }

    A specialized orchestration task.

    Type Declaration

    • bomRef: string

      BOM unique reference to the resource.

      from field: string bom_ref = 1;

    • Optionaldescription?: string

      A description of the resource instance.

      from field: optional string description = 4;

    • inputs: cdx_16.InputType[]

      Represents resources and data brought into a task at runtime by executor or task commands

      from field: repeated cyclonedx.v1_6.InputType inputs = 12;

    • Optionalname?: string

      The name of the resource instance.

      from field: optional string name = 3;

    • outputs: cdx_16.OutputType[]

      Represents resources and data output from a task at runtime by executor or task commands

      from field: repeated cyclonedx.v1_6.OutputType outputs = 13;

    • properties: cdx_16.Property[]

      Domain-specific resource instance properties.

      from field: repeated cyclonedx.v1_6.Property properties = 5;

    • resourceReferences: cdx_16.ResourceReferenceChoice[]

      References to component or service resources that are used to realize the resource instance.

      from field: repeated cyclonedx.v1_6.ResourceReferenceChoice resourceReferences = 6;

    • runtimeTopology: cdx_16.Dependency[]

      A graph of the component runtime topology for workflow's instance.

      from field: repeated cyclonedx.v1_6.Dependency runtimeTopology = 17;

    • steps: cdx_16.Step[]

      The sequence of steps for the task.

      from field: repeated cyclonedx.v1_6.Step steps = 11;

    • taskDependencies: cdx_16.Dependency[]

      The graph of dependencies between tasks within the workflow.

      from field: repeated cyclonedx.v1_6.Dependency taskDependencies = 8;

    • tasks: cdx_16.Task[]

      The tasks that comprise the workflow.

      from field: repeated cyclonedx.v1_6.Task tasks = 7;

    • taskTypes: cdx_16.TaskType[]

      Indicates the types of activities performed by the set of workflow tasks.

      from field: repeated cyclonedx.v1_6.TaskType taskTypes = 9;

    • OptionaltimeEnd?: Timestamp

      The date and time (timestamp) when the task ended.

      from field: optional google.protobuf.Timestamp timeEnd = 15;

    • OptionaltimeStart?: Timestamp

      The date and time (timestamp) when the task started.

      from field: optional google.protobuf.Timestamp timeStart = 14;

    • Optionaltrigger?: cdx_16.Trigger

      The trigger that initiated the task.

      from field: optional cyclonedx.v1_6.Trigger trigger = 10;

    • uid: string

      The unique identifier for the resource instance within its deployment context.

      from field: string uid = 2;

    • workspaces: cdx_16.Workspace[]

      A set of named filesystem or data resource shareable by workflow tasks.

      from field: repeated cyclonedx.v1_6.Workspace workspaces = 16;

    from message cyclonedx.v1_6.Workflow

    Settings

    Member Visibility