Package io.tiledb.cloud.rest_api.model

Class TGUDFEnvironment

  • @Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2023-10-02T12:25:58.319138+03:00[Europe/Athens]")
public class TGUDFEnvironment
extends java.lang.Object
    Metadata about the environment where we want to execute a UDF.

    • Field Detail

      • SERIALIZED_NAME_LANGUAGE

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

      • SERIALIZED_NAME_LANGUAGE_VERSION

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

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

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

      • SERIALIZED_NAME_RUN_CLIENT_SIDE

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

      • SERIALIZED_NAME_TIMEOUT

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

      • TGUDFEnvironment

        public TGUDFEnvironment()

    • Method Detail

      • getLanguage

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

      • setLanguage

        public void setLanguage​(UDFLanguage language)

      • languageVersion

        public TGUDFEnvironment languageVersion​(java.lang.String languageVersion)

      • getLanguageVersion

        @Nullable
public java.lang.String getLanguageVersion()
        The language version used to execute this UDF. Neither this nor `language` needs to be set for registered UDFs, since the language and version are stored server-side with the UDF itself.
        Returns:
        languageVersion

      • setLanguageVersion

        public void setLanguageVersion​(java.lang.String languageVersion)

      • getImageName

        @Nullable
public java.lang.String getImageName()
        The name of the image to use for the execution environment.
        Returns:
        imageName

      • setImageName

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

      • accessCredentialsName

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

      • getNamespace

        @Nullable
public java.lang.String getNamespace()
        If set, the non-default namespace to execute this UDF under (and to query any Array Nodes that are used as inputs to this UDF).
        Returns:
        namespace

      • setNamespace

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

      • resourceClass

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

      • runClientSide

        public TGUDFEnvironment runClientSide​(java.lang.Boolean runClientSide)

      • getRunClientSide

        @Nullable
public java.lang.Boolean getRunClientSide()
        A hint that, if possible, this function should be executed on the client side rather than on the server. Registered UDFs and functions which take arrays as inputs can never be executed client-side. If the client’s environment is incompatible, or the client does not support client-side execution, the function will be executed on the server.
        Returns:
        runClientSide

      • setRunClientSide

        public void setRunClientSide​(java.lang.Boolean runClientSide)

      • getTimeout

        @Nullable
public java.math.BigDecimal getTimeout()
        The maximum length of time this UDF is allowed to execute for before it is killed and fails. If not present (or zero), the function is allowed to run indefinitely (subject to the server’s global limits).
        Returns:
        timeout

      • setTimeout

        public void setTimeout​(java.math.BigDecimal timeout)

      • putAdditionalProperty

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

      • fromJson

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

      • toJson

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