@osdk/foundry.streams 2.1.1 → 2.2.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/CHANGELOG.md +24 -7
- package/build/browser/_components.d.ts +68 -0
- package/build/browser/_components.d.ts.map +1 -1
- package/build/browser/_errors.d.ts +148 -0
- package/build/browser/_errors.d.ts.map +1 -1
- package/build/browser/index.d.ts +2 -2
- package/build/browser/index.d.ts.map +1 -1
- package/build/browser/public/Dataset.d.ts +4 -3
- package/build/browser/public/Dataset.d.ts.map +1 -1
- package/build/browser/public/Dataset.js +1 -1
- package/build/browser/public/Dataset.js.map +1 -1
- package/build/browser/public/Stream.d.ts +92 -3
- package/build/browser/public/Stream.d.ts.map +1 -1
- package/build/browser/public/Stream.js +69 -1
- package/build/browser/public/Stream.js.map +1 -1
- package/build/esm/_components.d.ts +68 -0
- package/build/esm/_components.d.ts.map +1 -1
- package/build/esm/_errors.d.ts +148 -0
- package/build/esm/_errors.d.ts.map +1 -1
- package/build/esm/index.d.ts +2 -2
- package/build/esm/index.d.ts.map +1 -1
- package/build/esm/public/Dataset.d.ts +4 -3
- package/build/esm/public/Dataset.d.ts.map +1 -1
- package/build/esm/public/Dataset.js +1 -1
- package/build/esm/public/Dataset.js.map +1 -1
- package/build/esm/public/Stream.d.ts +92 -3
- package/build/esm/public/Stream.d.ts.map +1 -1
- package/build/esm/public/Stream.js +69 -1
- package/build/esm/public/Stream.js.map +1 -1
- package/package.json +8 -9
package/CHANGELOG.md
CHANGED
|
@@ -1,15 +1,32 @@
|
|
|
1
1
|
# @osdk/foundry.streams
|
|
2
2
|
|
|
3
|
-
## 2.
|
|
3
|
+
## 2.2.0
|
|
4
|
+
|
|
5
|
+
### Minor Changes
|
|
6
|
+
|
|
7
|
+
- 02fc65d: Fix codegen for new APIs.
|
|
8
|
+
- ca65018: Updating deps for platform sdk.
|
|
9
|
+
|
|
10
|
+
### Patch Changes
|
|
11
|
+
|
|
12
|
+
- Updated dependencies [02fc65d]
|
|
13
|
+
- Updated dependencies [ca65018]
|
|
14
|
+
- @osdk/foundry.filesystem@2.2.0
|
|
15
|
+
- @osdk/foundry.datasets@2.2.0
|
|
16
|
+
- @osdk/foundry.core@2.2.0
|
|
17
|
+
|
|
18
|
+
## 2.2.0-beta.0
|
|
19
|
+
|
|
20
|
+
### Minor Changes
|
|
21
|
+
|
|
22
|
+
- 02fc65d: Fix codegen for new APIs.
|
|
4
23
|
|
|
5
24
|
### Patch Changes
|
|
6
25
|
|
|
7
|
-
- Updated dependencies [
|
|
8
|
-
- @osdk/
|
|
9
|
-
- @osdk/foundry.
|
|
10
|
-
- @osdk/foundry.
|
|
11
|
-
- @osdk/foundry.filesystem@2.1.1
|
|
12
|
-
- @osdk/shared.net.platformapi@0.3.1
|
|
26
|
+
- Updated dependencies [02fc65d]
|
|
27
|
+
- @osdk/foundry.filesystem@2.2.0-beta.0
|
|
28
|
+
- @osdk/foundry.datasets@2.2.0-beta.0
|
|
29
|
+
- @osdk/foundry.core@2.2.0-beta.0
|
|
13
30
|
|
|
14
31
|
## 2.1.0
|
|
15
32
|
|
|
@@ -1,3 +1,4 @@
|
|
|
1
|
+
import type * as _Core from "@osdk/foundry.core";
|
|
1
2
|
import type * as _Datasets from "@osdk/foundry.datasets";
|
|
2
3
|
import type * as _Filesystem from "@osdk/foundry.filesystem";
|
|
3
4
|
export type LooselyBrandedString<T extends string> = string & {
|
|
@@ -12,12 +13,49 @@ network bandwidth symptoms like non-zero lag, lower than expected throughput, or
|
|
|
12
13
|
* Log Safety: SAFE
|
|
13
14
|
*/
|
|
14
15
|
export type Compressed = boolean;
|
|
16
|
+
/**
|
|
17
|
+
* Log Safety: UNSAFE
|
|
18
|
+
*/
|
|
19
|
+
export interface CreateStreamRequest {
|
|
20
|
+
schema: CreateStreamRequestStreamSchema;
|
|
21
|
+
partitionsCount?: PartitionsCount;
|
|
22
|
+
streamType?: StreamType;
|
|
23
|
+
branchName: _Datasets.BranchName;
|
|
24
|
+
compressed?: Compressed;
|
|
25
|
+
}
|
|
26
|
+
/**
|
|
27
|
+
* Log Safety: UNSAFE
|
|
28
|
+
*/
|
|
29
|
+
export interface CreateStreamRequestStreamSchema {
|
|
30
|
+
keyFieldNames?: Array<_Core.FieldName>;
|
|
31
|
+
fields: Array<_Core.Field>;
|
|
32
|
+
changeDataCapture?: _Core.ChangeDataCaptureConfiguration;
|
|
33
|
+
}
|
|
34
|
+
/**
|
|
35
|
+
* Configuration for utilizing the stream as a change data capture (CDC) dataset. To configure CDC on a stream, at
|
|
36
|
+
least one key needs to be provided.
|
|
37
|
+
For more information on CDC in
|
|
38
|
+
Foundry, see the Change Data Capture user documentation.
|
|
39
|
+
*
|
|
40
|
+
* Log Safety: UNSAFE
|
|
41
|
+
*/
|
|
42
|
+
export type CreateStreamRequestStreamSchemaChangeDataCaptureConfiguration = {
|
|
43
|
+
type: "fullRow";
|
|
44
|
+
} & CreateStreamRequestStreamSchemaChangeDataCaptureConfigurationFullRowChangeDataCaptureConfiguration;
|
|
45
|
+
/**
|
|
46
|
+
* Log Safety: UNSAFE
|
|
47
|
+
*/
|
|
48
|
+
export interface CreateStreamRequestStreamSchemaChangeDataCaptureConfigurationFullRowChangeDataCaptureConfiguration {
|
|
49
|
+
orderingFieldName: _Core.FieldName;
|
|
50
|
+
deletionFieldName: _Core.FieldName;
|
|
51
|
+
}
|
|
15
52
|
/**
|
|
16
53
|
* Log Safety: UNSAFE
|
|
17
54
|
*/
|
|
18
55
|
export interface CreateStreamingDatasetRequest {
|
|
19
56
|
name: _Datasets.DatasetName;
|
|
20
57
|
parentFolderRid: _Filesystem.FolderRid;
|
|
58
|
+
schema: _Core.StreamSchema;
|
|
21
59
|
branchName?: _Datasets.BranchName;
|
|
22
60
|
partitionsCount?: PartitionsCount;
|
|
23
61
|
streamType?: StreamType;
|
|
@@ -37,11 +75,41 @@ export interface Dataset {
|
|
|
37
75
|
* Log Safety: SAFE
|
|
38
76
|
*/
|
|
39
77
|
export type PartitionsCount = number;
|
|
78
|
+
/**
|
|
79
|
+
* Log Safety: DO_NOT_LOG
|
|
80
|
+
*/
|
|
81
|
+
export interface PublishRecordToStreamRequest {
|
|
82
|
+
record: _Record;
|
|
83
|
+
viewRid?: ViewRid;
|
|
84
|
+
}
|
|
85
|
+
/**
|
|
86
|
+
* Log Safety: DO_NOT_LOG
|
|
87
|
+
*/
|
|
88
|
+
export interface PublishRecordsToStreamRequest {
|
|
89
|
+
records: Array<_Record>;
|
|
90
|
+
viewRid?: ViewRid;
|
|
91
|
+
}
|
|
92
|
+
/**
|
|
93
|
+
* A record to be published to a stream.
|
|
94
|
+
*
|
|
95
|
+
* Log Safety: DO_NOT_LOG
|
|
96
|
+
*/
|
|
97
|
+
export type _Record = Record<string, any>;
|
|
98
|
+
/**
|
|
99
|
+
* Log Safety: UNSAFE
|
|
100
|
+
*/
|
|
101
|
+
export interface ResetStreamRequest {
|
|
102
|
+
schema?: _Core.StreamSchema;
|
|
103
|
+
partitionsCount?: PartitionsCount;
|
|
104
|
+
streamType?: StreamType;
|
|
105
|
+
compressed?: Compressed;
|
|
106
|
+
}
|
|
40
107
|
/**
|
|
41
108
|
* Log Safety: UNSAFE
|
|
42
109
|
*/
|
|
43
110
|
export interface Stream {
|
|
44
111
|
branchName: _Datasets.BranchName;
|
|
112
|
+
schema: _Core.StreamSchema;
|
|
45
113
|
viewRid: ViewRid;
|
|
46
114
|
partitionsCount: PartitionsCount;
|
|
47
115
|
streamType: StreamType;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"_components.d.ts","sourceRoot":"","sources":["../../src/_components.ts"],"names":[],"mappings":"AAgBA,OAAO,KAAK,KAAK,SAAS,MAAM,wBAAwB,CAAC;AACzD,OAAO,KAAK,KAAK,WAAW,MAAM,0BAA0B,CAAC;AAE7D,MAAM,MAAM,oBAAoB,CAAC,CAAC,SAAS,MAAM,IAAI,MAAM,GAAG;IAC5D,aAAa,CAAC,EAAE,CAAC,CAAC;CACnB,CAAC;AAEF;;;;;;;KAOK;AACL,MAAM,MAAM,UAAU,GAAG,OAAO,CAAC;AAEjC;;GAEG;AACH,MAAM,WAAW,6BAA6B;IAC5C,IAAI,EAAE,SAAS,CAAC,WAAW,CAAC;IAC5B,eAAe,EAAE,WAAW,CAAC,SAAS,CAAC;IACvC,UAAU,CAAC,EAAE,SAAS,CAAC,UAAU,CAAC;IAClC,eAAe,CAAC,EAAE,eAAe,CAAC;IAClC,UAAU,CAAC,EAAE,UAAU,CAAC;IACxB,UAAU,CAAC,EAAE,UAAU,CAAC;CACzB;AAED;;GAEG;AACH,MAAM,WAAW,OAAO;IACtB,GAAG,EAAE,SAAS,CAAC,UAAU,CAAC;IAC1B,IAAI,EAAE,SAAS,CAAC,WAAW,CAAC;IAC5B,eAAe,EAAE,WAAW,CAAC,SAAS,CAAC;CACxC;AAED;;;;GAIG;AACH,MAAM,MAAM,eAAe,GAAG,MAAM,CAAC;AAErC;;GAEG;AACH,MAAM,WAAW,MAAM;IACrB,UAAU,EAAE,SAAS,CAAC,UAAU,CAAC;IACjC,OAAO,EAAE,OAAO,CAAC;IACjB,eAAe,EAAE,eAAe,CAAC;IACjC,UAAU,EAAE,UAAU,CAAC;IACvB,UAAU,EAAE,UAAU,CAAC;CACxB;AAED;;;;;;;;;;;;KAYK;AACL,MAAM,MAAM,UAAU,GAAG,aAAa,GAAG,iBAAiB,CAAC;AAE3D;;;;GAIG;AACH,MAAM,MAAM,OAAO,GAAG,oBAAoB,CAAC,SAAS,CAAC,CAAC"}
|
|
1
|
+
{"version":3,"file":"_components.d.ts","sourceRoot":"","sources":["../../src/_components.ts"],"names":[],"mappings":"AAgBA,OAAO,KAAK,KAAK,KAAK,MAAM,oBAAoB,CAAC;AACjD,OAAO,KAAK,KAAK,SAAS,MAAM,wBAAwB,CAAC;AACzD,OAAO,KAAK,KAAK,WAAW,MAAM,0BAA0B,CAAC;AAE7D,MAAM,MAAM,oBAAoB,CAAC,CAAC,SAAS,MAAM,IAAI,MAAM,GAAG;IAC5D,aAAa,CAAC,EAAE,CAAC,CAAC;CACnB,CAAC;AAEF;;;;;;;KAOK;AACL,MAAM,MAAM,UAAU,GAAG,OAAO,CAAC;AAEjC;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC,MAAM,EAAE,+BAA+B,CAAC;IACxC,eAAe,CAAC,EAAE,eAAe,CAAC;IAClC,UAAU,CAAC,EAAE,UAAU,CAAC;IACxB,UAAU,EAAE,SAAS,CAAC,UAAU,CAAC;IACjC,UAAU,CAAC,EAAE,UAAU,CAAC;CACzB;AAED;;GAEG;AACH,MAAM,WAAW,+BAA+B;IAC9C,aAAa,CAAC,EAAE,KAAK,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;IACvC,MAAM,EAAE,KAAK,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;IAC3B,iBAAiB,CAAC,EAAE,KAAK,CAAC,8BAA8B,CAAC;CAC1D;AAED;;;;;;;KAOK;AACL,MAAM,MAAM,6DAA6D,GACrE;IACA,IAAI,EAAE,SAAS,CAAC;CACjB,GACC,kGAAkG,CAAC;AAEvG;;GAEG;AACH,MAAM,WAAW,kGAAkG;IACjH,iBAAiB,EAAE,KAAK,CAAC,SAAS,CAAC;IACnC,iBAAiB,EAAE,KAAK,CAAC,SAAS,CAAC;CACpC;AAED;;GAEG;AACH,MAAM,WAAW,6BAA6B;IAC5C,IAAI,EAAE,SAAS,CAAC,WAAW,CAAC;IAC5B,eAAe,EAAE,WAAW,CAAC,SAAS,CAAC;IACvC,MAAM,EAAE,KAAK,CAAC,YAAY,CAAC;IAC3B,UAAU,CAAC,EAAE,SAAS,CAAC,UAAU,CAAC;IAClC,eAAe,CAAC,EAAE,eAAe,CAAC;IAClC,UAAU,CAAC,EAAE,UAAU,CAAC;IACxB,UAAU,CAAC,EAAE,UAAU,CAAC;CACzB;AAED;;GAEG;AACH,MAAM,WAAW,OAAO;IACtB,GAAG,EAAE,SAAS,CAAC,UAAU,CAAC;IAC1B,IAAI,EAAE,SAAS,CAAC,WAAW,CAAC;IAC5B,eAAe,EAAE,WAAW,CAAC,SAAS,CAAC;CACxC;AAED;;;;GAIG;AACH,MAAM,MAAM,eAAe,GAAG,MAAM,CAAC;AAErC;;GAEG;AACH,MAAM,WAAW,4BAA4B;IAC3C,MAAM,EAAE,OAAO,CAAC;IAChB,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB;AAED;;GAEG;AACH,MAAM,WAAW,6BAA6B;IAC5C,OAAO,EAAE,KAAK,CAAC,OAAO,CAAC,CAAC;IACxB,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB;AAED;;;;GAIG;AACH,MAAM,MAAM,OAAO,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;AAE1C;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC,MAAM,CAAC,EAAE,KAAK,CAAC,YAAY,CAAC;IAC5B,eAAe,CAAC,EAAE,eAAe,CAAC;IAClC,UAAU,CAAC,EAAE,UAAU,CAAC;IACxB,UAAU,CAAC,EAAE,UAAU,CAAC;CACzB;AAED;;GAEG;AACH,MAAM,WAAW,MAAM;IACrB,UAAU,EAAE,SAAS,CAAC,UAAU,CAAC;IACjC,MAAM,EAAE,KAAK,CAAC,YAAY,CAAC;IAC3B,OAAO,EAAE,OAAO,CAAC;IACjB,eAAe,EAAE,eAAe,CAAC;IACjC,UAAU,EAAE,UAAU,CAAC;IACvB,UAAU,EAAE,UAAU,CAAC;CACxB;AAED;;;;;;;;;;;;KAYK;AACL,MAAM,MAAM,UAAU,GAAG,aAAa,GAAG,iBAAiB,CAAC;AAE3D;;;;GAIG;AACH,MAAM,MAAM,OAAO,GAAG,oBAAoB,CAAC,SAAS,CAAC,CAAC"}
|
|
@@ -14,6 +14,46 @@ export interface CannotCreateStreamingDatasetInUserFolder {
|
|
|
14
14
|
parentFolderRid: unknown;
|
|
15
15
|
};
|
|
16
16
|
}
|
|
17
|
+
/**
|
|
18
|
+
* The view specified is not the latest view on the branch.
|
|
19
|
+
*
|
|
20
|
+
* Log Safety: SAFE
|
|
21
|
+
*/
|
|
22
|
+
export interface CannotWriteToOutdatedView {
|
|
23
|
+
errorCode: "INVALID_ARGUMENT";
|
|
24
|
+
errorName: "CannotWriteToOutdatedView";
|
|
25
|
+
errorInstanceId: string;
|
|
26
|
+
parameters: {
|
|
27
|
+
viewRid: unknown;
|
|
28
|
+
};
|
|
29
|
+
}
|
|
30
|
+
/**
|
|
31
|
+
* Cannot write to a stream that is in the trash.
|
|
32
|
+
*
|
|
33
|
+
* Log Safety: SAFE
|
|
34
|
+
*/
|
|
35
|
+
export interface CannotWriteToTrashedStream {
|
|
36
|
+
errorCode: "INVALID_ARGUMENT";
|
|
37
|
+
errorName: "CannotWriteToTrashedStream";
|
|
38
|
+
errorInstanceId: string;
|
|
39
|
+
parameters: {
|
|
40
|
+
datasetRid: unknown;
|
|
41
|
+
};
|
|
42
|
+
}
|
|
43
|
+
/**
|
|
44
|
+
* Could not create the Stream.
|
|
45
|
+
*
|
|
46
|
+
* Log Safety: UNSAFE
|
|
47
|
+
*/
|
|
48
|
+
export interface CreateStreamPermissionDenied {
|
|
49
|
+
errorCode: "PERMISSION_DENIED";
|
|
50
|
+
errorName: "CreateStreamPermissionDenied";
|
|
51
|
+
errorInstanceId: string;
|
|
52
|
+
parameters: {
|
|
53
|
+
datasetRid: unknown;
|
|
54
|
+
streamBranchName: unknown;
|
|
55
|
+
};
|
|
56
|
+
}
|
|
17
57
|
/**
|
|
18
58
|
* Could not create the Dataset.
|
|
19
59
|
*
|
|
@@ -25,6 +65,19 @@ export interface CreateStreamingDatasetPermissionDenied {
|
|
|
25
65
|
errorInstanceId: string;
|
|
26
66
|
parameters: {};
|
|
27
67
|
}
|
|
68
|
+
/**
|
|
69
|
+
* The requested stream exists but is invalid, as it does not have a schema.
|
|
70
|
+
*
|
|
71
|
+
* Log Safety: SAFE
|
|
72
|
+
*/
|
|
73
|
+
export interface InvalidStreamNoSchema {
|
|
74
|
+
errorCode: "INVALID_ARGUMENT";
|
|
75
|
+
errorName: "InvalidStreamNoSchema";
|
|
76
|
+
errorInstanceId: string;
|
|
77
|
+
parameters: {
|
|
78
|
+
viewRid: unknown;
|
|
79
|
+
};
|
|
80
|
+
}
|
|
28
81
|
/**
|
|
29
82
|
* The stream type is invalid.
|
|
30
83
|
*
|
|
@@ -38,6 +91,88 @@ export interface InvalidStreamType {
|
|
|
38
91
|
streamType: unknown;
|
|
39
92
|
};
|
|
40
93
|
}
|
|
94
|
+
/**
|
|
95
|
+
* Could not publishBinaryRecord the Stream.
|
|
96
|
+
*
|
|
97
|
+
* Log Safety: UNSAFE
|
|
98
|
+
*/
|
|
99
|
+
export interface PublishBinaryRecordToStreamPermissionDenied {
|
|
100
|
+
errorCode: "PERMISSION_DENIED";
|
|
101
|
+
errorName: "PublishBinaryRecordToStreamPermissionDenied";
|
|
102
|
+
errorInstanceId: string;
|
|
103
|
+
parameters: {
|
|
104
|
+
datasetRid: unknown;
|
|
105
|
+
streamBranchName: unknown;
|
|
106
|
+
};
|
|
107
|
+
}
|
|
108
|
+
/**
|
|
109
|
+
* Could not publishRecord the Stream.
|
|
110
|
+
*
|
|
111
|
+
* Log Safety: UNSAFE
|
|
112
|
+
*/
|
|
113
|
+
export interface PublishRecordToStreamPermissionDenied {
|
|
114
|
+
errorCode: "PERMISSION_DENIED";
|
|
115
|
+
errorName: "PublishRecordToStreamPermissionDenied";
|
|
116
|
+
errorInstanceId: string;
|
|
117
|
+
parameters: {
|
|
118
|
+
datasetRid: unknown;
|
|
119
|
+
streamBranchName: unknown;
|
|
120
|
+
};
|
|
121
|
+
}
|
|
122
|
+
/**
|
|
123
|
+
* Could not publishRecords the Stream.
|
|
124
|
+
*
|
|
125
|
+
* Log Safety: UNSAFE
|
|
126
|
+
*/
|
|
127
|
+
export interface PublishRecordsToStreamPermissionDenied {
|
|
128
|
+
errorCode: "PERMISSION_DENIED";
|
|
129
|
+
errorName: "PublishRecordsToStreamPermissionDenied";
|
|
130
|
+
errorInstanceId: string;
|
|
131
|
+
parameters: {
|
|
132
|
+
datasetRid: unknown;
|
|
133
|
+
streamBranchName: unknown;
|
|
134
|
+
};
|
|
135
|
+
}
|
|
136
|
+
/**
|
|
137
|
+
* A provided record does not match the stream schema
|
|
138
|
+
*
|
|
139
|
+
* Log Safety: UNSAFE
|
|
140
|
+
*/
|
|
141
|
+
export interface RecordDoesNotMatchStreamSchema {
|
|
142
|
+
errorCode: "INVALID_ARGUMENT";
|
|
143
|
+
errorName: "RecordDoesNotMatchStreamSchema";
|
|
144
|
+
errorInstanceId: string;
|
|
145
|
+
parameters: {
|
|
146
|
+
branchName: unknown;
|
|
147
|
+
viewRid: unknown;
|
|
148
|
+
};
|
|
149
|
+
}
|
|
150
|
+
/**
|
|
151
|
+
* A record is too large to be published to the stream. On most enrollments, the maximum record size is 1MB.
|
|
152
|
+
|
|
153
|
+
*
|
|
154
|
+
* Log Safety: SAFE
|
|
155
|
+
*/
|
|
156
|
+
export interface RecordTooLarge {
|
|
157
|
+
errorCode: "REQUEST_ENTITY_TOO_LARGE";
|
|
158
|
+
errorName: "RecordTooLarge";
|
|
159
|
+
errorInstanceId: string;
|
|
160
|
+
parameters: {};
|
|
161
|
+
}
|
|
162
|
+
/**
|
|
163
|
+
* Could not reset the Stream.
|
|
164
|
+
*
|
|
165
|
+
* Log Safety: UNSAFE
|
|
166
|
+
*/
|
|
167
|
+
export interface ResetStreamPermissionDenied {
|
|
168
|
+
errorCode: "PERMISSION_DENIED";
|
|
169
|
+
errorName: "ResetStreamPermissionDenied";
|
|
170
|
+
errorInstanceId: string;
|
|
171
|
+
parameters: {
|
|
172
|
+
datasetRid: unknown;
|
|
173
|
+
streamBranchName: unknown;
|
|
174
|
+
};
|
|
175
|
+
}
|
|
41
176
|
/**
|
|
42
177
|
* The given Stream could not be found.
|
|
43
178
|
*
|
|
@@ -52,4 +187,17 @@ export interface StreamNotFound {
|
|
|
52
187
|
streamBranchName: unknown;
|
|
53
188
|
};
|
|
54
189
|
}
|
|
190
|
+
/**
|
|
191
|
+
* No view for the view rid provided could be found.
|
|
192
|
+
*
|
|
193
|
+
* Log Safety: SAFE
|
|
194
|
+
*/
|
|
195
|
+
export interface ViewNotFound {
|
|
196
|
+
errorCode: "NOT_FOUND";
|
|
197
|
+
errorName: "ViewNotFound";
|
|
198
|
+
errorInstanceId: string;
|
|
199
|
+
parameters: {
|
|
200
|
+
viewRid: unknown;
|
|
201
|
+
};
|
|
202
|
+
}
|
|
55
203
|
//# sourceMappingURL=_errors.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"_errors.d.ts","sourceRoot":"","sources":["../../src/_errors.ts"],"names":[],"mappings":"AAgBA,MAAM,MAAM,oBAAoB,CAAC,CAAC,SAAS,MAAM,IAAI,MAAM,GAAG;IAC5D,aAAa,CAAC,EAAE,CAAC,CAAC;CACnB,CAAC;AAEF;;;;GAIG;AACH,MAAM,WAAW,wCAAwC;IACvD,SAAS,EAAE,kBAAkB,CAAC;IAC9B,SAAS,EAAE,0CAA0C,CAAC;IACtD,eAAe,EAAE,MAAM,CAAC;IACxB,UAAU,EAAE;QACV,eAAe,EAAE,OAAO,CAAC;KAC1B,CAAC;CACH;AAED;;;;GAIG;AACH,MAAM,WAAW,sCAAsC;IACrD,SAAS,EAAE,mBAAmB,CAAC;IAC/B,SAAS,EAAE,wCAAwC,CAAC;IACpD,eAAe,EAAE,MAAM,CAAC;IACxB,UAAU,EAAE,EAAE,CAAC;CAChB;AAED;;;;GAIG;AACH,MAAM,WAAW,iBAAiB;IAChC,SAAS,EAAE,kBAAkB,CAAC;IAC9B,SAAS,EAAE,mBAAmB,CAAC;IAC/B,eAAe,EAAE,MAAM,CAAC;IACxB,UAAU,EAAE;QACV,UAAU,EAAE,OAAO,CAAC;KACrB,CAAC;CACH;AAED;;;;GAIG;AACH,MAAM,WAAW,cAAc;IAC7B,SAAS,EAAE,WAAW,CAAC;IACvB,SAAS,EAAE,gBAAgB,CAAC;IAC5B,eAAe,EAAE,MAAM,CAAC;IACxB,UAAU,EAAE;QACV,UAAU,EAAE,OAAO,CAAC;QACpB,gBAAgB,EAAE,OAAO,CAAC;KAC3B,CAAC;CACH"}
|
|
1
|
+
{"version":3,"file":"_errors.d.ts","sourceRoot":"","sources":["../../src/_errors.ts"],"names":[],"mappings":"AAgBA,MAAM,MAAM,oBAAoB,CAAC,CAAC,SAAS,MAAM,IAAI,MAAM,GAAG;IAC5D,aAAa,CAAC,EAAE,CAAC,CAAC;CACnB,CAAC;AAEF;;;;GAIG;AACH,MAAM,WAAW,wCAAwC;IACvD,SAAS,EAAE,kBAAkB,CAAC;IAC9B,SAAS,EAAE,0CAA0C,CAAC;IACtD,eAAe,EAAE,MAAM,CAAC;IACxB,UAAU,EAAE;QACV,eAAe,EAAE,OAAO,CAAC;KAC1B,CAAC;CACH;AAED;;;;GAIG;AACH,MAAM,WAAW,yBAAyB;IACxC,SAAS,EAAE,kBAAkB,CAAC;IAC9B,SAAS,EAAE,2BAA2B,CAAC;IACvC,eAAe,EAAE,MAAM,CAAC;IACxB,UAAU,EAAE;QACV,OAAO,EAAE,OAAO,CAAC;KAClB,CAAC;CACH;AAED;;;;GAIG;AACH,MAAM,WAAW,0BAA0B;IACzC,SAAS,EAAE,kBAAkB,CAAC;IAC9B,SAAS,EAAE,4BAA4B,CAAC;IACxC,eAAe,EAAE,MAAM,CAAC;IACxB,UAAU,EAAE;QACV,UAAU,EAAE,OAAO,CAAC;KACrB,CAAC;CACH;AAED;;;;GAIG;AACH,MAAM,WAAW,4BAA4B;IAC3C,SAAS,EAAE,mBAAmB,CAAC;IAC/B,SAAS,EAAE,8BAA8B,CAAC;IAC1C,eAAe,EAAE,MAAM,CAAC;IACxB,UAAU,EAAE;QACV,UAAU,EAAE,OAAO,CAAC;QACpB,gBAAgB,EAAE,OAAO,CAAC;KAC3B,CAAC;CACH;AAED;;;;GAIG;AACH,MAAM,WAAW,sCAAsC;IACrD,SAAS,EAAE,mBAAmB,CAAC;IAC/B,SAAS,EAAE,wCAAwC,CAAC;IACpD,eAAe,EAAE,MAAM,CAAC;IACxB,UAAU,EAAE,EAAE,CAAC;CAChB;AAED;;;;GAIG;AACH,MAAM,WAAW,qBAAqB;IACpC,SAAS,EAAE,kBAAkB,CAAC;IAC9B,SAAS,EAAE,uBAAuB,CAAC;IACnC,eAAe,EAAE,MAAM,CAAC;IACxB,UAAU,EAAE;QACV,OAAO,EAAE,OAAO,CAAC;KAClB,CAAC;CACH;AAED;;;;GAIG;AACH,MAAM,WAAW,iBAAiB;IAChC,SAAS,EAAE,kBAAkB,CAAC;IAC9B,SAAS,EAAE,mBAAmB,CAAC;IAC/B,eAAe,EAAE,MAAM,CAAC;IACxB,UAAU,EAAE;QACV,UAAU,EAAE,OAAO,CAAC;KACrB,CAAC;CACH;AAED;;;;GAIG;AACH,MAAM,WAAW,2CAA2C;IAC1D,SAAS,EAAE,mBAAmB,CAAC;IAC/B,SAAS,EAAE,6CAA6C,CAAC;IACzD,eAAe,EAAE,MAAM,CAAC;IACxB,UAAU,EAAE;QACV,UAAU,EAAE,OAAO,CAAC;QACpB,gBAAgB,EAAE,OAAO,CAAC;KAC3B,CAAC;CACH;AAED;;;;GAIG;AACH,MAAM,WAAW,qCAAqC;IACpD,SAAS,EAAE,mBAAmB,CAAC;IAC/B,SAAS,EAAE,uCAAuC,CAAC;IACnD,eAAe,EAAE,MAAM,CAAC;IACxB,UAAU,EAAE;QACV,UAAU,EAAE,OAAO,CAAC;QACpB,gBAAgB,EAAE,OAAO,CAAC;KAC3B,CAAC;CACH;AAED;;;;GAIG;AACH,MAAM,WAAW,sCAAsC;IACrD,SAAS,EAAE,mBAAmB,CAAC;IAC/B,SAAS,EAAE,wCAAwC,CAAC;IACpD,eAAe,EAAE,MAAM,CAAC;IACxB,UAAU,EAAE;QACV,UAAU,EAAE,OAAO,CAAC;QACpB,gBAAgB,EAAE,OAAO,CAAC;KAC3B,CAAC;CACH;AAED;;;;GAIG;AACH,MAAM,WAAW,8BAA8B;IAC7C,SAAS,EAAE,kBAAkB,CAAC;IAC9B,SAAS,EAAE,gCAAgC,CAAC;IAC5C,eAAe,EAAE,MAAM,CAAC;IACxB,UAAU,EAAE;QACV,UAAU,EAAE,OAAO,CAAC;QACpB,OAAO,EAAE,OAAO,CAAC;KAClB,CAAC;CACH;AAED;;;;;KAKK;AACL,MAAM,WAAW,cAAc;IAC7B,SAAS,EAAE,0BAA0B,CAAC;IACtC,SAAS,EAAE,gBAAgB,CAAC;IAC5B,eAAe,EAAE,MAAM,CAAC;IACxB,UAAU,EAAE,EAAE,CAAC;CAChB;AAED;;;;GAIG;AACH,MAAM,WAAW,2BAA2B;IAC1C,SAAS,EAAE,mBAAmB,CAAC;IAC/B,SAAS,EAAE,6BAA6B,CAAC;IACzC,eAAe,EAAE,MAAM,CAAC;IACxB,UAAU,EAAE;QACV,UAAU,EAAE,OAAO,CAAC;QACpB,gBAAgB,EAAE,OAAO,CAAC;KAC3B,CAAC;CACH;AAED;;;;GAIG;AACH,MAAM,WAAW,cAAc;IAC7B,SAAS,EAAE,WAAW,CAAC;IACvB,SAAS,EAAE,gBAAgB,CAAC;IAC5B,eAAe,EAAE,MAAM,CAAC;IACxB,UAAU,EAAE;QACV,UAAU,EAAE,OAAO,CAAC;QACpB,gBAAgB,EAAE,OAAO,CAAC;KAC3B,CAAC;CACH;AAED;;;;GAIG;AACH,MAAM,WAAW,YAAY;IAC3B,SAAS,EAAE,WAAW,CAAC;IACvB,SAAS,EAAE,cAAc,CAAC;IAC1B,eAAe,EAAE,MAAM,CAAC;IACxB,UAAU,EAAE;QACV,OAAO,EAAE,OAAO,CAAC;KAClB,CAAC;CACH"}
|
package/build/browser/index.d.ts
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
|
-
export type { Compressed, CreateStreamingDatasetRequest, Dataset, PartitionsCount, Stream, StreamType, ViewRid, } from "./_components.js";
|
|
2
|
-
export type { CannotCreateStreamingDatasetInUserFolder, CreateStreamingDatasetPermissionDenied, InvalidStreamType, StreamNotFound, } from "./_errors.js";
|
|
1
|
+
export type { _Record, Compressed, CreateStreamingDatasetRequest, CreateStreamRequest, CreateStreamRequestStreamSchema, CreateStreamRequestStreamSchemaChangeDataCaptureConfiguration, CreateStreamRequestStreamSchemaChangeDataCaptureConfigurationFullRowChangeDataCaptureConfiguration, Dataset, PartitionsCount, PublishRecordsToStreamRequest, PublishRecordToStreamRequest, ResetStreamRequest, Stream, StreamType, ViewRid, } from "./_components.js";
|
|
2
|
+
export type { CannotCreateStreamingDatasetInUserFolder, CannotWriteToOutdatedView, CannotWriteToTrashedStream, CreateStreamingDatasetPermissionDenied, CreateStreamPermissionDenied, InvalidStreamNoSchema, InvalidStreamType, PublishBinaryRecordToStreamPermissionDenied, PublishRecordsToStreamPermissionDenied, PublishRecordToStreamPermissionDenied, RecordDoesNotMatchStreamSchema, RecordTooLarge, ResetStreamPermissionDenied, StreamNotFound, ViewNotFound, } from "./_errors.js";
|
|
3
3
|
export * as Datasets from "./public/Dataset.js";
|
|
4
4
|
export * as Streams from "./public/Stream.js";
|
|
5
5
|
//# sourceMappingURL=index.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAgBA,YAAY,EACV,UAAU,EACV,6BAA6B,EAC7B,OAAO,EACP,eAAe,EACf,MAAM,EACN,UAAU,EACV,OAAO,GACR,MAAM,kBAAkB,CAAC;AAC1B,YAAY,EACV,wCAAwC,EACxC,sCAAsC,EACtC,iBAAiB,EACjB,cAAc,
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAgBA,YAAY,EACV,OAAO,EACP,UAAU,EACV,6BAA6B,EAC7B,mBAAmB,EACnB,+BAA+B,EAC/B,6DAA6D,EAC7D,kGAAkG,EAClG,OAAO,EACP,eAAe,EACf,6BAA6B,EAC7B,4BAA4B,EAC5B,kBAAkB,EAClB,MAAM,EACN,UAAU,EACV,OAAO,GACR,MAAM,kBAAkB,CAAC;AAC1B,YAAY,EACV,wCAAwC,EACxC,yBAAyB,EACzB,0BAA0B,EAC1B,sCAAsC,EACtC,4BAA4B,EAC5B,qBAAqB,EACrB,iBAAiB,EACjB,2CAA2C,EAC3C,sCAAsC,EACtC,qCAAqC,EACrC,8BAA8B,EAC9B,cAAc,EACd,2BAA2B,EAC3B,cAAc,EACd,YAAY,GACb,MAAM,cAAc,CAAC;AACtB,OAAO,KAAK,QAAQ,MAAM,qBAAqB,CAAC;AAChD,OAAO,KAAK,OAAO,MAAM,oBAAoB,CAAC"}
|
|
@@ -1,5 +1,6 @@
|
|
|
1
1
|
import type * as _Core from "@osdk/foundry.core";
|
|
2
|
-
import type { SharedClient as $
|
|
2
|
+
import type { SharedClient as $OldClient, SharedClientContext as $OldClientContext } from "@osdk/shared.client";
|
|
3
|
+
import type { SharedClient as $Client, SharedClientContext as $ClientContext } from "@osdk/shared.client2";
|
|
3
4
|
import type * as _Streams from "../_components.js";
|
|
4
5
|
/**
|
|
5
6
|
* Creates a streaming dataset with a stream on the specified branch, or if no branch is specified, on the
|
|
@@ -8,10 +9,10 @@ import type * as _Streams from "../_components.js";
|
|
|
8
9
|
*
|
|
9
10
|
* @alpha
|
|
10
11
|
*
|
|
11
|
-
* Required Scopes: [api:
|
|
12
|
+
* Required Scopes: [api:streams-write]
|
|
12
13
|
* URL: /v2/streams/datasets/create
|
|
13
14
|
*/
|
|
14
|
-
export declare function create($ctx: $Client | $ClientContext, ...args: [
|
|
15
|
+
export declare function create($ctx: $Client | $ClientContext | $OldClient | $OldClientContext, ...args: [
|
|
15
16
|
$body: _Streams.CreateStreamingDatasetRequest,
|
|
16
17
|
$queryParams?: {
|
|
17
18
|
preview?: _Core.PreviewMode | undefined;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"Dataset.d.ts","sourceRoot":"","sources":["../../../src/public/Dataset.ts"],"names":[],"mappings":"AAgBA,OAAO,KAAK,KAAK,KAAK,MAAM,oBAAoB,CAAC;AACjD,OAAO,KAAK,EACV,YAAY,IAAI,OAAO,EACvB,mBAAmB,IAAI,cAAc,EACtC,MAAM,
|
|
1
|
+
{"version":3,"file":"Dataset.d.ts","sourceRoot":"","sources":["../../../src/public/Dataset.ts"],"names":[],"mappings":"AAgBA,OAAO,KAAK,KAAK,KAAK,MAAM,oBAAoB,CAAC;AACjD,OAAO,KAAK,EACV,YAAY,IAAI,UAAU,EAC1B,mBAAmB,IAAI,iBAAiB,EACzC,MAAM,qBAAqB,CAAC;AAC7B,OAAO,KAAK,EACV,YAAY,IAAI,OAAO,EACvB,mBAAmB,IAAI,cAAc,EACtC,MAAM,sBAAsB,CAAC;AAG9B,OAAO,KAAK,KAAK,QAAQ,MAAM,mBAAmB,CAAC;AAWnD;;;;;;;;;GASG;AACH,wBAAgB,MAAM,CACpB,IAAI,EAAE,OAAO,GAAG,cAAc,GAAG,UAAU,GAAG,iBAAiB,EAC/D,GAAG,IAAI,EAAE;IACP,KAAK,EAAE,QAAQ,CAAC,6BAA6B;IAC7C,YAAY,CAAC,EAAE;QAAE,OAAO,CAAC,EAAE,KAAK,CAAC,WAAW,GAAG,SAAS,CAAA;KAAE;CAC3D,GACA,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAC,CAE3B"}
|
|
@@ -23,7 +23,7 @@ const _create = [1, "/v2/streams/datasets/create", 3];
|
|
|
23
23
|
*
|
|
24
24
|
* @alpha
|
|
25
25
|
*
|
|
26
|
-
* Required Scopes: [api:
|
|
26
|
+
* Required Scopes: [api:streams-write]
|
|
27
27
|
* URL: /v2/streams/datasets/create
|
|
28
28
|
*/
|
|
29
29
|
export function create($ctx, ...args) {
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"Dataset.js","names":["foundryPlatformFetch","$foundryPlatformFetch","_create","create","$ctx","args"],"sources":["Dataset.js"],"sourcesContent":["/*\n * Copyright 2024 Palantir Technologies, Inc. All rights reserved.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\nimport { foundryPlatformFetch as $foundryPlatformFetch } from \"@osdk/shared.net.platformapi\";\n//\nconst _create = [1, \"/v2/streams/datasets/create\", 3];\n/**\n * Creates a streaming dataset with a stream on the specified branch, or if no branch is specified, on the\n * default branch ('master' for most enrollments). For more information on streaming datasets, refer to the\n * [streams](https://www.palantir.com/docs/foundry/data-integration/streams/) user documentation.\n *\n * @alpha\n *\n * Required Scopes: [api:
|
|
1
|
+
{"version":3,"file":"Dataset.js","names":["foundryPlatformFetch","$foundryPlatformFetch","_create","create","$ctx","args"],"sources":["Dataset.js"],"sourcesContent":["/*\n * Copyright 2024 Palantir Technologies, Inc. All rights reserved.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\nimport { foundryPlatformFetch as $foundryPlatformFetch } from \"@osdk/shared.net.platformapi\";\n//\nconst _create = [1, \"/v2/streams/datasets/create\", 3];\n/**\n * Creates a streaming dataset with a stream on the specified branch, or if no branch is specified, on the\n * default branch ('master' for most enrollments). For more information on streaming datasets, refer to the\n * [streams](https://www.palantir.com/docs/foundry/data-integration/streams/) user documentation.\n *\n * @alpha\n *\n * Required Scopes: [api:streams-write]\n * URL: /v2/streams/datasets/create\n */\nexport function create($ctx, ...args) {\n return $foundryPlatformFetch($ctx, _create, ...args);\n}\n"],"mappings":"AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,SAASA,oBAAoB,IAAIC,qBAAqB,QAAQ,8BAA8B;AAC5F;AACA,MAAMC,OAAO,GAAG,CAAC,CAAC,EAAE,6BAA6B,EAAE,CAAC,CAAC;AACrD;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASC,MAAMA,CAACC,IAAI,EAAE,GAAGC,IAAI,EAAE;EAClC,OAAOJ,qBAAqB,CAACG,IAAI,EAAEF,OAAO,EAAE,GAAGG,IAAI,CAAC;AACxD","ignoreList":[]}
|
|
@@ -1,19 +1,108 @@
|
|
|
1
1
|
import type * as _Core from "@osdk/foundry.core";
|
|
2
2
|
import type * as _Datasets from "@osdk/foundry.datasets";
|
|
3
|
-
import type { SharedClient as $
|
|
3
|
+
import type { SharedClient as $OldClient, SharedClientContext as $OldClientContext } from "@osdk/shared.client";
|
|
4
|
+
import type { SharedClient as $Client, SharedClientContext as $ClientContext } from "@osdk/shared.client2";
|
|
4
5
|
import type * as _Streams from "../_components.js";
|
|
6
|
+
/**
|
|
7
|
+
* Creates a new branch on the backing streaming dataset, and creates a new stream on that branch.
|
|
8
|
+
*
|
|
9
|
+
* @alpha
|
|
10
|
+
*
|
|
11
|
+
* Required Scopes: [api:streams-write]
|
|
12
|
+
* URL: /v2/streams/datasets/{datasetRid}/streams
|
|
13
|
+
*/
|
|
14
|
+
export declare function create($ctx: $Client | $ClientContext | $OldClient | $OldClientContext, ...args: [
|
|
15
|
+
datasetRid: _Datasets.DatasetRid,
|
|
16
|
+
$body: _Streams.CreateStreamRequest,
|
|
17
|
+
$queryParams?: {
|
|
18
|
+
preview?: _Core.PreviewMode | undefined;
|
|
19
|
+
}
|
|
20
|
+
]): Promise<_Streams.Stream>;
|
|
5
21
|
/**
|
|
6
22
|
* Get a stream by its branch name. If the branch does not exist, there is no stream on that branch, or the
|
|
7
23
|
* user does not have permission to access the stream, a 404 error will be returned.
|
|
8
24
|
*
|
|
9
25
|
* @alpha
|
|
10
26
|
*
|
|
11
|
-
* Required Scopes: [api:
|
|
27
|
+
* Required Scopes: [api:streams-read]
|
|
12
28
|
* URL: /v2/streams/datasets/{datasetRid}/streams/{streamBranchName}
|
|
13
29
|
*/
|
|
14
|
-
export declare function get($ctx: $Client | $ClientContext, ...args: [
|
|
30
|
+
export declare function get($ctx: $Client | $ClientContext | $OldClient | $OldClientContext, ...args: [
|
|
31
|
+
datasetRid: _Datasets.DatasetRid,
|
|
32
|
+
streamBranchName: _Datasets.BranchName,
|
|
33
|
+
$queryParams?: {
|
|
34
|
+
preview?: _Core.PreviewMode | undefined;
|
|
35
|
+
}
|
|
36
|
+
]): Promise<_Streams.Stream>;
|
|
37
|
+
/**
|
|
38
|
+
* Publish a single record to the stream. The record will be validated against the stream's schema, and
|
|
39
|
+
* rejected if it is invalid.
|
|
40
|
+
*
|
|
41
|
+
* @alpha
|
|
42
|
+
*
|
|
43
|
+
* Required Scopes: [api:streams-write]
|
|
44
|
+
* URL: /v2/highScale/streams/datasets/{datasetRid}/streams/{streamBranchName}/publishRecord
|
|
45
|
+
*/
|
|
46
|
+
export declare function publishRecord($ctx: $Client | $ClientContext | $OldClient | $OldClientContext, ...args: [
|
|
47
|
+
datasetRid: _Datasets.DatasetRid,
|
|
48
|
+
streamBranchName: _Datasets.BranchName,
|
|
49
|
+
$body: _Streams.PublishRecordToStreamRequest,
|
|
50
|
+
$queryParams?: {
|
|
51
|
+
preview?: _Core.PreviewMode | undefined;
|
|
52
|
+
}
|
|
53
|
+
]): Promise<void>;
|
|
54
|
+
/**
|
|
55
|
+
* Publish a batch of records to the stream. The records will be validated against the stream's schema, and
|
|
56
|
+
* the batch will be rejected if one or more of the records are invalid.
|
|
57
|
+
*
|
|
58
|
+
* @alpha
|
|
59
|
+
*
|
|
60
|
+
* Required Scopes: [api:streams-write]
|
|
61
|
+
* URL: /v2/highScale/streams/datasets/{datasetRid}/streams/{streamBranchName}/publishRecords
|
|
62
|
+
*/
|
|
63
|
+
export declare function publishRecords($ctx: $Client | $ClientContext | $OldClient | $OldClientContext, ...args: [
|
|
64
|
+
datasetRid: _Datasets.DatasetRid,
|
|
65
|
+
streamBranchName: _Datasets.BranchName,
|
|
66
|
+
$body: _Streams.PublishRecordsToStreamRequest,
|
|
67
|
+
$queryParams?: {
|
|
68
|
+
preview?: _Core.PreviewMode | undefined;
|
|
69
|
+
}
|
|
70
|
+
]): Promise<void>;
|
|
71
|
+
/**
|
|
72
|
+
* Publish a single binary record to the stream. The stream's schema must be a single binary field.
|
|
73
|
+
*
|
|
74
|
+
* @alpha
|
|
75
|
+
*
|
|
76
|
+
* Required Scopes: [api:streams-write]
|
|
77
|
+
* URL: /v2/highScale/streams/datasets/{datasetRid}/streams/{streamBranchName}/publishBinaryRecord
|
|
78
|
+
*/
|
|
79
|
+
export declare function publishBinaryRecord($ctx: $Client | $ClientContext | $OldClient | $OldClientContext, ...args: [
|
|
80
|
+
datasetRid: _Datasets.DatasetRid,
|
|
81
|
+
streamBranchName: _Datasets.BranchName,
|
|
82
|
+
$body: Blob,
|
|
83
|
+
$queryParams?: {
|
|
84
|
+
viewRid?: _Streams.ViewRid | undefined;
|
|
85
|
+
preview?: _Core.PreviewMode | undefined;
|
|
86
|
+
}
|
|
87
|
+
]): Promise<void>;
|
|
88
|
+
/**
|
|
89
|
+
* Reset the stream on the given dataset branch, clearing the existing records and allowing new configurations
|
|
90
|
+
* to be applied.
|
|
91
|
+
*
|
|
92
|
+
* To change the stream settings without clearing the records, update the stream settings in-platform.
|
|
93
|
+
*
|
|
94
|
+
* This will create a new stream view (as seen by the change of the `viewRid` on the branch),
|
|
95
|
+
* which will be the new stream view that will be written to for the branch.
|
|
96
|
+
*
|
|
97
|
+
* @alpha
|
|
98
|
+
*
|
|
99
|
+
* Required Scopes: [api:streams-write]
|
|
100
|
+
* URL: /v2/streams/datasets/{datasetRid}/streams/{streamBranchName}/reset
|
|
101
|
+
*/
|
|
102
|
+
export declare function reset($ctx: $Client | $ClientContext | $OldClient | $OldClientContext, ...args: [
|
|
15
103
|
datasetRid: _Datasets.DatasetRid,
|
|
16
104
|
streamBranchName: _Datasets.BranchName,
|
|
105
|
+
$body: _Streams.ResetStreamRequest,
|
|
17
106
|
$queryParams?: {
|
|
18
107
|
preview?: _Core.PreviewMode | undefined;
|
|
19
108
|
}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"Stream.d.ts","sourceRoot":"","sources":["../../../src/public/Stream.ts"],"names":[],"mappings":"AAgBA,OAAO,KAAK,KAAK,KAAK,MAAM,oBAAoB,CAAC;AACjD,OAAO,KAAK,KAAK,SAAS,MAAM,wBAAwB,CAAC;AACzD,OAAO,KAAK,EACV,YAAY,IAAI,OAAO,EACvB,mBAAmB,IAAI,cAAc,EACtC,MAAM,
|
|
1
|
+
{"version":3,"file":"Stream.d.ts","sourceRoot":"","sources":["../../../src/public/Stream.ts"],"names":[],"mappings":"AAgBA,OAAO,KAAK,KAAK,KAAK,MAAM,oBAAoB,CAAC;AACjD,OAAO,KAAK,KAAK,SAAS,MAAM,wBAAwB,CAAC;AACzD,OAAO,KAAK,EACV,YAAY,IAAI,UAAU,EAC1B,mBAAmB,IAAI,iBAAiB,EACzC,MAAM,qBAAqB,CAAC;AAC7B,OAAO,KAAK,EACV,YAAY,IAAI,OAAO,EACvB,mBAAmB,IAAI,cAAc,EACtC,MAAM,sBAAsB,CAAC;AAG9B,OAAO,KAAK,KAAK,QAAQ,MAAM,mBAAmB,CAAC;AAYnD;;;;;;;GAOG;AACH,wBAAgB,MAAM,CACpB,IAAI,EAAE,OAAO,GAAG,cAAc,GAAG,UAAU,GAAG,iBAAiB,EAC/D,GAAG,IAAI,EAAE;IACP,UAAU,EAAE,SAAS,CAAC,UAAU;IAChC,KAAK,EAAE,QAAQ,CAAC,mBAAmB;IACnC,YAAY,CAAC,EAAE;QAAE,OAAO,CAAC,EAAE,KAAK,CAAC,WAAW,GAAG,SAAS,CAAA;KAAE;CAC3D,GACA,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAC,CAE1B;AAUD;;;;;;;;GAQG;AACH,wBAAgB,GAAG,CACjB,IAAI,EAAE,OAAO,GAAG,cAAc,GAAG,UAAU,GAAG,iBAAiB,EAC/D,GAAG,IAAI,EAAE;IACP,UAAU,EAAE,SAAS,CAAC,UAAU;IAChC,gBAAgB,EAAE,SAAS,CAAC,UAAU;IAEtC,YAAY,CAAC,EAAE;QAAE,OAAO,CAAC,EAAE,KAAK,CAAC,WAAW,GAAG,SAAS,CAAA;KAAE;CAC3D,GACA,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAC,CAE1B;AAWD;;;;;;;;GAQG;AACH,wBAAgB,aAAa,CAC3B,IAAI,EAAE,OAAO,GAAG,cAAc,GAAG,UAAU,GAAG,iBAAiB,EAC/D,GAAG,IAAI,EAAE;IACP,UAAU,EAAE,SAAS,CAAC,UAAU;IAChC,gBAAgB,EAAE,SAAS,CAAC,UAAU;IACtC,KAAK,EAAE,QAAQ,CAAC,4BAA4B;IAC5C,YAAY,CAAC,EAAE;QAAE,OAAO,CAAC,EAAE,KAAK,CAAC,WAAW,GAAG,SAAS,CAAA;KAAE;CAC3D,GACA,OAAO,CAAC,IAAI,CAAC,CAEf;AAWD;;;;;;;;GAQG;AACH,wBAAgB,cAAc,CAC5B,IAAI,EAAE,OAAO,GAAG,cAAc,GAAG,UAAU,GAAG,iBAAiB,EAC/D,GAAG,IAAI,EAAE;IACP,UAAU,EAAE,SAAS,CAAC,UAAU;IAChC,gBAAgB,EAAE,SAAS,CAAC,UAAU;IACtC,KAAK,EAAE,QAAQ,CAAC,6BAA6B;IAC7C,YAAY,CAAC,EAAE;QAAE,OAAO,CAAC,EAAE,KAAK,CAAC,WAAW,GAAG,SAAS,CAAA;KAAE;CAC3D,GACA,OAAO,CAAC,IAAI,CAAC,CAEf;AAmBD;;;;;;;GAOG;AACH,wBAAgB,mBAAmB,CACjC,IAAI,EAAE,OAAO,GAAG,cAAc,GAAG,UAAU,GAAG,iBAAiB,EAC/D,GAAG,IAAI,EAAE;IACP,UAAU,EAAE,SAAS,CAAC,UAAU;IAChC,gBAAgB,EAAE,SAAS,CAAC,UAAU;IACtC,KAAK,EAAE,IAAI;IACX,YAAY,CAAC,EAAE;QACb,OAAO,CAAC,EAAE,QAAQ,CAAC,OAAO,GAAG,SAAS,CAAC;QACvC,OAAO,CAAC,EAAE,KAAK,CAAC,WAAW,GAAG,SAAS,CAAC;KACzC;CACF,GACA,OAAO,CAAC,IAAI,CAAC,CAEf;AAWD;;;;;;;;;;;;;GAaG;AACH,wBAAgB,KAAK,CACnB,IAAI,EAAE,OAAO,GAAG,cAAc,GAAG,UAAU,GAAG,iBAAiB,EAC/D,GAAG,IAAI,EAAE;IACP,UAAU,EAAE,SAAS,CAAC,UAAU;IAChC,gBAAgB,EAAE,SAAS,CAAC,UAAU;IACtC,KAAK,EAAE,QAAQ,CAAC,kBAAkB;IAClC,YAAY,CAAC,EAAE;QAAE,OAAO,CAAC,EAAE,KAAK,CAAC,WAAW,GAAG,SAAS,CAAA;KAAE;CAC3D,GACA,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAC,CAE1B"}
|
|
@@ -15,6 +15,18 @@
|
|
|
15
15
|
*/
|
|
16
16
|
import { foundryPlatformFetch as $foundryPlatformFetch } from "@osdk/shared.net.platformapi";
|
|
17
17
|
//
|
|
18
|
+
const _create = [1, "/v2/streams/datasets/{0}/streams", 3];
|
|
19
|
+
/**
|
|
20
|
+
* Creates a new branch on the backing streaming dataset, and creates a new stream on that branch.
|
|
21
|
+
*
|
|
22
|
+
* @alpha
|
|
23
|
+
*
|
|
24
|
+
* Required Scopes: [api:streams-write]
|
|
25
|
+
* URL: /v2/streams/datasets/{datasetRid}/streams
|
|
26
|
+
*/
|
|
27
|
+
export function create($ctx, ...args) {
|
|
28
|
+
return $foundryPlatformFetch($ctx, _create, ...args);
|
|
29
|
+
}
|
|
18
30
|
const _get = [0, "/v2/streams/datasets/{0}/streams/{1}", 2];
|
|
19
31
|
/**
|
|
20
32
|
* Get a stream by its branch name. If the branch does not exist, there is no stream on that branch, or the
|
|
@@ -22,10 +34,66 @@ const _get = [0, "/v2/streams/datasets/{0}/streams/{1}", 2];
|
|
|
22
34
|
*
|
|
23
35
|
* @alpha
|
|
24
36
|
*
|
|
25
|
-
* Required Scopes: [api:
|
|
37
|
+
* Required Scopes: [api:streams-read]
|
|
26
38
|
* URL: /v2/streams/datasets/{datasetRid}/streams/{streamBranchName}
|
|
27
39
|
*/
|
|
28
40
|
export function get($ctx, ...args) {
|
|
29
41
|
return $foundryPlatformFetch($ctx, _get, ...args);
|
|
30
42
|
}
|
|
43
|
+
const _publishRecord = [1, "/v2/highScale/streams/datasets/{0}/streams/{1}/publishRecord", 3];
|
|
44
|
+
/**
|
|
45
|
+
* Publish a single record to the stream. The record will be validated against the stream's schema, and
|
|
46
|
+
* rejected if it is invalid.
|
|
47
|
+
*
|
|
48
|
+
* @alpha
|
|
49
|
+
*
|
|
50
|
+
* Required Scopes: [api:streams-write]
|
|
51
|
+
* URL: /v2/highScale/streams/datasets/{datasetRid}/streams/{streamBranchName}/publishRecord
|
|
52
|
+
*/
|
|
53
|
+
export function publishRecord($ctx, ...args) {
|
|
54
|
+
return $foundryPlatformFetch($ctx, _publishRecord, ...args);
|
|
55
|
+
}
|
|
56
|
+
const _publishRecords = [1, "/v2/highScale/streams/datasets/{0}/streams/{1}/publishRecords", 3];
|
|
57
|
+
/**
|
|
58
|
+
* Publish a batch of records to the stream. The records will be validated against the stream's schema, and
|
|
59
|
+
* the batch will be rejected if one or more of the records are invalid.
|
|
60
|
+
*
|
|
61
|
+
* @alpha
|
|
62
|
+
*
|
|
63
|
+
* Required Scopes: [api:streams-write]
|
|
64
|
+
* URL: /v2/highScale/streams/datasets/{datasetRid}/streams/{streamBranchName}/publishRecords
|
|
65
|
+
*/
|
|
66
|
+
export function publishRecords($ctx, ...args) {
|
|
67
|
+
return $foundryPlatformFetch($ctx, _publishRecords, ...args);
|
|
68
|
+
}
|
|
69
|
+
const _publishBinaryRecord = [1, "/v2/highScale/streams/datasets/{0}/streams/{1}/publishBinaryRecord", 3, "application/octet-stream"];
|
|
70
|
+
/**
|
|
71
|
+
* Publish a single binary record to the stream. The stream's schema must be a single binary field.
|
|
72
|
+
*
|
|
73
|
+
* @alpha
|
|
74
|
+
*
|
|
75
|
+
* Required Scopes: [api:streams-write]
|
|
76
|
+
* URL: /v2/highScale/streams/datasets/{datasetRid}/streams/{streamBranchName}/publishBinaryRecord
|
|
77
|
+
*/
|
|
78
|
+
export function publishBinaryRecord($ctx, ...args) {
|
|
79
|
+
return $foundryPlatformFetch($ctx, _publishBinaryRecord, ...args);
|
|
80
|
+
}
|
|
81
|
+
const _reset = [1, "/v2/streams/datasets/{0}/streams/{1}/reset", 3];
|
|
82
|
+
/**
|
|
83
|
+
* Reset the stream on the given dataset branch, clearing the existing records and allowing new configurations
|
|
84
|
+
* to be applied.
|
|
85
|
+
*
|
|
86
|
+
* To change the stream settings without clearing the records, update the stream settings in-platform.
|
|
87
|
+
*
|
|
88
|
+
* This will create a new stream view (as seen by the change of the `viewRid` on the branch),
|
|
89
|
+
* which will be the new stream view that will be written to for the branch.
|
|
90
|
+
*
|
|
91
|
+
* @alpha
|
|
92
|
+
*
|
|
93
|
+
* Required Scopes: [api:streams-write]
|
|
94
|
+
* URL: /v2/streams/datasets/{datasetRid}/streams/{streamBranchName}/reset
|
|
95
|
+
*/
|
|
96
|
+
export function reset($ctx, ...args) {
|
|
97
|
+
return $foundryPlatformFetch($ctx, _reset, ...args);
|
|
98
|
+
}
|
|
31
99
|
//# sourceMappingURL=Stream.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"Stream.js","names":["foundryPlatformFetch","$foundryPlatformFetch","
|
|
1
|
+
{"version":3,"file":"Stream.js","names":["foundryPlatformFetch","$foundryPlatformFetch","_create","create","$ctx","args","_get","get","_publishRecord","publishRecord","_publishRecords","publishRecords","_publishBinaryRecord","publishBinaryRecord","_reset","reset"],"sources":["Stream.js"],"sourcesContent":["/*\n * Copyright 2024 Palantir Technologies, Inc. All rights reserved.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\nimport { foundryPlatformFetch as $foundryPlatformFetch } from \"@osdk/shared.net.platformapi\";\n//\nconst _create = [1, \"/v2/streams/datasets/{0}/streams\", 3];\n/**\n * Creates a new branch on the backing streaming dataset, and creates a new stream on that branch.\n *\n * @alpha\n *\n * Required Scopes: [api:streams-write]\n * URL: /v2/streams/datasets/{datasetRid}/streams\n */\nexport function create($ctx, ...args) {\n return $foundryPlatformFetch($ctx, _create, ...args);\n}\nconst _get = [0, \"/v2/streams/datasets/{0}/streams/{1}\", 2];\n/**\n * Get a stream by its branch name. If the branch does not exist, there is no stream on that branch, or the\n * user does not have permission to access the stream, a 404 error will be returned.\n *\n * @alpha\n *\n * Required Scopes: [api:streams-read]\n * URL: /v2/streams/datasets/{datasetRid}/streams/{streamBranchName}\n */\nexport function get($ctx, ...args) {\n return $foundryPlatformFetch($ctx, _get, ...args);\n}\nconst _publishRecord = [1, \"/v2/highScale/streams/datasets/{0}/streams/{1}/publishRecord\", 3];\n/**\n * Publish a single record to the stream. The record will be validated against the stream's schema, and\n * rejected if it is invalid.\n *\n * @alpha\n *\n * Required Scopes: [api:streams-write]\n * URL: /v2/highScale/streams/datasets/{datasetRid}/streams/{streamBranchName}/publishRecord\n */\nexport function publishRecord($ctx, ...args) {\n return $foundryPlatformFetch($ctx, _publishRecord, ...args);\n}\nconst _publishRecords = [1, \"/v2/highScale/streams/datasets/{0}/streams/{1}/publishRecords\", 3];\n/**\n * Publish a batch of records to the stream. The records will be validated against the stream's schema, and\n * the batch will be rejected if one or more of the records are invalid.\n *\n * @alpha\n *\n * Required Scopes: [api:streams-write]\n * URL: /v2/highScale/streams/datasets/{datasetRid}/streams/{streamBranchName}/publishRecords\n */\nexport function publishRecords($ctx, ...args) {\n return $foundryPlatformFetch($ctx, _publishRecords, ...args);\n}\nconst _publishBinaryRecord = [\n 1,\n \"/v2/highScale/streams/datasets/{0}/streams/{1}/publishBinaryRecord\",\n 3,\n \"application/octet-stream\",\n];\n/**\n * Publish a single binary record to the stream. The stream's schema must be a single binary field.\n *\n * @alpha\n *\n * Required Scopes: [api:streams-write]\n * URL: /v2/highScale/streams/datasets/{datasetRid}/streams/{streamBranchName}/publishBinaryRecord\n */\nexport function publishBinaryRecord($ctx, ...args) {\n return $foundryPlatformFetch($ctx, _publishBinaryRecord, ...args);\n}\nconst _reset = [1, \"/v2/streams/datasets/{0}/streams/{1}/reset\", 3];\n/**\n * Reset the stream on the given dataset branch, clearing the existing records and allowing new configurations\n * to be applied.\n *\n * To change the stream settings without clearing the records, update the stream settings in-platform.\n *\n * This will create a new stream view (as seen by the change of the `viewRid` on the branch),\n * which will be the new stream view that will be written to for the branch.\n *\n * @alpha\n *\n * Required Scopes: [api:streams-write]\n * URL: /v2/streams/datasets/{datasetRid}/streams/{streamBranchName}/reset\n */\nexport function reset($ctx, ...args) {\n return $foundryPlatformFetch($ctx, _reset, ...args);\n}\n"],"mappings":"AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,SAASA,oBAAoB,IAAIC,qBAAqB,QAAQ,8BAA8B;AAC5F;AACA,MAAMC,OAAO,GAAG,CAAC,CAAC,EAAE,kCAAkC,EAAE,CAAC,CAAC;AAC1D;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASC,MAAMA,CAACC,IAAI,EAAE,GAAGC,IAAI,EAAE;EAClC,OAAOJ,qBAAqB,CAACG,IAAI,EAAEF,OAAO,EAAE,GAAGG,IAAI,CAAC;AACxD;AACA,MAAMC,IAAI,GAAG,CAAC,CAAC,EAAE,sCAAsC,EAAE,CAAC,CAAC;AAC3D;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASC,GAAGA,CAACH,IAAI,EAAE,GAAGC,IAAI,EAAE;EAC/B,OAAOJ,qBAAqB,CAACG,IAAI,EAAEE,IAAI,EAAE,GAAGD,IAAI,CAAC;AACrD;AACA,MAAMG,cAAc,GAAG,CAAC,CAAC,EAAE,8DAA8D,EAAE,CAAC,CAAC;AAC7F;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASC,aAAaA,CAACL,IAAI,EAAE,GAAGC,IAAI,EAAE;EACzC,OAAOJ,qBAAqB,CAACG,IAAI,EAAEI,cAAc,EAAE,GAAGH,IAAI,CAAC;AAC/D;AACA,MAAMK,eAAe,GAAG,CAAC,CAAC,EAAE,+DAA+D,EAAE,CAAC,CAAC;AAC/F;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASC,cAAcA,CAACP,IAAI,EAAE,GAAGC,IAAI,EAAE;EAC1C,OAAOJ,qBAAqB,CAACG,IAAI,EAAEM,eAAe,EAAE,GAAGL,IAAI,CAAC;AAChE;AACA,MAAMO,oBAAoB,GAAG,CACzB,CAAC,EACD,oEAAoE,EACpE,CAAC,EACD,0BAA0B,CAC7B;AACD;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASC,mBAAmBA,CAACT,IAAI,EAAE,GAAGC,IAAI,EAAE;EAC/C,OAAOJ,qBAAqB,CAACG,IAAI,EAAEQ,oBAAoB,EAAE,GAAGP,IAAI,CAAC;AACrE;AACA,MAAMS,MAAM,GAAG,CAAC,CAAC,EAAE,4CAA4C,EAAE,CAAC,CAAC;AACnE;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASC,KAAKA,CAACX,IAAI,EAAE,GAAGC,IAAI,EAAE;EACjC,OAAOJ,qBAAqB,CAACG,IAAI,EAAEU,MAAM,EAAE,GAAGT,IAAI,CAAC;AACvD","ignoreList":[]}
|
|
@@ -1,3 +1,4 @@
|
|
|
1
|
+
import type * as _Core from "@osdk/foundry.core";
|
|
1
2
|
import type * as _Datasets from "@osdk/foundry.datasets";
|
|
2
3
|
import type * as _Filesystem from "@osdk/foundry.filesystem";
|
|
3
4
|
export type LooselyBrandedString<T extends string> = string & {
|
|
@@ -12,12 +13,49 @@ network bandwidth symptoms like non-zero lag, lower than expected throughput, or
|
|
|
12
13
|
* Log Safety: SAFE
|
|
13
14
|
*/
|
|
14
15
|
export type Compressed = boolean;
|
|
16
|
+
/**
|
|
17
|
+
* Log Safety: UNSAFE
|
|
18
|
+
*/
|
|
19
|
+
export interface CreateStreamRequest {
|
|
20
|
+
schema: CreateStreamRequestStreamSchema;
|
|
21
|
+
partitionsCount?: PartitionsCount;
|
|
22
|
+
streamType?: StreamType;
|
|
23
|
+
branchName: _Datasets.BranchName;
|
|
24
|
+
compressed?: Compressed;
|
|
25
|
+
}
|
|
26
|
+
/**
|
|
27
|
+
* Log Safety: UNSAFE
|
|
28
|
+
*/
|
|
29
|
+
export interface CreateStreamRequestStreamSchema {
|
|
30
|
+
keyFieldNames?: Array<_Core.FieldName>;
|
|
31
|
+
fields: Array<_Core.Field>;
|
|
32
|
+
changeDataCapture?: _Core.ChangeDataCaptureConfiguration;
|
|
33
|
+
}
|
|
34
|
+
/**
|
|
35
|
+
* Configuration for utilizing the stream as a change data capture (CDC) dataset. To configure CDC on a stream, at
|
|
36
|
+
least one key needs to be provided.
|
|
37
|
+
For more information on CDC in
|
|
38
|
+
Foundry, see the Change Data Capture user documentation.
|
|
39
|
+
*
|
|
40
|
+
* Log Safety: UNSAFE
|
|
41
|
+
*/
|
|
42
|
+
export type CreateStreamRequestStreamSchemaChangeDataCaptureConfiguration = {
|
|
43
|
+
type: "fullRow";
|
|
44
|
+
} & CreateStreamRequestStreamSchemaChangeDataCaptureConfigurationFullRowChangeDataCaptureConfiguration;
|
|
45
|
+
/**
|
|
46
|
+
* Log Safety: UNSAFE
|
|
47
|
+
*/
|
|
48
|
+
export interface CreateStreamRequestStreamSchemaChangeDataCaptureConfigurationFullRowChangeDataCaptureConfiguration {
|
|
49
|
+
orderingFieldName: _Core.FieldName;
|
|
50
|
+
deletionFieldName: _Core.FieldName;
|
|
51
|
+
}
|
|
15
52
|
/**
|
|
16
53
|
* Log Safety: UNSAFE
|
|
17
54
|
*/
|
|
18
55
|
export interface CreateStreamingDatasetRequest {
|
|
19
56
|
name: _Datasets.DatasetName;
|
|
20
57
|
parentFolderRid: _Filesystem.FolderRid;
|
|
58
|
+
schema: _Core.StreamSchema;
|
|
21
59
|
branchName?: _Datasets.BranchName;
|
|
22
60
|
partitionsCount?: PartitionsCount;
|
|
23
61
|
streamType?: StreamType;
|
|
@@ -37,11 +75,41 @@ export interface Dataset {
|
|
|
37
75
|
* Log Safety: SAFE
|
|
38
76
|
*/
|
|
39
77
|
export type PartitionsCount = number;
|
|
78
|
+
/**
|
|
79
|
+
* Log Safety: DO_NOT_LOG
|
|
80
|
+
*/
|
|
81
|
+
export interface PublishRecordToStreamRequest {
|
|
82
|
+
record: _Record;
|
|
83
|
+
viewRid?: ViewRid;
|
|
84
|
+
}
|
|
85
|
+
/**
|
|
86
|
+
* Log Safety: DO_NOT_LOG
|
|
87
|
+
*/
|
|
88
|
+
export interface PublishRecordsToStreamRequest {
|
|
89
|
+
records: Array<_Record>;
|
|
90
|
+
viewRid?: ViewRid;
|
|
91
|
+
}
|
|
92
|
+
/**
|
|
93
|
+
* A record to be published to a stream.
|
|
94
|
+
*
|
|
95
|
+
* Log Safety: DO_NOT_LOG
|
|
96
|
+
*/
|
|
97
|
+
export type _Record = Record<string, any>;
|
|
98
|
+
/**
|
|
99
|
+
* Log Safety: UNSAFE
|
|
100
|
+
*/
|
|
101
|
+
export interface ResetStreamRequest {
|
|
102
|
+
schema?: _Core.StreamSchema;
|
|
103
|
+
partitionsCount?: PartitionsCount;
|
|
104
|
+
streamType?: StreamType;
|
|
105
|
+
compressed?: Compressed;
|
|
106
|
+
}
|
|
40
107
|
/**
|
|
41
108
|
* Log Safety: UNSAFE
|
|
42
109
|
*/
|
|
43
110
|
export interface Stream {
|
|
44
111
|
branchName: _Datasets.BranchName;
|
|
112
|
+
schema: _Core.StreamSchema;
|
|
45
113
|
viewRid: ViewRid;
|
|
46
114
|
partitionsCount: PartitionsCount;
|
|
47
115
|
streamType: StreamType;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"_components.d.ts","sourceRoot":"","sources":["../../src/_components.ts"],"names":[],"mappings":"AAgBA,OAAO,KAAK,KAAK,SAAS,MAAM,wBAAwB,CAAC;AACzD,OAAO,KAAK,KAAK,WAAW,MAAM,0BAA0B,CAAC;AAE7D,MAAM,MAAM,oBAAoB,CAAC,CAAC,SAAS,MAAM,IAAI,MAAM,GAAG;IAC5D,aAAa,CAAC,EAAE,CAAC,CAAC;CACnB,CAAC;AAEF;;;;;;;KAOK;AACL,MAAM,MAAM,UAAU,GAAG,OAAO,CAAC;AAEjC;;GAEG;AACH,MAAM,WAAW,6BAA6B;IAC5C,IAAI,EAAE,SAAS,CAAC,WAAW,CAAC;IAC5B,eAAe,EAAE,WAAW,CAAC,SAAS,CAAC;IACvC,UAAU,CAAC,EAAE,SAAS,CAAC,UAAU,CAAC;IAClC,eAAe,CAAC,EAAE,eAAe,CAAC;IAClC,UAAU,CAAC,EAAE,UAAU,CAAC;IACxB,UAAU,CAAC,EAAE,UAAU,CAAC;CACzB;AAED;;GAEG;AACH,MAAM,WAAW,OAAO;IACtB,GAAG,EAAE,SAAS,CAAC,UAAU,CAAC;IAC1B,IAAI,EAAE,SAAS,CAAC,WAAW,CAAC;IAC5B,eAAe,EAAE,WAAW,CAAC,SAAS,CAAC;CACxC;AAED;;;;GAIG;AACH,MAAM,MAAM,eAAe,GAAG,MAAM,CAAC;AAErC;;GAEG;AACH,MAAM,WAAW,MAAM;IACrB,UAAU,EAAE,SAAS,CAAC,UAAU,CAAC;IACjC,OAAO,EAAE,OAAO,CAAC;IACjB,eAAe,EAAE,eAAe,CAAC;IACjC,UAAU,EAAE,UAAU,CAAC;IACvB,UAAU,EAAE,UAAU,CAAC;CACxB;AAED;;;;;;;;;;;;KAYK;AACL,MAAM,MAAM,UAAU,GAAG,aAAa,GAAG,iBAAiB,CAAC;AAE3D;;;;GAIG;AACH,MAAM,MAAM,OAAO,GAAG,oBAAoB,CAAC,SAAS,CAAC,CAAC"}
|
|
1
|
+
{"version":3,"file":"_components.d.ts","sourceRoot":"","sources":["../../src/_components.ts"],"names":[],"mappings":"AAgBA,OAAO,KAAK,KAAK,KAAK,MAAM,oBAAoB,CAAC;AACjD,OAAO,KAAK,KAAK,SAAS,MAAM,wBAAwB,CAAC;AACzD,OAAO,KAAK,KAAK,WAAW,MAAM,0BAA0B,CAAC;AAE7D,MAAM,MAAM,oBAAoB,CAAC,CAAC,SAAS,MAAM,IAAI,MAAM,GAAG;IAC5D,aAAa,CAAC,EAAE,CAAC,CAAC;CACnB,CAAC;AAEF;;;;;;;KAOK;AACL,MAAM,MAAM,UAAU,GAAG,OAAO,CAAC;AAEjC;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC,MAAM,EAAE,+BAA+B,CAAC;IACxC,eAAe,CAAC,EAAE,eAAe,CAAC;IAClC,UAAU,CAAC,EAAE,UAAU,CAAC;IACxB,UAAU,EAAE,SAAS,CAAC,UAAU,CAAC;IACjC,UAAU,CAAC,EAAE,UAAU,CAAC;CACzB;AAED;;GAEG;AACH,MAAM,WAAW,+BAA+B;IAC9C,aAAa,CAAC,EAAE,KAAK,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;IACvC,MAAM,EAAE,KAAK,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;IAC3B,iBAAiB,CAAC,EAAE,KAAK,CAAC,8BAA8B,CAAC;CAC1D;AAED;;;;;;;KAOK;AACL,MAAM,MAAM,6DAA6D,GACrE;IACA,IAAI,EAAE,SAAS,CAAC;CACjB,GACC,kGAAkG,CAAC;AAEvG;;GAEG;AACH,MAAM,WAAW,kGAAkG;IACjH,iBAAiB,EAAE,KAAK,CAAC,SAAS,CAAC;IACnC,iBAAiB,EAAE,KAAK,CAAC,SAAS,CAAC;CACpC;AAED;;GAEG;AACH,MAAM,WAAW,6BAA6B;IAC5C,IAAI,EAAE,SAAS,CAAC,WAAW,CAAC;IAC5B,eAAe,EAAE,WAAW,CAAC,SAAS,CAAC;IACvC,MAAM,EAAE,KAAK,CAAC,YAAY,CAAC;IAC3B,UAAU,CAAC,EAAE,SAAS,CAAC,UAAU,CAAC;IAClC,eAAe,CAAC,EAAE,eAAe,CAAC;IAClC,UAAU,CAAC,EAAE,UAAU,CAAC;IACxB,UAAU,CAAC,EAAE,UAAU,CAAC;CACzB;AAED;;GAEG;AACH,MAAM,WAAW,OAAO;IACtB,GAAG,EAAE,SAAS,CAAC,UAAU,CAAC;IAC1B,IAAI,EAAE,SAAS,CAAC,WAAW,CAAC;IAC5B,eAAe,EAAE,WAAW,CAAC,SAAS,CAAC;CACxC;AAED;;;;GAIG;AACH,MAAM,MAAM,eAAe,GAAG,MAAM,CAAC;AAErC;;GAEG;AACH,MAAM,WAAW,4BAA4B;IAC3C,MAAM,EAAE,OAAO,CAAC;IAChB,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB;AAED;;GAEG;AACH,MAAM,WAAW,6BAA6B;IAC5C,OAAO,EAAE,KAAK,CAAC,OAAO,CAAC,CAAC;IACxB,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB;AAED;;;;GAIG;AACH,MAAM,MAAM,OAAO,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;AAE1C;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC,MAAM,CAAC,EAAE,KAAK,CAAC,YAAY,CAAC;IAC5B,eAAe,CAAC,EAAE,eAAe,CAAC;IAClC,UAAU,CAAC,EAAE,UAAU,CAAC;IACxB,UAAU,CAAC,EAAE,UAAU,CAAC;CACzB;AAED;;GAEG;AACH,MAAM,WAAW,MAAM;IACrB,UAAU,EAAE,SAAS,CAAC,UAAU,CAAC;IACjC,MAAM,EAAE,KAAK,CAAC,YAAY,CAAC;IAC3B,OAAO,EAAE,OAAO,CAAC;IACjB,eAAe,EAAE,eAAe,CAAC;IACjC,UAAU,EAAE,UAAU,CAAC;IACvB,UAAU,EAAE,UAAU,CAAC;CACxB;AAED;;;;;;;;;;;;KAYK;AACL,MAAM,MAAM,UAAU,GAAG,aAAa,GAAG,iBAAiB,CAAC;AAE3D;;;;GAIG;AACH,MAAM,MAAM,OAAO,GAAG,oBAAoB,CAAC,SAAS,CAAC,CAAC"}
|
package/build/esm/_errors.d.ts
CHANGED
|
@@ -14,6 +14,46 @@ export interface CannotCreateStreamingDatasetInUserFolder {
|
|
|
14
14
|
parentFolderRid: unknown;
|
|
15
15
|
};
|
|
16
16
|
}
|
|
17
|
+
/**
|
|
18
|
+
* The view specified is not the latest view on the branch.
|
|
19
|
+
*
|
|
20
|
+
* Log Safety: SAFE
|
|
21
|
+
*/
|
|
22
|
+
export interface CannotWriteToOutdatedView {
|
|
23
|
+
errorCode: "INVALID_ARGUMENT";
|
|
24
|
+
errorName: "CannotWriteToOutdatedView";
|
|
25
|
+
errorInstanceId: string;
|
|
26
|
+
parameters: {
|
|
27
|
+
viewRid: unknown;
|
|
28
|
+
};
|
|
29
|
+
}
|
|
30
|
+
/**
|
|
31
|
+
* Cannot write to a stream that is in the trash.
|
|
32
|
+
*
|
|
33
|
+
* Log Safety: SAFE
|
|
34
|
+
*/
|
|
35
|
+
export interface CannotWriteToTrashedStream {
|
|
36
|
+
errorCode: "INVALID_ARGUMENT";
|
|
37
|
+
errorName: "CannotWriteToTrashedStream";
|
|
38
|
+
errorInstanceId: string;
|
|
39
|
+
parameters: {
|
|
40
|
+
datasetRid: unknown;
|
|
41
|
+
};
|
|
42
|
+
}
|
|
43
|
+
/**
|
|
44
|
+
* Could not create the Stream.
|
|
45
|
+
*
|
|
46
|
+
* Log Safety: UNSAFE
|
|
47
|
+
*/
|
|
48
|
+
export interface CreateStreamPermissionDenied {
|
|
49
|
+
errorCode: "PERMISSION_DENIED";
|
|
50
|
+
errorName: "CreateStreamPermissionDenied";
|
|
51
|
+
errorInstanceId: string;
|
|
52
|
+
parameters: {
|
|
53
|
+
datasetRid: unknown;
|
|
54
|
+
streamBranchName: unknown;
|
|
55
|
+
};
|
|
56
|
+
}
|
|
17
57
|
/**
|
|
18
58
|
* Could not create the Dataset.
|
|
19
59
|
*
|
|
@@ -25,6 +65,19 @@ export interface CreateStreamingDatasetPermissionDenied {
|
|
|
25
65
|
errorInstanceId: string;
|
|
26
66
|
parameters: {};
|
|
27
67
|
}
|
|
68
|
+
/**
|
|
69
|
+
* The requested stream exists but is invalid, as it does not have a schema.
|
|
70
|
+
*
|
|
71
|
+
* Log Safety: SAFE
|
|
72
|
+
*/
|
|
73
|
+
export interface InvalidStreamNoSchema {
|
|
74
|
+
errorCode: "INVALID_ARGUMENT";
|
|
75
|
+
errorName: "InvalidStreamNoSchema";
|
|
76
|
+
errorInstanceId: string;
|
|
77
|
+
parameters: {
|
|
78
|
+
viewRid: unknown;
|
|
79
|
+
};
|
|
80
|
+
}
|
|
28
81
|
/**
|
|
29
82
|
* The stream type is invalid.
|
|
30
83
|
*
|
|
@@ -38,6 +91,88 @@ export interface InvalidStreamType {
|
|
|
38
91
|
streamType: unknown;
|
|
39
92
|
};
|
|
40
93
|
}
|
|
94
|
+
/**
|
|
95
|
+
* Could not publishBinaryRecord the Stream.
|
|
96
|
+
*
|
|
97
|
+
* Log Safety: UNSAFE
|
|
98
|
+
*/
|
|
99
|
+
export interface PublishBinaryRecordToStreamPermissionDenied {
|
|
100
|
+
errorCode: "PERMISSION_DENIED";
|
|
101
|
+
errorName: "PublishBinaryRecordToStreamPermissionDenied";
|
|
102
|
+
errorInstanceId: string;
|
|
103
|
+
parameters: {
|
|
104
|
+
datasetRid: unknown;
|
|
105
|
+
streamBranchName: unknown;
|
|
106
|
+
};
|
|
107
|
+
}
|
|
108
|
+
/**
|
|
109
|
+
* Could not publishRecord the Stream.
|
|
110
|
+
*
|
|
111
|
+
* Log Safety: UNSAFE
|
|
112
|
+
*/
|
|
113
|
+
export interface PublishRecordToStreamPermissionDenied {
|
|
114
|
+
errorCode: "PERMISSION_DENIED";
|
|
115
|
+
errorName: "PublishRecordToStreamPermissionDenied";
|
|
116
|
+
errorInstanceId: string;
|
|
117
|
+
parameters: {
|
|
118
|
+
datasetRid: unknown;
|
|
119
|
+
streamBranchName: unknown;
|
|
120
|
+
};
|
|
121
|
+
}
|
|
122
|
+
/**
|
|
123
|
+
* Could not publishRecords the Stream.
|
|
124
|
+
*
|
|
125
|
+
* Log Safety: UNSAFE
|
|
126
|
+
*/
|
|
127
|
+
export interface PublishRecordsToStreamPermissionDenied {
|
|
128
|
+
errorCode: "PERMISSION_DENIED";
|
|
129
|
+
errorName: "PublishRecordsToStreamPermissionDenied";
|
|
130
|
+
errorInstanceId: string;
|
|
131
|
+
parameters: {
|
|
132
|
+
datasetRid: unknown;
|
|
133
|
+
streamBranchName: unknown;
|
|
134
|
+
};
|
|
135
|
+
}
|
|
136
|
+
/**
|
|
137
|
+
* A provided record does not match the stream schema
|
|
138
|
+
*
|
|
139
|
+
* Log Safety: UNSAFE
|
|
140
|
+
*/
|
|
141
|
+
export interface RecordDoesNotMatchStreamSchema {
|
|
142
|
+
errorCode: "INVALID_ARGUMENT";
|
|
143
|
+
errorName: "RecordDoesNotMatchStreamSchema";
|
|
144
|
+
errorInstanceId: string;
|
|
145
|
+
parameters: {
|
|
146
|
+
branchName: unknown;
|
|
147
|
+
viewRid: unknown;
|
|
148
|
+
};
|
|
149
|
+
}
|
|
150
|
+
/**
|
|
151
|
+
* A record is too large to be published to the stream. On most enrollments, the maximum record size is 1MB.
|
|
152
|
+
|
|
153
|
+
*
|
|
154
|
+
* Log Safety: SAFE
|
|
155
|
+
*/
|
|
156
|
+
export interface RecordTooLarge {
|
|
157
|
+
errorCode: "REQUEST_ENTITY_TOO_LARGE";
|
|
158
|
+
errorName: "RecordTooLarge";
|
|
159
|
+
errorInstanceId: string;
|
|
160
|
+
parameters: {};
|
|
161
|
+
}
|
|
162
|
+
/**
|
|
163
|
+
* Could not reset the Stream.
|
|
164
|
+
*
|
|
165
|
+
* Log Safety: UNSAFE
|
|
166
|
+
*/
|
|
167
|
+
export interface ResetStreamPermissionDenied {
|
|
168
|
+
errorCode: "PERMISSION_DENIED";
|
|
169
|
+
errorName: "ResetStreamPermissionDenied";
|
|
170
|
+
errorInstanceId: string;
|
|
171
|
+
parameters: {
|
|
172
|
+
datasetRid: unknown;
|
|
173
|
+
streamBranchName: unknown;
|
|
174
|
+
};
|
|
175
|
+
}
|
|
41
176
|
/**
|
|
42
177
|
* The given Stream could not be found.
|
|
43
178
|
*
|
|
@@ -52,4 +187,17 @@ export interface StreamNotFound {
|
|
|
52
187
|
streamBranchName: unknown;
|
|
53
188
|
};
|
|
54
189
|
}
|
|
190
|
+
/**
|
|
191
|
+
* No view for the view rid provided could be found.
|
|
192
|
+
*
|
|
193
|
+
* Log Safety: SAFE
|
|
194
|
+
*/
|
|
195
|
+
export interface ViewNotFound {
|
|
196
|
+
errorCode: "NOT_FOUND";
|
|
197
|
+
errorName: "ViewNotFound";
|
|
198
|
+
errorInstanceId: string;
|
|
199
|
+
parameters: {
|
|
200
|
+
viewRid: unknown;
|
|
201
|
+
};
|
|
202
|
+
}
|
|
55
203
|
//# sourceMappingURL=_errors.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"_errors.d.ts","sourceRoot":"","sources":["../../src/_errors.ts"],"names":[],"mappings":"AAgBA,MAAM,MAAM,oBAAoB,CAAC,CAAC,SAAS,MAAM,IAAI,MAAM,GAAG;IAC5D,aAAa,CAAC,EAAE,CAAC,CAAC;CACnB,CAAC;AAEF;;;;GAIG;AACH,MAAM,WAAW,wCAAwC;IACvD,SAAS,EAAE,kBAAkB,CAAC;IAC9B,SAAS,EAAE,0CAA0C,CAAC;IACtD,eAAe,EAAE,MAAM,CAAC;IACxB,UAAU,EAAE;QACV,eAAe,EAAE,OAAO,CAAC;KAC1B,CAAC;CACH;AAED;;;;GAIG;AACH,MAAM,WAAW,sCAAsC;IACrD,SAAS,EAAE,mBAAmB,CAAC;IAC/B,SAAS,EAAE,wCAAwC,CAAC;IACpD,eAAe,EAAE,MAAM,CAAC;IACxB,UAAU,EAAE,EAAE,CAAC;CAChB;AAED;;;;GAIG;AACH,MAAM,WAAW,iBAAiB;IAChC,SAAS,EAAE,kBAAkB,CAAC;IAC9B,SAAS,EAAE,mBAAmB,CAAC;IAC/B,eAAe,EAAE,MAAM,CAAC;IACxB,UAAU,EAAE;QACV,UAAU,EAAE,OAAO,CAAC;KACrB,CAAC;CACH;AAED;;;;GAIG;AACH,MAAM,WAAW,cAAc;IAC7B,SAAS,EAAE,WAAW,CAAC;IACvB,SAAS,EAAE,gBAAgB,CAAC;IAC5B,eAAe,EAAE,MAAM,CAAC;IACxB,UAAU,EAAE;QACV,UAAU,EAAE,OAAO,CAAC;QACpB,gBAAgB,EAAE,OAAO,CAAC;KAC3B,CAAC;CACH"}
|
|
1
|
+
{"version":3,"file":"_errors.d.ts","sourceRoot":"","sources":["../../src/_errors.ts"],"names":[],"mappings":"AAgBA,MAAM,MAAM,oBAAoB,CAAC,CAAC,SAAS,MAAM,IAAI,MAAM,GAAG;IAC5D,aAAa,CAAC,EAAE,CAAC,CAAC;CACnB,CAAC;AAEF;;;;GAIG;AACH,MAAM,WAAW,wCAAwC;IACvD,SAAS,EAAE,kBAAkB,CAAC;IAC9B,SAAS,EAAE,0CAA0C,CAAC;IACtD,eAAe,EAAE,MAAM,CAAC;IACxB,UAAU,EAAE;QACV,eAAe,EAAE,OAAO,CAAC;KAC1B,CAAC;CACH;AAED;;;;GAIG;AACH,MAAM,WAAW,yBAAyB;IACxC,SAAS,EAAE,kBAAkB,CAAC;IAC9B,SAAS,EAAE,2BAA2B,CAAC;IACvC,eAAe,EAAE,MAAM,CAAC;IACxB,UAAU,EAAE;QACV,OAAO,EAAE,OAAO,CAAC;KAClB,CAAC;CACH;AAED;;;;GAIG;AACH,MAAM,WAAW,0BAA0B;IACzC,SAAS,EAAE,kBAAkB,CAAC;IAC9B,SAAS,EAAE,4BAA4B,CAAC;IACxC,eAAe,EAAE,MAAM,CAAC;IACxB,UAAU,EAAE;QACV,UAAU,EAAE,OAAO,CAAC;KACrB,CAAC;CACH;AAED;;;;GAIG;AACH,MAAM,WAAW,4BAA4B;IAC3C,SAAS,EAAE,mBAAmB,CAAC;IAC/B,SAAS,EAAE,8BAA8B,CAAC;IAC1C,eAAe,EAAE,MAAM,CAAC;IACxB,UAAU,EAAE;QACV,UAAU,EAAE,OAAO,CAAC;QACpB,gBAAgB,EAAE,OAAO,CAAC;KAC3B,CAAC;CACH;AAED;;;;GAIG;AACH,MAAM,WAAW,sCAAsC;IACrD,SAAS,EAAE,mBAAmB,CAAC;IAC/B,SAAS,EAAE,wCAAwC,CAAC;IACpD,eAAe,EAAE,MAAM,CAAC;IACxB,UAAU,EAAE,EAAE,CAAC;CAChB;AAED;;;;GAIG;AACH,MAAM,WAAW,qBAAqB;IACpC,SAAS,EAAE,kBAAkB,CAAC;IAC9B,SAAS,EAAE,uBAAuB,CAAC;IACnC,eAAe,EAAE,MAAM,CAAC;IACxB,UAAU,EAAE;QACV,OAAO,EAAE,OAAO,CAAC;KAClB,CAAC;CACH;AAED;;;;GAIG;AACH,MAAM,WAAW,iBAAiB;IAChC,SAAS,EAAE,kBAAkB,CAAC;IAC9B,SAAS,EAAE,mBAAmB,CAAC;IAC/B,eAAe,EAAE,MAAM,CAAC;IACxB,UAAU,EAAE;QACV,UAAU,EAAE,OAAO,CAAC;KACrB,CAAC;CACH;AAED;;;;GAIG;AACH,MAAM,WAAW,2CAA2C;IAC1D,SAAS,EAAE,mBAAmB,CAAC;IAC/B,SAAS,EAAE,6CAA6C,CAAC;IACzD,eAAe,EAAE,MAAM,CAAC;IACxB,UAAU,EAAE;QACV,UAAU,EAAE,OAAO,CAAC;QACpB,gBAAgB,EAAE,OAAO,CAAC;KAC3B,CAAC;CACH;AAED;;;;GAIG;AACH,MAAM,WAAW,qCAAqC;IACpD,SAAS,EAAE,mBAAmB,CAAC;IAC/B,SAAS,EAAE,uCAAuC,CAAC;IACnD,eAAe,EAAE,MAAM,CAAC;IACxB,UAAU,EAAE;QACV,UAAU,EAAE,OAAO,CAAC;QACpB,gBAAgB,EAAE,OAAO,CAAC;KAC3B,CAAC;CACH;AAED;;;;GAIG;AACH,MAAM,WAAW,sCAAsC;IACrD,SAAS,EAAE,mBAAmB,CAAC;IAC/B,SAAS,EAAE,wCAAwC,CAAC;IACpD,eAAe,EAAE,MAAM,CAAC;IACxB,UAAU,EAAE;QACV,UAAU,EAAE,OAAO,CAAC;QACpB,gBAAgB,EAAE,OAAO,CAAC;KAC3B,CAAC;CACH;AAED;;;;GAIG;AACH,MAAM,WAAW,8BAA8B;IAC7C,SAAS,EAAE,kBAAkB,CAAC;IAC9B,SAAS,EAAE,gCAAgC,CAAC;IAC5C,eAAe,EAAE,MAAM,CAAC;IACxB,UAAU,EAAE;QACV,UAAU,EAAE,OAAO,CAAC;QACpB,OAAO,EAAE,OAAO,CAAC;KAClB,CAAC;CACH;AAED;;;;;KAKK;AACL,MAAM,WAAW,cAAc;IAC7B,SAAS,EAAE,0BAA0B,CAAC;IACtC,SAAS,EAAE,gBAAgB,CAAC;IAC5B,eAAe,EAAE,MAAM,CAAC;IACxB,UAAU,EAAE,EAAE,CAAC;CAChB;AAED;;;;GAIG;AACH,MAAM,WAAW,2BAA2B;IAC1C,SAAS,EAAE,mBAAmB,CAAC;IAC/B,SAAS,EAAE,6BAA6B,CAAC;IACzC,eAAe,EAAE,MAAM,CAAC;IACxB,UAAU,EAAE;QACV,UAAU,EAAE,OAAO,CAAC;QACpB,gBAAgB,EAAE,OAAO,CAAC;KAC3B,CAAC;CACH;AAED;;;;GAIG;AACH,MAAM,WAAW,cAAc;IAC7B,SAAS,EAAE,WAAW,CAAC;IACvB,SAAS,EAAE,gBAAgB,CAAC;IAC5B,eAAe,EAAE,MAAM,CAAC;IACxB,UAAU,EAAE;QACV,UAAU,EAAE,OAAO,CAAC;QACpB,gBAAgB,EAAE,OAAO,CAAC;KAC3B,CAAC;CACH;AAED;;;;GAIG;AACH,MAAM,WAAW,YAAY;IAC3B,SAAS,EAAE,WAAW,CAAC;IACvB,SAAS,EAAE,cAAc,CAAC;IAC1B,eAAe,EAAE,MAAM,CAAC;IACxB,UAAU,EAAE;QACV,OAAO,EAAE,OAAO,CAAC;KAClB,CAAC;CACH"}
|
package/build/esm/index.d.ts
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
|
-
export type { Compressed, CreateStreamingDatasetRequest, Dataset, PartitionsCount, Stream, StreamType, ViewRid, } from "./_components.js";
|
|
2
|
-
export type { CannotCreateStreamingDatasetInUserFolder, CreateStreamingDatasetPermissionDenied, InvalidStreamType, StreamNotFound, } from "./_errors.js";
|
|
1
|
+
export type { _Record, Compressed, CreateStreamingDatasetRequest, CreateStreamRequest, CreateStreamRequestStreamSchema, CreateStreamRequestStreamSchemaChangeDataCaptureConfiguration, CreateStreamRequestStreamSchemaChangeDataCaptureConfigurationFullRowChangeDataCaptureConfiguration, Dataset, PartitionsCount, PublishRecordsToStreamRequest, PublishRecordToStreamRequest, ResetStreamRequest, Stream, StreamType, ViewRid, } from "./_components.js";
|
|
2
|
+
export type { CannotCreateStreamingDatasetInUserFolder, CannotWriteToOutdatedView, CannotWriteToTrashedStream, CreateStreamingDatasetPermissionDenied, CreateStreamPermissionDenied, InvalidStreamNoSchema, InvalidStreamType, PublishBinaryRecordToStreamPermissionDenied, PublishRecordsToStreamPermissionDenied, PublishRecordToStreamPermissionDenied, RecordDoesNotMatchStreamSchema, RecordTooLarge, ResetStreamPermissionDenied, StreamNotFound, ViewNotFound, } from "./_errors.js";
|
|
3
3
|
export * as Datasets from "./public/Dataset.js";
|
|
4
4
|
export * as Streams from "./public/Stream.js";
|
|
5
5
|
//# sourceMappingURL=index.d.ts.map
|
package/build/esm/index.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAgBA,YAAY,EACV,UAAU,EACV,6BAA6B,EAC7B,OAAO,EACP,eAAe,EACf,MAAM,EACN,UAAU,EACV,OAAO,GACR,MAAM,kBAAkB,CAAC;AAC1B,YAAY,EACV,wCAAwC,EACxC,sCAAsC,EACtC,iBAAiB,EACjB,cAAc,
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAgBA,YAAY,EACV,OAAO,EACP,UAAU,EACV,6BAA6B,EAC7B,mBAAmB,EACnB,+BAA+B,EAC/B,6DAA6D,EAC7D,kGAAkG,EAClG,OAAO,EACP,eAAe,EACf,6BAA6B,EAC7B,4BAA4B,EAC5B,kBAAkB,EAClB,MAAM,EACN,UAAU,EACV,OAAO,GACR,MAAM,kBAAkB,CAAC;AAC1B,YAAY,EACV,wCAAwC,EACxC,yBAAyB,EACzB,0BAA0B,EAC1B,sCAAsC,EACtC,4BAA4B,EAC5B,qBAAqB,EACrB,iBAAiB,EACjB,2CAA2C,EAC3C,sCAAsC,EACtC,qCAAqC,EACrC,8BAA8B,EAC9B,cAAc,EACd,2BAA2B,EAC3B,cAAc,EACd,YAAY,GACb,MAAM,cAAc,CAAC;AACtB,OAAO,KAAK,QAAQ,MAAM,qBAAqB,CAAC;AAChD,OAAO,KAAK,OAAO,MAAM,oBAAoB,CAAC"}
|
|
@@ -1,5 +1,6 @@
|
|
|
1
1
|
import type * as _Core from "@osdk/foundry.core";
|
|
2
|
-
import type { SharedClient as $
|
|
2
|
+
import type { SharedClient as $OldClient, SharedClientContext as $OldClientContext } from "@osdk/shared.client";
|
|
3
|
+
import type { SharedClient as $Client, SharedClientContext as $ClientContext } from "@osdk/shared.client2";
|
|
3
4
|
import type * as _Streams from "../_components.js";
|
|
4
5
|
/**
|
|
5
6
|
* Creates a streaming dataset with a stream on the specified branch, or if no branch is specified, on the
|
|
@@ -8,10 +9,10 @@ import type * as _Streams from "../_components.js";
|
|
|
8
9
|
*
|
|
9
10
|
* @alpha
|
|
10
11
|
*
|
|
11
|
-
* Required Scopes: [api:
|
|
12
|
+
* Required Scopes: [api:streams-write]
|
|
12
13
|
* URL: /v2/streams/datasets/create
|
|
13
14
|
*/
|
|
14
|
-
export declare function create($ctx: $Client | $ClientContext, ...args: [
|
|
15
|
+
export declare function create($ctx: $Client | $ClientContext | $OldClient | $OldClientContext, ...args: [
|
|
15
16
|
$body: _Streams.CreateStreamingDatasetRequest,
|
|
16
17
|
$queryParams?: {
|
|
17
18
|
preview?: _Core.PreviewMode | undefined;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"Dataset.d.ts","sourceRoot":"","sources":["../../../src/public/Dataset.ts"],"names":[],"mappings":"AAgBA,OAAO,KAAK,KAAK,KAAK,MAAM,oBAAoB,CAAC;AACjD,OAAO,KAAK,EACV,YAAY,IAAI,OAAO,EACvB,mBAAmB,IAAI,cAAc,EACtC,MAAM,
|
|
1
|
+
{"version":3,"file":"Dataset.d.ts","sourceRoot":"","sources":["../../../src/public/Dataset.ts"],"names":[],"mappings":"AAgBA,OAAO,KAAK,KAAK,KAAK,MAAM,oBAAoB,CAAC;AACjD,OAAO,KAAK,EACV,YAAY,IAAI,UAAU,EAC1B,mBAAmB,IAAI,iBAAiB,EACzC,MAAM,qBAAqB,CAAC;AAC7B,OAAO,KAAK,EACV,YAAY,IAAI,OAAO,EACvB,mBAAmB,IAAI,cAAc,EACtC,MAAM,sBAAsB,CAAC;AAG9B,OAAO,KAAK,KAAK,QAAQ,MAAM,mBAAmB,CAAC;AAWnD;;;;;;;;;GASG;AACH,wBAAgB,MAAM,CACpB,IAAI,EAAE,OAAO,GAAG,cAAc,GAAG,UAAU,GAAG,iBAAiB,EAC/D,GAAG,IAAI,EAAE;IACP,KAAK,EAAE,QAAQ,CAAC,6BAA6B;IAC7C,YAAY,CAAC,EAAE;QAAE,OAAO,CAAC,EAAE,KAAK,CAAC,WAAW,GAAG,SAAS,CAAA;KAAE;CAC3D,GACA,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAC,CAE3B"}
|
|
@@ -23,7 +23,7 @@ const _create = [1, "/v2/streams/datasets/create", 3];
|
|
|
23
23
|
*
|
|
24
24
|
* @alpha
|
|
25
25
|
*
|
|
26
|
-
* Required Scopes: [api:
|
|
26
|
+
* Required Scopes: [api:streams-write]
|
|
27
27
|
* URL: /v2/streams/datasets/create
|
|
28
28
|
*/
|
|
29
29
|
export function create($ctx, ...args) {
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"Dataset.js","names":["foundryPlatformFetch","$foundryPlatformFetch","_create","create","$ctx","args"],"sources":["Dataset.js"],"sourcesContent":["/*\n * Copyright 2024 Palantir Technologies, Inc. All rights reserved.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\nimport { foundryPlatformFetch as $foundryPlatformFetch } from \"@osdk/shared.net.platformapi\";\n//\nconst _create = [1, \"/v2/streams/datasets/create\", 3];\n/**\n * Creates a streaming dataset with a stream on the specified branch, or if no branch is specified, on the\n * default branch ('master' for most enrollments). For more information on streaming datasets, refer to the\n * [streams](https://www.palantir.com/docs/foundry/data-integration/streams/) user documentation.\n *\n * @alpha\n *\n * Required Scopes: [api:
|
|
1
|
+
{"version":3,"file":"Dataset.js","names":["foundryPlatformFetch","$foundryPlatformFetch","_create","create","$ctx","args"],"sources":["Dataset.js"],"sourcesContent":["/*\n * Copyright 2024 Palantir Technologies, Inc. All rights reserved.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\nimport { foundryPlatformFetch as $foundryPlatformFetch } from \"@osdk/shared.net.platformapi\";\n//\nconst _create = [1, \"/v2/streams/datasets/create\", 3];\n/**\n * Creates a streaming dataset with a stream on the specified branch, or if no branch is specified, on the\n * default branch ('master' for most enrollments). For more information on streaming datasets, refer to the\n * [streams](https://www.palantir.com/docs/foundry/data-integration/streams/) user documentation.\n *\n * @alpha\n *\n * Required Scopes: [api:streams-write]\n * URL: /v2/streams/datasets/create\n */\nexport function create($ctx, ...args) {\n return $foundryPlatformFetch($ctx, _create, ...args);\n}\n"],"mappings":"AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,SAASA,oBAAoB,IAAIC,qBAAqB,QAAQ,8BAA8B;AAC5F;AACA,MAAMC,OAAO,GAAG,CAAC,CAAC,EAAE,6BAA6B,EAAE,CAAC,CAAC;AACrD;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASC,MAAMA,CAACC,IAAI,EAAE,GAAGC,IAAI,EAAE;EAClC,OAAOJ,qBAAqB,CAACG,IAAI,EAAEF,OAAO,EAAE,GAAGG,IAAI,CAAC;AACxD","ignoreList":[]}
|
|
@@ -1,19 +1,108 @@
|
|
|
1
1
|
import type * as _Core from "@osdk/foundry.core";
|
|
2
2
|
import type * as _Datasets from "@osdk/foundry.datasets";
|
|
3
|
-
import type { SharedClient as $
|
|
3
|
+
import type { SharedClient as $OldClient, SharedClientContext as $OldClientContext } from "@osdk/shared.client";
|
|
4
|
+
import type { SharedClient as $Client, SharedClientContext as $ClientContext } from "@osdk/shared.client2";
|
|
4
5
|
import type * as _Streams from "../_components.js";
|
|
6
|
+
/**
|
|
7
|
+
* Creates a new branch on the backing streaming dataset, and creates a new stream on that branch.
|
|
8
|
+
*
|
|
9
|
+
* @alpha
|
|
10
|
+
*
|
|
11
|
+
* Required Scopes: [api:streams-write]
|
|
12
|
+
* URL: /v2/streams/datasets/{datasetRid}/streams
|
|
13
|
+
*/
|
|
14
|
+
export declare function create($ctx: $Client | $ClientContext | $OldClient | $OldClientContext, ...args: [
|
|
15
|
+
datasetRid: _Datasets.DatasetRid,
|
|
16
|
+
$body: _Streams.CreateStreamRequest,
|
|
17
|
+
$queryParams?: {
|
|
18
|
+
preview?: _Core.PreviewMode | undefined;
|
|
19
|
+
}
|
|
20
|
+
]): Promise<_Streams.Stream>;
|
|
5
21
|
/**
|
|
6
22
|
* Get a stream by its branch name. If the branch does not exist, there is no stream on that branch, or the
|
|
7
23
|
* user does not have permission to access the stream, a 404 error will be returned.
|
|
8
24
|
*
|
|
9
25
|
* @alpha
|
|
10
26
|
*
|
|
11
|
-
* Required Scopes: [api:
|
|
27
|
+
* Required Scopes: [api:streams-read]
|
|
12
28
|
* URL: /v2/streams/datasets/{datasetRid}/streams/{streamBranchName}
|
|
13
29
|
*/
|
|
14
|
-
export declare function get($ctx: $Client | $ClientContext, ...args: [
|
|
30
|
+
export declare function get($ctx: $Client | $ClientContext | $OldClient | $OldClientContext, ...args: [
|
|
31
|
+
datasetRid: _Datasets.DatasetRid,
|
|
32
|
+
streamBranchName: _Datasets.BranchName,
|
|
33
|
+
$queryParams?: {
|
|
34
|
+
preview?: _Core.PreviewMode | undefined;
|
|
35
|
+
}
|
|
36
|
+
]): Promise<_Streams.Stream>;
|
|
37
|
+
/**
|
|
38
|
+
* Publish a single record to the stream. The record will be validated against the stream's schema, and
|
|
39
|
+
* rejected if it is invalid.
|
|
40
|
+
*
|
|
41
|
+
* @alpha
|
|
42
|
+
*
|
|
43
|
+
* Required Scopes: [api:streams-write]
|
|
44
|
+
* URL: /v2/highScale/streams/datasets/{datasetRid}/streams/{streamBranchName}/publishRecord
|
|
45
|
+
*/
|
|
46
|
+
export declare function publishRecord($ctx: $Client | $ClientContext | $OldClient | $OldClientContext, ...args: [
|
|
47
|
+
datasetRid: _Datasets.DatasetRid,
|
|
48
|
+
streamBranchName: _Datasets.BranchName,
|
|
49
|
+
$body: _Streams.PublishRecordToStreamRequest,
|
|
50
|
+
$queryParams?: {
|
|
51
|
+
preview?: _Core.PreviewMode | undefined;
|
|
52
|
+
}
|
|
53
|
+
]): Promise<void>;
|
|
54
|
+
/**
|
|
55
|
+
* Publish a batch of records to the stream. The records will be validated against the stream's schema, and
|
|
56
|
+
* the batch will be rejected if one or more of the records are invalid.
|
|
57
|
+
*
|
|
58
|
+
* @alpha
|
|
59
|
+
*
|
|
60
|
+
* Required Scopes: [api:streams-write]
|
|
61
|
+
* URL: /v2/highScale/streams/datasets/{datasetRid}/streams/{streamBranchName}/publishRecords
|
|
62
|
+
*/
|
|
63
|
+
export declare function publishRecords($ctx: $Client | $ClientContext | $OldClient | $OldClientContext, ...args: [
|
|
64
|
+
datasetRid: _Datasets.DatasetRid,
|
|
65
|
+
streamBranchName: _Datasets.BranchName,
|
|
66
|
+
$body: _Streams.PublishRecordsToStreamRequest,
|
|
67
|
+
$queryParams?: {
|
|
68
|
+
preview?: _Core.PreviewMode | undefined;
|
|
69
|
+
}
|
|
70
|
+
]): Promise<void>;
|
|
71
|
+
/**
|
|
72
|
+
* Publish a single binary record to the stream. The stream's schema must be a single binary field.
|
|
73
|
+
*
|
|
74
|
+
* @alpha
|
|
75
|
+
*
|
|
76
|
+
* Required Scopes: [api:streams-write]
|
|
77
|
+
* URL: /v2/highScale/streams/datasets/{datasetRid}/streams/{streamBranchName}/publishBinaryRecord
|
|
78
|
+
*/
|
|
79
|
+
export declare function publishBinaryRecord($ctx: $Client | $ClientContext | $OldClient | $OldClientContext, ...args: [
|
|
80
|
+
datasetRid: _Datasets.DatasetRid,
|
|
81
|
+
streamBranchName: _Datasets.BranchName,
|
|
82
|
+
$body: Blob,
|
|
83
|
+
$queryParams?: {
|
|
84
|
+
viewRid?: _Streams.ViewRid | undefined;
|
|
85
|
+
preview?: _Core.PreviewMode | undefined;
|
|
86
|
+
}
|
|
87
|
+
]): Promise<void>;
|
|
88
|
+
/**
|
|
89
|
+
* Reset the stream on the given dataset branch, clearing the existing records and allowing new configurations
|
|
90
|
+
* to be applied.
|
|
91
|
+
*
|
|
92
|
+
* To change the stream settings without clearing the records, update the stream settings in-platform.
|
|
93
|
+
*
|
|
94
|
+
* This will create a new stream view (as seen by the change of the `viewRid` on the branch),
|
|
95
|
+
* which will be the new stream view that will be written to for the branch.
|
|
96
|
+
*
|
|
97
|
+
* @alpha
|
|
98
|
+
*
|
|
99
|
+
* Required Scopes: [api:streams-write]
|
|
100
|
+
* URL: /v2/streams/datasets/{datasetRid}/streams/{streamBranchName}/reset
|
|
101
|
+
*/
|
|
102
|
+
export declare function reset($ctx: $Client | $ClientContext | $OldClient | $OldClientContext, ...args: [
|
|
15
103
|
datasetRid: _Datasets.DatasetRid,
|
|
16
104
|
streamBranchName: _Datasets.BranchName,
|
|
105
|
+
$body: _Streams.ResetStreamRequest,
|
|
17
106
|
$queryParams?: {
|
|
18
107
|
preview?: _Core.PreviewMode | undefined;
|
|
19
108
|
}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"Stream.d.ts","sourceRoot":"","sources":["../../../src/public/Stream.ts"],"names":[],"mappings":"AAgBA,OAAO,KAAK,KAAK,KAAK,MAAM,oBAAoB,CAAC;AACjD,OAAO,KAAK,KAAK,SAAS,MAAM,wBAAwB,CAAC;AACzD,OAAO,KAAK,EACV,YAAY,IAAI,OAAO,EACvB,mBAAmB,IAAI,cAAc,EACtC,MAAM,
|
|
1
|
+
{"version":3,"file":"Stream.d.ts","sourceRoot":"","sources":["../../../src/public/Stream.ts"],"names":[],"mappings":"AAgBA,OAAO,KAAK,KAAK,KAAK,MAAM,oBAAoB,CAAC;AACjD,OAAO,KAAK,KAAK,SAAS,MAAM,wBAAwB,CAAC;AACzD,OAAO,KAAK,EACV,YAAY,IAAI,UAAU,EAC1B,mBAAmB,IAAI,iBAAiB,EACzC,MAAM,qBAAqB,CAAC;AAC7B,OAAO,KAAK,EACV,YAAY,IAAI,OAAO,EACvB,mBAAmB,IAAI,cAAc,EACtC,MAAM,sBAAsB,CAAC;AAG9B,OAAO,KAAK,KAAK,QAAQ,MAAM,mBAAmB,CAAC;AAYnD;;;;;;;GAOG;AACH,wBAAgB,MAAM,CACpB,IAAI,EAAE,OAAO,GAAG,cAAc,GAAG,UAAU,GAAG,iBAAiB,EAC/D,GAAG,IAAI,EAAE;IACP,UAAU,EAAE,SAAS,CAAC,UAAU;IAChC,KAAK,EAAE,QAAQ,CAAC,mBAAmB;IACnC,YAAY,CAAC,EAAE;QAAE,OAAO,CAAC,EAAE,KAAK,CAAC,WAAW,GAAG,SAAS,CAAA;KAAE;CAC3D,GACA,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAC,CAE1B;AAUD;;;;;;;;GAQG;AACH,wBAAgB,GAAG,CACjB,IAAI,EAAE,OAAO,GAAG,cAAc,GAAG,UAAU,GAAG,iBAAiB,EAC/D,GAAG,IAAI,EAAE;IACP,UAAU,EAAE,SAAS,CAAC,UAAU;IAChC,gBAAgB,EAAE,SAAS,CAAC,UAAU;IAEtC,YAAY,CAAC,EAAE;QAAE,OAAO,CAAC,EAAE,KAAK,CAAC,WAAW,GAAG,SAAS,CAAA;KAAE;CAC3D,GACA,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAC,CAE1B;AAWD;;;;;;;;GAQG;AACH,wBAAgB,aAAa,CAC3B,IAAI,EAAE,OAAO,GAAG,cAAc,GAAG,UAAU,GAAG,iBAAiB,EAC/D,GAAG,IAAI,EAAE;IACP,UAAU,EAAE,SAAS,CAAC,UAAU;IAChC,gBAAgB,EAAE,SAAS,CAAC,UAAU;IACtC,KAAK,EAAE,QAAQ,CAAC,4BAA4B;IAC5C,YAAY,CAAC,EAAE;QAAE,OAAO,CAAC,EAAE,KAAK,CAAC,WAAW,GAAG,SAAS,CAAA;KAAE;CAC3D,GACA,OAAO,CAAC,IAAI,CAAC,CAEf;AAWD;;;;;;;;GAQG;AACH,wBAAgB,cAAc,CAC5B,IAAI,EAAE,OAAO,GAAG,cAAc,GAAG,UAAU,GAAG,iBAAiB,EAC/D,GAAG,IAAI,EAAE;IACP,UAAU,EAAE,SAAS,CAAC,UAAU;IAChC,gBAAgB,EAAE,SAAS,CAAC,UAAU;IACtC,KAAK,EAAE,QAAQ,CAAC,6BAA6B;IAC7C,YAAY,CAAC,EAAE;QAAE,OAAO,CAAC,EAAE,KAAK,CAAC,WAAW,GAAG,SAAS,CAAA;KAAE;CAC3D,GACA,OAAO,CAAC,IAAI,CAAC,CAEf;AAmBD;;;;;;;GAOG;AACH,wBAAgB,mBAAmB,CACjC,IAAI,EAAE,OAAO,GAAG,cAAc,GAAG,UAAU,GAAG,iBAAiB,EAC/D,GAAG,IAAI,EAAE;IACP,UAAU,EAAE,SAAS,CAAC,UAAU;IAChC,gBAAgB,EAAE,SAAS,CAAC,UAAU;IACtC,KAAK,EAAE,IAAI;IACX,YAAY,CAAC,EAAE;QACb,OAAO,CAAC,EAAE,QAAQ,CAAC,OAAO,GAAG,SAAS,CAAC;QACvC,OAAO,CAAC,EAAE,KAAK,CAAC,WAAW,GAAG,SAAS,CAAC;KACzC;CACF,GACA,OAAO,CAAC,IAAI,CAAC,CAEf;AAWD;;;;;;;;;;;;;GAaG;AACH,wBAAgB,KAAK,CACnB,IAAI,EAAE,OAAO,GAAG,cAAc,GAAG,UAAU,GAAG,iBAAiB,EAC/D,GAAG,IAAI,EAAE;IACP,UAAU,EAAE,SAAS,CAAC,UAAU;IAChC,gBAAgB,EAAE,SAAS,CAAC,UAAU;IACtC,KAAK,EAAE,QAAQ,CAAC,kBAAkB;IAClC,YAAY,CAAC,EAAE;QAAE,OAAO,CAAC,EAAE,KAAK,CAAC,WAAW,GAAG,SAAS,CAAA;KAAE;CAC3D,GACA,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAC,CAE1B"}
|
|
@@ -15,6 +15,18 @@
|
|
|
15
15
|
*/
|
|
16
16
|
import { foundryPlatformFetch as $foundryPlatformFetch } from "@osdk/shared.net.platformapi";
|
|
17
17
|
//
|
|
18
|
+
const _create = [1, "/v2/streams/datasets/{0}/streams", 3];
|
|
19
|
+
/**
|
|
20
|
+
* Creates a new branch on the backing streaming dataset, and creates a new stream on that branch.
|
|
21
|
+
*
|
|
22
|
+
* @alpha
|
|
23
|
+
*
|
|
24
|
+
* Required Scopes: [api:streams-write]
|
|
25
|
+
* URL: /v2/streams/datasets/{datasetRid}/streams
|
|
26
|
+
*/
|
|
27
|
+
export function create($ctx, ...args) {
|
|
28
|
+
return $foundryPlatformFetch($ctx, _create, ...args);
|
|
29
|
+
}
|
|
18
30
|
const _get = [0, "/v2/streams/datasets/{0}/streams/{1}", 2];
|
|
19
31
|
/**
|
|
20
32
|
* Get a stream by its branch name. If the branch does not exist, there is no stream on that branch, or the
|
|
@@ -22,10 +34,66 @@ const _get = [0, "/v2/streams/datasets/{0}/streams/{1}", 2];
|
|
|
22
34
|
*
|
|
23
35
|
* @alpha
|
|
24
36
|
*
|
|
25
|
-
* Required Scopes: [api:
|
|
37
|
+
* Required Scopes: [api:streams-read]
|
|
26
38
|
* URL: /v2/streams/datasets/{datasetRid}/streams/{streamBranchName}
|
|
27
39
|
*/
|
|
28
40
|
export function get($ctx, ...args) {
|
|
29
41
|
return $foundryPlatformFetch($ctx, _get, ...args);
|
|
30
42
|
}
|
|
43
|
+
const _publishRecord = [1, "/v2/highScale/streams/datasets/{0}/streams/{1}/publishRecord", 3];
|
|
44
|
+
/**
|
|
45
|
+
* Publish a single record to the stream. The record will be validated against the stream's schema, and
|
|
46
|
+
* rejected if it is invalid.
|
|
47
|
+
*
|
|
48
|
+
* @alpha
|
|
49
|
+
*
|
|
50
|
+
* Required Scopes: [api:streams-write]
|
|
51
|
+
* URL: /v2/highScale/streams/datasets/{datasetRid}/streams/{streamBranchName}/publishRecord
|
|
52
|
+
*/
|
|
53
|
+
export function publishRecord($ctx, ...args) {
|
|
54
|
+
return $foundryPlatformFetch($ctx, _publishRecord, ...args);
|
|
55
|
+
}
|
|
56
|
+
const _publishRecords = [1, "/v2/highScale/streams/datasets/{0}/streams/{1}/publishRecords", 3];
|
|
57
|
+
/**
|
|
58
|
+
* Publish a batch of records to the stream. The records will be validated against the stream's schema, and
|
|
59
|
+
* the batch will be rejected if one or more of the records are invalid.
|
|
60
|
+
*
|
|
61
|
+
* @alpha
|
|
62
|
+
*
|
|
63
|
+
* Required Scopes: [api:streams-write]
|
|
64
|
+
* URL: /v2/highScale/streams/datasets/{datasetRid}/streams/{streamBranchName}/publishRecords
|
|
65
|
+
*/
|
|
66
|
+
export function publishRecords($ctx, ...args) {
|
|
67
|
+
return $foundryPlatformFetch($ctx, _publishRecords, ...args);
|
|
68
|
+
}
|
|
69
|
+
const _publishBinaryRecord = [1, "/v2/highScale/streams/datasets/{0}/streams/{1}/publishBinaryRecord", 3, "application/octet-stream"];
|
|
70
|
+
/**
|
|
71
|
+
* Publish a single binary record to the stream. The stream's schema must be a single binary field.
|
|
72
|
+
*
|
|
73
|
+
* @alpha
|
|
74
|
+
*
|
|
75
|
+
* Required Scopes: [api:streams-write]
|
|
76
|
+
* URL: /v2/highScale/streams/datasets/{datasetRid}/streams/{streamBranchName}/publishBinaryRecord
|
|
77
|
+
*/
|
|
78
|
+
export function publishBinaryRecord($ctx, ...args) {
|
|
79
|
+
return $foundryPlatformFetch($ctx, _publishBinaryRecord, ...args);
|
|
80
|
+
}
|
|
81
|
+
const _reset = [1, "/v2/streams/datasets/{0}/streams/{1}/reset", 3];
|
|
82
|
+
/**
|
|
83
|
+
* Reset the stream on the given dataset branch, clearing the existing records and allowing new configurations
|
|
84
|
+
* to be applied.
|
|
85
|
+
*
|
|
86
|
+
* To change the stream settings without clearing the records, update the stream settings in-platform.
|
|
87
|
+
*
|
|
88
|
+
* This will create a new stream view (as seen by the change of the `viewRid` on the branch),
|
|
89
|
+
* which will be the new stream view that will be written to for the branch.
|
|
90
|
+
*
|
|
91
|
+
* @alpha
|
|
92
|
+
*
|
|
93
|
+
* Required Scopes: [api:streams-write]
|
|
94
|
+
* URL: /v2/streams/datasets/{datasetRid}/streams/{streamBranchName}/reset
|
|
95
|
+
*/
|
|
96
|
+
export function reset($ctx, ...args) {
|
|
97
|
+
return $foundryPlatformFetch($ctx, _reset, ...args);
|
|
98
|
+
}
|
|
31
99
|
//# sourceMappingURL=Stream.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"Stream.js","names":["foundryPlatformFetch","$foundryPlatformFetch","
|
|
1
|
+
{"version":3,"file":"Stream.js","names":["foundryPlatformFetch","$foundryPlatformFetch","_create","create","$ctx","args","_get","get","_publishRecord","publishRecord","_publishRecords","publishRecords","_publishBinaryRecord","publishBinaryRecord","_reset","reset"],"sources":["Stream.js"],"sourcesContent":["/*\n * Copyright 2024 Palantir Technologies, Inc. All rights reserved.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\nimport { foundryPlatformFetch as $foundryPlatformFetch } from \"@osdk/shared.net.platformapi\";\n//\nconst _create = [1, \"/v2/streams/datasets/{0}/streams\", 3];\n/**\n * Creates a new branch on the backing streaming dataset, and creates a new stream on that branch.\n *\n * @alpha\n *\n * Required Scopes: [api:streams-write]\n * URL: /v2/streams/datasets/{datasetRid}/streams\n */\nexport function create($ctx, ...args) {\n return $foundryPlatformFetch($ctx, _create, ...args);\n}\nconst _get = [0, \"/v2/streams/datasets/{0}/streams/{1}\", 2];\n/**\n * Get a stream by its branch name. If the branch does not exist, there is no stream on that branch, or the\n * user does not have permission to access the stream, a 404 error will be returned.\n *\n * @alpha\n *\n * Required Scopes: [api:streams-read]\n * URL: /v2/streams/datasets/{datasetRid}/streams/{streamBranchName}\n */\nexport function get($ctx, ...args) {\n return $foundryPlatformFetch($ctx, _get, ...args);\n}\nconst _publishRecord = [1, \"/v2/highScale/streams/datasets/{0}/streams/{1}/publishRecord\", 3];\n/**\n * Publish a single record to the stream. The record will be validated against the stream's schema, and\n * rejected if it is invalid.\n *\n * @alpha\n *\n * Required Scopes: [api:streams-write]\n * URL: /v2/highScale/streams/datasets/{datasetRid}/streams/{streamBranchName}/publishRecord\n */\nexport function publishRecord($ctx, ...args) {\n return $foundryPlatformFetch($ctx, _publishRecord, ...args);\n}\nconst _publishRecords = [1, \"/v2/highScale/streams/datasets/{0}/streams/{1}/publishRecords\", 3];\n/**\n * Publish a batch of records to the stream. The records will be validated against the stream's schema, and\n * the batch will be rejected if one or more of the records are invalid.\n *\n * @alpha\n *\n * Required Scopes: [api:streams-write]\n * URL: /v2/highScale/streams/datasets/{datasetRid}/streams/{streamBranchName}/publishRecords\n */\nexport function publishRecords($ctx, ...args) {\n return $foundryPlatformFetch($ctx, _publishRecords, ...args);\n}\nconst _publishBinaryRecord = [\n 1,\n \"/v2/highScale/streams/datasets/{0}/streams/{1}/publishBinaryRecord\",\n 3,\n \"application/octet-stream\",\n];\n/**\n * Publish a single binary record to the stream. The stream's schema must be a single binary field.\n *\n * @alpha\n *\n * Required Scopes: [api:streams-write]\n * URL: /v2/highScale/streams/datasets/{datasetRid}/streams/{streamBranchName}/publishBinaryRecord\n */\nexport function publishBinaryRecord($ctx, ...args) {\n return $foundryPlatformFetch($ctx, _publishBinaryRecord, ...args);\n}\nconst _reset = [1, \"/v2/streams/datasets/{0}/streams/{1}/reset\", 3];\n/**\n * Reset the stream on the given dataset branch, clearing the existing records and allowing new configurations\n * to be applied.\n *\n * To change the stream settings without clearing the records, update the stream settings in-platform.\n *\n * This will create a new stream view (as seen by the change of the `viewRid` on the branch),\n * which will be the new stream view that will be written to for the branch.\n *\n * @alpha\n *\n * Required Scopes: [api:streams-write]\n * URL: /v2/streams/datasets/{datasetRid}/streams/{streamBranchName}/reset\n */\nexport function reset($ctx, ...args) {\n return $foundryPlatformFetch($ctx, _reset, ...args);\n}\n"],"mappings":"AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,SAASA,oBAAoB,IAAIC,qBAAqB,QAAQ,8BAA8B;AAC5F;AACA,MAAMC,OAAO,GAAG,CAAC,CAAC,EAAE,kCAAkC,EAAE,CAAC,CAAC;AAC1D;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASC,MAAMA,CAACC,IAAI,EAAE,GAAGC,IAAI,EAAE;EAClC,OAAOJ,qBAAqB,CAACG,IAAI,EAAEF,OAAO,EAAE,GAAGG,IAAI,CAAC;AACxD;AACA,MAAMC,IAAI,GAAG,CAAC,CAAC,EAAE,sCAAsC,EAAE,CAAC,CAAC;AAC3D;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASC,GAAGA,CAACH,IAAI,EAAE,GAAGC,IAAI,EAAE;EAC/B,OAAOJ,qBAAqB,CAACG,IAAI,EAAEE,IAAI,EAAE,GAAGD,IAAI,CAAC;AACrD;AACA,MAAMG,cAAc,GAAG,CAAC,CAAC,EAAE,8DAA8D,EAAE,CAAC,CAAC;AAC7F;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASC,aAAaA,CAACL,IAAI,EAAE,GAAGC,IAAI,EAAE;EACzC,OAAOJ,qBAAqB,CAACG,IAAI,EAAEI,cAAc,EAAE,GAAGH,IAAI,CAAC;AAC/D;AACA,MAAMK,eAAe,GAAG,CAAC,CAAC,EAAE,+DAA+D,EAAE,CAAC,CAAC;AAC/F;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASC,cAAcA,CAACP,IAAI,EAAE,GAAGC,IAAI,EAAE;EAC1C,OAAOJ,qBAAqB,CAACG,IAAI,EAAEM,eAAe,EAAE,GAAGL,IAAI,CAAC;AAChE;AACA,MAAMO,oBAAoB,GAAG,CACzB,CAAC,EACD,oEAAoE,EACpE,CAAC,EACD,0BAA0B,CAC7B;AACD;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASC,mBAAmBA,CAACT,IAAI,EAAE,GAAGC,IAAI,EAAE;EAC/C,OAAOJ,qBAAqB,CAACG,IAAI,EAAEQ,oBAAoB,EAAE,GAAGP,IAAI,CAAC;AACrE;AACA,MAAMS,MAAM,GAAG,CAAC,CAAC,EAAE,4CAA4C,EAAE,CAAC,CAAC;AACnE;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASC,KAAKA,CAACX,IAAI,EAAE,GAAGC,IAAI,EAAE;EACjC,OAAOJ,qBAAqB,CAACG,IAAI,EAAEU,MAAM,EAAE,GAAGT,IAAI,CAAC;AACvD","ignoreList":[]}
|
package/package.json
CHANGED
|
@@ -1,10 +1,10 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@osdk/foundry.streams",
|
|
3
|
-
"version": "2.
|
|
3
|
+
"version": "2.2.0",
|
|
4
4
|
"license": "Apache-2.0",
|
|
5
5
|
"repository": {
|
|
6
6
|
"type": "git",
|
|
7
|
-
"url": "https://github.com/palantir/
|
|
7
|
+
"url": "https://github.com/palantir/foundry-platform-typescript.git"
|
|
8
8
|
},
|
|
9
9
|
"exports": {
|
|
10
10
|
".": {
|
|
@@ -17,16 +17,15 @@
|
|
|
17
17
|
}
|
|
18
18
|
},
|
|
19
19
|
"dependencies": {
|
|
20
|
-
"@osdk/foundry.core": "2.1.1",
|
|
21
|
-
"@osdk/foundry.datasets": "2.1.1",
|
|
22
|
-
"@osdk/foundry.filesystem": "2.1.1",
|
|
23
20
|
"@osdk/shared.client": "^1.0.1",
|
|
24
|
-
"@osdk/shared.
|
|
21
|
+
"@osdk/shared.client2": "^1.0.0",
|
|
22
|
+
"@osdk/shared.net.platformapi": "~0.3.2",
|
|
23
|
+
"@osdk/foundry.core": "2.2.0",
|
|
24
|
+
"@osdk/foundry.datasets": "2.2.0",
|
|
25
|
+
"@osdk/foundry.filesystem": "2.2.0"
|
|
25
26
|
},
|
|
26
27
|
"devDependencies": {
|
|
27
28
|
"typescript": "^5.5.4",
|
|
28
|
-
"@osdk/monorepo.api-extractor": "~0.0.0",
|
|
29
|
-
"@osdk/monorepo.tsup": "~0.0.0",
|
|
30
29
|
"@osdk/monorepo.tsconfig": "~0.0.0"
|
|
31
30
|
},
|
|
32
31
|
"publishConfig": {
|
|
@@ -46,7 +45,7 @@
|
|
|
46
45
|
"sls": {
|
|
47
46
|
"dependencies": {
|
|
48
47
|
"com.palantir.foundry.api:api-gateway": {
|
|
49
|
-
"minVersion": "1.
|
|
48
|
+
"minVersion": "1.950.0",
|
|
50
49
|
"maxVersion": "1.x.x",
|
|
51
50
|
"optional": true
|
|
52
51
|
}
|