@maxim_mazurok/gapi.client.analyticshub-v1 0.0.20230722 → 0.0.20230804
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 +628 -4
- package/package.json +2 -2
- package/tests.ts +63 -1
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://analyticshub.googleapis.com/$discovery/rest?version=v1
|
|
12
|
-
// Revision:
|
|
12
|
+
// Revision: 20230804
|
|
13
13
|
|
|
14
14
|
/// <reference types="gapi.client" />
|
|
15
15
|
|
|
@@ -107,6 +107,9 @@ declare namespace gapi.client {
|
|
|
107
107
|
/** Optional. Email or URL of the primary point of contact of the data exchange. Max Length: 1000 bytes. */
|
|
108
108
|
primaryContact?:
|
|
109
109
|
string;
|
|
110
|
+
/** Required. Configurable data sharing environment option for a data exchange. */
|
|
111
|
+
sharingEnvironmentConfig?:
|
|
112
|
+
SharingEnvironmentConfig;
|
|
110
113
|
}
|
|
111
114
|
interface DataProvider {
|
|
112
115
|
/** Optional. Name of the data provider. */
|
|
@@ -116,6 +119,12 @@ declare namespace gapi.client {
|
|
|
116
119
|
primaryContact?:
|
|
117
120
|
string;
|
|
118
121
|
}
|
|
122
|
+
// tslint:disable-next-line:no-empty-interface
|
|
123
|
+
interface DcrExchangeConfig {
|
|
124
|
+
}
|
|
125
|
+
// tslint:disable-next-line:no-empty-interface
|
|
126
|
+
interface DefaultExchangeConfig {
|
|
127
|
+
}
|
|
119
128
|
interface DestinationDataset {
|
|
120
129
|
/** Required. A reference that identifies the destination dataset. */
|
|
121
130
|
datasetReference?:
|
|
@@ -180,6 +189,11 @@ declare namespace gapi.client {
|
|
|
180
189
|
requestedPolicyVersion?:
|
|
181
190
|
number;
|
|
182
191
|
}
|
|
192
|
+
interface LinkedResource {
|
|
193
|
+
/** Output only. Name of the linked dataset, e.g. projects/subscriberproject/datasets/linked_dataset */
|
|
194
|
+
linkedDataset?:
|
|
195
|
+
string;
|
|
196
|
+
}
|
|
183
197
|
interface ListDataExchangesResponse {
|
|
184
198
|
/** The list of data exchanges. */
|
|
185
199
|
dataExchanges?:
|
|
@@ -254,6 +268,49 @@ declare namespace gapi.client {
|
|
|
254
268
|
nextPageToken?:
|
|
255
269
|
string;
|
|
256
270
|
}
|
|
271
|
+
interface ListSharedResourceSubscriptionsResponse {
|
|
272
|
+
/** Next page token. */
|
|
273
|
+
nextPageToken?:
|
|
274
|
+
string;
|
|
275
|
+
/** The list of subscriptions. */
|
|
276
|
+
sharedResourceSubscriptions?:
|
|
277
|
+
Subscription[];
|
|
278
|
+
}
|
|
279
|
+
interface ListSubscriptionsResponse {
|
|
280
|
+
/** Next page token. */
|
|
281
|
+
nextPageToken?:
|
|
282
|
+
string;
|
|
283
|
+
/** The list of subscriptions. */
|
|
284
|
+
subscriptions?:
|
|
285
|
+
Subscription[];
|
|
286
|
+
}
|
|
287
|
+
interface Operation {
|
|
288
|
+
/** If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. */
|
|
289
|
+
done?:
|
|
290
|
+
boolean;
|
|
291
|
+
/** The error result of the operation in case of failure or cancellation. */
|
|
292
|
+
error?:
|
|
293
|
+
Status;
|
|
294
|
+
/**
|
|
295
|
+
* Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such
|
|
296
|
+
* metadata. Any method that returns a long-running operation should document the metadata type, if any.
|
|
297
|
+
*/
|
|
298
|
+
metadata?:
|
|
299
|
+
{ [P in string]: any };
|
|
300
|
+
/**
|
|
301
|
+
* The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending
|
|
302
|
+
* with `operations/{unique_id}`.
|
|
303
|
+
*/
|
|
304
|
+
name?:
|
|
305
|
+
string;
|
|
306
|
+
/**
|
|
307
|
+
* The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original
|
|
308
|
+
* method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original
|
|
309
|
+
* method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
|
|
310
|
+
*/
|
|
311
|
+
response?:
|
|
312
|
+
{ [P in string]: any };
|
|
313
|
+
}
|
|
257
314
|
interface OperationMetadata {
|
|
258
315
|
/** Output only. API version used to start the operation. */
|
|
259
316
|
apiVersion?:
|
|
@@ -320,6 +377,14 @@ declare namespace gapi.client {
|
|
|
320
377
|
primaryContact?:
|
|
321
378
|
string;
|
|
322
379
|
}
|
|
380
|
+
// tslint:disable-next-line:no-empty-interface
|
|
381
|
+
interface RefreshSubscriptionRequest {
|
|
382
|
+
}
|
|
383
|
+
interface RefreshSubscriptionResponse {
|
|
384
|
+
/** The refreshed subscription resource. */
|
|
385
|
+
subscription?:
|
|
386
|
+
Subscription;
|
|
387
|
+
}
|
|
323
388
|
interface RestrictedExportConfig {
|
|
324
389
|
/** Optional. If true, enable restricted export. */
|
|
325
390
|
enabled?:
|
|
@@ -331,6 +396,12 @@ declare namespace gapi.client {
|
|
|
331
396
|
restrictQueryResult?:
|
|
332
397
|
boolean;
|
|
333
398
|
}
|
|
399
|
+
// tslint:disable-next-line:no-empty-interface
|
|
400
|
+
interface RevokeSubscriptionRequest {
|
|
401
|
+
}
|
|
402
|
+
// tslint:disable-next-line:no-empty-interface
|
|
403
|
+
interface RevokeSubscriptionResponse {
|
|
404
|
+
}
|
|
334
405
|
interface SetIamPolicyRequest {
|
|
335
406
|
/**
|
|
336
407
|
* REQUIRED: The complete policy to be applied to the `resource`. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Google Cloud
|
|
@@ -345,13 +416,88 @@ declare namespace gapi.client {
|
|
|
345
416
|
updateMask?:
|
|
346
417
|
string;
|
|
347
418
|
}
|
|
419
|
+
interface SharingEnvironmentConfig {
|
|
420
|
+
/** Data Clean Room (DCR), used for privacy-safe and secured data sharing. */
|
|
421
|
+
dcrExchangeConfig?:
|
|
422
|
+
any;
|
|
423
|
+
/** Default Analytics Hub data exchange, used for secured data sharing. */
|
|
424
|
+
defaultExchangeConfig?:
|
|
425
|
+
any;
|
|
426
|
+
}
|
|
427
|
+
interface Status {
|
|
428
|
+
/** The status code, which should be an enum value of google.rpc.Code. */
|
|
429
|
+
code?:
|
|
430
|
+
number;
|
|
431
|
+
/** A list of messages that carry the error details. There is a common set of message types for APIs to use. */
|
|
432
|
+
details?:
|
|
433
|
+
Array<{ [P in string]: any }>;
|
|
434
|
+
/**
|
|
435
|
+
* 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
|
|
436
|
+
* client.
|
|
437
|
+
*/
|
|
438
|
+
message?:
|
|
439
|
+
string;
|
|
440
|
+
}
|
|
441
|
+
interface SubscribeDataExchangeRequest {
|
|
442
|
+
/** Required. The parent resource path of the Subscription. e.g. `projects/subscriberproject/locations/US` */
|
|
443
|
+
destination?:
|
|
444
|
+
string;
|
|
445
|
+
/** Email of the subscriber. */
|
|
446
|
+
subscriberContact?:
|
|
447
|
+
string;
|
|
448
|
+
/** Required. Name of the subscription to create. e.g. `subscription1` */
|
|
449
|
+
subscription?:
|
|
450
|
+
string;
|
|
451
|
+
}
|
|
452
|
+
interface SubscribeDataExchangeResponse {
|
|
453
|
+
/** Subscription object created from this subscribe action. */
|
|
454
|
+
subscription?:
|
|
455
|
+
Subscription;
|
|
456
|
+
}
|
|
348
457
|
interface SubscribeListingRequest {
|
|
349
458
|
/** BigQuery destination dataset to create for the subscriber. */
|
|
350
459
|
destinationDataset?:
|
|
351
460
|
DestinationDataset;
|
|
352
461
|
}
|
|
353
|
-
// tslint:disable-next-line:no-empty-interface
|
|
354
462
|
interface SubscribeListingResponse {
|
|
463
|
+
/** Subscription object created from this subscribe action. */
|
|
464
|
+
subscription?:
|
|
465
|
+
Subscription;
|
|
466
|
+
}
|
|
467
|
+
interface Subscription {
|
|
468
|
+
/** Output only. Timestamp when the subscription was created. */
|
|
469
|
+
creationTime?:
|
|
470
|
+
string;
|
|
471
|
+
/** Output only. Resource name of the source Data Exchange. e.g. projects/123/locations/US/dataExchanges/456 */
|
|
472
|
+
dataExchange?:
|
|
473
|
+
string;
|
|
474
|
+
/** Output only. Timestamp when the subscription was last modified. */
|
|
475
|
+
lastModifyTime?:
|
|
476
|
+
string;
|
|
477
|
+
/**
|
|
478
|
+
* Output only. Map of listing resource names to associated linked resource, e.g. projects/123/locations/US/dataExchanges/456/listings/789 -> projects/123/datasets/my_dataset For
|
|
479
|
+
* listing-level subscriptions, this is a map of size 1. Only contains values if state == STATE_ACTIVE.
|
|
480
|
+
*/
|
|
481
|
+
linkedDatasetMap?:
|
|
482
|
+
{ [P in string]: LinkedResource };
|
|
483
|
+
/** Output only. Resource name of the source Listing. e.g. projects/123/locations/US/dataExchanges/456/listings/789 */
|
|
484
|
+
listing?:
|
|
485
|
+
string;
|
|
486
|
+
/** Output only. The resource name of the subscription. e.g. `projects/myproject/locations/US/subscriptions/123`. */
|
|
487
|
+
name?:
|
|
488
|
+
string;
|
|
489
|
+
/** Output only. Display name of the project of this subscription. */
|
|
490
|
+
organizationDisplayName?:
|
|
491
|
+
string;
|
|
492
|
+
/** Output only. Organization of the project this subscription belongs to. */
|
|
493
|
+
organizationId?:
|
|
494
|
+
string;
|
|
495
|
+
/** Output only. Current state of the subscription. */
|
|
496
|
+
state?:
|
|
497
|
+
string;
|
|
498
|
+
/** Output only. Email of the subscriber. */
|
|
499
|
+
subscriberContact?:
|
|
500
|
+
string;
|
|
355
501
|
}
|
|
356
502
|
interface TestIamPermissionsRequest {
|
|
357
503
|
/**
|
|
@@ -681,6 +827,57 @@ declare namespace gapi.client {
|
|
|
681
827
|
uploadType?:
|
|
682
828
|
string;
|
|
683
829
|
}): Request<ListListingsResponse>;
|
|
830
|
+
/** Lists all subscriptions on a given Data Exchange or Listing. */
|
|
831
|
+
listSubscriptions(request?: {
|
|
832
|
+
/** V1 error format. */
|
|
833
|
+
"$.xgafv"?:
|
|
834
|
+
string;
|
|
835
|
+
/** OAuth access token. */
|
|
836
|
+
access_token?:
|
|
837
|
+
string;
|
|
838
|
+
/** Data format for response. */
|
|
839
|
+
alt?:
|
|
840
|
+
string;
|
|
841
|
+
/** JSONP */
|
|
842
|
+
callback?:
|
|
843
|
+
string;
|
|
844
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
845
|
+
fields?:
|
|
846
|
+
string;
|
|
847
|
+
/** If selected, includes deleted subscriptions in the response (up to 63 days after deletion). */
|
|
848
|
+
includeDeletedSubscriptions?:
|
|
849
|
+
boolean;
|
|
850
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
851
|
+
key?:
|
|
852
|
+
string;
|
|
853
|
+
/** OAuth 2.0 token for the current user. */
|
|
854
|
+
oauth_token?:
|
|
855
|
+
string;
|
|
856
|
+
/** The maximum number of results to return in a single response page. */
|
|
857
|
+
pageSize?:
|
|
858
|
+
number;
|
|
859
|
+
/** Page token, returned by a previous call. */
|
|
860
|
+
pageToken?:
|
|
861
|
+
string;
|
|
862
|
+
/** Returns response with indentations and line breaks. */
|
|
863
|
+
prettyPrint?:
|
|
864
|
+
boolean;
|
|
865
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
866
|
+
quotaUser?:
|
|
867
|
+
string;
|
|
868
|
+
/**
|
|
869
|
+
* Required. Resource name of the requested target. This resource may be either a Listing or a DataExchange. e.g. projects/123/locations/US/dataExchanges/456 OR e.g.
|
|
870
|
+
* projects/123/locations/US/dataExchanges/456/listings/789
|
|
871
|
+
*/
|
|
872
|
+
resource:
|
|
873
|
+
string;
|
|
874
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
875
|
+
upload_protocol?:
|
|
876
|
+
string;
|
|
877
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
878
|
+
uploadType?:
|
|
879
|
+
string;
|
|
880
|
+
}): Request<ListSharedResourceSubscriptionsResponse>;
|
|
684
881
|
/** Updates an existing listing. */
|
|
685
882
|
patch(request: {
|
|
686
883
|
/** V1 error format. */
|
|
@@ -855,7 +1052,7 @@ declare namespace gapi.client {
|
|
|
855
1052
|
/** Request body */
|
|
856
1053
|
resource:
|
|
857
1054
|
SubscribeListingRequest;
|
|
858
|
-
}): Request<
|
|
1055
|
+
}): Request<SubscribeListingResponse>;
|
|
859
1056
|
subscribe(request: {
|
|
860
1057
|
/** V1 error format. */
|
|
861
1058
|
"$.xgafv"?:
|
|
@@ -894,7 +1091,7 @@ declare namespace gapi.client {
|
|
|
894
1091
|
uploadType?:
|
|
895
1092
|
string;
|
|
896
1093
|
},
|
|
897
|
-
body: SubscribeListingRequest): Request<
|
|
1094
|
+
body: SubscribeListingRequest): Request<SubscribeListingResponse>;
|
|
898
1095
|
/** Returns the permissions that a caller has. */
|
|
899
1096
|
testIamPermissions(request: {
|
|
900
1097
|
/** V1 error format. */
|
|
@@ -1199,6 +1396,57 @@ declare namespace gapi.client {
|
|
|
1199
1396
|
uploadType?:
|
|
1200
1397
|
string;
|
|
1201
1398
|
}): Request<ListDataExchangesResponse>;
|
|
1399
|
+
/** Lists all subscriptions on a given Data Exchange or Listing. */
|
|
1400
|
+
listSubscriptions(request?: {
|
|
1401
|
+
/** V1 error format. */
|
|
1402
|
+
"$.xgafv"?:
|
|
1403
|
+
string;
|
|
1404
|
+
/** OAuth access token. */
|
|
1405
|
+
access_token?:
|
|
1406
|
+
string;
|
|
1407
|
+
/** Data format for response. */
|
|
1408
|
+
alt?:
|
|
1409
|
+
string;
|
|
1410
|
+
/** JSONP */
|
|
1411
|
+
callback?:
|
|
1412
|
+
string;
|
|
1413
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
1414
|
+
fields?:
|
|
1415
|
+
string;
|
|
1416
|
+
/** If selected, includes deleted subscriptions in the response (up to 63 days after deletion). */
|
|
1417
|
+
includeDeletedSubscriptions?:
|
|
1418
|
+
boolean;
|
|
1419
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
1420
|
+
key?:
|
|
1421
|
+
string;
|
|
1422
|
+
/** OAuth 2.0 token for the current user. */
|
|
1423
|
+
oauth_token?:
|
|
1424
|
+
string;
|
|
1425
|
+
/** The maximum number of results to return in a single response page. */
|
|
1426
|
+
pageSize?:
|
|
1427
|
+
number;
|
|
1428
|
+
/** Page token, returned by a previous call. */
|
|
1429
|
+
pageToken?:
|
|
1430
|
+
string;
|
|
1431
|
+
/** Returns response with indentations and line breaks. */
|
|
1432
|
+
prettyPrint?:
|
|
1433
|
+
boolean;
|
|
1434
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
1435
|
+
quotaUser?:
|
|
1436
|
+
string;
|
|
1437
|
+
/**
|
|
1438
|
+
* Required. Resource name of the requested target. This resource may be either a Listing or a DataExchange. e.g. projects/123/locations/US/dataExchanges/456 OR e.g.
|
|
1439
|
+
* projects/123/locations/US/dataExchanges/456/listings/789
|
|
1440
|
+
*/
|
|
1441
|
+
resource:
|
|
1442
|
+
string;
|
|
1443
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
1444
|
+
upload_protocol?:
|
|
1445
|
+
string;
|
|
1446
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1447
|
+
uploadType?:
|
|
1448
|
+
string;
|
|
1449
|
+
}): Request<ListSharedResourceSubscriptionsResponse>;
|
|
1202
1450
|
/** Updates an existing data exchange. */
|
|
1203
1451
|
patch(request: {
|
|
1204
1452
|
/** V1 error format. */
|
|
@@ -1335,6 +1583,87 @@ declare namespace gapi.client {
|
|
|
1335
1583
|
string;
|
|
1336
1584
|
},
|
|
1337
1585
|
body: SetIamPolicyRequest): Request<Policy>;
|
|
1586
|
+
/** Creates a Subscription to a Data Exchange. This is a long-running operation as it will create one or more linked datasets. */
|
|
1587
|
+
subscribe(request: {
|
|
1588
|
+
/** V1 error format. */
|
|
1589
|
+
"$.xgafv"?:
|
|
1590
|
+
string;
|
|
1591
|
+
/** OAuth access token. */
|
|
1592
|
+
access_token?:
|
|
1593
|
+
string;
|
|
1594
|
+
/** Data format for response. */
|
|
1595
|
+
alt?:
|
|
1596
|
+
string;
|
|
1597
|
+
/** JSONP */
|
|
1598
|
+
callback?:
|
|
1599
|
+
string;
|
|
1600
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
1601
|
+
fields?:
|
|
1602
|
+
string;
|
|
1603
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
1604
|
+
key?:
|
|
1605
|
+
string;
|
|
1606
|
+
/** Required. Resource name of the Data Exchange. e.g. `projects/publisherproject/locations/US/dataExchanges/123` */
|
|
1607
|
+
name:
|
|
1608
|
+
string;
|
|
1609
|
+
/** OAuth 2.0 token for the current user. */
|
|
1610
|
+
oauth_token?:
|
|
1611
|
+
string;
|
|
1612
|
+
/** Returns response with indentations and line breaks. */
|
|
1613
|
+
prettyPrint?:
|
|
1614
|
+
boolean;
|
|
1615
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
1616
|
+
quotaUser?:
|
|
1617
|
+
string;
|
|
1618
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
1619
|
+
upload_protocol?:
|
|
1620
|
+
string;
|
|
1621
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1622
|
+
uploadType?:
|
|
1623
|
+
string;
|
|
1624
|
+
/** Request body */
|
|
1625
|
+
resource:
|
|
1626
|
+
SubscribeDataExchangeRequest;
|
|
1627
|
+
}): Request<Operation>;
|
|
1628
|
+
subscribe(request: {
|
|
1629
|
+
/** V1 error format. */
|
|
1630
|
+
"$.xgafv"?:
|
|
1631
|
+
string;
|
|
1632
|
+
/** OAuth access token. */
|
|
1633
|
+
access_token?:
|
|
1634
|
+
string;
|
|
1635
|
+
/** Data format for response. */
|
|
1636
|
+
alt?:
|
|
1637
|
+
string;
|
|
1638
|
+
/** JSONP */
|
|
1639
|
+
callback?:
|
|
1640
|
+
string;
|
|
1641
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
1642
|
+
fields?:
|
|
1643
|
+
string;
|
|
1644
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
1645
|
+
key?:
|
|
1646
|
+
string;
|
|
1647
|
+
/** Required. Resource name of the Data Exchange. e.g. `projects/publisherproject/locations/US/dataExchanges/123` */
|
|
1648
|
+
name:
|
|
1649
|
+
string;
|
|
1650
|
+
/** OAuth 2.0 token for the current user. */
|
|
1651
|
+
oauth_token?:
|
|
1652
|
+
string;
|
|
1653
|
+
/** Returns response with indentations and line breaks. */
|
|
1654
|
+
prettyPrint?:
|
|
1655
|
+
boolean;
|
|
1656
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
1657
|
+
quotaUser?:
|
|
1658
|
+
string;
|
|
1659
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
1660
|
+
upload_protocol?:
|
|
1661
|
+
string;
|
|
1662
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1663
|
+
uploadType?:
|
|
1664
|
+
string;
|
|
1665
|
+
},
|
|
1666
|
+
body: SubscribeDataExchangeRequest): Request<Operation>;
|
|
1338
1667
|
/** Returns the permissions that a caller has. */
|
|
1339
1668
|
testIamPermissions(request: {
|
|
1340
1669
|
/** V1 error format. */
|
|
@@ -1381,9 +1710,304 @@ declare namespace gapi.client {
|
|
|
1381
1710
|
listings:
|
|
1382
1711
|
ListingsResource;
|
|
1383
1712
|
}
|
|
1713
|
+
interface SubscriptionsResource {
|
|
1714
|
+
/** Deletes a subscription. */
|
|
1715
|
+
delete(request?: {
|
|
1716
|
+
/** V1 error format. */
|
|
1717
|
+
"$.xgafv"?:
|
|
1718
|
+
string;
|
|
1719
|
+
/** OAuth access token. */
|
|
1720
|
+
access_token?:
|
|
1721
|
+
string;
|
|
1722
|
+
/** Data format for response. */
|
|
1723
|
+
alt?:
|
|
1724
|
+
string;
|
|
1725
|
+
/** JSONP */
|
|
1726
|
+
callback?:
|
|
1727
|
+
string;
|
|
1728
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
1729
|
+
fields?:
|
|
1730
|
+
string;
|
|
1731
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
1732
|
+
key?:
|
|
1733
|
+
string;
|
|
1734
|
+
/** Required. Resource name of the subscription to delete. e.g. projects/123/locations/US/subscriptions/456 */
|
|
1735
|
+
name:
|
|
1736
|
+
string;
|
|
1737
|
+
/** OAuth 2.0 token for the current user. */
|
|
1738
|
+
oauth_token?:
|
|
1739
|
+
string;
|
|
1740
|
+
/** Returns response with indentations and line breaks. */
|
|
1741
|
+
prettyPrint?:
|
|
1742
|
+
boolean;
|
|
1743
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
1744
|
+
quotaUser?:
|
|
1745
|
+
string;
|
|
1746
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
1747
|
+
upload_protocol?:
|
|
1748
|
+
string;
|
|
1749
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1750
|
+
uploadType?:
|
|
1751
|
+
string;
|
|
1752
|
+
}): Request<Operation>;
|
|
1753
|
+
/** Gets the details of a Subscription. */
|
|
1754
|
+
get(request?: {
|
|
1755
|
+
/** V1 error format. */
|
|
1756
|
+
"$.xgafv"?:
|
|
1757
|
+
string;
|
|
1758
|
+
/** OAuth access token. */
|
|
1759
|
+
access_token?:
|
|
1760
|
+
string;
|
|
1761
|
+
/** Data format for response. */
|
|
1762
|
+
alt?:
|
|
1763
|
+
string;
|
|
1764
|
+
/** JSONP */
|
|
1765
|
+
callback?:
|
|
1766
|
+
string;
|
|
1767
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
1768
|
+
fields?:
|
|
1769
|
+
string;
|
|
1770
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
1771
|
+
key?:
|
|
1772
|
+
string;
|
|
1773
|
+
/** Required. Resource name of the subscription. e.g. projects/123/locations/US/subscriptions/456 */
|
|
1774
|
+
name:
|
|
1775
|
+
string;
|
|
1776
|
+
/** OAuth 2.0 token for the current user. */
|
|
1777
|
+
oauth_token?:
|
|
1778
|
+
string;
|
|
1779
|
+
/** Returns response with indentations and line breaks. */
|
|
1780
|
+
prettyPrint?:
|
|
1781
|
+
boolean;
|
|
1782
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
1783
|
+
quotaUser?:
|
|
1784
|
+
string;
|
|
1785
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
1786
|
+
upload_protocol?:
|
|
1787
|
+
string;
|
|
1788
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1789
|
+
uploadType?:
|
|
1790
|
+
string;
|
|
1791
|
+
}): Request<Subscription>;
|
|
1792
|
+
/** Lists all subscriptions in a given project and location. */
|
|
1793
|
+
list(request?: {
|
|
1794
|
+
/** V1 error format. */
|
|
1795
|
+
"$.xgafv"?:
|
|
1796
|
+
string;
|
|
1797
|
+
/** OAuth access token. */
|
|
1798
|
+
access_token?:
|
|
1799
|
+
string;
|
|
1800
|
+
/** Data format for response. */
|
|
1801
|
+
alt?:
|
|
1802
|
+
string;
|
|
1803
|
+
/** JSONP */
|
|
1804
|
+
callback?:
|
|
1805
|
+
string;
|
|
1806
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
1807
|
+
fields?:
|
|
1808
|
+
string;
|
|
1809
|
+
/** The filter expression may be used to filter by Data Exchange or Listing. */
|
|
1810
|
+
filter?:
|
|
1811
|
+
string;
|
|
1812
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
1813
|
+
key?:
|
|
1814
|
+
string;
|
|
1815
|
+
/** OAuth 2.0 token for the current user. */
|
|
1816
|
+
oauth_token?:
|
|
1817
|
+
string;
|
|
1818
|
+
/** The maximum number of results to return in a single response page. */
|
|
1819
|
+
pageSize?:
|
|
1820
|
+
number;
|
|
1821
|
+
/** Page token, returned by a previous call. */
|
|
1822
|
+
pageToken?:
|
|
1823
|
+
string;
|
|
1824
|
+
/** Required. The parent resource path of the subscription. e.g. projects/myproject/locations/US */
|
|
1825
|
+
parent:
|
|
1826
|
+
string;
|
|
1827
|
+
/** Returns response with indentations and line breaks. */
|
|
1828
|
+
prettyPrint?:
|
|
1829
|
+
boolean;
|
|
1830
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
1831
|
+
quotaUser?:
|
|
1832
|
+
string;
|
|
1833
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
1834
|
+
upload_protocol?:
|
|
1835
|
+
string;
|
|
1836
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1837
|
+
uploadType?:
|
|
1838
|
+
string;
|
|
1839
|
+
}): Request<ListSubscriptionsResponse>;
|
|
1840
|
+
/**
|
|
1841
|
+
* Refreshes a Subscription to a Data Exchange. A Data Exchange can become stale when a publisher adds or removes data. This is a long-running operation as it may create many linked
|
|
1842
|
+
* datasets.
|
|
1843
|
+
*/
|
|
1844
|
+
refresh(request: {
|
|
1845
|
+
/** V1 error format. */
|
|
1846
|
+
"$.xgafv"?:
|
|
1847
|
+
string;
|
|
1848
|
+
/** OAuth access token. */
|
|
1849
|
+
access_token?:
|
|
1850
|
+
string;
|
|
1851
|
+
/** Data format for response. */
|
|
1852
|
+
alt?:
|
|
1853
|
+
string;
|
|
1854
|
+
/** JSONP */
|
|
1855
|
+
callback?:
|
|
1856
|
+
string;
|
|
1857
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
1858
|
+
fields?:
|
|
1859
|
+
string;
|
|
1860
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
1861
|
+
key?:
|
|
1862
|
+
string;
|
|
1863
|
+
/** Required. Resource name of the Subscription to refresh. e.g. `projects/subscriberproject/locations/US/subscriptions/123` */
|
|
1864
|
+
name:
|
|
1865
|
+
string;
|
|
1866
|
+
/** OAuth 2.0 token for the current user. */
|
|
1867
|
+
oauth_token?:
|
|
1868
|
+
string;
|
|
1869
|
+
/** Returns response with indentations and line breaks. */
|
|
1870
|
+
prettyPrint?:
|
|
1871
|
+
boolean;
|
|
1872
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
1873
|
+
quotaUser?:
|
|
1874
|
+
string;
|
|
1875
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
1876
|
+
upload_protocol?:
|
|
1877
|
+
string;
|
|
1878
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1879
|
+
uploadType?:
|
|
1880
|
+
string;
|
|
1881
|
+
/** Request body */
|
|
1882
|
+
resource:
|
|
1883
|
+
RefreshSubscriptionRequest;
|
|
1884
|
+
}): Request<Operation>;
|
|
1885
|
+
refresh(request: {
|
|
1886
|
+
/** V1 error format. */
|
|
1887
|
+
"$.xgafv"?:
|
|
1888
|
+
string;
|
|
1889
|
+
/** OAuth access token. */
|
|
1890
|
+
access_token?:
|
|
1891
|
+
string;
|
|
1892
|
+
/** Data format for response. */
|
|
1893
|
+
alt?:
|
|
1894
|
+
string;
|
|
1895
|
+
/** JSONP */
|
|
1896
|
+
callback?:
|
|
1897
|
+
string;
|
|
1898
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
1899
|
+
fields?:
|
|
1900
|
+
string;
|
|
1901
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
1902
|
+
key?:
|
|
1903
|
+
string;
|
|
1904
|
+
/** Required. Resource name of the Subscription to refresh. e.g. `projects/subscriberproject/locations/US/subscriptions/123` */
|
|
1905
|
+
name:
|
|
1906
|
+
string;
|
|
1907
|
+
/** OAuth 2.0 token for the current user. */
|
|
1908
|
+
oauth_token?:
|
|
1909
|
+
string;
|
|
1910
|
+
/** Returns response with indentations and line breaks. */
|
|
1911
|
+
prettyPrint?:
|
|
1912
|
+
boolean;
|
|
1913
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
1914
|
+
quotaUser?:
|
|
1915
|
+
string;
|
|
1916
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
1917
|
+
upload_protocol?:
|
|
1918
|
+
string;
|
|
1919
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1920
|
+
uploadType?:
|
|
1921
|
+
string;
|
|
1922
|
+
},
|
|
1923
|
+
body: RefreshSubscriptionRequest): Request<Operation>;
|
|
1924
|
+
/** Revokes a given subscription. */
|
|
1925
|
+
revoke(request: {
|
|
1926
|
+
/** V1 error format. */
|
|
1927
|
+
"$.xgafv"?:
|
|
1928
|
+
string;
|
|
1929
|
+
/** OAuth access token. */
|
|
1930
|
+
access_token?:
|
|
1931
|
+
string;
|
|
1932
|
+
/** Data format for response. */
|
|
1933
|
+
alt?:
|
|
1934
|
+
string;
|
|
1935
|
+
/** JSONP */
|
|
1936
|
+
callback?:
|
|
1937
|
+
string;
|
|
1938
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
1939
|
+
fields?:
|
|
1940
|
+
string;
|
|
1941
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
1942
|
+
key?:
|
|
1943
|
+
string;
|
|
1944
|
+
/** Required. Resource name of the subscription to revoke. e.g. projects/123/locations/US/subscriptions/456 */
|
|
1945
|
+
name:
|
|
1946
|
+
string;
|
|
1947
|
+
/** OAuth 2.0 token for the current user. */
|
|
1948
|
+
oauth_token?:
|
|
1949
|
+
string;
|
|
1950
|
+
/** Returns response with indentations and line breaks. */
|
|
1951
|
+
prettyPrint?:
|
|
1952
|
+
boolean;
|
|
1953
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
1954
|
+
quotaUser?:
|
|
1955
|
+
string;
|
|
1956
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
1957
|
+
upload_protocol?:
|
|
1958
|
+
string;
|
|
1959
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1960
|
+
uploadType?:
|
|
1961
|
+
string;
|
|
1962
|
+
/** Request body */
|
|
1963
|
+
resource:
|
|
1964
|
+
RevokeSubscriptionRequest;
|
|
1965
|
+
}): Request<{}>;
|
|
1966
|
+
revoke(request: {
|
|
1967
|
+
/** V1 error format. */
|
|
1968
|
+
"$.xgafv"?:
|
|
1969
|
+
string;
|
|
1970
|
+
/** OAuth access token. */
|
|
1971
|
+
access_token?:
|
|
1972
|
+
string;
|
|
1973
|
+
/** Data format for response. */
|
|
1974
|
+
alt?:
|
|
1975
|
+
string;
|
|
1976
|
+
/** JSONP */
|
|
1977
|
+
callback?:
|
|
1978
|
+
string;
|
|
1979
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
1980
|
+
fields?:
|
|
1981
|
+
string;
|
|
1982
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
1983
|
+
key?:
|
|
1984
|
+
string;
|
|
1985
|
+
/** Required. Resource name of the subscription to revoke. e.g. projects/123/locations/US/subscriptions/456 */
|
|
1986
|
+
name:
|
|
1987
|
+
string;
|
|
1988
|
+
/** OAuth 2.0 token for the current user. */
|
|
1989
|
+
oauth_token?:
|
|
1990
|
+
string;
|
|
1991
|
+
/** Returns response with indentations and line breaks. */
|
|
1992
|
+
prettyPrint?:
|
|
1993
|
+
boolean;
|
|
1994
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
1995
|
+
quotaUser?:
|
|
1996
|
+
string;
|
|
1997
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
1998
|
+
upload_protocol?:
|
|
1999
|
+
string;
|
|
2000
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
2001
|
+
uploadType?:
|
|
2002
|
+
string;
|
|
2003
|
+
},
|
|
2004
|
+
body: RevokeSubscriptionRequest): Request<{}>;
|
|
2005
|
+
}
|
|
1384
2006
|
interface LocationsResource {
|
|
1385
2007
|
dataExchanges:
|
|
1386
2008
|
DataExchangesResource;
|
|
2009
|
+
subscriptions:
|
|
2010
|
+
SubscriptionsResource;
|
|
1387
2011
|
}
|
|
1388
2012
|
interface ProjectsResource {
|
|
1389
2013
|
locations:
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@maxim_mazurok/gapi.client.analyticshub-v1",
|
|
3
|
-
"version": "0.0.
|
|
3
|
+
"version": "0.0.20230804",
|
|
4
4
|
"description": "TypeScript typings for Analytics Hub API v1",
|
|
5
5
|
"license": "MIT",
|
|
6
6
|
"author": {
|
|
@@ -15,6 +15,6 @@
|
|
|
15
15
|
"types": "index.d.ts",
|
|
16
16
|
"dependencies": {
|
|
17
17
|
"@types/gapi.client": "*",
|
|
18
|
-
"@types/gapi.client.discovery": "*"
|
|
18
|
+
"@types/gapi.client.discovery-v1": "*"
|
|
19
19
|
}
|
|
20
20
|
}
|
package/tests.ts
CHANGED
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
// This file was generated by https://github.com/Maxim-Mazurok/google-api-typings-generator. Please do not edit it manually.
|
|
4
4
|
// In case of any problems please post issue to https://github.com/Maxim-Mazurok/google-api-typings-generator
|
|
5
5
|
|
|
6
|
-
// Revision:
|
|
6
|
+
// Revision: 20230804
|
|
7
7
|
|
|
8
8
|
gapi.load('client', async () => {
|
|
9
9
|
/** now we can use gapi.client */
|
|
@@ -49,6 +49,12 @@ gapi.load('client', async () => {
|
|
|
49
49
|
listingCount: 42,
|
|
50
50
|
name: "Test string",
|
|
51
51
|
primaryContact: "Test string",
|
|
52
|
+
sharingEnvironmentConfig: {
|
|
53
|
+
dcrExchangeConfig: {
|
|
54
|
+
},
|
|
55
|
+
defaultExchangeConfig: {
|
|
56
|
+
},
|
|
57
|
+
},
|
|
52
58
|
});
|
|
53
59
|
/** Deletes an existing data exchange. */
|
|
54
60
|
await gapi.client.analyticshub.projects.locations.dataExchanges.delete({
|
|
@@ -72,6 +78,13 @@ gapi.load('client', async () => {
|
|
|
72
78
|
pageToken: "Test string",
|
|
73
79
|
parent: "Test string",
|
|
74
80
|
});
|
|
81
|
+
/** Lists all subscriptions on a given Data Exchange or Listing. */
|
|
82
|
+
await gapi.client.analyticshub.projects.locations.dataExchanges.listSubscriptions({
|
|
83
|
+
includeDeletedSubscriptions: true,
|
|
84
|
+
pageSize: 42,
|
|
85
|
+
pageToken: "Test string",
|
|
86
|
+
resource: "Test string",
|
|
87
|
+
});
|
|
75
88
|
/** Updates an existing data exchange. */
|
|
76
89
|
await gapi.client.analyticshub.projects.locations.dataExchanges.patch({
|
|
77
90
|
name: "Test string",
|
|
@@ -84,6 +97,12 @@ gapi.load('client', async () => {
|
|
|
84
97
|
listingCount: 42,
|
|
85
98
|
name: "Test string",
|
|
86
99
|
primaryContact: "Test string",
|
|
100
|
+
sharingEnvironmentConfig: {
|
|
101
|
+
dcrExchangeConfig: {
|
|
102
|
+
},
|
|
103
|
+
defaultExchangeConfig: {
|
|
104
|
+
},
|
|
105
|
+
},
|
|
87
106
|
});
|
|
88
107
|
/** Sets the IAM policy. */
|
|
89
108
|
await gapi.client.analyticshub.projects.locations.dataExchanges.setIamPolicy({
|
|
@@ -122,6 +141,14 @@ gapi.load('client', async () => {
|
|
|
122
141
|
},
|
|
123
142
|
updateMask: "Test string",
|
|
124
143
|
});
|
|
144
|
+
/** Creates a Subscription to a Data Exchange. This is a long-running operation as it will create one or more linked datasets. */
|
|
145
|
+
await gapi.client.analyticshub.projects.locations.dataExchanges.subscribe({
|
|
146
|
+
name: "Test string",
|
|
147
|
+
}, {
|
|
148
|
+
destination: "Test string",
|
|
149
|
+
subscriberContact: "Test string",
|
|
150
|
+
subscription: "Test string",
|
|
151
|
+
});
|
|
125
152
|
/** Returns the permissions that a caller has. */
|
|
126
153
|
await gapi.client.analyticshub.projects.locations.dataExchanges.testIamPermissions({
|
|
127
154
|
resource: "Test string",
|
|
@@ -185,6 +212,13 @@ gapi.load('client', async () => {
|
|
|
185
212
|
pageToken: "Test string",
|
|
186
213
|
parent: "Test string",
|
|
187
214
|
});
|
|
215
|
+
/** Lists all subscriptions on a given Data Exchange or Listing. */
|
|
216
|
+
await gapi.client.analyticshub.projects.locations.dataExchanges.listings.listSubscriptions({
|
|
217
|
+
includeDeletedSubscriptions: true,
|
|
218
|
+
pageSize: 42,
|
|
219
|
+
pageToken: "Test string",
|
|
220
|
+
resource: "Test string",
|
|
221
|
+
});
|
|
188
222
|
/** Updates an existing listing. */
|
|
189
223
|
await gapi.client.analyticshub.projects.locations.dataExchanges.listings.patch({
|
|
190
224
|
name: "Test string",
|
|
@@ -283,5 +317,33 @@ gapi.load('client', async () => {
|
|
|
283
317
|
"Test string"
|
|
284
318
|
],
|
|
285
319
|
});
|
|
320
|
+
/** Deletes a subscription. */
|
|
321
|
+
await gapi.client.analyticshub.projects.locations.subscriptions.delete({
|
|
322
|
+
name: "Test string",
|
|
323
|
+
});
|
|
324
|
+
/** Gets the details of a Subscription. */
|
|
325
|
+
await gapi.client.analyticshub.projects.locations.subscriptions.get({
|
|
326
|
+
name: "Test string",
|
|
327
|
+
});
|
|
328
|
+
/** Lists all subscriptions in a given project and location. */
|
|
329
|
+
await gapi.client.analyticshub.projects.locations.subscriptions.list({
|
|
330
|
+
filter: "Test string",
|
|
331
|
+
pageSize: 42,
|
|
332
|
+
pageToken: "Test string",
|
|
333
|
+
parent: "Test string",
|
|
334
|
+
});
|
|
335
|
+
/**
|
|
336
|
+
* Refreshes a Subscription to a Data Exchange. A Data Exchange can become stale when a publisher adds or removes data. This is a long-running operation as it may create many linked
|
|
337
|
+
* datasets.
|
|
338
|
+
*/
|
|
339
|
+
await gapi.client.analyticshub.projects.locations.subscriptions.refresh({
|
|
340
|
+
name: "Test string",
|
|
341
|
+
}, {
|
|
342
|
+
});
|
|
343
|
+
/** Revokes a given subscription. */
|
|
344
|
+
await gapi.client.analyticshub.projects.locations.subscriptions.revoke({
|
|
345
|
+
name: "Test string",
|
|
346
|
+
}, {
|
|
347
|
+
});
|
|
286
348
|
}
|
|
287
349
|
});
|