All URIs are relative to /v1
| Method | HTTP request | Description |
|---|---|---|
| arrayActivityLog | GET /arrays/{namespace}/{array}/activity | |
| arraysBrowserOwnedGet | GET /arrays/browser/owned | |
| arraysBrowserOwnedSidebarGet | GET /arrays/browser/owned/sidebar | |
| arraysBrowserPublicGet | GET /arrays/browser/public | |
| arraysBrowserPublicSidebarGet | GET /arrays/browser/public/sidebar | |
| arraysBrowserSharedGet | GET /arrays/browser/shared | |
| arraysBrowserSharedSidebarGet | GET /arrays/browser/shared/sidebar | |
| arraysNamespaceArrayEndTimestampsGet | GET /arrays/{namespace}/{array}/end_timestamps | |
| consolidateArray | POST /arrays/{namespace}/{array}/consolidate | |
| createArray | POST /arrays/{namespace}/{array} | |
| deleteArray | DELETE /arrays/{namespace}/{array} | |
| deregisterArray | DELETE /arrays/{namespace}/{array}/deregister | |
| fragmentInfo | POST /arrays/{namespace}/{array}/fragment_info | |
| getActivityLogById | GET /arrays/{namespace}/{array}/activity/{id} | |
| getAllArrayMetadata | GET /arrays | |
| getArray | GET /arrays/{namespace}/{array} | |
| getArrayMaxBufferSizes | GET /arrays/{namespace}/{array}/max_buffer_sizes | |
| getArrayMetaDataJson | GET /arrays/{namespace}/{array}/metadata_json | |
| getArrayMetadata | GET /arrays/{namespace}/{array}/metadata | |
| getArrayMetadataCapnp | GET /arrays/{namespace}/{array}/array_metadata | |
| getArrayNonEmptyDomain | GET /arrays/{namespace}/{array}/non_empty_domain | |
| getArrayNonEmptyDomainJson | GET /arrays/{namespace}/{array}/non_empty_domain_json | |
| getArraySampleData | GET /arrays/{namespace}/{array}/sample | |
| getArraySharingPolicies | GET /arrays/{namespace}/{array}/share | |
| getArraysInNamespace | GET /arrays/{namespace} | |
| getFragmentEndTimestamp | GET /arrays/{namespace}/{array}/fragment_end_timestamp | |
| getLastAccessedArrays | GET /arrays/last_accessed | |
| loadArraySchema | POST /arrays/{namespace}/{array}/schema | |
| loadEnumerations | POST /arrays/{namespace}/{array}/enumerations | |
| registerArray | POST /arrays/{namespace}/{array}/register | |
| shareArray | PATCH /arrays/{namespace}/{array}/share | |
| updateArrayMetadata | PATCH /arrays/{namespace}/{array}/metadata | |
| updateArrayMetadataCapnp | POST /arrays/{namespace}/{array}/array_metadata | |
| vacuumArray | POST /arrays/{namespace}/{array}/vacuum |
List<ArrayActivityLog> arrayActivityLog(namespace, array, start, end, eventTypes, taskId, hasTaskId)
get array activity logs
// 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.ArrayApi;
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");
ArrayApi apiInstance = new ArrayApi(defaultClient);
String namespace = "namespace_example"; // String | namespace array is in (an organization name or user's username)
String array = "array_example"; // String | name/uri of array that is url-encoded
Integer start = 56; // Integer | Start time of window of fetch logs, unix epoch in seconds (default: seven days ago)
Integer end = 56; // Integer | End time of window of fetch logs, unix epoch in seconds (default: current utc timestamp)
String eventTypes = "eventTypes_example"; // String | Refer to ActivityEventType for possible values
String taskId = "taskId_example"; // String | Array task ID To filter activity to
Boolean hasTaskId = true; // Boolean | Excludes activity log results that do not contain an array task UUID
try {
List<ArrayActivityLog> result = apiInstance.arrayActivityLog(namespace, array, start, end, eventTypes, taskId, hasTaskId);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ArrayApi#arrayActivityLog");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| namespace | String | namespace array is in (an organization name or user's username) | |
| array | String | name/uri of array that is url-encoded | |
| start | Integer | Start time of window of fetch logs, unix epoch in seconds (default: seven days ago) | [optional] |
| end | Integer | End time of window of fetch logs, unix epoch in seconds (default: current utc timestamp) | [optional] |
| eventTypes | String | Refer to ActivityEventType for possible values | [optional] |
| taskId | String | Array task ID To filter activity to | [optional] |
| hasTaskId | Boolean | Excludes activity log results that do not contain an array task UUID | [optional] |
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | log of array activity | - |
| 502 | Bad Gateway | - |
| 0 | error response | - |
ArrayBrowserData arraysBrowserOwnedGet(page, perPage, search, namespace, orderby, permissions, tag, excludeTag, fileType, excludeFileType, fileProperty, withMetadata)
Fetch a list of all arrays that are owned directly by user or user's organizations
// 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.ArrayApi;
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");
ArrayApi apiInstance = new ArrayApi(defaultClient);
Integer page = 56; // Integer | pagination offset
Integer perPage = 56; // Integer | pagination limit
String search = "search_example"; // String | search string that will look at name, namespace or description fields
String namespace = "namespace_example"; // String | namespace
String orderby = "orderby_example"; // String | sort by which field valid values include size, name
String permissions = "permissions_example"; // String | permissions valid values include read, read_write, write, admin
List<String> tag = Arrays.asList(); // List<String> | tag to search for, more than one can be included
List<String> excludeTag = Arrays.asList(); // List<String> | tags to exclude matching array in results, more than one can be included
List<String> fileType = Arrays.asList(); // List<String> | file_type to search for, more than one can be included
List<String> excludeFileType = Arrays.asList(); // List<String> | file_type to exclude matching array in results, more than one can be included
List<String> fileProperty = Arrays.asList(); // List<String> | file_property key-value pair (comma separated, i.e. key,value) to search for, more than one can be included
Boolean withMetadata = true; // Boolean | include the metadata of the array
try {
ArrayBrowserData result = apiInstance.arraysBrowserOwnedGet(page, perPage, search, namespace, orderby, permissions, tag, excludeTag, fileType, excludeFileType, fileProperty, withMetadata);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ArrayApi#arraysBrowserOwnedGet");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| page | Integer | pagination offset | [optional] |
| perPage | Integer | pagination limit | [optional] |
| search | String | search string that will look at name, namespace or description fields | [optional] |
| namespace | String | namespace | [optional] |
| orderby | String | sort by which field valid values include size, name | [optional] |
| permissions | String | permissions valid values include read, read_write, write, admin | [optional] |
| tag | List<String> | tag to search for, more than one can be included | [optional] |
| excludeTag | List<String> | tags to exclude matching array in results, more than one can be included | [optional] |
| fileType | List<String> | file_type to search for, more than one can be included | [optional] |
| excludeFileType | List<String> | file_type to exclude matching array in results, more than one can be included | [optional] |
| fileProperty | List<String> | file_property key-value pair (comma separated, i.e. key,value) to search for, more than one can be included | [optional] |
| withMetadata | Boolean | include the metadata of the array | [optional] |
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | Array of array info that are owned directly by user or user's organizations | - |
| 502 | Bad Gateway | - |
| 0 | error response | - |
ArrayBrowserSidebar arraysBrowserOwnedSidebarGet(fileType, excludeFileType, fileProperty)
Fetch a sidebar for arrays that are owned directly by user or user's organizations
// 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.ArrayApi;
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");
ArrayApi apiInstance = new ArrayApi(defaultClient);
List<String> fileType = Arrays.asList(); // List<String> | file_type to search for, more than one can be included
List<String> excludeFileType = Arrays.asList(); // List<String> | file_type to exclude matching array in results, more than one can be included
List<String> fileProperty = Arrays.asList(); // List<String> | file_property key-value pair (comma separated, i.e. key,value) to search for, more than one can be included
try {
ArrayBrowserSidebar result = apiInstance.arraysBrowserOwnedSidebarGet(fileType, excludeFileType, fileProperty);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ArrayApi#arraysBrowserOwnedSidebarGet");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| fileType | List<String> | file_type to search for, more than one can be included | [optional] |
| excludeFileType | List<String> | file_type to exclude matching array in results, more than one can be included | [optional] |
| fileProperty | List<String> | file_property key-value pair (comma separated, i.e. key,value) to search for, more than one can be included | [optional] |
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | Array of array info that are owned directly by user or user's organizations | - |
| 502 | Bad Gateway | - |
| 0 | error response | - |
ArrayBrowserData arraysBrowserPublicGet(page, perPage, search, namespace, orderby, permissions, tag, excludeTag, fileType, excludeFileType, fileProperty, withMetadata)
Fetch a list of all arrays that have been shared publically
// 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.ArrayApi;
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");
ArrayApi apiInstance = new ArrayApi(defaultClient);
Integer page = 56; // Integer | pagination offset
Integer perPage = 56; // Integer | pagination limit
String search = "search_example"; // String | search string that will look at name, namespace or description fields
String namespace = "namespace_example"; // String | namespace
String orderby = "orderby_example"; // String | sort by which field valid values include size, name
String permissions = "permissions_example"; // String | permissions valid values include read, read_write, write, admin
List<String> tag = Arrays.asList(); // List<String> | tag to search for, more than one can be included
List<String> excludeTag = Arrays.asList(); // List<String> | tags to exclude matching array in results, more than one can be included
List<String> fileType = Arrays.asList(); // List<String> | file_type to search for, more than one can be included
List<String> excludeFileType = Arrays.asList(); // List<String> | file_type to exclude matching array in results, more than one can be included
List<String> fileProperty = Arrays.asList(); // List<String> | file_property key-value pair (comma separated, i.e. key,value) to search for, more than one can be included
Boolean withMetadata = true; // Boolean | include the metadata of the array
try {
ArrayBrowserData result = apiInstance.arraysBrowserPublicGet(page, perPage, search, namespace, orderby, permissions, tag, excludeTag, fileType, excludeFileType, fileProperty, withMetadata);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ArrayApi#arraysBrowserPublicGet");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| page | Integer | pagination offset | [optional] |
| perPage | Integer | pagination limit | [optional] |
| search | String | search string that will look at name, namespace or description fields | [optional] |
| namespace | String | namespace | [optional] |
| orderby | String | sort by which field valid values include size, name | [optional] |
| permissions | String | permissions valid values include read, read_write, write, admin | [optional] |
| tag | List<String> | tag to search for, more than one can be included | [optional] |
| excludeTag | List<String> | tags to exclude matching array in results, more than one can be included | [optional] |
| fileType | List<String> | file_type to search for, more than one can be included | [optional] |
| excludeFileType | List<String> | file_type to exclude matching array in results, more than one can be included | [optional] |
| fileProperty | List<String> | file_property key-value pair (comma separated, i.e. key,value) to search for, more than one can be included | [optional] |
| withMetadata | Boolean | include the metadata of the array | [optional] |
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | Array of array info that has been shared publically | - |
| 502 | Bad Gateway | - |
| 0 | error response | - |
ArrayBrowserSidebar arraysBrowserPublicSidebarGet(fileType, excludeFileType, fileProperty)
Fetch a sidebar of all arrays that have been shared publically
// 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.ArrayApi;
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");
ArrayApi apiInstance = new ArrayApi(defaultClient);
List<String> fileType = Arrays.asList(); // List<String> | file_type to search for, more than one can be included
List<String> excludeFileType = Arrays.asList(); // List<String> | file_type to exclude matching array in results, more than one can be included
List<String> fileProperty = Arrays.asList(); // List<String> | file_property key-value pair (comma separated, i.e. key,value) to search for, more than one can be included
try {
ArrayBrowserSidebar result = apiInstance.arraysBrowserPublicSidebarGet(fileType, excludeFileType, fileProperty);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ArrayApi#arraysBrowserPublicSidebarGet");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| fileType | List<String> | file_type to search for, more than one can be included | [optional] |
| excludeFileType | List<String> | file_type to exclude matching array in results, more than one can be included | [optional] |
| fileProperty | List<String> | file_property key-value pair (comma separated, i.e. key,value) to search for, more than one can be included | [optional] |
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | Array of array info that has been shared publically | - |
| 502 | Bad Gateway | - |
| 0 | error response | - |
ArrayBrowserData arraysBrowserSharedGet(page, perPage, search, namespace, orderby, permissions, tag, excludeTag, fileType, excludeFileType, fileProperty, sharedTo, withMetadata)
Fetch a list of all arrays that have been shared with the user
// 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.ArrayApi;
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");
ArrayApi apiInstance = new ArrayApi(defaultClient);
Integer page = 56; // Integer | pagination offset
Integer perPage = 56; // Integer | pagination limit
String search = "search_example"; // String | search string that will look at name, namespace or description fields
String namespace = "namespace_example"; // String | namespace
String orderby = "orderby_example"; // String | sort by which field valid values include size, name
String permissions = "permissions_example"; // String | permissions valid values include read, read_write, write, admin
List<String> tag = Arrays.asList(); // List<String> | tag to search for, more than one can be included
List<String> excludeTag = Arrays.asList(); // List<String> | tags to exclude matching array in results, more than one can be included
List<String> fileType = Arrays.asList(); // List<String> | file_type to search for, more than one can be included
List<String> excludeFileType = Arrays.asList(); // List<String> | file_type to exclude matching array in results, more than one can be included
List<String> fileProperty = Arrays.asList(); // List<String> | file_property key-value pair (comma separated, i.e. key,value) to search for, more than one can be included
List<String> sharedTo = Arrays.asList(); // List<String> | namespaces to filter results of where there arrays were shared to
Boolean withMetadata = true; // Boolean | include the metadata of the array
try {
ArrayBrowserData result = apiInstance.arraysBrowserSharedGet(page, perPage, search, namespace, orderby, permissions, tag, excludeTag, fileType, excludeFileType, fileProperty, sharedTo, withMetadata);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ArrayApi#arraysBrowserSharedGet");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| page | Integer | pagination offset | [optional] |
| perPage | Integer | pagination limit | [optional] |
| search | String | search string that will look at name, namespace or description fields | [optional] |
| namespace | String | namespace | [optional] |
| orderby | String | sort by which field valid values include size, name | [optional] |
| permissions | String | permissions valid values include read, read_write, write, admin | [optional] |
| tag | List<String> | tag to search for, more than one can be included | [optional] |
| excludeTag | List<String> | tags to exclude matching array in results, more than one can be included | [optional] |
| fileType | List<String> | file_type to search for, more than one can be included | [optional] |
| excludeFileType | List<String> | file_type to exclude matching array in results, more than one can be included | [optional] |
| fileProperty | List<String> | file_property key-value pair (comma separated, i.e. key,value) to search for, more than one can be included | [optional] |
| sharedTo | List<String> | namespaces to filter results of where there arrays were shared to | [optional] |
| withMetadata | Boolean | include the metadata of the array | [optional] |
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | Array of array info that has been shared with the user | - |
| 502 | Bad Gateway | - |
| 0 | error response | - |
ArrayBrowserSidebar arraysBrowserSharedSidebarGet(fileType, excludeFileType, fileProperty, sharedTo)
Fetch a list of all arrays that have been shared with the user
// 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.ArrayApi;
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");
ArrayApi apiInstance = new ArrayApi(defaultClient);
List<String> fileType = Arrays.asList(); // List<String> | file_type to search for, more than one can be included
List<String> excludeFileType = Arrays.asList(); // List<String> | file_type to exclude matching array in results, more than one can be included
List<String> fileProperty = Arrays.asList(); // List<String> | file_property key-value pair (comma separated, i.e. key,value) to search for, more than one can be included
List<String> sharedTo = Arrays.asList(); // List<String> | namespaces to filter results of where there groups were shared to
try {
ArrayBrowserSidebar result = apiInstance.arraysBrowserSharedSidebarGet(fileType, excludeFileType, fileProperty, sharedTo);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ArrayApi#arraysBrowserSharedSidebarGet");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| fileType | List<String> | file_type to search for, more than one can be included | [optional] |
| excludeFileType | List<String> | file_type to exclude matching array in results, more than one can be included | [optional] |
| fileProperty | List<String> | file_property key-value pair (comma separated, i.e. key,value) to search for, more than one can be included | [optional] |
| sharedTo | List<String> | namespaces to filter results of where there groups were shared to | [optional] |
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | Array of array info that has been shared with the user | - |
| 502 | Bad Gateway | - |
| 0 | error response | - |
ArrayEndTimestampData arraysNamespaceArrayEndTimestampsGet(namespace, array, page, perPage)
retrieve a list of timestamps from the array fragment info listing in milliseconds, paginated
// 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.ArrayApi;
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");
ArrayApi apiInstance = new ArrayApi(defaultClient);
String namespace = "namespace_example"; // String | namespace array is in (an organization name or user's username)
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.arraysNamespaceArrayEndTimestampsGet(namespace, array, page, perPage);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ArrayApi#arraysNamespaceArrayEndTimestampsGet");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| namespace | String | namespace array is in (an organization name or user's username) | |
| array | String | name/uri of array that is url-encoded | |
| page | Integer | pagination offset | [optional] |
| perPage | Integer | pagination limit | [optional] |
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | list of timestamps in milliseconds, paginated | - |
| 502 | Bad Gateway | - |
| 0 | error response | - |
consolidateArray(namespace, array, consolidateRequest)
consolidate an array at a specified URI
// 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.ArrayApi;
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");
ArrayApi apiInstance = new ArrayApi(defaultClient);
String namespace = "namespace_example"; // String | namespace array is in (an organization name or user's username)
String array = "array_example"; // String | name/uri of array that is url-encoded
ArrayConsolidationRequest consolidateRequest = new ArrayConsolidationRequest(); // ArrayConsolidationRequest | Consolidate Request
try {
apiInstance.consolidateArray(namespace, array, consolidateRequest);
} catch (ApiException e) {
System.err.println("Exception when calling ArrayApi#consolidateArray");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| namespace | String | namespace array is in (an organization name or user's username) | |
| array | String | name/uri of array that is url-encoded | |
| consolidateRequest | ArrayConsolidationRequest | Consolidate Request |
null (empty response body)
- Content-Type: application/json
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 204 | array consolidated successfully | - |
| 502 | Bad Gateway | - |
| 0 | error response | - |
createArray(namespace, array, contentType, arraySchema, X_TILEDB_CLOUD_ACCESS_CREDENTIALS_NAME)
create a array schema at a specified URI registered to a group/project
// 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.ArrayApi;
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");
ArrayApi apiInstance = new ArrayApi(defaultClient);
String namespace = "namespace_example"; // String | namespace array is in (an organization name or user's username)
String array = "array_example"; // String | name/uri of array that is url-encoded
String contentType = "application/json"; // String | Content Type of input and return mime
ArraySchema arraySchema = new ArraySchema(); // ArraySchema | ArraySchema being created
String X_TILEDB_CLOUD_ACCESS_CREDENTIALS_NAME = "X_TILEDB_CLOUD_ACCESS_CREDENTIALS_NAME_example"; // String | Optional registered access credentials to use for creation
try {
apiInstance.createArray(namespace, array, contentType, arraySchema, X_TILEDB_CLOUD_ACCESS_CREDENTIALS_NAME);
} catch (ApiException e) {
System.err.println("Exception when calling ArrayApi#createArray");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| namespace | String | namespace array is in (an organization name or user's username) | |
| array | String | name/uri of array that is url-encoded | |
| contentType | String | Content Type of input and return mime | [default to application/json] |
| arraySchema | ArraySchema | ArraySchema being created | |
| X_TILEDB_CLOUD_ACCESS_CREDENTIALS_NAME | String | Optional registered access credentials to use for creation | [optional] |
null (empty response body)
- Content-Type: application/json
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 204 | schema created successfully | - |
| 502 | Bad Gateway | - |
| 0 | error response | - |
deleteArray(namespace, array, contentType)
delete a array
// 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.ArrayApi;
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");
ArrayApi apiInstance = new ArrayApi(defaultClient);
String namespace = "namespace_example"; // String | namespace array is in (an organization name or user's username)
String array = "array_example"; // String | name/uri of array that is url-encoded
String contentType = "application/json"; // String | Content Type of input and return mime
try {
apiInstance.deleteArray(namespace, array, contentType);
} catch (ApiException e) {
System.err.println("Exception when calling ArrayApi#deleteArray");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| namespace | String | namespace array is in (an organization name or user's username) | |
| array | String | name/uri of array that is url-encoded | |
| contentType | String | Content Type of input and return mime | [default to application/json] |
null (empty response body)
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 204 | delete array successful | - |
| 502 | Bad Gateway | - |
| 0 | error response | - |
deregisterArray(namespace, array)
deregister a array
// 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.ArrayApi;
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");
ArrayApi apiInstance = new ArrayApi(defaultClient);
String namespace = "namespace_example"; // String | namespace array is in (an organization name or user's username)
String array = "array_example"; // String | name/uri of array that is url-encoded
try {
apiInstance.deregisterArray(namespace, array);
} catch (ApiException e) {
System.err.println("Exception when calling ArrayApi#deregisterArray");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| namespace | String | namespace array is in (an organization name or user's username) | |
| array | String | name/uri of array that is url-encoded |
null (empty response body)
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 204 | deregistered array successful | - |
| 502 | Bad Gateway | - |
| 0 | error response | - |
FragmentInfo fragmentInfo(namespace, array, contentType, fragmentInfoRequest)
fetch an array's fragment info
// 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.ArrayApi;
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");
ArrayApi apiInstance = new ArrayApi(defaultClient);
String namespace = "namespace_example"; // String | namespace array is in (an organization name or user's username)
String array = "array_example"; // String | name/uri of array that is url-encoded
String contentType = "application/json"; // String | Content Type of input and return mime
FragmentInfoRequest fragmentInfoRequest = new FragmentInfoRequest(); // FragmentInfoRequest | ArraySchema being created
try {
FragmentInfo result = apiInstance.fragmentInfo(namespace, array, contentType, fragmentInfoRequest);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ArrayApi#fragmentInfo");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| namespace | String | namespace array is in (an organization name or user's username) | |
| array | String | name/uri of array that is url-encoded | |
| contentType | String | Content Type of input and return mime | [default to application/json] |
| fragmentInfoRequest | FragmentInfoRequest | ArraySchema being created |
- Content-Type: application/json
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | fragment info | - |
| 0 | error response | - |
ArrayActivityLog getActivityLogById(namespace, array, id)
get activity log by ID
// 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.ArrayApi;
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");
ArrayApi apiInstance = new ArrayApi(defaultClient);
String namespace = "namespace_example"; // String | namespace array is in (an organization name or user's username)
String array = "array_example"; // String | name/uri of array that is url-encoded
String id = "id_example"; // String | ID of the activity
try {
ArrayActivityLog result = apiInstance.getActivityLogById(namespace, array, id);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ArrayApi#getActivityLogById");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| namespace | String | namespace array is in (an organization name or user's username) | |
| array | String | name/uri of array that is url-encoded | |
| id | String | ID of the activity |
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | array activity | - |
| 502 | Bad Gateway | - |
| 0 | error response | - |
List<ArrayInfo> getAllArrayMetadata(publicShare)
get all array metadata user has access to
// 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.ArrayApi;
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");
ArrayApi apiInstance = new ArrayApi(defaultClient);
String publicShare = "publicShare_example"; // String | Public share values can be one of exclude, only
try {
List<ArrayInfo> result = apiInstance.getAllArrayMetadata(publicShare);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ArrayApi#getAllArrayMetadata");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| publicShare | String | Public share values can be one of exclude, only | [optional] |
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | array metadata for all arrays user has access to | - |
| 502 | Bad Gateway | - |
| 0 | error response | - |
ArraySchema getArray(namespace, array, contentType)
get an ArraySchema using a url encoded uri
// 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.ArrayApi;
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");
ArrayApi apiInstance = new ArrayApi(defaultClient);
String namespace = "namespace_example"; // String | namespace array is in (an organization name or user's username)
String array = "array_example"; // String | name/uri of array that is url-encoded
String contentType = "application/json"; // String | Content Type of input and return mime
try {
ArraySchema result = apiInstance.getArray(namespace, array, contentType);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ArrayApi#getArray");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| namespace | String | namespace array is in (an organization name or user's username) | |
| array | String | name/uri of array that is url-encoded | |
| contentType | String | Content Type of input and return mime | [default to application/json] |
- Content-Type: Not defined
- Accept: application/json, application/capnp
| Status code | Description | Response headers |
|---|---|---|
| 200 | get ArraySchema | - |
| 502 | Bad Gateway | - |
| 0 | error response | - |
MaxBufferSizes getArrayMaxBufferSizes(namespace, array, subarray, contentType, xPayer)
get the max buffer sizes of an array for a subarray
// 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.ArrayApi;
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");
ArrayApi apiInstance = new ArrayApi(defaultClient);
String namespace = "namespace_example"; // String | namespace array is in (an organization name or user's username)
String array = "array_example"; // String | name/uri of array that is url-encoded
String subarray = "subarray_example"; // String | CSV string of subarray to get max buffer sizes for
String contentType = "application/json"; // String | Content Type of input and return mime
String xPayer = "xPayer_example"; // String | Name of organization or user who should be charged for this request
try {
MaxBufferSizes result = apiInstance.getArrayMaxBufferSizes(namespace, array, subarray, contentType, xPayer);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ArrayApi#getArrayMaxBufferSizes");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| namespace | String | namespace array is in (an organization name or user's username) | |
| array | String | name/uri of array that is url-encoded | |
| subarray | String | CSV string of subarray to get max buffer sizes for | |
| contentType | String | Content Type of input and return mime | [default to application/json] |
| xPayer | String | Name of organization or user who should be charged for this request | [optional] |
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | get the max buffer sizes of an array for a subarray | - |
| 502 | Bad Gateway | - |
| 0 | error response | - |
Map<String, Object> getArrayMetaDataJson(namespace, array, length, endTimestamp)
get metadata from the array in JSON format
// 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.ArrayApi;
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");
ArrayApi apiInstance = new ArrayApi(defaultClient);
String namespace = "namespace_example"; // String | namespace array is in (an organization name or user's username)
String array = "array_example"; // String | name/uri of array that is url-encoded
Integer length = 56; // Integer | (optional) limit character length of returned values
Integer endTimestamp = 56; // Integer | Milliseconds since Unix epoch, metadata will use open_at functionality to open array at the specific timestamp
try {
Map<String, Object> result = apiInstance.getArrayMetaDataJson(namespace, array, length, endTimestamp);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ArrayApi#getArrayMetaDataJson");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| namespace | String | namespace array is in (an organization name or user's username) | |
| array | String | name/uri of array that is url-encoded | |
| length | Integer | (optional) limit character length of returned values | [optional] |
| endTimestamp | Integer | Milliseconds since Unix epoch, metadata will use open_at functionality to open array at the specific timestamp | [optional] |
Map<String, Object>
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | get array metadata | - |
| 502 | Bad Gateway | - |
| 0 | error response | - |
ArrayInfo getArrayMetadata(namespace, array)
get metadata on an array
// 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.ArrayApi;
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");
ArrayApi apiInstance = new ArrayApi(defaultClient);
String namespace = "namespace_example"; // String | namespace array is in (an organization name or user's username)
String array = "array_example"; // String | name/uri of array that is url-encoded
try {
ArrayInfo result = apiInstance.getArrayMetadata(namespace, array);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ArrayApi#getArrayMetadata");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| namespace | String | namespace array is in (an organization name or user's username) | |
| array | String | name/uri of array that is url-encoded |
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | array metadata for an array | - |
| 502 | Bad Gateway | - |
| 0 | error response | - |
ArrayMetadata getArrayMetadataCapnp(namespace, array)
get metadata on an array
// 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.ArrayApi;
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");
ArrayApi apiInstance = new ArrayApi(defaultClient);
String namespace = "namespace_example"; // String | namespace array is in (an organization name or user's username)
String array = "array_example"; // String | name/uri of array that is url-encoded
try {
ArrayMetadata result = apiInstance.getArrayMetadataCapnp(namespace, array);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ArrayApi#getArrayMetadataCapnp");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| namespace | String | namespace array is in (an organization name or user's username) | |
| array | String | name/uri of array that is url-encoded |
- Content-Type: Not defined
- Accept: application/json, application/capnp
| Status code | Description | Response headers |
|---|---|---|
| 200 | array metadata for an array | - |
| 502 | Bad Gateway | - |
| 0 | error response | - |
NonEmptyDomain getArrayNonEmptyDomain(namespace, array, contentType, xPayer)
get the non empty domain of an array
// 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.ArrayApi;
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");
ArrayApi apiInstance = new ArrayApi(defaultClient);
String namespace = "namespace_example"; // String | namespace array is in (an organization name or user's username)
String array = "array_example"; // String | name/uri of array that is url-encoded
String contentType = "application/json"; // String | Content Type of input and return mime
String xPayer = "xPayer_example"; // String | Name of organization or user who should be charged for this request
try {
NonEmptyDomain result = apiInstance.getArrayNonEmptyDomain(namespace, array, contentType, xPayer);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ArrayApi#getArrayNonEmptyDomain");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| namespace | String | namespace array is in (an organization name or user's username) | |
| array | String | name/uri of array that is url-encoded | |
| contentType | String | Content Type of input and return mime | [default to application/json] |
| xPayer | String | Name of organization or user who should be charged for this request | [optional] |
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | get the non empty domain of an array | - |
| 502 | Bad Gateway | - |
| 0 | error response | - |
Map<String, Object> getArrayNonEmptyDomainJson(namespace, array)
get non-empty domain from the array in json format
// 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.ArrayApi;
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");
ArrayApi apiInstance = new ArrayApi(defaultClient);
String namespace = "namespace_example"; // String | namespace array is in (an organization name or user's username)
String array = "array_example"; // String | name/uri of array that is url-encoded
try {
Map<String, Object> result = apiInstance.getArrayNonEmptyDomainJson(namespace, array);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ArrayApi#getArrayNonEmptyDomainJson");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| namespace | String | namespace array is in (an organization name or user's username) | |
| array | String | name/uri of array that is url-encoded |
Map<String, Object>
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | get array non-empty domaim | - |
| 502 | Bad Gateway | - |
| 0 | error response | - |
ArraySample getArraySampleData(namespace, array, samples)
get an sample set of data from the array
// 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.ArrayApi;
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");
ArrayApi apiInstance = new ArrayApi(defaultClient);
String namespace = "namespace_example"; // String | namespace array is in (an organization name or user's username)
String array = "array_example"; // String | name/uri of array that is url-encoded
BigDecimal samples = new BigDecimal("5.0"); // BigDecimal | Number of sample results to return
try {
ArraySample result = apiInstance.getArraySampleData(namespace, array, samples);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ArrayApi#getArraySampleData");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| namespace | String | namespace array is in (an organization name or user's username) | |
| array | String | name/uri of array that is url-encoded | |
| samples | BigDecimal | Number of sample results to return | [optional] [default to 5.0] |
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | get array sample data | - |
| 502 | Bad Gateway | - |
| 0 | error response | - |
List<ArraySharing> getArraySharingPolicies(namespace, array)
Get all sharing details of the array
// 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.ArrayApi;
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");
ArrayApi apiInstance = new ArrayApi(defaultClient);
String namespace = "namespace_example"; // String | namespace array is in (an organization name or user's username)
String array = "array_example"; // String | name/uri of array that is url-encoded
try {
List<ArraySharing> result = apiInstance.getArraySharingPolicies(namespace, array);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ArrayApi#getArraySharingPolicies");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| namespace | String | namespace array is in (an organization name or user's username) | |
| array | String | name/uri of array that is url-encoded |
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | List of all specific sharing policies | - |
| 404 | Array does not exist or user does not have permissions to view array-sharing policies | - |
| 502 | Bad Gateway | - |
| 0 | error response | - |
List<ArrayInfo> getArraysInNamespace(namespace, withMetadata)
get metadata on all arrays in a namespace
// 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.ArrayApi;
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");
ArrayApi apiInstance = new ArrayApi(defaultClient);
String namespace = "namespace_example"; // String | namespace array is in (an organization name or user's username)
Boolean withMetadata = true; // Boolean | include the metadata of the arrays
try {
List<ArrayInfo> result = apiInstance.getArraysInNamespace(namespace, withMetadata);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ArrayApi#getArraysInNamespace");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| namespace | String | namespace array is in (an organization name or user's username) | |
| withMetadata | Boolean | include the metadata of the arrays | [optional] |
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | array metadata for all arrays in a namespace | - |
| 502 | Bad Gateway | - |
| 0 | error response | - |
Integer getFragmentEndTimestamp(namespace, array, endTimestamp)
Get fragment end_timestamp on an array, will search for the closest end_timestamp to the timestamp asked
// 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.ArrayApi;
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");
ArrayApi apiInstance = new ArrayApi(defaultClient);
String namespace = "namespace_example"; // String | namespace array is in (an organization name or user's username)
String array = "array_example"; // String | name/uri of array that is url-encoded
Integer endTimestamp = 56; // Integer | Milliseconds since Unix epoch
try {
Integer result = apiInstance.getFragmentEndTimestamp(namespace, array, endTimestamp);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ArrayApi#getFragmentEndTimestamp");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| namespace | String | namespace array is in (an organization name or user's username) | |
| array | String | name/uri of array that is url-encoded | |
| endTimestamp | Integer | Milliseconds since Unix epoch | [optional] |
Integer
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | fragment end_timestamp on an array | - |
| 502 | Bad Gateway | - |
| 0 | error response | - |
List<LastAccessedArray> getLastAccessedArrays()
// 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.ArrayApi;
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");
ArrayApi apiInstance = new ArrayApi(defaultClient);
try {
List<LastAccessedArray> result = apiInstance.getLastAccessedArrays();
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ArrayApi#getLastAccessedArrays");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}This endpoint does not need any parameter.
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | gets last accessed arrays | - |
| 502 | Bad Gateway | - |
| 0 | error response | - |
LoadArraySchemaResponse loadArraySchema(namespace, array, loadArraySchemaRequest)
request to get the array schema
// 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.ArrayApi;
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");
ArrayApi apiInstance = new ArrayApi(defaultClient);
String namespace = "namespace_example"; // String | namespace array is in (an organization name or user's username)
String array = "array_example"; // String | name/uri of array that is url-encoded
LoadArraySchemaRequest loadArraySchemaRequest = new LoadArraySchemaRequest(); // LoadArraySchemaRequest | Load Array Schema Request
try {
LoadArraySchemaResponse result = apiInstance.loadArraySchema(namespace, array, loadArraySchemaRequest);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ArrayApi#loadArraySchema");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| namespace | String | namespace array is in (an organization name or user's username) | |
| array | String | name/uri of array that is url-encoded | |
| loadArraySchemaRequest | LoadArraySchemaRequest | Load Array Schema Request |
- Content-Type: application/json
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | array schemas returned successfully | - |
| 404 | Array does not exist or user does not have permissions to access it | - |
| 502 | Bad Gateway | - |
| 0 | error response | - |
LoadEnumerationsResponse loadEnumerations(namespace, array, loadEnumerationsRequest)
request to get the enumerations of the arrays' attributes
// 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.ArrayApi;
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");
ArrayApi apiInstance = new ArrayApi(defaultClient);
String namespace = "namespace_example"; // String | namespace array is in (an organization name or user's username)
String array = "array_example"; // String | name/uri of array that is url-encoded
LoadEnumerationsRequest loadEnumerationsRequest = new LoadEnumerationsRequest(); // LoadEnumerationsRequest | Load Enumerations Request
try {
LoadEnumerationsResponse result = apiInstance.loadEnumerations(namespace, array, loadEnumerationsRequest);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ArrayApi#loadEnumerations");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| namespace | String | namespace array is in (an organization name or user's username) | |
| array | String | name/uri of array that is url-encoded | |
| loadEnumerationsRequest | LoadEnumerationsRequest | Load Enumerations Request |
- Content-Type: application/json
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | enumerations returned successfully | - |
| 404 | Array does not exist or user does not have permissions to access it | - |
| 502 | Bad Gateway | - |
| 0 | error response | - |
ArrayInfo registerArray(namespace, array, arrayMetadata)
register an array at a specified URI registered to the given namespace
// 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.ArrayApi;
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");
ArrayApi apiInstance = new ArrayApi(defaultClient);
String namespace = "namespace_example"; // String | namespace array is in (an organization name or user's username)
String array = "array_example"; // String | name/uri of array that is url-encoded
ArrayInfoUpdate arrayMetadata = new ArrayInfoUpdate(); // ArrayInfoUpdate | metadata associated with array
try {
ArrayInfo result = apiInstance.registerArray(namespace, array, arrayMetadata);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ArrayApi#registerArray");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| namespace | String | namespace array is in (an organization name or user's username) | |
| array | String | name/uri of array that is url-encoded | |
| arrayMetadata | ArrayInfoUpdate | metadata associated with array |
- Content-Type: application/json
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | array registered successfully | - |
| 502 | Bad Gateway | - |
| 0 | error response | - |
shareArray(namespace, array, arraySharing)
Share an array with a user
// 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.ArrayApi;
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");
ArrayApi apiInstance = new ArrayApi(defaultClient);
String namespace = "namespace_example"; // String | namespace array is in (an organization name or user's username)
String array = "array_example"; // String | name/uri of array that is url-encoded
ArraySharing arraySharing = new ArraySharing(); // ArraySharing | 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 array will not be shared with the namespace at all.
try {
apiInstance.shareArray(namespace, array, arraySharing);
} catch (ApiException e) {
System.err.println("Exception when calling ArrayApi#shareArray");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| namespace | String | namespace array is in (an organization name or user's username) | |
| array | String | name/uri of array that is url-encoded | |
| arraySharing | ArraySharing | 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 array will not be shared with the namespace at all. |
null (empty response body)
- Content-Type: application/json
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 204 | Array shared successfully | - |
| 404 | Array does not exist or user does not have permissions to share array | - |
| 502 | Bad Gateway | - |
| 0 | error response | - |
updateArrayMetadata(namespace, array, arrayMetadata)
update metadata on an array
// 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.ArrayApi;
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");
ArrayApi apiInstance = new ArrayApi(defaultClient);
String namespace = "namespace_example"; // String | namespace array is in (an organization name or user's username)
String array = "array_example"; // String | name/uri of array that is url-encoded
ArrayInfoUpdate arrayMetadata = new ArrayInfoUpdate(); // ArrayInfoUpdate | array metadata to update
try {
apiInstance.updateArrayMetadata(namespace, array, arrayMetadata);
} catch (ApiException e) {
System.err.println("Exception when calling ArrayApi#updateArrayMetadata");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| namespace | String | namespace array is in (an organization name or user's username) | |
| array | String | name/uri of array that is url-encoded | |
| arrayMetadata | ArrayInfoUpdate | array metadata to update |
null (empty response body)
- Content-Type: application/json
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 204 | array metadata updated successfully | - |
| 502 | Bad Gateway | - |
| 0 | error response | - |
updateArrayMetadataCapnp(namespace, array, arrayMetadataEntries)
update metadata on an array
// 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.ArrayApi;
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");
ArrayApi apiInstance = new ArrayApi(defaultClient);
String namespace = "namespace_example"; // String | namespace array is in (an organization name or user's username)
String array = "array_example"; // String | name/uri of array that is url-encoded
ArrayMetadata arrayMetadataEntries = new ArrayMetadata(); // ArrayMetadata | List of metadata entries
try {
apiInstance.updateArrayMetadataCapnp(namespace, array, arrayMetadataEntries);
} catch (ApiException e) {
System.err.println("Exception when calling ArrayApi#updateArrayMetadataCapnp");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| namespace | String | namespace array is in (an organization name or user's username) | |
| array | String | name/uri of array that is url-encoded | |
| arrayMetadataEntries | ArrayMetadata | List of metadata entries |
null (empty response body)
- Content-Type: application/json, application/capnp
- Accept: application/json, application/capnp
| Status code | Description | Response headers |
|---|---|---|
| 200 | array metadata updated successfully | - |
| 502 | Bad Gateway | - |
| 0 | error response | - |
vacuumArray(namespace, array, vaccumRequest)
vacuum an array at a specified URI
// 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.ArrayApi;
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");
ArrayApi apiInstance = new ArrayApi(defaultClient);
String namespace = "namespace_example"; // String | namespace array is in (an organization name or user's username)
String array = "array_example"; // String | name/uri of array that is url-encoded
ArrayVacuumRequest vaccumRequest = new ArrayVacuumRequest(); // ArrayVacuumRequest | Vaccum Request
try {
apiInstance.vacuumArray(namespace, array, vaccumRequest);
} catch (ApiException e) {
System.err.println("Exception when calling ArrayApi#vacuumArray");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| namespace | String | namespace array is in (an organization name or user's username) | |
| array | String | name/uri of array that is url-encoded | |
| vaccumRequest | ArrayVacuumRequest | Vaccum Request |
null (empty response body)
- Content-Type: application/json
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 204 | array vacuumed successfully | - |
| 502 | Bad Gateway | - |
| 0 | error response | - |