NotebookClient Class

Package:

com.azure.analytics.synapse.artifacts

Maven Artifact:

com.azure:azure-analytics-synapse-artifacts:1.0.0-beta.17

• java.lang.Object
• • com.azure.analytics.synapse.artifacts.NotebookClient

public final class NotebookClient

Initializes a new instance of the synchronous ArtifactsClient type.

Method Summary

Modifier and Type	Method and Description
NotebookResource	createOrUpdateNotebook(String notebookName, NotebookResource notebook) Creates or updates a Note Book.
NotebookResource	createOrUpdateNotebook(String notebookName, NotebookResource notebook, String ifMatch) Creates or updates a Note Book.
Response<NotebookResource>	createOrUpdateNotebookWithResponse(String notebookName, NotebookResource notebook, String ifMatch, Context context) Creates or updates a Note Book.
void	deleteNotebook(String notebookName) Deletes a Note book.
Response<Void>	deleteNotebookWithResponse(String notebookName, Context context) Deletes a Note book.
NotebookResource	getNotebook(String notebookName) Gets a Note Book.
NotebookResource	getNotebook(String notebookName, String ifNoneMatch) Gets a Note Book.
PagedIterable<NotebookResource>	getNotebooksByWorkspace() Lists Notebooks.
PagedIterable<NotebookResource>	getNotebooksByWorkspace(Context context) Lists Notebooks.
PagedIterable<NotebookResource>	getNotebookSummaryByWorkSpace() Lists a summary of Notebooks.
PagedIterable<NotebookResource>	getNotebookSummaryByWorkSpace(Context context) Lists a summary of Notebooks.
Response<NotebookResource>	getNotebookWithResponse(String notebookName, String ifNoneMatch, Context context) Gets a Note Book.
void	renameNotebook(String notebookName, ArtifactRenameRequest request) Renames a notebook.
Response<Void>	renameNotebookWithResponse(String notebookName, ArtifactRenameRequest request, Context context) Renames a notebook.

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Method Details

createOrUpdateNotebook

public NotebookResource createOrUpdateNotebook(String notebookName, NotebookResource notebook)

Creates or updates a Note Book.

Parameters:

notebookName - The notebook name.

notebook - Note book resource definition.

Returns:

notebook resource type.

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.

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<T>.

deleteNotebook

public void deleteNotebook(String notebookName)

Deletes a Note book.

Parameters:

notebookName - The notebook name.

deleteNotebookWithResponse

public Response<Void> deleteNotebookWithResponse(String notebookName, Context context)

Deletes a Note book.

Parameters:

notebookName - The notebook name.

context - The context to associate with this operation.

Returns:

the Response<T>.

getNotebook

public NotebookResource getNotebook(String notebookName)

Gets a Note Book.

Parameters:

notebookName - The notebook name.

Returns:

a Note Book.

getNotebook

public NotebookResource getNotebook(String notebookName, String ifNoneMatch)

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.

getNotebooksByWorkspace

public PagedIterable<NotebookResource> getNotebooksByWorkspace()

Lists Notebooks.

Returns:

a list of Notebook resources as paginated response with PagedIterable<T>.

getNotebooksByWorkspace

public PagedIterable<NotebookResource> getNotebooksByWorkspace(Context context)

Lists Notebooks.

Parameters:

context - The context to associate with this operation.

Returns:

a list of Notebook resources as paginated response with PagedIterable<T>.

getNotebookSummaryByWorkSpace

public PagedIterable<NotebookResource> getNotebookSummaryByWorkSpace()

Lists a summary of Notebooks.

Returns:

a list of Notebook resources as paginated response with PagedIterable<T>.

getNotebookSummaryByWorkSpace

public PagedIterable<NotebookResource> getNotebookSummaryByWorkSpace(Context context)

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<T>.

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<T>.

renameNotebook

public void renameNotebook(String notebookName, ArtifactRenameRequest request)

Renames a notebook.

Parameters:

notebookName - The notebook name.

request - proposed new name.

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<T>.