org.apache.zeppelin.rest

Class NotebookRestApi

java.lang.Object

org.apache.zeppelin.rest.NotebookRestApi

public class NotebookRestApi
extends Object

Rest api endpoint for the noteBook.

Constructor Summary

Constructors

Constructor and Description
NotebookRestApi()
NotebookRestApi(Notebook notebook, NotebookServer notebookServer, SearchService search)

Method Summary

Methods

Modifier and Type	Method and Description
javax.ws.rs.core.Response	bind(String noteId) list binded setting
javax.ws.rs.core.Response	bind(String noteId, String req) bind a setting to note
javax.ws.rs.core.Response	cloneNote(String notebookId, String message) Clone note REST API
javax.ws.rs.core.Response	createNote(String message) Create new note REST API
javax.ws.rs.core.Response	deleteNote(String notebookId) Delete note REST API
javax.ws.rs.core.Response	deleteParagraph(String notebookId, String paragraphId) Delete paragraph REST API
javax.ws.rs.core.Response	exportNoteBook(String noteId) export note REST API
javax.ws.rs.core.Response	getCronJob(String notebookId) Get cron job REST API
javax.ws.rs.core.Response	getJobListforNotebook() Get notebook jobs for job manager
javax.ws.rs.core.Response	getNotebook(String notebookId)
javax.ws.rs.core.Response	getNotebookList()
javax.ws.rs.core.Response	getNoteJobStatus(String notebookId) Get notebook job status REST API
javax.ws.rs.core.Response	getNotePermissions(String noteId) get note authorization information
javax.ws.rs.core.Response	getParagraph(String notebookId, String paragraphId) Get paragraph REST API
javax.ws.rs.core.Response	getUpdatedJobListforNotebook(long lastUpdateUnixTime) Get updated notebook jobs for job manager
javax.ws.rs.core.Response	importNotebook(String req) import new note REST API
javax.ws.rs.core.Response	insertParagraph(String notebookId, String message) Insert paragraph REST API
javax.ws.rs.core.Response	moveParagraph(String notebookId, String paragraphId, String newIndex) Move paragraph REST API
javax.ws.rs.core.Response	putNotePermissions(String noteId, String req) set note authorization information
javax.ws.rs.core.Response	registerCronJob(String notebookId, String message) Register cron job REST API
javax.ws.rs.core.Response	removeCronJob(String notebookId) Remove cron job REST API
javax.ws.rs.core.Response	runNoteJobs(String notebookId) Run notebook jobs REST API
javax.ws.rs.core.Response	runParagraph(String notebookId, String paragraphId, String message) Run paragraph job REST API
javax.ws.rs.core.Response	search(String queryTerm) Search for a Notes with permissions
javax.ws.rs.core.Response	stopNoteJobs(String notebookId) Stop(delete) notebook jobs REST API
javax.ws.rs.core.Response	stopParagraph(String notebookId, String paragraphId) Stop(delete) paragraph job REST API

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

NotebookRestApi

public NotebookRestApi()

NotebookRestApi

public NotebookRestApi(Notebook notebook,
               NotebookServer notebookServer,
               SearchService search)

Method Detail

getNotePermissions

public javax.ws.rs.core.Response getNotePermissions(String noteId)

get note authorization information

putNotePermissions

public javax.ws.rs.core.Response putNotePermissions(String noteId,
                                           String req)
                                             throws IOException

set note authorization information

Throws:

IOException

bind

public javax.ws.rs.core.Response bind(String noteId,
                             String req)
                               throws IOException

bind a setting to note

Throws:

IOException

bind

public javax.ws.rs.core.Response bind(String noteId)

list binded setting

getNotebookList

public javax.ws.rs.core.Response getNotebookList()
                                          throws IOException

Throws:

IOException

getNotebook

public javax.ws.rs.core.Response getNotebook(String notebookId)
                                      throws IOException

Throws:

IOException

exportNoteBook

public javax.ws.rs.core.Response exportNoteBook(String noteId)
                                         throws IOException

export note REST API

Parameters:

-

Returns:

note JSON with status.OK

Throws:

IOException

importNotebook

public javax.ws.rs.core.Response importNotebook(String req)
                                         throws IOException

import new note REST API

Parameters:

req - - notebook Json

Returns:

JSON with new note ID

Throws:

IOException

createNote

public javax.ws.rs.core.Response createNote(String message)
                                     throws IOException

Create new note REST API

Parameters:

message - - JSON with new note name

Returns:

JSON with new note ID

Throws:

IOException

deleteNote

public javax.ws.rs.core.Response deleteNote(String notebookId)
                                     throws IOException

Delete note REST API

Parameters:

-

Returns:

JSON with status.OK

Throws:

IOException

cloneNote

public javax.ws.rs.core.Response cloneNote(String notebookId,
                                  String message)
                                    throws IOException,
                                           CloneNotSupportedException,
                                           IllegalArgumentException

