Package io.tiledb.cloud.rest_api.model

Class RegisteredTaskGraph

  • @Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2023-10-02T12:25:58.319138+03:00[Europe/Athens]")
public class RegisteredTaskGraph
extends java.lang.Object
    The structure and metadata of a task graph that can be stored on TileDB Cloud and executed by users who have access to it.

    • Field Detail

      • SERIALIZED_NAME_UUID

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

      • SERIALIZED_NAME_NAMESPACE

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

      • SERIALIZED_NAME_NAME

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

      • SERIALIZED_NAME_README

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

      • SERIALIZED_NAME_LICENSE_ID

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

      • SERIALIZED_NAME_LICENSE_TEXT

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

      • SERIALIZED_NAME_TAGS

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

      • SERIALIZED_NAME_NODES

        public static final java.lang.String SERIALIZED_NAME_NODES
        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

      • RegisteredTaskGraph

        public RegisteredTaskGraph()

    • Method Detail

      • getUuid

        @Nullable
public java.lang.String getUuid()
        A server-assigned unique ID for the UDF, in UUID format.
        Returns:
        uuid

      • setUuid

        public void setUuid​(java.lang.String uuid)

      • getNamespace

        @Nullable
public java.lang.String getNamespace()
        The namespace that owns this task graph log.
        Returns:
        namespace

      • setNamespace

        public void setNamespace​(java.lang.String namespace)

      • getName

        @Nullable
public java.lang.String getName()
        The name of this graph, to appear in URLs. Must be unique per-namespace.
        Returns:
        name

      • setName

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

      • getReadme

        @Nullable
public java.lang.String getReadme()
        Documentation for the task graph, in Markdown format.
        Returns:
        readme

      • setReadme

        public void setReadme​(java.lang.String readme)

      • getLicenseId

        @Nullable
public java.lang.String getLicenseId()
        SPDX license identifier.
        Returns:
        licenseId

      • setLicenseId

        public void setLicenseId​(java.lang.String licenseId)

      • getLicenseText

        @Nullable
public java.lang.String getLicenseText()
        Full text of the license.
        Returns:
        licenseText

      • setLicenseText

        public void setLicenseText​(java.lang.String licenseText)

      • getTags

        @Nullable
public java.util.List<java.lang.String> getTags()
        Optional tags to classify the graph.
        Returns:
        tags

      • setTags

        public void setTags​(java.util.List<java.lang.String> tags)

      • getNodes

        @Nullable
public java.util.List<TaskGraphNode> getNodes()
        The structure of the graph, in the form of the nodes that make it up. As with `TaskGraphLog`, nodes must topologically sorted, so that any node appears after all the nodes it depends on.
        Returns:
        nodes

      • setNodes

        public void setNodes​(java.util.List<TaskGraphNode> nodes)

      • putAdditionalProperty

        public RegisteredTaskGraph 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 RegisteredTaskGraph

      • fromJson

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

      • toJson

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