Package io.tiledb.cloud.rest_api.model
Class GenericUDF
- java.lang.Object
-
- io.tiledb.cloud.rest_api.model.GenericUDF
-
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen", date="2023-10-02T12:25:58.319138+03:00[Europe/Athens]") public class GenericUDF extends java.lang.Object
User-defined function
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
GenericUDF.CustomTypeAdapterFactory
-
Field Summary
Fields Modifier and Type Field Description static java.util.HashSet<java.lang.String>
openapiFields
static java.util.HashSet<java.lang.String>
openapiRequiredFields
static java.lang.String
SERIALIZED_NAME_ACCESS_CREDENTIALS_NAME
static java.lang.String
SERIALIZED_NAME_ARGUMENT
static java.lang.String
SERIALIZED_NAME_CLIENT_NODE_UUID
static java.lang.String
SERIALIZED_NAME_DONT_DOWNLOAD_RESULTS
static java.lang.String
SERIALIZED_NAME_EXEC
static java.lang.String
SERIALIZED_NAME_EXEC_RAW
static java.lang.String
SERIALIZED_NAME_IMAGE_NAME
static java.lang.String
SERIALIZED_NAME_LANGUAGE
static java.lang.String
SERIALIZED_NAME_RESOURCE_CLASS
static java.lang.String
SERIALIZED_NAME_RESULT_FORMAT
static java.lang.String
SERIALIZED_NAME_STORE_RESULTS
static java.lang.String
SERIALIZED_NAME_STORED_PARAM_UUIDS
static java.lang.String
SERIALIZED_NAME_TASK_GRAPH_UUID
static java.lang.String
SERIALIZED_NAME_TASK_NAME
static java.lang.String
SERIALIZED_NAME_TIMEOUT
static java.lang.String
SERIALIZED_NAME_UDF_INFO_NAME
static java.lang.String
SERIALIZED_NAME_VERSION
-
Constructor Summary
Constructors Constructor Description GenericUDF()
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description GenericUDF
accessCredentialsName(java.lang.String accessCredentialsName)
GenericUDF
addStoredParamUuidsItem(java.lang.String storedParamUuidsItem)
GenericUDF
argument(java.lang.String argument)
GenericUDF
clientNodeUuid(java.lang.String clientNodeUuid)
GenericUDF
dontDownloadResults(java.lang.Boolean dontDownloadResults)
boolean
equals(java.lang.Object o)
GenericUDF
exec(java.lang.String exec)
GenericUDF
execRaw(java.lang.String execRaw)
static GenericUDF
fromJson(java.lang.String jsonString)
Create an instance of GenericUDF given an JSON stringjava.lang.String
getAccessCredentialsName()
The name of the access credentials to use.java.util.Map<java.lang.String,java.lang.Object>
getAdditionalProperties()
Return the additional (undeclared) property.java.lang.Object
getAdditionalProperty(java.lang.String key)
Return the additional (undeclared) property with the specified name.java.lang.String
getArgument()
Argument(s) to pass to UDF function, tuple or list of args/kwargs which can be in native or JSON formatjava.lang.String
getClientNodeUuid()
If set, the client-defined ID of the node within this task's graph.java.lang.Boolean
getDontDownloadResults()
Set to true to avoid downloading the results of this UDF.java.lang.String
getExec()
Type-specific executable textjava.lang.String
getExecRaw()
optional raw text to store of serialized function, used for showing in UIjava.lang.String
getImageName()
Docker image name to use for UDFUDFLanguage
getLanguage()
Get languagejava.lang.String
getResourceClass()
The resource class to use for the UDF execution.ResultFormat
getResultFormat()
Get resultFormatjava.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.java.lang.Boolean
getStoreResults()
store results for later retrievaljava.lang.String
getTaskGraphUuid()
If set, the ID of the log for the task graph that this was part of.java.lang.String
getTaskName()
name of task, optionaljava.lang.Integer
getTimeout()
UDF-type timeout in seconds (default: 900)java.lang.String
getUdfInfoName()
name of UDFInfo to run, format is {namespace}/{udf_name}.java.lang.String
getVersion()
Type-specific versionint
hashCode()
GenericUDF
imageName(java.lang.String imageName)
GenericUDF
language(UDFLanguage language)
GenericUDF
putAdditionalProperty(java.lang.String key, java.lang.Object value)
Set the additional (undeclared) property with the specified name and value.GenericUDF
resourceClass(java.lang.String resourceClass)
GenericUDF
resultFormat(ResultFormat resultFormat)
void
setAccessCredentialsName(java.lang.String accessCredentialsName)
void
setArgument(java.lang.String argument)
void
setClientNodeUuid(java.lang.String clientNodeUuid)
void
setDontDownloadResults(java.lang.Boolean dontDownloadResults)
void
setExec(java.lang.String exec)
void
setExecRaw(java.lang.String execRaw)
void
setImageName(java.lang.String imageName)
void
setLanguage(UDFLanguage language)
void
setResourceClass(java.lang.String resourceClass)
void
setResultFormat(ResultFormat resultFormat)
void
setStoredParamUuids(java.util.List<java.lang.String> storedParamUuids)
void
setStoreResults(java.lang.Boolean storeResults)
void
setTaskGraphUuid(java.lang.String taskGraphUuid)
void
setTaskName(java.lang.String taskName)
void
setTimeout(java.lang.Integer timeout)
void
setUdfInfoName(java.lang.String udfInfoName)
void
setVersion(java.lang.String version)
GenericUDF
storedParamUuids(java.util.List<java.lang.String> storedParamUuids)
GenericUDF
storeResults(java.lang.Boolean storeResults)
GenericUDF
taskGraphUuid(java.lang.String taskGraphUuid)
GenericUDF
taskName(java.lang.String taskName)
GenericUDF
timeout(java.lang.Integer timeout)
java.lang.String
toJson()
Convert an instance of GenericUDF to an JSON stringjava.lang.String
toString()
GenericUDF
udfInfoName(java.lang.String udfInfoName)
static void
validateJsonObject(com.google.gson.JsonObject jsonObj)
Validates the JSON Object and throws an exception if issues foundGenericUDF
version(java.lang.String version)
-
-
-
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_ARGUMENT
public static final java.lang.String SERIALIZED_NAME_ARGUMENT
- 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_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_STORE_RESULTS
public static final java.lang.String SERIALIZED_NAME_STORE_RESULTS
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_TIMEOUT
public static final java.lang.String SERIALIZED_NAME_TIMEOUT
- 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_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
-
-
Method Detail
-
udfInfoName
public GenericUDF 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)
-
language
public GenericUDF language(UDFLanguage language)
-
getLanguage
@Nullable public UDFLanguage getLanguage()
Get language- Returns:
- language
-
setLanguage
public void setLanguage(UDFLanguage language)
-
version
public GenericUDF 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 GenericUDF 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 GenericUDF 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 GenericUDF 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)
-
exec
public GenericUDF exec(java.lang.String exec)
-
getExec
@Nullable public java.lang.String getExec()
Type-specific executable text- Returns:
- exec
-
setExec
public void setExec(java.lang.String exec)
-
execRaw
public GenericUDF 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)
-
argument
public GenericUDF argument(java.lang.String argument)
-
getArgument
@Nullable public java.lang.String getArgument()
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)
-
storedParamUuids
public GenericUDF storedParamUuids(java.util.List<java.lang.String> storedParamUuids)
-
addStoredParamUuidsItem
public GenericUDF 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)
-
resultFormat
public GenericUDF resultFormat(ResultFormat resultFormat)
-
getResultFormat
@Nullable public ResultFormat getResultFormat()
Get resultFormat- Returns:
- resultFormat
-
setResultFormat
public void setResultFormat(ResultFormat resultFormat)
-
taskName
public GenericUDF 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)
-
storeResults
public GenericUDF 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)
-
timeout
public GenericUDF 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)
-
dontDownloadResults
public GenericUDF 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)
-
taskGraphUuid
public GenericUDF 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 GenericUDF 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 GenericUDF 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 classjava.lang.Object
-
hashCode
public int hashCode()
- Overrides:
hashCode
in classjava.lang.Object
-
toString
public java.lang.String toString()
- Overrides:
toString
in classjava.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 GenericUDF
-
fromJson
public static GenericUDF fromJson(java.lang.String jsonString) throws java.io.IOException
Create an instance of GenericUDF given an JSON string- Parameters:
jsonString
- JSON string- Returns:
- An instance of GenericUDF
- Throws:
java.io.IOException
- if the JSON string is invalid with respect to GenericUDF
-
toJson
public java.lang.String toJson()
Convert an instance of GenericUDF to an JSON string- Returns:
- JSON string
-
-