v2alpha1.d.ts
61.2 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
/// <reference types="node" />
import { OAuth2Client, JWT, Compute, UserRefreshClient, BaseExternalAccountClient, GaxiosPromise, GoogleConfigurable, MethodOptions, StreamMethodOptions, GlobalOptions, GoogleAuth, BodyResponseCallback, APIRequestContext } from 'googleapis-common';
import { Readable } from 'stream';
export declare namespace genomics_v2alpha1 {
export interface Options extends GlobalOptions {
version: 'v2alpha1';
}
interface StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient | BaseExternalAccountClient | GoogleAuth;
/**
* 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
* ```js
* const {google} = require('googleapis');
* const genomics = google.genomics('v2alpha1');
* ```
*/
export class Genomics {
context: APIRequestContext;
pipelines: Resource$Pipelines;
projects: Resource$Projects;
workers: Resource$Workers;
constructor(options: GlobalOptions, google?: GoogleConfigurable);
}
/**
* Carries information about an accelerator that can be attached to a VM.
*/
export interface Schema$Accelerator {
/**
* How many accelerators of this type to attach.
*/
count?: string | null;
/**
* The accelerator type string (for example, "nvidia-tesla-k80"). Only NVIDIA GPU accelerators are currently supported. If an NVIDIA GPU is attached, the required runtime libraries will be made available to all containers under `/usr/local/nvidia`. The driver version to install must be specified using the NVIDIA driver version parameter on the virtual machine specification. Note that attaching a GPU increases the worker VM startup time by a few minutes.
*/
type?: string | null;
}
/**
* Specifies a single action that runs a Docker container.
*/
export interface Schema$Action {
/**
* If specified, overrides the `CMD` specified in the container. If the container also has an `ENTRYPOINT` the values are used as entrypoint arguments. Otherwise, they are used as a command and arguments to run inside the container.
*/
commands?: string[] | null;
/**
* If the specified image is hosted on a private registry other than Google Container Registry, the credentials required to pull the image must be specified here as an encrypted secret. The secret must decrypt to a JSON-encoded dictionary containing both `username` and `password` keys.
*/
credentials?: Schema$Secret;
/**
* The encrypted environment to pass into the container. This environment is merged with values specified in the google.genomics.v2alpha1.Pipeline message, overwriting any duplicate values. The secret must decrypt to a JSON-encoded dictionary where key-value pairs serve as environment variable names and their values. The decoded environment variables can overwrite the values specified by the `environment` field.
*/
encryptedEnvironment?: Schema$Secret;
/**
* If specified, overrides the `ENTRYPOINT` specified in the container.
*/
entrypoint?: string | null;
/**
* The environment to pass into the container. This environment is merged with values specified in the google.genomics.v2alpha1.Pipeline message, overwriting any duplicate values. In addition to the values passed here, a few other values are automatically injected into the environment. These cannot be hidden or overwritten. `GOOGLE_PIPELINE_FAILED` will be set to "1" if the pipeline failed because an action has exited with a non-zero status (and did not have the `IGNORE_EXIT_STATUS` flag set). This can be used to determine if additional debug or logging actions should execute. `GOOGLE_LAST_EXIT_STATUS` will be set to the exit status of the last non-background action that executed. This can be used by workflow engine authors to determine whether an individual action has succeeded or failed.
*/
environment?: {
[key: string]: string;
} | null;
/**
* The set of flags to apply to this action.
*/
flags?: string[] | null;
/**
* Required. The URI to pull the container image from. Note that all images referenced by actions in the pipeline are pulled before the first action runs. If multiple actions reference the same image, it is only pulled once, ensuring that the same image is used for all actions in a single pipeline. The image URI can be either a complete host and image specification (e.g., quay.io/biocontainers/samtools), a library and image name (e.g., google/cloud-sdk) or a bare image name ('bash') to pull from the default library. No schema is required in any of these cases. If the specified image is not public, the service account specified for the Virtual Machine must have access to pull the images from GCR, or appropriate credentials must be specified in the google.genomics.v2alpha1.Action.credentials field.
*/
imageUri?: string | null;
/**
* Labels to associate with the action. This field is provided to assist workflow engine authors in identifying actions (for example, to indicate what sort of action they perform, such as localization or debugging). They are returned in the operation metadata, but are otherwise ignored.
*/
labels?: {
[key: string]: string;
} | null;
/**
* A list of mounts to make available to the action. In addition to the values specified here, every action has a special virtual disk mounted under `/google` that contains log files and other operational components. - /google/logs All logs written during the pipeline execution. - /google/logs/output The combined standard output and standard error of all actions run as part of the pipeline execution. - /google/logs/action/x/stdout The complete contents of each individual action's standard output. - /google/logs/action/x/stderr The complete contents of each individual action's standard error output.
*/
mounts?: Schema$Mount[];
/**
* An optional name for the container. The container hostname will be set to this name, making it useful for inter-container communication. The name must contain only upper and lowercase alphanumeric characters and hyphens and cannot start with a hyphen.
*/
name?: string | null;
/**
* An optional identifier for a PID namespace to run the action inside. Multiple actions should use the same string to share a namespace. If unspecified, a separate isolated namespace is used.
*/
pidNamespace?: string | null;
/**
* A map of containers to host port mappings for this container. If the container already specifies exposed ports, use the `PUBLISH_EXPOSED_PORTS` flag instead. The host port number must be less than 65536. If it is zero, an unused random port is assigned. To determine the resulting port number, consult the `ContainerStartedEvent` in the operation metadata.
*/
portMappings?: {
[key: string]: number;
} | null;
/**
* The maximum amount of time to give the action to complete. If the action fails to complete before the timeout, it will be terminated and the exit status will be non-zero. The pipeline will continue or terminate based on the rules defined by the `ALWAYS_RUN` and `IGNORE_EXIT_STATUS` flags.
*/
timeout?: string | null;
}
/**
* The request message for Operations.CancelOperation.
*/
export interface Schema$CancelOperationRequest {
}
/**
* The parameters to the CheckIn method.
*/
export interface Schema$CheckInRequest {
/**
* The deadline has expired and the worker needs more time.
*/
deadlineExpired?: Schema$Empty;
/**
* A workflow specific event occurred.
*/
event?: {
[key: string]: any;
} | null;
/**
* A list of timestamped events.
*/
events?: Schema$TimestampedEvent[];
/**
* The operation has finished with the given result.
*/
result?: Schema$Status;
/**
* An SOS report for an unexpected VM failure.
*/
sosReport?: string | null;
/**
* Data about the status of the worker VM.
*/
workerStatus?: Schema$WorkerStatus;
}
/**
* The response to the CheckIn method.
*/
export interface Schema$CheckInResponse {
/**
* The deadline by which the worker must request an extension. The backend will allow for network transmission time and other delays, but the worker must attempt to transmit the extension request no later than the deadline.
*/
deadline?: string | null;
/**
* Feature configuration for the operation.
*/
features?: {
[key: string]: any;
} | null;
/**
* The metadata that describes the operation assigned to the worker.
*/
metadata?: {
[key: string]: any;
} | 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;
}
/**
* 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;
}
/**
* Carries information about a disk that can be attached to a VM. See https://cloud.google.com/compute/docs/disks/performance for more information about disk type, size, and performance considerations. Specify either `Volume` or `Disk`, but not both.
*/
export interface Schema$Disk {
/**
* A user-supplied name for the disk. Used when mounting the disk into actions. The name must contain only upper and lowercase alphanumeric characters and hyphens and cannot start with a hyphen.
*/
name?: string | null;
/**
* The size, in GB, of the disk to attach. If the size is not specified, a default is chosen to ensure reasonable I/O performance. If the disk type is specified as `local-ssd`, multiple local drives are automatically combined to provide the requested size. Note, however, that each physical SSD is 375GB in size, and no more than 8 drives can be attached to a single instance.
*/
sizeGb?: number | null;
/**
* An optional image to put on the disk before attaching it to the VM.
*/
sourceImage?: string | null;
/**
* The Compute Engine disk type. If unspecified, `pd-standard` is used.
*/
type?: string | null;
}
/**
* The status of a disk on a VM.
*/
export interface Schema$DiskStatus {
/**
* Free disk space.
*/
freeSpaceBytes?: string | null;
/**
* Total disk space.
*/
totalSpaceBytes?: 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;
}
/**
* Configuration for an existing disk to be attached to the VM.
*/
export interface Schema$ExistingDisk {
/**
* If `disk` contains slashes, the Cloud Life Sciences API assumes that it is a complete URL for the disk. If `disk` does not contain slashes, the Cloud Life Sciences API assumes that the disk is a zonal disk and a URL will be generated of the form `zones//disks/`, where `` is the zone in which the instance is allocated. The disk must be ext4 formatted. If all `Mount` references to this disk have the `read_only` flag set to true, the disk will be attached in `read-only` mode and can be shared with other instances. Otherwise, the disk will be available for writing but cannot be shared.
*/
disk?: 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[];
}
/**
* Carries information about the pipeline execution that is returned in the long running operation's metadata field.
*/
export interface Schema$Metadata {
/**
* The time at which the operation was created by the API.
*/
createTime?: string | null;
/**
* The time at which execution was completed and resources were cleaned up.
*/
endTime?: string | null;
/**
* The list of events that have happened so far during the execution of this operation.
*/
events?: Schema$Event[];
/**
* The user-defined labels associated with this operation.
*/
labels?: {
[key: string]: string;
} | null;
/**
* The pipeline this operation represents.
*/
pipeline?: Schema$Pipeline;
/**
* The first time at which resources were allocated to execute the pipeline.
*/
startTime?: string | null;
}
/**
* Carries information about a particular disk mount inside a container.
*/
export interface Schema$Mount {
/**
* The name of the disk to mount, as specified in the resources section.
*/
disk?: string | null;
/**
* The path to mount the disk inside the container.
*/
path?: string | null;
/**
* If true, the disk is mounted read-only inside the container.
*/
readOnly?: boolean | null;
}
/**
* VM networking options.
*/
export interface Schema$Network {
/**
* The network name to attach the VM's network interface to. The value will be prefixed with `global/networks/` unless it contains a `/`, in which case it is assumed to be a fully specified network resource URL. If unspecified, the global default network is used.
*/
name?: string | null;
/**
* If the specified network is configured for custom subnet creation, the name of the subnetwork to attach the instance to must be specified here. The value is prefixed with `regions/x/subnetworks/` unless it contains a `/`, in which case it is assumed to be a fully specified subnetwork resource URL. If the `*` character appears in the value, it is replaced with the region that the virtual machine has been allocated in.
*/
subnetwork?: string | null;
/**
* If set to true, do not attach a public IP address to the VM. Note that without a public IP address, additional configuration is required to allow the VM to access Google services. See https://cloud.google.com/vpc/docs/configure-private-google-access for more information.
*/
usePrivateAddress?: boolean | null;
}
/**
* Configuration for an `NFSMount` to be attached to the VM.
*/
export interface Schema$NFSMount {
/**
* A target NFS mount. The target must be specified as `address:/mount".
*/
target?: 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;
}
/**
* Configuration for a persistent disk to be attached to the VM. See https://cloud.google.com/compute/docs/disks/performance for more information about disk type, size, and performance considerations.
*/
export interface Schema$PersistentDisk {
/**
* The size, in GB, of the disk to attach. If the size is not specified, a default is chosen to ensure reasonable I/O performance. If the disk type is specified as `local-ssd`, multiple local drives are automatically combined to provide the requested size. Note, however, that each physical SSD is 375GB in size, and no more than 8 drives can be attached to a single instance.
*/
sizeGb?: number | null;
/**
* An image to put on the disk before attaching it to the VM.
*/
sourceImage?: string | null;
/**
* The Compute Engine disk type. If unspecified, `pd-standard` is used.
*/
type?: string | null;
}
/**
* Specifies a series of actions to execute, expressed as Docker containers.
*/
export interface Schema$Pipeline {
/**
* The list of actions to execute, in the order they are specified.
*/
actions?: Schema$Action[];
/**
* The encrypted environment to pass into every action. Each action can also specify its own encrypted environment. The secret must decrypt to a JSON-encoded dictionary where key-value pairs serve as environment variable names and their values. The decoded environment variables can overwrite the values specified by the `environment` field.
*/
encryptedEnvironment?: Schema$Secret;
/**
* The environment to pass into every action. Each action can also specify additional environment variables but cannot delete an entry from this map (though they can overwrite it with a different value).
*/
environment?: {
[key: string]: string;
} | null;
/**
* The resources required for execution.
*/
resources?: Schema$Resources;
/**
* The maximum amount of time to give the pipeline to complete. This includes the time spent waiting for a worker to be allocated. If the pipeline fails to complete before the timeout, it will be cancelled and the error code will be set to DEADLINE_EXCEEDED. If unspecified, it will default to 7 days.
*/
timeout?: 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;
}
/**
* The system resources for the pipeline run. At least one zone or region must be specified or the pipeline run will fail.
*/
export interface Schema$Resources {
/**
* The project ID to allocate resources in.
*/
projectId?: string | null;
/**
* The list of regions allowed for VM allocation. If set, the `zones` field must not be set.
*/
regions?: string[] | null;
/**
* The virtual machine specification.
*/
virtualMachine?: Schema$VirtualMachine;
/**
* The list of zones allowed for VM allocation. If set, the `regions` field must not be set.
*/
zones?: string[] | null;
}
/**
* The arguments to the `RunPipeline` method. The requesting user must have the `iam.serviceAccounts.actAs` permission for the Cloud Genomics service account or the request will fail.
*/
export interface Schema$RunPipelineRequest {
/**
* User-defined labels to associate with the returned operation. These labels are not propagated to any Google Cloud Platform resources used by the operation, and can be modified at any time. To associate labels with resources created while executing the operation, see the appropriate resource message (for example, `VirtualMachine`).
*/
labels?: {
[key: string]: string;
} | null;
/**
* Required. The description of the pipeline to run.
*/
pipeline?: Schema$Pipeline;
/**
* The name of an existing Pub/Sub topic. The server will publish messages to this topic whenever the status of the operation changes. The Genomics Service Agent account must have publisher permissions to the specified topic or notifications will not be sent.
*/
pubSubTopic?: string | null;
}
/**
* The response to the RunPipeline method, returned in the operation's result field on success.
*/
export interface Schema$RunPipelineResponse {
}
/**
* Holds encrypted information that is only decrypted and stored in RAM by the worker VM when running the pipeline.
*/
export interface Schema$Secret {
/**
* The value of the cipherText response from the `encrypt` method. This field is intentionally unaudited.
*/
cipherText?: string | null;
/**
* The name of the Cloud KMS key that will be used to decrypt the secret value. The VM service account must have the required permissions and authentication scopes to invoke the `decrypt` method on the specified key.
*/
keyName?: string | null;
}
/**
* Carries information about a Google Cloud service account.
*/
export interface Schema$ServiceAccount {
/**
* Email address of the service account. If not specified, the default Compute Engine service account for the project will be used.
*/
email?: string | null;
/**
* List of scopes to be enabled for this service account on the VM, in addition to the cloud-platform API scope that will be added by default.
*/
scopes?: 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;
}
/**
* An event that occured in the operation assigned to the worker and the time of occurance.
*/
export interface Schema$TimestampedEvent {
/**
* The event data.
*/
data?: {
[key: string]: any;
} | null;
/**
* The time when the event happened.
*/
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;
}
/**
* Carries information about a Compute Engine VM resource.
*/
export interface Schema$VirtualMachine {
/**
* The list of accelerators to attach to the VM.
*/
accelerators?: Schema$Accelerator[];
/**
* The size of the boot disk, in GB. The boot disk must be large enough to accommodate all of the Docker images from each action in the pipeline at the same time. If not specified, a small but reasonable default value is used.
*/
bootDiskSizeGb?: number | null;
/**
* The host operating system image to use. Currently, only Container-Optimized OS images can be used. The default value is `projects/cos-cloud/global/images/family/cos-stable`, which selects the latest stable release of Container-Optimized OS. This option is provided to allow testing against the beta release of the operating system to ensure that the new version does not interact negatively with production pipelines. To test a pipeline against the beta release of Container-Optimized OS, use the value `projects/cos-cloud/global/images/family/cos-beta`.
*/
bootImage?: string | null;
/**
* The CPU platform to request. An instance based on a newer platform can be allocated, but never one with fewer capabilities. The value of this parameter must be a valid Compute Engine CPU platform name (such as "Intel Skylake"). This parameter is only useful for carefully optimized work loads where the CPU platform has a significant impact. For more information about the effect of this parameter, see https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform.
*/
cpuPlatform?: string | null;
/**
* The list of disks to create and attach to the VM. Specify either the `volumes[]` field or the `disks[]` field, but not both.
*/
disks?: Schema$Disk[];
/**
* The Compute Engine Disk Images to use as a Docker cache. The disks will be mounted into the Docker folder in a way that the images present in the cache will not need to be pulled. The digests of the cached images must match those of the tags used or the latest version will still be pulled. The root directory of the ext4 image must contain `image` and `overlay2` directories copied from the Docker directory of a VM where the desired Docker images have already been pulled. Any images pulled that are not cached will be stored on the first cache disk instead of the boot disk. Only a single image is supported.
*/
dockerCacheImages?: string[] | null;
/**
* Whether Stackdriver monitoring should be enabled on the VM.
*/
enableStackdriverMonitoring?: boolean | null;
/**
* Optional set of labels to apply to the VM and any attached disk resources. These labels must adhere to the [name and value restrictions](https://cloud.google.com/compute/docs/labeling-resources) on VM labels imposed by Compute Engine. Labels keys with the prefix 'google-' are reserved for use by Google. Labels applied at creation time to the VM. Applied on a best-effort basis to attached disk resources shortly after VM creation.
*/
labels?: {
[key: string]: string;
} | null;
/**
* Required. The machine type of the virtual machine to create. Must be the short name of a standard machine type (such as "n1-standard-1") or a custom machine type (such as "custom-1-4096", where "1" indicates the number of vCPUs and "4096" indicates the memory in MB). See [Creating an instance with a custom machine type](https://cloud.google.com/compute/docs/instances/creating-instance-with-custom-machine-type#create) for more specifications on creating a custom machine type.
*/
machineType?: string | null;
/**
* The VM network configuration.
*/
network?: Schema$Network;
/**
* The NVIDIA driver version to use when attaching an NVIDIA GPU accelerator. The version specified here must be compatible with the GPU libraries contained in the container being executed, and must be one of the drivers hosted in the `nvidia-drivers-us-public` bucket on Google Cloud Storage.
*/
nvidiaDriverVersion?: string | null;
/**
* If true, allocate a preemptible VM.
*/
preemptible?: boolean | null;
/**
* The service account to install on the VM. This account does not need any permissions other than those required by the pipeline.
*/
serviceAccount?: Schema$ServiceAccount;
/**
* The list of disks and other storage to create or attach to the VM. Specify either the `volumes[]` field or the `disks[]` field, but not both.
*/
volumes?: Schema$Volume[];
}
/**
* Carries information about storage that can be attached to a VM. Specify either `Volume` or `Disk`, but not both.
*/
export interface Schema$Volume {
/**
* Configuration for a existing disk.
*/
existingDisk?: Schema$ExistingDisk;
/**
* Configuration for an NFS mount.
*/
nfsMount?: Schema$NFSMount;
/**
* Configuration for a persistent disk.
*/
persistentDisk?: Schema$PersistentDisk;
/**
* A user-supplied name for the volume. Used when mounting the volume into `Actions`. The name must contain only upper and lowercase alphanumeric characters and hyphens and cannot start with a hyphen.
*/
volume?: string | 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;
}
/**
* The status of the worker VM.
*/
export interface Schema$WorkerStatus {
/**
* Status of attached disks.
*/
attachedDisks?: {
[key: string]: Schema$DiskStatus;
} | null;
/**
* Status of the boot disk.
*/
bootDisk?: Schema$DiskStatus;
/**
* Free RAM.
*/
freeRamBytes?: string | null;
/**
* Total RAM.
*/
totalRamBytes?: string | null;
/**
* System uptime.
*/
uptimeSeconds?: string | null;
}
export class Resource$Pipelines {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* Runs a pipeline. The returned Operation's metadata field will contain a google.genomics.v2alpha1.Metadata object describing the status of the pipeline execution. The [response] field will contain a google.genomics.v2alpha1.RunPipelineResponse object if the pipeline completes successfully. **Note:** Before you can use this method, the Genomics Service Agent must have access to your project. This is done automatically when the Cloud Genomics API is first enabled, but if you delete this permission, or if you enabled the Cloud Genomics API before the v2alpha1 API launch, you must disable and re-enable the API to grant the Genomics Service Agent the required permissions. Authorization requires the following [Google IAM](https://cloud.google.com/iam/) permission: * `genomics.operations.create` [1]: /genomics/gsa
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/genomics.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const genomics = google.genomics('v2alpha1');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: [
* 'https://www.googleapis.com/auth/cloud-platform',
* 'https://www.googleapis.com/auth/genomics',
* ],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await genomics.pipelines.run({
* // Request body metadata
* requestBody: {
* // request body parameters
* // {
* // "labels": {},
* // "pipeline": {},
* // "pubSubTopic": "my_pubSubTopic"
* // }
* },
* });
* console.log(res.data);
*
* // Example response
* // {
* // "done": false,
* // "error": {},
* // "metadata": {},
* // "name": "my_name",
* // "response": {}
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
run(params: Params$Resource$Pipelines$Run, options: StreamMethodOptions): GaxiosPromise<Readable>;
run(params?: Params$Resource$Pipelines$Run, options?: MethodOptions): GaxiosPromise<Schema$Operation>;
run(params: Params$Resource$Pipelines$Run, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
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;
}
export interface Params$Resource$Pipelines$Run extends StandardParameters {
/**
* Request body metadata
*/
requestBody?: Schema$RunPipelineRequest;
}
export class Resource$Projects {
context: APIRequestContext;
operations: Resource$Projects$Operations;
workers: Resource$Projects$Workers;
constructor(context: APIRequestContext);
}
export class Resource$Projects$Operations {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* 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
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/genomics.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const genomics = google.genomics('v2alpha1');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: [
* 'https://www.googleapis.com/auth/cloud-platform',
* 'https://www.googleapis.com/auth/genomics',
* ],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await genomics.projects.operations.cancel({
* // The name of the operation resource to be cancelled.
* name: 'projects/my-project/operations/my-operation',
*
* // Request body metadata
* requestBody: {
* // request body parameters
* // {}
* },
* });
* console.log(res.data);
*
* // Example response
* // {}
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
cancel(params: Params$Resource$Projects$Operations$Cancel, options: StreamMethodOptions): GaxiosPromise<Readable>;
cancel(params?: Params$Resource$Projects$Operations$Cancel, options?: MethodOptions): GaxiosPromise<Schema$Empty>;
cancel(params: Params$Resource$Projects$Operations$Cancel, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
cancel(params: Params$Resource$Projects$Operations$Cancel, options: MethodOptions | BodyResponseCallback<Schema$Empty>, callback: BodyResponseCallback<Schema$Empty>): void;
cancel(params: Params$Resource$Projects$Operations$Cancel, callback: BodyResponseCallback<Schema$Empty>): void;
cancel(callback: BodyResponseCallback<Schema$Empty>): void;
/**
* 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
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/genomics.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const genomics = google.genomics('v2alpha1');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: [
* 'https://www.googleapis.com/auth/cloud-platform',
* 'https://www.googleapis.com/auth/genomics',
* ],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await genomics.projects.operations.get({
* // The name of the operation resource.
* name: 'projects/my-project/operations/my-operation',
* });
* console.log(res.data);
*
* // Example response
* // {
* // "done": false,
* // "error": {},
* // "metadata": {},
* // "name": "my_name",
* // "response": {}
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
get(params: Params$Resource$Projects$Operations$Get, options: StreamMethodOptions): GaxiosPromise<Readable>;
get(params?: Params$Resource$Projects$Operations$Get, options?: MethodOptions): GaxiosPromise<Schema$Operation>;
get(params: Params$Resource$Projects$Operations$Get, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
get(params: Params$Resource$Projects$Operations$Get, options: MethodOptions | BodyResponseCallback<Schema$Operation>, callback: BodyResponseCallback<Schema$Operation>): void;
get(params: Params$Resource$Projects$Operations$Get, callback: BodyResponseCallback<Schema$Operation>): void;
get(callback: BodyResponseCallback<Schema$Operation>): void;
/**
* 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
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/genomics.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const genomics = google.genomics('v2alpha1');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: [
* 'https://www.googleapis.com/auth/cloud-platform',
* 'https://www.googleapis.com/auth/genomics',
* ],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await genomics.projects.operations.list({
* // 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. 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: 'placeholder-value',
* // The name of the operation's parent resource.
* name: 'projects/my-project/operations',
* // The maximum number of results to return. The maximum value is 256.
* pageSize: 'placeholder-value',
* // The standard list page token.
* pageToken: 'placeholder-value',
* });
* console.log(res.data);
*
* // Example response
* // {
* // "nextPageToken": "my_nextPageToken",
* // "operations": []
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
list(params: Params$Resource$Projects$Operations$List, options: StreamMethodOptions): GaxiosPromise<Readable>;
list(params?: Params$Resource$Projects$Operations$List, options?: MethodOptions): GaxiosPromise<Schema$ListOperationsResponse>;
list(params: Params$Resource$Projects$Operations$List, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
list(params: Params$Resource$Projects$Operations$List, options: MethodOptions | BodyResponseCallback<Schema$ListOperationsResponse>, callback: BodyResponseCallback<Schema$ListOperationsResponse>): void;
list(params: Params$Resource$Projects$Operations$List, callback: BodyResponseCallback<Schema$ListOperationsResponse>): void;
list(callback: BodyResponseCallback<Schema$ListOperationsResponse>): void;
}
export interface Params$Resource$Projects$Operations$Cancel extends StandardParameters {
/**
* The name of the operation resource to be cancelled.
*/
name?: string;
/**
* Request body metadata
*/
requestBody?: Schema$CancelOperationRequest;
}
export interface Params$Resource$Projects$Operations$Get extends StandardParameters {
/**
* The name of the operation resource.
*/
name?: string;
}
export interface Params$Resource$Projects$Operations$List extends StandardParameters {
/**
* 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. 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$Projects$Workers {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* The worker uses this method to retrieve the assigned operation and provide periodic status updates.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/genomics.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const genomics = google.genomics('v2alpha1');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: [
* 'https://www.googleapis.com/auth/cloud-platform',
* 'https://www.googleapis.com/auth/genomics',
* ],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await genomics.projects.workers.checkIn({
* // The VM identity token for authenticating the VM instance. https://cloud.google.com/compute/docs/instances/verifying-instance-identity
* id: 'projects/my-project/workers/my-worker',
*
* // Request body metadata
* requestBody: {
* // request body parameters
* // {
* // "deadlineExpired": {},
* // "event": {},
* // "events": [],
* // "result": {},
* // "sosReport": "my_sosReport",
* // "workerStatus": {}
* // }
* },
* });
* console.log(res.data);
*
* // Example response
* // {
* // "deadline": "my_deadline",
* // "features": {},
* // "metadata": {}
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
checkIn(params: Params$Resource$Projects$Workers$Checkin, options: StreamMethodOptions): GaxiosPromise<Readable>;
checkIn(params?: Params$Resource$Projects$Workers$Checkin, options?: MethodOptions): GaxiosPromise<Schema$CheckInResponse>;
checkIn(params: Params$Resource$Projects$Workers$Checkin, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
checkIn(params: Params$Resource$Projects$Workers$Checkin, options: MethodOptions | BodyResponseCallback<Schema$CheckInResponse>, callback: BodyResponseCallback<Schema$CheckInResponse>): void;
checkIn(params: Params$Resource$Projects$Workers$Checkin, callback: BodyResponseCallback<Schema$CheckInResponse>): void;
checkIn(callback: BodyResponseCallback<Schema$CheckInResponse>): void;
}
export interface Params$Resource$Projects$Workers$Checkin extends StandardParameters {
/**
* The VM identity token for authenticating the VM instance. https://cloud.google.com/compute/docs/instances/verifying-instance-identity
*/
id?: string;
/**
* Request body metadata
*/
requestBody?: Schema$CheckInRequest;
}
export class Resource$Workers {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* The worker uses this method to retrieve the assigned operation and provide periodic status updates.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/genomics.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const genomics = google.genomics('v2alpha1');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: [
* 'https://www.googleapis.com/auth/cloud-platform',
* 'https://www.googleapis.com/auth/genomics',
* ],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await genomics.workers.checkIn({
* // The VM identity token for authenticating the VM instance. https://cloud.google.com/compute/docs/instances/verifying-instance-identity
* id: 'placeholder-value',
*
* // Request body metadata
* requestBody: {
* // request body parameters
* // {
* // "deadlineExpired": {},
* // "event": {},
* // "events": [],
* // "result": {},
* // "sosReport": "my_sosReport",
* // "workerStatus": {}
* // }
* },
* });
* console.log(res.data);
*
* // Example response
* // {
* // "deadline": "my_deadline",
* // "features": {},
* // "metadata": {}
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
checkIn(params: Params$Resource$Workers$Checkin, options: StreamMethodOptions): GaxiosPromise<Readable>;
checkIn(params?: Params$Resource$Workers$Checkin, options?: MethodOptions): GaxiosPromise<Schema$CheckInResponse>;
checkIn(params: Params$Resource$Workers$Checkin, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
checkIn(params: Params$Resource$Workers$Checkin, options: MethodOptions | BodyResponseCallback<Schema$CheckInResponse>, callback: BodyResponseCallback<Schema$CheckInResponse>): void;
checkIn(params: Params$Resource$Workers$Checkin, callback: BodyResponseCallback<Schema$CheckInResponse>): void;
checkIn(callback: BodyResponseCallback<Schema$CheckInResponse>): void;
}
export interface Params$Resource$Workers$Checkin extends StandardParameters {
/**
* The VM identity token for authenticating the VM instance. https://cloud.google.com/compute/docs/instances/verifying-instance-identity
*/
id?: string;
/**
* Request body metadata
*/
requestBody?: Schema$CheckInRequest;
}
export {};
}