com.qubole.qds.sdk.java.api

Interface NotebookAPI

All Known Implementing Classes:

NotebookApiImpl

public interface NotebookAPI

Corresponds to http://docs.qubole.com/en/latest/rest-api/notebook_api/index.html

Method Summary

Modifier and Type	Method and Description
InvokableBuilder<NotebookResult>	bindNotebookToCluster(String clusterId, String notebookId) Corresponds to http://docs.qubole.com/en/latest/rest-api/notebook_api/bind-notebook.html
InvokableBuilder<NotebookResult>	clone(String name, String location, String clusterId, String clonedFromNotebook) Corresponds to http://docs.qubole.com/en/latest/rest-api/notebook_api/clone-notebook.html
InvokableBuilder<NotebookResult>	configure(String name, String location, String clusterId, String notebookId) Corresponds to http://docs.qubole.com/en/latest/rest-api/notebook_api/configure-notebook.html
InvokableBuilder<NotebookResult>	create(String name, String location, String noteType, String clusterId) Corresponds to http://docs.qubole.com/en/latest/rest-api/notebook_api/create-notebook.html
InvokableBuilder<NotebookResult>	delete(String notebookId) Corresponds to http://docs.qubole.com/en/latest/rest-api/notebook_api/delete-notebook.html

Method Detail

create

InvokableBuilder<NotebookResult> create(String name,
                                        String location,
                                        String noteType,
                                        String clusterId)

Corresponds to http://docs.qubole.com/en/latest/rest-api/notebook_api/create-notebook.html

Parameters:

name - name of the notebook

location - location of the notebook

noteType - type of the notebook, available are "spark" and "presto"

clusterId - cluster id of the cluster to associate notebook with

Returns:

new builder

configure

InvokableBuilder<NotebookResult> configure(String name,
                                           String location,
                                           String clusterId,
                                           String notebookId)

Corresponds to http://docs.qubole.com/en/latest/rest-api/notebook_api/configure-notebook.html

Parameters:

name - name of the notebook

location - location of the notebook

clusterId - cluster id of the cluster to associate notebook with

notebookId - notebook id to configure

Returns:

new builder

clone

InvokableBuilder<NotebookResult> clone(String name,
                                       String location,
                                       String clusterId,
                                       String clonedFromNotebook)

Corresponds to http://docs.qubole.com/en/latest/rest-api/notebook_api/clone-notebook.html

Parameters:

name - name of the notebook

location - location of the notebook

clusterId - cluster id of the cluster to associate notebook with

clonedFromNotebook - notebook id from which the new notebook is cloned

Returns:

new builder

bindNotebookToCluster

InvokableBuilder<NotebookResult> bindNotebookToCluster(String clusterId,
                                                       String notebookId)

Corresponds to http://docs.qubole.com/en/latest/rest-api/notebook_api/bind-notebook.html

Parameters:

clusterId - cluster id of the cluster who needs to be associated with notebook

notebookId - notebook id

Returns:

new builder

delete

InvokableBuilder<NotebookResult> delete(String notebookId)

Corresponds to http://docs.qubole.com/en/latest/rest-api/notebook_api/delete-notebook.html

Parameters:

notebookId - notebook id

Returns:

new builder