UdfApi

All URIs are relative to /v1

Method	HTTP request	Description
deleteUDFInfo	DELETE /udf/{workspace}/{name}
getUDFInfo	GET /udf/{workspace}/{name}
getUDFInfoSharingPolicies	GET /udf/{workspace}/{name}/share
handleCopyUDF	POST /udf/{workspace}/{name}/copy
registerUDFInfo	POST /udf/{workspace}/{name}
shareUDFInfo	PATCH /udf/{workspace}/{name}/share
submitGenericUDF	POST /udfs/generic/{workspace}
submitMultiArrayUDF	POST /udfs/arrays/{workspace}
submitUDF	POST /arrays/{workspace}/{teamspace}/{array}/udf/submit
udfWorkspaceArrayEndTimestampsGet	GET /udf/{workspace}/{array}/end_timestamps
updateUDFInfo	PATCH /udf/{workspace}/{name}

deleteUDFInfo

deleteUDFInfo(workspace, name)

delete a registered UDF -- this will remove all sharing and can not be undone

Example

// Import classes:
import io.tiledb.cloud.rest_api.ApiClient;
import io.tiledb.cloud.rest_api.ApiException;
import io.tiledb.cloud.rest_api.Configuration;
import io.tiledb.cloud.rest_api.auth.*;
import io.tiledb.cloud.rest_api.models.*;
import io.tiledb.cloud.rest_api.api.UdfApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("/v1");
    
    // Configure HTTP basic authorization: BasicAuth
    HttpBasicAuth BasicAuth = (HttpBasicAuth) defaultClient.getAuthentication("BasicAuth");
    BasicAuth.setUsername("YOUR USERNAME");
    BasicAuth.setPassword("YOUR PASSWORD");

    // Configure API key authorization: ApiKeyAuth
    ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
    ApiKeyAuth.setApiKey("YOUR API KEY");
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //ApiKeyAuth.setApiKeyPrefix("Token");

    UdfApi apiInstance = new UdfApi(defaultClient);
    String workspace = "workspace_example"; // String | the workspace containing the teamspace the array belongs to
    String name = "name_example"; // String | name to register UDF under
    try {
      apiInstance.deleteUDFInfo(workspace, name);
    } catch (ApiException e) {
      System.err.println("Exception when calling UdfApi#deleteUDFInfo");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description	Notes
workspace	String	the workspace containing the teamspace the array belongs to
name	String	name to register UDF under

Return type

null (empty response body)

Authorization

BasicAuth, ApiKeyAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
204	UDF deleted successfully	-
502	Bad Gateway	-
0	error response	-

getUDFInfo

UDFInfo getUDFInfo(workspace, name)

get a specific UDF in the given namespace

Example

// Import classes:
import io.tiledb.cloud.rest_api.ApiClient;
import io.tiledb.cloud.rest_api.ApiException;
import io.tiledb.cloud.rest_api.Configuration;
import io.tiledb.cloud.rest_api.auth.*;
import io.tiledb.cloud.rest_api.models.*;
import io.tiledb.cloud.rest_api.api.UdfApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("/v1");
    
    // Configure HTTP basic authorization: BasicAuth
    HttpBasicAuth BasicAuth = (HttpBasicAuth) defaultClient.getAuthentication("BasicAuth");
    BasicAuth.setUsername("YOUR USERNAME");
    BasicAuth.setPassword("YOUR PASSWORD");

    // Configure API key authorization: ApiKeyAuth
    ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
    ApiKeyAuth.setApiKey("YOUR API KEY");
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //ApiKeyAuth.setApiKeyPrefix("Token");

    UdfApi apiInstance = new UdfApi(defaultClient);
    String workspace = "workspace_example"; // String | the workspace containing the teamspace the array belongs to
    String name = "name_example"; // String | name to register UDF under
    try {
      UDFInfo result = apiInstance.getUDFInfo(workspace, name);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling UdfApi#getUDFInfo");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description	Notes
workspace	String	the workspace containing the teamspace the array belongs to
name	String	name to register UDF under

Return type

UDFInfo

Authorization

BasicAuth, ApiKeyAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	UDFInfo was retrieved successfully	-
404	UDF not found	-
502	Bad Gateway	-
0	error response	-

getUDFInfoSharingPolicies

List<UDFSharing> getUDFInfoSharingPolicies(workspace, name)

Get all sharing details of the UDF

Example

// Import classes:
import io.tiledb.cloud.rest_api.ApiClient;
import io.tiledb.cloud.rest_api.ApiException;
import io.tiledb.cloud.rest_api.Configuration;
import io.tiledb.cloud.rest_api.auth.*;
import io.tiledb.cloud.rest_api.models.*;
import io.tiledb.cloud.rest_api.api.UdfApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("/v1");
    
    // Configure HTTP basic authorization: BasicAuth
    HttpBasicAuth BasicAuth = (HttpBasicAuth) defaultClient.getAuthentication("BasicAuth");
    BasicAuth.setUsername("YOUR USERNAME");
    BasicAuth.setPassword("YOUR PASSWORD");

    // Configure API key authorization: ApiKeyAuth
    ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
    ApiKeyAuth.setApiKey("YOUR API KEY");
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //ApiKeyAuth.setApiKeyPrefix("Token");

    UdfApi apiInstance = new UdfApi(defaultClient);
    String workspace = "workspace_example"; // String | the workspace containing the teamspace the array belongs to
    String name = "name_example"; // String | name of UDFInfo
    try {
      List<UDFSharing> result = apiInstance.getUDFInfoSharingPolicies(workspace, name);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling UdfApi#getUDFInfoSharingPolicies");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description	Notes
workspace	String	the workspace containing the teamspace the array belongs to
name	String	name of UDFInfo

Return type

List<UDFSharing>

Authorization

BasicAuth, ApiKeyAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	List of all specific sharing policies	-
404	UDF does not exist or user does not have permissions to view array-sharing policies	-
502	Bad Gateway	-
0	error response	-

handleCopyUDF

UDFCopied handleCopyUDF(workspace, name, udFCopy, X_TILEDB_CLOUD_ACCESS_CREDENTIALS_NAME, endTimestamp)

Copy a tiledb udf at the specified location

Example

// Import classes:
import io.tiledb.cloud.rest_api.ApiClient;
import io.tiledb.cloud.rest_api.ApiException;
import io.tiledb.cloud.rest_api.Configuration;
import io.tiledb.cloud.rest_api.auth.*;
import io.tiledb.cloud.rest_api.models.*;
import io.tiledb.cloud.rest_api.api.UdfApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("/v1");
    
    // Configure HTTP basic authorization: BasicAuth
    HttpBasicAuth BasicAuth = (HttpBasicAuth) defaultClient.getAuthentication("BasicAuth");
    BasicAuth.setUsername("YOUR USERNAME");
    BasicAuth.setPassword("YOUR PASSWORD");

    // Configure API key authorization: ApiKeyAuth
    ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
    ApiKeyAuth.setApiKey("YOUR API KEY");
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //ApiKeyAuth.setApiKeyPrefix("Token");

    UdfApi apiInstance = new UdfApi(defaultClient);
    String workspace = "workspace_example"; // String | the workspace containing the teamspace the array belongs to
    String name = "name_example"; // String | name of UDFInfo
    UDFCopy udFCopy = new UDFCopy(); // UDFCopy | Input/Output information to copy a UDF
    String X_TILEDB_CLOUD_ACCESS_CREDENTIALS_NAME = "X_TILEDB_CLOUD_ACCESS_CREDENTIALS_NAME_example"; // String | Optional registered access credentials to use for creation
    Integer endTimestamp = 56; // Integer | Milliseconds since Unix epoch
    try {
      UDFCopied result = apiInstance.handleCopyUDF(workspace, name, udFCopy, X_TILEDB_CLOUD_ACCESS_CREDENTIALS_NAME, endTimestamp);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling UdfApi#handleCopyUDF");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description	Notes
workspace	String	the workspace containing the teamspace the array belongs to
name	String	name of UDFInfo
udFCopy	UDFCopy	Input/Output information to copy a UDF
X_TILEDB_CLOUD_ACCESS_CREDENTIALS_NAME	String	Optional registered access credentials to use for creation	[optional]
endTimestamp	Integer	Milliseconds since Unix epoch	[optional]

Return type

UDFCopied

Authorization

BasicAuth, ApiKeyAuth

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
201	UDF copied	-
502	Bad Gateway	-
0	error response	-

registerUDFInfo

registerUDFInfo(workspace, name, udf)

Example

// Import classes:
import io.tiledb.cloud.rest_api.ApiClient;
import io.tiledb.cloud.rest_api.ApiException;
import io.tiledb.cloud.rest_api.Configuration;
import io.tiledb.cloud.rest_api.auth.*;
import io.tiledb.cloud.rest_api.models.*;
import io.tiledb.cloud.rest_api.api.UdfApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("/v1");
    
    // Configure HTTP basic authorization: BasicAuth
    HttpBasicAuth BasicAuth = (HttpBasicAuth) defaultClient.getAuthentication("BasicAuth");
    BasicAuth.setUsername("YOUR USERNAME");
    BasicAuth.setPassword("YOUR PASSWORD");

    // Configure API key authorization: ApiKeyAuth
    ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
    ApiKeyAuth.setApiKey("YOUR API KEY");
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //ApiKeyAuth.setApiKeyPrefix("Token");

    UdfApi apiInstance = new UdfApi(defaultClient);
    String workspace = "workspace_example"; // String | the workspace containing the teamspace the array belongs to
    String name = "name_example"; // String | name to register UDF under
    UDFInfoUpdate udf = new UDFInfoUpdate(); // UDFInfoUpdate | UDF to register
    try {
      apiInstance.registerUDFInfo(workspace, name, udf);
    } catch (ApiException e) {
      System.err.println("Exception when calling UdfApi#registerUDFInfo");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description
workspace	String	the workspace containing the teamspace the array belongs to
name	String	name to register UDF under
udf	UDFInfoUpdate	UDF to register

Return type

null (empty response body)

Authorization

BasicAuth, ApiKeyAuth

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
204	UDF registered successfully	-
502	Bad Gateway	-
0	error response	-

shareUDFInfo

shareUDFInfo(workspace, name, udfSharing)

Share a UDF with a user

Example

// Import classes:
import io.tiledb.cloud.rest_api.ApiClient;
import io.tiledb.cloud.rest_api.ApiException;
import io.tiledb.cloud.rest_api.Configuration;
import io.tiledb.cloud.rest_api.auth.*;
import io.tiledb.cloud.rest_api.models.*;
import io.tiledb.cloud.rest_api.api.UdfApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("/v1");
    
    // Configure HTTP basic authorization: BasicAuth
    HttpBasicAuth BasicAuth = (HttpBasicAuth) defaultClient.getAuthentication("BasicAuth");
    BasicAuth.setUsername("YOUR USERNAME");
    BasicAuth.setPassword("YOUR PASSWORD");

    // Configure API key authorization: ApiKeyAuth
    ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
    ApiKeyAuth.setApiKey("YOUR API KEY");
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //ApiKeyAuth.setApiKeyPrefix("Token");

    UdfApi apiInstance = new UdfApi(defaultClient);
    String workspace = "workspace_example"; // String | the workspace containing the teamspace the array belongs to
    String name = "name_example"; // String | name of UDFInfo
    UDFSharing udfSharing = new UDFSharing(); // 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.
    try {
      apiInstance.shareUDFInfo(workspace, name, udfSharing);
    } catch (ApiException e) {
      System.err.println("Exception when calling UdfApi#shareUDFInfo");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description
workspace	String	the workspace containing the teamspace the array belongs to
name	String	name of UDFInfo
udfSharing	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.

Return type

null (empty response body)

Authorization

BasicAuth, ApiKeyAuth

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
204	UDF shared successfully	-
404	UDF does not exist or user does not have permissions to share UDF	-
502	Bad Gateway	-
0	error response	-

submitGenericUDF

File submitGenericUDF(workspace, udf, acceptEncoding)

submit a generic UDF in the given namespace

Example

// Import classes:
import io.tiledb.cloud.rest_api.ApiClient;
import io.tiledb.cloud.rest_api.ApiException;
import io.tiledb.cloud.rest_api.Configuration;
import io.tiledb.cloud.rest_api.auth.*;
import io.tiledb.cloud.rest_api.models.*;
import io.tiledb.cloud.rest_api.api.UdfApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("/v1");
    
    // Configure HTTP basic authorization: BasicAuth
    HttpBasicAuth BasicAuth = (HttpBasicAuth) defaultClient.getAuthentication("BasicAuth");
    BasicAuth.setUsername("YOUR USERNAME");
    BasicAuth.setPassword("YOUR PASSWORD");

    // Configure API key authorization: ApiKeyAuth
    ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
    ApiKeyAuth.setApiKey("YOUR API KEY");
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //ApiKeyAuth.setApiKeyPrefix("Token");

    UdfApi apiInstance = new UdfApi(defaultClient);
    String workspace = "workspace_example"; // String | the workspace containing the teamspace the array belongs to
    GenericUDF udf = new GenericUDF(); // GenericUDF | UDF to run
    String acceptEncoding = "acceptEncoding_example"; // String | Encoding to use
    try {
      File result = apiInstance.submitGenericUDF(workspace, udf, acceptEncoding);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling UdfApi#submitGenericUDF");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description	Notes
workspace	String	the workspace containing the teamspace the array belongs to
udf	GenericUDF	UDF to run
acceptEncoding	String	Encoding to use	[optional]

Return type

File

Authorization

BasicAuth, ApiKeyAuth

HTTP request headers

Content-Type: application/json
Accept: application/octet-stream

HTTP response details

Status code	Description	Response headers
200	UDF completed and the UDF-type specific result is returned	* X-TILEDB-CLOUD-TASK-ID - Task ID for just completed request
502	Bad Gateway	-
0	error response	* X-TILEDB-CLOUD-TASK-ID - Task ID for just completed request

submitMultiArrayUDF

File submitMultiArrayUDF(workspace, udf, acceptEncoding)

submit a multi-array UDF in the given namespace

Example

// Import classes:
import io.tiledb.cloud.rest_api.ApiClient;
import io.tiledb.cloud.rest_api.ApiException;
import io.tiledb.cloud.rest_api.Configuration;
import io.tiledb.cloud.rest_api.auth.*;
import io.tiledb.cloud.rest_api.models.*;
import io.tiledb.cloud.rest_api.api.UdfApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("/v1");
    
    // Configure HTTP basic authorization: BasicAuth
    HttpBasicAuth BasicAuth = (HttpBasicAuth) defaultClient.getAuthentication("BasicAuth");
    BasicAuth.setUsername("YOUR USERNAME");
    BasicAuth.setPassword("YOUR PASSWORD");

    // Configure API key authorization: ApiKeyAuth
    ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
    ApiKeyAuth.setApiKey("YOUR API KEY");
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //ApiKeyAuth.setApiKeyPrefix("Token");

    UdfApi apiInstance = new UdfApi(defaultClient);
    String workspace = "workspace_example"; // String | the workspace containing the teamspace the array belongs to
    MultiArrayUDF udf = new MultiArrayUDF(); // MultiArrayUDF | UDF to run
    String acceptEncoding = "acceptEncoding_example"; // String | Encoding to use
    try {
      File result = apiInstance.submitMultiArrayUDF(workspace, udf, acceptEncoding);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling UdfApi#submitMultiArrayUDF");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description	Notes
workspace	String	the workspace containing the teamspace the array belongs to
udf	MultiArrayUDF	UDF to run
acceptEncoding	String	Encoding to use	[optional]

Return type

File

Authorization

BasicAuth, ApiKeyAuth

HTTP request headers

Content-Type: application/json
Accept: application/octet-stream

HTTP response details

Status code	Description	Response headers
200	UDF completed and the UDF-type specific result is returned	* X-TILEDB-CLOUD-TASK-ID - Task ID for just completed request
502	Bad Gateway	-
0	error response	* X-TILEDB-CLOUD-TASK-ID - Task ID for just completed request

submitUDF

File submitUDF(workspace, teamspace, array, udf, xPayer, acceptEncoding, v2)

send a UDF to run against a specified array/URI registered to a group/project

Example

// Import classes:
import io.tiledb.cloud.rest_api.ApiClient;
import io.tiledb.cloud.rest_api.ApiException;
import io.tiledb.cloud.rest_api.Configuration;
import io.tiledb.cloud.rest_api.auth.*;
import io.tiledb.cloud.rest_api.models.*;
import io.tiledb.cloud.rest_api.api.UdfApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("/v1");
    
    // Configure HTTP basic authorization: BasicAuth
    HttpBasicAuth BasicAuth = (HttpBasicAuth) defaultClient.getAuthentication("BasicAuth");
    BasicAuth.setUsername("YOUR USERNAME");
    BasicAuth.setPassword("YOUR PASSWORD");

    // Configure API key authorization: ApiKeyAuth
    ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
    ApiKeyAuth.setApiKey("YOUR API KEY");
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //ApiKeyAuth.setApiKeyPrefix("Token");

    UdfApi apiInstance = new UdfApi(defaultClient);
    String workspace = "workspace_example"; // String | the workspace containing the teamspace the array belongs to
    String teamspace = "teamspace_example"; // String | the teamspace the array belongs to
    String array = "array_example"; // String | name/uri of array that is url-encoded
    MultiArrayUDF udf = new MultiArrayUDF(); // MultiArrayUDF | UDF to run
    String xPayer = "xPayer_example"; // String | Name of organization or user who should be charged for this request
    String acceptEncoding = "acceptEncoding_example"; // String | Encoding to use
    String v2 = "v2_example"; // String | flag to indicate if v2 array UDFs should be used, currently in beta testing. Setting any value will enable v2 array UDFs.
    try {
      File result = apiInstance.submitUDF(workspace, teamspace, array, udf, xPayer, acceptEncoding, v2);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling UdfApi#submitUDF");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description	Notes
workspace	String	the workspace containing the teamspace the array belongs to
teamspace	String	the teamspace the array belongs to
array	String	name/uri of array that is url-encoded
udf	MultiArrayUDF	UDF to run
xPayer	String	Name of organization or user who should be charged for this request	[optional]
acceptEncoding	String	Encoding to use	[optional]
v2	String	flag to indicate if v2 array UDFs should be used, currently in beta testing. Setting any value will enable v2 array UDFs.	[optional]

Return type

File

Authorization

BasicAuth, ApiKeyAuth

HTTP request headers

Content-Type: application/json
Accept: application/octet-stream

HTTP response details

Status code	Description	Response headers
200	UDF completed and the UDF-type specific result is returned	* X-TILEDB-CLOUD-TASK-ID - Task ID for just completed request
502	Bad Gateway	-
0	error response	* X-TILEDB-CLOUD-TASK-ID - Task ID for just completed request

udfWorkspaceArrayEndTimestampsGet

ArrayEndTimestampData udfWorkspaceArrayEndTimestampsGet(workspace, array, page, perPage)

retrieve a list of timestamps from the array fragment info listing in milliseconds, paginated

Example

// Import classes:
import io.tiledb.cloud.rest_api.ApiClient;
import io.tiledb.cloud.rest_api.ApiException;
import io.tiledb.cloud.rest_api.Configuration;
import io.tiledb.cloud.rest_api.auth.*;
import io.tiledb.cloud.rest_api.models.*;
import io.tiledb.cloud.rest_api.api.UdfApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("/v1");
    
    // Configure HTTP basic authorization: BasicAuth
    HttpBasicAuth BasicAuth = (HttpBasicAuth) defaultClient.getAuthentication("BasicAuth");
    BasicAuth.setUsername("YOUR USERNAME");
    BasicAuth.setPassword("YOUR PASSWORD");

    // Configure API key authorization: ApiKeyAuth
    ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
    ApiKeyAuth.setApiKey("YOUR API KEY");
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //ApiKeyAuth.setApiKeyPrefix("Token");

    UdfApi apiInstance = new UdfApi(defaultClient);
    String workspace = "workspace_example"; // String | the workspace containing the teamspace the array belongs to
    String array = "array_example"; // String | name/uri of array that is url-encoded
    Integer page = 56; // Integer | pagination offset
    Integer perPage = 56; // Integer | pagination limit
    try {
      ArrayEndTimestampData result = apiInstance.udfWorkspaceArrayEndTimestampsGet(workspace, array, page, perPage);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling UdfApi#udfWorkspaceArrayEndTimestampsGet");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description	Notes
workspace	String	the workspace containing the teamspace the array belongs to
array	String	name/uri of array that is url-encoded
page	Integer	pagination offset	[optional]
perPage	Integer	pagination limit	[optional]

Return type

ArrayEndTimestampData

Authorization

BasicAuth, ApiKeyAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	list of timestamps in milliseconds, paginated	-
502	Bad Gateway	-
0	error response	-

updateUDFInfo

updateUDFInfo(workspace, name, udf)

update an existing registered UDF in the given namespace

Example

// Import classes:
import io.tiledb.cloud.rest_api.ApiClient;
import io.tiledb.cloud.rest_api.ApiException;
import io.tiledb.cloud.rest_api.Configuration;
import io.tiledb.cloud.rest_api.auth.*;
import io.tiledb.cloud.rest_api.models.*;
import io.tiledb.cloud.rest_api.api.UdfApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("/v1");
    
    // Configure HTTP basic authorization: BasicAuth
    HttpBasicAuth BasicAuth = (HttpBasicAuth) defaultClient.getAuthentication("BasicAuth");
    BasicAuth.setUsername("YOUR USERNAME");
    BasicAuth.setPassword("YOUR PASSWORD");

    // Configure API key authorization: ApiKeyAuth
    ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
    ApiKeyAuth.setApiKey("YOUR API KEY");
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //ApiKeyAuth.setApiKeyPrefix("Token");

    UdfApi apiInstance = new UdfApi(defaultClient);
    String workspace = "workspace_example"; // String | the workspace containing the teamspace the array belongs to
    String name = "name_example"; // String | name to register UDF under
    UDFInfoUpdate udf = new UDFInfoUpdate(); // UDFInfoUpdate | UDF to update
    try {
      apiInstance.updateUDFInfo(workspace, name, udf);
    } catch (ApiException e) {
      System.err.println("Exception when calling UdfApi#updateUDFInfo");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description
workspace	String	the workspace containing the teamspace the array belongs to
name	String	name to register UDF under
udf	UDFInfoUpdate	UDF to update

Return type

null (empty response body)

Authorization

BasicAuth, ApiKeyAuth

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
204	UDF updated successfully	-
502	Bad Gateway	-
0	error response	-

FilesExpand file tree

UdfApi.md

Latest commit

History

UdfApi.md

File metadata and controls

UdfApi

deleteUDFInfo

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

getUDFInfo

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

getUDFInfoSharingPolicies

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

handleCopyUDF

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

registerUDFInfo

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

shareUDFInfo

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

submitGenericUDF

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

submitMultiArrayUDF

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

submitUDF

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

udfWorkspaceArrayEndTimestampsGet

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

updateUDFInfo

Example

Parameters