/
com.azure.resourcemanager.streamanalytics.fluent.FunctionsClient.yml
413 lines (413 loc) · 39.3 KB
/
com.azure.resourcemanager.streamanalytics.fluent.FunctionsClient.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
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
### YamlMime:JavaType
uid: "com.azure.resourcemanager.streamanalytics.fluent.FunctionsClient"
fullName: "com.azure.resourcemanager.streamanalytics.fluent.FunctionsClient"
name: "FunctionsClient"
nameWithType: "FunctionsClient"
summary: "An instance of this class provides access to all the operations defined in Functions<wbr>Client."
syntax: "public interface **FunctionsClient**"
methods:
- uid: "com.azure.resourcemanager.streamanalytics.fluent.FunctionsClient.beginTest(java.lang.String,java.lang.String,java.lang.String)"
fullName: "com.azure.resourcemanager.streamanalytics.fluent.FunctionsClient.beginTest(String resourceGroupName, String jobName, String functionName)"
name: "beginTest(String resourceGroupName, String jobName, String functionName)"
nameWithType: "FunctionsClient.beginTest(String resourceGroupName, String jobName, String functionName)"
summary: "Tests if the information provided for a function is valid."
modifiers:
- "abstract"
parameters:
- description: "The name of the resource group. The name is case insensitive."
name: "resourceGroupName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "The name of the streaming job."
name: "jobName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "The name of the function."
name: "functionName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public abstract SyncPoller<PollResult<ResourceTestStatusInner>,ResourceTestStatusInner> beginTest(String resourceGroupName, String jobName, String functionName)"
desc: "Tests if the information provided for a function is valid. This can range from testing the connection to the underlying web service behind the function or making sure the function code provided is syntactically correct."
returns:
description: "the <xref uid=\"com.azure.core.util.polling.SyncPoller\" data-throw-if-not-resolved=\"false\" data-raw-source=\"SyncPoller\"></xref> for polling of describes the status of the test operation along with error\n information, if applicable."
type: "<xref href=\"com.azure.core.util.polling.SyncPoller?alt=com.azure.core.util.polling.SyncPoller&text=SyncPoller\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.core.management.polling.PollResult?alt=com.azure.core.management.polling.PollResult&text=PollResult\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.resourcemanager.streamanalytics.fluent.models.ResourceTestStatusInner?alt=com.azure.resourcemanager.streamanalytics.fluent.models.ResourceTestStatusInner&text=ResourceTestStatusInner\" data-throw-if-not-resolved=\"False\" />>,<xref href=\"com.azure.resourcemanager.streamanalytics.fluent.models.ResourceTestStatusInner?alt=com.azure.resourcemanager.streamanalytics.fluent.models.ResourceTestStatusInner&text=ResourceTestStatusInner\" data-throw-if-not-resolved=\"False\" />>"
- uid: "com.azure.resourcemanager.streamanalytics.fluent.FunctionsClient.beginTest(java.lang.String,java.lang.String,java.lang.String,com.azure.resourcemanager.streamanalytics.fluent.models.FunctionInner,com.azure.core.util.Context)"
fullName: "com.azure.resourcemanager.streamanalytics.fluent.FunctionsClient.beginTest(String resourceGroupName, String jobName, String functionName, FunctionInner function, Context context)"
name: "beginTest(String resourceGroupName, String jobName, String functionName, FunctionInner function, Context context)"
nameWithType: "FunctionsClient.beginTest(String resourceGroupName, String jobName, String functionName, FunctionInner function, Context context)"
summary: "Tests if the information provided for a function is valid."
modifiers:
- "abstract"
parameters:
- description: "The name of the resource group. The name is case insensitive."
name: "resourceGroupName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "The name of the streaming job."
name: "jobName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "The name of the function."
name: "functionName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "If the function specified does not already exist, this parameter must contain the full function\n definition intended to be tested. If the function specified already exists, this parameter can be left null to\n test the existing function as is or if specified, the properties specified will overwrite the corresponding\n properties in the existing function (exactly like a PATCH operation) and the resulting function will be tested."
name: "function"
type: "<xref href=\"com.azure.resourcemanager.streamanalytics.fluent.models.FunctionInner?alt=com.azure.resourcemanager.streamanalytics.fluent.models.FunctionInner&text=FunctionInner\" data-throw-if-not-resolved=\"False\" />"
- description: "The context to associate with this operation."
name: "context"
type: "<xref href=\"com.azure.core.util.Context?alt=com.azure.core.util.Context&text=Context\" data-throw-if-not-resolved=\"False\" />"
syntax: "public abstract SyncPoller<PollResult<ResourceTestStatusInner>,ResourceTestStatusInner> beginTest(String resourceGroupName, String jobName, String functionName, FunctionInner function, Context context)"
desc: "Tests if the information provided for a function is valid. This can range from testing the connection to the underlying web service behind the function or making sure the function code provided is syntactically correct."
returns:
description: "the <xref uid=\"com.azure.core.util.polling.SyncPoller\" data-throw-if-not-resolved=\"false\" data-raw-source=\"SyncPoller\"></xref> for polling of describes the status of the test operation along with error\n information, if applicable."
type: "<xref href=\"com.azure.core.util.polling.SyncPoller?alt=com.azure.core.util.polling.SyncPoller&text=SyncPoller\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.core.management.polling.PollResult?alt=com.azure.core.management.polling.PollResult&text=PollResult\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.resourcemanager.streamanalytics.fluent.models.ResourceTestStatusInner?alt=com.azure.resourcemanager.streamanalytics.fluent.models.ResourceTestStatusInner&text=ResourceTestStatusInner\" data-throw-if-not-resolved=\"False\" />>,<xref href=\"com.azure.resourcemanager.streamanalytics.fluent.models.ResourceTestStatusInner?alt=com.azure.resourcemanager.streamanalytics.fluent.models.ResourceTestStatusInner&text=ResourceTestStatusInner\" data-throw-if-not-resolved=\"False\" />>"
- uid: "com.azure.resourcemanager.streamanalytics.fluent.FunctionsClient.createOrReplace(java.lang.String,java.lang.String,java.lang.String,com.azure.resourcemanager.streamanalytics.fluent.models.FunctionInner)"
fullName: "com.azure.resourcemanager.streamanalytics.fluent.FunctionsClient.createOrReplace(String resourceGroupName, String jobName, String functionName, FunctionInner function)"
name: "createOrReplace(String resourceGroupName, String jobName, String functionName, FunctionInner function)"
nameWithType: "FunctionsClient.createOrReplace(String resourceGroupName, String jobName, String functionName, FunctionInner function)"
summary: "Creates a function or replaces an already existing function under an existing streaming job."
modifiers:
- "abstract"
parameters:
- description: "The name of the resource group. The name is case insensitive."
name: "resourceGroupName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "The name of the streaming job."
name: "jobName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "The name of the function."
name: "functionName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "The definition of the function that will be used to create a new function or replace the existing\n one under the streaming job."
name: "function"
type: "<xref href=\"com.azure.resourcemanager.streamanalytics.fluent.models.FunctionInner?alt=com.azure.resourcemanager.streamanalytics.fluent.models.FunctionInner&text=FunctionInner\" data-throw-if-not-resolved=\"False\" />"
syntax: "public abstract FunctionInner createOrReplace(String resourceGroupName, String jobName, String functionName, FunctionInner function)"
desc: "Creates a function or replaces an already existing function under an existing streaming job."
returns:
description: "a function object, containing all information associated with the named function."
type: "<xref href=\"com.azure.resourcemanager.streamanalytics.fluent.models.FunctionInner?alt=com.azure.resourcemanager.streamanalytics.fluent.models.FunctionInner&text=FunctionInner\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.streamanalytics.fluent.FunctionsClient.createOrReplaceWithResponse(java.lang.String,java.lang.String,java.lang.String,com.azure.resourcemanager.streamanalytics.fluent.models.FunctionInner,java.lang.String,java.lang.String,com.azure.core.util.Context)"
fullName: "com.azure.resourcemanager.streamanalytics.fluent.FunctionsClient.createOrReplaceWithResponse(String resourceGroupName, String jobName, String functionName, FunctionInner function, String ifMatch, String ifNoneMatch, Context context)"
name: "createOrReplaceWithResponse(String resourceGroupName, String jobName, String functionName, FunctionInner function, String ifMatch, String ifNoneMatch, Context context)"
nameWithType: "FunctionsClient.createOrReplaceWithResponse(String resourceGroupName, String jobName, String functionName, FunctionInner function, String ifMatch, String ifNoneMatch, Context context)"
summary: "Creates a function or replaces an already existing function under an existing streaming job."
modifiers:
- "abstract"
parameters:
- description: "The name of the resource group. The name is case insensitive."
name: "resourceGroupName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "The name of the streaming job."
name: "jobName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "The name of the function."
name: "functionName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "The definition of the function that will be used to create a new function or replace the existing\n one under the streaming job."
name: "function"
type: "<xref href=\"com.azure.resourcemanager.streamanalytics.fluent.models.FunctionInner?alt=com.azure.resourcemanager.streamanalytics.fluent.models.FunctionInner&text=FunctionInner\" data-throw-if-not-resolved=\"False\" />"
- description: "The ETag of the function. Omit this value to always overwrite the current function. Specify the\n last-seen ETag value to prevent accidentally overwriting concurrent changes."
name: "ifMatch"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "Set to '*' to allow a new function to be created, but to prevent updating an existing\n function. Other values will result in a 412 Pre-condition Failed response."
name: "ifNoneMatch"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "The context to associate with this operation."
name: "context"
type: "<xref href=\"com.azure.core.util.Context?alt=com.azure.core.util.Context&text=Context\" data-throw-if-not-resolved=\"False\" />"
syntax: "public abstract FunctionsCreateOrReplaceResponse createOrReplaceWithResponse(String resourceGroupName, String jobName, String functionName, FunctionInner function, String ifMatch, String ifNoneMatch, Context context)"
desc: "Creates a function or replaces an already existing function under an existing streaming job."
returns:
description: "a function object, containing all information associated with the named function."
type: "<xref href=\"com.azure.resourcemanager.streamanalytics.models.FunctionsCreateOrReplaceResponse?alt=com.azure.resourcemanager.streamanalytics.models.FunctionsCreateOrReplaceResponse&text=FunctionsCreateOrReplaceResponse\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.streamanalytics.fluent.FunctionsClient.delete(java.lang.String,java.lang.String,java.lang.String)"
fullName: "com.azure.resourcemanager.streamanalytics.fluent.FunctionsClient.delete(String resourceGroupName, String jobName, String functionName)"
name: "delete(String resourceGroupName, String jobName, String functionName)"
nameWithType: "FunctionsClient.delete(String resourceGroupName, String jobName, String functionName)"
summary: "Deletes a function from the streaming job."
modifiers:
- "abstract"
parameters:
- description: "The name of the resource group. The name is case insensitive."
name: "resourceGroupName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "The name of the streaming job."
name: "jobName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "The name of the function."
name: "functionName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public abstract void delete(String resourceGroupName, String jobName, String functionName)"
desc: "Deletes a function from the streaming job."
- uid: "com.azure.resourcemanager.streamanalytics.fluent.FunctionsClient.deleteWithResponse(java.lang.String,java.lang.String,java.lang.String,com.azure.core.util.Context)"
fullName: "com.azure.resourcemanager.streamanalytics.fluent.FunctionsClient.deleteWithResponse(String resourceGroupName, String jobName, String functionName, Context context)"
name: "deleteWithResponse(String resourceGroupName, String jobName, String functionName, Context context)"
nameWithType: "FunctionsClient.deleteWithResponse(String resourceGroupName, String jobName, String functionName, Context context)"
summary: "Deletes a function from the streaming job."
modifiers:
- "abstract"
parameters:
- description: "The name of the resource group. The name is case insensitive."
name: "resourceGroupName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "The name of the streaming job."
name: "jobName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "The name of the function."
name: "functionName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "The context to associate with this operation."
name: "context"
type: "<xref href=\"com.azure.core.util.Context?alt=com.azure.core.util.Context&text=Context\" data-throw-if-not-resolved=\"False\" />"
syntax: "public abstract Response<Void> deleteWithResponse(String resourceGroupName, String jobName, String functionName, Context context)"
desc: "Deletes a function from the streaming job."
returns:
description: "the <xref uid=\"com.azure.core.http.rest.Response\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Response\"></xref>."
type: "<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.resourcemanager.streamanalytics.fluent.FunctionsClient.get(java.lang.String,java.lang.String,java.lang.String)"
fullName: "com.azure.resourcemanager.streamanalytics.fluent.FunctionsClient.get(String resourceGroupName, String jobName, String functionName)"
name: "get(String resourceGroupName, String jobName, String functionName)"
nameWithType: "FunctionsClient.get(String resourceGroupName, String jobName, String functionName)"
summary: "Gets details about the specified function."
modifiers:
- "abstract"
parameters:
- description: "The name of the resource group. The name is case insensitive."
name: "resourceGroupName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "The name of the streaming job."
name: "jobName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "The name of the function."
name: "functionName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public abstract FunctionInner get(String resourceGroupName, String jobName, String functionName)"
desc: "Gets details about the specified function."
returns:
description: "details about the specified function."
type: "<xref href=\"com.azure.resourcemanager.streamanalytics.fluent.models.FunctionInner?alt=com.azure.resourcemanager.streamanalytics.fluent.models.FunctionInner&text=FunctionInner\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.streamanalytics.fluent.FunctionsClient.getWithResponse(java.lang.String,java.lang.String,java.lang.String,com.azure.core.util.Context)"
fullName: "com.azure.resourcemanager.streamanalytics.fluent.FunctionsClient.getWithResponse(String resourceGroupName, String jobName, String functionName, Context context)"
name: "getWithResponse(String resourceGroupName, String jobName, String functionName, Context context)"
nameWithType: "FunctionsClient.getWithResponse(String resourceGroupName, String jobName, String functionName, Context context)"
summary: "Gets details about the specified function."
modifiers:
- "abstract"
parameters:
- description: "The name of the resource group. The name is case insensitive."
name: "resourceGroupName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "The name of the streaming job."
name: "jobName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "The name of the function."
name: "functionName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "The context to associate with this operation."
name: "context"
type: "<xref href=\"com.azure.core.util.Context?alt=com.azure.core.util.Context&text=Context\" data-throw-if-not-resolved=\"False\" />"
syntax: "public abstract FunctionsGetResponse getWithResponse(String resourceGroupName, String jobName, String functionName, Context context)"
desc: "Gets details about the specified function."
returns:
description: "details about the specified function."
type: "<xref href=\"com.azure.resourcemanager.streamanalytics.models.FunctionsGetResponse?alt=com.azure.resourcemanager.streamanalytics.models.FunctionsGetResponse&text=FunctionsGetResponse\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.streamanalytics.fluent.FunctionsClient.listByStreamingJob(java.lang.String,java.lang.String)"
fullName: "com.azure.resourcemanager.streamanalytics.fluent.FunctionsClient.listByStreamingJob(String resourceGroupName, String jobName)"
name: "listByStreamingJob(String resourceGroupName, String jobName)"
nameWithType: "FunctionsClient.listByStreamingJob(String resourceGroupName, String jobName)"
summary: "Lists all of the functions under the specified streaming job."
modifiers:
- "abstract"
parameters:
- description: "The name of the resource group. The name is case insensitive."
name: "resourceGroupName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "The name of the streaming job."
name: "jobName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public abstract PagedIterable<FunctionInner> listByStreamingJob(String resourceGroupName, String jobName)"
desc: "Lists all of the functions under the specified streaming job."
returns:
description: "object containing a list of functions under a streaming job as paginated response with\n <xref uid=\"com.azure.core.http.rest.PagedIterable\" data-throw-if-not-resolved=\"false\" data-raw-source=\"PagedIterable\"></xref>."
type: "<xref href=\"com.azure.core.http.rest.PagedIterable?alt=com.azure.core.http.rest.PagedIterable&text=PagedIterable\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.resourcemanager.streamanalytics.fluent.models.FunctionInner?alt=com.azure.resourcemanager.streamanalytics.fluent.models.FunctionInner&text=FunctionInner\" data-throw-if-not-resolved=\"False\" />>"
- uid: "com.azure.resourcemanager.streamanalytics.fluent.FunctionsClient.listByStreamingJob(java.lang.String,java.lang.String,java.lang.String,com.azure.core.util.Context)"
fullName: "com.azure.resourcemanager.streamanalytics.fluent.FunctionsClient.listByStreamingJob(String resourceGroupName, String jobName, String select, Context context)"
name: "listByStreamingJob(String resourceGroupName, String jobName, String select, Context context)"
nameWithType: "FunctionsClient.listByStreamingJob(String resourceGroupName, String jobName, String select, Context context)"
summary: "Lists all of the functions under the specified streaming job."
modifiers:
- "abstract"
parameters:
- description: "The name of the resource group. The name is case insensitive."
name: "resourceGroupName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "The name of the streaming job."
name: "jobName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "The $select OData query parameter. This is a comma-separated list of structural properties to\n include in the response, or \"*\" to include all properties. By default, all properties are returned except\n diagnostics. Currently only accepts '*' as a valid value."
name: "select"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "The context to associate with this operation."
name: "context"
type: "<xref href=\"com.azure.core.util.Context?alt=com.azure.core.util.Context&text=Context\" data-throw-if-not-resolved=\"False\" />"
syntax: "public abstract PagedIterable<FunctionInner> listByStreamingJob(String resourceGroupName, String jobName, String select, Context context)"
desc: "Lists all of the functions under the specified streaming job."
returns:
description: "object containing a list of functions under a streaming job as paginated response with\n <xref uid=\"com.azure.core.http.rest.PagedIterable\" data-throw-if-not-resolved=\"false\" data-raw-source=\"PagedIterable\"></xref>."
type: "<xref href=\"com.azure.core.http.rest.PagedIterable?alt=com.azure.core.http.rest.PagedIterable&text=PagedIterable\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.resourcemanager.streamanalytics.fluent.models.FunctionInner?alt=com.azure.resourcemanager.streamanalytics.fluent.models.FunctionInner&text=FunctionInner\" data-throw-if-not-resolved=\"False\" />>"
- uid: "com.azure.resourcemanager.streamanalytics.fluent.FunctionsClient.retrieveDefaultDefinition(java.lang.String,java.lang.String,java.lang.String)"
fullName: "com.azure.resourcemanager.streamanalytics.fluent.FunctionsClient.retrieveDefaultDefinition(String resourceGroupName, String jobName, String functionName)"
name: "retrieveDefaultDefinition(String resourceGroupName, String jobName, String functionName)"
nameWithType: "FunctionsClient.retrieveDefaultDefinition(String resourceGroupName, String jobName, String functionName)"
summary: "Retrieves the default definition of a function based on the parameters specified."
modifiers:
- "abstract"
parameters:
- description: "The name of the resource group. The name is case insensitive."
name: "resourceGroupName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "The name of the streaming job."
name: "jobName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "The name of the function."
name: "functionName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public abstract FunctionInner retrieveDefaultDefinition(String resourceGroupName, String jobName, String functionName)"
desc: "Retrieves the default definition of a function based on the parameters specified."
returns:
description: "a function object, containing all information associated with the named function."
type: "<xref href=\"com.azure.resourcemanager.streamanalytics.fluent.models.FunctionInner?alt=com.azure.resourcemanager.streamanalytics.fluent.models.FunctionInner&text=FunctionInner\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.streamanalytics.fluent.FunctionsClient.retrieveDefaultDefinitionWithResponse(java.lang.String,java.lang.String,java.lang.String,com.azure.resourcemanager.streamanalytics.models.FunctionRetrieveDefaultDefinitionParameters,com.azure.core.util.Context)"
fullName: "com.azure.resourcemanager.streamanalytics.fluent.FunctionsClient.retrieveDefaultDefinitionWithResponse(String resourceGroupName, String jobName, String functionName, FunctionRetrieveDefaultDefinitionParameters functionRetrieveDefaultDefinitionParameters, Context context)"
name: "retrieveDefaultDefinitionWithResponse(String resourceGroupName, String jobName, String functionName, FunctionRetrieveDefaultDefinitionParameters functionRetrieveDefaultDefinitionParameters, Context context)"
nameWithType: "FunctionsClient.retrieveDefaultDefinitionWithResponse(String resourceGroupName, String jobName, String functionName, FunctionRetrieveDefaultDefinitionParameters functionRetrieveDefaultDefinitionParameters, Context context)"
summary: "Retrieves the default definition of a function based on the parameters specified."
modifiers:
- "abstract"
parameters:
- description: "The name of the resource group. The name is case insensitive."
name: "resourceGroupName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "The name of the streaming job."
name: "jobName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "The name of the function."
name: "functionName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "Parameters used to specify the type of function to retrieve\n the default definition for."
name: "functionRetrieveDefaultDefinitionParameters"
type: "<xref href=\"com.azure.resourcemanager.streamanalytics.models.FunctionRetrieveDefaultDefinitionParameters?alt=com.azure.resourcemanager.streamanalytics.models.FunctionRetrieveDefaultDefinitionParameters&text=FunctionRetrieveDefaultDefinitionParameters\" data-throw-if-not-resolved=\"False\" />"
- description: "The context to associate with this operation."
name: "context"
type: "<xref href=\"com.azure.core.util.Context?alt=com.azure.core.util.Context&text=Context\" data-throw-if-not-resolved=\"False\" />"
syntax: "public abstract Response<FunctionInner> retrieveDefaultDefinitionWithResponse(String resourceGroupName, String jobName, String functionName, FunctionRetrieveDefaultDefinitionParameters functionRetrieveDefaultDefinitionParameters, Context context)"
desc: "Retrieves the default definition of a function based on the parameters specified."
returns:
description: "a function object, containing all information associated with the named function along with\n <xref uid=\"com.azure.core.http.rest.Response\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Response\"></xref>."
type: "<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.resourcemanager.streamanalytics.fluent.models.FunctionInner?alt=com.azure.resourcemanager.streamanalytics.fluent.models.FunctionInner&text=FunctionInner\" data-throw-if-not-resolved=\"False\" />>"
- uid: "com.azure.resourcemanager.streamanalytics.fluent.FunctionsClient.test(java.lang.String,java.lang.String,java.lang.String)"
fullName: "com.azure.resourcemanager.streamanalytics.fluent.FunctionsClient.test(String resourceGroupName, String jobName, String functionName)"
name: "test(String resourceGroupName, String jobName, String functionName)"
nameWithType: "FunctionsClient.test(String resourceGroupName, String jobName, String functionName)"
summary: "Tests if the information provided for a function is valid."
modifiers:
- "abstract"
parameters:
- description: "The name of the resource group. The name is case insensitive."
name: "resourceGroupName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "The name of the streaming job."
name: "jobName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "The name of the function."
name: "functionName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public abstract ResourceTestStatusInner test(String resourceGroupName, String jobName, String functionName)"
desc: "Tests if the information provided for a function is valid. This can range from testing the connection to the underlying web service behind the function or making sure the function code provided is syntactically correct."
returns:
description: "describes the status of the test operation along with error information, if applicable."
type: "<xref href=\"com.azure.resourcemanager.streamanalytics.fluent.models.ResourceTestStatusInner?alt=com.azure.resourcemanager.streamanalytics.fluent.models.ResourceTestStatusInner&text=ResourceTestStatusInner\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.streamanalytics.fluent.FunctionsClient.test(java.lang.String,java.lang.String,java.lang.String,com.azure.resourcemanager.streamanalytics.fluent.models.FunctionInner,com.azure.core.util.Context)"
fullName: "com.azure.resourcemanager.streamanalytics.fluent.FunctionsClient.test(String resourceGroupName, String jobName, String functionName, FunctionInner function, Context context)"
name: "test(String resourceGroupName, String jobName, String functionName, FunctionInner function, Context context)"
nameWithType: "FunctionsClient.test(String resourceGroupName, String jobName, String functionName, FunctionInner function, Context context)"
summary: "Tests if the information provided for a function is valid."
modifiers:
- "abstract"
parameters:
- description: "The name of the resource group. The name is case insensitive."
name: "resourceGroupName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "The name of the streaming job."
name: "jobName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "The name of the function."
name: "functionName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "If the function specified does not already exist, this parameter must contain the full function\n definition intended to be tested. If the function specified already exists, this parameter can be left null to\n test the existing function as is or if specified, the properties specified will overwrite the corresponding\n properties in the existing function (exactly like a PATCH operation) and the resulting function will be tested."
name: "function"
type: "<xref href=\"com.azure.resourcemanager.streamanalytics.fluent.models.FunctionInner?alt=com.azure.resourcemanager.streamanalytics.fluent.models.FunctionInner&text=FunctionInner\" data-throw-if-not-resolved=\"False\" />"
- description: "The context to associate with this operation."
name: "context"
type: "<xref href=\"com.azure.core.util.Context?alt=com.azure.core.util.Context&text=Context\" data-throw-if-not-resolved=\"False\" />"
syntax: "public abstract ResourceTestStatusInner test(String resourceGroupName, String jobName, String functionName, FunctionInner function, Context context)"
desc: "Tests if the information provided for a function is valid. This can range from testing the connection to the underlying web service behind the function or making sure the function code provided is syntactically correct."
returns:
description: "describes the status of the test operation along with error information, if applicable."
type: "<xref href=\"com.azure.resourcemanager.streamanalytics.fluent.models.ResourceTestStatusInner?alt=com.azure.resourcemanager.streamanalytics.fluent.models.ResourceTestStatusInner&text=ResourceTestStatusInner\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.streamanalytics.fluent.FunctionsClient.update(java.lang.String,java.lang.String,java.lang.String,com.azure.resourcemanager.streamanalytics.fluent.models.FunctionInner)"
fullName: "com.azure.resourcemanager.streamanalytics.fluent.FunctionsClient.update(String resourceGroupName, String jobName, String functionName, FunctionInner function)"
name: "update(String resourceGroupName, String jobName, String functionName, FunctionInner function)"
nameWithType: "FunctionsClient.update(String resourceGroupName, String jobName, String functionName, FunctionInner function)"
summary: "Updates an existing function under an existing streaming job."
modifiers:
- "abstract"
parameters:
- description: "The name of the resource group. The name is case insensitive."
name: "resourceGroupName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "The name of the streaming job."
name: "jobName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "The name of the function."
name: "functionName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "A function object. The properties specified here will overwrite the corresponding properties in\n the existing function (ie. Those properties will be updated). Any properties that are set to null here will mean\n that the corresponding property in the existing function will remain the same and not change as a result of this\n PATCH operation."
name: "function"
type: "<xref href=\"com.azure.resourcemanager.streamanalytics.fluent.models.FunctionInner?alt=com.azure.resourcemanager.streamanalytics.fluent.models.FunctionInner&text=FunctionInner\" data-throw-if-not-resolved=\"False\" />"
syntax: "public abstract FunctionInner update(String resourceGroupName, String jobName, String functionName, FunctionInner function)"
desc: "Updates an existing function under an existing streaming job. This can be used to partially update (ie. update one or two properties) a function without affecting the rest the job or function definition."
returns:
description: "a function object, containing all information associated with the named function."
type: "<xref href=\"com.azure.resourcemanager.streamanalytics.fluent.models.FunctionInner?alt=com.azure.resourcemanager.streamanalytics.fluent.models.FunctionInner&text=FunctionInner\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.streamanalytics.fluent.FunctionsClient.updateWithResponse(java.lang.String,java.lang.String,java.lang.String,com.azure.resourcemanager.streamanalytics.fluent.models.FunctionInner,java.lang.String,com.azure.core.util.Context)"
fullName: "com.azure.resourcemanager.streamanalytics.fluent.FunctionsClient.updateWithResponse(String resourceGroupName, String jobName, String functionName, FunctionInner function, String ifMatch, Context context)"
name: "updateWithResponse(String resourceGroupName, String jobName, String functionName, FunctionInner function, String ifMatch, Context context)"
nameWithType: "FunctionsClient.updateWithResponse(String resourceGroupName, String jobName, String functionName, FunctionInner function, String ifMatch, Context context)"
summary: "Updates an existing function under an existing streaming job."
modifiers:
- "abstract"
parameters:
- description: "The name of the resource group. The name is case insensitive."
name: "resourceGroupName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "The name of the streaming job."
name: "jobName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "The name of the function."
name: "functionName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "A function object. The properties specified here will overwrite the corresponding properties in\n the existing function (ie. Those properties will be updated). Any properties that are set to null here will mean\n that the corresponding property in the existing function will remain the same and not change as a result of this\n PATCH operation."
name: "function"
type: "<xref href=\"com.azure.resourcemanager.streamanalytics.fluent.models.FunctionInner?alt=com.azure.resourcemanager.streamanalytics.fluent.models.FunctionInner&text=FunctionInner\" data-throw-if-not-resolved=\"False\" />"
- description: "The ETag of the function. Omit this value to always overwrite the current function. Specify the\n last-seen ETag value to prevent accidentally overwriting concurrent changes."
name: "ifMatch"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "The context to associate with this operation."
name: "context"
type: "<xref href=\"com.azure.core.util.Context?alt=com.azure.core.util.Context&text=Context\" data-throw-if-not-resolved=\"False\" />"
syntax: "public abstract FunctionsUpdateResponse updateWithResponse(String resourceGroupName, String jobName, String functionName, FunctionInner function, String ifMatch, Context context)"
desc: "Updates an existing function under an existing streaming job. This can be used to partially update (ie. update one or two properties) a function without affecting the rest the job or function definition."
returns:
description: "a function object, containing all information associated with the named function."
type: "<xref href=\"com.azure.resourcemanager.streamanalytics.models.FunctionsUpdateResponse?alt=com.azure.resourcemanager.streamanalytics.models.FunctionsUpdateResponse&text=FunctionsUpdateResponse\" data-throw-if-not-resolved=\"False\" />"
type: "interface"
desc: "An instance of this class provides access to all the operations defined in FunctionsClient."
metadata: {}
package: "com.azure.resourcemanager.streamanalytics.fluent"
artifact: com.azure.resourcemanager:azure-resourcemanager-streamanalytics:1.0.0-beta.3