NotebookAsyncClient Class

Package:

com.azure.analytics.synapse.artifacts

Maven Artifact:

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

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

public final class NotebookAsyncClient

Initializes a new instance of the asynchronous ArtifactsClient type.

Method Summary

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

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Method Details

createOrUpdateNotebook

public Mono 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 on successful completion of Mono.

createOrUpdateNotebook

public Mono 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 on successful completion of Mono.

createOrUpdateNotebookWithResponse

public Mono<>> createOrUpdateNotebookWithResponse(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 along with Response<T> on successful completion of Mono.

deleteNotebook

public Mono deleteNotebook(String notebookName)

Deletes a Note book.

Parameters:

notebookName - The notebook name.

Returns:

A Mono that completes when a successful response is received.

deleteNotebookWithResponse

public Mono<>> deleteNotebookWithResponse(String notebookName)

Deletes a Note book.

Parameters:

notebookName - The notebook name.

Returns:

the Response<T> on successful completion of Mono.

getNotebook

public Mono getNotebook(String notebookName)

Gets a Note Book.

Parameters:

notebookName - The notebook name.

Returns:

a Note Book on successful completion of Mono.

getNotebook

public Mono 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 on successful completion of Mono.

getNotebookSummaryByWorkSpace

public PagedFlux getNotebookSummaryByWorkSpace()

Lists a summary of Notebooks.

Returns:

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

getNotebookWithResponse

public Mono<>> getNotebookWithResponse(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 along with Response<T> on successful completion of Mono.

getNotebooksByWorkspace

public PagedFlux getNotebooksByWorkspace()

Lists Notebooks.

Returns:

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

renameNotebook

public Mono renameNotebook(String notebookName, ArtifactRenameRequest request)

Renames a notebook.

Parameters:

notebookName - The notebook name.

request - proposed new name.

Returns:

A Mono that completes when a successful response is received.

renameNotebookWithResponse

public Mono<>> renameNotebookWithResponse(String notebookName, ArtifactRenameRequest request)

Renames a notebook.

Parameters:

notebookName - The notebook name.

request - proposed new name.

Returns:

the Response<T> on successful completion of Mono.