v1alpha2.d.ts
73.5 KB
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
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
/**
* 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 { OAuth2Client, JWT, Compute, UserRefreshClient } from 'google-auth-library';
import { GoogleConfigurable, MethodOptions, GlobalOptions, BodyResponseCallback, APIRequestContext } from 'googleapis-common';
import { GaxiosPromise } from 'gaxios';
export declare namespace genomics_v1alpha2 {
export interface Options extends GlobalOptions {
version: 'v1alpha2';
}
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;
}
/**
* Genomics API
*
* Uploads, processes, queries, and searches Genomics data in the cloud.
*
* @example
* const {google} = require('googleapis');
* const genomics = google.genomics('v1alpha2');
*
* @namespace genomics
* @type {Function}
* @version v1alpha2
* @variation v1alpha2
* @param {object=} options Options for Genomics
*/
export class Genomics {
context: APIRequestContext;
operations: Resource$Operations;
pipelines: Resource$Pipelines;
constructor(options: GlobalOptions, google?: GoogleConfigurable);
}
/**
* The request message for Operations.CancelOperation.
*/
export interface Schema$CancelOperationRequest {
}
/**
* Describes a Compute Engine resource that is being managed by a running pipeline.
*/
export interface Schema$ComputeEngine {
/**
* The names of the disks that were created for this pipeline.
*/
diskNames?: string[] | null;
/**
* The instance on which the operation is running.
*/
instanceName?: string | null;
/**
* The machine type of the instance.
*/
machineType?: string | null;
/**
* The availability zone in which the instance resides.
*/
zone?: string | null;
}
/**
* An event generated when a container is forcibly terminated by the worker. Currently, this only occurs when the container outlives the timeout specified by the user.
*/
export interface Schema$ContainerKilledEvent {
/**
* The numeric ID of the action that started the container.
*/
actionId?: number | null;
}
/**
* An event generated when a container starts.
*/
export interface Schema$ContainerStartedEvent {
/**
* The numeric ID of the action that started this container.
*/
actionId?: number | null;
/**
* The public IP address that can be used to connect to the container. This field is only populated when at least one port mapping is present. If the instance was created with a private address, this field will be empty even if port mappings exist.
*/
ipAddress?: string | null;
/**
* The container-to-host port mappings installed for this container. This set will contain any ports exposed using the `PUBLISH_EXPOSED_PORTS` flag as well as any specified in the `Action` definition.
*/
portMappings?: {
[key: string]: number;
} | null;
}
/**
* An event generated when a container exits.
*/
export interface Schema$ContainerStoppedEvent {
/**
* The numeric ID of the action that started this container.
*/
actionId?: number | null;
/**
* The exit status of the container.
*/
exitStatus?: number | null;
/**
* The tail end of any content written to standard error by the container. If the content emits large amounts of debugging noise or contains sensitive information, you can prevent the content from being printed by setting the `DISABLE_STANDARD_ERROR_CAPTURE` flag. Note that only a small amount of the end of the stream is captured here. The entire stream is stored in the `/google/logs` directory mounted into each action, and can be copied off the machine as described elsewhere.
*/
stderr?: string | null;
}
/**
* Stores the information that the controller will fetch from the server in order to run. Should only be used by VMs created by the Pipelines Service and not by end users.
*/
export interface Schema$ControllerConfig {
cmd?: string | null;
disks?: {
[key: string]: string;
} | null;
gcsLogPath?: string | null;
gcsSinks?: {
[key: string]: Schema$RepeatedString;
} | null;
gcsSources?: {
[key: string]: Schema$RepeatedString;
} | null;
image?: string | null;
machineType?: string | null;
vars?: {
[key: string]: string;
} | null;
}
/**
* An event generated whenever a resource limitation or transient error delays execution of a pipeline that was otherwise ready to run.
*/
export interface Schema$DelayedEvent {
/**
* A textual description of the cause of the delay. The string can change without notice because it is often generated by another service (such as Compute Engine).
*/
cause?: string | null;
/**
* If the delay was caused by a resource shortage, this field lists the Compute Engine metrics that are preventing this operation from running (for example, `CPUS` or `INSTANCES`). If the particular metric is not known, a single `UNKNOWN` metric will be present.
*/
metrics?: string[] | null;
}
/**
* A Google Compute Engine disk resource specification.
*/
export interface Schema$Disk {
/**
* Deprecated. Disks created by the Pipelines API will be deleted at the end of the pipeline run, regardless of what this field is set to.
*/
autoDelete?: boolean | null;
/**
* Required at create time and cannot be overridden at run time. Specifies the path in the docker container where files on this disk should be located. For example, if `mountPoint` is `/mnt/disk`, and the parameter has `localPath` `inputs/file.txt`, the docker container can access the data at `/mnt/disk/inputs/file.txt`.
*/
mountPoint?: string | null;
/**
* Required. The name of the disk that can be used in the pipeline parameters. Must be 1 - 63 characters. The name "boot" is reserved for system use.
*/
name?: string | null;
/**
* Specifies how a sourced-base persistent disk will be mounted. See https://cloud.google.com/compute/docs/disks/persistent-disks#use_multi_instances for more details. Can only be set at create time.
*/
readOnly?: boolean | null;
/**
* The size of the disk. Defaults to 500 (GB). This field is not applicable for local SSD.
*/
sizeGb?: number | null;
/**
* The full or partial URL of the persistent disk to attach. See https://cloud.google.com/compute/docs/reference/latest/instances#resource and https://cloud.google.com/compute/docs/disks/persistent-disks#snapshots for more details.
*/
source?: string | null;
/**
* Required. The type of the disk to create.
*/
type?: string | null;
}
/**
* The Docker execuctor specification.
*/
export interface Schema$DockerExecutor {
/**
* Required. The command or newline delimited script to run. The command string will be executed within a bash shell. If the command exits with a non-zero exit code, output parameter de-localization will be skipped and the pipeline operation's `error` field will be populated. Maximum command string length is 16384.
*/
cmd?: string | null;
/**
* Required. Image name from either Docker Hub or Google Container Registry. Users that run pipelines must have READ access to the image.
*/
imageName?: string | null;
}
/**
* 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 {
}
/**
* Carries information about events that occur during pipeline execution.
*/
export interface Schema$Event {
/**
* A human-readable description of the event. Note that these strings can change at any time without notice. Any application logic must use the information in the `details` field.
*/
description?: string | null;
/**
* Machine-readable details about the event.
*/
details?: {
[key: string]: any;
} | null;
/**
* The time at which the event occurred.
*/
timestamp?: string | null;
}
/**
* An event generated when the execution of a pipeline has failed. Note that other events can continue to occur after this event.
*/
export interface Schema$FailedEvent {
/**
* The human-readable description of the cause of the failure.
*/
cause?: string | null;
/**
* The Google standard error code that best describes this failure.
*/
code?: string | null;
}
/**
* The response message for Operations.ListOperations.
*/
export interface Schema$ListOperationsResponse {
/**
* The standard List next-page token.
*/
nextPageToken?: string | null;
/**
* A list of operations that matches the specified filter in the request.
*/
operations?: Schema$Operation[];
}
/**
* The response of ListPipelines. Contains at most `pageSize` pipelines. If it contains `pageSize` pipelines, and more pipelines exist, then `nextPageToken` will be populated and should be used as the `pageToken` argument to a subsequent ListPipelines request.
*/
export interface Schema$ListPipelinesResponse {
/**
* The token to use to get the next page of results.
*/
nextPageToken?: string | null;
/**
* The matched pipelines.
*/
pipelines?: Schema$Pipeline[];
}
/**
* LocalCopy defines how a remote file should be copied to and from the VM.
*/
export interface Schema$LocalCopy {
/**
* Required. The name of the disk where this parameter is located. Can be the name of one of the disks specified in the Resources field, or "boot", which represents the Docker instance's boot disk and has a mount point of `/`.
*/
disk?: string | null;
/**
* Required. The path within the user's docker container where this input should be localized to and from, relative to the specified disk's mount point. For example: file.txt,
*/
path?: string | null;
}
/**
* The logging options for the pipeline run.
*/
export interface Schema$LoggingOptions {
/**
* The location in Google Cloud Storage to which the pipeline logs will be copied. Can be specified as a fully qualified directory path, in which case logs will be output with a unique identifier as the filename in that directory, or as a fully specified path, which must end in `.log`, in which case that path will be used, and the user must ensure that logs are not overwritten. Stdout and stderr logs from the run are also generated and output as `-stdout.log` and `-stderr.log`.
*/
gcsPath?: string | null;
}
/**
* This resource represents a long-running operation that is the result of a network API call.
*/
export interface Schema$Operation {
/**
* 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.
*/
done?: boolean | null;
/**
* The error result of the operation in case of failure or cancellation.
*/
error?: Schema$Status;
/**
* An OperationMetadata or Metadata object. This will always be returned with the Operation.
*/
metadata?: {
[key: string]: any;
} | null;
/**
* The server-assigned name, which is only unique within the same service that originally returns it. For example: `operations/CJHU7Oi_ChDrveSpBRjfuL-qzoWAgEw`
*/
name?: string | null;
/**
* An Empty object.
*/
response?: {
[key: string]: any;
} | null;
}
/**
* An event that occurred during an Operation.
*/
export interface Schema$OperationEvent {
/**
* Required description of event.
*/
description?: string | null;
/**
* Optional time of when event finished. An event can have a start time and no finish time. If an event has a finish time, there must be a start time.
*/
endTime?: string | null;
/**
* Optional time of when event started.
*/
startTime?: string | null;
}
/**
* Metadata describing an Operation.
*/
export interface Schema$OperationMetadata {
/**
* This field is deprecated. Use `labels` instead. Optionally provided by the caller when submitting the request that creates the operation.
*/
clientId?: string | null;
/**
* The time at which the job was submitted to the Genomics service.
*/
createTime?: string | null;
/**
* The time at which the job stopped running.
*/
endTime?: string | null;
/**
* Optional event messages that were generated during the job's execution. This also contains any warnings that were generated during import or export.
*/
events?: Schema$OperationEvent[];
/**
* Optionally provided by the caller when submitting the request that creates the operation.
*/
labels?: {
[key: string]: string;
} | null;
/**
* The Google Cloud Project in which the job is scoped.
*/
projectId?: string | null;
/**
* The original request that started the operation. Note that this will be in current version of the API. If the operation was started with v1beta2 API and a GetOperation is performed on v1 API, a v1 request will be returned.
*/
request?: {
[key: string]: any;
} | null;
/**
* Runtime metadata on this Operation.
*/
runtimeMetadata?: {
[key: string]: any;
} | null;
/**
* The time at which the job began to run.
*/
startTime?: string | null;
}
/**
* The pipeline object. Represents a transformation from a set of input parameters to a set of output parameters. The transformation is defined as a docker image and command to run within that image. Each pipeline is run on a Google Compute Engine VM. A pipeline can be created with the `create` method and then later run with the `run` method, or a pipeline can be defined and run all at once with the `run` method.
*/
export interface Schema$Pipeline {
/**
* User-specified description.
*/
description?: string | null;
/**
* Specifies the docker run information.
*/
docker?: Schema$DockerExecutor;
/**
* Input parameters of the pipeline.
*/
inputParameters?: Schema$PipelineParameter[];
/**
* Required. A user specified pipeline name that does not have to be unique. This name can be used for filtering Pipelines in ListPipelines.
*/
name?: string | null;
/**
* Output parameters of the pipeline.
*/
outputParameters?: Schema$PipelineParameter[];
/**
* Unique pipeline id that is generated by the service when CreatePipeline is called. Cannot be specified in the Pipeline used in the CreatePipelineRequest, and will be populated in the response to CreatePipeline and all subsequent Get and List calls. Indicates that the service has registered this pipeline.
*/
pipelineId?: string | null;
/**
* Required. The project in which to create the pipeline. The caller must have WRITE access.
*/
projectId?: string | null;
/**
* Required. Specifies resource requirements for the pipeline run. Required fields: * minimumCpuCores * minimumRamGb
*/
resources?: Schema$PipelineResources;
}
/**
* Parameters facilitate setting and delivering data into the pipeline's execution environment. They are defined at create time, with optional defaults, and can be overridden at run time. If `localCopy` is unset, then the parameter specifies a string that is passed as-is into the pipeline, as the value of the environment variable with the given name. A default value can be optionally specified at create time. The default can be overridden at run time using the inputs map. If no default is given, a value must be supplied at runtime. If `localCopy` is defined, then the parameter specifies a data source or sink, both in Google Cloud Storage and on the Docker container where the pipeline computation is run. The service account associated with the Pipeline (by default the project's Compute Engine service account) must have access to the Google Cloud Storage paths. At run time, the Google Cloud Storage paths can be overridden if a default was provided at create time, or must be set otherwise. The pipeline runner should add a key/value pair to either the inputs or outputs map. The indicated data copies will be carried out before/after pipeline execution, just as if the corresponding arguments were provided to `gsutil cp`. For example: Given the following `PipelineParameter`, specified in the `inputParameters` list: ``` {name: "input_file", localCopy: {path: "file.txt", disk: "pd1"}} ``` where `disk` is defined in the `PipelineResources` object as: ``` {name: "pd1", mountPoint: "/mnt/disk/"} ``` We create a disk named `pd1`, mount it on the host VM, and map `/mnt/pd1` to `/mnt/disk` in the docker container. At runtime, an entry for `input_file` would be required in the inputs map, such as: ``` inputs["input_file"] = "gs://my-bucket/bar.txt" ``` This would generate the following gsutil call: ``` gsutil cp gs://my-bucket/bar.txt /mnt/pd1/file.txt ``` The file `/mnt/pd1/file.txt` maps to `/mnt/disk/file.txt` in the Docker container. Acceptable paths are: <table> <thead> <tr><th>Google Cloud storage path</th><th>Local path</th></tr> </thead> <tbody> <tr><td>file</td><td>file</td></tr> <tr><td>glob</td><td>directory</td></tr> </tbody> </table> For outputs, the direction of the copy is reversed: ``` gsutil cp /mnt/disk/file.txt gs://my-bucket/bar.txt ``` Acceptable paths are: <table> <thead> <tr><th>Local path</th><th>Google Cloud Storage path</th></tr> </thead> <tbody> <tr><td>file</td><td>file</td></tr> <tr> <td>file</td> <td>directory - directory must already exist</td> </tr> <tr> <td>glob</td> <td>directory - directory will be created if it doesn't exist</td></tr> </tbody> </table> One restriction due to docker limitations, is that for outputs that are found on the boot disk, the local path cannot be a glob and must be a file.
*/
export interface Schema$PipelineParameter {
/**
* The default value for this parameter. Can be overridden at runtime. If `localCopy` is present, then this must be a Google Cloud Storage path beginning with `gs://`.
*/
defaultValue?: string | null;
/**
* Human-readable description.
*/
description?: string | null;
/**
* If present, this parameter is marked for copying to and from the VM. `LocalCopy` indicates where on the VM the file should be. The value given to this parameter (either at runtime or using `defaultValue`) must be the remote path where the file should be.
*/
localCopy?: Schema$LocalCopy;
/**
* Required. Name of the parameter - the pipeline runner uses this string as the key to the input and output maps in RunPipeline.
*/
name?: string | null;
}
/**
* The system resources for the pipeline run.
*/
export interface Schema$PipelineResources {
/**
* Optional. The number of accelerators of the specified type to attach. By specifying this parameter, you will download and install the following third-party software onto your managed Compute Engine instances: NVIDIA® Tesla® drivers and NVIDIA® CUDA toolkit.
*/
acceleratorCount?: string | null;
/**
* Optional. The Compute Engine defined accelerator type. By specifying this parameter, you will download and install the following third-party software onto your managed Compute Engine instances: NVIDIA® Tesla® drivers and NVIDIA® CUDA toolkit. Please see https://cloud.google.com/compute/docs/gpus/ for a list of available accelerator types.
*/
acceleratorType?: string | null;
/**
* The size of the boot disk. Defaults to 10 (GB).
*/
bootDiskSizeGb?: number | null;
/**
* Disks to attach.
*/
disks?: Schema$Disk[];
/**
* The minimum number of cores to use. Defaults to 1.
*/
minimumCpuCores?: number | null;
/**
* The minimum amount of RAM to use. Defaults to 3.75 (GB)
*/
minimumRamGb?: number | null;
/**
* Whether to assign an external IP to the instance. This is an experimental feature that may go away. Defaults to false. Corresponds to `--no_address` flag for [gcloud compute instances create] (https://cloud.google.com/sdk/gcloud/reference/compute/instances/create). In order to use this, must be true for both create time and run time. Cannot be true at run time if false at create time. If you need to ssh into a private IP VM for debugging, you can ssh to a public VM and then ssh into the private VM's Internal IP. If noAddress is set, this pipeline run may only load docker images from Google Container Registry and not Docker Hub. Before using this, you must [configure access to Google services from internal IPs](https://cloud.google.com/compute/docs/configure-private-google-access#configuring_access_to_google_services_from_internal_ips).
*/
noAddress?: boolean | null;
/**
* Whether to use preemptible VMs. Defaults to `false`. In order to use this, must be true for both create time and run time. Cannot be true at run time if false at create time.
*/
preemptible?: boolean | null;
/**
* List of Google Compute Engine availability zones to which resource creation will restricted. If empty, any zone may be chosen.
*/
zones?: string[] | null;
}
/**
* An event generated when the worker starts pulling an image.
*/
export interface Schema$PullStartedEvent {
/**
* The URI of the image that was pulled.
*/
imageUri?: string | null;
}
/**
* An event generated when the worker stops pulling an image.
*/
export interface Schema$PullStoppedEvent {
/**
* The URI of the image that was pulled.
*/
imageUri?: string | null;
}
export interface Schema$RepeatedString {
values?: string[] | null;
}
/**
* The pipeline run arguments.
*/
export interface Schema$RunPipelineArgs {
/**
* This field is deprecated. Use `labels` instead. Client-specified pipeline operation identifier.
*/
clientId?: string | null;
/**
* Pipeline input arguments; keys are defined in the pipeline documentation. All input parameters that do not have default values must be specified. If parameters with defaults are specified here, the defaults will be overridden.
*/
inputs?: {
[key: string]: string;
} | null;
/**
* How long to keep the VM up after a failure (for example docker command failed, copying input or output files failed, etc). While the VM is up, one can ssh into the VM to debug. Default is 0; maximum allowed value is 1 day.
*/
keepVmAliveOnFailureDuration?: string | null;
/**
* Labels to apply to this pipeline run. Labels will also be applied to compute resources (VM, disks) created by this pipeline run. When listing operations, operations can filtered by labels. Label keys may not be empty; label values may be empty. Non-empty labels must be 1-63 characters long, and comply with [RFC1035] (https://www.ietf.org/rfc/rfc1035.txt). Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
*/
labels?: {
[key: string]: string;
} | null;
/**
* Required. Logging options. Used by the service to communicate results to the user.
*/
logging?: Schema$LoggingOptions;
/**
* Pipeline output arguments; keys are defined in the pipeline documentation. All output parameters of without default values must be specified. If parameters with defaults are specified here, the defaults will be overridden.
*/
outputs?: {
[key: string]: string;
} | null;
/**
* Required. The project in which to run the pipeline. The caller must have WRITER access to all Google Cloud services and resources (e.g. Google Compute Engine) will be used.
*/
projectId?: string | null;
/**
* Specifies resource requirements/overrides for the pipeline run.
*/
resources?: Schema$PipelineResources;
/**
* The Google Cloud Service Account that will be used to access data and services. By default, the compute service account associated with `projectId` is used.
*/
serviceAccount?: Schema$ServiceAccount;
}
/**
* The request to run a pipeline. If `pipelineId` is specified, it refers to a saved pipeline created with CreatePipeline and set as the `pipelineId` of the returned Pipeline object. If `ephemeralPipeline` is specified, that pipeline is run once with the given args and not saved. It is an error to specify both `pipelineId` and `ephemeralPipeline`. `pipelineArgs` must be specified.
*/
export interface Schema$RunPipelineRequest {
/**
* A new pipeline object to run once and then delete.
*/
ephemeralPipeline?: Schema$Pipeline;
/**
* The arguments to use when running this pipeline.
*/
pipelineArgs?: Schema$RunPipelineArgs;
/**
* The already created pipeline to run.
*/
pipelineId?: string | null;
}
/**
* The response to the RunPipeline method, returned in the operation's result field on success.
*/
export interface Schema$RunPipelineResponse {
}
/**
* Runtime metadata that will be populated in the runtimeMetadata field of the Operation associated with a RunPipeline execution.
*/
export interface Schema$RuntimeMetadata {
/**
* Execution information specific to Google Compute Engine.
*/
computeEngine?: Schema$ComputeEngine;
}
/**
* A Google Cloud Service Account.
*/
export interface Schema$ServiceAccount {
/**
* Email address of the service account. Defaults to `default`, which uses the compute service account associated with the project.
*/
email?: string | null;
/**
* List of scopes to be enabled for this service account on the VM. The following scopes are automatically included: * https://www.googleapis.com/auth/compute * https://www.googleapis.com/auth/devstorage.full_control * https://www.googleapis.com/auth/genomics * https://www.googleapis.com/auth/logging.write * https://www.googleapis.com/auth/monitoring.write
*/
scopes?: string[] | null;
}
/**
* Request to set operation status. Should only be used by VMs created by the Pipelines Service and not by end users.
*/
export interface Schema$SetOperationStatusRequest {
errorCode?: string | null;
errorMessage?: string | null;
operationId?: string | null;
timestampEvents?: Schema$TimestampEvent[];
validationToken?: string | null;
}
/**
* 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). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).
*/
export interface Schema$Status {
/**
* The status code, which should be an enum value of google.rpc.Code.
*/
code?: number | null;
/**
* 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;
}> | null;
/**
* 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 | null;
}
/**
* Stores the list of events and times they occured for major events in job execution.
*/
export interface Schema$TimestampEvent {
/**
* String indicating the type of event
*/
description?: string | null;
/**
* The time this event occured.
*/
timestamp?: string | null;
}
/**
* An event generated when the execution of a container results in a non-zero exit status that was not otherwise ignored. Execution will continue, but only actions that are flagged as `ALWAYS_RUN` will be executed. Other actions will be skipped.
*/
export interface Schema$UnexpectedExitStatusEvent {
/**
* The numeric ID of the action that started the container.
*/
actionId?: number | null;
/**
* The exit status of the container.
*/
exitStatus?: number | null;
}
/**
* An event generated after a worker VM has been assigned to run the pipeline.
*/
export interface Schema$WorkerAssignedEvent {
/**
* The worker's instance name.
*/
instance?: string | null;
/**
* The machine type that was assigned for the worker.
*/
machineType?: string | null;
/**
* The zone the worker is running in.
*/
zone?: string | null;
}
/**
* An event generated when the worker VM that was assigned to the pipeline has been released (deleted).
*/
export interface Schema$WorkerReleasedEvent {
/**
* The worker's instance name.
*/
instance?: string | null;
/**
* The zone the worker was running in.
*/
zone?: string | null;
}
export class Resource$Operations {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* genomics.operations.cancel
* @desc Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. Clients may use Operations.GetOperation or Operations.ListOperations to check whether the cancellation succeeded or the operation completed despite cancellation. Authorization requires the following [Google IAM](https://cloud.google.com/iam) permission: * `genomics.operations.cancel`
* @example
* * // BEFORE RUNNING:
* // ---------------
* // 1. If not already done, enable the Genomics API
* // and check the quota for your project at
* // https://console.developers.google.com/apis/api/genomics
* // 2. This sample uses Application Default Credentials for authentication.
* // If not already done, install the gcloud CLI from
* // https://cloud.google.com/sdk and run
* // `gcloud beta auth application-default login`.
* // For more information, see
* // https://developers.google.com/identity/protocols/application-default-credentials
* // 3. Install the Node.js client library by running
* // `npm install googleapis --save`
*
* const {google} = require('googleapis');
* var genomics = google.genomics('v1alpha2');
*
* authorize(function(authClient) {
* var request = {
* // The name of the operation resource to be cancelled.
* name: 'operations/my-operation', // TODO: Update placeholder value.
*
* resource: {
* // TODO: Add desired properties to the request body.
* },
*
* auth: authClient,
* };
*
* genomics.operations.cancel(request, function(err) {
* if (err) {
* console.error(err);
* return;
* }
* });
* });
*
* function authorize(callback) {
* google.auth.getClient({
* scopes: ['https://www.googleapis.com/auth/cloud-platform']
* }).then(client => {
* callback(client);
* }).catch(err => {
* console.error('authentication failed: ', err);
* });
* }
* @alias genomics.operations.cancel
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.name The name of the operation resource to be cancelled.
* @param {().CancelOperationRequest} 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
*/
cancel(params?: Params$Resource$Operations$Cancel, options?: MethodOptions): GaxiosPromise<Schema$Empty>;
cancel(params: Params$Resource$Operations$Cancel, options: MethodOptions | BodyResponseCallback<Schema$Empty>, callback: BodyResponseCallback<Schema$Empty>): void;
cancel(params: Params$Resource$Operations$Cancel, callback: BodyResponseCallback<Schema$Empty>): void;
cancel(callback: BodyResponseCallback<Schema$Empty>): void;
/**
* genomics.operations.get
* @desc Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. Authorization requires the following [Google IAM](https://cloud.google.com/iam) permission: * `genomics.operations.get`
* @example
* * // BEFORE RUNNING:
* // ---------------
* // 1. If not already done, enable the Genomics API
* // and check the quota for your project at
* // https://console.developers.google.com/apis/api/genomics
* // 2. This sample uses Application Default Credentials for authentication.
* // If not already done, install the gcloud CLI from
* // https://cloud.google.com/sdk and run
* // `gcloud beta auth application-default login`.
* // For more information, see
* // https://developers.google.com/identity/protocols/application-default-credentials
* // 3. Install the Node.js client library by running
* // `npm install googleapis --save`
*
* const {google} = require('googleapis');
* var genomics = google.genomics('v1alpha2');
*
* authorize(function(authClient) {
* var request = {
* // The name of the operation resource.
* name: 'operations/my-operation', // TODO: Update placeholder value.
*
* auth: authClient,
* };
*
* genomics.operations.get(request, function(err, response) {
* if (err) {
* console.error(err);
* return;
* }
*
* // TODO: Change code below to process the `response` object:
* console.log(JSON.stringify(response, null, 2));
* });
* });
*
* function authorize(callback) {
* google.auth.getClient({
* scopes: ['https://www.googleapis.com/auth/cloud-platform']
* }).then(client => {
* callback(client);
* }).catch(err => {
* console.error('authentication failed: ', err);
* });
* }
* @alias genomics.operations.get
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.name The name of the operation resource.
* @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$Operations$Get, options?: MethodOptions): GaxiosPromise<Schema$Operation>;
get(params: Params$Resource$Operations$Get, options: MethodOptions | BodyResponseCallback<Schema$Operation>, callback: BodyResponseCallback<Schema$Operation>): void;
get(params: Params$Resource$Operations$Get, callback: BodyResponseCallback<Schema$Operation>): void;
get(callback: BodyResponseCallback<Schema$Operation>): void;
/**
* genomics.operations.list
* @desc Lists operations that match the specified filter in the request. Authorization requires the following [Google IAM](https://cloud.google.com/iam) permission: * `genomics.operations.list`
* @example
* * // BEFORE RUNNING:
* // ---------------
* // 1. If not already done, enable the Genomics API
* // and check the quota for your project at
* // https://console.developers.google.com/apis/api/genomics
* // 2. This sample uses Application Default Credentials for authentication.
* // If not already done, install the gcloud CLI from
* // https://cloud.google.com/sdk and run
* // `gcloud beta auth application-default login`.
* // For more information, see
* // https://developers.google.com/identity/protocols/application-default-credentials
* // 3. Install the Node.js client library by running
* // `npm install googleapis --save`
*
* const {google} = require('googleapis');
* var genomics = google.genomics('v1alpha2');
*
* authorize(function(authClient) {
* var request = {
* // The name of the operation's parent resource.
* name: 'operations', // TODO: Update placeholder value.
*
* auth: authClient,
* };
*
* var handlePage = function(err, response) {
* if (err) {
* console.error(err);
* return;
* }
*
* var operationsPage = response['operations'];
* if (!operationsPage) {
* return;
* }
* for (var i = 0; i < operationsPage.length; i++) {
* // TODO: Change code below to process each resource in `operationsPage`:
* console.log(JSON.stringify(operationsPage[i], null, 2));
* }
*
* if (response.nextPageToken) {
* request.pageToken = response.nextPageToken;
* genomics.operations.list(request, handlePage);
* }
* };
*
* genomics.operations.list(request, handlePage);
* });
*
* function authorize(callback) {
* google.auth.getClient({
* scopes: ['https://www.googleapis.com/auth/cloud-platform']
* }).then(client => {
* callback(client);
* }).catch(err => {
* console.error('authentication failed: ', err);
* });
* }
* @alias genomics.operations.list
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string=} params.filter A string for filtering Operations. In v2alpha1, the following filter fields are supported: * createTime: The time this job was created * events: The set of event (names) that have occurred while running the pipeline. The : operator can be used to determine if a particular event has occurred. * error: If the pipeline is running, this value is NULL. Once the pipeline finishes, the value is the standard Google error code. * labels.key or labels."key with space" where key is a label key. * done: If the pipeline is running, this value is false. Once the pipeline finishes, the value is true. In v1 and v1alpha2, the following filter fields are supported: * projectId: Required. Corresponds to OperationMetadata.projectId. * createTime: The time this job was created, in seconds from the [epoch](http://en.wikipedia.org/wiki/Unix_time). Can use `>=` and/or `<=` operators. * status: Can be `RUNNING`, `SUCCESS`, `FAILURE`, or `CANCELED`. Only one status may be specified. * labels.key where key is a label key. Examples: * `projectId = my-project AND createTime >= 1432140000` * `projectId = my-project AND createTime >= 1432140000 AND createTime <= 1432150000 AND status = RUNNING` * `projectId = my-project AND labels.color = *` * `projectId = my-project AND labels.color = red`
* @param {string} params.name The name of the operation's parent resource.
* @param {integer=} params.pageSize The maximum number of results to return. The maximum value is 256.
* @param {string=} params.pageToken The standard list page token.
* @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$Operations$List, options?: MethodOptions): GaxiosPromise<Schema$ListOperationsResponse>;
list(params: Params$Resource$Operations$List, options: MethodOptions | BodyResponseCallback<Schema$ListOperationsResponse>, callback: BodyResponseCallback<Schema$ListOperationsResponse>): void;
list(params: Params$Resource$Operations$List, callback: BodyResponseCallback<Schema$ListOperationsResponse>): void;
list(callback: BodyResponseCallback<Schema$ListOperationsResponse>): void;
}
export interface Params$Resource$Operations$Cancel extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The name of the operation resource to be cancelled.
*/
name?: string;
/**
* Request body metadata
*/
requestBody?: Schema$CancelOperationRequest;
}
export interface Params$Resource$Operations$Get extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The name of the operation resource.
*/
name?: string;
}
export interface Params$Resource$Operations$List extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* A string for filtering Operations. In v2alpha1, the following filter fields are supported: * createTime: The time this job was created * events: The set of event (names) that have occurred while running the pipeline. The : operator can be used to determine if a particular event has occurred. * error: If the pipeline is running, this value is NULL. Once the pipeline finishes, the value is the standard Google error code. * labels.key or labels."key with space" where key is a label key. * done: If the pipeline is running, this value is false. Once the pipeline finishes, the value is true. In v1 and v1alpha2, the following filter fields are supported: * projectId: Required. Corresponds to OperationMetadata.projectId. * createTime: The time this job was created, in seconds from the [epoch](http://en.wikipedia.org/wiki/Unix_time). Can use `>=` and/or `<=` operators. * status: Can be `RUNNING`, `SUCCESS`, `FAILURE`, or `CANCELED`. Only one status may be specified. * labels.key where key is a label key. Examples: * `projectId = my-project AND createTime >= 1432140000` * `projectId = my-project AND createTime >= 1432140000 AND createTime <= 1432150000 AND status = RUNNING` * `projectId = my-project AND labels.color = *` * `projectId = my-project AND labels.color = red`
*/
filter?: string;
/**
* The name of the operation's parent resource.
*/
name?: string;
/**
* The maximum number of results to return. The maximum value is 256.
*/
pageSize?: number;
/**
* The standard list page token.
*/
pageToken?: string;
}
export class Resource$Pipelines {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* genomics.pipelines.create
* @desc Creates a pipeline that can be run later. Create takes a Pipeline that has all fields other than `pipelineId` populated, and then returns the same pipeline with `pipelineId` populated. This id can be used to run the pipeline. Caller must have WRITE permission to the project.
* @example
* * // BEFORE RUNNING:
* // ---------------
* // 1. If not already done, enable the Genomics API
* // and check the quota for your project at
* // https://console.developers.google.com/apis/api/genomics
* // 2. This sample uses Application Default Credentials for authentication.
* // If not already done, install the gcloud CLI from
* // https://cloud.google.com/sdk and run
* // `gcloud beta auth application-default login`.
* // For more information, see
* // https://developers.google.com/identity/protocols/application-default-credentials
* // 3. Install the Node.js client library by running
* // `npm install googleapis --save`
*
* const {google} = require('googleapis');
* var genomics = google.genomics('v1alpha2');
*
* authorize(function(authClient) {
* var request = {
* resource: {
* // TODO: Add desired properties to the request body.
* },
*
* auth: authClient,
* };
*
* genomics.pipelines.create(request, function(err, response) {
* if (err) {
* console.error(err);
* return;
* }
*
* // TODO: Change code below to process the `response` object:
* console.log(JSON.stringify(response, null, 2));
* });
* });
*
* function authorize(callback) {
* google.auth.getClient({
* scopes: ['https://www.googleapis.com/auth/cloud-platform']
* }).then(client => {
* callback(client);
* }).catch(err => {
* console.error('authentication failed: ', err);
* });
* }
* @alias genomics.pipelines.create
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {().Pipeline} 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
*/
create(params?: Params$Resource$Pipelines$Create, options?: MethodOptions): GaxiosPromise<Schema$Pipeline>;
create(params: Params$Resource$Pipelines$Create, options: MethodOptions | BodyResponseCallback<Schema$Pipeline>, callback: BodyResponseCallback<Schema$Pipeline>): void;
create(params: Params$Resource$Pipelines$Create, callback: BodyResponseCallback<Schema$Pipeline>): void;
create(callback: BodyResponseCallback<Schema$Pipeline>): void;
/**
* genomics.pipelines.delete
* @desc Deletes a pipeline based on ID. Caller must have WRITE permission to the project.
* @example
* * // BEFORE RUNNING:
* // ---------------
* // 1. If not already done, enable the Genomics API
* // and check the quota for your project at
* // https://console.developers.google.com/apis/api/genomics
* // 2. This sample uses Application Default Credentials for authentication.
* // If not already done, install the gcloud CLI from
* // https://cloud.google.com/sdk and run
* // `gcloud beta auth application-default login`.
* // For more information, see
* // https://developers.google.com/identity/protocols/application-default-credentials
* // 3. Install the Node.js client library by running
* // `npm install googleapis --save`
*
* const {google} = require('googleapis');
* var genomics = google.genomics('v1alpha2');
*
* authorize(function(authClient) {
* var request = {
* // Caller must have WRITE access to the project in which this pipeline
* // is defined.
* pipelineId: 'my-pipeline-id', // TODO: Update placeholder value.
*
* auth: authClient,
* };
*
* genomics.pipelines.delete(request, function(err) {
* if (err) {
* console.error(err);
* return;
* }
* });
* });
*
* function authorize(callback) {
* google.auth.getClient({
* scopes: ['https://www.googleapis.com/auth/cloud-platform']
* }).then(client => {
* callback(client);
* }).catch(err => {
* console.error('authentication failed: ', err);
* });
* }
* @alias genomics.pipelines.delete
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.pipelineId Caller must have WRITE access to the project in which this pipeline is defined.
* @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
*/
delete(params?: Params$Resource$Pipelines$Delete, options?: MethodOptions): GaxiosPromise<Schema$Empty>;
delete(params: Params$Resource$Pipelines$Delete, options: MethodOptions | BodyResponseCallback<Schema$Empty>, callback: BodyResponseCallback<Schema$Empty>): void;
delete(params: Params$Resource$Pipelines$Delete, callback: BodyResponseCallback<Schema$Empty>): void;
delete(callback: BodyResponseCallback<Schema$Empty>): void;
/**
* genomics.pipelines.get
* @desc Retrieves a pipeline based on ID. Caller must have READ permission to the project.
* @example
* * // BEFORE RUNNING:
* // ---------------
* // 1. If not already done, enable the Genomics API
* // and check the quota for your project at
* // https://console.developers.google.com/apis/api/genomics
* // 2. This sample uses Application Default Credentials for authentication.
* // If not already done, install the gcloud CLI from
* // https://cloud.google.com/sdk and run
* // `gcloud beta auth application-default login`.
* // For more information, see
* // https://developers.google.com/identity/protocols/application-default-credentials
* // 3. Install the Node.js client library by running
* // `npm install googleapis --save`
*
* const {google} = require('googleapis');
* var genomics = google.genomics('v1alpha2');
*
* authorize(function(authClient) {
* var request = {
* // Caller must have READ access to the project in which this pipeline
* // is defined.
* pipelineId: 'my-pipeline-id', // TODO: Update placeholder value.
*
* auth: authClient,
* };
*
* genomics.pipelines.get(request, function(err, response) {
* if (err) {
* console.error(err);
* return;
* }
*
* // TODO: Change code below to process the `response` object:
* console.log(JSON.stringify(response, null, 2));
* });
* });
*
* function authorize(callback) {
* google.auth.getClient({
* scopes: ['https://www.googleapis.com/auth/cloud-platform']
* }).then(client => {
* callback(client);
* }).catch(err => {
* console.error('authentication failed: ', err);
* });
* }
* @alias genomics.pipelines.get
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.pipelineId Caller must have READ access to the project in which this pipeline is defined.
* @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$Pipelines$Get, options?: MethodOptions): GaxiosPromise<Schema$Pipeline>;
get(params: Params$Resource$Pipelines$Get, options: MethodOptions | BodyResponseCallback<Schema$Pipeline>, callback: BodyResponseCallback<Schema$Pipeline>): void;
get(params: Params$Resource$Pipelines$Get, callback: BodyResponseCallback<Schema$Pipeline>): void;
get(callback: BodyResponseCallback<Schema$Pipeline>): void;
/**
* genomics.pipelines.getControllerConfig
* @desc Gets controller configuration information. Should only be called by VMs created by the Pipelines Service and not by end users.
* @example
* * // BEFORE RUNNING:
* // ---------------
* // 1. If not already done, enable the Genomics API
* // and check the quota for your project at
* // https://console.developers.google.com/apis/api/genomics
* // 2. This sample uses Application Default Credentials for authentication.
* // If not already done, install the gcloud CLI from
* // https://cloud.google.com/sdk and run
* // `gcloud beta auth application-default login`.
* // For more information, see
* // https://developers.google.com/identity/protocols/application-default-credentials
* // 3. Install the Node.js client library by running
* // `npm install googleapis --save`
*
* const {google} = require('googleapis');
* var genomics = google.genomics('v1alpha2');
*
* authorize(function(authClient) {
* var request = {
* auth: authClient,
* };
*
* genomics.pipelines.getControllerConfig(request, function(err, response) {
* if (err) {
* console.error(err);
* return;
* }
*
* // TODO: Change code below to process the `response` object:
* console.log(JSON.stringify(response, null, 2));
* });
* });
*
* function authorize(callback) {
* google.auth.getClient({
* scopes: ['https://www.googleapis.com/auth/cloud-platform']
* }).then(client => {
* callback(client);
* }).catch(err => {
* console.error('authentication failed: ', err);
* });
* }
* @alias genomics.pipelines.getControllerConfig
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string=} params.operationId The operation to retrieve controller configuration for.
* @param {string=} params.validationToken
* @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
*/
getControllerConfig(params?: Params$Resource$Pipelines$Getcontrollerconfig, options?: MethodOptions): GaxiosPromise<Schema$ControllerConfig>;
getControllerConfig(params: Params$Resource$Pipelines$Getcontrollerconfig, options: MethodOptions | BodyResponseCallback<Schema$ControllerConfig>, callback: BodyResponseCallback<Schema$ControllerConfig>): void;
getControllerConfig(params: Params$Resource$Pipelines$Getcontrollerconfig, callback: BodyResponseCallback<Schema$ControllerConfig>): void;
getControllerConfig(callback: BodyResponseCallback<Schema$ControllerConfig>): void;
/**
* genomics.pipelines.list
* @desc Lists pipelines. Caller must have READ permission to the project.
* @example
* * // BEFORE RUNNING:
* // ---------------
* // 1. If not already done, enable the Genomics API
* // and check the quota for your project at
* // https://console.developers.google.com/apis/api/genomics
* // 2. This sample uses Application Default Credentials for authentication.
* // If not already done, install the gcloud CLI from
* // https://cloud.google.com/sdk and run
* // `gcloud beta auth application-default login`.
* // For more information, see
* // https://developers.google.com/identity/protocols/application-default-credentials
* // 3. Install the Node.js client library by running
* // `npm install googleapis --save`
*
* const {google} = require('googleapis');
* var genomics = google.genomics('v1alpha2');
*
* authorize(function(authClient) {
* var request = {
* auth: authClient,
* };
*
* var handlePage = function(err, response) {
* if (err) {
* console.error(err);
* return;
* }
*
* var pipelinesPage = response['pipelines'];
* if (!pipelinesPage) {
* return;
* }
* for (var i = 0; i < pipelinesPage.length; i++) {
* // TODO: Change code below to process each resource in `pipelinesPage`:
* console.log(JSON.stringify(pipelinesPage[i], null, 2));
* }
*
* if (response.nextPageToken) {
* request.pageToken = response.nextPageToken;
* genomics.pipelines.list(request, handlePage);
* }
* };
*
* genomics.pipelines.list(request, handlePage);
* });
*
* function authorize(callback) {
* google.auth.getClient({
* scopes: ['https://www.googleapis.com/auth/cloud-platform']
* }).then(client => {
* callback(client);
* }).catch(err => {
* console.error('authentication failed: ', err);
* });
* }
* @alias genomics.pipelines.list
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string=} params.namePrefix Pipelines with names that match this prefix should be returned. If unspecified, all pipelines in the project, up to `pageSize`, will be returned.
* @param {integer=} params.pageSize Number of pipelines to return at once. Defaults to 256, and max is 2048.
* @param {string=} params.pageToken Token to use to indicate where to start getting results. If unspecified, returns the first page of results.
* @param {string=} params.projectId Required. The name of the project to search for pipelines. Caller must have READ access to this project.
* @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$Pipelines$List, options?: MethodOptions): GaxiosPromise<Schema$ListPipelinesResponse>;
list(params: Params$Resource$Pipelines$List, options: MethodOptions | BodyResponseCallback<Schema$ListPipelinesResponse>, callback: BodyResponseCallback<Schema$ListPipelinesResponse>): void;
list(params: Params$Resource$Pipelines$List, callback: BodyResponseCallback<Schema$ListPipelinesResponse>): void;
list(callback: BodyResponseCallback<Schema$ListPipelinesResponse>): void;
/**
* genomics.pipelines.run
* @desc Runs a pipeline. If `pipelineId` is specified in the request, then run a saved pipeline. If `ephemeralPipeline` is specified, then run that pipeline once without saving a copy. The caller must have READ permission to the project where the pipeline is stored and WRITE permission to the project where the pipeline will be run, as VMs will be created and storage will be used. If a pipeline operation is still running after 6 days, it will be canceled.
* @example
* * // BEFORE RUNNING:
* // ---------------
* // 1. If not already done, enable the Genomics API
* // and check the quota for your project at
* // https://console.developers.google.com/apis/api/genomics
* // 2. This sample uses Application Default Credentials for authentication.
* // If not already done, install the gcloud CLI from
* // https://cloud.google.com/sdk and run
* // `gcloud beta auth application-default login`.
* // For more information, see
* // https://developers.google.com/identity/protocols/application-default-credentials
* // 3. Install the Node.js client library by running
* // `npm install googleapis --save`
*
* const {google} = require('googleapis');
* var genomics = google.genomics('v1alpha2');
*
* authorize(function(authClient) {
* var request = {
* resource: {
* // TODO: Add desired properties to the request body.
* },
*
* auth: authClient,
* };
*
* genomics.pipelines.run(request, function(err, response) {
* if (err) {
* console.error(err);
* return;
* }
*
* // TODO: Change code below to process the `response` object:
* console.log(JSON.stringify(response, null, 2));
* });
* });
*
* function authorize(callback) {
* google.auth.getClient({
* scopes: ['https://www.googleapis.com/auth/cloud-platform']
* }).then(client => {
* callback(client);
* }).catch(err => {
* console.error('authentication failed: ', err);
* });
* }
* @alias genomics.pipelines.run
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {().RunPipelineRequest} 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
*/
run(params?: Params$Resource$Pipelines$Run, options?: MethodOptions): GaxiosPromise<Schema$Operation>;
run(params: Params$Resource$Pipelines$Run, options: MethodOptions | BodyResponseCallback<Schema$Operation>, callback: BodyResponseCallback<Schema$Operation>): void;
run(params: Params$Resource$Pipelines$Run, callback: BodyResponseCallback<Schema$Operation>): void;
run(callback: BodyResponseCallback<Schema$Operation>): void;
/**
* genomics.pipelines.setOperationStatus
* @desc Sets status of a given operation. Any new timestamps (as determined by description) are appended to TimestampEvents. Should only be called by VMs created by the Pipelines Service and not by end users.
* @example
* * // BEFORE RUNNING:
* // ---------------
* // 1. If not already done, enable the Genomics API
* // and check the quota for your project at
* // https://console.developers.google.com/apis/api/genomics
* // 2. This sample uses Application Default Credentials for authentication.
* // If not already done, install the gcloud CLI from
* // https://cloud.google.com/sdk and run
* // `gcloud beta auth application-default login`.
* // For more information, see
* // https://developers.google.com/identity/protocols/application-default-credentials
* // 3. Install the Node.js client library by running
* // `npm install googleapis --save`
*
* const {google} = require('googleapis');
* var genomics = google.genomics('v1alpha2');
*
* authorize(function(authClient) {
* var request = {
* resource: {
* // TODO: Add desired properties to the request body. All existing properties
* // will be replaced.
* },
*
* auth: authClient,
* };
*
* genomics.pipelines.setOperationStatus(request, function(err) {
* if (err) {
* console.error(err);
* return;
* }
* });
* });
*
* function authorize(callback) {
* google.auth.getClient({
* scopes: ['https://www.googleapis.com/auth/cloud-platform']
* }).then(client => {
* callback(client);
* }).catch(err => {
* console.error('authentication failed: ', err);
* });
* }
* @alias genomics.pipelines.setOperationStatus
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {().SetOperationStatusRequest} 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
*/
setOperationStatus(params?: Params$Resource$Pipelines$Setoperationstatus, options?: MethodOptions): GaxiosPromise<Schema$Empty>;
setOperationStatus(params: Params$Resource$Pipelines$Setoperationstatus, options: MethodOptions | BodyResponseCallback<Schema$Empty>, callback: BodyResponseCallback<Schema$Empty>): void;
setOperationStatus(params: Params$Resource$Pipelines$Setoperationstatus, callback: BodyResponseCallback<Schema$Empty>): void;
setOperationStatus(callback: BodyResponseCallback<Schema$Empty>): void;
}
export interface Params$Resource$Pipelines$Create extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Request body metadata
*/
requestBody?: Schema$Pipeline;
}
export interface Params$Resource$Pipelines$Delete extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Caller must have WRITE access to the project in which this pipeline is defined.
*/
pipelineId?: string;
}
export interface Params$Resource$Pipelines$Get extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Caller must have READ access to the project in which this pipeline is defined.
*/
pipelineId?: string;
}
export interface Params$Resource$Pipelines$Getcontrollerconfig extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The operation to retrieve controller configuration for.
*/
operationId?: string;
/**
*
*/
validationToken?: string;
}
export interface Params$Resource$Pipelines$List extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Pipelines with names that match this prefix should be returned. If unspecified, all pipelines in the project, up to `pageSize`, will be returned.
*/
namePrefix?: string;
/**
* Number of pipelines to return at once. Defaults to 256, and max is 2048.
*/
pageSize?: number;
/**
* Token to use to indicate where to start getting results. If unspecified, returns the first page of results.
*/
pageToken?: string;
/**
* Required. The name of the project to search for pipelines. Caller must have READ access to this project.
*/
projectId?: string;
}
export interface Params$Resource$Pipelines$Run extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Request body metadata
*/
requestBody?: Schema$RunPipelineRequest;
}
export interface Params$Resource$Pipelines$Setoperationstatus extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Request body metadata
*/
requestBody?: Schema$SetOperationStatusRequest;
}
export {};
}