-
Notifications
You must be signed in to change notification settings - Fork 254
/
com.azure.analytics.synapse.artifacts.SqlScriptAsyncClient.yml
206 lines (206 loc) · 19.3 KB
/
com.azure.analytics.synapse.artifacts.SqlScriptAsyncClient.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
### YamlMime:JavaType
uid: "com.azure.analytics.synapse.artifacts.SqlScriptAsyncClient"
fullName: "com.azure.analytics.synapse.artifacts.SqlScriptAsyncClient"
name: "SqlScriptAsyncClient"
nameWithType: "SqlScriptAsyncClient"
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 **SqlScriptAsyncClient**"
methods:
- uid: "com.azure.analytics.synapse.artifacts.SqlScriptAsyncClient.createOrUpdateSqlScript(java.lang.String,com.azure.analytics.synapse.artifacts.models.SqlScriptResource)"
fullName: "com.azure.analytics.synapse.artifacts.SqlScriptAsyncClient.createOrUpdateSqlScript(String sqlScriptName, SqlScriptResource sqlScript)"
name: "createOrUpdateSqlScript(String sqlScriptName, SqlScriptResource sqlScript)"
nameWithType: "SqlScriptAsyncClient.createOrUpdateSqlScript(String sqlScriptName, SqlScriptResource sqlScript)"
summary: "Creates or updates a Sql Script."
parameters:
- description: "The sql script name."
name: "sqlScriptName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "Sql Script resource definition."
name: "sqlScript"
type: "<xref href=\"com.azure.analytics.synapse.artifacts.models.SqlScriptResource?alt=com.azure.analytics.synapse.artifacts.models.SqlScriptResource&text=SqlScriptResource\" data-throw-if-not-resolved=\"False\" />"
syntax: "public Mono<SqlScriptResource> createOrUpdateSqlScript(String sqlScriptName, SqlScriptResource sqlScript)"
desc: "Creates or updates a Sql Script."
returns:
description: "sql Script 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.SqlScriptResource?alt=com.azure.analytics.synapse.artifacts.models.SqlScriptResource&text=SqlScriptResource\" data-throw-if-not-resolved=\"False\" />>"
- uid: "com.azure.analytics.synapse.artifacts.SqlScriptAsyncClient.createOrUpdateSqlScript(java.lang.String,com.azure.analytics.synapse.artifacts.models.SqlScriptResource,java.lang.String)"
fullName: "com.azure.analytics.synapse.artifacts.SqlScriptAsyncClient.createOrUpdateSqlScript(String sqlScriptName, SqlScriptResource sqlScript, String ifMatch)"
name: "createOrUpdateSqlScript(String sqlScriptName, SqlScriptResource sqlScript, String ifMatch)"
nameWithType: "SqlScriptAsyncClient.createOrUpdateSqlScript(String sqlScriptName, SqlScriptResource sqlScript, String ifMatch)"
summary: "Creates or updates a Sql Script."
parameters:
- description: "The sql script name."
name: "sqlScriptName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "Sql Script resource definition."
name: "sqlScript"
type: "<xref href=\"com.azure.analytics.synapse.artifacts.models.SqlScriptResource?alt=com.azure.analytics.synapse.artifacts.models.SqlScriptResource&text=SqlScriptResource\" data-throw-if-not-resolved=\"False\" />"
- description: "ETag of the SQL script 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<SqlScriptResource> createOrUpdateSqlScript(String sqlScriptName, SqlScriptResource sqlScript, String ifMatch)"
desc: "Creates or updates a Sql Script."
returns:
description: "sql Script 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.SqlScriptResource?alt=com.azure.analytics.synapse.artifacts.models.SqlScriptResource&text=SqlScriptResource\" data-throw-if-not-resolved=\"False\" />>"
- uid: "com.azure.analytics.synapse.artifacts.SqlScriptAsyncClient.createOrUpdateSqlScriptWithResponse(java.lang.String,com.azure.analytics.synapse.artifacts.models.SqlScriptResource,java.lang.String)"
fullName: "com.azure.analytics.synapse.artifacts.SqlScriptAsyncClient.createOrUpdateSqlScriptWithResponse(String sqlScriptName, SqlScriptResource sqlScript, String ifMatch)"
name: "createOrUpdateSqlScriptWithResponse(String sqlScriptName, SqlScriptResource sqlScript, String ifMatch)"
nameWithType: "SqlScriptAsyncClient.createOrUpdateSqlScriptWithResponse(String sqlScriptName, SqlScriptResource sqlScript, String ifMatch)"
summary: "Creates or updates a Sql Script."
parameters:
- description: "The sql script name."
name: "sqlScriptName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "Sql Script resource definition."
name: "sqlScript"
type: "<xref href=\"com.azure.analytics.synapse.artifacts.models.SqlScriptResource?alt=com.azure.analytics.synapse.artifacts.models.SqlScriptResource&text=SqlScriptResource\" data-throw-if-not-resolved=\"False\" />"
- description: "ETag of the SQL script 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<SqlScriptResource>> createOrUpdateSqlScriptWithResponse(String sqlScriptName, SqlScriptResource sqlScript, String ifMatch)"
desc: "Creates or updates a Sql Script."
returns:
description: "sql Script 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.SqlScriptResource?alt=com.azure.analytics.synapse.artifacts.models.SqlScriptResource&text=SqlScriptResource\" data-throw-if-not-resolved=\"False\" />>>"
- uid: "com.azure.analytics.synapse.artifacts.SqlScriptAsyncClient.deleteSqlScript(java.lang.String)"
fullName: "com.azure.analytics.synapse.artifacts.SqlScriptAsyncClient.deleteSqlScript(String sqlScriptName)"
name: "deleteSqlScript(String sqlScriptName)"
nameWithType: "SqlScriptAsyncClient.deleteSqlScript(String sqlScriptName)"
summary: "Deletes a Sql Script."
parameters:
- description: "The sql script name."
name: "sqlScriptName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public Mono<Void> deleteSqlScript(String sqlScriptName)"
desc: "Deletes a Sql Script."
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.SqlScriptAsyncClient.deleteSqlScriptWithResponse(java.lang.String)"
fullName: "com.azure.analytics.synapse.artifacts.SqlScriptAsyncClient.deleteSqlScriptWithResponse(String sqlScriptName)"
name: "deleteSqlScriptWithResponse(String sqlScriptName)"
nameWithType: "SqlScriptAsyncClient.deleteSqlScriptWithResponse(String sqlScriptName)"
summary: "Deletes a Sql Script."
parameters:
- description: "The sql script name."
name: "sqlScriptName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public Mono<Response<Void>> deleteSqlScriptWithResponse(String sqlScriptName)"
desc: "Deletes a Sql Script."
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.SqlScriptAsyncClient.getSqlScript(java.lang.String)"
fullName: "com.azure.analytics.synapse.artifacts.SqlScriptAsyncClient.getSqlScript(String sqlScriptName)"
name: "getSqlScript(String sqlScriptName)"
nameWithType: "SqlScriptAsyncClient.getSqlScript(String sqlScriptName)"
summary: "Gets a sql script."
parameters:
- description: "The sql script name."
name: "sqlScriptName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public Mono<SqlScriptResource> getSqlScript(String sqlScriptName)"
desc: "Gets a sql script."
returns:
description: "a sql script 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.SqlScriptResource?alt=com.azure.analytics.synapse.artifacts.models.SqlScriptResource&text=SqlScriptResource\" data-throw-if-not-resolved=\"False\" />>"
- uid: "com.azure.analytics.synapse.artifacts.SqlScriptAsyncClient.getSqlScript(java.lang.String,java.lang.String)"
fullName: "com.azure.analytics.synapse.artifacts.SqlScriptAsyncClient.getSqlScript(String sqlScriptName, String ifNoneMatch)"
name: "getSqlScript(String sqlScriptName, String ifNoneMatch)"
nameWithType: "SqlScriptAsyncClient.getSqlScript(String sqlScriptName, String ifNoneMatch)"
summary: "Gets a sql script."
parameters:
- description: "The sql script name."
name: "sqlScriptName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "ETag of the sql compute 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<SqlScriptResource> getSqlScript(String sqlScriptName, String ifNoneMatch)"
desc: "Gets a sql script."
returns:
description: "a sql script 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.SqlScriptResource?alt=com.azure.analytics.synapse.artifacts.models.SqlScriptResource&text=SqlScriptResource\" data-throw-if-not-resolved=\"False\" />>"
- uid: "com.azure.analytics.synapse.artifacts.SqlScriptAsyncClient.getSqlScriptWithResponse(java.lang.String,java.lang.String)"
fullName: "com.azure.analytics.synapse.artifacts.SqlScriptAsyncClient.getSqlScriptWithResponse(String sqlScriptName, String ifNoneMatch)"
name: "getSqlScriptWithResponse(String sqlScriptName, String ifNoneMatch)"
nameWithType: "SqlScriptAsyncClient.getSqlScriptWithResponse(String sqlScriptName, String ifNoneMatch)"
summary: "Gets a sql script."
parameters:
- description: "The sql script name."
name: "sqlScriptName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "ETag of the sql compute 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<SqlScriptResource>> getSqlScriptWithResponse(String sqlScriptName, String ifNoneMatch)"
desc: "Gets a sql script."
returns:
description: "a sql script 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.SqlScriptResource?alt=com.azure.analytics.synapse.artifacts.models.SqlScriptResource&text=SqlScriptResource\" data-throw-if-not-resolved=\"False\" />>>"
- uid: "com.azure.analytics.synapse.artifacts.SqlScriptAsyncClient.getSqlScriptsByWorkspace()"
fullName: "com.azure.analytics.synapse.artifacts.SqlScriptAsyncClient.getSqlScriptsByWorkspace()"
name: "getSqlScriptsByWorkspace()"
nameWithType: "SqlScriptAsyncClient.getSqlScriptsByWorkspace()"
summary: "Lists sql scripts."
syntax: "public PagedFlux<SqlScriptResource> getSqlScriptsByWorkspace()"
desc: "Lists sql scripts."
returns:
description: "a list of sql scripts 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.SqlScriptResource?alt=com.azure.analytics.synapse.artifacts.models.SqlScriptResource&text=SqlScriptResource\" data-throw-if-not-resolved=\"False\" />>"
- uid: "com.azure.analytics.synapse.artifacts.SqlScriptAsyncClient.renameSqlScript(java.lang.String,com.azure.analytics.synapse.artifacts.models.ArtifactRenameRequest)"
fullName: "com.azure.analytics.synapse.artifacts.SqlScriptAsyncClient.renameSqlScript(String sqlScriptName, ArtifactRenameRequest request)"
name: "renameSqlScript(String sqlScriptName, ArtifactRenameRequest request)"
nameWithType: "SqlScriptAsyncClient.renameSqlScript(String sqlScriptName, ArtifactRenameRequest request)"
summary: "Renames a sql<wbr>Script."
parameters:
- description: "The sql script name."
name: "sqlScriptName"
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> renameSqlScript(String sqlScriptName, ArtifactRenameRequest request)"
desc: "Renames a sqlScript."
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.SqlScriptAsyncClient.renameSqlScriptWithResponse(java.lang.String,com.azure.analytics.synapse.artifacts.models.ArtifactRenameRequest)"
fullName: "com.azure.analytics.synapse.artifacts.SqlScriptAsyncClient.renameSqlScriptWithResponse(String sqlScriptName, ArtifactRenameRequest request)"
name: "renameSqlScriptWithResponse(String sqlScriptName, ArtifactRenameRequest request)"
nameWithType: "SqlScriptAsyncClient.renameSqlScriptWithResponse(String sqlScriptName, ArtifactRenameRequest request)"
summary: "Renames a sql<wbr>Script."
parameters:
- description: "The sql script name."
name: "sqlScriptName"
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>> renameSqlScriptWithResponse(String sqlScriptName, ArtifactRenameRequest request)"
desc: "Renames a sqlScript."
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.15