-
Notifications
You must be signed in to change notification settings - Fork 221
/
com.azure.analytics.synapse.artifacts.NotebookAsyncClient.yml
216 lines (216 loc) · 20 KB
/
com.azure.analytics.synapse.artifacts.NotebookAsyncClient.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
### YamlMime:JavaType
uid: "com.azure.analytics.synapse.artifacts.NotebookAsyncClient"
fullName: "com.azure.analytics.synapse.artifacts.NotebookAsyncClient"
name: "NotebookAsyncClient"
nameWithType: "NotebookAsyncClient"
summary: "Initializes a new instance of the asynchronous Artifacts<wbr>Client type."
inheritances:
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
inheritedClassMethods:
- classRef: "java.lang.<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
methodsRef:
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--\">clone</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals-java.lang.Object-\">equals</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--\">finalize</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--\">getClass</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode--\">hashCode</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--\">notify</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--\">notifyAll</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--\">toString</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--\">wait</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-\">wait</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-\">wait</a>"
syntax: "public final class **NotebookAsyncClient**"
methods:
- uid: "com.azure.analytics.synapse.artifacts.NotebookAsyncClient.createOrUpdateNotebook(java.lang.String,com.azure.analytics.synapse.artifacts.models.NotebookResource)"
fullName: "com.azure.analytics.synapse.artifacts.NotebookAsyncClient.createOrUpdateNotebook(String notebookName, NotebookResource notebook)"
name: "createOrUpdateNotebook(String notebookName, NotebookResource notebook)"
nameWithType: "NotebookAsyncClient.createOrUpdateNotebook(String notebookName, NotebookResource notebook)"
summary: "Creates or updates a Note Book."
parameters:
- description: "The notebook name."
name: "notebookName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "Note book resource definition."
name: "notebook"
type: "<xref href=\"com.azure.analytics.synapse.artifacts.models.NotebookResource?alt=com.azure.analytics.synapse.artifacts.models.NotebookResource&text=NotebookResource\" data-throw-if-not-resolved=\"False\" />"
syntax: "public Mono<NotebookResource> createOrUpdateNotebook(String notebookName, NotebookResource notebook)"
desc: "Creates or updates a Note Book."
returns:
description: "notebook resource type on successful completion of <xref uid=\"reactor.core.publisher.Mono\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Mono\"></xref>."
type: "<a href=\"https://projectreactor.io/docs/core/release/api/reactor/core/publisher/Mono.html\">Mono</a><<xref href=\"com.azure.analytics.synapse.artifacts.models.NotebookResource?alt=com.azure.analytics.synapse.artifacts.models.NotebookResource&text=NotebookResource\" data-throw-if-not-resolved=\"False\" />>"
- uid: "com.azure.analytics.synapse.artifacts.NotebookAsyncClient.createOrUpdateNotebook(java.lang.String,com.azure.analytics.synapse.artifacts.models.NotebookResource,java.lang.String)"
fullName: "com.azure.analytics.synapse.artifacts.NotebookAsyncClient.createOrUpdateNotebook(String notebookName, NotebookResource notebook, String ifMatch)"
name: "createOrUpdateNotebook(String notebookName, NotebookResource notebook, String ifMatch)"
nameWithType: "NotebookAsyncClient.createOrUpdateNotebook(String notebookName, NotebookResource notebook, String ifMatch)"
summary: "Creates or updates a Note Book."
parameters:
- description: "The notebook name."
name: "notebookName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "Note book resource definition."
name: "notebook"
type: "<xref href=\"com.azure.analytics.synapse.artifacts.models.NotebookResource?alt=com.azure.analytics.synapse.artifacts.models.NotebookResource&text=NotebookResource\" data-throw-if-not-resolved=\"False\" />"
- description: "ETag of the Note book entity. Should only be specified for update, for which it should match\n existing entity or can be * for unconditional update."
name: "ifMatch"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public Mono<NotebookResource> createOrUpdateNotebook(String notebookName, NotebookResource notebook, String ifMatch)"
desc: "Creates or updates a Note Book."
returns:
description: "notebook resource type on successful completion of <xref uid=\"reactor.core.publisher.Mono\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Mono\"></xref>."
type: "<a href=\"https://projectreactor.io/docs/core/release/api/reactor/core/publisher/Mono.html\">Mono</a><<xref href=\"com.azure.analytics.synapse.artifacts.models.NotebookResource?alt=com.azure.analytics.synapse.artifacts.models.NotebookResource&text=NotebookResource\" data-throw-if-not-resolved=\"False\" />>"
- uid: "com.azure.analytics.synapse.artifacts.NotebookAsyncClient.createOrUpdateNotebookWithResponse(java.lang.String,com.azure.analytics.synapse.artifacts.models.NotebookResource,java.lang.String)"
fullName: "com.azure.analytics.synapse.artifacts.NotebookAsyncClient.createOrUpdateNotebookWithResponse(String notebookName, NotebookResource notebook, String ifMatch)"
name: "createOrUpdateNotebookWithResponse(String notebookName, NotebookResource notebook, String ifMatch)"
nameWithType: "NotebookAsyncClient.createOrUpdateNotebookWithResponse(String notebookName, NotebookResource notebook, String ifMatch)"
summary: "Creates or updates a Note Book."
parameters:
- description: "The notebook name."
name: "notebookName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "Note book resource definition."
name: "notebook"
type: "<xref href=\"com.azure.analytics.synapse.artifacts.models.NotebookResource?alt=com.azure.analytics.synapse.artifacts.models.NotebookResource&text=NotebookResource\" data-throw-if-not-resolved=\"False\" />"
- description: "ETag of the Note book entity. Should only be specified for update, for which it should match\n existing entity or can be * for unconditional update."
name: "ifMatch"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public Mono<Response<NotebookResource>> createOrUpdateNotebookWithResponse(String notebookName, NotebookResource notebook, String ifMatch)"
desc: "Creates or updates a Note Book."
returns:
description: "notebook resource type along with <xref uid=\"com.azure.core.http.rest.Response\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Response\"></xref> on successful completion of <xref uid=\"reactor.core.publisher.Mono\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Mono\"></xref>."
type: "<a href=\"https://projectreactor.io/docs/core/release/api/reactor/core/publisher/Mono.html\">Mono</a><<xref href=\"com.azure.core.http.rest.Response?alt=com.azure.core.http.rest.Response&text=Response\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.analytics.synapse.artifacts.models.NotebookResource?alt=com.azure.analytics.synapse.artifacts.models.NotebookResource&text=NotebookResource\" data-throw-if-not-resolved=\"False\" />>>"
- uid: "com.azure.analytics.synapse.artifacts.NotebookAsyncClient.deleteNotebook(java.lang.String)"
fullName: "com.azure.analytics.synapse.artifacts.NotebookAsyncClient.deleteNotebook(String notebookName)"
name: "deleteNotebook(String notebookName)"
nameWithType: "NotebookAsyncClient.deleteNotebook(String notebookName)"
summary: "Deletes a Note book."
parameters:
- description: "The notebook name."
name: "notebookName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public Mono<Void> deleteNotebook(String notebookName)"
desc: "Deletes a Note book."
returns:
description: "A <xref uid=\"reactor.core.publisher.Mono\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Mono\"></xref> that completes when a successful response is received."
type: "<a href=\"https://projectreactor.io/docs/core/release/api/reactor/core/publisher/Mono.html\">Mono</a><<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Void.html\">Void</a>>"
- uid: "com.azure.analytics.synapse.artifacts.NotebookAsyncClient.deleteNotebookWithResponse(java.lang.String)"
fullName: "com.azure.analytics.synapse.artifacts.NotebookAsyncClient.deleteNotebookWithResponse(String notebookName)"
name: "deleteNotebookWithResponse(String notebookName)"
nameWithType: "NotebookAsyncClient.deleteNotebookWithResponse(String notebookName)"
summary: "Deletes a Note book."
parameters:
- description: "The notebook name."
name: "notebookName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public Mono<Response<Void>> deleteNotebookWithResponse(String notebookName)"
desc: "Deletes a Note book."
returns:
description: "the <xref uid=\"com.azure.core.http.rest.Response\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Response\"></xref> on successful completion of <xref uid=\"reactor.core.publisher.Mono\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Mono\"></xref>."
type: "<a href=\"https://projectreactor.io/docs/core/release/api/reactor/core/publisher/Mono.html\">Mono</a><<xref href=\"com.azure.core.http.rest.Response?alt=com.azure.core.http.rest.Response&text=Response\" data-throw-if-not-resolved=\"False\" /><<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Void.html\">Void</a>>>"
- uid: "com.azure.analytics.synapse.artifacts.NotebookAsyncClient.getNotebook(java.lang.String)"
fullName: "com.azure.analytics.synapse.artifacts.NotebookAsyncClient.getNotebook(String notebookName)"
name: "getNotebook(String notebookName)"
nameWithType: "NotebookAsyncClient.getNotebook(String notebookName)"
summary: "Gets a Note Book."
parameters:
- description: "The notebook name."
name: "notebookName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public Mono<NotebookResource> getNotebook(String notebookName)"
desc: "Gets a Note Book."
returns:
description: "a Note Book on successful completion of <xref uid=\"reactor.core.publisher.Mono\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Mono\"></xref>."
type: "<a href=\"https://projectreactor.io/docs/core/release/api/reactor/core/publisher/Mono.html\">Mono</a><<xref href=\"com.azure.analytics.synapse.artifacts.models.NotebookResource?alt=com.azure.analytics.synapse.artifacts.models.NotebookResource&text=NotebookResource\" data-throw-if-not-resolved=\"False\" />>"
- uid: "com.azure.analytics.synapse.artifacts.NotebookAsyncClient.getNotebook(java.lang.String,java.lang.String)"
fullName: "com.azure.analytics.synapse.artifacts.NotebookAsyncClient.getNotebook(String notebookName, String ifNoneMatch)"
name: "getNotebook(String notebookName, String ifNoneMatch)"
nameWithType: "NotebookAsyncClient.getNotebook(String notebookName, String ifNoneMatch)"
summary: "Gets a Note Book."
parameters:
- description: "The notebook name."
name: "notebookName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "ETag of the Notebook entity. Should only be specified for get. If the ETag matches the\n existing entity tag, or if * was provided, then no content will be returned."
name: "ifNoneMatch"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public Mono<NotebookResource> getNotebook(String notebookName, String ifNoneMatch)"
desc: "Gets a Note Book."
returns:
description: "a Note Book on successful completion of <xref uid=\"reactor.core.publisher.Mono\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Mono\"></xref>."
type: "<a href=\"https://projectreactor.io/docs/core/release/api/reactor/core/publisher/Mono.html\">Mono</a><<xref href=\"com.azure.analytics.synapse.artifacts.models.NotebookResource?alt=com.azure.analytics.synapse.artifacts.models.NotebookResource&text=NotebookResource\" data-throw-if-not-resolved=\"False\" />>"
- uid: "com.azure.analytics.synapse.artifacts.NotebookAsyncClient.getNotebookSummaryByWorkSpace()"
fullName: "com.azure.analytics.synapse.artifacts.NotebookAsyncClient.getNotebookSummaryByWorkSpace()"
name: "getNotebookSummaryByWorkSpace()"
nameWithType: "NotebookAsyncClient.getNotebookSummaryByWorkSpace()"
summary: "Lists a summary of Notebooks."
syntax: "public PagedFlux<NotebookResource> getNotebookSummaryByWorkSpace()"
desc: "Lists a summary of Notebooks."
returns:
description: "a list of Notebook resources as paginated response with <xref uid=\"com.azure.core.http.rest.PagedFlux\" data-throw-if-not-resolved=\"false\" data-raw-source=\"PagedFlux\"></xref>."
type: "<xref href=\"com.azure.core.http.rest.PagedFlux?alt=com.azure.core.http.rest.PagedFlux&text=PagedFlux\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.analytics.synapse.artifacts.models.NotebookResource?alt=com.azure.analytics.synapse.artifacts.models.NotebookResource&text=NotebookResource\" data-throw-if-not-resolved=\"False\" />>"
- uid: "com.azure.analytics.synapse.artifacts.NotebookAsyncClient.getNotebookWithResponse(java.lang.String,java.lang.String)"
fullName: "com.azure.analytics.synapse.artifacts.NotebookAsyncClient.getNotebookWithResponse(String notebookName, String ifNoneMatch)"
name: "getNotebookWithResponse(String notebookName, String ifNoneMatch)"
nameWithType: "NotebookAsyncClient.getNotebookWithResponse(String notebookName, String ifNoneMatch)"
summary: "Gets a Note Book."
parameters:
- description: "The notebook name."
name: "notebookName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "ETag of the Notebook entity. Should only be specified for get. If the ETag matches the\n existing entity tag, or if * was provided, then no content will be returned."
name: "ifNoneMatch"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public Mono<Response<NotebookResource>> getNotebookWithResponse(String notebookName, String ifNoneMatch)"
desc: "Gets a Note Book."
returns:
description: "a Note Book along with <xref uid=\"com.azure.core.http.rest.Response\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Response\"></xref> on successful completion of <xref uid=\"reactor.core.publisher.Mono\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Mono\"></xref>."
type: "<a href=\"https://projectreactor.io/docs/core/release/api/reactor/core/publisher/Mono.html\">Mono</a><<xref href=\"com.azure.core.http.rest.Response?alt=com.azure.core.http.rest.Response&text=Response\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.analytics.synapse.artifacts.models.NotebookResource?alt=com.azure.analytics.synapse.artifacts.models.NotebookResource&text=NotebookResource\" data-throw-if-not-resolved=\"False\" />>>"
- uid: "com.azure.analytics.synapse.artifacts.NotebookAsyncClient.getNotebooksByWorkspace()"
fullName: "com.azure.analytics.synapse.artifacts.NotebookAsyncClient.getNotebooksByWorkspace()"
name: "getNotebooksByWorkspace()"
nameWithType: "NotebookAsyncClient.getNotebooksByWorkspace()"
summary: "Lists Notebooks."
syntax: "public PagedFlux<NotebookResource> getNotebooksByWorkspace()"
desc: "Lists Notebooks."
returns:
description: "a list of Notebook resources as paginated response with <xref uid=\"com.azure.core.http.rest.PagedFlux\" data-throw-if-not-resolved=\"false\" data-raw-source=\"PagedFlux\"></xref>."
type: "<xref href=\"com.azure.core.http.rest.PagedFlux?alt=com.azure.core.http.rest.PagedFlux&text=PagedFlux\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.analytics.synapse.artifacts.models.NotebookResource?alt=com.azure.analytics.synapse.artifacts.models.NotebookResource&text=NotebookResource\" data-throw-if-not-resolved=\"False\" />>"
- uid: "com.azure.analytics.synapse.artifacts.NotebookAsyncClient.renameNotebook(java.lang.String,com.azure.analytics.synapse.artifacts.models.ArtifactRenameRequest)"
fullName: "com.azure.analytics.synapse.artifacts.NotebookAsyncClient.renameNotebook(String notebookName, ArtifactRenameRequest request)"
name: "renameNotebook(String notebookName, ArtifactRenameRequest request)"
nameWithType: "NotebookAsyncClient.renameNotebook(String notebookName, ArtifactRenameRequest request)"
summary: "Renames a notebook."
parameters:
- description: "The notebook name."
name: "notebookName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "proposed new name."
name: "request"
type: "<xref href=\"com.azure.analytics.synapse.artifacts.models.ArtifactRenameRequest?alt=com.azure.analytics.synapse.artifacts.models.ArtifactRenameRequest&text=ArtifactRenameRequest\" data-throw-if-not-resolved=\"False\" />"
syntax: "public Mono<Void> renameNotebook(String notebookName, ArtifactRenameRequest request)"
desc: "Renames a notebook."
returns:
description: "A <xref uid=\"reactor.core.publisher.Mono\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Mono\"></xref> that completes when a successful response is received."
type: "<a href=\"https://projectreactor.io/docs/core/release/api/reactor/core/publisher/Mono.html\">Mono</a><<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Void.html\">Void</a>>"
- uid: "com.azure.analytics.synapse.artifacts.NotebookAsyncClient.renameNotebookWithResponse(java.lang.String,com.azure.analytics.synapse.artifacts.models.ArtifactRenameRequest)"
fullName: "com.azure.analytics.synapse.artifacts.NotebookAsyncClient.renameNotebookWithResponse(String notebookName, ArtifactRenameRequest request)"
name: "renameNotebookWithResponse(String notebookName, ArtifactRenameRequest request)"
nameWithType: "NotebookAsyncClient.renameNotebookWithResponse(String notebookName, ArtifactRenameRequest request)"
summary: "Renames a notebook."
parameters:
- description: "The notebook name."
name: "notebookName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "proposed new name."
name: "request"
type: "<xref href=\"com.azure.analytics.synapse.artifacts.models.ArtifactRenameRequest?alt=com.azure.analytics.synapse.artifacts.models.ArtifactRenameRequest&text=ArtifactRenameRequest\" data-throw-if-not-resolved=\"False\" />"
syntax: "public Mono<Response<Void>> renameNotebookWithResponse(String notebookName, ArtifactRenameRequest request)"
desc: "Renames a notebook."
returns:
description: "the <xref uid=\"com.azure.core.http.rest.Response\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Response\"></xref> on successful completion of <xref uid=\"reactor.core.publisher.Mono\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Mono\"></xref>."
type: "<a href=\"https://projectreactor.io/docs/core/release/api/reactor/core/publisher/Mono.html\">Mono</a><<xref href=\"com.azure.core.http.rest.Response?alt=com.azure.core.http.rest.Response&text=Response\" data-throw-if-not-resolved=\"False\" /><<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Void.html\">Void</a>>>"
type: "class"
desc: "Initializes a new instance of the asynchronous ArtifactsClient type."
metadata: {}
package: "com.azure.analytics.synapse.artifacts"
artifact: com.azure:azure-analytics-synapse-artifacts:1.0.0-beta.14