Package io.tiledb.cloud.rest_api.model

Class TaskGraphNode

  • @Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2023-10-02T12:25:58.319138+03:00[Europe/Athens]")
public class TaskGraphNode
extends java.lang.Object
    Information about a single node within a registered task graph. A single node represents one piece of data or a computational step; either as an input value, a data source, or a computation that acts upon earlier nodes. The structure parallels the existing `TaskGraphNodeMetadata`.

    • Field Detail

      • SERIALIZED_NAME_CLIENT_NODE_ID

        public static final java.lang.String SERIALIZED_NAME_CLIENT_NODE_ID
        See Also:
        Constant Field Values

      • SERIALIZED_NAME_NAME

        public static final java.lang.String SERIALIZED_NAME_NAME
        See Also:
        Constant Field Values

      • SERIALIZED_NAME_DEPENDS_ON

        public static final java.lang.String SERIALIZED_NAME_DEPENDS_ON
        See Also:
        Constant Field Values

      • SERIALIZED_NAME_ARRAY_NODE

        public static final java.lang.String SERIALIZED_NAME_ARRAY_NODE
        See Also:
        Constant Field Values

      • SERIALIZED_NAME_INPUT_NODE

        public static final java.lang.String SERIALIZED_NAME_INPUT_NODE
        See Also:
        Constant Field Values

      • SERIALIZED_NAME_SQL_NODE

        public static final java.lang.String SERIALIZED_NAME_SQL_NODE
        See Also:
        Constant Field Values

      • SERIALIZED_NAME_UDF_NODE

        public static final java.lang.String SERIALIZED_NAME_UDF_NODE
        See Also:
        Constant Field Values

      • SERIALIZED_NAME_RETRY_STRATEGY

        public static final java.lang.String SERIALIZED_NAME_RETRY_STRATEGY
        See Also:
        Constant Field Values

      • SERIALIZED_NAME_EXPAND_NODE_OUTPUT

        public static final java.lang.String SERIALIZED_NAME_EXPAND_NODE_OUTPUT
        See Also:
        Constant Field Values

      • SERIALIZED_NAME_DEADLINE

        public static final java.lang.String SERIALIZED_NAME_DEADLINE
        See Also:
        Constant Field Values

      • openapiFields

        public static java.util.HashSet<java.lang.String> openapiFields

      • openapiRequiredFields

        public static java.util.HashSet<java.lang.String> openapiRequiredFields

    • Constructor Detail

      • TaskGraphNode

        public TaskGraphNode()

    • Method Detail

      • clientNodeId

        public TaskGraphNode clientNodeId​(java.lang.String clientNodeId)

      • getClientNodeId

        @Nullable
public java.lang.String getClientNodeId()
        The client-generated UUID of the given graph node.
        Returns:
        clientNodeId

      • setClientNodeId

        public void setClientNodeId​(java.lang.String clientNodeId)

      • getName

        @Nullable
public java.lang.String getName()
        A client-specified name for the node. If provided, this must be unique.
        Returns:
        name

      • setName

        public void setName​(java.lang.String name)

      • dependsOn

        public TaskGraphNode dependsOn​(java.util.List<java.lang.String> dependsOn)

      • addDependsOnItem

        public TaskGraphNode addDependsOnItem​(java.lang.String dependsOnItem)

      • getDependsOn

        @Nullable
public java.util.List<java.lang.String> getDependsOn()
        The client_node_uuid of each node that this node depends upon. Used to define the structure of the graph.
        Returns:
        dependsOn

      • setDependsOn

        public void setDependsOn​(java.util.List<java.lang.String> dependsOn)

      • getArrayNode

        @Nullable
public UDFArrayDetails getArrayNode()
        Get arrayNode
        Returns:
        arrayNode

      • getInputNode

        @Nullable
public TGInputNodeData getInputNode()
        Get inputNode
        Returns:
        inputNode

      • getSqlNode

        @Nullable
public TGSQLNodeData getSqlNode()
        Get sqlNode
        Returns:
        sqlNode

      • getUdfNode

        @Nullable
public TGUDFNodeData getUdfNode()
        Get udfNode
        Returns:
        udfNode

      • getRetryStrategy

        @Nullable
public RetryStrategy getRetryStrategy()
        Get retryStrategy
        Returns:
        retryStrategy

      • setRetryStrategy

        public void setRetryStrategy​(RetryStrategy retryStrategy)

      • expandNodeOutput

        public TaskGraphNode expandNodeOutput​(java.lang.String expandNodeOutput)

      • getExpandNodeOutput

        @Nullable
public java.lang.String getExpandNodeOutput()
        Used to create dynamic tasks based on the output of another node. The other node's output must be a JSON list of values. The expansion process creates one task per item in the output list. The item is also passed as an argument to each task. The value is the client_node_uuid of the node that we want to expand.
        Returns:
        expandNodeOutput

      • setExpandNodeOutput

        public void setExpandNodeOutput​(java.lang.String expandNodeOutput)

      • deadline

        public TaskGraphNode deadline​(java.lang.Long deadline)

      • getDeadline

        @Nullable
public java.lang.Long getDeadline()
        Duration in seconds relative to the node start time which the node is allowed to run before it gets terminated.
        Returns:
        deadline

      • setDeadline

        public void setDeadline​(java.lang.Long deadline)

      • putAdditionalProperty

        public TaskGraphNode putAdditionalProperty​(java.lang.String key,
                                           java.lang.Object value)
        Set the additional (undeclared) property with the specified name and value. If the property does not already exist, create it otherwise replace it.

      • getAdditionalProperties

        public java.util.Map<java.lang.String,​java.lang.Object> getAdditionalProperties()
        Return the additional (undeclared) property.

      • getAdditionalProperty

        public java.lang.Object getAdditionalProperty​(java.lang.String key)
        Return the additional (undeclared) property with the specified name.

      • equals

        public boolean equals​(java.lang.Object o)
        Overrides:
        equals in class java.lang.Object

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object

      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object

      • validateJsonObject

        public static void validateJsonObject​(com.google.gson.JsonObject jsonObj)
                               throws java.io.IOException
        Validates the JSON Object and throws an exception if issues found
        Parameters:
        jsonObj - JSON Object
        Throws:
        java.io.IOException - if the JSON Object is invalid with respect to TaskGraphNode

      • fromJson

        public static TaskGraphNode fromJson​(java.lang.String jsonString)
                              throws java.io.IOException
        Create an instance of TaskGraphNode given an JSON string
        Parameters:
        jsonString - JSON string
        Returns:
        An instance of TaskGraphNode
        Throws:
        java.io.IOException - if the JSON string is invalid with respect to TaskGraphNode

      • toJson

        public java.lang.String toJson()
        Convert an instance of TaskGraphNode to an JSON string
        Returns:
        JSON string