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
|
@@ -11,72 +11,77 @@ export declare class LogStreamsClient {
|
|
|
11
11
|
protected readonly _options: NormalizedClientOptionsWithAuth<LogStreamsClient.Options>;
|
|
12
12
|
constructor(options: LogStreamsClient.Options);
|
|
13
13
|
/**
|
|
14
|
-
* Retrieve details on
|
|
15
|
-
*
|
|
16
|
-
*
|
|
17
|
-
*
|
|
18
|
-
*
|
|
19
|
-
*
|
|
20
|
-
*
|
|
21
|
-
*
|
|
22
|
-
*
|
|
23
|
-
*
|
|
24
|
-
*
|
|
14
|
+
* Retrieve details on [log streams](https://auth0.com/docs/logs/streams).
|
|
15
|
+
*
|
|
16
|
+
* **Sample Response**
|
|
17
|
+
*
|
|
18
|
+
* ```json
|
|
19
|
+
* [{
|
|
20
|
+
* "id": "string",
|
|
21
|
+
* "name": "string",
|
|
22
|
+
* "type": "eventbridge",
|
|
23
|
+
* "status": "active|paused|suspended",
|
|
24
|
+
* "sink": {
|
|
25
|
+
* "awsAccountId": "string",
|
|
26
|
+
* "awsRegion": "string",
|
|
27
|
+
* "awsPartnerEventSource": "string"
|
|
28
|
+
* }
|
|
25
29
|
* }, {
|
|
26
|
-
*
|
|
27
|
-
*
|
|
28
|
-
*
|
|
29
|
-
*
|
|
30
|
-
*
|
|
31
|
-
*
|
|
32
|
-
*
|
|
33
|
-
*
|
|
34
|
-
*
|
|
35
|
-
*
|
|
30
|
+
* "id": "string",
|
|
31
|
+
* "name": "string",
|
|
32
|
+
* "type": "http",
|
|
33
|
+
* "status": "active|paused|suspended",
|
|
34
|
+
* "sink": {
|
|
35
|
+
* "httpContentFormat": "JSONLINES|JSONARRAY",
|
|
36
|
+
* "httpContentType": "string",
|
|
37
|
+
* "httpEndpoint": "string",
|
|
38
|
+
* "httpAuthorization": "string"
|
|
39
|
+
* }
|
|
36
40
|
* },
|
|
37
41
|
* {
|
|
38
|
-
*
|
|
39
|
-
*
|
|
40
|
-
*
|
|
41
|
-
*
|
|
42
|
-
*
|
|
43
|
-
*
|
|
44
|
-
*
|
|
45
|
-
*
|
|
46
|
-
*
|
|
47
|
-
*
|
|
42
|
+
* "id": "string",
|
|
43
|
+
* "name": "string",
|
|
44
|
+
* "type": "eventgrid",
|
|
45
|
+
* "status": "active|paused|suspended",
|
|
46
|
+
* "sink": {
|
|
47
|
+
* "azureSubscriptionId": "string",
|
|
48
|
+
* "azureResourceGroup": "string",
|
|
49
|
+
* "azureRegion": "string",
|
|
50
|
+
* "azurePartnerTopic": "string"
|
|
51
|
+
* }
|
|
48
52
|
* },
|
|
49
53
|
* {
|
|
50
|
-
*
|
|
51
|
-
*
|
|
52
|
-
*
|
|
53
|
-
*
|
|
54
|
-
*
|
|
55
|
-
*
|
|
56
|
-
*
|
|
57
|
-
*
|
|
58
|
-
*
|
|
59
|
-
*
|
|
54
|
+
* "id": "string",
|
|
55
|
+
* "name": "string",
|
|
56
|
+
* "type": "splunk",
|
|
57
|
+
* "status": "active|paused|suspended",
|
|
58
|
+
* "sink": {
|
|
59
|
+
* "splunkDomain": "string",
|
|
60
|
+
* "splunkToken": "string",
|
|
61
|
+
* "splunkPort": "string",
|
|
62
|
+
* "splunkSecure": "boolean"
|
|
63
|
+
* }
|
|
60
64
|
* },
|
|
61
65
|
* {
|
|
62
|
-
*
|
|
63
|
-
*
|
|
64
|
-
*
|
|
65
|
-
*
|
|
66
|
-
*
|
|
67
|
-
*
|
|
68
|
-
*
|
|
66
|
+
* "id": "string",
|
|
67
|
+
* "name": "string",
|
|
68
|
+
* "type": "sumo",
|
|
69
|
+
* "status": "active|paused|suspended",
|
|
70
|
+
* "sink": {
|
|
71
|
+
* "sumoSourceAddress": "string"
|
|
72
|
+
* }
|
|
69
73
|
* },
|
|
70
74
|
* {
|
|
71
|
-
*
|
|
72
|
-
*
|
|
73
|
-
*
|
|
74
|
-
*
|
|
75
|
-
*
|
|
76
|
-
*
|
|
77
|
-
*
|
|
78
|
-
*
|
|
79
|
-
* }]
|
|
75
|
+
* "id": "string",
|
|
76
|
+
* "name": "string",
|
|
77
|
+
* "type": "datadog",
|
|
78
|
+
* "status": "active|paused|suspended",
|
|
79
|
+
* "sink": {
|
|
80
|
+
* "datadogRegion": "string",
|
|
81
|
+
* "datadogApiKey": "string"
|
|
82
|
+
* }
|
|
83
|
+
* }]
|
|
84
|
+
* ```
|
|
80
85
|
*
|
|
81
86
|
* @param {LogStreamsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
82
87
|
*
|
|
@@ -92,131 +97,202 @@ export declare class LogStreamsClient {
|
|
|
92
97
|
private __list;
|
|
93
98
|
/**
|
|
94
99
|
* Create a log stream.
|
|
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
|
-
* Request
|
|
205
|
-
*
|
|
206
|
-
*
|
|
207
|
-
*
|
|
208
|
-
*
|
|
209
|
-
*
|
|
210
|
-
*
|
|
211
|
-
*
|
|
212
|
-
*
|
|
213
|
-
*
|
|
214
|
-
*
|
|
215
|
-
*
|
|
216
|
-
*
|
|
217
|
-
*
|
|
218
|
-
*
|
|
219
|
-
*
|
|
100
|
+
*
|
|
101
|
+
* **Log Stream Types**
|
|
102
|
+
*
|
|
103
|
+
* The `type` of log stream being created determines the properties required in the `sink` payload.
|
|
104
|
+
*
|
|
105
|
+
* **HTTP Stream**
|
|
106
|
+
*
|
|
107
|
+
* For an `http` Stream, the `sink` properties are listed in the payload below.
|
|
108
|
+
*
|
|
109
|
+
* **Request:**
|
|
110
|
+
* ```json
|
|
111
|
+
* {
|
|
112
|
+
* "name": "string",
|
|
113
|
+
* "type": "http",
|
|
114
|
+
* "sink": {
|
|
115
|
+
* "httpEndpoint": "string",
|
|
116
|
+
* "httpContentType": "string",
|
|
117
|
+
* "httpContentFormat": "JSONLINES|JSONARRAY",
|
|
118
|
+
* "httpAuthorization": "string"
|
|
119
|
+
* }
|
|
120
|
+
* }
|
|
121
|
+
* ```
|
|
122
|
+
*
|
|
123
|
+
* **Response:**
|
|
124
|
+
* ```json
|
|
125
|
+
* {
|
|
126
|
+
* "id": "string",
|
|
127
|
+
* "name": "string",
|
|
128
|
+
* "type": "http",
|
|
129
|
+
* "status": "active",
|
|
130
|
+
* "sink": {
|
|
131
|
+
* "httpEndpoint": "string",
|
|
132
|
+
* "httpContentType": "string",
|
|
133
|
+
* "httpContentFormat": "JSONLINES|JSONARRAY",
|
|
134
|
+
* "httpAuthorization": "string"
|
|
135
|
+
* }
|
|
136
|
+
* }
|
|
137
|
+
* ```
|
|
138
|
+
*
|
|
139
|
+
* **Amazon EventBridge Stream**
|
|
140
|
+
*
|
|
141
|
+
* For an `eventbridge` Stream, the `sink` properties are listed in the payload below.
|
|
142
|
+
*
|
|
143
|
+
* **Request:**
|
|
144
|
+
* ```json
|
|
145
|
+
* {
|
|
146
|
+
* "name": "string",
|
|
147
|
+
* "type": "eventbridge",
|
|
148
|
+
* "sink": {
|
|
149
|
+
* "awsRegion": "string",
|
|
150
|
+
* "awsAccountId": "string"
|
|
151
|
+
* }
|
|
152
|
+
* }
|
|
153
|
+
* ```
|
|
154
|
+
*
|
|
155
|
+
* The response will include an additional field `awsPartnerEventSource` in the `sink`:
|
|
156
|
+
*
|
|
157
|
+
* **Response:**
|
|
158
|
+
* ```json
|
|
159
|
+
* {
|
|
160
|
+
* "id": "string",
|
|
161
|
+
* "name": "string",
|
|
162
|
+
* "type": "eventbridge",
|
|
163
|
+
* "status": "active",
|
|
164
|
+
* "sink": {
|
|
165
|
+
* "awsAccountId": "string",
|
|
166
|
+
* "awsRegion": "string",
|
|
167
|
+
* "awsPartnerEventSource": "string"
|
|
168
|
+
* }
|
|
169
|
+
* }
|
|
170
|
+
* ```
|
|
171
|
+
*
|
|
172
|
+
* **Azure Event Grid Stream**
|
|
173
|
+
*
|
|
174
|
+
* For an `Azure Event Grid` Stream, the `sink` properties are listed in the payload below.
|
|
175
|
+
*
|
|
176
|
+
* **Request:**
|
|
177
|
+
* ```json
|
|
178
|
+
* {
|
|
179
|
+
* "name": "string",
|
|
180
|
+
* "type": "eventgrid",
|
|
181
|
+
* "sink": {
|
|
182
|
+
* "azureSubscriptionId": "string",
|
|
183
|
+
* "azureResourceGroup": "string",
|
|
184
|
+
* "azureRegion": "string"
|
|
185
|
+
* }
|
|
186
|
+
* }
|
|
187
|
+
* ```
|
|
188
|
+
*
|
|
189
|
+
* **Response:**
|
|
190
|
+
* ```json
|
|
191
|
+
* {
|
|
192
|
+
* "id": "string",
|
|
193
|
+
* "name": "string",
|
|
194
|
+
* "type": "http",
|
|
195
|
+
* "status": "active",
|
|
196
|
+
* "sink": {
|
|
197
|
+
* "azureSubscriptionId": "string",
|
|
198
|
+
* "azureResourceGroup": "string",
|
|
199
|
+
* "azureRegion": "string",
|
|
200
|
+
* "azurePartnerTopic": "string"
|
|
201
|
+
* }
|
|
202
|
+
* }
|
|
203
|
+
* ```
|
|
204
|
+
*
|
|
205
|
+
* **Datadog Stream**
|
|
206
|
+
*
|
|
207
|
+
* For a `Datadog` Stream, the `sink` properties are listed in the payload below.
|
|
208
|
+
*
|
|
209
|
+
* **Request:**
|
|
210
|
+
* ```json
|
|
211
|
+
* {
|
|
212
|
+
* "name": "string",
|
|
213
|
+
* "type": "datadog",
|
|
214
|
+
* "sink": {
|
|
215
|
+
* "datadogRegion": "string",
|
|
216
|
+
* "datadogApiKey": "string"
|
|
217
|
+
* }
|
|
218
|
+
* }
|
|
219
|
+
* ```
|
|
220
|
+
*
|
|
221
|
+
* **Response:**
|
|
222
|
+
* ```json
|
|
223
|
+
* {
|
|
224
|
+
* "id": "string",
|
|
225
|
+
* "name": "string",
|
|
226
|
+
* "type": "datadog",
|
|
227
|
+
* "status": "active",
|
|
228
|
+
* "sink": {
|
|
229
|
+
* "datadogRegion": "string",
|
|
230
|
+
* "datadogApiKey": "string"
|
|
231
|
+
* }
|
|
232
|
+
* }
|
|
233
|
+
* ```
|
|
234
|
+
*
|
|
235
|
+
* **Splunk Stream**
|
|
236
|
+
*
|
|
237
|
+
* For a `Splunk` Stream, the `sink` properties are listed in the payload below.
|
|
238
|
+
*
|
|
239
|
+
* **Request:**
|
|
240
|
+
* ```json
|
|
241
|
+
* {
|
|
242
|
+
* "name": "string",
|
|
243
|
+
* "type": "splunk",
|
|
244
|
+
* "sink": {
|
|
245
|
+
* "splunkDomain": "string",
|
|
246
|
+
* "splunkToken": "string",
|
|
247
|
+
* "splunkPort": "string",
|
|
248
|
+
* "splunkSecure": "boolean"
|
|
249
|
+
* }
|
|
250
|
+
* }
|
|
251
|
+
* ```
|
|
252
|
+
*
|
|
253
|
+
* **Response:**
|
|
254
|
+
* ```json
|
|
255
|
+
* {
|
|
256
|
+
* "id": "string",
|
|
257
|
+
* "name": "string",
|
|
258
|
+
* "type": "splunk",
|
|
259
|
+
* "status": "active",
|
|
260
|
+
* "sink": {
|
|
261
|
+
* "splunkDomain": "string",
|
|
262
|
+
* "splunkToken": "string",
|
|
263
|
+
* "splunkPort": "string",
|
|
264
|
+
* "splunkSecure": "boolean"
|
|
265
|
+
* }
|
|
266
|
+
* }
|
|
267
|
+
* ```
|
|
268
|
+
*
|
|
269
|
+
* **Sumo Logic Stream**
|
|
270
|
+
*
|
|
271
|
+
* For a `Sumo Logic` Stream, the `sink` properties are listed in the payload below.
|
|
272
|
+
*
|
|
273
|
+
* **Request:**
|
|
274
|
+
* ```json
|
|
275
|
+
* {
|
|
276
|
+
* "name": "string",
|
|
277
|
+
* "type": "sumo",
|
|
278
|
+
* "sink": {
|
|
279
|
+
* "sumoSourceAddress": "string"
|
|
280
|
+
* }
|
|
281
|
+
* }
|
|
282
|
+
* ```
|
|
283
|
+
*
|
|
284
|
+
* **Response:**
|
|
285
|
+
* ```json
|
|
286
|
+
* {
|
|
287
|
+
* "id": "string",
|
|
288
|
+
* "name": "string",
|
|
289
|
+
* "type": "sumo",
|
|
290
|
+
* "status": "active",
|
|
291
|
+
* "sink": {
|
|
292
|
+
* "sumoSourceAddress": "string"
|
|
293
|
+
* }
|
|
294
|
+
* }
|
|
295
|
+
* ```
|
|
220
296
|
*
|
|
221
297
|
* @param {Management.CreateLogStreamRequestContent} request
|
|
222
298
|
* @param {LogStreamsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -239,107 +315,157 @@ export declare class LogStreamsClient {
|
|
|
239
315
|
private __create;
|
|
240
316
|
/**
|
|
241
317
|
* Retrieve a log stream configuration and status.
|
|
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
|
-
*
|
|
318
|
+
*
|
|
319
|
+
* **Sample responses**
|
|
320
|
+
*
|
|
321
|
+
* **Amazon EventBridge Log Stream**
|
|
322
|
+
*
|
|
323
|
+
* ```json
|
|
324
|
+
* {
|
|
325
|
+
* "id": "string",
|
|
326
|
+
* "name": "string",
|
|
327
|
+
* "type": "eventbridge",
|
|
328
|
+
* "status": "active|paused|suspended",
|
|
329
|
+
* "sink": {
|
|
330
|
+
* "awsAccountId": "string",
|
|
331
|
+
* "awsRegion": "string",
|
|
332
|
+
* "awsPartnerEventSource": "string"
|
|
333
|
+
* }
|
|
334
|
+
* }
|
|
335
|
+
* ```
|
|
336
|
+
*
|
|
337
|
+
* **HTTP Log Stream**
|
|
338
|
+
*
|
|
339
|
+
* ```json
|
|
340
|
+
* {
|
|
341
|
+
* "id": "string",
|
|
342
|
+
* "name": "string",
|
|
343
|
+
* "type": "http",
|
|
344
|
+
* "status": "active|paused|suspended",
|
|
345
|
+
* "sink": {
|
|
346
|
+
* "httpContentFormat": "JSONLINES|JSONARRAY",
|
|
347
|
+
* "httpContentType": "string",
|
|
348
|
+
* "httpEndpoint": "string",
|
|
349
|
+
* "httpAuthorization": "string"
|
|
350
|
+
* }
|
|
351
|
+
* }
|
|
352
|
+
* ```
|
|
353
|
+
*
|
|
354
|
+
* **Datadog Log Stream**
|
|
355
|
+
*
|
|
356
|
+
* ```json
|
|
357
|
+
* {
|
|
358
|
+
* "id": "string",
|
|
359
|
+
* "name": "string",
|
|
360
|
+
* "type": "datadog",
|
|
361
|
+
* "status": "active|paused|suspended",
|
|
362
|
+
* "sink": {
|
|
363
|
+
* "datadogRegion": "string",
|
|
364
|
+
* "datadogApiKey": "string"
|
|
365
|
+
* }
|
|
366
|
+
* }
|
|
367
|
+
* ```
|
|
368
|
+
*
|
|
369
|
+
* **Mixpanel**
|
|
370
|
+
*
|
|
371
|
+
* **Request:**
|
|
372
|
+
*
|
|
373
|
+
* ```json
|
|
374
|
+
* {
|
|
375
|
+
* "name": "string",
|
|
376
|
+
* "type": "mixpanel",
|
|
377
|
+
* "sink": {
|
|
378
|
+
* "mixpanelRegion": "string",
|
|
379
|
+
* "mixpanelProjectId": "string",
|
|
380
|
+
* "mixpanelServiceAccountUsername": "string",
|
|
381
|
+
* "mixpanelServiceAccountPassword": "string"
|
|
382
|
+
* }
|
|
383
|
+
* }
|
|
384
|
+
* ```
|
|
385
|
+
*
|
|
386
|
+
* **Response:**
|
|
387
|
+
*
|
|
388
|
+
* ```json
|
|
389
|
+
* {
|
|
390
|
+
* "id": "string",
|
|
391
|
+
* "name": "string",
|
|
392
|
+
* "type": "mixpanel",
|
|
393
|
+
* "status": "active",
|
|
394
|
+
* "sink": {
|
|
395
|
+
* "mixpanelRegion": "string",
|
|
396
|
+
* "mixpanelProjectId": "string",
|
|
397
|
+
* "mixpanelServiceAccountUsername": "string",
|
|
398
|
+
* "mixpanelServiceAccountPassword": "string"
|
|
399
|
+
* }
|
|
400
|
+
* }
|
|
401
|
+
* ```
|
|
402
|
+
*
|
|
403
|
+
* **Segment**
|
|
404
|
+
*
|
|
405
|
+
* **Request:**
|
|
406
|
+
*
|
|
407
|
+
* ```json
|
|
408
|
+
* {
|
|
409
|
+
* "name": "string",
|
|
410
|
+
* "type": "segment",
|
|
411
|
+
* "sink": {
|
|
412
|
+
* "segmentWriteKey": "string"
|
|
413
|
+
* }
|
|
414
|
+
* }
|
|
415
|
+
* ```
|
|
416
|
+
*
|
|
417
|
+
* **Response:**
|
|
418
|
+
*
|
|
419
|
+
* ```json
|
|
420
|
+
* {
|
|
421
|
+
* "id": "string",
|
|
422
|
+
* "name": "string",
|
|
423
|
+
* "type": "segment",
|
|
424
|
+
* "status": "active",
|
|
425
|
+
* "sink": {
|
|
426
|
+
* "segmentWriteKey": "string"
|
|
427
|
+
* }
|
|
428
|
+
* }
|
|
429
|
+
* ```
|
|
430
|
+
*
|
|
431
|
+
* **Splunk Log Stream**
|
|
432
|
+
*
|
|
433
|
+
* ```json
|
|
434
|
+
* {
|
|
435
|
+
* "id": "string",
|
|
436
|
+
* "name": "string",
|
|
437
|
+
* "type": "splunk",
|
|
438
|
+
* "status": "active|paused|suspended",
|
|
439
|
+
* "sink": {
|
|
440
|
+
* "splunkDomain": "string",
|
|
441
|
+
* "splunkToken": "string",
|
|
442
|
+
* "splunkPort": "string",
|
|
443
|
+
* "splunkSecure": "boolean"
|
|
444
|
+
* }
|
|
445
|
+
* }
|
|
446
|
+
* ```
|
|
447
|
+
*
|
|
448
|
+
* **Sumo Logic Log Stream**
|
|
449
|
+
*
|
|
450
|
+
* ```json
|
|
451
|
+
* {
|
|
452
|
+
* "id": "string",
|
|
453
|
+
* "name": "string",
|
|
454
|
+
* "type": "sumo",
|
|
455
|
+
* "status": "active|paused|suspended",
|
|
456
|
+
* "sink": {
|
|
457
|
+
* "sumoSourceAddress": "string"
|
|
458
|
+
* }
|
|
459
|
+
* }
|
|
460
|
+
* ```
|
|
461
|
+
*
|
|
462
|
+
* **Status**
|
|
463
|
+
*
|
|
464
|
+
* The `status` of a log stream maybe any of the following:
|
|
465
|
+
*
|
|
466
|
+
* 1. `active` - Stream is currently enabled.
|
|
467
|
+
* 2. `paused` - Stream is currently user disabled and will not attempt log delivery.
|
|
468
|
+
* 3. `suspended` - Stream is currently disabled because of errors and will not attempt log delivery.
|
|
343
469
|
*
|
|
344
470
|
* @param {string} id - The id of the log stream to get
|
|
345
471
|
* @param {LogStreamsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -373,40 +499,79 @@ export declare class LogStreamsClient {
|
|
|
373
499
|
private __delete;
|
|
374
500
|
/**
|
|
375
501
|
* Update a log stream.
|
|
376
|
-
*
|
|
377
|
-
*
|
|
378
|
-
*
|
|
379
|
-
*
|
|
380
|
-
*
|
|
381
|
-
*
|
|
382
|
-
*
|
|
383
|
-
*
|
|
502
|
+
*
|
|
503
|
+
* **Examples of how to use the PATCH endpoint.**
|
|
504
|
+
*
|
|
505
|
+
* The following fields may be updated in a PATCH operation:
|
|
506
|
+
*
|
|
507
|
+
* - name
|
|
508
|
+
* - status
|
|
509
|
+
* - sink
|
|
510
|
+
*
|
|
511
|
+
* Note: For log streams of type `eventbridge` and `eventgrid`, updating the `sink` is not permitted.
|
|
512
|
+
*
|
|
513
|
+
* **Update the status of a log stream**
|
|
514
|
+
*
|
|
515
|
+
* ```json
|
|
516
|
+
* {
|
|
517
|
+
* "status": "active|paused"
|
|
518
|
+
* }
|
|
519
|
+
* ```
|
|
520
|
+
*
|
|
521
|
+
* **Update the name of a log stream**
|
|
522
|
+
*
|
|
523
|
+
* ```json
|
|
524
|
+
* {
|
|
525
|
+
* "name": "string"
|
|
526
|
+
* }
|
|
527
|
+
* ```
|
|
528
|
+
*
|
|
529
|
+
* **Update the sink properties of a stream of type `http`**
|
|
530
|
+
*
|
|
531
|
+
* ```json
|
|
532
|
+
* {
|
|
384
533
|
* "sink": {
|
|
385
534
|
* "httpEndpoint": "string",
|
|
386
535
|
* "httpContentType": "string",
|
|
387
536
|
* "httpContentFormat": "JSONARRAY|JSONLINES",
|
|
388
537
|
* "httpAuthorization": "string"
|
|
389
538
|
* }
|
|
390
|
-
* }
|
|
391
|
-
*
|
|
539
|
+
* }
|
|
540
|
+
* ```
|
|
541
|
+
*
|
|
542
|
+
* **Update the sink properties of a stream of type `datadog`**
|
|
543
|
+
*
|
|
544
|
+
* ```json
|
|
545
|
+
* {
|
|
392
546
|
* "sink": {
|
|
393
|
-
*
|
|
394
|
-
*
|
|
547
|
+
* "datadogRegion": "string",
|
|
548
|
+
* "datadogApiKey": "string"
|
|
395
549
|
* }
|
|
396
|
-
* }
|
|
397
|
-
*
|
|
550
|
+
* }
|
|
551
|
+
* ```
|
|
552
|
+
*
|
|
553
|
+
* **Update the sink properties of a stream of type `splunk`**
|
|
554
|
+
*
|
|
555
|
+
* ```json
|
|
556
|
+
* {
|
|
398
557
|
* "sink": {
|
|
399
558
|
* "splunkDomain": "string",
|
|
400
559
|
* "splunkToken": "string",
|
|
401
560
|
* "splunkPort": "string",
|
|
402
561
|
* "splunkSecure": "boolean"
|
|
403
562
|
* }
|
|
404
|
-
* }
|
|
405
|
-
*
|
|
563
|
+
* }
|
|
564
|
+
* ```
|
|
565
|
+
*
|
|
566
|
+
* **Update the sink properties of a stream of type `sumo`**
|
|
567
|
+
*
|
|
568
|
+
* ```json
|
|
569
|
+
* {
|
|
406
570
|
* "sink": {
|
|
407
571
|
* "sumoSourceAddress": "string"
|
|
408
572
|
* }
|
|
409
|
-
* }
|
|
573
|
+
* }
|
|
574
|
+
* ```
|
|
410
575
|
*
|
|
411
576
|
* @param {string} id - The id of the log stream to get
|
|
412
577
|
* @param {Management.UpdateLogStreamRequestContent} request
|