Package io.tiledb.cloud.rest_api.model

Class SQLParameters

  • @Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2023-10-02T12:25:58.319138+03:00[Europe/Athens]")
public class SQLParameters
extends java.lang.Object
    Parameters for running sql query

    • Field Detail

      • SERIALIZED_NAME_NAME

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

      • SERIALIZED_NAME_QUERY

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

      • SERIALIZED_NAME_OUTPUT_URI

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

      • SERIALIZED_NAME_STORE_RESULTS

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

      • SERIALIZED_NAME_DONT_DOWNLOAD_RESULTS

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

      • SERIALIZED_NAME_RESOURCE_CLASS

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

      • SERIALIZED_NAME_RESULT_FORMAT

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

      • SERIALIZED_NAME_INIT_COMMANDS

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

      • SERIALIZED_NAME_PARAMETERS

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

      • SERIALIZED_NAME_TASK_GRAPH_UUID

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

      • SERIALIZED_NAME_CLIENT_NODE_UUID

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

      • SQLParameters

        public SQLParameters()

    • Method Detail

      • getName

        @Nullable
public java.lang.String getName()
        name of task, optional
        Returns:
        name

      • setName

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

      • getQuery

        @Nullable
public java.lang.String getQuery()
        query to run
        Returns:
        query

      • setQuery

        public void setQuery​(java.lang.String query)

      • outputUri

        public SQLParameters outputUri​(java.lang.String outputUri)

      • getOutputUri

        @Nullable
public java.lang.String getOutputUri()
        Output array uri
        Returns:
        outputUri

      • setOutputUri

        public void setOutputUri​(java.lang.String outputUri)

      • storeResults

        public SQLParameters storeResults​(java.lang.Boolean storeResults)

      • getStoreResults

        @Nullable
public java.lang.Boolean getStoreResults()
        store results for later retrieval
        Returns:
        storeResults

      • setStoreResults

        public void setStoreResults​(java.lang.Boolean storeResults)

      • dontDownloadResults

        public SQLParameters dontDownloadResults​(java.lang.Boolean dontDownloadResults)

      • getDontDownloadResults

        @Nullable
public java.lang.Boolean getDontDownloadResults()
        Set to true to avoid downloading the results of this UDF. Useful for intermediate nodes in a task graph where you will not be using the results of your function. Defaults to false (\"yes download results\").
        Returns:
        dontDownloadResults

      • setDontDownloadResults

        public void setDontDownloadResults​(java.lang.Boolean dontDownloadResults)

      • resourceClass

        public SQLParameters resourceClass​(java.lang.String resourceClass)

      • getResourceClass

        @Nullable
public java.lang.String getResourceClass()
        The resource class to use for the SQL execution. Resource classes define resource limits for memory and CPUs. If this is empty, then the SQL will execute in the standard resource class of the TileDB Cloud provider.
        Returns:
        resourceClass

      • setResourceClass

        public void setResourceClass​(java.lang.String resourceClass)

      • getResultFormat

        @Nullable
public ResultFormat getResultFormat()
        Get resultFormat
        Returns:
        resultFormat

      • setResultFormat

        public void setResultFormat​(ResultFormat resultFormat)

      • initCommands

        public SQLParameters initCommands​(java.util.List<java.lang.String> initCommands)

      • addInitCommandsItem

        public SQLParameters addInitCommandsItem​(java.lang.String initCommandsItem)

      • getInitCommands

        @Nullable
public java.util.List<java.lang.String> getInitCommands()
        Queries or commands to run before main query
        Returns:
        initCommands

      • setInitCommands

        public void setInitCommands​(java.util.List<java.lang.String> initCommands)

      • parameters

        public SQLParameters parameters​(java.util.List<java.lang.Object> parameters)

      • addParametersItem

        public SQLParameters addParametersItem​(java.lang.Object parametersItem)

      • getParameters

        @Nullable
public java.util.List<java.lang.Object> getParameters()
        SQL query parameters
        Returns:
        parameters

      • setParameters

        public void setParameters​(java.util.List<java.lang.Object> parameters)

      • taskGraphUuid

        public SQLParameters taskGraphUuid​(java.lang.String taskGraphUuid)

      • getTaskGraphUuid

        @Nullable
public java.lang.String getTaskGraphUuid()
        If set, the ID of the log for the task graph that this was part of.
        Returns:
        taskGraphUuid

      • setTaskGraphUuid

        public void setTaskGraphUuid​(java.lang.String taskGraphUuid)

      • clientNodeUuid

        public SQLParameters clientNodeUuid​(java.lang.String clientNodeUuid)

      • getClientNodeUuid

        @Nullable
public java.lang.String getClientNodeUuid()
        If set, the client-defined ID of the node within this task's graph.
        Returns:
        clientNodeUuid

      • setClientNodeUuid

        public void setClientNodeUuid​(java.lang.String clientNodeUuid)

      • putAdditionalProperty

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

      • fromJson

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

      • toJson

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