Package flyteidl.core

Class Workflow.WorkflowTemplate

  • All Implemented Interfaces:
    com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Workflow.WorkflowTemplateOrBuilder, Serializable
    Enclosing class:
    Workflow
    public static final class Workflow.WorkflowTemplate
extends com.google.protobuf.GeneratedMessageV3
implements Workflow.WorkflowTemplateOrBuilder
     Flyte Workflow Structure that encapsulates task, branch and subworkflow nodes to form a statically analyzable,
 directed acyclic graph.
    Protobuf type flyteidl.core.WorkflowTemplate
    See Also:
    Serialized Form

    • Constructor Detail

      • WorkflowTemplate

        private WorkflowTemplate​(com.google.protobuf.GeneratedMessageV3.Builder<?> builder)

      • WorkflowTemplate

        private WorkflowTemplate()

    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3

      • getUnknownFields

        public final com.google.protobuf.UnknownFieldSet getUnknownFields()
        Specified by:
        getUnknownFields in interface com.google.protobuf.MessageOrBuilder
        Overrides:
        getUnknownFields in class com.google.protobuf.GeneratedMessageV3

      • getDescriptor

        public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

      • hasId

        public boolean hasId()
         A globally unique identifier for the workflow.
        .flyteidl.core.Identifier id = 1;
        Specified by:
        hasId in interface Workflow.WorkflowTemplateOrBuilder
        Returns:
        Whether the id field is set.

      • hasMetadata

        public boolean hasMetadata()
         Extra metadata about the workflow.
        .flyteidl.core.WorkflowMetadata metadata = 2;
        Specified by:
        hasMetadata in interface Workflow.WorkflowTemplateOrBuilder
        Returns:
        Whether the metadata field is set.

      • hasInterface

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

      • getNodesCount

        public 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;
        Specified by:
        getNodesCount in interface Workflow.WorkflowTemplateOrBuilder

      • getNodes

        public 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;
        Specified by:
        getNodes in interface Workflow.WorkflowTemplateOrBuilder

      • getOutputsList

        public 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;
        Specified by:
        getOutputsList in interface Workflow.WorkflowTemplateOrBuilder

      • getOutputsOrBuilderList

        public 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;
        Specified by:
        getOutputsOrBuilderList in interface Workflow.WorkflowTemplateOrBuilder

      • getOutputsCount

        public 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;
        Specified by:
        getOutputsCount in interface Workflow.WorkflowTemplateOrBuilder

      • getOutputs

        public 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;
        Specified by:
        getOutputs in interface Workflow.WorkflowTemplateOrBuilder

      • getOutputsOrBuilder

        public 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;
        Specified by:
        getOutputsOrBuilder in interface Workflow.WorkflowTemplateOrBuilder

      • hasFailureNode

        public 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;
        Specified by:
        hasFailureNode in interface Workflow.WorkflowTemplateOrBuilder
        Returns:
        Whether the failureNode field is set.

      • getFailureNode

        public 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;
        Specified by:
        getFailureNode in interface Workflow.WorkflowTemplateOrBuilder
        Returns:
        The failureNode.

      • getFailureNodeOrBuilder

        public 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;
        Specified by:
        getFailureNodeOrBuilder in interface Workflow.WorkflowTemplateOrBuilder

      • hasMetadataDefaults

        public boolean hasMetadataDefaults()
         workflow defaults
        .flyteidl.core.WorkflowMetadataDefaults metadata_defaults = 7;
        Specified by:
        hasMetadataDefaults in interface Workflow.WorkflowTemplateOrBuilder
        Returns:
        Whether the metadataDefaults field is set.

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3

      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
             throws IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        IOException

      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessageV3

      • equals

        public boolean equals​(Object obj)
        Specified by:
        equals in interface com.google.protobuf.Message
        Overrides:
        equals in class com.google.protobuf.AbstractMessage

      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface com.google.protobuf.Message
        Overrides:
        hashCode in class com.google.protobuf.AbstractMessage

      • parseFrom

        public static Workflow.WorkflowTemplate parseFrom​(ByteBuffer data)
                                           throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Workflow.WorkflowTemplate parseFrom​(ByteBuffer data,
                                                  com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                           throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Workflow.WorkflowTemplate parseFrom​(com.google.protobuf.ByteString data)
                                           throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Workflow.WorkflowTemplate parseFrom​(com.google.protobuf.ByteString data,
                                                  com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                           throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Workflow.WorkflowTemplate parseFrom​(byte[] data)
                                           throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Workflow.WorkflowTemplate parseFrom​(byte[] data,
                                                  com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                           throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • newBuilderForType

        public Workflow.WorkflowTemplate.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite

      • toBuilder

        public Workflow.WorkflowTemplate.Builder toBuilder()
        Specified by:
        toBuilder in interface com.google.protobuf.Message
        Specified by:
        toBuilder in interface com.google.protobuf.MessageLite

      • newBuilderForType

        protected Workflow.WorkflowTemplate.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • getParserForType

        public com.google.protobuf.Parser<Workflow.WorkflowTemplate> getParserForType()
        Specified by:
        getParserForType in interface com.google.protobuf.Message
        Specified by:
        getParserForType in interface com.google.protobuf.MessageLite
        Overrides:
        getParserForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstanceForType

        public Workflow.WorkflowTemplate getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder