@maxim_mazurok/gapi.client.datastore-v1 0.1.20260310 → 0.2.20260529
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/index.d.ts +169 -86
- package/package.json +1 -1
- package/readme.md +12 -0
package/index.d.ts
CHANGED
|
@@ -9,7 +9,7 @@
|
|
|
9
9
|
// This file was generated by https://github.com/Maxim-Mazurok/google-api-typings-generator. Please do not edit it manually.
|
|
10
10
|
// In case of any problems please post issue to https://github.com/Maxim-Mazurok/google-api-typings-generator
|
|
11
11
|
// Generated from: https://datastore.googleapis.com/$discovery/rest?version=v1
|
|
12
|
-
// Revision:
|
|
12
|
+
// Revision: 20260529
|
|
13
13
|
|
|
14
14
|
/// <reference types="gapi.client" />
|
|
15
15
|
|
|
@@ -48,7 +48,12 @@ declare namespace gapi.client {
|
|
|
48
48
|
/** The aggregation results for this batch. */
|
|
49
49
|
aggregationResults?: AggregationResult[];
|
|
50
50
|
/** The state of the query after the current batch. Only COUNT(*) aggregations are supported in the initial launch. Therefore, expected result type is limited to `NO_MORE_RESULTS`. */
|
|
51
|
-
moreResults?:
|
|
51
|
+
moreResults?:
|
|
52
|
+
| 'MORE_RESULTS_TYPE_UNSPECIFIED'
|
|
53
|
+
| 'NOT_FINISHED'
|
|
54
|
+
| 'MORE_RESULTS_AFTER_LIMIT'
|
|
55
|
+
| 'MORE_RESULTS_AFTER_CURSOR'
|
|
56
|
+
| 'NO_MORE_RESULTS';
|
|
52
57
|
/** Read timestamp this batch was returned from. In a single transaction, subsequent query result batches for the same query can have a greater timestamp. Each batch's read timestamp is valid for all preceding batches. */
|
|
53
58
|
readTime?: string;
|
|
54
59
|
}
|
|
@@ -84,7 +89,7 @@ declare namespace gapi.client {
|
|
|
84
89
|
/** The ID of the database against which to make the request. '(default)' is not allowed; please use empty string '' to refer the default database. */
|
|
85
90
|
databaseId?: string;
|
|
86
91
|
/** The type of commit to perform. Defaults to `TRANSACTIONAL`. */
|
|
87
|
-
mode?:
|
|
92
|
+
mode?: 'MODE_UNSPECIFIED' | 'TRANSACTIONAL' | 'NON_TRANSACTIONAL';
|
|
88
93
|
/** The mutations to perform. When mode is `TRANSACTIONAL`, mutations affecting a single entity are applied in order. The following sequences of mutations affecting a single entity are not permitted in a single `Commit` request: - `insert` followed by `insert` - `update` followed by `insert` - `upsert` followed by `insert` - `delete` followed by `update` When mode is `NON_TRANSACTIONAL`, no two mutations may affect a single entity. */
|
|
89
94
|
mutations?: Mutation[];
|
|
90
95
|
/** Options for beginning a new transaction for this request. The transaction is committed when the request completes. If specified, TransactionOptions.mode must be TransactionOptions.ReadWrite. */
|
|
@@ -104,7 +109,7 @@ declare namespace gapi.client {
|
|
|
104
109
|
/** The list of filters to combine. Requires: * At least one filter is present. */
|
|
105
110
|
filters?: Filter[];
|
|
106
111
|
/** The operator for combining multiple filters. */
|
|
107
|
-
op?:
|
|
112
|
+
op?: 'OPERATOR_UNSPECIFIED' | 'AND' | 'OR';
|
|
108
113
|
}
|
|
109
114
|
interface Count {
|
|
110
115
|
/** Optional. Optional constraint on the maximum number of entities to count. This provides a way to set an upper bound on the number of entities to scan, limiting latency, and cost. Unspecified is interpreted as no bound. If a zero value is provided, a count result of zero should always be expected. High-Level Example: ``` AGGREGATE COUNT_UP_TO(1000) OVER ( SELECT * FROM k ); ``` Requires: * Must be non-negative when present. */
|
|
@@ -157,7 +162,11 @@ declare namespace gapi.client {
|
|
|
157
162
|
}
|
|
158
163
|
interface FindNearest {
|
|
159
164
|
/** Required. The Distance Measure to use, required. */
|
|
160
|
-
distanceMeasure?:
|
|
165
|
+
distanceMeasure?:
|
|
166
|
+
| 'DISTANCE_MEASURE_UNSPECIFIED'
|
|
167
|
+
| 'EUCLIDEAN'
|
|
168
|
+
| 'COSINE'
|
|
169
|
+
| 'DOT_PRODUCT';
|
|
161
170
|
/** Optional. Optional name of the field to output the result of the vector distance calculation. Must conform to entity property limitations. */
|
|
162
171
|
distanceResultProperty?: string;
|
|
163
172
|
/** Optional. Option to specify a threshold for which no less similar documents will be returned. The behavior of the specified `distance_measure` will affect the meaning of the distance threshold. Since DOT_PRODUCT distances increase when the vectors are more similar, the comparison is inverted. * For EUCLIDEAN, COSINE: WHERE distance <= distance_threshold * For DOT_PRODUCT: WHERE distance >= distance_threshold */
|
|
@@ -175,11 +184,22 @@ declare namespace gapi.client {
|
|
|
175
184
|
/** The client-assigned labels which were provided when the operation was created. May also include additional labels. */
|
|
176
185
|
labels?: {[P in string]: string};
|
|
177
186
|
/** The type of the operation. Can be used as a filter in ListOperationsRequest. */
|
|
178
|
-
operationType?:
|
|
187
|
+
operationType?:
|
|
188
|
+
| 'OPERATION_TYPE_UNSPECIFIED'
|
|
189
|
+
| 'EXPORT_ENTITIES'
|
|
190
|
+
| 'IMPORT_ENTITIES';
|
|
179
191
|
/** The time that work began on the operation. */
|
|
180
192
|
startTime?: string;
|
|
181
193
|
/** The current state of the Operation. */
|
|
182
|
-
state?:
|
|
194
|
+
state?:
|
|
195
|
+
| 'STATE_UNSPECIFIED'
|
|
196
|
+
| 'INITIALIZING'
|
|
197
|
+
| 'PROCESSING'
|
|
198
|
+
| 'CANCELLING'
|
|
199
|
+
| 'FINALIZING'
|
|
200
|
+
| 'SUCCESSFUL'
|
|
201
|
+
| 'FAILED'
|
|
202
|
+
| 'CANCELLED';
|
|
183
203
|
}
|
|
184
204
|
interface GoogleDatastoreAdminV1beta1EntityFilter {
|
|
185
205
|
/** If empty, then this represents all kinds. */
|
|
@@ -227,17 +247,42 @@ declare namespace gapi.client {
|
|
|
227
247
|
/** The client-assigned labels which were provided when the operation was created. May also include additional labels. */
|
|
228
248
|
labels?: {[P in string]: string};
|
|
229
249
|
/** The type of the operation. Can be used as a filter in ListOperationsRequest. */
|
|
230
|
-
operationType?:
|
|
250
|
+
operationType?:
|
|
251
|
+
| 'OPERATION_TYPE_UNSPECIFIED'
|
|
252
|
+
| 'EXPORT_ENTITIES'
|
|
253
|
+
| 'IMPORT_ENTITIES'
|
|
254
|
+
| 'CREATE_INDEX'
|
|
255
|
+
| 'DELETE_INDEX';
|
|
231
256
|
/** The time that work began on the operation. */
|
|
232
257
|
startTime?: string;
|
|
233
258
|
/** The current state of the Operation. */
|
|
234
|
-
state?:
|
|
259
|
+
state?:
|
|
260
|
+
| 'STATE_UNSPECIFIED'
|
|
261
|
+
| 'INITIALIZING'
|
|
262
|
+
| 'PROCESSING'
|
|
263
|
+
| 'CANCELLING'
|
|
264
|
+
| 'FINALIZING'
|
|
265
|
+
| 'SUCCESSFUL'
|
|
266
|
+
| 'FAILED'
|
|
267
|
+
| 'CANCELLED';
|
|
235
268
|
}
|
|
236
269
|
interface GoogleDatastoreAdminV1DatastoreFirestoreMigrationMetadata {
|
|
237
270
|
/** The current state of migration from Cloud Datastore to Cloud Firestore in Datastore mode. */
|
|
238
|
-
migrationState?:
|
|
271
|
+
migrationState?:
|
|
272
|
+
| 'MIGRATION_STATE_UNSPECIFIED'
|
|
273
|
+
| 'RUNNING'
|
|
274
|
+
| 'PAUSED'
|
|
275
|
+
| 'COMPLETE';
|
|
239
276
|
/** The current step of migration from Cloud Datastore to Cloud Firestore in Datastore mode. */
|
|
240
|
-
migrationStep?:
|
|
277
|
+
migrationStep?:
|
|
278
|
+
| 'MIGRATION_STEP_UNSPECIFIED'
|
|
279
|
+
| 'PREPARE'
|
|
280
|
+
| 'START'
|
|
281
|
+
| 'APPLY_WRITES_SYNCHRONOUSLY'
|
|
282
|
+
| 'COPY_AND_VERIFY'
|
|
283
|
+
| 'REDIRECT_EVENTUALLY_CONSISTENT_READS'
|
|
284
|
+
| 'REDIRECT_STRONGLY_CONSISTENT_READS'
|
|
285
|
+
| 'REDIRECT_WRITES';
|
|
241
286
|
}
|
|
242
287
|
interface GoogleDatastoreAdminV1EntityFilter {
|
|
243
288
|
/** If empty, then this represents all kinds. */
|
|
@@ -291,7 +336,7 @@ declare namespace gapi.client {
|
|
|
291
336
|
}
|
|
292
337
|
interface GoogleDatastoreAdminV1Index {
|
|
293
338
|
/** Required. The index's ancestor mode. Must not be ANCESTOR_MODE_UNSPECIFIED. */
|
|
294
|
-
ancestor?:
|
|
339
|
+
ancestor?: 'ANCESTOR_MODE_UNSPECIFIED' | 'NONE' | 'ALL_ANCESTORS';
|
|
295
340
|
/** Output only. The resource ID of the index. */
|
|
296
341
|
indexId?: string;
|
|
297
342
|
/** Required. The entity kind to which this index applies. */
|
|
@@ -301,11 +346,11 @@ declare namespace gapi.client {
|
|
|
301
346
|
/** Required. An ordered sequence of property names and their index attributes. Requires: * A maximum of 100 properties. */
|
|
302
347
|
properties?: GoogleDatastoreAdminV1IndexedProperty[];
|
|
303
348
|
/** Output only. The state of the index. */
|
|
304
|
-
state?:
|
|
349
|
+
state?: 'STATE_UNSPECIFIED' | 'CREATING' | 'READY' | 'DELETING' | 'ERROR';
|
|
305
350
|
}
|
|
306
351
|
interface GoogleDatastoreAdminV1IndexedProperty {
|
|
307
352
|
/** Required. The indexed property's direction. Must not be DIRECTION_UNSPECIFIED. */
|
|
308
|
-
direction?:
|
|
353
|
+
direction?: 'DIRECTION_UNSPECIFIED' | 'ASCENDING' | 'DESCENDING';
|
|
309
354
|
/** Required. The property name to index. */
|
|
310
355
|
name?: string;
|
|
311
356
|
}
|
|
@@ -329,15 +374,27 @@ declare namespace gapi.client {
|
|
|
329
374
|
/** Details for the `REDIRECT_WRITES` step. */
|
|
330
375
|
redirectWritesStepDetails?: GoogleDatastoreAdminV1RedirectWritesStepDetails;
|
|
331
376
|
/** The step that is starting. An event with step set to `START` indicates that the migration has been reverted back to the initial pre-migration state. */
|
|
332
|
-
step?:
|
|
377
|
+
step?:
|
|
378
|
+
| 'MIGRATION_STEP_UNSPECIFIED'
|
|
379
|
+
| 'PREPARE'
|
|
380
|
+
| 'START'
|
|
381
|
+
| 'APPLY_WRITES_SYNCHRONOUSLY'
|
|
382
|
+
| 'COPY_AND_VERIFY'
|
|
383
|
+
| 'REDIRECT_EVENTUALLY_CONSISTENT_READS'
|
|
384
|
+
| 'REDIRECT_STRONGLY_CONSISTENT_READS'
|
|
385
|
+
| 'REDIRECT_WRITES';
|
|
333
386
|
}
|
|
334
387
|
interface GoogleDatastoreAdminV1MigrationStateEvent {
|
|
335
388
|
/** The new state of the migration. */
|
|
336
|
-
state?:
|
|
389
|
+
state?: 'MIGRATION_STATE_UNSPECIFIED' | 'RUNNING' | 'PAUSED' | 'COMPLETE';
|
|
337
390
|
}
|
|
338
391
|
interface GoogleDatastoreAdminV1PrepareStepDetails {
|
|
339
392
|
/** The concurrency mode this database will use when it reaches the `REDIRECT_WRITES` step. */
|
|
340
|
-
concurrencyMode?:
|
|
393
|
+
concurrencyMode?:
|
|
394
|
+
| 'CONCURRENCY_MODE_UNSPECIFIED'
|
|
395
|
+
| 'PESSIMISTIC'
|
|
396
|
+
| 'OPTIMISTIC'
|
|
397
|
+
| 'OPTIMISTIC_WITH_ENTITY_GROUPS';
|
|
341
398
|
}
|
|
342
399
|
interface GoogleDatastoreAdminV1Progress {
|
|
343
400
|
/** The amount of work that has been completed. Note that this may be greater than work_estimated. */
|
|
@@ -347,7 +404,11 @@ declare namespace gapi.client {
|
|
|
347
404
|
}
|
|
348
405
|
interface GoogleDatastoreAdminV1RedirectWritesStepDetails {
|
|
349
406
|
/** The concurrency mode for this database. */
|
|
350
|
-
concurrencyMode?:
|
|
407
|
+
concurrencyMode?:
|
|
408
|
+
| 'CONCURRENCY_MODE_UNSPECIFIED'
|
|
409
|
+
| 'PESSIMISTIC'
|
|
410
|
+
| 'OPTIMISTIC'
|
|
411
|
+
| 'OPTIMISTIC_WITH_ENTITY_GROUPS';
|
|
351
412
|
}
|
|
352
413
|
interface GoogleLongrunningListOperationsResponse {
|
|
353
414
|
/** The standard List next-page token. */
|
|
@@ -427,7 +488,10 @@ declare namespace gapi.client {
|
|
|
427
488
|
/** The version of the entity that this mutation is being applied to. If this does not match the current version on the server, the mutation conflicts. */
|
|
428
489
|
baseVersion?: string;
|
|
429
490
|
/** The strategy to use when a conflict is detected. Defaults to `SERVER_VALUE`. If this is set, then `conflict_detection_strategy` must also be set. */
|
|
430
|
-
conflictResolutionStrategy?:
|
|
491
|
+
conflictResolutionStrategy?:
|
|
492
|
+
| 'STRATEGY_UNSPECIFIED'
|
|
493
|
+
| 'SERVER_VALUE'
|
|
494
|
+
| 'FAIL';
|
|
431
495
|
/** The key of the entity to delete. The entity may or may not already exist. Must have a complete key path and must not be reserved/read-only. */
|
|
432
496
|
delete?: Key;
|
|
433
497
|
/** The entity to insert. The entity must not already exist. The entity key's final path element may be incomplete. */
|
|
@@ -475,7 +539,7 @@ declare namespace gapi.client {
|
|
|
475
539
|
}
|
|
476
540
|
interface PlanSummary {
|
|
477
541
|
/** The indexes selected for the query. For example: [ {"query_scope": "Collection", "properties": "(foo ASC, __name__ ASC)"}, {"query_scope": "Collection", "properties": "(bar ASC, __name__ ASC)"} ] */
|
|
478
|
-
indexesUsed?:
|
|
542
|
+
indexesUsed?: {[P in string]: any}[];
|
|
479
543
|
}
|
|
480
544
|
interface Projection {
|
|
481
545
|
/** The property to project. */
|
|
@@ -483,7 +547,17 @@ declare namespace gapi.client {
|
|
|
483
547
|
}
|
|
484
548
|
interface PropertyFilter {
|
|
485
549
|
/** The operator to filter by. */
|
|
486
|
-
op?:
|
|
550
|
+
op?:
|
|
551
|
+
| 'OPERATOR_UNSPECIFIED'
|
|
552
|
+
| 'LESS_THAN'
|
|
553
|
+
| 'LESS_THAN_OR_EQUAL'
|
|
554
|
+
| 'GREATER_THAN'
|
|
555
|
+
| 'GREATER_THAN_OR_EQUAL'
|
|
556
|
+
| 'EQUAL'
|
|
557
|
+
| 'IN'
|
|
558
|
+
| 'NOT_EQUAL'
|
|
559
|
+
| 'HAS_ANCESTOR'
|
|
560
|
+
| 'NOT_IN';
|
|
487
561
|
/** The property to filter by. */
|
|
488
562
|
property?: PropertyReference;
|
|
489
563
|
/** The value to compare the property to. */
|
|
@@ -495,7 +569,7 @@ declare namespace gapi.client {
|
|
|
495
569
|
}
|
|
496
570
|
interface PropertyOrder {
|
|
497
571
|
/** The direction to order by. Defaults to `ASCENDING`. */
|
|
498
|
-
direction?:
|
|
572
|
+
direction?: 'DIRECTION_UNSPECIFIED' | 'ASCENDING' | 'DESCENDING';
|
|
499
573
|
/** The property to order by. */
|
|
500
574
|
property?: PropertyReference;
|
|
501
575
|
}
|
|
@@ -517,7 +591,7 @@ declare namespace gapi.client {
|
|
|
517
591
|
/** Removes all of the given elements from the array in the property. If the property is not an array, or if the property does not yet exist, it is set to the empty array. Equivalent numbers of different types (e.g. 3L and 3.0) are considered equal when deciding whether an element should be removed. NaN is equal to NaN, and the null value is equal to the null value. This will remove all equivalent values if there are duplicates. The corresponding transform result will be the null value. */
|
|
518
592
|
removeAllFromArray?: ArrayValue;
|
|
519
593
|
/** Sets the property to the given server value. */
|
|
520
|
-
setToServerValue?:
|
|
594
|
+
setToServerValue?: 'SERVER_VALUE_UNSPECIFIED' | 'REQUEST_TIME';
|
|
521
595
|
}
|
|
522
596
|
interface Query {
|
|
523
597
|
/** The properties to make distinct. The query results will contain the first result for each distinct combination of values for the given properties (if empty, all results are returned). Requires: * If `order` is specified, the set of distinct on properties must appear before the non-distinct on properties in `order`. */
|
|
@@ -547,9 +621,18 @@ declare namespace gapi.client {
|
|
|
547
621
|
/** The results for this batch. */
|
|
548
622
|
entityResults?: EntityResult[];
|
|
549
623
|
/** The result type for every entity in `entity_results`. */
|
|
550
|
-
entityResultType?:
|
|
624
|
+
entityResultType?:
|
|
625
|
+
| 'RESULT_TYPE_UNSPECIFIED'
|
|
626
|
+
| 'FULL'
|
|
627
|
+
| 'PROJECTION'
|
|
628
|
+
| 'KEY_ONLY';
|
|
551
629
|
/** The state of the query after the current batch. */
|
|
552
|
-
moreResults?:
|
|
630
|
+
moreResults?:
|
|
631
|
+
| 'MORE_RESULTS_TYPE_UNSPECIFIED'
|
|
632
|
+
| 'NOT_FINISHED'
|
|
633
|
+
| 'MORE_RESULTS_AFTER_LIMIT'
|
|
634
|
+
| 'MORE_RESULTS_AFTER_CURSOR'
|
|
635
|
+
| 'NO_MORE_RESULTS';
|
|
553
636
|
/** Read timestamp this batch was returned from. This applies to the range of results from the query's `start_cursor` (or the beginning of the query if no cursor was given) to this batch's `end_cursor` (not the query's `end_cursor`). In a single transaction, subsequent query result batches for the same query can have a greater timestamp. Each batch's read timestamp is valid for all preceding batches. This value will not be set for eventually consistent queries in Cloud Datastore. */
|
|
554
637
|
readTime?: string;
|
|
555
638
|
/** A cursor that points to the position after the last skipped result. Will be set when `skipped_results` != 0. */
|
|
@@ -567,7 +650,7 @@ declare namespace gapi.client {
|
|
|
567
650
|
/** Options for beginning a new transaction for this request. The new transaction identifier will be returned in the corresponding response as either LookupResponse.transaction or RunQueryResponse.transaction. */
|
|
568
651
|
newTransaction?: TransactionOptions;
|
|
569
652
|
/** The non-transactional read consistency to use. */
|
|
570
|
-
readConsistency?:
|
|
653
|
+
readConsistency?: 'READ_CONSISTENCY_UNSPECIFIED' | 'STRONG' | 'EVENTUAL';
|
|
571
654
|
/** Reads entities as they were at the given time. This value is only supported for Cloud Firestore in Datastore mode. This must be a microsecond precision timestamp within the past one hour, or if Point-in-Time Recovery is enabled, can additionally be a whole minute timestamp within the past 7 days. */
|
|
572
655
|
readTime?: string;
|
|
573
656
|
/** The identifier of the transaction in which to read. A transaction identifier is returned by a call to Datastore.BeginTransaction. */
|
|
@@ -645,7 +728,7 @@ declare namespace gapi.client {
|
|
|
645
728
|
/** The status code, which should be an enum value of google.rpc.Code. */
|
|
646
729
|
code?: number;
|
|
647
730
|
/** A list of messages that carry the error details. There is a common set of message types for APIs to use. */
|
|
648
|
-
details?:
|
|
731
|
+
details?: {[P in string]: any}[];
|
|
649
732
|
/** A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. */
|
|
650
733
|
message?: string;
|
|
651
734
|
}
|
|
@@ -681,7 +764,7 @@ declare namespace gapi.client {
|
|
|
681
764
|
/** The `meaning` field should only be populated for backwards compatibility. */
|
|
682
765
|
meaning?: number;
|
|
683
766
|
/** A null value. */
|
|
684
|
-
nullValue?:
|
|
767
|
+
nullValue?: 'NULL_VALUE';
|
|
685
768
|
/** A UTF-8 encoded string value. When `exclude_from_indexes` is false (it is indexed) , may have at most 1500 bytes. Otherwise, may be set to at most 1,000,000 bytes. */
|
|
686
769
|
stringValue?: string;
|
|
687
770
|
/** A timestamp value. When stored in the Datastore, precise only to microseconds; any additional precision is rounded down. */
|
|
@@ -691,11 +774,11 @@ declare namespace gapi.client {
|
|
|
691
774
|
/** Creates the specified index. A newly created index's initial state is `CREATING`. On completion of the returned google.longrunning.Operation, the state will be `READY`. If the index already exists, the call will return an `ALREADY_EXISTS` status. During index creation, the process could result in an error, in which case the index will move to the `ERROR` state. The process can be recovered by fixing the data that caused the error, removing the index with delete, then re-creating the index with create. Indexes with a single property cannot be created. */
|
|
692
775
|
create(request: {
|
|
693
776
|
/** V1 error format. */
|
|
694
|
-
'$.xgafv'?:
|
|
777
|
+
'$.xgafv'?: '1' | '2';
|
|
695
778
|
/** OAuth access token. */
|
|
696
779
|
access_token?: string;
|
|
697
780
|
/** Data format for response. */
|
|
698
|
-
alt?:
|
|
781
|
+
alt?: 'json' | 'media' | 'proto';
|
|
699
782
|
/** JSONP */
|
|
700
783
|
callback?: string;
|
|
701
784
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -720,11 +803,11 @@ declare namespace gapi.client {
|
|
|
720
803
|
create(
|
|
721
804
|
request: {
|
|
722
805
|
/** V1 error format. */
|
|
723
|
-
'$.xgafv'?:
|
|
806
|
+
'$.xgafv'?: '1' | '2';
|
|
724
807
|
/** OAuth access token. */
|
|
725
808
|
access_token?: string;
|
|
726
809
|
/** Data format for response. */
|
|
727
|
-
alt?:
|
|
810
|
+
alt?: 'json' | 'media' | 'proto';
|
|
728
811
|
/** JSONP */
|
|
729
812
|
callback?: string;
|
|
730
813
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -749,11 +832,11 @@ declare namespace gapi.client {
|
|
|
749
832
|
/** Deletes an existing index. An index can only be deleted if it is in a `READY` or `ERROR` state. On successful execution of the request, the index will be in a `DELETING` state. And on completion of the returned google.longrunning.Operation, the index will be removed. During index deletion, the process could result in an error, in which case the index will move to the `ERROR` state. The process can be recovered by fixing the data that caused the error, followed by calling delete again. */
|
|
750
833
|
delete(request?: {
|
|
751
834
|
/** V1 error format. */
|
|
752
|
-
'$.xgafv'?:
|
|
835
|
+
'$.xgafv'?: '1' | '2';
|
|
753
836
|
/** OAuth access token. */
|
|
754
837
|
access_token?: string;
|
|
755
838
|
/** Data format for response. */
|
|
756
|
-
alt?:
|
|
839
|
+
alt?: 'json' | 'media' | 'proto';
|
|
757
840
|
/** JSONP */
|
|
758
841
|
callback?: string;
|
|
759
842
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -778,11 +861,11 @@ declare namespace gapi.client {
|
|
|
778
861
|
/** Gets an index. */
|
|
779
862
|
get(request?: {
|
|
780
863
|
/** V1 error format. */
|
|
781
|
-
'$.xgafv'?:
|
|
864
|
+
'$.xgafv'?: '1' | '2';
|
|
782
865
|
/** OAuth access token. */
|
|
783
866
|
access_token?: string;
|
|
784
867
|
/** Data format for response. */
|
|
785
|
-
alt?:
|
|
868
|
+
alt?: 'json' | 'media' | 'proto';
|
|
786
869
|
/** JSONP */
|
|
787
870
|
callback?: string;
|
|
788
871
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -807,11 +890,11 @@ declare namespace gapi.client {
|
|
|
807
890
|
/** Lists the indexes that match the specified filters. Datastore uses an eventually consistent query to fetch the list of indexes and may occasionally return stale results. */
|
|
808
891
|
list(request?: {
|
|
809
892
|
/** V1 error format. */
|
|
810
|
-
'$.xgafv'?:
|
|
893
|
+
'$.xgafv'?: '1' | '2';
|
|
811
894
|
/** OAuth access token. */
|
|
812
895
|
access_token?: string;
|
|
813
896
|
/** Data format for response. */
|
|
814
|
-
alt?:
|
|
897
|
+
alt?: 'json' | 'media' | 'proto';
|
|
815
898
|
/** JSONP */
|
|
816
899
|
callback?: string;
|
|
817
900
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -841,11 +924,11 @@ declare namespace gapi.client {
|
|
|
841
924
|
/** Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`. */
|
|
842
925
|
cancel(request?: {
|
|
843
926
|
/** V1 error format. */
|
|
844
|
-
'$.xgafv'?:
|
|
927
|
+
'$.xgafv'?: '1' | '2';
|
|
845
928
|
/** OAuth access token. */
|
|
846
929
|
access_token?: string;
|
|
847
930
|
/** Data format for response. */
|
|
848
|
-
alt?:
|
|
931
|
+
alt?: 'json' | 'media' | 'proto';
|
|
849
932
|
/** JSONP */
|
|
850
933
|
callback?: string;
|
|
851
934
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -868,11 +951,11 @@ declare namespace gapi.client {
|
|
|
868
951
|
/** Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. */
|
|
869
952
|
delete(request?: {
|
|
870
953
|
/** V1 error format. */
|
|
871
|
-
'$.xgafv'?:
|
|
954
|
+
'$.xgafv'?: '1' | '2';
|
|
872
955
|
/** OAuth access token. */
|
|
873
956
|
access_token?: string;
|
|
874
957
|
/** Data format for response. */
|
|
875
|
-
alt?:
|
|
958
|
+
alt?: 'json' | 'media' | 'proto';
|
|
876
959
|
/** JSONP */
|
|
877
960
|
callback?: string;
|
|
878
961
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -895,11 +978,11 @@ declare namespace gapi.client {
|
|
|
895
978
|
/** Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. */
|
|
896
979
|
get(request?: {
|
|
897
980
|
/** V1 error format. */
|
|
898
|
-
'$.xgafv'?:
|
|
981
|
+
'$.xgafv'?: '1' | '2';
|
|
899
982
|
/** OAuth access token. */
|
|
900
983
|
access_token?: string;
|
|
901
984
|
/** Data format for response. */
|
|
902
|
-
alt?:
|
|
985
|
+
alt?: 'json' | 'media' | 'proto';
|
|
903
986
|
/** JSONP */
|
|
904
987
|
callback?: string;
|
|
905
988
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -922,11 +1005,11 @@ declare namespace gapi.client {
|
|
|
922
1005
|
/** Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. */
|
|
923
1006
|
list(request?: {
|
|
924
1007
|
/** V1 error format. */
|
|
925
|
-
'$.xgafv'?:
|
|
1008
|
+
'$.xgafv'?: '1' | '2';
|
|
926
1009
|
/** OAuth access token. */
|
|
927
1010
|
access_token?: string;
|
|
928
1011
|
/** Data format for response. */
|
|
929
|
-
alt?:
|
|
1012
|
+
alt?: 'json' | 'media' | 'proto';
|
|
930
1013
|
/** JSONP */
|
|
931
1014
|
callback?: string;
|
|
932
1015
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -959,11 +1042,11 @@ declare namespace gapi.client {
|
|
|
959
1042
|
/** Allocates IDs for the given keys, which is useful for referencing an entity before it is inserted. */
|
|
960
1043
|
allocateIds(request: {
|
|
961
1044
|
/** V1 error format. */
|
|
962
|
-
'$.xgafv'?:
|
|
1045
|
+
'$.xgafv'?: '1' | '2';
|
|
963
1046
|
/** OAuth access token. */
|
|
964
1047
|
access_token?: string;
|
|
965
1048
|
/** Data format for response. */
|
|
966
|
-
alt?:
|
|
1049
|
+
alt?: 'json' | 'media' | 'proto';
|
|
967
1050
|
/** JSONP */
|
|
968
1051
|
callback?: string;
|
|
969
1052
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -988,11 +1071,11 @@ declare namespace gapi.client {
|
|
|
988
1071
|
allocateIds(
|
|
989
1072
|
request: {
|
|
990
1073
|
/** V1 error format. */
|
|
991
|
-
'$.xgafv'?:
|
|
1074
|
+
'$.xgafv'?: '1' | '2';
|
|
992
1075
|
/** OAuth access token. */
|
|
993
1076
|
access_token?: string;
|
|
994
1077
|
/** Data format for response. */
|
|
995
|
-
alt?:
|
|
1078
|
+
alt?: 'json' | 'media' | 'proto';
|
|
996
1079
|
/** JSONP */
|
|
997
1080
|
callback?: string;
|
|
998
1081
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -1017,11 +1100,11 @@ declare namespace gapi.client {
|
|
|
1017
1100
|
/** Begins a new transaction. */
|
|
1018
1101
|
beginTransaction(request: {
|
|
1019
1102
|
/** V1 error format. */
|
|
1020
|
-
'$.xgafv'?:
|
|
1103
|
+
'$.xgafv'?: '1' | '2';
|
|
1021
1104
|
/** OAuth access token. */
|
|
1022
1105
|
access_token?: string;
|
|
1023
1106
|
/** Data format for response. */
|
|
1024
|
-
alt?:
|
|
1107
|
+
alt?: 'json' | 'media' | 'proto';
|
|
1025
1108
|
/** JSONP */
|
|
1026
1109
|
callback?: string;
|
|
1027
1110
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -1046,11 +1129,11 @@ declare namespace gapi.client {
|
|
|
1046
1129
|
beginTransaction(
|
|
1047
1130
|
request: {
|
|
1048
1131
|
/** V1 error format. */
|
|
1049
|
-
'$.xgafv'?:
|
|
1132
|
+
'$.xgafv'?: '1' | '2';
|
|
1050
1133
|
/** OAuth access token. */
|
|
1051
1134
|
access_token?: string;
|
|
1052
1135
|
/** Data format for response. */
|
|
1053
|
-
alt?:
|
|
1136
|
+
alt?: 'json' | 'media' | 'proto';
|
|
1054
1137
|
/** JSONP */
|
|
1055
1138
|
callback?: string;
|
|
1056
1139
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -1075,11 +1158,11 @@ declare namespace gapi.client {
|
|
|
1075
1158
|
/** Commits a transaction, optionally creating, deleting or modifying some entities. */
|
|
1076
1159
|
commit(request: {
|
|
1077
1160
|
/** V1 error format. */
|
|
1078
|
-
'$.xgafv'?:
|
|
1161
|
+
'$.xgafv'?: '1' | '2';
|
|
1079
1162
|
/** OAuth access token. */
|
|
1080
1163
|
access_token?: string;
|
|
1081
1164
|
/** Data format for response. */
|
|
1082
|
-
alt?:
|
|
1165
|
+
alt?: 'json' | 'media' | 'proto';
|
|
1083
1166
|
/** JSONP */
|
|
1084
1167
|
callback?: string;
|
|
1085
1168
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -1104,11 +1187,11 @@ declare namespace gapi.client {
|
|
|
1104
1187
|
commit(
|
|
1105
1188
|
request: {
|
|
1106
1189
|
/** V1 error format. */
|
|
1107
|
-
'$.xgafv'?:
|
|
1190
|
+
'$.xgafv'?: '1' | '2';
|
|
1108
1191
|
/** OAuth access token. */
|
|
1109
1192
|
access_token?: string;
|
|
1110
1193
|
/** Data format for response. */
|
|
1111
|
-
alt?:
|
|
1194
|
+
alt?: 'json' | 'media' | 'proto';
|
|
1112
1195
|
/** JSONP */
|
|
1113
1196
|
callback?: string;
|
|
1114
1197
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -1133,11 +1216,11 @@ declare namespace gapi.client {
|
|
|
1133
1216
|
/** Exports a copy of all or a subset of entities from Google Cloud Datastore to another storage system, such as Google Cloud Storage. Recent updates to entities may not be reflected in the export. The export occurs in the background and its progress can be monitored and managed via the Operation resource that is created. The output of an export may only be used once the associated operation is done. If an export operation is cancelled before completion it may leave partial data behind in Google Cloud Storage. */
|
|
1134
1217
|
export(request: {
|
|
1135
1218
|
/** V1 error format. */
|
|
1136
|
-
'$.xgafv'?:
|
|
1219
|
+
'$.xgafv'?: '1' | '2';
|
|
1137
1220
|
/** OAuth access token. */
|
|
1138
1221
|
access_token?: string;
|
|
1139
1222
|
/** Data format for response. */
|
|
1140
|
-
alt?:
|
|
1223
|
+
alt?: 'json' | 'media' | 'proto';
|
|
1141
1224
|
/** JSONP */
|
|
1142
1225
|
callback?: string;
|
|
1143
1226
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -1162,11 +1245,11 @@ declare namespace gapi.client {
|
|
|
1162
1245
|
export(
|
|
1163
1246
|
request: {
|
|
1164
1247
|
/** V1 error format. */
|
|
1165
|
-
'$.xgafv'?:
|
|
1248
|
+
'$.xgafv'?: '1' | '2';
|
|
1166
1249
|
/** OAuth access token. */
|
|
1167
1250
|
access_token?: string;
|
|
1168
1251
|
/** Data format for response. */
|
|
1169
|
-
alt?:
|
|
1252
|
+
alt?: 'json' | 'media' | 'proto';
|
|
1170
1253
|
/** JSONP */
|
|
1171
1254
|
callback?: string;
|
|
1172
1255
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -1191,11 +1274,11 @@ declare namespace gapi.client {
|
|
|
1191
1274
|
/** Imports entities into Google Cloud Datastore. Existing entities with the same key are overwritten. The import occurs in the background and its progress can be monitored and managed via the Operation resource that is created. If an ImportEntities operation is cancelled, it is possible that a subset of the data has already been imported to Cloud Datastore. */
|
|
1192
1275
|
import(request: {
|
|
1193
1276
|
/** V1 error format. */
|
|
1194
|
-
'$.xgafv'?:
|
|
1277
|
+
'$.xgafv'?: '1' | '2';
|
|
1195
1278
|
/** OAuth access token. */
|
|
1196
1279
|
access_token?: string;
|
|
1197
1280
|
/** Data format for response. */
|
|
1198
|
-
alt?:
|
|
1281
|
+
alt?: 'json' | 'media' | 'proto';
|
|
1199
1282
|
/** JSONP */
|
|
1200
1283
|
callback?: string;
|
|
1201
1284
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -1220,11 +1303,11 @@ declare namespace gapi.client {
|
|
|
1220
1303
|
import(
|
|
1221
1304
|
request: {
|
|
1222
1305
|
/** V1 error format. */
|
|
1223
|
-
'$.xgafv'?:
|
|
1306
|
+
'$.xgafv'?: '1' | '2';
|
|
1224
1307
|
/** OAuth access token. */
|
|
1225
1308
|
access_token?: string;
|
|
1226
1309
|
/** Data format for response. */
|
|
1227
|
-
alt?:
|
|
1310
|
+
alt?: 'json' | 'media' | 'proto';
|
|
1228
1311
|
/** JSONP */
|
|
1229
1312
|
callback?: string;
|
|
1230
1313
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -1249,11 +1332,11 @@ declare namespace gapi.client {
|
|
|
1249
1332
|
/** Looks up entities by key. */
|
|
1250
1333
|
lookup(request: {
|
|
1251
1334
|
/** V1 error format. */
|
|
1252
|
-
'$.xgafv'?:
|
|
1335
|
+
'$.xgafv'?: '1' | '2';
|
|
1253
1336
|
/** OAuth access token. */
|
|
1254
1337
|
access_token?: string;
|
|
1255
1338
|
/** Data format for response. */
|
|
1256
|
-
alt?:
|
|
1339
|
+
alt?: 'json' | 'media' | 'proto';
|
|
1257
1340
|
/** JSONP */
|
|
1258
1341
|
callback?: string;
|
|
1259
1342
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -1278,11 +1361,11 @@ declare namespace gapi.client {
|
|
|
1278
1361
|
lookup(
|
|
1279
1362
|
request: {
|
|
1280
1363
|
/** V1 error format. */
|
|
1281
|
-
'$.xgafv'?:
|
|
1364
|
+
'$.xgafv'?: '1' | '2';
|
|
1282
1365
|
/** OAuth access token. */
|
|
1283
1366
|
access_token?: string;
|
|
1284
1367
|
/** Data format for response. */
|
|
1285
|
-
alt?:
|
|
1368
|
+
alt?: 'json' | 'media' | 'proto';
|
|
1286
1369
|
/** JSONP */
|
|
1287
1370
|
callback?: string;
|
|
1288
1371
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -1307,11 +1390,11 @@ declare namespace gapi.client {
|
|
|
1307
1390
|
/** Prevents the supplied keys' IDs from being auto-allocated by Cloud Datastore. */
|
|
1308
1391
|
reserveIds(request: {
|
|
1309
1392
|
/** V1 error format. */
|
|
1310
|
-
'$.xgafv'?:
|
|
1393
|
+
'$.xgafv'?: '1' | '2';
|
|
1311
1394
|
/** OAuth access token. */
|
|
1312
1395
|
access_token?: string;
|
|
1313
1396
|
/** Data format for response. */
|
|
1314
|
-
alt?:
|
|
1397
|
+
alt?: 'json' | 'media' | 'proto';
|
|
1315
1398
|
/** JSONP */
|
|
1316
1399
|
callback?: string;
|
|
1317
1400
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -1336,11 +1419,11 @@ declare namespace gapi.client {
|
|
|
1336
1419
|
reserveIds(
|
|
1337
1420
|
request: {
|
|
1338
1421
|
/** V1 error format. */
|
|
1339
|
-
'$.xgafv'?:
|
|
1422
|
+
'$.xgafv'?: '1' | '2';
|
|
1340
1423
|
/** OAuth access token. */
|
|
1341
1424
|
access_token?: string;
|
|
1342
1425
|
/** Data format for response. */
|
|
1343
|
-
alt?:
|
|
1426
|
+
alt?: 'json' | 'media' | 'proto';
|
|
1344
1427
|
/** JSONP */
|
|
1345
1428
|
callback?: string;
|
|
1346
1429
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -1365,11 +1448,11 @@ declare namespace gapi.client {
|
|
|
1365
1448
|
/** Rolls back a transaction. */
|
|
1366
1449
|
rollback(request: {
|
|
1367
1450
|
/** V1 error format. */
|
|
1368
|
-
'$.xgafv'?:
|
|
1451
|
+
'$.xgafv'?: '1' | '2';
|
|
1369
1452
|
/** OAuth access token. */
|
|
1370
1453
|
access_token?: string;
|
|
1371
1454
|
/** Data format for response. */
|
|
1372
|
-
alt?:
|
|
1455
|
+
alt?: 'json' | 'media' | 'proto';
|
|
1373
1456
|
/** JSONP */
|
|
1374
1457
|
callback?: string;
|
|
1375
1458
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -1394,11 +1477,11 @@ declare namespace gapi.client {
|
|
|
1394
1477
|
rollback(
|
|
1395
1478
|
request: {
|
|
1396
1479
|
/** V1 error format. */
|
|
1397
|
-
'$.xgafv'?:
|
|
1480
|
+
'$.xgafv'?: '1' | '2';
|
|
1398
1481
|
/** OAuth access token. */
|
|
1399
1482
|
access_token?: string;
|
|
1400
1483
|
/** Data format for response. */
|
|
1401
|
-
alt?:
|
|
1484
|
+
alt?: 'json' | 'media' | 'proto';
|
|
1402
1485
|
/** JSONP */
|
|
1403
1486
|
callback?: string;
|
|
1404
1487
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -1423,11 +1506,11 @@ declare namespace gapi.client {
|
|
|
1423
1506
|
/** Runs an aggregation query. */
|
|
1424
1507
|
runAggregationQuery(request: {
|
|
1425
1508
|
/** V1 error format. */
|
|
1426
|
-
'$.xgafv'?:
|
|
1509
|
+
'$.xgafv'?: '1' | '2';
|
|
1427
1510
|
/** OAuth access token. */
|
|
1428
1511
|
access_token?: string;
|
|
1429
1512
|
/** Data format for response. */
|
|
1430
|
-
alt?:
|
|
1513
|
+
alt?: 'json' | 'media' | 'proto';
|
|
1431
1514
|
/** JSONP */
|
|
1432
1515
|
callback?: string;
|
|
1433
1516
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -1452,11 +1535,11 @@ declare namespace gapi.client {
|
|
|
1452
1535
|
runAggregationQuery(
|
|
1453
1536
|
request: {
|
|
1454
1537
|
/** V1 error format. */
|
|
1455
|
-
'$.xgafv'?:
|
|
1538
|
+
'$.xgafv'?: '1' | '2';
|
|
1456
1539
|
/** OAuth access token. */
|
|
1457
1540
|
access_token?: string;
|
|
1458
1541
|
/** Data format for response. */
|
|
1459
|
-
alt?:
|
|
1542
|
+
alt?: 'json' | 'media' | 'proto';
|
|
1460
1543
|
/** JSONP */
|
|
1461
1544
|
callback?: string;
|
|
1462
1545
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -1481,11 +1564,11 @@ declare namespace gapi.client {
|
|
|
1481
1564
|
/** Queries for entities. */
|
|
1482
1565
|
runQuery(request: {
|
|
1483
1566
|
/** V1 error format. */
|
|
1484
|
-
'$.xgafv'?:
|
|
1567
|
+
'$.xgafv'?: '1' | '2';
|
|
1485
1568
|
/** OAuth access token. */
|
|
1486
1569
|
access_token?: string;
|
|
1487
1570
|
/** Data format for response. */
|
|
1488
|
-
alt?:
|
|
1571
|
+
alt?: 'json' | 'media' | 'proto';
|
|
1489
1572
|
/** JSONP */
|
|
1490
1573
|
callback?: string;
|
|
1491
1574
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -1510,11 +1593,11 @@ declare namespace gapi.client {
|
|
|
1510
1593
|
runQuery(
|
|
1511
1594
|
request: {
|
|
1512
1595
|
/** V1 error format. */
|
|
1513
|
-
'$.xgafv'?:
|
|
1596
|
+
'$.xgafv'?: '1' | '2';
|
|
1514
1597
|
/** OAuth access token. */
|
|
1515
1598
|
access_token?: string;
|
|
1516
1599
|
/** Data format for response. */
|
|
1517
|
-
alt?:
|
|
1600
|
+
alt?: 'json' | 'media' | 'proto';
|
|
1518
1601
|
/** JSONP */
|
|
1519
1602
|
callback?: string;
|
|
1520
1603
|
/** Selector specifying which fields to include in a partial response. */
|
package/package.json
CHANGED
package/readme.md
CHANGED
|
@@ -11,6 +11,18 @@ Install typings for Cloud Datastore API:
|
|
|
11
11
|
npm install @types/gapi.client.datastore-v1 --save-dev
|
|
12
12
|
```
|
|
13
13
|
|
|
14
|
+
## TypeScript 6.0+
|
|
15
|
+
|
|
16
|
+
TypeScript 6.0 changed `types` to default to `[]`. You must now explicitly list type packages in `tsconfig.json`:
|
|
17
|
+
|
|
18
|
+
```json
|
|
19
|
+
{
|
|
20
|
+
"compilerOptions": {
|
|
21
|
+
"types": ["gapi", "gapi.auth2", "gapi.client", "gapi.client.datastore-v1"]
|
|
22
|
+
}
|
|
23
|
+
}
|
|
24
|
+
```
|
|
25
|
+
|
|
14
26
|
## Usage
|
|
15
27
|
|
|
16
28
|
You need to initialize Google API client in your code:
|