Class NotebookClient
java.lang.Object
com.azure.analytics.synapse.artifacts.NotebookClient
Initializes a new instance of the synchronous ArtifactsClient type.
-
Method Summary
Modifier and TypeMethodDescriptioncreateOrUpdateNotebook
(String notebookName, NotebookResource notebook) Creates or updates a Note Book.createOrUpdateNotebook
(String notebookName, NotebookResource notebook, String ifMatch) Creates or updates a Note Book.createOrUpdateNotebookWithResponse
(String notebookName, NotebookResource notebook, String ifMatch, Context context) Creates or updates a Note Book.void
deleteNotebook
(String notebookName) Deletes a Note book.deleteNotebookWithResponse
(String notebookName, Context context) Deletes a Note book.getNotebook
(String notebookName) Gets a Note Book.getNotebook
(String notebookName, String ifNoneMatch) Gets a Note Book.Lists Notebooks.getNotebooksByWorkspace
(Context context) Lists Notebooks.Lists a summary of Notebooks.getNotebookSummaryByWorkSpace
(Context context) Lists a summary of Notebooks.getNotebookWithResponse
(String notebookName, String ifNoneMatch, Context context) Gets a Note Book.void
renameNotebook
(String notebookName, ArtifactRenameRequest request) Renames a notebook.renameNotebookWithResponse
(String notebookName, ArtifactRenameRequest request, Context context) Renames a notebook.
-
Method Details
-
getNotebooksByWorkspace
Lists Notebooks.- Returns:
- a list of Notebook resources as paginated response with
PagedIterable
. - Throws:
CloudErrorException
- thrown if the request is rejected by server.RuntimeException
- all other wrapped checked exceptions if the request fails to be sent.
-
getNotebooksByWorkspace
Lists Notebooks.- Parameters:
context
- The context to associate with this operation.- Returns:
- a list of Notebook resources as paginated response with
PagedIterable
. - Throws:
IllegalArgumentException
- thrown if parameters fail the validation.CloudErrorException
- thrown if the request is rejected by server.RuntimeException
- all other wrapped checked exceptions if the request fails to be sent.
-
getNotebookSummaryByWorkSpace
Lists a summary of Notebooks.- Returns:
- a list of Notebook resources as paginated response with
PagedIterable
. - Throws:
CloudErrorException
- thrown if the request is rejected by server.RuntimeException
- all other wrapped checked exceptions if the request fails to be sent.
-
getNotebookSummaryByWorkSpace
Lists a summary of Notebooks.- Parameters:
context
- The context to associate with this operation.- Returns:
- a list of Notebook resources as paginated response with
PagedIterable
. - Throws:
IllegalArgumentException
- thrown if parameters fail the validation.CloudErrorException
- thrown if the request is rejected by server.RuntimeException
- all other wrapped checked exceptions if the request fails to be sent.
-
createOrUpdateNotebook
public NotebookResource createOrUpdateNotebook(String notebookName, NotebookResource notebook, String ifMatch) Creates or updates a Note Book.- Parameters:
notebookName
- The notebook name.notebook
- Note book resource definition.ifMatch
- ETag of the Note book entity. Should only be specified for update, for which it should match existing entity or can be * for unconditional update.- Returns:
- notebook resource type.
- Throws:
IllegalArgumentException
- thrown if parameters fail the validation.CloudErrorException
- thrown if the request is rejected by server.RuntimeException
- all other wrapped checked exceptions if the request fails to be sent.
-
createOrUpdateNotebook
Creates or updates a Note Book.- Parameters:
notebookName
- The notebook name.notebook
- Note book resource definition.- Returns:
- notebook resource type.
- Throws:
IllegalArgumentException
- thrown if parameters fail the validation.CloudErrorException
- thrown if the request is rejected by server.RuntimeException
- all other wrapped checked exceptions if the request fails to be sent.
-
createOrUpdateNotebookWithResponse
public Response<NotebookResource> createOrUpdateNotebookWithResponse(String notebookName, NotebookResource notebook, String ifMatch, Context context) Creates or updates a Note Book.- Parameters:
notebookName
- The notebook name.notebook
- Note book resource definition.ifMatch
- ETag of the Note book entity. Should only be specified for update, for which it should match existing entity or can be * for unconditional update.context
- The context to associate with this operation.- Returns:
- notebook resource type along with
Response
. - Throws:
IllegalArgumentException
- thrown if parameters fail the validation.CloudErrorException
- thrown if the request is rejected by server.RuntimeException
- all other wrapped checked exceptions if the request fails to be sent.
-
getNotebook
Gets a Note Book.- Parameters:
notebookName
- The notebook name.ifNoneMatch
- ETag of the Notebook entity. Should only be specified for get. If the ETag matches the existing entity tag, or if * was provided, then no content will be returned.- Returns:
- a Note Book.
- Throws:
IllegalArgumentException
- thrown if parameters fail the validation.CloudErrorException
- thrown if the request is rejected by server.RuntimeException
- all other wrapped checked exceptions if the request fails to be sent.
-
getNotebook
Gets a Note Book.- Parameters:
notebookName
- The notebook name.- Returns:
- a Note Book.
- Throws:
IllegalArgumentException
- thrown if parameters fail the validation.CloudErrorException
- thrown if the request is rejected by server.RuntimeException
- all other wrapped checked exceptions if the request fails to be sent.
-
getNotebookWithResponse
public Response<NotebookResource> getNotebookWithResponse(String notebookName, String ifNoneMatch, Context context) Gets a Note Book.- Parameters:
notebookName
- The notebook name.ifNoneMatch
- ETag of the Notebook entity. Should only be specified for get. If the ETag matches the existing entity tag, or if * was provided, then no content will be returned.context
- The context to associate with this operation.- Returns:
- a Note Book along with
Response
. - Throws:
IllegalArgumentException
- thrown if parameters fail the validation.CloudErrorException
- thrown if the request is rejected by server.RuntimeException
- all other wrapped checked exceptions if the request fails to be sent.
-
deleteNotebook
Deletes a Note book.- Parameters:
notebookName
- The notebook name.- Throws:
IllegalArgumentException
- thrown if parameters fail the validation.CloudErrorException
- thrown if the request is rejected by server.RuntimeException
- all other wrapped checked exceptions if the request fails to be sent.
-
deleteNotebookWithResponse
Deletes a Note book.- Parameters:
notebookName
- The notebook name.context
- The context to associate with this operation.- Returns:
- the
Response
. - Throws:
IllegalArgumentException
- thrown if parameters fail the validation.CloudErrorException
- thrown if the request is rejected by server.RuntimeException
- all other wrapped checked exceptions if the request fails to be sent.
-
renameNotebook
Renames a notebook.- Parameters:
notebookName
- The notebook name.request
- proposed new name.- Throws:
IllegalArgumentException
- thrown if parameters fail the validation.CloudErrorException
- thrown if the request is rejected by server.RuntimeException
- all other wrapped checked exceptions if the request fails to be sent.
-
renameNotebookWithResponse
public Response<Void> renameNotebookWithResponse(String notebookName, ArtifactRenameRequest request, Context context) Renames a notebook.- Parameters:
notebookName
- The notebook name.request
- proposed new name.context
- The context to associate with this operation.- Returns:
- the
Response
. - Throws:
IllegalArgumentException
- thrown if parameters fail the validation.CloudErrorException
- thrown if the request is rejected by server.RuntimeException
- all other wrapped checked exceptions if the request fails to be sent.
-