Package io.tiledb.cloud.rest_api.api

Class UdfApi

  • public class UdfApi
extends java.lang.Object

    • Constructor Detail

      • UdfApi

        public UdfApi()

      • UdfApi

        public UdfApi​(ApiClient apiClient)

    • Method Detail

      • getApiClient

        public ApiClient getApiClient()

      • setApiClient

        public void setApiClient​(ApiClient apiClient)

      • getHostIndex

        public int getHostIndex()

      • setHostIndex

        public void setHostIndex​(int hostIndex)

      • getCustomBaseUrl

        public java.lang.String getCustomBaseUrl()

      • setCustomBaseUrl

        public void setCustomBaseUrl​(java.lang.String customBaseUrl)

      • deleteUDFInfoCall

        public okhttp3.Call deleteUDFInfoCall​(java.lang.String namespace,
                                      java.lang.String name,
                                      ApiCallback _callback)
                               throws ApiException
        Build call for deleteUDFInfo
        Parameters:
        namespace - namespace array is in (an organization name or user's username) (required)
        name - name to register UDF under (required)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object

      • submitGenericUDFBytes

        public byte[] submitGenericUDFBytes​(java.lang.String namespace,
                                    GenericUDF udf,
                                    java.lang.String acceptEncoding)
                             throws ApiException
        submit a generic UDF in the given namespace
        Parameters:
        namespace - namespace array is in (an organization name or user's username) (required)
        udf - UDF to run (required)
        acceptEncoding - Encoding to use (optional)
        Returns:
        byte[]
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • submitGenericUDFWithHttpInfoBytes

        public ApiResponse<byte[]> submitGenericUDFWithHttpInfoBytes​(java.lang.String namespace,
                                                             GenericUDF udf,
                                                             java.lang.String acceptEncoding)
                                                      throws ApiException
        submit a generic UDF in the given namespace
        Parameters:
        namespace - namespace array is in (an organization name or user's username) (required)
        udf - UDF to run (required)
        acceptEncoding - Encoding to use (optional)
        Returns:
        ApiResponse<byte[]>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • submitGenericUDFObj

        public java.lang.Object submitGenericUDFObj​(java.lang.String namespace,
                                            GenericUDF udf,
                                            java.lang.String acceptEncoding)
                                     throws ApiException
        submit a generic UDF in the given namespace
        Parameters:
        namespace - namespace array is in (an organization name or user's username) (required)
        udf - UDF to run (required)
        acceptEncoding - Encoding to use (optional)
        Returns:
        Object
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • submitMultiArrayUDFString

        public java.lang.String submitMultiArrayUDFString​(java.lang.String namespace,
                                                  MultiArrayUDF udf,
                                                  java.lang.String acceptEncoding)
                                           throws ApiException
        submit a multi-array UDF in the given namespace
        Parameters:
        namespace - namespace array is in (an organization name or user's username) (required)
        udf - UDF to run (required)
        acceptEncoding - Encoding to use (optional)
        Returns:
        String
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • submitMultiArrayUDFWithHttpInfoString

        public ApiResponse<java.lang.String> submitMultiArrayUDFWithHttpInfoString​(java.lang.String namespace,
                                                                           MultiArrayUDF udf,
                                                                           java.lang.String acceptEncoding)
                                                                    throws ApiException
        submit a multi-array UDF in the given namespace
        Parameters:
        namespace - namespace array is in (an organization name or user's username) (required)
        udf - UDF to run (required)
        acceptEncoding - Encoding to use (optional)
        Returns:
        ApiResponse<String>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • submitMultiArrayUDFBytes

        public byte[] submitMultiArrayUDFBytes​(java.lang.String namespace,
                                       MultiArrayUDF udf,
                                       java.lang.String acceptEncoding)
                                throws ApiException
        submit a multi-array UDF in the given namespace
        Parameters:
        namespace - namespace array is in (an organization name or user's username) (required)
        udf - UDF to run (required)
        acceptEncoding - Encoding to use (optional)
        Returns:
        byte[]
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • submitUDFString

        public java.lang.String submitUDFString​(java.lang.String namespace,
                                        java.lang.String array,
                                        MultiArrayUDF udf,
                                        java.lang.String xPayer,
                                        java.lang.String acceptEncoding,
                                        java.lang.String v2)
                                 throws ApiException
        send a UDF to run against a specified array/URI registered to a group/project
        Parameters:
        namespace - namespace array is in (an organization name or user's username) (required)
        array - name/uri of array that is url-encoded (required)
        udf - UDF to run (required)
        xPayer - Name of organization or user who should be charged for this request (optional)
        acceptEncoding - Encoding to use (optional)
        v2 - flag to indicate if v2 array UDFs should be used, currently in beta testing. Setting any value will enable v2 array UDFs. (optional)
        Returns:
        String
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • submitUDFWithHttpInfoString

        public ApiResponse<java.lang.String> submitUDFWithHttpInfoString​(java.lang.String namespace,
                                                                 java.lang.String array,
                                                                 MultiArrayUDF udf,
                                                                 java.lang.String xPayer,
                                                                 java.lang.String acceptEncoding,
                                                                 java.lang.String v2)
                                                          throws ApiException
        send a UDF to run against a specified array/URI registered to a group/project
        Parameters:
        namespace - namespace array is in (an organization name or user's username) (required)
        array - name/uri of array that is url-encoded (required)
        udf - UDF to run (required)
        xPayer - Name of organization or user who should be charged for this request (optional)
        acceptEncoding - Encoding to use (optional)
        v2 - flag to indicate if v2 array UDFs should be used, currently in beta testing. Setting any value will enable v2 array UDFs. (optional)
        Returns:
        ApiResponse<String>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • submitUDFBytes

        public byte[] submitUDFBytes​(java.lang.String namespace,
                             java.lang.String array,
                             MultiArrayUDF udf,
                             java.lang.String xPayer,
                             java.lang.String acceptEncoding,
                             java.lang.String v2)
                      throws ApiException
        send a UDF to run against a specified array/URI registered to a group/project
        Parameters:
        namespace - namespace array is in (an organization name or user's username) (required)
        array - name/uri of array that is url-encoded (required)
        udf - UDF to run (required)
        xPayer - Name of organization or user who should be charged for this request (optional)
        acceptEncoding - Encoding to use (optional)
        v2 - flag to indicate if v2 array UDFs should be used, currently in beta testing. Setting any value will enable v2 array UDFs. (optional)
        Returns:
        byte[]
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • submitUDFWithHttpInfoBytes

        public ApiResponse<byte[]> submitUDFWithHttpInfoBytes​(java.lang.String namespace,
                                                      java.lang.String array,
                                                      MultiArrayUDF udf,
                                                      java.lang.String xPayer,
                                                      java.lang.String acceptEncoding,
                                                      java.lang.String v2)
                                               throws ApiException
        send a UDF to run against a specified array/URI registered to a group/project
        Parameters:
        namespace - namespace array is in (an organization name or user's username) (required)
        array - name/uri of array that is url-encoded (required)
        udf - UDF to run (required)
        xPayer - Name of organization or user who should be charged for this request (optional)
        acceptEncoding - Encoding to use (optional)
        v2 - flag to indicate if v2 array UDFs should be used, currently in beta testing. Setting any value will enable v2 array UDFs. (optional)
        Returns:
        ApiResponse<byte[]>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • submitMultiArrayUDFWithHttpInfoBytes

        public ApiResponse<byte[]> submitMultiArrayUDFWithHttpInfoBytes​(java.lang.String namespace,
                                                                MultiArrayUDF udf,
                                                                java.lang.String acceptEncoding)
                                                         throws ApiException
        submit a multi-array UDF in the given namespace
        Parameters:
        namespace - namespace array is in (an organization name or user's username) (required)
        udf - UDF to run (required)
        acceptEncoding - Encoding to use (optional)
        Returns:
        ApiResponse<byte[]>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • submitGenericUDFWithHttpInfoObj

        public ApiResponse<java.lang.Object> submitGenericUDFWithHttpInfoObj​(java.lang.String namespace,
                                                                     GenericUDF udf,
                                                                     java.lang.String acceptEncoding)
                                                              throws ApiException
        submit a generic UDF in the given namespace
        Parameters:
        namespace - namespace array is in (an organization name or user's username) (required)
        udf - UDF to run (required)
        acceptEncoding - Encoding to use (optional)
        Returns:
        ApiResponse<Object>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • deleteUDFInfo

        public void deleteUDFInfo​(java.lang.String namespace,
                          java.lang.String name)
                   throws ApiException
        delete a registered UDF -- this will remove all sharing and can not be undone
        Parameters:
        namespace - namespace array is in (an organization name or user's username) (required)
        name - name to register UDF under (required)
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • submitGenericUDFWithHttpInfoString

        public ApiResponse<java.lang.String> submitGenericUDFWithHttpInfoString​(java.lang.String namespace,
                                                                        GenericUDF udf,
                                                                        java.lang.String acceptEncoding)
                                                                 throws ApiException
        submit a generic UDF in the given namespace
        Parameters:
        namespace - namespace array is in (an organization name or user's username) (required)
        udf - UDF to run (required)
        acceptEncoding - Encoding to use (optional)
        Returns:
        ApiResponse<String>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • submitGenericUDFString

        public java.lang.String submitGenericUDFString​(java.lang.String namespace,
                                               GenericUDF udf,
                                               java.lang.String acceptEncoding)
                                        throws ApiException
        submit a generic UDF in the given namespace
        Parameters:
        namespace - namespace array is in (an organization name or user's username) (required)
        udf - UDF to run (required)
        acceptEncoding - Encoding to use (optional)
        Returns:
        String
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • deleteUDFInfoWithHttpInfo

        public ApiResponse<java.lang.Void> deleteUDFInfoWithHttpInfo​(java.lang.String namespace,
                                                             java.lang.String name)
                                                      throws ApiException
        delete a registered UDF -- this will remove all sharing and can not be undone
        Parameters:
        namespace - namespace array is in (an organization name or user's username) (required)
        name - name to register UDF under (required)
        Returns:
        ApiResponse<Void>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • deleteUDFInfoAsync

        public okhttp3.Call deleteUDFInfoAsync​(java.lang.String namespace,
                                       java.lang.String name,
                                       ApiCallback<java.lang.Void> _callback)
                                throws ApiException
        (asynchronously) delete a registered UDF -- this will remove all sharing and can not be undone
        Parameters:
        namespace - namespace array is in (an organization name or user's username) (required)
        name - name to register UDF under (required)
        _callback - The callback to be executed when the API call finishes
        Returns:
        The request call
        Throws:
        ApiException - If fail to process the API call, e.g. serializing the request body object

      • getUDFInfoCall

        public okhttp3.Call getUDFInfoCall​(java.lang.String namespace,
                                   java.lang.String name,
                                   ApiCallback _callback)
                            throws ApiException
        Build call for getUDFInfo
        Parameters:
        namespace - namespace array is in (an organization name or user's username) (required)
        name - name to register UDF under (required)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object

      • getUDFInfo

        public UDFInfo getUDFInfo​(java.lang.String namespace,
                          java.lang.String name)
                   throws ApiException
        get a specific UDF in the given namespace
        Parameters:
        namespace - namespace array is in (an organization name or user's username) (required)
        name - name to register UDF under (required)
        Returns:
        UDFInfo
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • getUDFInfoWithHttpInfo

        public ApiResponse<UDFInfo> getUDFInfoWithHttpInfo​(java.lang.String namespace,
                                                   java.lang.String name)
                                            throws ApiException
        get a specific UDF in the given namespace
        Parameters:
        namespace - namespace array is in (an organization name or user's username) (required)
        name - name to register UDF under (required)
        Returns:
        ApiResponse<UDFInfo>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • getUDFInfoAsync

        public okhttp3.Call getUDFInfoAsync​(java.lang.String namespace,
                                    java.lang.String name,
                                    ApiCallback<UDFInfo> _callback)
                             throws ApiException
        (asynchronously) get a specific UDF in the given namespace
        Parameters:
        namespace - namespace array is in (an organization name or user's username) (required)
        name - name to register UDF under (required)
        _callback - The callback to be executed when the API call finishes
        Returns:
        The request call
        Throws:
        ApiException - If fail to process the API call, e.g. serializing the request body object

      • getUDFInfoSharingPoliciesCall

        public okhttp3.Call getUDFInfoSharingPoliciesCall​(java.lang.String namespace,
                                                  java.lang.String name,
                                                  ApiCallback _callback)
                                           throws ApiException
        Build call for getUDFInfoSharingPolicies
        Parameters:
        namespace - namespace array is in (an organization name or user's username) (required)
        name - name of UDFInfo (required)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object

      • getUDFInfoSharingPolicies

        public java.util.List<UDFSharing> getUDFInfoSharingPolicies​(java.lang.String namespace,
                                                            java.lang.String name)
                                                     throws ApiException
        Get all sharing details of the UDF
        Parameters:
        namespace - namespace array is in (an organization name or user's username) (required)
        name - name of UDFInfo (required)
        Returns:
        List<UDFSharing>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • getUDFInfoSharingPoliciesWithHttpInfo

        public ApiResponse<java.util.List<UDFSharing>> getUDFInfoSharingPoliciesWithHttpInfo​(java.lang.String namespace,
                                                                                     java.lang.String name)
                                                                              throws ApiException
        Get all sharing details of the UDF
        Parameters:
        namespace - namespace array is in (an organization name or user's username) (required)
        name - name of UDFInfo (required)
        Returns:
        ApiResponse<List<UDFSharing>>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • getUDFInfoSharingPoliciesAsync

        public okhttp3.Call getUDFInfoSharingPoliciesAsync​(java.lang.String namespace,
                                                   java.lang.String name,
                                                   ApiCallback<java.util.List<UDFSharing>> _callback)
                                            throws ApiException
        (asynchronously) Get all sharing details of the UDF
        Parameters:
        namespace - namespace array is in (an organization name or user's username) (required)
        name - name of UDFInfo (required)
        _callback - The callback to be executed when the API call finishes
        Returns:
        The request call
        Throws:
        ApiException - If fail to process the API call, e.g. serializing the request body object

      • handleCopyUDFCall

        public okhttp3.Call handleCopyUDFCall​(java.lang.String namespace,
                                      java.lang.String name,
                                      UDFCopy udFCopy,
                                      java.lang.String X_TILEDB_CLOUD_ACCESS_CREDENTIALS_NAME,
                                      java.lang.Integer endTimestamp,
                                      ApiCallback _callback)
                               throws ApiException
        Build call for handleCopyUDF
        Parameters:
        namespace - namespace array is in (an organization name or user's username) (required)
        name - name of UDFInfo (required)
        udFCopy - Input/Output information to copy a UDF (required)
        X_TILEDB_CLOUD_ACCESS_CREDENTIALS_NAME - Optional registered access credentials to use for creation (optional)
        endTimestamp - Milliseconds since Unix epoch (optional)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object

      • handleCopyUDF

        public UDFCopied handleCopyUDF​(java.lang.String namespace,
                               java.lang.String name,
                               UDFCopy udFCopy,
                               java.lang.String X_TILEDB_CLOUD_ACCESS_CREDENTIALS_NAME,
                               java.lang.Integer endTimestamp)
                        throws ApiException
        Copy a tiledb udf at the specified location
        Parameters:
        namespace - namespace array is in (an organization name or user's username) (required)
        name - name of UDFInfo (required)
        udFCopy - Input/Output information to copy a UDF (required)
        X_TILEDB_CLOUD_ACCESS_CREDENTIALS_NAME - Optional registered access credentials to use for creation (optional)
        endTimestamp - Milliseconds since Unix epoch (optional)
        Returns:
        UDFCopied
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • handleCopyUDFWithHttpInfo

        public ApiResponse<UDFCopied> handleCopyUDFWithHttpInfo​(java.lang.String namespace,
                                                        java.lang.String name,
                                                        UDFCopy udFCopy,
                                                        java.lang.String X_TILEDB_CLOUD_ACCESS_CREDENTIALS_NAME,
                                                        java.lang.Integer endTimestamp)
                                                 throws ApiException
        Copy a tiledb udf at the specified location
        Parameters:
        namespace - namespace array is in (an organization name or user's username) (required)
        name - name of UDFInfo (required)
        udFCopy - Input/Output information to copy a UDF (required)
        X_TILEDB_CLOUD_ACCESS_CREDENTIALS_NAME - Optional registered access credentials to use for creation (optional)
        endTimestamp - Milliseconds since Unix epoch (optional)
        Returns:
        ApiResponse<UDFCopied>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • handleCopyUDFAsync

        public okhttp3.Call handleCopyUDFAsync​(java.lang.String namespace,
                                       java.lang.String name,
                                       UDFCopy udFCopy,
                                       java.lang.String X_TILEDB_CLOUD_ACCESS_CREDENTIALS_NAME,
                                       java.lang.Integer endTimestamp,
                                       ApiCallback<UDFCopied> _callback)
                                throws ApiException
        (asynchronously) Copy a tiledb udf at the specified location
        Parameters:
        namespace - namespace array is in (an organization name or user's username) (required)
        name - name of UDFInfo (required)
        udFCopy - Input/Output information to copy a UDF (required)
        X_TILEDB_CLOUD_ACCESS_CREDENTIALS_NAME - Optional registered access credentials to use for creation (optional)
        endTimestamp - Milliseconds since Unix epoch (optional)
        _callback - The callback to be executed when the API call finishes
        Returns:
        The request call
        Throws:
        ApiException - If fail to process the API call, e.g. serializing the request body object

      • registerUDFInfoCall

        public okhttp3.Call registerUDFInfoCall​(java.lang.String namespace,
                                        java.lang.String name,
                                        UDFInfoUpdate udf,
                                        ApiCallback _callback)
                                 throws ApiException
        Build call for registerUDFInfo
        Parameters:
        namespace - namespace array is in (an organization name or user's username) (required)
        name - name to register UDF under (required)
        udf - UDF to register (required)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object

      • registerUDFInfo

        public void registerUDFInfo​(java.lang.String namespace,
                            java.lang.String name,
                            UDFInfoUpdate udf)
                     throws ApiException
        register a UDF in the given namespace
        Parameters:
        namespace - namespace array is in (an organization name or user's username) (required)
        name - name to register UDF under (required)
        udf - UDF to register (required)
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • registerUDFInfoWithHttpInfo

        public ApiResponse<java.lang.Void> registerUDFInfoWithHttpInfo​(java.lang.String namespace,
                                                               java.lang.String name,
                                                               UDFInfoUpdate udf)
                                                        throws ApiException
        register a UDF in the given namespace
        Parameters:
        namespace - namespace array is in (an organization name or user's username) (required)
        name - name to register UDF under (required)
        udf - UDF to register (required)
        Returns:
        ApiResponse<Void>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • registerUDFInfoAsync

        public okhttp3.Call registerUDFInfoAsync​(java.lang.String namespace,
                                         java.lang.String name,
                                         UDFInfoUpdate udf,
                                         ApiCallback<java.lang.Void> _callback)
                                  throws ApiException
        (asynchronously) register a UDF in the given namespace
        Parameters:
        namespace - namespace array is in (an organization name or user's username) (required)
        name - name to register UDF under (required)
        udf - UDF to register (required)
        _callback - The callback to be executed when the API call finishes
        Returns:
        The request call
        Throws:
        ApiException - If fail to process the API call, e.g. serializing the request body object

      • shareUDFInfoCall

        public okhttp3.Call shareUDFInfoCall​(java.lang.String namespace,
                                     java.lang.String name,
                                     UDFSharing udfSharing,
                                     ApiCallback _callback)
                              throws ApiException
        Build call for shareUDFInfo
        Parameters:
        namespace - namespace array is in (an organization name or user's username) (required)
        name - name of UDFInfo (required)
        udfSharing - Namespace and list of permissions to share with. An empty list of permissions will remove the namespace; if permissions already exist they will be deleted then new ones added. In the event of a failure, the new policies will be rolled back to prevent partial policies, and it's likely the UDF will not be shared with the namespace at all. (required)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object

      • shareUDFInfo

        public void shareUDFInfo​(java.lang.String namespace,
                         java.lang.String name,
                         UDFSharing udfSharing)
                  throws ApiException
        Share a UDF with a user
        Parameters:
        namespace - namespace array is in (an organization name or user's username) (required)
        name - name of UDFInfo (required)
        udfSharing - Namespace and list of permissions to share with. An empty list of permissions will remove the namespace; if permissions already exist they will be deleted then new ones added. In the event of a failure, the new policies will be rolled back to prevent partial policies, and it's likely the UDF will not be shared with the namespace at all. (required)
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • shareUDFInfoWithHttpInfo

        public ApiResponse<java.lang.Void> shareUDFInfoWithHttpInfo​(java.lang.String namespace,
                                                            java.lang.String name,
                                                            UDFSharing udfSharing)
                                                     throws ApiException
        Share a UDF with a user
        Parameters:
        namespace - namespace array is in (an organization name or user's username) (required)
        name - name of UDFInfo (required)
        udfSharing - Namespace and list of permissions to share with. An empty list of permissions will remove the namespace; if permissions already exist they will be deleted then new ones added. In the event of a failure, the new policies will be rolled back to prevent partial policies, and it's likely the UDF will not be shared with the namespace at all. (required)
        Returns:
        ApiResponse<Void>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • shareUDFInfoAsync

        public okhttp3.Call shareUDFInfoAsync​(java.lang.String namespace,
                                      java.lang.String name,
                                      UDFSharing udfSharing,
                                      ApiCallback<java.lang.Void> _callback)
                               throws ApiException
        (asynchronously) Share a UDF with a user
        Parameters:
        namespace - namespace array is in (an organization name or user's username) (required)
        name - name of UDFInfo (required)
        udfSharing - Namespace and list of permissions to share with. An empty list of permissions will remove the namespace; if permissions already exist they will be deleted then new ones added. In the event of a failure, the new policies will be rolled back to prevent partial policies, and it's likely the UDF will not be shared with the namespace at all. (required)
        _callback - The callback to be executed when the API call finishes
        Returns:
        The request call
        Throws:
        ApiException - If fail to process the API call, e.g. serializing the request body object

      • submitGenericUDFCall

        public okhttp3.Call submitGenericUDFCall​(java.lang.String namespace,
                                         GenericUDF udf,
                                         java.lang.String acceptEncoding,
                                         ApiCallback _callback)
                                  throws ApiException
        Build call for submitGenericUDF
        Parameters:
        namespace - namespace array is in (an organization name or user's username) (required)
        udf - UDF to run (required)
        acceptEncoding - Encoding to use (optional)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object

      • submitGenericUDF

        public java.io.File submitGenericUDF​(java.lang.String namespace,
                                     GenericUDF udf,
                                     java.lang.String acceptEncoding)
                              throws ApiException
        submit a generic UDF in the given namespace
        Parameters:
        namespace - namespace array is in (an organization name or user's username) (required)
        udf - UDF to run (required)
        acceptEncoding - Encoding to use (optional)
        Returns:
        File
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • submitGenericUDFWithHttpInfo

        public ApiResponse<java.io.File> submitGenericUDFWithHttpInfo​(java.lang.String namespace,
                                                              GenericUDF udf,
                                                              java.lang.String acceptEncoding)
                                                       throws ApiException
        submit a generic UDF in the given namespace
        Parameters:
        namespace - namespace array is in (an organization name or user's username) (required)
        udf - UDF to run (required)
        acceptEncoding - Encoding to use (optional)
        Returns:
        ApiResponse<File>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • submitGenericUDFAsync

        public okhttp3.Call submitGenericUDFAsync​(java.lang.String namespace,
                                          GenericUDF udf,
                                          java.lang.String acceptEncoding,
                                          ApiCallback<java.io.File> _callback)
                                   throws ApiException
        (asynchronously) submit a generic UDF in the given namespace
        Parameters:
        namespace - namespace array is in (an organization name or user's username) (required)
        udf - UDF to run (required)
        acceptEncoding - Encoding to use (optional)
        _callback - The callback to be executed when the API call finishes
        Returns:
        The request call
        Throws:
        ApiException - If fail to process the API call, e.g. serializing the request body object

      • submitMultiArrayUDFCall

        public okhttp3.Call submitMultiArrayUDFCall​(java.lang.String namespace,
                                            MultiArrayUDF udf,
                                            java.lang.String acceptEncoding,
                                            ApiCallback _callback)
                                     throws ApiException
        Build call for submitMultiArrayUDF
        Parameters:
        namespace - namespace array is in (an organization name or user's username) (required)
        udf - UDF to run (required)
        acceptEncoding - Encoding to use (optional)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object

      • submitMultiArrayUDF

        public java.io.File submitMultiArrayUDF​(java.lang.String namespace,
                                        MultiArrayUDF udf,
                                        java.lang.String acceptEncoding)
                                 throws ApiException
        submit a multi-array UDF in the given namespace
        Parameters:
        namespace - namespace array is in (an organization name or user's username) (required)
        udf - UDF to run (required)
        acceptEncoding - Encoding to use (optional)
        Returns:
        File
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • submitMultiArrayUDFWithHttpInfo

        public ApiResponse<java.io.File> submitMultiArrayUDFWithHttpInfo​(java.lang.String namespace,
                                                                 MultiArrayUDF udf,
                                                                 java.lang.String acceptEncoding)
                                                          throws ApiException
        submit a multi-array UDF in the given namespace
        Parameters:
        namespace - namespace array is in (an organization name or user's username) (required)
        udf - UDF to run (required)
        acceptEncoding - Encoding to use (optional)
        Returns:
        ApiResponse<File>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • submitMultiArrayUDFAsync

        public okhttp3.Call submitMultiArrayUDFAsync​(java.lang.String namespace,
                                             MultiArrayUDF udf,
                                             java.lang.String acceptEncoding,
                                             ApiCallback<java.io.File> _callback)
                                      throws ApiException
        (asynchronously) submit a multi-array UDF in the given namespace
        Parameters:
        namespace - namespace array is in (an organization name or user's username) (required)
        udf - UDF to run (required)
        acceptEncoding - Encoding to use (optional)
        _callback - The callback to be executed when the API call finishes
        Returns:
        The request call
        Throws:
        ApiException - If fail to process the API call, e.g. serializing the request body object

      • submitUDFCall

        public okhttp3.Call submitUDFCall​(java.lang.String namespace,
                                  java.lang.String array,
                                  MultiArrayUDF udf,
                                  java.lang.String xPayer,
                                  java.lang.String acceptEncoding,
                                  java.lang.String v2,
                                  ApiCallback _callback)
                           throws ApiException
        Build call for submitUDF
        Parameters:
        namespace - namespace array is in (an organization name or user's username) (required)
        array - name/uri of array that is url-encoded (required)
        udf - UDF to run (required)
        xPayer - Name of organization or user who should be charged for this request (optional)
        acceptEncoding - Encoding to use (optional)
        v2 - flag to indicate if v2 array UDFs should be used, currently in beta testing. Setting any value will enable v2 array UDFs. (optional)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object

      • submitUDF

        public java.io.File submitUDF​(java.lang.String namespace,
                              java.lang.String array,
                              MultiArrayUDF udf,
                              java.lang.String xPayer,
                              java.lang.String acceptEncoding,
                              java.lang.String v2)
                       throws ApiException
        send a UDF to run against a specified array/URI registered to a group/project
        Parameters:
        namespace - namespace array is in (an organization name or user's username) (required)
        array - name/uri of array that is url-encoded (required)
        udf - UDF to run (required)
        xPayer - Name of organization or user who should be charged for this request (optional)
        acceptEncoding - Encoding to use (optional)
        v2 - flag to indicate if v2 array UDFs should be used, currently in beta testing. Setting any value will enable v2 array UDFs. (optional)
        Returns:
        File
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • submitUDFWithHttpInfo

        public ApiResponse<java.io.File> submitUDFWithHttpInfo​(java.lang.String namespace,
                                                       java.lang.String array,
                                                       MultiArrayUDF udf,
                                                       java.lang.String xPayer,
                                                       java.lang.String acceptEncoding,
                                                       java.lang.String v2)
                                                throws ApiException
        send a UDF to run against a specified array/URI registered to a group/project
        Parameters:
        namespace - namespace array is in (an organization name or user's username) (required)
        array - name/uri of array that is url-encoded (required)
        udf - UDF to run (required)
        xPayer - Name of organization or user who should be charged for this request (optional)
        acceptEncoding - Encoding to use (optional)
        v2 - flag to indicate if v2 array UDFs should be used, currently in beta testing. Setting any value will enable v2 array UDFs. (optional)
        Returns:
        ApiResponse<File>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • submitUDFAsync

        public okhttp3.Call submitUDFAsync​(java.lang.String namespace,
                                   java.lang.String array,
                                   MultiArrayUDF udf,
                                   java.lang.String xPayer,
                                   java.lang.String acceptEncoding,
                                   java.lang.String v2,
                                   ApiCallback<java.io.File> _callback)
                            throws ApiException
        (asynchronously) send a UDF to run against a specified array/URI registered to a group/project
        Parameters:
        namespace - namespace array is in (an organization name or user's username) (required)
        array - name/uri of array that is url-encoded (required)
        udf - UDF to run (required)
        xPayer - Name of organization or user who should be charged for this request (optional)
        acceptEncoding - Encoding to use (optional)
        v2 - flag to indicate if v2 array UDFs should be used, currently in beta testing. Setting any value will enable v2 array UDFs. (optional)
        _callback - The callback to be executed when the API call finishes
        Returns:
        The request call
        Throws:
        ApiException - If fail to process the API call, e.g. serializing the request body object

      • udfNamespaceArrayEndTimestampsGetCall

        public okhttp3.Call udfNamespaceArrayEndTimestampsGetCall​(java.lang.String namespace,
                                                          java.lang.String array,
                                                          java.lang.Integer page,
                                                          java.lang.Integer perPage,
                                                          ApiCallback _callback)
                                                   throws ApiException
        Build call for udfNamespaceArrayEndTimestampsGet
        Parameters:
        namespace - namespace array is in (an organization name or user's username) (required)
        array - name/uri of array that is url-encoded (required)
        page - pagination offset (optional)
        perPage - pagination limit (optional)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object

      • udfNamespaceArrayEndTimestampsGet

        public ArrayEndTimestampData udfNamespaceArrayEndTimestampsGet​(java.lang.String namespace,
                                                               java.lang.String array,
                                                               java.lang.Integer page,
                                                               java.lang.Integer perPage)
                                                        throws ApiException
        retrieve a list of timestamps from the array fragment info listing in milliseconds, paginated
        Parameters:
        namespace - namespace array is in (an organization name or user's username) (required)
        array - name/uri of array that is url-encoded (required)
        page - pagination offset (optional)
        perPage - pagination limit (optional)
        Returns:
        ArrayEndTimestampData
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • udfNamespaceArrayEndTimestampsGetWithHttpInfo

        public ApiResponse<ArrayEndTimestampData> udfNamespaceArrayEndTimestampsGetWithHttpInfo​(java.lang.String namespace,
                                                                                        java.lang.String array,
                                                                                        java.lang.Integer page,
                                                                                        java.lang.Integer perPage)
                                                                                 throws ApiException
        retrieve a list of timestamps from the array fragment info listing in milliseconds, paginated
        Parameters:
        namespace - namespace array is in (an organization name or user's username) (required)
        array - name/uri of array that is url-encoded (required)
        page - pagination offset (optional)
        perPage - pagination limit (optional)
        Returns:
        ApiResponse<ArrayEndTimestampData>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • udfNamespaceArrayEndTimestampsGetAsync

        public okhttp3.Call udfNamespaceArrayEndTimestampsGetAsync​(java.lang.String namespace,
                                                           java.lang.String array,
                                                           java.lang.Integer page,
                                                           java.lang.Integer perPage,
                                                           ApiCallback<ArrayEndTimestampData> _callback)
                                                    throws ApiException
        (asynchronously) retrieve a list of timestamps from the array fragment info listing in milliseconds, paginated
        Parameters:
        namespace - namespace array is in (an organization name or user's username) (required)
        array - name/uri of array that is url-encoded (required)
        page - pagination offset (optional)
        perPage - pagination limit (optional)
        _callback - The callback to be executed when the API call finishes
        Returns:
        The request call
        Throws:
        ApiException - If fail to process the API call, e.g. serializing the request body object

      • updateUDFInfoCall

        public okhttp3.Call updateUDFInfoCall​(java.lang.String namespace,
                                      java.lang.String name,
                                      UDFInfoUpdate udf,
                                      ApiCallback _callback)
                               throws ApiException
        Build call for updateUDFInfo
        Parameters:
        namespace - namespace array is in (an organization name or user's username) (required)
        name - name to register UDF under (required)
        udf - UDF to update (required)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object

      • updateUDFInfo

        public void updateUDFInfo​(java.lang.String namespace,
                          java.lang.String name,
                          UDFInfoUpdate udf)
                   throws ApiException
        update an existing registered UDF in the given namespace
        Parameters:
        namespace - namespace array is in (an organization name or user's username) (required)
        name - name to register UDF under (required)
        udf - UDF to update (required)
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • updateUDFInfoWithHttpInfo

        public ApiResponse<java.lang.Void> updateUDFInfoWithHttpInfo​(java.lang.String namespace,
                                                             java.lang.String name,
                                                             UDFInfoUpdate udf)
                                                      throws ApiException
        update an existing registered UDF in the given namespace
        Parameters:
        namespace - namespace array is in (an organization name or user's username) (required)
        name - name to register UDF under (required)
        udf - UDF to update (required)
        Returns:
        ApiResponse<Void>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • updateUDFInfoAsync

        public okhttp3.Call updateUDFInfoAsync​(java.lang.String namespace,
                                       java.lang.String name,
                                       UDFInfoUpdate udf,
                                       ApiCallback<java.lang.Void> _callback)
                                throws ApiException
        (asynchronously) update an existing registered UDF in the given namespace
        Parameters:
        namespace - namespace array is in (an organization name or user's username) (required)
        name - name to register UDF under (required)
        udf - UDF to update (required)
        _callback - The callback to be executed when the API call finishes
        Returns:
        The request call
        Throws:
        ApiException - If fail to process the API call, e.g. serializing the request body object