Clone note REST API

Parameters:

-

Returns:

JSON with status.CREATED

Throws:

IOException, - CloneNotSupportedException, IllegalArgumentException

IOException

CloneNotSupportedException

IllegalArgumentException

insertParagraph

public javax.ws.rs.core.Response insertParagraph(String notebookId,
                                        String message)
                                          throws IOException

Insert paragraph REST API

Parameters:

message - - JSON containing paragraph's information

Returns:

JSON with status.OK

Throws:

IOException

getParagraph

public javax.ws.rs.core.Response getParagraph(String notebookId,
                                     String paragraphId)
                                       throws IOException

Get paragraph REST API

Parameters:

-

Returns:

JSON with information of the paragraph

Throws:

IOException

moveParagraph

public javax.ws.rs.core.Response moveParagraph(String notebookId,
                                      String paragraphId,
                                      String newIndex)
                                        throws IOException

Move paragraph REST API

Parameters:

newIndex - - new index to move

Returns:

JSON with status.OK

Throws:

IOException

deleteParagraph

public javax.ws.rs.core.Response deleteParagraph(String notebookId,
                                        String paragraphId)
                                          throws IOException

Delete paragraph REST API

Parameters:

-

Returns:

JSON with status.OK

Throws:

IOException

runNoteJobs

public javax.ws.rs.core.Response runNoteJobs(String notebookId)
                                      throws IOException,
                                             IllegalArgumentException

Run notebook jobs REST API

Parameters:

-

Returns:

JSON with status.OK

Throws:

IOException, - IllegalArgumentException

IOException

IllegalArgumentException

stopNoteJobs

public javax.ws.rs.core.Response stopNoteJobs(String notebookId)
                                       throws IOException,
                                              IllegalArgumentException

Stop(delete) notebook jobs REST API

Parameters:

-

Returns:

JSON with status.OK

Throws:

IOException, - IllegalArgumentException

IOException

IllegalArgumentException

getNoteJobStatus

public javax.ws.rs.core.Response getNoteJobStatus(String notebookId)
                                           throws IOException,
                                                  IllegalArgumentException

Get notebook job status REST API

Parameters:

-

Returns:

JSON with status.OK

Throws:

IOException, - IllegalArgumentException

IOException

IllegalArgumentException

runParagraph

public javax.ws.rs.core.Response runParagraph(String notebookId,
                                     String paragraphId,
                                     String message)
                                       throws IOException,
                                              IllegalArgumentException

Run paragraph job REST API

Parameters:

message - - JSON with params if user wants to update dynamic form's value null, empty string, empty json if user doesn't want to update

Returns:

JSON with status.OK

Throws:

IOException, - IllegalArgumentException

IOException

IllegalArgumentException

stopParagraph

public javax.ws.rs.core.Response stopParagraph(String notebookId,
                                      String paragraphId)
                                        throws IOException,
                                               IllegalArgumentException

Stop(delete) paragraph job REST API

Parameters:

-

Returns:

JSON with status.OK

Throws:

IOException, - IllegalArgumentException

IOException

IllegalArgumentException

registerCronJob

public javax.ws.rs.core.Response registerCronJob(String notebookId,
                                        String message)
                                          throws IOException,
                                                 IllegalArgumentException

Register cron job REST API

Parameters:

message - - JSON with cron expressions.

Returns:

JSON with status.OK

Throws:

IOException, - IllegalArgumentException

IOException

IllegalArgumentException

removeCronJob

public javax.ws.rs.core.Response removeCronJob(String notebookId)
                                        throws IOException,
                                               IllegalArgumentException

Remove cron job REST API

Parameters:

-

Returns:

JSON with status.OK

Throws:

IOException, - IllegalArgumentException

IOException

IllegalArgumentException

getCronJob

public javax.ws.rs.core.Response getCronJob(String notebookId)
                                     throws IOException,
                                            IllegalArgumentException

Get cron job REST API

Parameters:

-

Returns:

JSON with status.OK

Throws:

IOException, - IllegalArgumentException

IOException

IllegalArgumentException

getJobListforNotebook

public javax.ws.rs.core.Response getJobListforNotebook()
                                                throws IOException,
                                                       IllegalArgumentException

Get notebook jobs for job manager

Parameters:

-

Returns:

JSON with status.OK

Throws:

IOException, - IllegalArgumentException

IOException

IllegalArgumentException

getUpdatedJobListforNotebook

public javax.ws.rs.core.Response getUpdatedJobListforNotebook(long lastUpdateUnixTime)
                                                       throws IOException,
                                                              IllegalArgumentException

Get updated notebook jobs for job manager

Parameters:

-

Returns:

JSON with status.OK

Throws:

IOException, - IllegalArgumentException

IOException

IllegalArgumentException

search

public javax.ws.rs.core.Response search(String queryTerm)

Search for a Notes with permissions