Package flyteidl.core

Interface Workflow.WorkflowTemplateOrBuilder

    • Method Detail

      • hasId

        boolean hasId()
         A globally unique identifier for the workflow.
        .flyteidl.core.Identifier id = 1;
        Returns:
        Whether the id field is set.

      • hasMetadata

        boolean hasMetadata()
         Extra metadata about the workflow.
        .flyteidl.core.WorkflowMetadata metadata = 2;
        Returns:
        Whether the metadata field is set.

      • getMetadata

        Workflow.WorkflowMetadata getMetadata()
         Extra metadata about the workflow.
        .flyteidl.core.WorkflowMetadata metadata = 2;
        Returns:
        The metadata.

      • hasInterface

        boolean hasInterface()
         Defines a strongly typed interface for the Workflow. This can include some optional parameters.
        .flyteidl.core.TypedInterface interface = 3;
        Returns:
        Whether the interface field is set.

      • getInterface

        Interface.TypedInterface getInterface()
         Defines a strongly typed interface for the Workflow. This can include some optional parameters.
        .flyteidl.core.TypedInterface interface = 3;
        Returns:
        The interface.

      • getInterfaceOrBuilder

        Interface.TypedInterfaceOrBuilder getInterfaceOrBuilder()
         Defines a strongly typed interface for the Workflow. This can include some optional parameters.
        .flyteidl.core.TypedInterface interface = 3;

      • getNodesList

        List<Workflow.Node> getNodesList()
         A list of nodes. In addition, 'globals' is a special reserved node id that can be used to consume workflow inputs.
        repeated .flyteidl.core.Node nodes = 4;

      • getNodes

        Workflow.Node getNodes​(int index)
         A list of nodes. In addition, 'globals' is a special reserved node id that can be used to consume workflow inputs.
        repeated .flyteidl.core.Node nodes = 4;

      • getNodesCount

        int getNodesCount()
         A list of nodes. In addition, 'globals' is a special reserved node id that can be used to consume workflow inputs.
        repeated .flyteidl.core.Node nodes = 4;

      • getNodesOrBuilderList

        List<? extends Workflow.NodeOrBuilder> getNodesOrBuilderList()
         A list of nodes. In addition, 'globals' is a special reserved node id that can be used to consume workflow inputs.
        repeated .flyteidl.core.Node nodes = 4;

      • getNodesOrBuilder

        Workflow.NodeOrBuilder getNodesOrBuilder​(int index)
         A list of nodes. In addition, 'globals' is a special reserved node id that can be used to consume workflow inputs.
        repeated .flyteidl.core.Node nodes = 4;

      • getOutputsList

        List<Literals.Binding> getOutputsList()
         A list of output bindings that specify how to construct workflow outputs. Bindings can pull node outputs or
 specify literals. All workflow outputs specified in the interface field must be bound in order for the workflow
 to be validated. A workflow has an implicit dependency on all of its nodes to execute successfully in order to
 bind final outputs.
 Most of these outputs will be Binding's with a BindingData of type OutputReference.  That is, your workflow can
 just have an output of some constant (`Output(5)`), but usually, the workflow will be pulling
 outputs from the output of a task.
        repeated .flyteidl.core.Binding outputs = 5;

      • getOutputs

        Literals.Binding getOutputs​(int index)
         A list of output bindings that specify how to construct workflow outputs. Bindings can pull node outputs or
 specify literals. All workflow outputs specified in the interface field must be bound in order for the workflow
 to be validated. A workflow has an implicit dependency on all of its nodes to execute successfully in order to
 bind final outputs.
 Most of these outputs will be Binding's with a BindingData of type OutputReference.  That is, your workflow can
 just have an output of some constant (`Output(5)`), but usually, the workflow will be pulling
 outputs from the output of a task.
        repeated .flyteidl.core.Binding outputs = 5;

      • getOutputsCount

        int getOutputsCount()
         A list of output bindings that specify how to construct workflow outputs. Bindings can pull node outputs or
 specify literals. All workflow outputs specified in the interface field must be bound in order for the workflow
 to be validated. A workflow has an implicit dependency on all of its nodes to execute successfully in order to
 bind final outputs.
 Most of these outputs will be Binding's with a BindingData of type OutputReference.  That is, your workflow can
 just have an output of some constant (`Output(5)`), but usually, the workflow will be pulling
 outputs from the output of a task.
        repeated .flyteidl.core.Binding outputs = 5;

      • getOutputsOrBuilderList

        List<? extends Literals.BindingOrBuilder> getOutputsOrBuilderList()
         A list of output bindings that specify how to construct workflow outputs. Bindings can pull node outputs or
 specify literals. All workflow outputs specified in the interface field must be bound in order for the workflow
 to be validated. A workflow has an implicit dependency on all of its nodes to execute successfully in order to
 bind final outputs.
 Most of these outputs will be Binding's with a BindingData of type OutputReference.  That is, your workflow can
 just have an output of some constant (`Output(5)`), but usually, the workflow will be pulling
 outputs from the output of a task.
        repeated .flyteidl.core.Binding outputs = 5;

      • getOutputsOrBuilder

        Literals.BindingOrBuilder getOutputsOrBuilder​(int index)
         A list of output bindings that specify how to construct workflow outputs. Bindings can pull node outputs or
 specify literals. All workflow outputs specified in the interface field must be bound in order for the workflow
 to be validated. A workflow has an implicit dependency on all of its nodes to execute successfully in order to
 bind final outputs.
 Most of these outputs will be Binding's with a BindingData of type OutputReference.  That is, your workflow can
 just have an output of some constant (`Output(5)`), but usually, the workflow will be pulling
 outputs from the output of a task.
        repeated .flyteidl.core.Binding outputs = 5;

      • hasFailureNode

        boolean hasFailureNode()
        +optional A catch-all node. This node is executed whenever the execution engine determines the workflow has failed.
 The interface of this node must match the Workflow interface with an additional input named 'error' of type
 pb.lyft.flyte.core.Error.
        .flyteidl.core.Node failure_node = 6;
        Returns:
        Whether the failureNode field is set.

      • getFailureNode

        Workflow.Node getFailureNode()
        +optional A catch-all node. This node is executed whenever the execution engine determines the workflow has failed.
 The interface of this node must match the Workflow interface with an additional input named 'error' of type
 pb.lyft.flyte.core.Error.
        .flyteidl.core.Node failure_node = 6;
        Returns:
        The failureNode.

      • getFailureNodeOrBuilder

        Workflow.NodeOrBuilder getFailureNodeOrBuilder()
        +optional A catch-all node. This node is executed whenever the execution engine determines the workflow has failed.
 The interface of this node must match the Workflow interface with an additional input named 'error' of type
 pb.lyft.flyte.core.Error.
        .flyteidl.core.Node failure_node = 6;

      • hasMetadataDefaults

        boolean hasMetadataDefaults()
         workflow defaults
        .flyteidl.core.WorkflowMetadataDefaults metadata_defaults = 7;
        Returns:
        Whether the metadataDefaults field is set.

      • getMetadataDefaults

        Workflow.WorkflowMetadataDefaults getMetadataDefaults()
         workflow defaults
        .flyteidl.core.WorkflowMetadataDefaults metadata_defaults = 7;
        Returns:
        The metadataDefaults.