Package flyteidl.core

Class Workflow.Node

  • All Implemented Interfaces:
    com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Workflow.NodeOrBuilder, Serializable
    Enclosing class:
    Workflow

    public static final class Workflow.Node
    extends com.google.protobuf.GeneratedMessageV3
    implements Workflow.NodeOrBuilder
     A Workflow graph Node. One unit of execution in the graph. Each node can be linked to a Task, a Workflow or a branch
     node.
     
    Protobuf type flyteidl.core.Node
    See Also:
    Serialized Form
    • Constructor Detail

      • Node

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

        private Node()
    • 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
      • getId

        public String getId()
         A workflow-level unique identifier that identifies this node in the workflow. 'inputs' and 'outputs' are reserved
         node ids that cannot be used by other nodes.
         
        string id = 1;
        Specified by:
        getId in interface Workflow.NodeOrBuilder
        Returns:
        The id.
      • getIdBytes

        public com.google.protobuf.ByteString getIdBytes()
         A workflow-level unique identifier that identifies this node in the workflow. 'inputs' and 'outputs' are reserved
         node ids that cannot be used by other nodes.
         
        string id = 1;
        Specified by:
        getIdBytes in interface Workflow.NodeOrBuilder
        Returns:
        The bytes for id.
      • hasMetadata

        public boolean hasMetadata()
         Extra metadata about the node.
         
        .flyteidl.core.NodeMetadata metadata = 2;
        Specified by:
        hasMetadata in interface Workflow.NodeOrBuilder
        Returns:
        Whether the metadata field is set.
      • getInputsList

        public List<Literals.Binding> getInputsList()
         Specifies how to bind the underlying interface's inputs. All required inputs specified in the underlying interface
         must be fulfilled.
         
        repeated .flyteidl.core.Binding inputs = 3;
        Specified by:
        getInputsList in interface Workflow.NodeOrBuilder
      • getInputsCount

        public int getInputsCount()
         Specifies how to bind the underlying interface's inputs. All required inputs specified in the underlying interface
         must be fulfilled.
         
        repeated .flyteidl.core.Binding inputs = 3;
        Specified by:
        getInputsCount in interface Workflow.NodeOrBuilder
      • getInputs

        public Literals.Binding getInputs​(int index)
         Specifies how to bind the underlying interface's inputs. All required inputs specified in the underlying interface
         must be fulfilled.
         
        repeated .flyteidl.core.Binding inputs = 3;
        Specified by:
        getInputs in interface Workflow.NodeOrBuilder
      • getInputsOrBuilder

        public Literals.BindingOrBuilder getInputsOrBuilder​(int index)
         Specifies how to bind the underlying interface's inputs. All required inputs specified in the underlying interface
         must be fulfilled.
         
        repeated .flyteidl.core.Binding inputs = 3;
        Specified by:
        getInputsOrBuilder in interface Workflow.NodeOrBuilder
      • getUpstreamNodeIdsList

        public com.google.protobuf.ProtocolStringList getUpstreamNodeIdsList()
        +optional Specifies execution dependency for this node ensuring it will only get scheduled to run after all its
         upstream nodes have completed. This node will have an implicit dependency on any node that appears in inputs
         field.
         
        repeated string upstream_node_ids = 4;
        Specified by:
        getUpstreamNodeIdsList in interface Workflow.NodeOrBuilder
        Returns:
        A list containing the upstreamNodeIds.
      • getUpstreamNodeIdsCount

        public int getUpstreamNodeIdsCount()
        +optional Specifies execution dependency for this node ensuring it will only get scheduled to run after all its
         upstream nodes have completed. This node will have an implicit dependency on any node that appears in inputs
         field.
         
        repeated string upstream_node_ids = 4;
        Specified by:
        getUpstreamNodeIdsCount in interface Workflow.NodeOrBuilder
        Returns:
        The count of upstreamNodeIds.
      • getUpstreamNodeIds

        public String getUpstreamNodeIds​(int index)
        +optional Specifies execution dependency for this node ensuring it will only get scheduled to run after all its
         upstream nodes have completed. This node will have an implicit dependency on any node that appears in inputs
         field.
         
        repeated string upstream_node_ids = 4;
        Specified by:
        getUpstreamNodeIds in interface Workflow.NodeOrBuilder
        Parameters:
        index - The index of the element to return.
        Returns:
        The upstreamNodeIds at the given index.
      • getUpstreamNodeIdsBytes

        public com.google.protobuf.ByteString getUpstreamNodeIdsBytes​(int index)
        +optional Specifies execution dependency for this node ensuring it will only get scheduled to run after all its
         upstream nodes have completed. This node will have an implicit dependency on any node that appears in inputs
         field.
         
        repeated string upstream_node_ids = 4;
        Specified by:
        getUpstreamNodeIdsBytes in interface Workflow.NodeOrBuilder
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the upstreamNodeIds at the given index.
      • getOutputAliasesList

        public List<Workflow.Alias> getOutputAliasesList()
        +optional. A node can define aliases for a subset of its outputs. This is particularly useful if different nodes
         need to conform to the same interface (e.g. all branches in a branch node). Downstream nodes must refer to this
         nodes outputs using the alias if one's specified.
         
        repeated .flyteidl.core.Alias output_aliases = 5;
        Specified by:
        getOutputAliasesList in interface Workflow.NodeOrBuilder
      • getOutputAliasesOrBuilderList

        public List<? extends Workflow.AliasOrBuilder> getOutputAliasesOrBuilderList()
        +optional. A node can define aliases for a subset of its outputs. This is particularly useful if different nodes
         need to conform to the same interface (e.g. all branches in a branch node). Downstream nodes must refer to this
         nodes outputs using the alias if one's specified.
         
        repeated .flyteidl.core.Alias output_aliases = 5;
        Specified by:
        getOutputAliasesOrBuilderList in interface Workflow.NodeOrBuilder
      • getOutputAliasesCount

        public int getOutputAliasesCount()
        +optional. A node can define aliases for a subset of its outputs. This is particularly useful if different nodes
         need to conform to the same interface (e.g. all branches in a branch node). Downstream nodes must refer to this
         nodes outputs using the alias if one's specified.
         
        repeated .flyteidl.core.Alias output_aliases = 5;
        Specified by:
        getOutputAliasesCount in interface Workflow.NodeOrBuilder
      • getOutputAliases

        public Workflow.Alias getOutputAliases​(int index)
        +optional. A node can define aliases for a subset of its outputs. This is particularly useful if different nodes
         need to conform to the same interface (e.g. all branches in a branch node). Downstream nodes must refer to this
         nodes outputs using the alias if one's specified.
         
        repeated .flyteidl.core.Alias output_aliases = 5;
        Specified by:
        getOutputAliases in interface Workflow.NodeOrBuilder
      • getOutputAliasesOrBuilder

        public Workflow.AliasOrBuilder getOutputAliasesOrBuilder​(int index)
        +optional. A node can define aliases for a subset of its outputs. This is particularly useful if different nodes
         need to conform to the same interface (e.g. all branches in a branch node). Downstream nodes must refer to this
         nodes outputs using the alias if one's specified.
         
        repeated .flyteidl.core.Alias output_aliases = 5;
        Specified by:
        getOutputAliasesOrBuilder in interface Workflow.NodeOrBuilder
      • hasTaskNode

        public boolean hasTaskNode()
         Information about the Task to execute in this node.
         
        .flyteidl.core.TaskNode task_node = 6;
        Specified by:
        hasTaskNode in interface Workflow.NodeOrBuilder
        Returns:
        Whether the taskNode field is set.
      • hasWorkflowNode

        public boolean hasWorkflowNode()
         Information about the Workflow to execute in this mode.
         
        .flyteidl.core.WorkflowNode workflow_node = 7;
        Specified by:
        hasWorkflowNode in interface Workflow.NodeOrBuilder
        Returns:
        Whether the workflowNode field is set.
      • hasBranchNode

        public boolean hasBranchNode()
         Information about the branch node to evaluate in this node.
         
        .flyteidl.core.BranchNode branch_node = 8;
        Specified by:
        hasBranchNode in interface Workflow.NodeOrBuilder
        Returns:
        Whether the branchNode 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.Node parseFrom​(ByteBuffer data)
                                       throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

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

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

        public static Workflow.Node 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.Node parseFrom​(byte[] data)
                                       throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

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

        public static Workflow.Node parseFrom​(com.google.protobuf.CodedInputStream input,
                                              com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                       throws IOException
        Throws:
        IOException
      • newBuilderForType

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

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

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

        public static Workflow.Node getDefaultInstance()
      • parser

        public static com.google.protobuf.Parser<Workflow.Node> parser()
      • getParserForType

        public com.google.protobuf.Parser<Workflow.Node> 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.Node getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder