Package com.azure.analytics.synapse.artifacts

Class NotebookAsyncClient

java.lang.Object

com.azure.analytics.synapse.artifacts.NotebookAsyncClient

public final class NotebookAsyncClient
extends Object

Initializes a new instance of the asynchronous ArtifactsClient type.

Method Summary

Modifier and Type	Method	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<com.azure.core.http.rest.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<com.azure.core.http.rest.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.
com.azure.core.http.rest.PagedFlux<NotebookResource>	getNotebooksByWorkspace()	Lists Notebooks.
com.azure.core.http.rest.PagedFlux<NotebookResource>	getNotebookSummaryByWorkSpace()	Lists a summary of Notebooks.
Mono<com.azure.core.http.rest.Response<NotebookResource>>	getNotebookWithResponse(String notebookName, String ifNoneMatch)	Gets a Note Book.
Mono<Void>	renameNotebook(String notebookName, ArtifactRenameRequest request)	Renames a notebook.
Mono<com.azure.core.http.rest.Response<Void>>	renameNotebookWithResponse(String notebookName, ArtifactRenameRequest request)	Renames a notebook.

Methods inherited from class java.lang.Object

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

Method Detail

getNotebooksByWorkspace

public com.azure.core.http.rest.PagedFlux<NotebookResource> getNotebooksByWorkspace()

Lists Notebooks.

Returns:

a list of Notebook resources as paginated response with PagedFlux.

Throws:

CloudErrorException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

getNotebookSummaryByWorkSpace

public com.azure.core.http.rest.PagedFlux<NotebookResource> getNotebookSummaryByWorkSpace()

Lists a summary of Notebooks.

Returns:

a list of Notebook resources as paginated response with PagedFlux.

Throws:

CloudErrorException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

createOrUpdateNotebookWithResponse

public Mono<com.azure.core.http.rest.Response<NotebookResource>> 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 on successful completion of Mono.

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

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

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 Mono<com.azure.core.http.rest.Response<NotebookResource>> 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 on successful completion of Mono.

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

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

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

public Mono<NotebookResource> getNotebook(String notebookName)

Gets a Note Book.

Parameters:

notebookName - The notebook name.

Returns:

a Note Book on successful completion of Mono.

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

public Mono<com.azure.core.http.rest.Response<Void>> deleteNotebookWithResponse(String notebookName)

Deletes a Note book.

Parameters:

notebookName - The notebook name.

Returns:

the Response on successful completion of Mono.

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

public Mono<Void> deleteNotebook(String notebookName)

Deletes a Note book.

Parameters:

notebookName - The notebook name.

Returns:

A Mono that completes when a successful response is received.

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 Mono<com.azure.core.http.rest.Response<Void>> renameNotebookWithResponse(String notebookName,
                                                                                ArtifactRenameRequest request)

Renames a notebook.

Parameters:

notebookName - The notebook name.

request - proposed new name.

Returns:

the Response on successful completion of Mono.

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

public Mono<Void> 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.

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.