/
v1.ts
3378 lines (3168 loc) · 134 KB
/
v1.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/**
* Copyright 2019 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
import {GaxiosPromise} from 'gaxios';
import {Compute, JWT, OAuth2Client, UserRefreshClient} from 'google-auth-library';
import {APIRequestContext, BodyResponseCallback, createAPIRequest, GlobalOptions, GoogleConfigurable, MethodOptions} from 'googleapis-common';
// tslint:disable: no-any
// tslint:disable: class-name
// tslint:disable: variable-name
// tslint:disable: jsdoc-format
// tslint:disable: no-namespace
export namespace bigquerydatatransfer_v1 {
export interface Options extends GlobalOptions {
version: 'v1';
}
let context: APIRequestContext;
interface StandardParameters {
/**
* V1 error format.
*/
'$.xgafv'?: string;
/**
* OAuth access token.
*/
access_token?: string;
/**
* Data format for response.
*/
alt?: string;
/**
* JSONP
*/
callback?: string;
/**
* Selector specifying which fields to include in a partial response.
*/
fields?: string;
/**
* 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.
*/
key?: string;
/**
* OAuth 2.0 token for the current user.
*/
oauth_token?: string;
/**
* Returns response with indentations and line breaks.
*/
prettyPrint?: boolean;
/**
* 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.
*/
quotaUser?: string;
/**
* Legacy upload protocol for media (e.g. "media", "multipart").
*/
uploadType?: string;
/**
* Upload protocol for media (e.g. "raw", "multipart").
*/
upload_protocol?: string;
}
/**
* BigQuery Data Transfer API
*
* Transfers data from partner SaaS applications to Google BigQuery on a
* scheduled, managed basis.
*
* @example
* const {google} = require('googleapis');
* const bigquerydatatransfer = google.bigquerydatatransfer('v1');
*
* @namespace bigquerydatatransfer
* @type {Function}
* @version v1
* @variation v1
* @param {object=} options Options for Bigquerydatatransfer
*/
export class Bigquerydatatransfer {
projects: Resource$Projects;
constructor(options: GlobalOptions, google?: GoogleConfigurable) {
context = {_options: options || {}, google};
this.projects = new Resource$Projects();
}
}
/**
* A request to determine whether the user has valid credentials. This method
* is used to limit the number of OAuth popups in the user interface. The user
* id is inferred from the API call context. If the data source has the
* Google+ authorization type, this method returns false, as it cannot be
* determined whether the credentials are already valid merely based on the
* user id.
*/
export interface Schema$CheckValidCredsRequest {}
/**
* A response indicating whether the credentials exist and are valid.
*/
export interface Schema$CheckValidCredsResponse {
/**
* If set to `true`, the credentials exist and are valid.
*/
hasValidCreds?: boolean;
}
/**
* Represents data source metadata. Metadata is sufficient to render UI and
* request proper OAuth tokens.
*/
export interface Schema$DataSource {
/**
* Indicates the type of authorization.
*/
authorizationType?: string;
/**
* Data source client id which should be used to receive refresh token.
*/
clientId?: string;
/**
* Specifies whether the data source supports automatic data refresh for the
* past few days, and how it's supported. For some data sources, data
* might not be complete until a few days later, so it's useful to
* refresh data automatically.
*/
dataRefreshType?: string;
/**
* Data source id.
*/
dataSourceId?: string;
/**
* Default data refresh window on days. Only meaningful when
* `data_refresh_type` = `SLIDING_WINDOW`.
*/
defaultDataRefreshWindowDays?: number;
/**
* Default data transfer schedule. Examples of valid schedules include:
* `1st,3rd monday of month 15:30`, `every wed,fri of jan,jun 13:15`, and
* `first sunday of quarter 00:00`.
*/
defaultSchedule?: string;
/**
* User friendly data source description string.
*/
description?: string;
/**
* User friendly data source name.
*/
displayName?: string;
/**
* Url for the help document for this data source.
*/
helpUrl?: string;
/**
* Disables backfilling and manual run scheduling for the data source.
*/
manualRunsDisabled?: boolean;
/**
* The minimum interval for scheduler to schedule runs.
*/
minimumScheduleInterval?: string;
/**
* Output only. Data source resource name.
*/
name?: string;
/**
* Data source parameters.
*/
parameters?: Schema$DataSourceParameter[];
/**
* Api auth scopes for which refresh token needs to be obtained. These are
* scopes needed by a data source to prepare data and ingest them into
* BigQuery, e.g., https://www.googleapis.com/auth/bigquery
*/
scopes?: string[];
/**
* Specifies whether the data source supports a user defined schedule, or
* operates on the default schedule. When set to `true`, user can override
* default schedule.
*/
supportsCustomSchedule?: boolean;
/**
* Deprecated. This field has no effect.
*/
supportsMultipleTransfers?: boolean;
/**
* Deprecated. This field has no effect.
*/
transferType?: string;
/**
* The number of seconds to wait for an update from the data source before
* the Data Transfer Service marks the transfer as FAILED.
*/
updateDeadlineSeconds?: number;
}
/**
* Represents a data source parameter with validation rules, so that
* parameters can be rendered in the UI. These parameters are given to us by
* supported data sources, and include all needed information for rendering
* and validation. Thus, whoever uses this api can decide to generate either
* generic ui, or custom data source specific forms.
*/
export interface Schema$DataSourceParameter {
/**
* All possible values for the parameter.
*/
allowedValues?: string[];
/**
* Parameter description.
*/
description?: string;
/**
* Parameter display name in the user interface.
*/
displayName?: string;
/**
* Deprecated. This field has no effect.
*/
fields?: Schema$DataSourceParameter[];
/**
* Cannot be changed after initial creation.
*/
immutable?: boolean;
/**
* For integer and double values specifies maxminum allowed value.
*/
maxValue?: number;
/**
* For integer and double values specifies minimum allowed value.
*/
minValue?: number;
/**
* Parameter identifier.
*/
paramId?: string;
/**
* Deprecated. This field has no effect.
*/
recurse?: boolean;
/**
* Deprecated. This field has no effect.
*/
repeated?: boolean;
/**
* Is parameter required.
*/
required?: boolean;
/**
* Parameter type.
*/
type?: string;
/**
* Description of the requirements for this field, in case the user input
* does not fulfill the regex pattern or min/max values.
*/
validationDescription?: string;
/**
* URL to a help document to further explain the naming requirements.
*/
validationHelpUrl?: string;
/**
* Regular expression which can be used for parameter validation.
*/
validationRegex?: string;
}
/**
* A generic empty message that you can re-use to avoid defining duplicated
* empty messages in your APIs. A typical example is to use it as the request
* or the response type of an API method. For instance: service Foo { rpc
* Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON
* representation for `Empty` is empty JSON object `{}`.
*/
export interface Schema$Empty {}
/**
* Returns list of supported data sources and their metadata.
*/
export interface Schema$ListDataSourcesResponse {
/**
* List of supported data sources and their transfer settings.
*/
dataSources?: Schema$DataSource[];
/**
* Output only. The next-pagination token. For multiple-page list results,
* this token can be used as the `ListDataSourcesRequest.page_token` to
* request the next page of list results.
*/
nextPageToken?: string;
}
/**
* The response message for Locations.ListLocations.
*/
export interface Schema$ListLocationsResponse {
/**
* A list of locations that matches the specified filter in the request.
*/
locations?: Schema$Location[];
/**
* The standard List next-page token.
*/
nextPageToken?: string;
}
/**
* The returned list of pipelines in the project.
*/
export interface Schema$ListTransferConfigsResponse {
/**
* Output only. The next-pagination token. For multiple-page list results,
* this token can be used as the `ListTransferConfigsRequest.page_token` to
* request the next page of list results.
*/
nextPageToken?: string;
/**
* Output only. The stored pipeline transfer configurations.
*/
transferConfigs?: Schema$TransferConfig[];
}
/**
* The returned list transfer run messages.
*/
export interface Schema$ListTransferLogsResponse {
/**
* Output only. The next-pagination token. For multiple-page list results,
* this token can be used as the `GetTransferRunLogRequest.page_token` to
* request the next page of list results.
*/
nextPageToken?: string;
/**
* Output only. The stored pipeline transfer messages.
*/
transferMessages?: Schema$TransferMessage[];
}
/**
* The returned list of pipelines in the project.
*/
export interface Schema$ListTransferRunsResponse {
/**
* 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.
*/
nextPageToken?: string;
/**
* Output only. The stored pipeline transfer runs.
*/
transferRuns?: Schema$TransferRun[];
}
/**
* A resource that represents Google Cloud Platform location.
*/
export interface Schema$Location {
/**
* The friendly name for this location, typically a nearby city name. For
* example, "Tokyo".
*/
displayName?: string;
/**
* Cross-service attributes for the location. For example
* {"cloud.googleapis.com/region": "us-east1"}
*/
labels?: {[key: string]: string;};
/**
* The canonical id for this location. For example: `"us-east1"`.
*/
locationId?: string;
/**
* Service-specific metadata. For example the available capacity at the
* given location.
*/
metadata?: {[key: string]: any;};
/**
* Resource name for the location, which may vary between implementations.
* For example: `"projects/example-project/locations/us-east1"`
*/
name?: string;
}
/**
* Options customizing the data transfer schedule.
*/
export interface Schema$ScheduleOptions {
/**
* 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.
*/
disableAutoScheduling?: boolean;
/**
* 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. The time when a data transfer can be trigerred manually is not
* limited by this option.
*/
endTime?: string;
/**
* Specifies time to start scheduling transfer runs. The first run will be
* scheduled at or after the start time according to a recurrence pattern
* defined in the schedule string. The start time can be changed at any
* moment. The time when a data transfer can be trigerred manually is not
* limited by this option.
*/
startTime?: string;
}
/**
* A request to schedule transfer runs for a time range.
*/
export interface Schema$ScheduleTransferRunsRequest {
/**
* End time of the range of transfer runs. For example,
* `"2017-05-30T00:00:00+00:00"`.
*/
endTime?: string;
/**
* Start time of the range of transfer runs. For example,
* `"2017-05-25T00:00:00+00:00"`.
*/
startTime?: string;
}
/**
* A response to schedule transfer runs for a time range.
*/
export interface Schema$ScheduleTransferRunsResponse {
/**
* The transfer runs that were scheduled.
*/
runs?: Schema$TransferRun[];
}
/**
* The `Status` type defines a logical error model that is suitable for
* different programming environments, including REST APIs and RPC APIs. It is
* used by [gRPC](https://github.com/grpc). The error model is designed to be:
* - Simple to use and understand for most users - Flexible enough to meet
* unexpected needs # Overview The `Status` message contains three pieces of
* data: error code, error message, and error details. The error code should
* be an enum value of google.rpc.Code, but it may accept additional error
* codes if needed. The error message should be a developer-facing English
* message that helps developers *understand* and *resolve* the error. If a
* localized user-facing error message is needed, put the localized message in
* the error details or localize it in the client. The optional error details
* may contain arbitrary information about the error. There is a predefined
* set of error detail types in the package `google.rpc` that can be used for
* common error conditions. # Language mapping The `Status` message is the
* logical representation of the error model, but it is not necessarily the
* actual wire format. When the `Status` message is exposed in different
* client libraries and different wire protocols, it can be mapped
* differently. For example, it will likely be mapped to some exceptions in
* Java, but more likely mapped to some error codes in C. # Other uses The
* error model and the `Status` message can be used in a variety of
* environments, either with or without APIs, to provide a consistent
* developer experience across different environments. Example uses of this
* error model include: - Partial errors. If a service needs to return
* partial errors to the client, it may embed the `Status` in the normal
* response to indicate the partial errors. - Workflow errors. A typical
* workflow has multiple steps. Each step may have a `Status` message for
* error reporting. - Batch operations. If a client uses batch request and
* batch response, the `Status` message should be used directly inside
* batch response, one for each error sub-response. - Asynchronous
* operations. If an API call embeds asynchronous operation results in its
* response, the status of those operations should be represented directly
* using the `Status` message. - Logging. If some API errors are stored in
* logs, the message `Status` could be used directly after any stripping
* needed for security/privacy reasons.
*/
export interface Schema$Status {
/**
* The status code, which should be an enum value of google.rpc.Code.
*/
code?: number;
/**
* A list of messages that carry the error details. There is a common set
* of message types for APIs to use.
*/
details?: Array<{[key: string]: any;}>;
/**
* 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.
*/
message?: string;
}
/**
* Represents a data transfer configuration. A transfer configuration contains
* all metadata needed to perform a data transfer. For example,
* `destination_dataset_id` specifies where data should be stored. When a new
* transfer configuration is created, the specified `destination_dataset_id`
* is created when needed and shared with the appropriate data source service
* account.
*/
export interface Schema$TransferConfig {
/**
* The number of days to look back to automatically refresh the data. For
* example, if `data_refresh_window_days = 10`, then every day BigQuery
* reingests data for [today-10, today-1], rather than ingesting data for
* just [today-1]. Only valid if the data source supports the feature. Set
* the value to 0 to use the default value.
*/
dataRefreshWindowDays?: number;
/**
* Output only. Region in which BigQuery dataset is located.
*/
datasetRegion?: string;
/**
* Data source id. Cannot be changed once data transfer is created.
*/
dataSourceId?: string;
/**
* The BigQuery target dataset id.
*/
destinationDatasetId?: string;
/**
* Is this config disabled. When set to true, no runs are scheduled for a
* given transfer.
*/
disabled?: boolean;
/**
* User specified display name for the data transfer.
*/
displayName?: string;
/**
* The resource name of the transfer config. Transfer config names have the
* form of
* `projects/{project_id}/locations/{region}/transferConfigs/{config_id}`.
* The name is automatically generated based on the config_id specified in
* CreateTransferConfigRequest along with project_id and region. If
* config_id is not provided, usually a uuid, even though it is not
* guaranteed or required, will be generated for config_id.
*/
name?: string;
/**
* Output only. Next time when data transfer will run.
*/
nextRunTime?: string;
/**
* Data transfer specific parameters.
*/
params?: {[key: string]: any;};
/**
* Data transfer schedule. If the data source does not support a custom
* schedule, this should be empty. If it is empty, the default value for the
* data source will be used. The specified times are in UTC. Examples of
* valid format: `1st,3rd monday of month 15:30`, `every wed,fri of jan,jun
* 13:15`, and `first sunday of quarter 00:00`. See more explanation about
* the format here:
* https://cloud.google.com/appengine/docs/flexible/python/scheduling-jobs-with-cron-yaml#the_schedule_format
* NOTE: the granularity should be at least 8 hours, or less frequent.
*/
schedule?: string;
/**
* Options customizing the data transfer schedule.
*/
scheduleOptions?: Schema$ScheduleOptions;
/**
* Output only. State of the most recently updated transfer run.
*/
state?: string;
/**
* Output only. Data transfer modification time. Ignored by server on input.
*/
updateTime?: string;
/**
* Deprecated. Unique ID of the user on whose behalf transfer is done.
*/
userId?: string;
}
/**
* Represents a user facing message for a particular data transfer run.
*/
export interface Schema$TransferMessage {
/**
* Message text.
*/
messageText?: string;
/**
* Time when message was logged.
*/
messageTime?: string;
/**
* Message severity.
*/
severity?: string;
}
/**
* Represents a data transfer run.
*/
export interface Schema$TransferRun {
/**
* Output only. Data source id.
*/
dataSourceId?: string;
/**
* Output only. The BigQuery target dataset id.
*/
destinationDatasetId?: string;
/**
* Output only. Time when transfer run ended. Parameter ignored by server
* for input requests.
*/
endTime?: string;
/**
* Status of the transfer run.
*/
errorStatus?: Schema$Status;
/**
* The resource name of the transfer run. Transfer run names have the form
* `projects/{project_id}/locations/{location}/transferConfigs/{config_id}/runs/{run_id}`.
* The name is ignored when creating a transfer run.
*/
name?: string;
/**
* Output only. Data transfer specific parameters.
*/
params?: {[key: string]: any;};
/**
* For batch transfer runs, specifies the date and time that data should be
* ingested.
*/
runTime?: string;
/**
* Output only. Describes the schedule of this transfer run if it was
* created as part of a regular schedule. For batch transfer runs that are
* scheduled manually, this is empty. NOTE: the system might choose to delay
* the schedule depending on the current load, so `schedule_time`
* doesn't always match this.
*/
schedule?: string;
/**
* Minimum time after which a transfer run can be started.
*/
scheduleTime?: string;
/**
* Output only. Time when transfer run was started. Parameter ignored by
* server for input requests.
*/
startTime?: string;
/**
* Data transfer run state. Ignored for input requests.
*/
state?: string;
/**
* Output only. Last time the data transfer run state was updated.
*/
updateTime?: string;
/**
* Deprecated. Unique ID of the user on whose behalf transfer is done.
*/
userId?: string;
}
export class Resource$Projects {
dataSources: Resource$Projects$Datasources;
locations: Resource$Projects$Locations;
transferConfigs: Resource$Projects$Transferconfigs;
constructor() {
this.dataSources = new Resource$Projects$Datasources();
this.locations = new Resource$Projects$Locations();
this.transferConfigs = new Resource$Projects$Transferconfigs();
}
}
export class Resource$Projects$Datasources {
constructor() {}
/**
* bigquerydatatransfer.projects.dataSources.checkValidCreds
* @desc Returns true if valid credentials exist for the given data source
* and requesting user. Some data sources doesn't support service account,
* so we need to talk to them on behalf of the end user. This API just
* checks whether we have OAuth token for the particular user, which is a
* pre-requisite before user can create a transfer config.
* @alias bigquerydatatransfer.projects.dataSources.checkValidCreds
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.name The data source in the form: `projects/{project_id}/dataSources/{data_source_id}`
* @param {().CheckValidCredsRequest} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
checkValidCreds(
params?: Params$Resource$Projects$Datasources$Checkvalidcreds,
options?: MethodOptions): GaxiosPromise<Schema$CheckValidCredsResponse>;
checkValidCreds(
params: Params$Resource$Projects$Datasources$Checkvalidcreds,
options: MethodOptions|
BodyResponseCallback<Schema$CheckValidCredsResponse>,
callback: BodyResponseCallback<Schema$CheckValidCredsResponse>): void;
checkValidCreds(
params: Params$Resource$Projects$Datasources$Checkvalidcreds,
callback: BodyResponseCallback<Schema$CheckValidCredsResponse>): void;
checkValidCreds(
callback: BodyResponseCallback<Schema$CheckValidCredsResponse>): void;
checkValidCreds(
paramsOrCallback?: Params$Resource$Projects$Datasources$Checkvalidcreds|
BodyResponseCallback<Schema$CheckValidCredsResponse>,
optionsOrCallback?: MethodOptions|
BodyResponseCallback<Schema$CheckValidCredsResponse>,
callback?: BodyResponseCallback<Schema$CheckValidCredsResponse>):
void|GaxiosPromise<Schema$CheckValidCredsResponse> {
let params = (paramsOrCallback || {}) as
Params$Resource$Projects$Datasources$Checkvalidcreds;
let options = (optionsOrCallback || {}) as MethodOptions;
if (typeof paramsOrCallback === 'function') {
callback = paramsOrCallback;
params = {} as Params$Resource$Projects$Datasources$Checkvalidcreds;
options = {};
}
if (typeof optionsOrCallback === 'function') {
callback = optionsOrCallback;
options = {};
}
const rootUrl =
options.rootUrl || 'https://bigquerydatatransfer.googleapis.com/';
const parameters = {
options: Object.assign(
{
url: (rootUrl + '/v1/{+name}:checkValidCreds')
.replace(/([^:]\/)\/+/g, '$1'),
method: 'POST'
},
options),
params,
requiredParams: ['name'],
pathParams: ['name'],
context
};
if (callback) {
createAPIRequest<Schema$CheckValidCredsResponse>(parameters, callback);
} else {
return createAPIRequest<Schema$CheckValidCredsResponse>(parameters);
}
}
/**
* bigquerydatatransfer.projects.dataSources.get
* @desc Retrieves a supported data source and returns its settings, which
* can be used for UI rendering.
* @alias bigquerydatatransfer.projects.dataSources.get
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.name The field will contain name of the resource requested, for example: `projects/{project_id}/dataSources/{data_source_id}`
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
get(params?: Params$Resource$Projects$Datasources$Get,
options?: MethodOptions): GaxiosPromise<Schema$DataSource>;
get(params: Params$Resource$Projects$Datasources$Get,
options: MethodOptions|BodyResponseCallback<Schema$DataSource>,
callback: BodyResponseCallback<Schema$DataSource>): void;
get(params: Params$Resource$Projects$Datasources$Get,
callback: BodyResponseCallback<Schema$DataSource>): void;
get(callback: BodyResponseCallback<Schema$DataSource>): void;
get(paramsOrCallback?: Params$Resource$Projects$Datasources$Get|
BodyResponseCallback<Schema$DataSource>,
optionsOrCallback?: MethodOptions|
BodyResponseCallback<Schema$DataSource>,
callback?: BodyResponseCallback<Schema$DataSource>):
void|GaxiosPromise<Schema$DataSource> {
let params =
(paramsOrCallback || {}) as Params$Resource$Projects$Datasources$Get;
let options = (optionsOrCallback || {}) as MethodOptions;
if (typeof paramsOrCallback === 'function') {
callback = paramsOrCallback;
params = {} as Params$Resource$Projects$Datasources$Get;
options = {};
}
if (typeof optionsOrCallback === 'function') {
callback = optionsOrCallback;
options = {};
}
const rootUrl =
options.rootUrl || 'https://bigquerydatatransfer.googleapis.com/';
const parameters = {
options: Object.assign(
{
url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'),
method: 'GET'
},
options),
params,
requiredParams: ['name'],
pathParams: ['name'],
context
};
if (callback) {
createAPIRequest<Schema$DataSource>(parameters, callback);
} else {
return createAPIRequest<Schema$DataSource>(parameters);
}
}
/**
* bigquerydatatransfer.projects.dataSources.list
* @desc Lists supported data sources and returns their settings, which can
* be used for UI rendering.
* @alias bigquerydatatransfer.projects.dataSources.list
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {integer=} params.pageSize Page size. The default page size is the maximum value of 1000 results.
* @param {string=} params.pageToken Pagination token, which can be used to request a specific page of `ListDataSourcesRequest` list results. For multiple-page results, `ListDataSourcesResponse` outputs a `next_page` token, which can be used as the `page_token` value to request the next page of list results.
* @param {string} params.parent The BigQuery project id for which data sources should be returned. Must be in the form: `projects/{project_id}`
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
list(
params?: Params$Resource$Projects$Datasources$List,
options?: MethodOptions): GaxiosPromise<Schema$ListDataSourcesResponse>;
list(
params: Params$Resource$Projects$Datasources$List,
options: MethodOptions|
BodyResponseCallback<Schema$ListDataSourcesResponse>,
callback: BodyResponseCallback<Schema$ListDataSourcesResponse>): void;
list(
params: Params$Resource$Projects$Datasources$List,
callback: BodyResponseCallback<Schema$ListDataSourcesResponse>): void;
list(callback: BodyResponseCallback<Schema$ListDataSourcesResponse>): void;
list(
paramsOrCallback?: Params$Resource$Projects$Datasources$List|
BodyResponseCallback<Schema$ListDataSourcesResponse>,
optionsOrCallback?: MethodOptions|
BodyResponseCallback<Schema$ListDataSourcesResponse>,
callback?: BodyResponseCallback<Schema$ListDataSourcesResponse>):
void|GaxiosPromise<Schema$ListDataSourcesResponse> {
let params =
(paramsOrCallback || {}) as Params$Resource$Projects$Datasources$List;
let options = (optionsOrCallback || {}) as MethodOptions;
if (typeof paramsOrCallback === 'function') {
callback = paramsOrCallback;
params = {} as Params$Resource$Projects$Datasources$List;
options = {};
}
if (typeof optionsOrCallback === 'function') {
callback = optionsOrCallback;
options = {};
}
const rootUrl =
options.rootUrl || 'https://bigquerydatatransfer.googleapis.com/';
const parameters = {
options: Object.assign(
{
url: (rootUrl + '/v1/{+parent}/dataSources')
.replace(/([^:]\/)\/+/g, '$1'),
method: 'GET'
},
options),
params,
requiredParams: ['parent'],
pathParams: ['parent'],
context
};
if (callback) {
createAPIRequest<Schema$ListDataSourcesResponse>(parameters, callback);
} else {
return createAPIRequest<Schema$ListDataSourcesResponse>(parameters);
}
}
}
export interface Params$Resource$Projects$Datasources$Checkvalidcreds extends
StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient;
/**
* The data source in the form:
* `projects/{project_id}/dataSources/{data_source_id}`
*/
name?: string;
/**
* Request body metadata
*/
requestBody?: Schema$CheckValidCredsRequest;
}
export interface Params$Resource$Projects$Datasources$Get extends
StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient;
/**
* The field will contain name of the resource requested, for example:
* `projects/{project_id}/dataSources/{data_source_id}`
*/
name?: string;
}
export interface Params$Resource$Projects$Datasources$List extends
StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient;
/**
* Page size. The default page size is the maximum value of 1000 results.
*/
pageSize?: number;
/**
* Pagination token, which can be used to request a specific page of
* `ListDataSourcesRequest` list results. For multiple-page results,
* `ListDataSourcesResponse` outputs a `next_page` token, which can be used
* as the `page_token` value to request the next page of list results.
*/
pageToken?: string;
/**
* The BigQuery project id for which data sources should be returned. Must
* be in the form: `projects/{project_id}`
*/
parent?: string;
}
export class Resource$Projects$Locations {
dataSources: Resource$Projects$Locations$Datasources;
transferConfigs: Resource$Projects$Locations$Transferconfigs;
constructor() {
this.dataSources = new Resource$Projects$Locations$Datasources();
this.transferConfigs = new Resource$Projects$Locations$Transferconfigs();
}
/**
* bigquerydatatransfer.projects.locations.get
* @desc Gets information about a location.
* @alias bigquerydatatransfer.projects.locations.get
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.name Resource name for the location.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
get(params?: Params$Resource$Projects$Locations$Get,
options?: MethodOptions): GaxiosPromise<Schema$Location>;
get(params: Params$Resource$Projects$Locations$Get,
options: MethodOptions|BodyResponseCallback<Schema$Location>,
callback: BodyResponseCallback<Schema$Location>): void;
get(params: Params$Resource$Projects$Locations$Get,
callback: BodyResponseCallback<Schema$Location>): void;
get(callback: BodyResponseCallback<Schema$Location>): void;
get(paramsOrCallback?: Params$Resource$Projects$Locations$Get|
BodyResponseCallback<Schema$Location>,
optionsOrCallback?: MethodOptions|BodyResponseCallback<Schema$Location>,
callback?: BodyResponseCallback<Schema$Location>):
void|GaxiosPromise<Schema$Location> {
let params =
(paramsOrCallback || {}) as Params$Resource$Projects$Locations$Get;
let options = (optionsOrCallback || {}) as MethodOptions;
if (typeof paramsOrCallback === 'function') {
callback = paramsOrCallback;
params = {} as Params$Resource$Projects$Locations$Get;
options = {};
}
if (typeof optionsOrCallback === 'function') {
callback = optionsOrCallback;