@maxim_mazurok/gapi.client.bigquerydatatransfer-v1 0.1.20260310 → 0.1.20260314
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 +199 -1
- package/package.json +1 -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://bigquerydatatransfer.googleapis.com/$discovery/rest?version=v1
|
|
12
|
-
// Revision:
|
|
12
|
+
// Revision: 20260314
|
|
13
13
|
|
|
14
14
|
/// <reference types="gapi.client" />
|
|
15
15
|
|
|
@@ -124,6 +124,12 @@ declare namespace gapi.client {
|
|
|
124
124
|
/** Pub/Sub subscription name used to receive events. Only Google Cloud Storage data source support this option. Format: projects/{project}/subscriptions/{subscription} */
|
|
125
125
|
pubsubSubscription?: string;
|
|
126
126
|
}
|
|
127
|
+
interface HierarchyDetail {
|
|
128
|
+
/** Optional. Partition details related to hierarchy. */
|
|
129
|
+
partitionDetail?: PartitionDetail;
|
|
130
|
+
/** Optional. Table details related to hierarchy. */
|
|
131
|
+
tableDetail?: TableDetail;
|
|
132
|
+
}
|
|
127
133
|
interface ListDataSourcesResponse {
|
|
128
134
|
/** List of supported data sources and their transfer settings. */
|
|
129
135
|
dataSources?: DataSource[];
|
|
@@ -148,6 +154,12 @@ declare namespace gapi.client {
|
|
|
148
154
|
/** Output only. The stored pipeline transfer messages. */
|
|
149
155
|
transferMessages?: TransferMessage[];
|
|
150
156
|
}
|
|
157
|
+
interface ListTransferResourcesResponse {
|
|
158
|
+
/** Output only. A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. */
|
|
159
|
+
nextPageToken?: string;
|
|
160
|
+
/** Output only. The transfer resources. */
|
|
161
|
+
transferResources?: TransferResource[];
|
|
162
|
+
}
|
|
151
163
|
interface ListTransferRunsResponse {
|
|
152
164
|
/** Output only. The next-pagination token. For multiple-page list results, this token can be used as the `ListTransferRunsRequest.page_token` to request the next page of list results. */
|
|
153
165
|
nextPageToken?: string;
|
|
@@ -167,6 +179,10 @@ declare namespace gapi.client {
|
|
|
167
179
|
name?: string;
|
|
168
180
|
}
|
|
169
181
|
interface ManualSchedule {}
|
|
182
|
+
interface PartitionDetail {
|
|
183
|
+
/** Optional. Name of the table which has the partitions. */
|
|
184
|
+
table?: string;
|
|
185
|
+
}
|
|
170
186
|
interface ScheduleOptions {
|
|
171
187
|
/** If true, automatic scheduling of data transfer runs for this configuration will be disabled. The runs can be started on ad-hoc basis using StartManualTransferRuns API. When automatic scheduling is disabled, the TransferConfig.schedule field will be ignored. */
|
|
172
188
|
disableAutoScheduling?: boolean;
|
|
@@ -211,6 +227,10 @@ declare namespace gapi.client {
|
|
|
211
227
|
/** 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. */
|
|
212
228
|
message?: string;
|
|
213
229
|
}
|
|
230
|
+
interface TableDetail {
|
|
231
|
+
/** Optional. Total number of partitions being tracked within the table. */
|
|
232
|
+
partitionCount?: string;
|
|
233
|
+
}
|
|
214
234
|
interface TimeBasedSchedule {
|
|
215
235
|
/** Defines time to stop scheduling transfer runs. A transfer run cannot be scheduled at or after the end time. The end time can be changed at any moment. */
|
|
216
236
|
endTime?: string;
|
|
@@ -277,6 +297,34 @@ declare namespace gapi.client {
|
|
|
277
297
|
/** Message severity. */
|
|
278
298
|
severity?: string;
|
|
279
299
|
}
|
|
300
|
+
interface TransferResource {
|
|
301
|
+
/** Optional. Resource destination. */
|
|
302
|
+
destination?: string;
|
|
303
|
+
/** Optional. Details about the hierarchy. */
|
|
304
|
+
hierarchyDetail?: HierarchyDetail;
|
|
305
|
+
/** Output only. Run details for the last successful run. */
|
|
306
|
+
lastSuccessfulRun?: TransferRunBrief;
|
|
307
|
+
/** Optional. Run details for the latest run. */
|
|
308
|
+
latestRun?: TransferRunBrief;
|
|
309
|
+
/** Optional. Status details for the latest run. */
|
|
310
|
+
latestStatusDetail?: TransferResourceStatusDetail;
|
|
311
|
+
/** Identifier. Resource name. */
|
|
312
|
+
name?: string;
|
|
313
|
+
/** Optional. Resource type. */
|
|
314
|
+
type?: string;
|
|
315
|
+
/** Output only. Time when the resource was last updated. */
|
|
316
|
+
updateTime?: string;
|
|
317
|
+
}
|
|
318
|
+
interface TransferResourceStatusDetail {
|
|
319
|
+
/** Output only. Percentage of the transfer completed. Valid values: 0-100. */
|
|
320
|
+
completedPercentage?: number;
|
|
321
|
+
/** Optional. Transfer error details for the resource. */
|
|
322
|
+
error?: Status;
|
|
323
|
+
/** Optional. Transfer state of the resource. */
|
|
324
|
+
state?: string;
|
|
325
|
+
/** Optional. Transfer status summary of the resource. */
|
|
326
|
+
summary?: TransferStatusSummary;
|
|
327
|
+
}
|
|
280
328
|
interface TransferRun {
|
|
281
329
|
/** Output only. Data source id. */
|
|
282
330
|
dataSourceId?: string;
|
|
@@ -309,6 +357,30 @@ declare namespace gapi.client {
|
|
|
309
357
|
/** Deprecated. Unique ID of the user on whose behalf transfer is done. */
|
|
310
358
|
userId?: string;
|
|
311
359
|
}
|
|
360
|
+
interface TransferRunBrief {
|
|
361
|
+
/** Optional. Run URI. Format projects/{project}/locations/{location}/transferConfigs/{config}/run/{run} */
|
|
362
|
+
run?: string;
|
|
363
|
+
/** Optional. Start time of the transfer run. */
|
|
364
|
+
startTime?: string;
|
|
365
|
+
}
|
|
366
|
+
interface TransferStatusMetric {
|
|
367
|
+
/** Optional. Number of units transferred successfully. */
|
|
368
|
+
completed?: string;
|
|
369
|
+
/** Optional. Number of units that failed to transfer. */
|
|
370
|
+
failed?: string;
|
|
371
|
+
/** Optional. Number of units pending transfer. */
|
|
372
|
+
pending?: string;
|
|
373
|
+
/** Optional. Total number of units for the transfer. */
|
|
374
|
+
total?: string;
|
|
375
|
+
/** Optional. Unit for measuring progress (e.g., BYTES). */
|
|
376
|
+
unit?: string;
|
|
377
|
+
}
|
|
378
|
+
interface TransferStatusSummary {
|
|
379
|
+
/** Optional. List of transfer status metrics. */
|
|
380
|
+
metrics?: TransferStatusMetric[];
|
|
381
|
+
/** Input only. Unit based on which transfer status progress should be calculated. */
|
|
382
|
+
progressUnit?: string;
|
|
383
|
+
}
|
|
312
384
|
interface UnenrollDataSourcesRequest {
|
|
313
385
|
/** Data sources that are unenrolled. It is required to provide at least one data source id. */
|
|
314
386
|
dataSourceIds?: string[];
|
|
@@ -680,6 +752,68 @@ declare namespace gapi.client {
|
|
|
680
752
|
}): Request<ListTransferRunsResponse>;
|
|
681
753
|
transferLogs: TransferLogsResource;
|
|
682
754
|
}
|
|
755
|
+
interface TransferResourcesResource {
|
|
756
|
+
/** Returns a transfer resource. */
|
|
757
|
+
get(request?: {
|
|
758
|
+
/** V1 error format. */
|
|
759
|
+
'$.xgafv'?: string;
|
|
760
|
+
/** OAuth access token. */
|
|
761
|
+
access_token?: string;
|
|
762
|
+
/** Data format for response. */
|
|
763
|
+
alt?: string;
|
|
764
|
+
/** JSONP */
|
|
765
|
+
callback?: string;
|
|
766
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
767
|
+
fields?: string;
|
|
768
|
+
/** 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. */
|
|
769
|
+
key?: string;
|
|
770
|
+
/** Required. The name of the transfer resource in the form of: * `projects/{project}/transferConfigs/{transfer_config}/transferResources/{transfer_resource}` * `projects/{project}/locations/{location}/transferConfigs/{transfer_config}/transferResources/{transfer_resource}` */
|
|
771
|
+
name: string;
|
|
772
|
+
/** OAuth 2.0 token for the current user. */
|
|
773
|
+
oauth_token?: string;
|
|
774
|
+
/** Returns response with indentations and line breaks. */
|
|
775
|
+
prettyPrint?: boolean;
|
|
776
|
+
/** 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. */
|
|
777
|
+
quotaUser?: string;
|
|
778
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
779
|
+
upload_protocol?: string;
|
|
780
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
781
|
+
uploadType?: string;
|
|
782
|
+
}): Request<TransferResource>;
|
|
783
|
+
/** Returns information about transfer resources. */
|
|
784
|
+
list(request?: {
|
|
785
|
+
/** V1 error format. */
|
|
786
|
+
'$.xgafv'?: string;
|
|
787
|
+
/** OAuth access token. */
|
|
788
|
+
access_token?: string;
|
|
789
|
+
/** Data format for response. */
|
|
790
|
+
alt?: string;
|
|
791
|
+
/** JSONP */
|
|
792
|
+
callback?: string;
|
|
793
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
794
|
+
fields?: string;
|
|
795
|
+
/** Optional. Filter for the transfer resources. Currently supported filters include: * Resource name: `name` - Wildcard supported * Resource type: `type` * Resource destination: `destination` * Latest resource state: `latest_status_detail.state` * Last update time: `update_time` - RFC-3339 format * Parent table name: `hierarchy_detail.partition_detail.table` Multiple filters can be applied using the `AND/OR` operator. Examples: * `name="*123" AND (type="TABLE" OR latest_status_detail.state="SUCCEEDED")` * `update_time >= "2012-04-21T11:30:00-04:00` * `hierarchy_detail.partition_detail.table = "table1"` */
|
|
796
|
+
filter?: string;
|
|
797
|
+
/** 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. */
|
|
798
|
+
key?: string;
|
|
799
|
+
/** OAuth 2.0 token for the current user. */
|
|
800
|
+
oauth_token?: string;
|
|
801
|
+
/** Optional. The maximum number of transfer resources to return. The maximum value is 1000; values above 1000 will be coerced to 1000. The default page size is the maximum value of 1000 results. */
|
|
802
|
+
pageSize?: number;
|
|
803
|
+
/** Optional. A page token, received from a previous `ListTransferResources` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListTransferResources` must match the call that provided the page token. */
|
|
804
|
+
pageToken?: string;
|
|
805
|
+
/** Required. Name of transfer configuration for which transfer resources should be retrieved. The name should be in one of the following form: * `projects/{project_id}/transferConfigs/{config_id}` * `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}` */
|
|
806
|
+
parent: string;
|
|
807
|
+
/** Returns response with indentations and line breaks. */
|
|
808
|
+
prettyPrint?: boolean;
|
|
809
|
+
/** 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. */
|
|
810
|
+
quotaUser?: string;
|
|
811
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
812
|
+
upload_protocol?: string;
|
|
813
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
814
|
+
uploadType?: string;
|
|
815
|
+
}): Request<ListTransferResourcesResponse>;
|
|
816
|
+
}
|
|
683
817
|
interface TransferConfigsResource {
|
|
684
818
|
/** Creates a new data transfer configuration. */
|
|
685
819
|
create(request: {
|
|
@@ -1029,6 +1163,7 @@ declare namespace gapi.client {
|
|
|
1029
1163
|
body: StartManualTransferRunsRequest,
|
|
1030
1164
|
): Request<StartManualTransferRunsResponse>;
|
|
1031
1165
|
runs: RunsResource;
|
|
1166
|
+
transferResources: TransferResourcesResource;
|
|
1032
1167
|
}
|
|
1033
1168
|
interface LocationsResource {
|
|
1034
1169
|
/** Enroll data sources in a user project. This allows users to create transfer configurations for these data sources. They will also appear in the ListDataSources RPC and as such, will appear in the [BigQuery UI](https://console.cloud.google.com/bigquery), and the documents can be found in the public guide for [BigQuery Web UI](https://cloud.google.com/bigquery/bigquery-web-ui) and [Data Transfer Service](https://cloud.google.com/bigquery/docs/working-with-transfers). */
|
|
@@ -1339,6 +1474,68 @@ declare namespace gapi.client {
|
|
|
1339
1474
|
}): Request<ListTransferRunsResponse>;
|
|
1340
1475
|
transferLogs: TransferLogsResource;
|
|
1341
1476
|
}
|
|
1477
|
+
interface TransferResourcesResource {
|
|
1478
|
+
/** Returns a transfer resource. */
|
|
1479
|
+
get(request?: {
|
|
1480
|
+
/** V1 error format. */
|
|
1481
|
+
'$.xgafv'?: string;
|
|
1482
|
+
/** OAuth access token. */
|
|
1483
|
+
access_token?: string;
|
|
1484
|
+
/** Data format for response. */
|
|
1485
|
+
alt?: string;
|
|
1486
|
+
/** JSONP */
|
|
1487
|
+
callback?: string;
|
|
1488
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
1489
|
+
fields?: string;
|
|
1490
|
+
/** 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. */
|
|
1491
|
+
key?: string;
|
|
1492
|
+
/** Required. The name of the transfer resource in the form of: * `projects/{project}/transferConfigs/{transfer_config}/transferResources/{transfer_resource}` * `projects/{project}/locations/{location}/transferConfigs/{transfer_config}/transferResources/{transfer_resource}` */
|
|
1493
|
+
name: string;
|
|
1494
|
+
/** OAuth 2.0 token for the current user. */
|
|
1495
|
+
oauth_token?: string;
|
|
1496
|
+
/** Returns response with indentations and line breaks. */
|
|
1497
|
+
prettyPrint?: boolean;
|
|
1498
|
+
/** 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. */
|
|
1499
|
+
quotaUser?: string;
|
|
1500
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
1501
|
+
upload_protocol?: string;
|
|
1502
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1503
|
+
uploadType?: string;
|
|
1504
|
+
}): Request<TransferResource>;
|
|
1505
|
+
/** Returns information about transfer resources. */
|
|
1506
|
+
list(request?: {
|
|
1507
|
+
/** V1 error format. */
|
|
1508
|
+
'$.xgafv'?: string;
|
|
1509
|
+
/** OAuth access token. */
|
|
1510
|
+
access_token?: string;
|
|
1511
|
+
/** Data format for response. */
|
|
1512
|
+
alt?: string;
|
|
1513
|
+
/** JSONP */
|
|
1514
|
+
callback?: string;
|
|
1515
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
1516
|
+
fields?: string;
|
|
1517
|
+
/** Optional. Filter for the transfer resources. Currently supported filters include: * Resource name: `name` - Wildcard supported * Resource type: `type` * Resource destination: `destination` * Latest resource state: `latest_status_detail.state` * Last update time: `update_time` - RFC-3339 format * Parent table name: `hierarchy_detail.partition_detail.table` Multiple filters can be applied using the `AND/OR` operator. Examples: * `name="*123" AND (type="TABLE" OR latest_status_detail.state="SUCCEEDED")` * `update_time >= "2012-04-21T11:30:00-04:00` * `hierarchy_detail.partition_detail.table = "table1"` */
|
|
1518
|
+
filter?: string;
|
|
1519
|
+
/** 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. */
|
|
1520
|
+
key?: string;
|
|
1521
|
+
/** OAuth 2.0 token for the current user. */
|
|
1522
|
+
oauth_token?: string;
|
|
1523
|
+
/** Optional. The maximum number of transfer resources to return. The maximum value is 1000; values above 1000 will be coerced to 1000. The default page size is the maximum value of 1000 results. */
|
|
1524
|
+
pageSize?: number;
|
|
1525
|
+
/** Optional. A page token, received from a previous `ListTransferResources` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListTransferResources` must match the call that provided the page token. */
|
|
1526
|
+
pageToken?: string;
|
|
1527
|
+
/** Required. Name of transfer configuration for which transfer resources should be retrieved. The name should be in one of the following form: * `projects/{project_id}/transferConfigs/{config_id}` * `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}` */
|
|
1528
|
+
parent: string;
|
|
1529
|
+
/** Returns response with indentations and line breaks. */
|
|
1530
|
+
prettyPrint?: boolean;
|
|
1531
|
+
/** 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. */
|
|
1532
|
+
quotaUser?: string;
|
|
1533
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
1534
|
+
upload_protocol?: string;
|
|
1535
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1536
|
+
uploadType?: string;
|
|
1537
|
+
}): Request<ListTransferResourcesResponse>;
|
|
1538
|
+
}
|
|
1342
1539
|
interface TransferConfigsResource {
|
|
1343
1540
|
/** Creates a new data transfer configuration. */
|
|
1344
1541
|
create(request: {
|
|
@@ -1688,6 +1885,7 @@ declare namespace gapi.client {
|
|
|
1688
1885
|
body: StartManualTransferRunsRequest,
|
|
1689
1886
|
): Request<StartManualTransferRunsResponse>;
|
|
1690
1887
|
runs: RunsResource;
|
|
1888
|
+
transferResources: TransferResourcesResource;
|
|
1691
1889
|
}
|
|
1692
1890
|
interface ProjectsResource {
|
|
1693
1891
|
/** Enroll data sources in a user project. This allows users to create transfer configurations for these data sources. They will also appear in the ListDataSources RPC and as such, will appear in the [BigQuery UI](https://console.cloud.google.com/bigquery), and the documents can be found in the public guide for [BigQuery Web UI](https://cloud.google.com/bigquery/bigquery-web-ui) and [Data Transfer Service](https://cloud.google.com/bigquery/docs/working-with-transfers). */
|