cribl-control-plane 0.4.0 → 0.5.0-alpha.1
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/README.md +75 -27
- package/dist/commonjs/lib/config.d.ts +4 -4
- package/dist/commonjs/lib/config.js +4 -4
- package/dist/commonjs/lib/config.js.map +1 -1
- package/dist/commonjs/models/runnablejobcollection.d.ts +37 -37
- package/dist/commonjs/models/runnablejobcollection.d.ts.map +1 -1
- package/dist/commonjs/models/runnablejobexecutor.d.ts +21 -21
- package/dist/commonjs/models/runnablejobexecutor.d.ts.map +1 -1
- package/dist/commonjs/models/runnablejobscheduledsearch.d.ts +16 -16
- package/dist/commonjs/models/runnablejobscheduledsearch.d.ts.map +1 -1
- package/dist/esm/lib/config.d.ts +4 -4
- package/dist/esm/lib/config.js +4 -4
- package/dist/esm/lib/config.js.map +1 -1
- package/dist/esm/models/runnablejobcollection.d.ts +37 -37
- package/dist/esm/models/runnablejobcollection.d.ts.map +1 -1
- package/dist/esm/models/runnablejobexecutor.d.ts +21 -21
- package/dist/esm/models/runnablejobexecutor.d.ts.map +1 -1
- package/dist/esm/models/runnablejobscheduledsearch.d.ts +16 -16
- package/dist/esm/models/runnablejobscheduledsearch.d.ts.map +1 -1
- package/examples/example-cloud-auth.ts +13 -13
- package/examples/example-cloud-search-packs-lake.ts +2 -2
- package/examples/example-cloud-worker-group.ts +4 -4
- package/examples/example-edge.ts +1 -2
- package/examples/example-onprem-auth.ts +20 -57
- package/examples/example-stream.ts +1 -2
- package/examples/example-worker-group-replication.ts +1 -2
- package/examples/package-lock.json +1 -1
- package/jsr.json +1 -1
- package/package.json +1 -1
- package/src/lib/config.ts +4 -4
- package/src/models/runnablejobcollection.ts +37 -37
- package/src/models/runnablejobexecutor.ts +21 -21
- package/src/models/runnablejobscheduledsearch.ts +16 -16
package/README.md
CHANGED
|
@@ -1,18 +1,9 @@
|
|
|
1
1
|
# cribl-control-plane-sdk-typescript
|
|
2
|
+
<!-- Start Summary [summary] -->
|
|
3
|
+
## Summary
|
|
2
4
|
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
In addition to the usage examples in this repository, you can adapt the [code examples for common use cases](https://docs.cribl.io/cribl-as-code/code-examples) in the Cribl documentation to use TypeScript instead of Python.
|
|
6
|
-
|
|
7
|
-
Complementary API reference documentation is available at https://docs.cribl.io/cribl-as-code/api-reference. Product documentation is available at https://docs.cribl.io.
|
|
8
|
-
|
|
9
|
-
> [!IMPORTANT]
|
|
10
|
-
> **Preview Feature**
|
|
11
|
-
> The Cribl SDKs are Preview features that are still being developed. We do not recommend using them in a production environment, because the features might not be fully tested or optimized for performance, and related documentation could be incomplete.
|
|
12
|
-
>
|
|
13
|
-
> Please continue to submit feedback through normal Cribl support channels, but assistance might be limited while the features remain in Preview.
|
|
14
|
-
|
|
15
|
-
<!-- No Summary [summary] -->
|
|
5
|
+
Cribl API Reference: This API Reference lists available REST endpoints, along with their supported operations for accessing, creating, updating, or deleting resources. See our complementary product documentation at [docs.cribl.io](http://docs.cribl.io).
|
|
6
|
+
<!-- End Summary [summary] -->
|
|
16
7
|
|
|
17
8
|
<!-- Start Table of Contents [toc] -->
|
|
18
9
|
## Table of Contents
|
|
@@ -151,14 +142,9 @@ run();
|
|
|
151
142
|
```
|
|
152
143
|
<!-- End SDK Example Usage [usage] -->
|
|
153
144
|
|
|
145
|
+
<!-- Start Authentication [security] -->
|
|
154
146
|
## Authentication
|
|
155
147
|
|
|
156
|
-
Except for the `health.get` and `auth.tokens.get` methods, all Cribl SDK requests require you to authenticate with a Bearer token. You must include a valid Bearer token in the configuration when initializing your SDK client. The Bearer token verifies your identity and ensures secure access to the requested resources. The SDK automatically manages the `Authorization` header for subsequent requests once properly authenticated.
|
|
157
|
-
|
|
158
|
-
For information about Bearer token expiration, see [Token Management](https://docs.cribl.io/cribl-as-code/sdks-auth/#sdks-token-mgmt) in the Cribl as Code documentation.
|
|
159
|
-
|
|
160
|
-
**Authentication happens once during SDK initialization**. After you initialize the SDK client with authentication as shown in the [authentication examples](#authentication-examples), the SDK automatically handles authentication for all subsequent API calls. You do not need to include authentication parameters in individual API requests. The [SDK Example Usage](#sdk-example-usage) section shows how to initialize the SDK and make API calls, but if you've properly initialized your client as shown in the authentication examples, you only need to make the API method calls themselves without re-initializing.
|
|
161
|
-
|
|
162
148
|
### Per-Client Security Schemes
|
|
163
149
|
|
|
164
150
|
This SDK supports the following security schemes globally:
|
|
@@ -168,19 +154,81 @@ This SDK supports the following security schemes globally:
|
|
|
168
154
|
| `bearerAuth` | http | HTTP Bearer | `CRIBLCONTROLPLANE_BEARER_AUTH` |
|
|
169
155
|
| `clientOauth` | oauth2 | OAuth2 token | `CRIBLCONTROLPLANE_CLIENT_OAUTH` |
|
|
170
156
|
|
|
171
|
-
|
|
172
|
-
|
|
173
|
-
|
|
157
|
+
You can set the security parameters through the `security` optional parameter when initializing the SDK client instance. The selected scheme will be used by default to authenticate with the API for all operations that support it. For example:
|
|
158
|
+
```typescript
|
|
159
|
+
import { CriblControlPlane } from "cribl-control-plane";
|
|
174
160
|
|
|
175
|
-
|
|
161
|
+
const criblControlPlane = new CriblControlPlane({
|
|
162
|
+
serverURL: "https://api.example.com",
|
|
163
|
+
security: {
|
|
164
|
+
bearerAuth: process.env["CRIBLCONTROLPLANE_BEARER_AUTH"] ?? "",
|
|
165
|
+
},
|
|
166
|
+
});
|
|
176
167
|
|
|
177
|
-
|
|
168
|
+
async function run() {
|
|
169
|
+
const result = await criblControlPlane.lakeDatasets.create({
|
|
170
|
+
lakeId: "<id>",
|
|
171
|
+
criblLakeDataset: {
|
|
172
|
+
acceleratedFields: [
|
|
173
|
+
"<value 1>",
|
|
174
|
+
"<value 2>",
|
|
175
|
+
],
|
|
176
|
+
bucketName: "<value>",
|
|
177
|
+
cacheConnection: {
|
|
178
|
+
acceleratedFields: [
|
|
179
|
+
"<value 1>",
|
|
180
|
+
"<value 2>",
|
|
181
|
+
],
|
|
182
|
+
backfillStatus: "pending",
|
|
183
|
+
cacheRef: "<value>",
|
|
184
|
+
createdAt: 7795.06,
|
|
185
|
+
lakehouseConnectionType: "cache",
|
|
186
|
+
migrationQueryId: "<id>",
|
|
187
|
+
retentionInDays: 1466.58,
|
|
188
|
+
},
|
|
189
|
+
deletionStartedAt: 8310.58,
|
|
190
|
+
description:
|
|
191
|
+
"pleased toothbrush long brush smooth swiftly rightfully phooey chapel",
|
|
192
|
+
format: "ddss",
|
|
193
|
+
httpDAUsed: true,
|
|
194
|
+
id: "<id>",
|
|
195
|
+
metrics: {
|
|
196
|
+
currentSizeBytes: 6170.04,
|
|
197
|
+
metricsDate: "<value>",
|
|
198
|
+
},
|
|
199
|
+
retentionPeriodInDays: 456.37,
|
|
200
|
+
searchConfig: {
|
|
201
|
+
datatypes: [
|
|
202
|
+
"<value 1>",
|
|
203
|
+
],
|
|
204
|
+
metadata: {
|
|
205
|
+
earliest: "<value>",
|
|
206
|
+
enableAcceleration: true,
|
|
207
|
+
fieldList: [
|
|
208
|
+
"<value 1>",
|
|
209
|
+
"<value 2>",
|
|
210
|
+
],
|
|
211
|
+
latestRunInfo: {
|
|
212
|
+
earliestScannedTime: 4334.7,
|
|
213
|
+
finishedAt: 6811.22,
|
|
214
|
+
latestScannedTime: 5303.3,
|
|
215
|
+
objectCount: 9489.04,
|
|
216
|
+
},
|
|
217
|
+
scanMode: "detailed",
|
|
218
|
+
},
|
|
219
|
+
},
|
|
220
|
+
storageLocationId: "<id>",
|
|
221
|
+
viewName: "<value>",
|
|
222
|
+
},
|
|
223
|
+
});
|
|
178
224
|
|
|
179
|
-
|
|
225
|
+
console.log(result);
|
|
226
|
+
}
|
|
180
227
|
|
|
181
|
-
|
|
228
|
+
run();
|
|
182
229
|
|
|
183
|
-
|
|
230
|
+
```
|
|
231
|
+
<!-- End Authentication [security] -->
|
|
184
232
|
|
|
185
233
|
<!-- Start Available Resources and Operations [operations] -->
|
|
186
234
|
## Available Resources and Operations
|
|
@@ -34,9 +34,9 @@ export type SDKOptions = {
|
|
|
34
34
|
export declare function serverURLFromOptions(options: SDKOptions): URL | null;
|
|
35
35
|
export declare const SDK_METADATA: {
|
|
36
36
|
readonly language: "typescript";
|
|
37
|
-
readonly openapiDocVersion: "4.15.1-
|
|
38
|
-
readonly sdkVersion: "0.
|
|
39
|
-
readonly genVersion: "2.
|
|
40
|
-
readonly userAgent: "speakeasy-sdk/typescript 0.
|
|
37
|
+
readonly openapiDocVersion: "4.15.1-alpha.1765407756960-5c02a009";
|
|
38
|
+
readonly sdkVersion: "0.5.0-alpha.1";
|
|
39
|
+
readonly genVersion: "2.791.1";
|
|
40
|
+
readonly userAgent: "speakeasy-sdk/typescript 0.5.0-alpha.1 2.791.1 4.15.1-alpha.1765407756960-5c02a009 cribl-control-plane";
|
|
41
41
|
};
|
|
42
42
|
//# sourceMappingURL=config.d.ts.map
|
|
@@ -27,9 +27,9 @@ function serverURLFromOptions(options) {
|
|
|
27
27
|
}
|
|
28
28
|
exports.SDK_METADATA = {
|
|
29
29
|
language: "typescript",
|
|
30
|
-
openapiDocVersion: "4.15.1-
|
|
31
|
-
sdkVersion: "0.
|
|
32
|
-
genVersion: "2.
|
|
33
|
-
userAgent: "speakeasy-sdk/typescript 0.
|
|
30
|
+
openapiDocVersion: "4.15.1-alpha.1765407756960-5c02a009",
|
|
31
|
+
sdkVersion: "0.5.0-alpha.1",
|
|
32
|
+
genVersion: "2.791.1",
|
|
33
|
+
userAgent: "speakeasy-sdk/typescript 0.5.0-alpha.1 2.791.1 4.15.1-alpha.1765407756960-5c02a009 cribl-control-plane",
|
|
34
34
|
};
|
|
35
35
|
//# sourceMappingURL=config.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"config.js","sourceRoot":"","sources":["../../../src/lib/config.ts"],"names":[],"mappings":";AAAA;;GAEG;;;AA0CH,oDAeC;AAnDD,qCAA8C;AAE9C;;GAEG;AACU,QAAA,UAAU,GAAG;IACxB,GAAG;CACK,CAAC;AA6BX,SAAgB,oBAAoB,CAAC,OAAmB;IACtD,IAAI,SAAS,GAAG,OAAO,CAAC,SAAS,CAAC;IAElC,MAAM,MAAM,GAAW,EAAE,CAAC;IAE1B,IAAI,CAAC,SAAS,EAAE,CAAC;QACf,MAAM,SAAS,GAAG,OAAO,CAAC,SAAS,IAAI,CAAC,CAAC;QACzC,IAAI,SAAS,GAAG,CAAC,IAAI,SAAS,IAAI,kBAAU,CAAC,MAAM,EAAE,CAAC;YACpD,MAAM,IAAI,KAAK,CAAC,wBAAwB,SAAS,EAAE,CAAC,CAAC;QACvD,CAAC;QACD,SAAS,GAAG,kBAAU,CAAC,SAAS,CAAC,IAAI,EAAE,CAAC;IAC1C,CAAC;IAED,MAAM,CAAC,GAAG,IAAA,mBAAU,EAAC,SAAS,CAAC,CAAC,MAAM,CAAC,CAAC;IACxC,OAAO,IAAI,GAAG,CAAC,CAAC,CAAC,CAAC;AACpB,CAAC;AAEY,QAAA,YAAY,GAAG;IAC1B,QAAQ,EAAE,YAAY;IACtB,iBAAiB,EAAE,
|
|
1
|
+
{"version":3,"file":"config.js","sourceRoot":"","sources":["../../../src/lib/config.ts"],"names":[],"mappings":";AAAA;;GAEG;;;AA0CH,oDAeC;AAnDD,qCAA8C;AAE9C;;GAEG;AACU,QAAA,UAAU,GAAG;IACxB,GAAG;CACK,CAAC;AA6BX,SAAgB,oBAAoB,CAAC,OAAmB;IACtD,IAAI,SAAS,GAAG,OAAO,CAAC,SAAS,CAAC;IAElC,MAAM,MAAM,GAAW,EAAE,CAAC;IAE1B,IAAI,CAAC,SAAS,EAAE,CAAC;QACf,MAAM,SAAS,GAAG,OAAO,CAAC,SAAS,IAAI,CAAC,CAAC;QACzC,IAAI,SAAS,GAAG,CAAC,IAAI,SAAS,IAAI,kBAAU,CAAC,MAAM,EAAE,CAAC;YACpD,MAAM,IAAI,KAAK,CAAC,wBAAwB,SAAS,EAAE,CAAC,CAAC;QACvD,CAAC;QACD,SAAS,GAAG,kBAAU,CAAC,SAAS,CAAC,IAAI,EAAE,CAAC;IAC1C,CAAC;IAED,MAAM,CAAC,GAAG,IAAA,mBAAU,EAAC,SAAS,CAAC,CAAC,MAAM,CAAC,CAAC;IACxC,OAAO,IAAI,GAAG,CAAC,CAAC,CAAC,CAAC;AACpB,CAAC;AAEY,QAAA,YAAY,GAAG;IAC1B,QAAQ,EAAE,YAAY;IACtB,iBAAiB,EAAE,qCAAqC;IACxD,UAAU,EAAE,eAAe;IAC3B,UAAU,EAAE,SAAS;IACrB,SAAS,EACP,wGAAwG;CAClG,CAAC"}
|
|
@@ -32,24 +32,24 @@ export type RunnableJobCollectionRunSettings = {
|
|
|
32
32
|
/**
|
|
33
33
|
* Reschedule tasks that failed with non-fatal errors
|
|
34
34
|
*/
|
|
35
|
-
rescheduleDroppedTasks
|
|
35
|
+
rescheduleDroppedTasks: boolean;
|
|
36
36
|
/**
|
|
37
37
|
* Maximum number of times a task can be rescheduled
|
|
38
38
|
*/
|
|
39
|
-
maxTaskReschedule
|
|
39
|
+
maxTaskReschedule: number;
|
|
40
40
|
/**
|
|
41
41
|
* Level at which to set task logging
|
|
42
42
|
*/
|
|
43
|
-
logLevel
|
|
43
|
+
logLevel: RunnableJobCollectionScheduleLogLevel;
|
|
44
44
|
/**
|
|
45
45
|
* Maximum time the job is allowed to run. Time unit defaults to seconds if not specified (examples: 30, 45s, 15m). Enter 0 for unlimited time.
|
|
46
46
|
*/
|
|
47
|
-
jobTimeout
|
|
47
|
+
jobTimeout: string;
|
|
48
48
|
/**
|
|
49
49
|
* Job run mode. Preview will either return up to N matching results, or will run until capture time T is reached. Discovery will gather the list of files to turn into streaming tasks, without running the data collection job. Full Run will run the collection job.
|
|
50
50
|
*/
|
|
51
|
-
mode
|
|
52
|
-
timeRangeType
|
|
51
|
+
mode: string;
|
|
52
|
+
timeRangeType: string;
|
|
53
53
|
/**
|
|
54
54
|
* Earliest time to collect data for the selected timezone
|
|
55
55
|
*/
|
|
@@ -63,7 +63,7 @@ export type RunnableJobCollectionRunSettings = {
|
|
|
63
63
|
/**
|
|
64
64
|
* A filter for tokens in the provided collect path and/or the events being collected
|
|
65
65
|
*/
|
|
66
|
-
expression
|
|
66
|
+
expression: string;
|
|
67
67
|
/**
|
|
68
68
|
* Limits the bundle size for small tasks. For example,
|
|
69
69
|
*
|
|
@@ -71,7 +71,7 @@ export type RunnableJobCollectionRunSettings = {
|
|
|
71
71
|
*
|
|
72
72
|
* if your lower bundle size is 1MB, you can bundle up to five 200KB files into one task.
|
|
73
73
|
*/
|
|
74
|
-
minTaskSize
|
|
74
|
+
minTaskSize: string;
|
|
75
75
|
/**
|
|
76
76
|
* Limits the bundle size for files above the lower task bundle size. For example, if your upper bundle size is 10MB,
|
|
77
77
|
*
|
|
@@ -79,7 +79,7 @@ export type RunnableJobCollectionRunSettings = {
|
|
|
79
79
|
*
|
|
80
80
|
* you can bundle up to five 2MB files into one task. Files greater than this size will be assigned to individual tasks.
|
|
81
81
|
*/
|
|
82
|
-
maxTaskSize
|
|
82
|
+
maxTaskSize: string;
|
|
83
83
|
};
|
|
84
84
|
/**
|
|
85
85
|
* Configuration for a scheduled job
|
|
@@ -92,19 +92,19 @@ export type RunnableJobCollectionSchedule = {
|
|
|
92
92
|
/**
|
|
93
93
|
* Skippable jobs can be delayed, up to their next run time, if the system is hitting concurrency limits
|
|
94
94
|
*/
|
|
95
|
-
skippable
|
|
95
|
+
skippable: boolean;
|
|
96
96
|
/**
|
|
97
97
|
* If Stream Leader (or single instance) restarts, run all missed jobs according to their original schedules
|
|
98
98
|
*/
|
|
99
|
-
resumeMissed
|
|
99
|
+
resumeMissed: boolean;
|
|
100
100
|
/**
|
|
101
101
|
* A cron schedule on which to run this job
|
|
102
102
|
*/
|
|
103
|
-
cronSchedule
|
|
103
|
+
cronSchedule: string;
|
|
104
104
|
/**
|
|
105
105
|
* The maximum number of instances of this scheduled job that may be running at any time
|
|
106
106
|
*/
|
|
107
|
-
maxConcurrentRuns
|
|
107
|
+
maxConcurrentRuns: number;
|
|
108
108
|
run?: RunnableJobCollectionRunSettings | undefined;
|
|
109
109
|
};
|
|
110
110
|
export type CollectorSpecificSettings = {};
|
|
@@ -117,7 +117,7 @@ export type Collector = {
|
|
|
117
117
|
/**
|
|
118
118
|
* Delete any files collected (where applicable)
|
|
119
119
|
*/
|
|
120
|
-
destructive
|
|
120
|
+
destructive: boolean;
|
|
121
121
|
/**
|
|
122
122
|
* Character encoding to use when parsing ingested data. When not set, @{product} will default to UTF-8 but may incorrectly interpret multi-byte characters.
|
|
123
123
|
*/
|
|
@@ -128,7 +128,7 @@ export declare const InputType: {
|
|
|
128
128
|
};
|
|
129
129
|
export type InputType = OpenEnum<typeof InputType>;
|
|
130
130
|
export type RunnableJobCollectionPreprocess = {
|
|
131
|
-
disabled
|
|
131
|
+
disabled: boolean;
|
|
132
132
|
/**
|
|
133
133
|
* Command to feed the data through (via stdin) and process its output (stdout)
|
|
134
134
|
*/
|
|
@@ -146,7 +146,7 @@ export type RunnableJobCollectionMetadatum = {
|
|
|
146
146
|
value: string;
|
|
147
147
|
};
|
|
148
148
|
export type RunnableJobCollectionInput = {
|
|
149
|
-
type
|
|
149
|
+
type: InputType;
|
|
150
150
|
/**
|
|
151
151
|
* A list of event-breaking rulesets that will be applied, in order, to the input data stream
|
|
152
152
|
*/
|
|
@@ -154,16 +154,16 @@ export type RunnableJobCollectionInput = {
|
|
|
154
154
|
/**
|
|
155
155
|
* How long (in milliseconds) the Event Breaker will wait for new data to be sent to a specific channel before flushing the data stream out, as is, to the Pipelines
|
|
156
156
|
*/
|
|
157
|
-
staleChannelFlushMs
|
|
157
|
+
staleChannelFlushMs: number;
|
|
158
158
|
/**
|
|
159
159
|
* Send events to normal routing and event processing. Disable to select a specific Pipeline/Destination combination.
|
|
160
160
|
*/
|
|
161
|
-
sendToRoutes
|
|
161
|
+
sendToRoutes: boolean;
|
|
162
162
|
preprocess?: RunnableJobCollectionPreprocess | undefined;
|
|
163
163
|
/**
|
|
164
164
|
* Rate (in bytes per second) to throttle while writing to an output. Accepts values with multiple-byte units, such as KB, MB, and GB. (Example: 42 MB) Default value of 0 specifies no throttling.
|
|
165
165
|
*/
|
|
166
|
-
throttleRatePerSec
|
|
166
|
+
throttleRatePerSec: string;
|
|
167
167
|
/**
|
|
168
168
|
* Fields to add to events from this input
|
|
169
169
|
*/
|
|
@@ -232,35 +232,35 @@ export type CaptureSettings = {
|
|
|
232
232
|
/**
|
|
233
233
|
* Amount of time to keep capture open, in seconds
|
|
234
234
|
*/
|
|
235
|
-
duration
|
|
235
|
+
duration: number;
|
|
236
236
|
/**
|
|
237
237
|
* Maximum number of events to capture
|
|
238
238
|
*/
|
|
239
|
-
maxEvents
|
|
240
|
-
level
|
|
239
|
+
maxEvents: number;
|
|
240
|
+
level: WhereToCapture;
|
|
241
241
|
};
|
|
242
242
|
export type RunnableJobCollectionRun = {
|
|
243
243
|
/**
|
|
244
244
|
* Reschedule tasks that failed with non-fatal errors
|
|
245
245
|
*/
|
|
246
|
-
rescheduleDroppedTasks
|
|
246
|
+
rescheduleDroppedTasks: boolean;
|
|
247
247
|
/**
|
|
248
248
|
* Maximum number of times a task can be rescheduled
|
|
249
249
|
*/
|
|
250
|
-
maxTaskReschedule
|
|
250
|
+
maxTaskReschedule: number;
|
|
251
251
|
/**
|
|
252
252
|
* Level at which to set task logging
|
|
253
253
|
*/
|
|
254
|
-
logLevel
|
|
254
|
+
logLevel: RunnableJobCollectionLogLevel;
|
|
255
255
|
/**
|
|
256
256
|
* Maximum time the job is allowed to run. Time unit defaults to seconds if not specified (examples: 30, 45s, 15m). Enter 0 for unlimited time.
|
|
257
257
|
*/
|
|
258
|
-
jobTimeout
|
|
258
|
+
jobTimeout: string;
|
|
259
259
|
/**
|
|
260
260
|
* Job run mode. Preview will either return up to N matching results, or will run until capture time T is reached. Discovery will gather the list of files to turn into streaming tasks, without running the data collection job. Full Run will run the collection job.
|
|
261
261
|
*/
|
|
262
|
-
mode
|
|
263
|
-
timeRangeType
|
|
262
|
+
mode: RunnableJobCollectionMode;
|
|
263
|
+
timeRangeType: TimeRange;
|
|
264
264
|
/**
|
|
265
265
|
* Earliest time to collect data for the selected timezone
|
|
266
266
|
*/
|
|
@@ -272,12 +272,12 @@ export type RunnableJobCollectionRun = {
|
|
|
272
272
|
/**
|
|
273
273
|
* Timezone to use for Earliest and Latest times
|
|
274
274
|
*/
|
|
275
|
-
timestampTimezone
|
|
275
|
+
timestampTimezone: string;
|
|
276
276
|
timeWarning?: RunnableJobCollectionTimeWarning | undefined;
|
|
277
277
|
/**
|
|
278
278
|
* A filter for tokens in the provided collect path and/or the events being collected
|
|
279
279
|
*/
|
|
280
|
-
expression
|
|
280
|
+
expression: string;
|
|
281
281
|
/**
|
|
282
282
|
* Limits the bundle size for small tasks. For example,
|
|
283
283
|
*
|
|
@@ -285,7 +285,7 @@ export type RunnableJobCollectionRun = {
|
|
|
285
285
|
*
|
|
286
286
|
* if your lower bundle size is 1MB, you can bundle up to five 200KB files into one task.
|
|
287
287
|
*/
|
|
288
|
-
minTaskSize
|
|
288
|
+
minTaskSize: string;
|
|
289
289
|
/**
|
|
290
290
|
* Limits the bundle size for files above the lower task bundle size. For example, if your upper bundle size is 10MB,
|
|
291
291
|
*
|
|
@@ -293,11 +293,11 @@ export type RunnableJobCollectionRun = {
|
|
|
293
293
|
*
|
|
294
294
|
* you can bundle up to five 2MB files into one task. Files greater than this size will be assigned to individual tasks.
|
|
295
295
|
*/
|
|
296
|
-
maxTaskSize
|
|
296
|
+
maxTaskSize: string;
|
|
297
297
|
/**
|
|
298
298
|
* Send discover results to Routes
|
|
299
299
|
*/
|
|
300
|
-
discoverToRoutes
|
|
300
|
+
discoverToRoutes: boolean;
|
|
301
301
|
capture?: CaptureSettings | undefined;
|
|
302
302
|
};
|
|
303
303
|
export type RunnableJobCollection = {
|
|
@@ -310,11 +310,11 @@ export type RunnableJobCollection = {
|
|
|
310
310
|
/**
|
|
311
311
|
* Time to keep the job's artifacts on disk after job completion. This also affects how long a job is listed in the Job Inspector.
|
|
312
312
|
*/
|
|
313
|
-
ttl
|
|
313
|
+
ttl: string;
|
|
314
314
|
/**
|
|
315
315
|
* When enabled, this job's artifacts are not counted toward the Worker Group's finished job artifacts limit. Artifacts will be removed only after the Collector's configured time to live.
|
|
316
316
|
*/
|
|
317
|
-
ignoreGroupJobsLimit
|
|
317
|
+
ignoreGroupJobsLimit: boolean;
|
|
318
318
|
/**
|
|
319
319
|
* List of fields to remove from Discover results. Wildcards (for example, aws*) are allowed. This is useful when discovery returns sensitive fields that should not be exposed in the Jobs user interface.
|
|
320
320
|
*/
|
|
@@ -322,7 +322,7 @@ export type RunnableJobCollection = {
|
|
|
322
322
|
/**
|
|
323
323
|
* Resume the ad hoc job if a failure condition causes Stream to restart during job execution
|
|
324
324
|
*/
|
|
325
|
-
resumeOnBoot
|
|
325
|
+
resumeOnBoot: boolean;
|
|
326
326
|
/**
|
|
327
327
|
* Optionally, enable this config only on a specified Git branch. If empty, will be enabled everywhere.
|
|
328
328
|
*/
|
|
@@ -338,7 +338,7 @@ export type RunnableJobCollection = {
|
|
|
338
338
|
/**
|
|
339
339
|
* If enabled, tasks are created and run by the same Worker Node
|
|
340
340
|
*/
|
|
341
|
-
workerAffinity
|
|
341
|
+
workerAffinity: boolean;
|
|
342
342
|
collector: Collector;
|
|
343
343
|
input?: RunnableJobCollectionInput | undefined;
|
|
344
344
|
run: RunnableJobCollectionRun;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"runnablejobcollection.d.ts","sourceRoot":"","sources":["../../../src/models/runnablejobcollection.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,CAAC,MAAM,QAAQ,CAAC;AAG5B,OAAO,EAAE,UAAU,EAAE,QAAQ,EAAE,MAAM,mBAAmB,CAAC;AACzD,OAAO,EAAE,MAAM,IAAI,eAAe,EAAE,MAAM,gBAAgB,CAAC;AAC3D,OAAO,EAAE,kBAAkB,EAAE,MAAM,gCAAgC,CAAC;AAEpE,eAAO,MAAM,4BAA4B;;;;CAI/B,CAAC;AACX,MAAM,MAAM,4BAA4B,GAAG,QAAQ,CACjD,OAAO,4BAA4B,CACpC,CAAC;AAEF,eAAO,MAAM,4BAA4B;;CAE/B,CAAC;AACX,MAAM,MAAM,4BAA4B,GAAG,UAAU,CACnD,OAAO,4BAA4B,CACpC,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,qCAAqC;;;;;;CAMxC,CAAC;AACX;;GAEG;AACH,MAAM,MAAM,qCAAqC,GAAG,UAAU,CAC5D,OAAO,qCAAqC,CAC7C,CAAC;AAEF,MAAM,MAAM,wCAAwC,GAAG,EAAE,CAAC;AAE1D,MAAM,MAAM,gCAAgC,GAAG;IAC7C,IAAI,CAAC,EAAE,4BAA4B,GAAG,SAAS,CAAC;IAChD;;OAEG;IACH,sBAAsB,
|
|
1
|
+
{"version":3,"file":"runnablejobcollection.d.ts","sourceRoot":"","sources":["../../../src/models/runnablejobcollection.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,CAAC,MAAM,QAAQ,CAAC;AAG5B,OAAO,EAAE,UAAU,EAAE,QAAQ,EAAE,MAAM,mBAAmB,CAAC;AACzD,OAAO,EAAE,MAAM,IAAI,eAAe,EAAE,MAAM,gBAAgB,CAAC;AAC3D,OAAO,EAAE,kBAAkB,EAAE,MAAM,gCAAgC,CAAC;AAEpE,eAAO,MAAM,4BAA4B;;;;CAI/B,CAAC;AACX,MAAM,MAAM,4BAA4B,GAAG,QAAQ,CACjD,OAAO,4BAA4B,CACpC,CAAC;AAEF,eAAO,MAAM,4BAA4B;;CAE/B,CAAC;AACX,MAAM,MAAM,4BAA4B,GAAG,UAAU,CACnD,OAAO,4BAA4B,CACpC,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,qCAAqC;;;;;;CAMxC,CAAC;AACX;;GAEG;AACH,MAAM,MAAM,qCAAqC,GAAG,UAAU,CAC5D,OAAO,qCAAqC,CAC7C,CAAC;AAEF,MAAM,MAAM,wCAAwC,GAAG,EAAE,CAAC;AAE1D,MAAM,MAAM,gCAAgC,GAAG;IAC7C,IAAI,CAAC,EAAE,4BAA4B,GAAG,SAAS,CAAC;IAChD;;OAEG;IACH,sBAAsB,EAAE,OAAO,CAAC;IAChC;;OAEG;IACH,iBAAiB,EAAE,MAAM,CAAC;IAC1B;;OAEG;IACH,QAAQ,EAAE,qCAAqC,CAAC;IAChD;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IACnB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb,aAAa,EAAE,MAAM,CAAC;IACtB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC9B;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC5B,iBAAiB,CAAC,EAAE,GAAG,GAAG,SAAS,CAAC;IACpC,WAAW,CAAC,EAAE,wCAAwC,GAAG,SAAS,CAAC;IACnE;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IACnB;;;;;;OAMG;IACH,WAAW,EAAE,MAAM,CAAC;IACpB;;;;;;OAMG;IACH,WAAW,EAAE,MAAM,CAAC;CACrB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,6BAA6B,GAAG;IAC1C;;OAEG;IACH,OAAO,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IAC9B;;OAEG;IACH,SAAS,EAAE,OAAO,CAAC;IACnB;;OAEG;IACH,YAAY,EAAE,OAAO,CAAC;IACtB;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IACrB;;OAEG;IACH,iBAAiB,EAAE,MAAM,CAAC;IAC1B,GAAG,CAAC,EAAE,gCAAgC,GAAG,SAAS,CAAC;CACpD,CAAC;AAEF,MAAM,MAAM,yBAAyB,GAAG,EAAE,CAAC;AAE3C,MAAM,MAAM,SAAS,GAAG;IACtB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,yBAAyB,CAAC;IAChC;;OAEG;IACH,WAAW,EAAE,OAAO,CAAC;IACrB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;CAC/B,CAAC;AAEF,eAAO,MAAM,SAAS;;CAEZ,CAAC;AACX,MAAM,MAAM,SAAS,GAAG,QAAQ,CAAC,OAAO,SAAS,CAAC,CAAC;AAEnD,MAAM,MAAM,+BAA+B,GAAG;IAC5C,QAAQ,EAAE,OAAO,CAAC;IAClB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC7B;;OAEG;IACH,IAAI,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,SAAS,CAAC;CAClC,CAAC;AAEF,MAAM,MAAM,8BAA8B,GAAG;IAC3C,IAAI,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;CACf,CAAC;AAEF,MAAM,MAAM,0BAA0B,GAAG;IACvC,IAAI,EAAE,SAAS,CAAC;IAChB;;OAEG;IACH,eAAe,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,SAAS,CAAC;IAC5C;;OAEG;IACH,mBAAmB,EAAE,MAAM,CAAC;IAC5B;;OAEG;IACH,YAAY,EAAE,OAAO,CAAC;IACtB,UAAU,CAAC,EAAE,+BAA+B,GAAG,SAAS,CAAC;IACzD;;OAEG;IACH,kBAAkB,EAAE,MAAM,CAAC;IAC3B;;OAEG;IACH,QAAQ,CAAC,EAAE,KAAK,CAAC,8BAA8B,CAAC,GAAG,SAAS,CAAC;IAC7D;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC9B;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;CAC7B,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,6BAA6B;;;;;;CAMhC,CAAC;AACX;;GAEG;AACH,MAAM,MAAM,6BAA6B,GAAG,QAAQ,CAClD,OAAO,6BAA6B,CACrC,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,yBAAyB;;;;CAI5B,CAAC;AACX;;GAEG;AACH,MAAM,MAAM,yBAAyB,GAAG,QAAQ,CAC9C,OAAO,yBAAyB,CACjC,CAAC;AAEF,eAAO,MAAM,SAAS;;;CAGZ,CAAC;AACX,MAAM,MAAM,SAAS,GAAG,QAAQ,CAAC,OAAO,SAAS,CAAC,CAAC;AAEnD,MAAM,MAAM,gCAAgC,GAAG,EAAE,CAAC;AAElD,eAAO,MAAM,cAAc;IACzB;;OAEG;;IAEH;;OAEG;;IAEH;;OAEG;;IAEH;;OAEG;;CAEK,CAAC;AACX,MAAM,MAAM,cAAc,GAAG,QAAQ,CAAC,OAAO,cAAc,CAAC,CAAC;AAE7D,MAAM,MAAM,eAAe,GAAG;IAC5B;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAClB,KAAK,EAAE,cAAc,CAAC;CACvB,CAAC;AAEF,MAAM,MAAM,wBAAwB,GAAG;IACrC;;OAEG;IACH,sBAAsB,EAAE,OAAO,CAAC;IAChC;;OAEG;IACH,iBAAiB,EAAE,MAAM,CAAC;IAC1B;;OAEG;IACH,QAAQ,EAAE,6BAA6B,CAAC;IACxC;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IACnB;;OAEG;IACH,IAAI,EAAE,yBAAyB,CAAC;IAChC,aAAa,EAAE,SAAS,CAAC;IACzB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC9B;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC5B;;OAEG;IACH,iBAAiB,EAAE,MAAM,CAAC;IAC1B,WAAW,CAAC,EAAE,gCAAgC,GAAG,SAAS,CAAC;IAC3D;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IACnB;;;;;;OAMG;IACH,WAAW,EAAE,MAAM,CAAC;IACpB;;;;;;OAMG;IACH,WAAW,EAAE,MAAM,CAAC;IACpB;;OAEG;IACH,gBAAgB,EAAE,OAAO,CAAC;IAC1B,OAAO,CAAC,EAAE,eAAe,GAAG,SAAS,CAAC;CACvC,CAAC;AAEF,MAAM,MAAM,qBAAqB,GAAG;IAClC;;OAEG;IACH,EAAE,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACxB,WAAW,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACjC,IAAI,CAAC,EAAE,4BAA4B,GAAG,SAAS,CAAC;IAChD;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;IACZ;;OAEG;IACH,oBAAoB,EAAE,OAAO,CAAC;IAC9B;;OAEG;IACH,YAAY,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,SAAS,CAAC;IACzC;;OAEG;IACH,YAAY,EAAE,OAAO,CAAC;IACtB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACjC;;OAEG;IACH,QAAQ,CAAC,EAAE,6BAA6B,GAAG,SAAS,CAAC;IACrD;;OAEG;IACH,UAAU,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,SAAS,CAAC;IACvC;;OAEG;IACH,cAAc,EAAE,OAAO,CAAC;IACxB,SAAS,EAAE,SAAS,CAAC;IACrB,KAAK,CAAC,EAAE,0BAA0B,GAAG,SAAS,CAAC;IAC/C,GAAG,EAAE,wBAAwB,CAAC;CAC/B,CAAC;AAEF,gBAAgB;AAChB,eAAO,MAAM,0CAA0C,EAAE,CAAC,CAAC,OAAO,CAChE,4BAA4B,EAC5B,CAAC,CAAC,UAAU,EACZ,OAAO,CACgD,CAAC;AAE1D,gBAAgB;AAChB,eAAO,MAAM,0CAA0C,EAAE,CAAC,CAAC,aAAa,CACtE,OAAO,4BAA4B,CACS,CAAC;AAE/C,gBAAgB;AAChB,eAAO,MAAM,mDAAmD,EAC9D,CAAC,CAAC,aAAa,CAAC,OAAO,qCAAqC,CAE3D,CAAC;AAEJ,gBAAgB;AAChB,eAAO,MAAM,sDAAsD,EAAE,CAAC,CAAC,OAAO,CAC5E,wCAAwC,EACxC,CAAC,CAAC,UAAU,EACZ,OAAO,CACO,CAAC;AAEjB,wBAAgB,gDAAgD,CAC9D,UAAU,EAAE,MAAM,GACjB,eAAe,CAChB,wCAAwC,EACxC,kBAAkB,CACnB,CASA;AAED,gBAAgB;AAChB,eAAO,MAAM,8CAA8C,EAAE,CAAC,CAAC,OAAO,CACpE,gCAAgC,EAChC,CAAC,CAAC,UAAU,EACZ,OAAO,CAkBP,CAAC;AAEH,wBAAgB,wCAAwC,CACtD,UAAU,EAAE,MAAM,GACjB,eAAe,CAAC,gCAAgC,EAAE,kBAAkB,CAAC,CAMvE;AAED,gBAAgB;AAChB,eAAO,MAAM,2CAA2C,EAAE,CAAC,CAAC,OAAO,CACjE,6BAA6B,EAC7B,CAAC,CAAC,UAAU,EACZ,OAAO,CAQP,CAAC;AAEH,wBAAgB,qCAAqC,CACnD,UAAU,EAAE,MAAM,GACjB,eAAe,CAAC,6BAA6B,EAAE,kBAAkB,CAAC,CAMpE;AAED,gBAAgB;AAChB,eAAO,MAAM,uCAAuC,EAAE,CAAC,CAAC,OAAO,CAC7D,yBAAyB,EACzB,CAAC,CAAC,UAAU,EACZ,OAAO,CACO,CAAC;AAEjB,wBAAgB,iCAAiC,CAC/C,UAAU,EAAE,MAAM,GACjB,eAAe,CAAC,yBAAyB,EAAE,kBAAkB,CAAC,CAMhE;AAED,gBAAgB;AAChB,eAAO,MAAM,uBAAuB,EAAE,CAAC,CAAC,OAAO,CAC7C,SAAS,EACT,CAAC,CAAC,UAAU,EACZ,OAAO,CAMP,CAAC;AAEH,wBAAgB,iBAAiB,CAC/B,UAAU,EAAE,MAAM,GACjB,eAAe,CAAC,SAAS,EAAE,kBAAkB,CAAC,CAMhD;AAED,gBAAgB;AAChB,eAAO,MAAM,uBAAuB,EAAE,CAAC,CAAC,OAAO,CAC7C,SAAS,EACT,CAAC,CAAC,UAAU,EACZ,OAAO,CAC6B,CAAC;AAEvC,gBAAgB;AAChB,eAAO,MAAM,6CAA6C,EAAE,CAAC,CAAC,OAAO,CACnE,+BAA+B,EAC/B,CAAC,CAAC,UAAU,EACZ,OAAO,CAKP,CAAC;AAEH,wBAAgB,uCAAuC,CACrD,UAAU,EAAE,MAAM,GACjB,eAAe,CAAC,+BAA+B,EAAE,kBAAkB,CAAC,CAMtE;AAED,gBAAgB;AAChB,eAAO,MAAM,4CAA4C,EAAE,CAAC,CAAC,OAAO,CAClE,8BAA8B,EAC9B,CAAC,CAAC,UAAU,EACZ,OAAO,CAIP,CAAC;AAEH,wBAAgB,sCAAsC,CACpD,UAAU,EAAE,MAAM,GACjB,eAAe,CAAC,8BAA8B,EAAE,kBAAkB,CAAC,CAMrE;AAED,gBAAgB;AAChB,eAAO,MAAM,wCAAwC,EAAE,CAAC,CAAC,OAAO,CAC9D,0BAA0B,EAC1B,CAAC,CAAC,UAAU,EACZ,OAAO,CAaP,CAAC;AAEH,wBAAgB,kCAAkC,CAChD,UAAU,EAAE,MAAM,GACjB,eAAe,CAAC,0BAA0B,EAAE,kBAAkB,CAAC,CAMjE;AAED,gBAAgB;AAChB,eAAO,MAAM,2CAA2C,EAAE,CAAC,CAAC,OAAO,CACjE,6BAA6B,EAC7B,CAAC,CAAC,UAAU,EACZ,OAAO,CACiD,CAAC;AAE3D,gBAAgB;AAChB,eAAO,MAAM,uCAAuC,EAAE,CAAC,CAAC,OAAO,CAC7D,yBAAyB,EACzB,CAAC,CAAC,UAAU,EACZ,OAAO,CAC6C,CAAC;AAEvD,gBAAgB;AAChB,eAAO,MAAM,uBAAuB,EAAE,CAAC,CAAC,OAAO,CAC7C,SAAS,EACT,CAAC,CAAC,UAAU,EACZ,OAAO,CAC6B,CAAC;AAEvC,gBAAgB;AAChB,eAAO,MAAM,8CAA8C,EAAE,CAAC,CAAC,OAAO,CACpE,gCAAgC,EAChC,CAAC,CAAC,UAAU,EACZ,OAAO,CACO,CAAC;AAEjB,wBAAgB,wCAAwC,CACtD,UAAU,EAAE,MAAM,GACjB,eAAe,CAAC,gCAAgC,EAAE,kBAAkB,CAAC,CAMvE;AAED,gBAAgB;AAChB,eAAO,MAAM,4BAA4B,EAAE,CAAC,CAAC,OAAO,CAClD,cAAc,EACd,CAAC,CAAC,UAAU,EACZ,OAAO,CACqC,CAAC;AAE/C,gBAAgB;AAChB,eAAO,MAAM,6BAA6B,EAAE,CAAC,CAAC,OAAO,CACnD,eAAe,EACf,CAAC,CAAC,UAAU,EACZ,OAAO,CAKP,CAAC;AAEH,wBAAgB,uBAAuB,CACrC,UAAU,EAAE,MAAM,GACjB,eAAe,CAAC,eAAe,EAAE,kBAAkB,CAAC,CAMtD;AAED,gBAAgB;AAChB,eAAO,MAAM,sCAAsC,EAAE,CAAC,CAAC,OAAO,CAC5D,wBAAwB,EACxB,CAAC,CAAC,UAAU,EACZ,OAAO,CAkBP,CAAC;AAEH,wBAAgB,gCAAgC,CAC9C,UAAU,EAAE,MAAM,GACjB,eAAe,CAAC,wBAAwB,EAAE,kBAAkB,CAAC,CAM/D;AAED,gBAAgB;AAChB,eAAO,MAAM,mCAAmC,EAAE,CAAC,CAAC,OAAO,CACzD,qBAAqB,EACrB,CAAC,CAAC,UAAU,EACZ,OAAO,CAiBP,CAAC;AAEH,wBAAgB,6BAA6B,CAC3C,UAAU,EAAE,MAAM,GACjB,eAAe,CAAC,qBAAqB,EAAE,kBAAkB,CAAC,CAM5D"}
|
|
@@ -32,24 +32,24 @@ export type RunnableJobExecutorRunSettings = {
|
|
|
32
32
|
/**
|
|
33
33
|
* Reschedule tasks that failed with non-fatal errors
|
|
34
34
|
*/
|
|
35
|
-
rescheduleDroppedTasks
|
|
35
|
+
rescheduleDroppedTasks: boolean;
|
|
36
36
|
/**
|
|
37
37
|
* Maximum number of times a task can be rescheduled
|
|
38
38
|
*/
|
|
39
|
-
maxTaskReschedule
|
|
39
|
+
maxTaskReschedule: number;
|
|
40
40
|
/**
|
|
41
41
|
* Level at which to set task logging
|
|
42
42
|
*/
|
|
43
|
-
logLevel
|
|
43
|
+
logLevel: RunnableJobExecutorScheduleLogLevel;
|
|
44
44
|
/**
|
|
45
45
|
* Maximum time the job is allowed to run. Time unit defaults to seconds if not specified (examples: 30, 45s, 15m). Enter 0 for unlimited time.
|
|
46
46
|
*/
|
|
47
|
-
jobTimeout
|
|
47
|
+
jobTimeout: string;
|
|
48
48
|
/**
|
|
49
49
|
* Job run mode. Preview will either return up to N matching results, or will run until capture time T is reached. Discovery will gather the list of files to turn into streaming tasks, without running the data collection job. Full Run will run the collection job.
|
|
50
50
|
*/
|
|
51
|
-
mode
|
|
52
|
-
timeRangeType
|
|
51
|
+
mode: string;
|
|
52
|
+
timeRangeType: string;
|
|
53
53
|
/**
|
|
54
54
|
* Earliest time to collect data for the selected timezone
|
|
55
55
|
*/
|
|
@@ -63,7 +63,7 @@ export type RunnableJobExecutorRunSettings = {
|
|
|
63
63
|
/**
|
|
64
64
|
* A filter for tokens in the provided collect path and/or the events being collected
|
|
65
65
|
*/
|
|
66
|
-
expression
|
|
66
|
+
expression: string;
|
|
67
67
|
/**
|
|
68
68
|
* Limits the bundle size for small tasks. For example,
|
|
69
69
|
*
|
|
@@ -71,7 +71,7 @@ export type RunnableJobExecutorRunSettings = {
|
|
|
71
71
|
*
|
|
72
72
|
* if your lower bundle size is 1MB, you can bundle up to five 200KB files into one task.
|
|
73
73
|
*/
|
|
74
|
-
minTaskSize
|
|
74
|
+
minTaskSize: string;
|
|
75
75
|
/**
|
|
76
76
|
* Limits the bundle size for files above the lower task bundle size. For example, if your upper bundle size is 10MB,
|
|
77
77
|
*
|
|
@@ -79,7 +79,7 @@ export type RunnableJobExecutorRunSettings = {
|
|
|
79
79
|
*
|
|
80
80
|
* you can bundle up to five 2MB files into one task. Files greater than this size will be assigned to individual tasks.
|
|
81
81
|
*/
|
|
82
|
-
maxTaskSize
|
|
82
|
+
maxTaskSize: string;
|
|
83
83
|
};
|
|
84
84
|
/**
|
|
85
85
|
* Configuration for a scheduled job
|
|
@@ -92,19 +92,19 @@ export type RunnableJobExecutorSchedule = {
|
|
|
92
92
|
/**
|
|
93
93
|
* Skippable jobs can be delayed, up to their next run time, if the system is hitting concurrency limits
|
|
94
94
|
*/
|
|
95
|
-
skippable
|
|
95
|
+
skippable: boolean;
|
|
96
96
|
/**
|
|
97
97
|
* If Stream Leader (or single instance) restarts, run all missed jobs according to their original schedules
|
|
98
98
|
*/
|
|
99
|
-
resumeMissed
|
|
99
|
+
resumeMissed: boolean;
|
|
100
100
|
/**
|
|
101
101
|
* A cron schedule on which to run this job
|
|
102
102
|
*/
|
|
103
|
-
cronSchedule
|
|
103
|
+
cronSchedule: string;
|
|
104
104
|
/**
|
|
105
105
|
* The maximum number of instances of this scheduled job that may be running at any time
|
|
106
106
|
*/
|
|
107
|
-
maxConcurrentRuns
|
|
107
|
+
maxConcurrentRuns: number;
|
|
108
108
|
run?: RunnableJobExecutorRunSettings | undefined;
|
|
109
109
|
};
|
|
110
110
|
export type ExecutorSpecificSettings = {};
|
|
@@ -116,7 +116,7 @@ export type Executor = {
|
|
|
116
116
|
/**
|
|
117
117
|
* Determines whether or not to write task results to disk
|
|
118
118
|
*/
|
|
119
|
-
storeTaskResults
|
|
119
|
+
storeTaskResults: boolean;
|
|
120
120
|
conf?: ExecutorSpecificSettings | undefined;
|
|
121
121
|
};
|
|
122
122
|
/**
|
|
@@ -137,19 +137,19 @@ export type RunnableJobExecutorRun = {
|
|
|
137
137
|
/**
|
|
138
138
|
* Reschedule tasks that failed with non-fatal errors
|
|
139
139
|
*/
|
|
140
|
-
rescheduleDroppedTasks
|
|
140
|
+
rescheduleDroppedTasks: boolean;
|
|
141
141
|
/**
|
|
142
142
|
* Maximum number of times a task can be rescheduled
|
|
143
143
|
*/
|
|
144
|
-
maxTaskReschedule
|
|
144
|
+
maxTaskReschedule: number;
|
|
145
145
|
/**
|
|
146
146
|
* Level at which to set task logging
|
|
147
147
|
*/
|
|
148
|
-
logLevel
|
|
148
|
+
logLevel: RunnableJobExecutorLogLevel;
|
|
149
149
|
/**
|
|
150
150
|
* Maximum time the job is allowed to run. Time unit defaults to seconds if not specified (examples: 30, 45s, 15m). Enter 0 for unlimited time.
|
|
151
151
|
*/
|
|
152
|
-
jobTimeout
|
|
152
|
+
jobTimeout: string;
|
|
153
153
|
};
|
|
154
154
|
export type RunnableJobExecutor = {
|
|
155
155
|
/**
|
|
@@ -161,11 +161,11 @@ export type RunnableJobExecutor = {
|
|
|
161
161
|
/**
|
|
162
162
|
* Time to keep the job's artifacts on disk after job completion. This also affects how long a job is listed in the Job Inspector.
|
|
163
163
|
*/
|
|
164
|
-
ttl
|
|
164
|
+
ttl: string;
|
|
165
165
|
/**
|
|
166
166
|
* When enabled, this job's artifacts are not counted toward the Worker Group's finished job artifacts limit. Artifacts will be removed only after the Collector's configured time to live.
|
|
167
167
|
*/
|
|
168
|
-
ignoreGroupJobsLimit
|
|
168
|
+
ignoreGroupJobsLimit: boolean;
|
|
169
169
|
/**
|
|
170
170
|
* List of fields to remove from Discover results. Wildcards (for example, aws*) are allowed. This is useful when discovery returns sensitive fields that should not be exposed in the Jobs user interface.
|
|
171
171
|
*/
|
|
@@ -173,7 +173,7 @@ export type RunnableJobExecutor = {
|
|
|
173
173
|
/**
|
|
174
174
|
* Resume the ad hoc job if a failure condition causes Stream to restart during job execution
|
|
175
175
|
*/
|
|
176
|
-
resumeOnBoot
|
|
176
|
+
resumeOnBoot: boolean;
|
|
177
177
|
/**
|
|
178
178
|
* Optionally, enable this config only on a specified Git branch. If empty, will be enabled everywhere.
|
|
179
179
|
*/
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"runnablejobexecutor.d.ts","sourceRoot":"","sources":["../../../src/models/runnablejobexecutor.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,CAAC,MAAM,QAAQ,CAAC;AAG5B,OAAO,EAAE,UAAU,EAAE,QAAQ,EAAE,MAAM,mBAAmB,CAAC;AACzD,OAAO,EAAE,MAAM,IAAI,eAAe,EAAE,MAAM,gBAAgB,CAAC;AAC3D,OAAO,EAAE,kBAAkB,EAAE,MAAM,gCAAgC,CAAC;AAEpE,eAAO,MAAM,0BAA0B;;;;CAI7B,CAAC;AACX,MAAM,MAAM,0BAA0B,GAAG,QAAQ,CAC/C,OAAO,0BAA0B,CAClC,CAAC;AAEF,eAAO,MAAM,uBAAuB;;CAE1B,CAAC;AACX,MAAM,MAAM,uBAAuB,GAAG,UAAU,CAC9C,OAAO,uBAAuB,CAC/B,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,mCAAmC;;;;;;CAMtC,CAAC;AACX;;GAEG;AACH,MAAM,MAAM,mCAAmC,GAAG,UAAU,CAC1D,OAAO,mCAAmC,CAC3C,CAAC;AAEF,MAAM,MAAM,8BAA8B,GAAG,EAAE,CAAC;AAEhD,MAAM,MAAM,8BAA8B,GAAG;IAC3C,IAAI,CAAC,EAAE,uBAAuB,GAAG,SAAS,CAAC;IAC3C;;OAEG;IACH,sBAAsB,
|
|
1
|
+
{"version":3,"file":"runnablejobexecutor.d.ts","sourceRoot":"","sources":["../../../src/models/runnablejobexecutor.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,CAAC,MAAM,QAAQ,CAAC;AAG5B,OAAO,EAAE,UAAU,EAAE,QAAQ,EAAE,MAAM,mBAAmB,CAAC;AACzD,OAAO,EAAE,MAAM,IAAI,eAAe,EAAE,MAAM,gBAAgB,CAAC;AAC3D,OAAO,EAAE,kBAAkB,EAAE,MAAM,gCAAgC,CAAC;AAEpE,eAAO,MAAM,0BAA0B;;;;CAI7B,CAAC;AACX,MAAM,MAAM,0BAA0B,GAAG,QAAQ,CAC/C,OAAO,0BAA0B,CAClC,CAAC;AAEF,eAAO,MAAM,uBAAuB;;CAE1B,CAAC;AACX,MAAM,MAAM,uBAAuB,GAAG,UAAU,CAC9C,OAAO,uBAAuB,CAC/B,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,mCAAmC;;;;;;CAMtC,CAAC;AACX;;GAEG;AACH,MAAM,MAAM,mCAAmC,GAAG,UAAU,CAC1D,OAAO,mCAAmC,CAC3C,CAAC;AAEF,MAAM,MAAM,8BAA8B,GAAG,EAAE,CAAC;AAEhD,MAAM,MAAM,8BAA8B,GAAG;IAC3C,IAAI,CAAC,EAAE,uBAAuB,GAAG,SAAS,CAAC;IAC3C;;OAEG;IACH,sBAAsB,EAAE,OAAO,CAAC;IAChC;;OAEG;IACH,iBAAiB,EAAE,MAAM,CAAC;IAC1B;;OAEG;IACH,QAAQ,EAAE,mCAAmC,CAAC;IAC9C;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IACnB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb,aAAa,EAAE,MAAM,CAAC;IACtB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC9B;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC5B,iBAAiB,CAAC,EAAE,GAAG,GAAG,SAAS,CAAC;IACpC,WAAW,CAAC,EAAE,8BAA8B,GAAG,SAAS,CAAC;IACzD;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IACnB;;;;;;OAMG;IACH,WAAW,EAAE,MAAM,CAAC;IACpB;;;;;;OAMG;IACH,WAAW,EAAE,MAAM,CAAC;CACrB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,2BAA2B,GAAG;IACxC;;OAEG;IACH,OAAO,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IAC9B;;OAEG;IACH,SAAS,EAAE,OAAO,CAAC;IACnB;;OAEG;IACH,YAAY,EAAE,OAAO,CAAC;IACtB;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IACrB;;OAEG;IACH,iBAAiB,EAAE,MAAM,CAAC;IAC1B,GAAG,CAAC,EAAE,8BAA8B,GAAG,SAAS,CAAC;CAClD,CAAC;AAEF,MAAM,MAAM,wBAAwB,GAAG,EAAE,CAAC;AAE1C,MAAM,MAAM,QAAQ,GAAG;IACrB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,gBAAgB,EAAE,OAAO,CAAC;IAC1B,IAAI,CAAC,EAAE,wBAAwB,GAAG,SAAS,CAAC;CAC7C,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,2BAA2B;;;;;;CAM9B,CAAC;AACX;;GAEG;AACH,MAAM,MAAM,2BAA2B,GAAG,QAAQ,CAChD,OAAO,2BAA2B,CACnC,CAAC;AAEF,MAAM,MAAM,sBAAsB,GAAG;IACnC;;OAEG;IACH,sBAAsB,EAAE,OAAO,CAAC;IAChC;;OAEG;IACH,iBAAiB,EAAE,MAAM,CAAC;IAC1B;;OAEG;IACH,QAAQ,EAAE,2BAA2B,CAAC;IACtC;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;CACpB,CAAC;AAEF,MAAM,MAAM,mBAAmB,GAAG;IAChC;;OAEG;IACH,EAAE,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACxB,WAAW,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACjC,IAAI,CAAC,EAAE,0BAA0B,GAAG,SAAS,CAAC;IAC9C;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;IACZ;;OAEG;IACH,oBAAoB,EAAE,OAAO,CAAC;IAC9B;;OAEG;IACH,YAAY,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,SAAS,CAAC;IACzC;;OAEG;IACH,YAAY,EAAE,OAAO,CAAC;IACtB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACjC;;OAEG;IACH,QAAQ,CAAC,EAAE,2BAA2B,GAAG,SAAS,CAAC;IACnD;;OAEG;IACH,UAAU,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,SAAS,CAAC;IACvC,QAAQ,EAAE,QAAQ,CAAC;IACnB,GAAG,EAAE,sBAAsB,CAAC;CAC7B,CAAC;AAEF,gBAAgB;AAChB,eAAO,MAAM,wCAAwC,EAAE,CAAC,CAAC,OAAO,CAC9D,0BAA0B,EAC1B,CAAC,CAAC,UAAU,EACZ,OAAO,CAC8C,CAAC;AAExD,gBAAgB;AAChB,eAAO,MAAM,qCAAqC,EAAE,CAAC,CAAC,aAAa,CACjE,OAAO,uBAAuB,CACS,CAAC;AAE1C,gBAAgB;AAChB,eAAO,MAAM,iDAAiD,EAAE,CAAC,CAAC,aAAa,CAC7E,OAAO,mCAAmC,CACS,CAAC;AAEtD,gBAAgB;AAChB,eAAO,MAAM,4CAA4C,EAAE,CAAC,CAAC,OAAO,CAClE,8BAA8B,EAC9B,CAAC,CAAC,UAAU,EACZ,OAAO,CACO,CAAC;AAEjB,wBAAgB,sCAAsC,CACpD,UAAU,EAAE,MAAM,GACjB,eAAe,CAAC,8BAA8B,EAAE,kBAAkB,CAAC,CAMrE;AAED,gBAAgB;AAChB,eAAO,MAAM,4CAA4C,EAAE,CAAC,CAAC,OAAO,CAClE,8BAA8B,EAC9B,CAAC,CAAC,UAAU,EACZ,OAAO,CAiBP,CAAC;AAEH,wBAAgB,sCAAsC,CACpD,UAAU,EAAE,MAAM,GACjB,eAAe,CAAC,8BAA8B,EAAE,kBAAkB,CAAC,CAMrE;AAED,gBAAgB;AAChB,eAAO,MAAM,yCAAyC,EAAE,CAAC,CAAC,OAAO,CAC/D,2BAA2B,EAC3B,CAAC,CAAC,UAAU,EACZ,OAAO,CAQP,CAAC;AAEH,wBAAgB,mCAAmC,CACjD,UAAU,EAAE,MAAM,GACjB,eAAe,CAAC,2BAA2B,EAAE,kBAAkB,CAAC,CAMlE;AAED,gBAAgB;AAChB,eAAO,MAAM,sCAAsC,EAAE,CAAC,CAAC,OAAO,CAC5D,wBAAwB,EACxB,CAAC,CAAC,UAAU,EACZ,OAAO,CACO,CAAC;AAEjB,wBAAgB,gCAAgC,CAC9C,UAAU,EAAE,MAAM,GACjB,eAAe,CAAC,wBAAwB,EAAE,kBAAkB,CAAC,CAM/D;AAED,gBAAgB;AAChB,eAAO,MAAM,sBAAsB,EAAE,CAAC,CAAC,OAAO,CAC5C,QAAQ,EACR,CAAC,CAAC,UAAU,EACZ,OAAO,CAKP,CAAC;AAEH,wBAAgB,gBAAgB,CAC9B,UAAU,EAAE,MAAM,GACjB,eAAe,CAAC,QAAQ,EAAE,kBAAkB,CAAC,CAM/C;AAED,gBAAgB;AAChB,eAAO,MAAM,yCAAyC,EAAE,CAAC,CAAC,OAAO,CAC/D,2BAA2B,EAC3B,CAAC,CAAC,UAAU,EACZ,OAAO,CAC+C,CAAC;AAEzD,gBAAgB;AAChB,eAAO,MAAM,oCAAoC,EAAE,CAAC,CAAC,OAAO,CAC1D,sBAAsB,EACtB,CAAC,CAAC,UAAU,EACZ,OAAO,CAMP,CAAC;AAEH,wBAAgB,8BAA8B,CAC5C,UAAU,EAAE,MAAM,GACjB,eAAe,CAAC,sBAAsB,EAAE,kBAAkB,CAAC,CAM7D;AAED,gBAAgB;AAChB,eAAO,MAAM,iCAAiC,EAAE,CAAC,CAAC,OAAO,CACvD,mBAAmB,EACnB,CAAC,CAAC,UAAU,EACZ,OAAO,CAcP,CAAC;AAEH,wBAAgB,2BAA2B,CACzC,UAAU,EAAE,MAAM,GACjB,eAAe,CAAC,mBAAmB,EAAE,kBAAkB,CAAC,CAM1D"}
|