Package io.tiledb.cloud.rest_api.model

Class TGUDFNodeData

  • @Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2023-10-02T12:25:58.319138+03:00[Europe/Athens]")
public class TGUDFNodeData
extends java.lang.Object
    A node specifying the execution of a user-defined function.

    • Field Detail

      • SERIALIZED_NAME_REGISTERED_UDF_NAME

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

      • SERIALIZED_NAME_EXECUTABLE_CODE

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

      • SERIALIZED_NAME_SOURCE_TEXT

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

      • SERIALIZED_NAME_ENVIRONMENT

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

      • SERIALIZED_NAME_ARGUMENTS

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

      • SERIALIZED_NAME_RESULT_FORMAT

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

      • TGUDFNodeData

        public TGUDFNodeData()

    • Method Detail

      • registeredUdfName

        public TGUDFNodeData registeredUdfName​(java.lang.String registeredUdfName)

      • getRegisteredUdfName

        @Nullable
public java.lang.String getRegisteredUdfName()
        If set, the name of the registered UDF to execute, in the format `namespace/name`. Either this or `executable_code` should be set, but not both.
        Returns:
        registeredUdfName

      • setRegisteredUdfName

        public void setRegisteredUdfName​(java.lang.String registeredUdfName)

      • executableCode

        public TGUDFNodeData executableCode​(java.lang.String executableCode)

      • getExecutableCode

        @Nullable
public java.lang.String getExecutableCode()
        If set, the base64 serialization of the code for this step, encoded in a language-specific format (e.g. Pickle for Python, serialization for R).
        Returns:
        executableCode

      • setExecutableCode

        public void setExecutableCode​(java.lang.String executableCode)

      • sourceText

        public TGUDFNodeData sourceText​(java.lang.String sourceText)

      • getSourceText

        @Nullable
public java.lang.String getSourceText()
        Optionally, the source text for the code passed in `executable_code`. *For reference only; only the code in `executable_code` is actually executed.* This will be included in activity logs and may be useful for debugging.
        Returns:
        sourceText

      • setSourceText

        public void setSourceText​(java.lang.String sourceText)

      • getEnvironment

        @Nullable
public TGUDFEnvironment getEnvironment()
        Get environment
        Returns:
        environment

      • getArguments

        @Nullable
public java.util.List<TGUDFArgument> getArguments()
        The arguments to a UDF function. This encompasses both named and positional arguments. The format is designed to provide compatibility across languages like Python which have a fairly traditional split between positional arguments and named arguments, and languages like R which has a rather unique way of specifying arguments. For Python (and most other languages), all positional arguments will come before all named arguments (if any are present): // fn(arg1, arg2, arg3) [ {value: arg1}, {value: arg2}, {value: arg3}, ] // fn(arg1, arg2, n=kw1, a=kw2) [ {value: arg1}, {value: arg2}, {name: \"n\", value: kw1}, {name: \"a\", value: kw2}, ] // fn(kw=k1, only=k2) [ {name: \"kw\", value: k1}, {name: \"only\", value: k2}, ] However, in R, named and positional arguments may be intermixed freely: // fn(arg, n=kw1, arg2) [ {value: arg}, {name: \"n\", value: kw1}, {value: arg2}, ]
        Returns:
        arguments

      • setArguments

        public void setArguments​(java.util.List<TGUDFArgument> arguments)

      • getResultFormat

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

      • setResultFormat

        public void setResultFormat​(ResultFormat resultFormat)

      • putAdditionalProperty

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

      • fromJson

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

      • toJson

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