auth0 5.7.0 → 5.8.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/cjs/management/api/requests/requests.d.ts +2 -2
- package/dist/cjs/management/api/resources/logStreams/client/Client.d.ts +465 -300
- package/dist/cjs/management/api/resources/logStreams/client/Client.js +465 -300
- package/dist/cjs/management/api/types/types.d.ts +29 -17
- package/dist/cjs/management/api/types/types.js +15 -10
- package/dist/cjs/management/version.d.ts +1 -1
- package/dist/cjs/management/version.js +1 -1
- package/dist/esm/management/api/requests/requests.d.mts +2 -2
- package/dist/esm/management/api/resources/logStreams/client/Client.d.mts +465 -300
- package/dist/esm/management/api/resources/logStreams/client/Client.mjs +465 -300
- package/dist/esm/management/api/types/types.d.mts +29 -17
- package/dist/esm/management/api/types/types.mjs +6 -1
- package/dist/esm/management/version.d.mts +1 -1
- package/dist/esm/management/version.mjs +1 -1
- package/package.json +1 -1
- package/reference.md +505 -323
|
@@ -56,72 +56,77 @@ class LogStreamsClient {
|
|
|
56
56
|
this._options = (0, BaseClient_js_1.normalizeClientOptionsWithAuth)(options);
|
|
57
57
|
}
|
|
58
58
|
/**
|
|
59
|
-
* Retrieve details on
|
|
60
|
-
*
|
|
61
|
-
*
|
|
62
|
-
*
|
|
63
|
-
*
|
|
64
|
-
*
|
|
65
|
-
*
|
|
66
|
-
*
|
|
67
|
-
*
|
|
68
|
-
*
|
|
69
|
-
*
|
|
59
|
+
* Retrieve details on [log streams](https://auth0.com/docs/logs/streams).
|
|
60
|
+
*
|
|
61
|
+
* **Sample Response**
|
|
62
|
+
*
|
|
63
|
+
* ```json
|
|
64
|
+
* [{
|
|
65
|
+
* "id": "string",
|
|
66
|
+
* "name": "string",
|
|
67
|
+
* "type": "eventbridge",
|
|
68
|
+
* "status": "active|paused|suspended",
|
|
69
|
+
* "sink": {
|
|
70
|
+
* "awsAccountId": "string",
|
|
71
|
+
* "awsRegion": "string",
|
|
72
|
+
* "awsPartnerEventSource": "string"
|
|
73
|
+
* }
|
|
70
74
|
* }, {
|
|
71
|
-
*
|
|
72
|
-
*
|
|
73
|
-
*
|
|
74
|
-
*
|
|
75
|
-
*
|
|
76
|
-
*
|
|
77
|
-
*
|
|
78
|
-
*
|
|
79
|
-
*
|
|
80
|
-
*
|
|
75
|
+
* "id": "string",
|
|
76
|
+
* "name": "string",
|
|
77
|
+
* "type": "http",
|
|
78
|
+
* "status": "active|paused|suspended",
|
|
79
|
+
* "sink": {
|
|
80
|
+
* "httpContentFormat": "JSONLINES|JSONARRAY",
|
|
81
|
+
* "httpContentType": "string",
|
|
82
|
+
* "httpEndpoint": "string",
|
|
83
|
+
* "httpAuthorization": "string"
|
|
84
|
+
* }
|
|
81
85
|
* },
|
|
82
86
|
* {
|
|
83
|
-
*
|
|
84
|
-
*
|
|
85
|
-
*
|
|
86
|
-
*
|
|
87
|
-
*
|
|
88
|
-
*
|
|
89
|
-
*
|
|
90
|
-
*
|
|
91
|
-
*
|
|
92
|
-
*
|
|
87
|
+
* "id": "string",
|
|
88
|
+
* "name": "string",
|
|
89
|
+
* "type": "eventgrid",
|
|
90
|
+
* "status": "active|paused|suspended",
|
|
91
|
+
* "sink": {
|
|
92
|
+
* "azureSubscriptionId": "string",
|
|
93
|
+
* "azureResourceGroup": "string",
|
|
94
|
+
* "azureRegion": "string",
|
|
95
|
+
* "azurePartnerTopic": "string"
|
|
96
|
+
* }
|
|
93
97
|
* },
|
|
94
98
|
* {
|
|
95
|
-
*
|
|
96
|
-
*
|
|
97
|
-
*
|
|
98
|
-
*
|
|
99
|
-
*
|
|
100
|
-
*
|
|
101
|
-
*
|
|
102
|
-
*
|
|
103
|
-
*
|
|
104
|
-
*
|
|
99
|
+
* "id": "string",
|
|
100
|
+
* "name": "string",
|
|
101
|
+
* "type": "splunk",
|
|
102
|
+
* "status": "active|paused|suspended",
|
|
103
|
+
* "sink": {
|
|
104
|
+
* "splunkDomain": "string",
|
|
105
|
+
* "splunkToken": "string",
|
|
106
|
+
* "splunkPort": "string",
|
|
107
|
+
* "splunkSecure": "boolean"
|
|
108
|
+
* }
|
|
105
109
|
* },
|
|
106
110
|
* {
|
|
107
|
-
*
|
|
108
|
-
*
|
|
109
|
-
*
|
|
110
|
-
*
|
|
111
|
-
*
|
|
112
|
-
*
|
|
113
|
-
*
|
|
111
|
+
* "id": "string",
|
|
112
|
+
* "name": "string",
|
|
113
|
+
* "type": "sumo",
|
|
114
|
+
* "status": "active|paused|suspended",
|
|
115
|
+
* "sink": {
|
|
116
|
+
* "sumoSourceAddress": "string"
|
|
117
|
+
* }
|
|
114
118
|
* },
|
|
115
119
|
* {
|
|
116
|
-
*
|
|
117
|
-
*
|
|
118
|
-
*
|
|
119
|
-
*
|
|
120
|
-
*
|
|
121
|
-
*
|
|
122
|
-
*
|
|
123
|
-
*
|
|
124
|
-
* }]
|
|
120
|
+
* "id": "string",
|
|
121
|
+
* "name": "string",
|
|
122
|
+
* "type": "datadog",
|
|
123
|
+
* "status": "active|paused|suspended",
|
|
124
|
+
* "sink": {
|
|
125
|
+
* "datadogRegion": "string",
|
|
126
|
+
* "datadogApiKey": "string"
|
|
127
|
+
* }
|
|
128
|
+
* }]
|
|
129
|
+
* ```
|
|
125
130
|
*
|
|
126
131
|
* @param {LogStreamsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
127
132
|
*
|
|
@@ -178,131 +183,202 @@ class LogStreamsClient {
|
|
|
178
183
|
}
|
|
179
184
|
/**
|
|
180
185
|
* Create a log stream.
|
|
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
|
-
* Request
|
|
291
|
-
*
|
|
292
|
-
*
|
|
293
|
-
*
|
|
294
|
-
*
|
|
295
|
-
*
|
|
296
|
-
*
|
|
297
|
-
*
|
|
298
|
-
*
|
|
299
|
-
*
|
|
300
|
-
*
|
|
301
|
-
*
|
|
302
|
-
*
|
|
303
|
-
*
|
|
304
|
-
*
|
|
305
|
-
*
|
|
186
|
+
*
|
|
187
|
+
* **Log Stream Types**
|
|
188
|
+
*
|
|
189
|
+
* The `type` of log stream being created determines the properties required in the `sink` payload.
|
|
190
|
+
*
|
|
191
|
+
* **HTTP Stream**
|
|
192
|
+
*
|
|
193
|
+
* For an `http` Stream, the `sink` properties are listed in the payload below.
|
|
194
|
+
*
|
|
195
|
+
* **Request:**
|
|
196
|
+
* ```json
|
|
197
|
+
* {
|
|
198
|
+
* "name": "string",
|
|
199
|
+
* "type": "http",
|
|
200
|
+
* "sink": {
|
|
201
|
+
* "httpEndpoint": "string",
|
|
202
|
+
* "httpContentType": "string",
|
|
203
|
+
* "httpContentFormat": "JSONLINES|JSONARRAY",
|
|
204
|
+
* "httpAuthorization": "string"
|
|
205
|
+
* }
|
|
206
|
+
* }
|
|
207
|
+
* ```
|
|
208
|
+
*
|
|
209
|
+
* **Response:**
|
|
210
|
+
* ```json
|
|
211
|
+
* {
|
|
212
|
+
* "id": "string",
|
|
213
|
+
* "name": "string",
|
|
214
|
+
* "type": "http",
|
|
215
|
+
* "status": "active",
|
|
216
|
+
* "sink": {
|
|
217
|
+
* "httpEndpoint": "string",
|
|
218
|
+
* "httpContentType": "string",
|
|
219
|
+
* "httpContentFormat": "JSONLINES|JSONARRAY",
|
|
220
|
+
* "httpAuthorization": "string"
|
|
221
|
+
* }
|
|
222
|
+
* }
|
|
223
|
+
* ```
|
|
224
|
+
*
|
|
225
|
+
* **Amazon EventBridge Stream**
|
|
226
|
+
*
|
|
227
|
+
* For an `eventbridge` Stream, the `sink` properties are listed in the payload below.
|
|
228
|
+
*
|
|
229
|
+
* **Request:**
|
|
230
|
+
* ```json
|
|
231
|
+
* {
|
|
232
|
+
* "name": "string",
|
|
233
|
+
* "type": "eventbridge",
|
|
234
|
+
* "sink": {
|
|
235
|
+
* "awsRegion": "string",
|
|
236
|
+
* "awsAccountId": "string"
|
|
237
|
+
* }
|
|
238
|
+
* }
|
|
239
|
+
* ```
|
|
240
|
+
*
|
|
241
|
+
* The response will include an additional field `awsPartnerEventSource` in the `sink`:
|
|
242
|
+
*
|
|
243
|
+
* **Response:**
|
|
244
|
+
* ```json
|
|
245
|
+
* {
|
|
246
|
+
* "id": "string",
|
|
247
|
+
* "name": "string",
|
|
248
|
+
* "type": "eventbridge",
|
|
249
|
+
* "status": "active",
|
|
250
|
+
* "sink": {
|
|
251
|
+
* "awsAccountId": "string",
|
|
252
|
+
* "awsRegion": "string",
|
|
253
|
+
* "awsPartnerEventSource": "string"
|
|
254
|
+
* }
|
|
255
|
+
* }
|
|
256
|
+
* ```
|
|
257
|
+
*
|
|
258
|
+
* **Azure Event Grid Stream**
|
|
259
|
+
*
|
|
260
|
+
* For an `Azure Event Grid` Stream, the `sink` properties are listed in the payload below.
|
|
261
|
+
*
|
|
262
|
+
* **Request:**
|
|
263
|
+
* ```json
|
|
264
|
+
* {
|
|
265
|
+
* "name": "string",
|
|
266
|
+
* "type": "eventgrid",
|
|
267
|
+
* "sink": {
|
|
268
|
+
* "azureSubscriptionId": "string",
|
|
269
|
+
* "azureResourceGroup": "string",
|
|
270
|
+
* "azureRegion": "string"
|
|
271
|
+
* }
|
|
272
|
+
* }
|
|
273
|
+
* ```
|
|
274
|
+
*
|
|
275
|
+
* **Response:**
|
|
276
|
+
* ```json
|
|
277
|
+
* {
|
|
278
|
+
* "id": "string",
|
|
279
|
+
* "name": "string",
|
|
280
|
+
* "type": "http",
|
|
281
|
+
* "status": "active",
|
|
282
|
+
* "sink": {
|
|
283
|
+
* "azureSubscriptionId": "string",
|
|
284
|
+
* "azureResourceGroup": "string",
|
|
285
|
+
* "azureRegion": "string",
|
|
286
|
+
* "azurePartnerTopic": "string"
|
|
287
|
+
* }
|
|
288
|
+
* }
|
|
289
|
+
* ```
|
|
290
|
+
*
|
|
291
|
+
* **Datadog Stream**
|
|
292
|
+
*
|
|
293
|
+
* For a `Datadog` Stream, the `sink` properties are listed in the payload below.
|
|
294
|
+
*
|
|
295
|
+
* **Request:**
|
|
296
|
+
* ```json
|
|
297
|
+
* {
|
|
298
|
+
* "name": "string",
|
|
299
|
+
* "type": "datadog",
|
|
300
|
+
* "sink": {
|
|
301
|
+
* "datadogRegion": "string",
|
|
302
|
+
* "datadogApiKey": "string"
|
|
303
|
+
* }
|
|
304
|
+
* }
|
|
305
|
+
* ```
|
|
306
|
+
*
|
|
307
|
+
* **Response:**
|
|
308
|
+
* ```json
|
|
309
|
+
* {
|
|
310
|
+
* "id": "string",
|
|
311
|
+
* "name": "string",
|
|
312
|
+
* "type": "datadog",
|
|
313
|
+
* "status": "active",
|
|
314
|
+
* "sink": {
|
|
315
|
+
* "datadogRegion": "string",
|
|
316
|
+
* "datadogApiKey": "string"
|
|
317
|
+
* }
|
|
318
|
+
* }
|
|
319
|
+
* ```
|
|
320
|
+
*
|
|
321
|
+
* **Splunk Stream**
|
|
322
|
+
*
|
|
323
|
+
* For a `Splunk` Stream, the `sink` properties are listed in the payload below.
|
|
324
|
+
*
|
|
325
|
+
* **Request:**
|
|
326
|
+
* ```json
|
|
327
|
+
* {
|
|
328
|
+
* "name": "string",
|
|
329
|
+
* "type": "splunk",
|
|
330
|
+
* "sink": {
|
|
331
|
+
* "splunkDomain": "string",
|
|
332
|
+
* "splunkToken": "string",
|
|
333
|
+
* "splunkPort": "string",
|
|
334
|
+
* "splunkSecure": "boolean"
|
|
335
|
+
* }
|
|
336
|
+
* }
|
|
337
|
+
* ```
|
|
338
|
+
*
|
|
339
|
+
* **Response:**
|
|
340
|
+
* ```json
|
|
341
|
+
* {
|
|
342
|
+
* "id": "string",
|
|
343
|
+
* "name": "string",
|
|
344
|
+
* "type": "splunk",
|
|
345
|
+
* "status": "active",
|
|
346
|
+
* "sink": {
|
|
347
|
+
* "splunkDomain": "string",
|
|
348
|
+
* "splunkToken": "string",
|
|
349
|
+
* "splunkPort": "string",
|
|
350
|
+
* "splunkSecure": "boolean"
|
|
351
|
+
* }
|
|
352
|
+
* }
|
|
353
|
+
* ```
|
|
354
|
+
*
|
|
355
|
+
* **Sumo Logic Stream**
|
|
356
|
+
*
|
|
357
|
+
* For a `Sumo Logic` Stream, the `sink` properties are listed in the payload below.
|
|
358
|
+
*
|
|
359
|
+
* **Request:**
|
|
360
|
+
* ```json
|
|
361
|
+
* {
|
|
362
|
+
* "name": "string",
|
|
363
|
+
* "type": "sumo",
|
|
364
|
+
* "sink": {
|
|
365
|
+
* "sumoSourceAddress": "string"
|
|
366
|
+
* }
|
|
367
|
+
* }
|
|
368
|
+
* ```
|
|
369
|
+
*
|
|
370
|
+
* **Response:**
|
|
371
|
+
* ```json
|
|
372
|
+
* {
|
|
373
|
+
* "id": "string",
|
|
374
|
+
* "name": "string",
|
|
375
|
+
* "type": "sumo",
|
|
376
|
+
* "status": "active",
|
|
377
|
+
* "sink": {
|
|
378
|
+
* "sumoSourceAddress": "string"
|
|
379
|
+
* }
|
|
380
|
+
* }
|
|
381
|
+
* ```
|
|
306
382
|
*
|
|
307
383
|
* @param {Management.CreateLogStreamRequestContent} request
|
|
308
384
|
* @param {LogStreamsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -374,107 +450,157 @@ class LogStreamsClient {
|
|
|
374
450
|
}
|
|
375
451
|
/**
|
|
376
452
|
* Retrieve a log stream configuration and status.
|
|
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
|
-
*
|
|
414
|
-
*
|
|
415
|
-
*
|
|
416
|
-
*
|
|
417
|
-
*
|
|
418
|
-
*
|
|
419
|
-
*
|
|
420
|
-
*
|
|
421
|
-
*
|
|
422
|
-
*
|
|
423
|
-
*
|
|
424
|
-
*
|
|
425
|
-
*
|
|
426
|
-
*
|
|
427
|
-
*
|
|
428
|
-
*
|
|
429
|
-
*
|
|
430
|
-
*
|
|
431
|
-
*
|
|
432
|
-
*
|
|
433
|
-
*
|
|
434
|
-
*
|
|
435
|
-
*
|
|
436
|
-
*
|
|
437
|
-
*
|
|
438
|
-
*
|
|
439
|
-
*
|
|
440
|
-
*
|
|
441
|
-
*
|
|
442
|
-
*
|
|
443
|
-
*
|
|
444
|
-
*
|
|
445
|
-
*
|
|
446
|
-
*
|
|
447
|
-
*
|
|
448
|
-
*
|
|
449
|
-
*
|
|
450
|
-
*
|
|
451
|
-
*
|
|
452
|
-
*
|
|
453
|
-
*
|
|
454
|
-
*
|
|
455
|
-
*
|
|
456
|
-
*
|
|
457
|
-
*
|
|
458
|
-
*
|
|
459
|
-
*
|
|
460
|
-
*
|
|
461
|
-
*
|
|
462
|
-
*
|
|
463
|
-
*
|
|
464
|
-
*
|
|
465
|
-
*
|
|
466
|
-
*
|
|
467
|
-
*
|
|
468
|
-
*
|
|
469
|
-
*
|
|
470
|
-
*
|
|
471
|
-
*
|
|
472
|
-
*
|
|
473
|
-
*
|
|
474
|
-
*
|
|
475
|
-
*
|
|
476
|
-
*
|
|
477
|
-
*
|
|
453
|
+
*
|
|
454
|
+
* **Sample responses**
|
|
455
|
+
*
|
|
456
|
+
* **Amazon EventBridge Log Stream**
|
|
457
|
+
*
|
|
458
|
+
* ```json
|
|
459
|
+
* {
|
|
460
|
+
* "id": "string",
|
|
461
|
+
* "name": "string",
|
|
462
|
+
* "type": "eventbridge",
|
|
463
|
+
* "status": "active|paused|suspended",
|
|
464
|
+
* "sink": {
|
|
465
|
+
* "awsAccountId": "string",
|
|
466
|
+
* "awsRegion": "string",
|
|
467
|
+
* "awsPartnerEventSource": "string"
|
|
468
|
+
* }
|
|
469
|
+
* }
|
|
470
|
+
* ```
|
|
471
|
+
*
|
|
472
|
+
* **HTTP Log Stream**
|
|
473
|
+
*
|
|
474
|
+
* ```json
|
|
475
|
+
* {
|
|
476
|
+
* "id": "string",
|
|
477
|
+
* "name": "string",
|
|
478
|
+
* "type": "http",
|
|
479
|
+
* "status": "active|paused|suspended",
|
|
480
|
+
* "sink": {
|
|
481
|
+
* "httpContentFormat": "JSONLINES|JSONARRAY",
|
|
482
|
+
* "httpContentType": "string",
|
|
483
|
+
* "httpEndpoint": "string",
|
|
484
|
+
* "httpAuthorization": "string"
|
|
485
|
+
* }
|
|
486
|
+
* }
|
|
487
|
+
* ```
|
|
488
|
+
*
|
|
489
|
+
* **Datadog Log Stream**
|
|
490
|
+
*
|
|
491
|
+
* ```json
|
|
492
|
+
* {
|
|
493
|
+
* "id": "string",
|
|
494
|
+
* "name": "string",
|
|
495
|
+
* "type": "datadog",
|
|
496
|
+
* "status": "active|paused|suspended",
|
|
497
|
+
* "sink": {
|
|
498
|
+
* "datadogRegion": "string",
|
|
499
|
+
* "datadogApiKey": "string"
|
|
500
|
+
* }
|
|
501
|
+
* }
|
|
502
|
+
* ```
|
|
503
|
+
*
|
|
504
|
+
* **Mixpanel**
|
|
505
|
+
*
|
|
506
|
+
* **Request:**
|
|
507
|
+
*
|
|
508
|
+
* ```json
|
|
509
|
+
* {
|
|
510
|
+
* "name": "string",
|
|
511
|
+
* "type": "mixpanel",
|
|
512
|
+
* "sink": {
|
|
513
|
+
* "mixpanelRegion": "string",
|
|
514
|
+
* "mixpanelProjectId": "string",
|
|
515
|
+
* "mixpanelServiceAccountUsername": "string",
|
|
516
|
+
* "mixpanelServiceAccountPassword": "string"
|
|
517
|
+
* }
|
|
518
|
+
* }
|
|
519
|
+
* ```
|
|
520
|
+
*
|
|
521
|
+
* **Response:**
|
|
522
|
+
*
|
|
523
|
+
* ```json
|
|
524
|
+
* {
|
|
525
|
+
* "id": "string",
|
|
526
|
+
* "name": "string",
|
|
527
|
+
* "type": "mixpanel",
|
|
528
|
+
* "status": "active",
|
|
529
|
+
* "sink": {
|
|
530
|
+
* "mixpanelRegion": "string",
|
|
531
|
+
* "mixpanelProjectId": "string",
|
|
532
|
+
* "mixpanelServiceAccountUsername": "string",
|
|
533
|
+
* "mixpanelServiceAccountPassword": "string"
|
|
534
|
+
* }
|
|
535
|
+
* }
|
|
536
|
+
* ```
|
|
537
|
+
*
|
|
538
|
+
* **Segment**
|
|
539
|
+
*
|
|
540
|
+
* **Request:**
|
|
541
|
+
*
|
|
542
|
+
* ```json
|
|
543
|
+
* {
|
|
544
|
+
* "name": "string",
|
|
545
|
+
* "type": "segment",
|
|
546
|
+
* "sink": {
|
|
547
|
+
* "segmentWriteKey": "string"
|
|
548
|
+
* }
|
|
549
|
+
* }
|
|
550
|
+
* ```
|
|
551
|
+
*
|
|
552
|
+
* **Response:**
|
|
553
|
+
*
|
|
554
|
+
* ```json
|
|
555
|
+
* {
|
|
556
|
+
* "id": "string",
|
|
557
|
+
* "name": "string",
|
|
558
|
+
* "type": "segment",
|
|
559
|
+
* "status": "active",
|
|
560
|
+
* "sink": {
|
|
561
|
+
* "segmentWriteKey": "string"
|
|
562
|
+
* }
|
|
563
|
+
* }
|
|
564
|
+
* ```
|
|
565
|
+
*
|
|
566
|
+
* **Splunk Log Stream**
|
|
567
|
+
*
|
|
568
|
+
* ```json
|
|
569
|
+
* {
|
|
570
|
+
* "id": "string",
|
|
571
|
+
* "name": "string",
|
|
572
|
+
* "type": "splunk",
|
|
573
|
+
* "status": "active|paused|suspended",
|
|
574
|
+
* "sink": {
|
|
575
|
+
* "splunkDomain": "string",
|
|
576
|
+
* "splunkToken": "string",
|
|
577
|
+
* "splunkPort": "string",
|
|
578
|
+
* "splunkSecure": "boolean"
|
|
579
|
+
* }
|
|
580
|
+
* }
|
|
581
|
+
* ```
|
|
582
|
+
*
|
|
583
|
+
* **Sumo Logic Log Stream**
|
|
584
|
+
*
|
|
585
|
+
* ```json
|
|
586
|
+
* {
|
|
587
|
+
* "id": "string",
|
|
588
|
+
* "name": "string",
|
|
589
|
+
* "type": "sumo",
|
|
590
|
+
* "status": "active|paused|suspended",
|
|
591
|
+
* "sink": {
|
|
592
|
+
* "sumoSourceAddress": "string"
|
|
593
|
+
* }
|
|
594
|
+
* }
|
|
595
|
+
* ```
|
|
596
|
+
*
|
|
597
|
+
* **Status**
|
|
598
|
+
*
|
|
599
|
+
* The `status` of a log stream maybe any of the following:
|
|
600
|
+
*
|
|
601
|
+
* 1. `active` - Stream is currently enabled.
|
|
602
|
+
* 2. `paused` - Stream is currently user disabled and will not attempt log delivery.
|
|
603
|
+
* 3. `suspended` - Stream is currently disabled because of errors and will not attempt log delivery.
|
|
478
604
|
*
|
|
479
605
|
* @param {string} id - The id of the log stream to get
|
|
480
606
|
* @param {LogStreamsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -595,40 +721,79 @@ class LogStreamsClient {
|
|
|
595
721
|
}
|
|
596
722
|
/**
|
|
597
723
|
* Update a log stream.
|
|
598
|
-
*
|
|
599
|
-
*
|
|
600
|
-
*
|
|
601
|
-
*
|
|
602
|
-
*
|
|
603
|
-
*
|
|
604
|
-
*
|
|
605
|
-
*
|
|
724
|
+
*
|
|
725
|
+
* **Examples of how to use the PATCH endpoint.**
|
|
726
|
+
*
|
|
727
|
+
* The following fields may be updated in a PATCH operation:
|
|
728
|
+
*
|
|
729
|
+
* - name
|
|
730
|
+
* - status
|
|
731
|
+
* - sink
|
|
732
|
+
*
|
|
733
|
+
* Note: For log streams of type `eventbridge` and `eventgrid`, updating the `sink` is not permitted.
|
|
734
|
+
*
|
|
735
|
+
* **Update the status of a log stream**
|
|
736
|
+
*
|
|
737
|
+
* ```json
|
|
738
|
+
* {
|
|
739
|
+
* "status": "active|paused"
|
|
740
|
+
* }
|
|
741
|
+
* ```
|
|
742
|
+
*
|
|
743
|
+
* **Update the name of a log stream**
|
|
744
|
+
*
|
|
745
|
+
* ```json
|
|
746
|
+
* {
|
|
747
|
+
* "name": "string"
|
|
748
|
+
* }
|
|
749
|
+
* ```
|
|
750
|
+
*
|
|
751
|
+
* **Update the sink properties of a stream of type `http`**
|
|
752
|
+
*
|
|
753
|
+
* ```json
|
|
754
|
+
* {
|
|
606
755
|
* "sink": {
|
|
607
756
|
* "httpEndpoint": "string",
|
|
608
757
|
* "httpContentType": "string",
|
|
609
758
|
* "httpContentFormat": "JSONARRAY|JSONLINES",
|
|
610
759
|
* "httpAuthorization": "string"
|
|
611
760
|
* }
|
|
612
|
-
* }
|
|
613
|
-
*
|
|
761
|
+
* }
|
|
762
|
+
* ```
|
|
763
|
+
*
|
|
764
|
+
* **Update the sink properties of a stream of type `datadog`**
|
|
765
|
+
*
|
|
766
|
+
* ```json
|
|
767
|
+
* {
|
|
614
768
|
* "sink": {
|
|
615
|
-
*
|
|
616
|
-
*
|
|
769
|
+
* "datadogRegion": "string",
|
|
770
|
+
* "datadogApiKey": "string"
|
|
617
771
|
* }
|
|
618
|
-
* }
|
|
619
|
-
*
|
|
772
|
+
* }
|
|
773
|
+
* ```
|
|
774
|
+
*
|
|
775
|
+
* **Update the sink properties of a stream of type `splunk`**
|
|
776
|
+
*
|
|
777
|
+
* ```json
|
|
778
|
+
* {
|
|
620
779
|
* "sink": {
|
|
621
780
|
* "splunkDomain": "string",
|
|
622
781
|
* "splunkToken": "string",
|
|
623
782
|
* "splunkPort": "string",
|
|
624
783
|
* "splunkSecure": "boolean"
|
|
625
784
|
* }
|
|
626
|
-
* }
|
|
627
|
-
*
|
|
785
|
+
* }
|
|
786
|
+
* ```
|
|
787
|
+
*
|
|
788
|
+
* **Update the sink properties of a stream of type `sumo`**
|
|
789
|
+
*
|
|
790
|
+
* ```json
|
|
791
|
+
* {
|
|
628
792
|
* "sink": {
|
|
629
793
|
* "sumoSourceAddress": "string"
|
|
630
794
|
* }
|
|
631
|
-
* }
|
|
795
|
+
* }
|
|
796
|
+
* ```
|
|
632
797
|
*
|
|
633
798
|
* @param {string} id - The id of the log stream to get
|
|
634
799
|
* @param {Management.UpdateLogStreamRequestContent} request
|