Package io.tiledb.cloud.rest_api.api

Class NotebookApi

  • public class NotebookApi
extends java.lang.Object

    • Constructor Detail

      • NotebookApi

        public NotebookApi()

      • NotebookApi

        public NotebookApi​(ApiClient apiClient)

    • Method Detail

      • getApiClient

        public ApiClient getApiClient()

      • setApiClient

        public void setApiClient​(ApiClient apiClient)

      • getHostIndex

        public int getHostIndex()

      • setHostIndex

        public void setHostIndex​(int hostIndex)

      • getCustomBaseUrl

        public java.lang.String getCustomBaseUrl()

      • setCustomBaseUrl

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

      • getNotebookServerStatusCall

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

      • getNotebookServerStatus

        public NotebookStatus getNotebookServerStatus​(java.lang.String namespace)
                                       throws ApiException
        Get status of the notebook server
        Parameters:
        namespace - namespace notebook is in (an organization name or user's username) (required)
        Returns:
        NotebookStatus
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • getNotebookServerStatusWithHttpInfo

        public ApiResponse<NotebookStatus> getNotebookServerStatusWithHttpInfo​(java.lang.String namespace)
                                                                throws ApiException
        Get status of the notebook server
        Parameters:
        namespace - namespace notebook is in (an organization name or user's username) (required)
        Returns:
        ApiResponse<NotebookStatus>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • getNotebookServerStatusAsync

        public okhttp3.Call getNotebookServerStatusAsync​(java.lang.String namespace,
                                                 ApiCallback<NotebookStatus> _callback)
                                          throws ApiException
        (asynchronously) Get status of the notebook server
        Parameters:
        namespace - namespace notebook is in (an organization name or user's username) (required)
        _callback - The callback to be executed when the API call finishes
        Returns:
        The request call
        Throws:
        ApiException - If fail to process the API call, e.g. serializing the request body object

      • handleCopyNotebookCall

        public okhttp3.Call handleCopyNotebookCall​(java.lang.String namespace,
                                           java.lang.String array,
                                           NotebookCopy notebookCopy,
                                           java.lang.String X_TILEDB_CLOUD_ACCESS_CREDENTIALS_NAME,
                                           java.lang.Integer endTimestamp,
                                           ApiCallback _callback)
                                    throws ApiException
        Build call for handleCopyNotebook
        Parameters:
        namespace - The namespace of the notebook (required)
        array - The name of the notebook (required)
        notebookCopy - Input/Output information to create a new TileDB file (required)
        X_TILEDB_CLOUD_ACCESS_CREDENTIALS_NAME - Optional registered access credentials to use for creation (optional)
        endTimestamp - Milliseconds since Unix epoch, copy will use open_at functionality to copy notebook created at the specific timestamp (optional)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object

      • handleCopyNotebook

        public NotebookCopied handleCopyNotebook​(java.lang.String namespace,
                                         java.lang.String array,
                                         NotebookCopy notebookCopy,
                                         java.lang.String X_TILEDB_CLOUD_ACCESS_CREDENTIALS_NAME,
                                         java.lang.Integer endTimestamp)
                                  throws ApiException
        Copy a tiledb notebook at the specified location
        Parameters:
        namespace - The namespace of the notebook (required)
        array - The name of the notebook (required)
        notebookCopy - Input/Output information to create a new TileDB file (required)
        X_TILEDB_CLOUD_ACCESS_CREDENTIALS_NAME - Optional registered access credentials to use for creation (optional)
        endTimestamp - Milliseconds since Unix epoch, copy will use open_at functionality to copy notebook created at the specific timestamp (optional)
        Returns:
        NotebookCopied
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • handleCopyNotebookWithHttpInfo

        public ApiResponse<NotebookCopied> handleCopyNotebookWithHttpInfo​(java.lang.String namespace,
                                                                  java.lang.String array,
                                                                  NotebookCopy notebookCopy,
                                                                  java.lang.String X_TILEDB_CLOUD_ACCESS_CREDENTIALS_NAME,
                                                                  java.lang.Integer endTimestamp)
                                                           throws ApiException
        Copy a tiledb notebook at the specified location
        Parameters:
        namespace - The namespace of the notebook (required)
        array - The name of the notebook (required)
        notebookCopy - Input/Output information to create a new TileDB file (required)
        X_TILEDB_CLOUD_ACCESS_CREDENTIALS_NAME - Optional registered access credentials to use for creation (optional)
        endTimestamp - Milliseconds since Unix epoch, copy will use open_at functionality to copy notebook created at the specific timestamp (optional)
        Returns:
        ApiResponse<NotebookCopied>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • handleCopyNotebookAsync

        public okhttp3.Call handleCopyNotebookAsync​(java.lang.String namespace,
                                            java.lang.String array,
                                            NotebookCopy notebookCopy,
                                            java.lang.String X_TILEDB_CLOUD_ACCESS_CREDENTIALS_NAME,
                                            java.lang.Integer endTimestamp,
                                            ApiCallback<NotebookCopied> _callback)
                                     throws ApiException
        (asynchronously) Copy a tiledb notebook at the specified location
        Parameters:
        namespace - The namespace of the notebook (required)
        array - The name of the notebook (required)
        notebookCopy - Input/Output information to create a new TileDB file (required)
        X_TILEDB_CLOUD_ACCESS_CREDENTIALS_NAME - Optional registered access credentials to use for creation (optional)
        endTimestamp - Milliseconds since Unix epoch, copy will use open_at functionality to copy notebook created at the specific timestamp (optional)
        _callback - The callback to be executed when the API call finishes
        Returns:
        The request call
        Throws:
        ApiException - If fail to process the API call, e.g. serializing the request body object

      • handleUploadNotebookCall

        public okhttp3.Call handleUploadNotebookCall​(java.lang.String namespace,
                                             java.io.File inputFile,
                                             java.lang.String X_TILEDB_CLOUD_ACCESS_CREDENTIALS_NAME,
                                             java.lang.String outputUri,
                                             java.lang.String name,
                                             ApiCallback _callback)
                                      throws ApiException
        Build call for handleUploadNotebook
        Parameters:
        namespace - The namespace of the notebook (required)
        inputFile - the notebook to upload (required)
        X_TILEDB_CLOUD_ACCESS_CREDENTIALS_NAME - Optional registered access credentials to use for creation (optional)
        outputUri - output location of the TileDB File (optional)
        name - name to set for registered file (optional)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object

      • handleUploadNotebook

        public FileUploaded handleUploadNotebook​(java.lang.String namespace,
                                         java.io.File inputFile,
                                         java.lang.String X_TILEDB_CLOUD_ACCESS_CREDENTIALS_NAME,
                                         java.lang.String outputUri,
                                         java.lang.String name)
                                  throws ApiException
        Upload a notebook at the specified location
        Parameters:
        namespace - The namespace of the notebook (required)
        inputFile - the notebook to upload (required)
        X_TILEDB_CLOUD_ACCESS_CREDENTIALS_NAME - Optional registered access credentials to use for creation (optional)
        outputUri - output location of the TileDB File (optional)
        name - name to set for registered file (optional)
        Returns:
        FileUploaded
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • handleUploadNotebookWithHttpInfo

        public ApiResponse<FileUploaded> handleUploadNotebookWithHttpInfo​(java.lang.String namespace,
                                                                  java.io.File inputFile,
                                                                  java.lang.String X_TILEDB_CLOUD_ACCESS_CREDENTIALS_NAME,
                                                                  java.lang.String outputUri,
                                                                  java.lang.String name)
                                                           throws ApiException
        Upload a notebook at the specified location
        Parameters:
        namespace - The namespace of the notebook (required)
        inputFile - the notebook to upload (required)
        X_TILEDB_CLOUD_ACCESS_CREDENTIALS_NAME - Optional registered access credentials to use for creation (optional)
        outputUri - output location of the TileDB File (optional)
        name - name to set for registered file (optional)
        Returns:
        ApiResponse<FileUploaded>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • handleUploadNotebookAsync

        public okhttp3.Call handleUploadNotebookAsync​(java.lang.String namespace,
                                              java.io.File inputFile,
                                              java.lang.String X_TILEDB_CLOUD_ACCESS_CREDENTIALS_NAME,
                                              java.lang.String outputUri,
                                              java.lang.String name,
                                              ApiCallback<FileUploaded> _callback)
                                       throws ApiException
        (asynchronously) Upload a notebook at the specified location
        Parameters:
        namespace - The namespace of the notebook (required)
        inputFile - the notebook to upload (required)
        X_TILEDB_CLOUD_ACCESS_CREDENTIALS_NAME - Optional registered access credentials to use for creation (optional)
        outputUri - output location of the TileDB File (optional)
        name - name to set for registered file (optional)
        _callback - The callback to be executed when the API call finishes
        Returns:
        The request call
        Throws:
        ApiException - If fail to process the API call, e.g. serializing the request body object

      • shutdownNotebookServerCall

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

      • shutdownNotebookServer

        public void shutdownNotebookServer​(java.lang.String namespace)
                            throws ApiException
        Shutdown a notebook server
        Parameters:
        namespace - namespace notebook is in (an organization name or user's username) (required)
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • shutdownNotebookServerWithHttpInfo

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

      • shutdownNotebookServerAsync

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

      • updateNotebookNameCall

        public okhttp3.Call updateNotebookNameCall​(java.lang.String namespace,
                                           java.lang.String array,
                                           ArrayInfoUpdate notebookMetadata,
                                           ApiCallback _callback)
                                    throws ApiException
        Build call for updateNotebookName
        Parameters:
        namespace - namespace array is in (an organization name or user's username) (required)
        array - name/uri of notebook (array) that is url-encoded (required)
        notebookMetadata - notebook (array) metadata to update (required)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object

      • updateNotebookName

        public void updateNotebookName​(java.lang.String namespace,
                               java.lang.String array,
                               ArrayInfoUpdate notebookMetadata)
                        throws ApiException
        update name on a notebok, moving related S3 object to new location
        Parameters:
        namespace - namespace array is in (an organization name or user's username) (required)
        array - name/uri of notebook (array) that is url-encoded (required)
        notebookMetadata - notebook (array) metadata to update (required)
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • updateNotebookNameWithHttpInfo

        public ApiResponse<java.lang.Void> updateNotebookNameWithHttpInfo​(java.lang.String namespace,
                                                                  java.lang.String array,
                                                                  ArrayInfoUpdate notebookMetadata)
                                                           throws ApiException
        update name on a notebok, moving related S3 object to new location
        Parameters:
        namespace - namespace array is in (an organization name or user's username) (required)
        array - name/uri of notebook (array) that is url-encoded (required)
        notebookMetadata - notebook (array) metadata to update (required)
        Returns:
        ApiResponse<Void>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • updateNotebookNameAsync

        public okhttp3.Call updateNotebookNameAsync​(java.lang.String namespace,
                                            java.lang.String array,
                                            ArrayInfoUpdate notebookMetadata,
                                            ApiCallback<java.lang.Void> _callback)
                                     throws ApiException
        (asynchronously) update name on a notebok, moving related S3 object to new location
        Parameters:
        namespace - namespace array is in (an organization name or user's username) (required)
        array - name/uri of notebook (array) that is url-encoded (required)
        notebookMetadata - notebook (array) metadata to update (required)
        _callback - The callback to be executed when the API call finishes
        Returns:
        The request call
        Throws:
        ApiException - If fail to process the API call, e.g. serializing the request body object