Package io.tiledb.cloud.rest_api.model

Class UDFArrayDetails

  • @Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2023-10-02T12:25:58.319138+03:00[Europe/Athens]")
public class UDFArrayDetails
extends java.lang.Object
    Contains array details for multi-array query including uri, ranges buffers

    • Field Detail

      • SERIALIZED_NAME_PARAMETER_ID

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

      • SERIALIZED_NAME_URI

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

      • SERIALIZED_NAME_RANGES

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

      • SERIALIZED_NAME_BUFFERS

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

      • UDFArrayDetails

        public UDFArrayDetails()

    • Method Detail

      • parameterId

        public UDFArrayDetails parameterId​(java.lang.String parameterId)

      • getParameterId

        @Nullable
public java.lang.String getParameterId()
        An optional client-generated identifier to distinguish between multiple range/buffer requests from the same array in the same call. This may be set for MultiArrayUDFs that use the `argument_json` style of passing arrays.
        Returns:
        parameterId

      • setParameterId

        public void setParameterId​(java.lang.String parameterId)

      • getUri

        @Nullable
public java.lang.String getUri()
        array to set ranges and buffers on, must be in tiledb:// format
        Returns:
        uri

      • setUri

        public void setUri​(java.lang.String uri)

      • getRanges

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

      • setRanges

        public void setRanges​(QueryRanges ranges)

      • buffers

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

      • addBuffersItem

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

      • getBuffers

        @Nullable
public java.util.List<java.lang.String> getBuffers()
        List of buffers to fetch (attributes + dimensions)
        Returns:
        buffers

      • setBuffers

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

      • putAdditionalProperty

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

      • fromJson

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

      • toJson

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