Package io.tiledb.cloud.rest_api.model

Class MultiArrayUDF

  • @Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2023-10-02T12:25:58.319138+03:00[Europe/Athens]")
public class MultiArrayUDF
extends java.lang.Object
    User-defined function

    • Field Detail

      • SERIALIZED_NAME_UDF_INFO_NAME

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

      • SERIALIZED_NAME_LANGUAGE

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

      • SERIALIZED_NAME_VERSION

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

      • SERIALIZED_NAME_IMAGE_NAME

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

      • SERIALIZED_NAME_ACCESS_CREDENTIALS_NAME

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

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

      • SERIALIZED_NAME_EXEC_RAW

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

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

      • SERIALIZED_NAME_ARGUMENT

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

      • SERIALIZED_NAME_ARGUMENTS_JSON

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

      • SERIALIZED_NAME_STORED_PARAM_UUIDS

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

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

      • SERIALIZED_NAME_SUBARRAY

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

      • SERIALIZED_NAME_BUFFERS

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

      • SERIALIZED_NAME_ARRAYS

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

      • SERIALIZED_NAME_TIMEOUT

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

      • MultiArrayUDF

        public MultiArrayUDF()

    • Method Detail

      • udfInfoName

        public MultiArrayUDF udfInfoName​(java.lang.String udfInfoName)

      • getUdfInfoName

        @Nullable
public java.lang.String getUdfInfoName()
        name of UDFInfo to run, format is {namespace}/{udf_name}. Can not be used with exec
        Returns:
        udfInfoName

      • setUdfInfoName

        public void setUdfInfoName​(java.lang.String udfInfoName)

      • getLanguage

        @Nullable
public UDFLanguage getLanguage()
        Get language
        Returns:
        language

      • setLanguage

        public void setLanguage​(UDFLanguage language)

      • version

        public MultiArrayUDF version​(java.lang.String version)

      • getVersion

        @Nullable
public java.lang.String getVersion()
        Type-specific version
        Returns:
        version

      • setVersion

        public void setVersion​(java.lang.String version)

      • imageName

        public MultiArrayUDF imageName​(java.lang.String imageName)

      • getImageName

        @Nullable
public java.lang.String getImageName()
        Docker image name to use for UDF
        Returns:
        imageName

      • setImageName

        public void setImageName​(java.lang.String imageName)

      • accessCredentialsName

        public MultiArrayUDF accessCredentialsName​(java.lang.String accessCredentialsName)

      • getAccessCredentialsName

        @Nullable
public java.lang.String getAccessCredentialsName()
        The name of the access credentials to use. if unset, no credentials will be configured in the environment.
        Returns:
        accessCredentialsName

      • setAccessCredentialsName

        public void setAccessCredentialsName​(java.lang.String accessCredentialsName)

      • resourceClass

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

      • getResourceClass

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

      • setResourceClass

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

      • getExec

        @Nullable
public java.lang.String getExec()
        Type-specific executable text
        Returns:
        exec

      • setExec

        public void setExec​(java.lang.String exec)

      • execRaw

        public MultiArrayUDF execRaw​(java.lang.String execRaw)

      • getExecRaw

        @Nullable
public java.lang.String getExecRaw()
        optional raw text to store of serialized function, used for showing in UI
        Returns:
        execRaw

      • setExecRaw

        public void setExecRaw​(java.lang.String execRaw)

      • getResultFormat

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

      • setResultFormat

        public void setResultFormat​(ResultFormat resultFormat)

      • taskName

        public MultiArrayUDF taskName​(java.lang.String taskName)

      • getTaskName

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

      • setTaskName

        public void setTaskName​(java.lang.String taskName)

      • argument

        public MultiArrayUDF argument​(java.lang.String argument)

      • getArgument

        @Nullable
public java.lang.String getArgument()
        Deprecated: Prefer to use `argument_json` instead. Argument(s) to pass to UDF function, tuple or list of args/kwargs which can be in native or JSON format
        Returns:
        argument

      • setArgument

        public void setArgument​(java.lang.String argument)

      • getArgumentsJson

        @Nullable
public java.util.List<TGUDFArgument> getArgumentsJson()
        A series of key-value pairs to be passed as arguments into the UDF. See `TGUDFNodeData.arguments` for more information. If this format is used to pass arguments, arrays will be passed into the UDF as specified by the Node placeholders passed in here, rather than the classic method of putting all array arguments in the first parameter. Either this or `argument` should be set.
        Returns:
        argumentsJson

      • setArgumentsJson

        public void setArgumentsJson​(java.util.List<TGUDFArgument> argumentsJson)

      • storedParamUuids

        public MultiArrayUDF storedParamUuids​(java.util.List<java.lang.String> storedParamUuids)

      • addStoredParamUuidsItem

        public MultiArrayUDF addStoredParamUuidsItem​(java.lang.String storedParamUuidsItem)

      • getStoredParamUuids

        @Nullable
public java.util.List<java.lang.String> getStoredParamUuids()
        The UUIDs of stored input parameters (passed in a language-specific format within \"argument\") to be retrieved from the server-side cache. Serialized in standard hex format with no {}.
        Returns:
        storedParamUuids

      • setStoredParamUuids

        public void setStoredParamUuids​(java.util.List<java.lang.String> storedParamUuids)

      • storeResults

        public MultiArrayUDF 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 MultiArrayUDF 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)

      • getRanges

        @Nullable
public QueryRanges getRanges()
        Get ranges
        Returns:
        ranges

      • setRanges

        public void setRanges​(QueryRanges ranges)

      • getSubarray

        @Nullable
public UDFSubarray getSubarray()
        Get subarray
        Returns:
        subarray

      • setSubarray

        public void setSubarray​(UDFSubarray subarray)

      • buffers

        public MultiArrayUDF buffers​(java.util.List<java.lang.String> buffers)

      • addBuffersItem

        public MultiArrayUDF addBuffersItem​(java.lang.String buffersItem)

      • getBuffers

        @Nullable
public java.util.List<java.lang.String> getBuffers()
        List of buffers to fetch (attributes + dimensions). Deprecated; please set arrays with `UDFArrayDetails`.
        Returns:
        buffers

      • setBuffers

        public void setBuffers​(java.util.List<java.lang.String> buffers)

      • getArrays

        @Nullable
public java.util.List<UDFArrayDetails> getArrays()
        Array ranges/buffer into to run UDF on
        Returns:
        arrays

      • setArrays

        public void setArrays​(java.util.List<UDFArrayDetails> arrays)

      • timeout

        public MultiArrayUDF timeout​(java.lang.Integer timeout)

      • getTimeout

        @Nullable
public java.lang.Integer getTimeout()
        UDF-type timeout in seconds (default: 900)
        Returns:
        timeout

      • setTimeout

        public void setTimeout​(java.lang.Integer timeout)

      • taskGraphUuid

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

      • fromJson

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

      • toJson

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