NotebookApi

All URIs are relative to /v1

Method	HTTP request	Description
getNotebookServerStatus	GET /notebooks/server/{namespace}/status
handleCopyNotebook	POST /notebooks/{namespace}/{array}/copy
handleUploadNotebook	POST /notebooks/{namespace}/upload
shutdownNotebookServer	DELETE /notebooks/server/{namespace}
updateNotebookName	PATCH /notebooks/{namespace}/{array}/rename

getNotebookServerStatus

NotebookStatus getNotebookServerStatus(namespace)

Get status of the notebook server

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.NotebookApi;

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");

    NotebookApi apiInstance = new NotebookApi(defaultClient);
    String namespace = "namespace_example"; // String | namespace notebook is in (an organization name or user's username)
    try {
      NotebookStatus result = apiInstance.getNotebookServerStatus(namespace);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling NotebookApi#getNotebookServerStatus");
      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
namespace	String	namespace notebook is in (an organization name or user's username)

Return type

NotebookStatus

Authorization

BasicAuth, ApiKeyAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	status of running notebook	-
402	Payment required	-
404	Notebook is not running	-
502	Bad Gateway	-
0	error response	-

handleCopyNotebook

NotebookCopied handleCopyNotebook(namespace, array, notebookCopy, X_TILEDB_CLOUD_ACCESS_CREDENTIALS_NAME, endTimestamp)

Copy a tiledb notebook 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.NotebookApi;

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");

    NotebookApi apiInstance = new NotebookApi(defaultClient);
    String namespace = "namespace_example"; // String | The namespace of the notebook
    String array = "array_example"; // String | The name of the notebook
    NotebookCopy notebookCopy = new NotebookCopy(); // NotebookCopy | Input/Output information to create a new TileDB file
    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, copy will use open_at functionality to copy notebook created at the specific timestamp
    try {
      NotebookCopied result = apiInstance.handleCopyNotebook(namespace, array, notebookCopy, X_TILEDB_CLOUD_ACCESS_CREDENTIALS_NAME, endTimestamp);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling NotebookApi#handleCopyNotebook");
      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
namespace	String	The namespace of the notebook
array	String	The name of the notebook
notebookCopy	NotebookCopy	Input/Output information to create a new TileDB file
X_TILEDB_CLOUD_ACCESS_CREDENTIALS_NAME	String	Optional registered access credentials to use for creation	[optional]
endTimestamp	Integer	Milliseconds since Unix epoch, copy will use open_at functionality to copy notebook created at the specific timestamp	[optional]

Return type

NotebookCopied

Authorization

BasicAuth, ApiKeyAuth

HTTP request headers

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

HTTP response details

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

handleUploadNotebook

FileUploaded handleUploadNotebook(namespace, inputFile, X_TILEDB_CLOUD_ACCESS_CREDENTIALS_NAME, outputUri, name)

Upload a notebook 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.NotebookApi;

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");

    NotebookApi apiInstance = new NotebookApi(defaultClient);
    String namespace = "namespace_example"; // String | The namespace of the notebook
    File inputFile = new File("/path/to/file"); // File | the notebook to upload
    String X_TILEDB_CLOUD_ACCESS_CREDENTIALS_NAME = "X_TILEDB_CLOUD_ACCESS_CREDENTIALS_NAME_example"; // String | Optional registered access credentials to use for creation
    String outputUri = "outputUri_example"; // String | output location of the TileDB File
    String name = "name_example"; // String | name to set for registered file
    try {
      FileUploaded result = apiInstance.handleUploadNotebook(namespace, inputFile, X_TILEDB_CLOUD_ACCESS_CREDENTIALS_NAME, outputUri, name);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling NotebookApi#handleUploadNotebook");
      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
namespace	String	The namespace of the notebook
inputFile	File	the notebook to upload
X_TILEDB_CLOUD_ACCESS_CREDENTIALS_NAME	String	Optional registered access credentials to use for creation	[optional]
outputUri	String	output location of the TileDB File	[optional]
name	String	name to set for registered file	[optional]

Return type

FileUploaded

Authorization

BasicAuth, ApiKeyAuth

HTTP request headers

Content-Type: multipart/form-data
Accept: application/json

HTTP response details

Status code	Description	Response headers
201	File uploaded	-
502	Bad Gateway	-
0	error response	-

shutdownNotebookServer

shutdownNotebookServer(namespace)

Shutdown a notebook server

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.NotebookApi;

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");

    NotebookApi apiInstance = new NotebookApi(defaultClient);
    String namespace = "namespace_example"; // String | namespace notebook is in (an organization name or user's username)
    try {
      apiInstance.shutdownNotebookServer(namespace);
    } catch (ApiException e) {
      System.err.println("Exception when calling NotebookApi#shutdownNotebookServer");
      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
namespace	String	namespace notebook is in (an organization name or user's username)

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	Notebook shutdown successfully	-
404	Notebook is not running	-
502	Bad Gateway	-
0	error response	-

updateNotebookName

updateNotebookName(namespace, array, notebookMetadata)

update name on a notebok, moving related S3 object to new 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.NotebookApi;

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");

    NotebookApi apiInstance = new NotebookApi(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 notebook (array) that is url-encoded
    ArrayInfoUpdate notebookMetadata = new ArrayInfoUpdate(); // ArrayInfoUpdate | notebook (array) metadata to update
    try {
      apiInstance.updateNotebookName(namespace, array, notebookMetadata);
    } catch (ApiException e) {
      System.err.println("Exception when calling NotebookApi#updateNotebookName");
      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
namespace	String	namespace array is in (an organization name or user's username)
array	String	name/uri of notebook (array) that is url-encoded
notebookMetadata	ArrayInfoUpdate	notebook (array) metadata 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	notebook name updated successfully	-
502	Bad Gateway	-
0	error response	-

Files

NotebookApi.md

Latest commit

History

NotebookApi.md

File metadata and controls

NotebookApi

getNotebookServerStatus

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

handleCopyNotebook

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

handleUploadNotebook

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

shutdownNotebookServer

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

updateNotebookName

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details