-
Notifications
You must be signed in to change notification settings - Fork 1.1k
/
genomics-gen.go
1410 lines (1231 loc) · 64.8 KB
/
genomics-gen.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
// Copyright 2021 Google LLC.
// Use of this source code is governed by a BSD-style
// license that can be found in the LICENSE file.
// Code generated file. DO NOT EDIT.
// Package genomics provides access to the Genomics API.
//
// For product documentation, see: https://cloud.google.com/genomics
//
// Creating a client
//
// Usage example:
//
// import "google.golang.org/api/genomics/v1"
// ...
// ctx := context.Background()
// genomicsService, err := genomics.NewService(ctx)
//
// In this example, Google Application Default Credentials are used for authentication.
//
// For information on how to create and obtain Application Default Credentials, see https://developers.google.com/identity/protocols/application-default-credentials.
//
// Other authentication options
//
// To use an API key for authentication (note: some APIs do not support API keys), use option.WithAPIKey:
//
// genomicsService, err := genomics.NewService(ctx, option.WithAPIKey("AIza..."))
//
// To use an OAuth token (e.g., a user token obtained via a three-legged OAuth flow), use option.WithTokenSource:
//
// config := &oauth2.Config{...}
// // ...
// token, err := config.Exchange(ctx, ...)
// genomicsService, err := genomics.NewService(ctx, option.WithTokenSource(config.TokenSource(ctx, token)))
//
// See https://godoc.org/google.golang.org/api/option/ for details on options.
package genomics // import "google.golang.org/api/genomics/v1"
import (
"bytes"
"context"
"encoding/json"
"errors"
"fmt"
"io"
"net/http"
"net/url"
"strconv"
"strings"
googleapi "google.golang.org/api/googleapi"
gensupport "google.golang.org/api/internal/gensupport"
option "google.golang.org/api/option"
internaloption "google.golang.org/api/option/internaloption"
htransport "google.golang.org/api/transport/http"
)
// Always reference these packages, just in case the auto-generated code
// below doesn't.
var _ = bytes.NewBuffer
var _ = strconv.Itoa
var _ = fmt.Sprintf
var _ = json.NewDecoder
var _ = io.Copy
var _ = url.Parse
var _ = gensupport.MarshalJSON
var _ = googleapi.Version
var _ = errors.New
var _ = strings.Replace
var _ = context.Canceled
var _ = internaloption.WithDefaultEndpoint
const apiId = "genomics:v1"
const apiName = "genomics"
const apiVersion = "v1"
const basePath = "https://genomics.googleapis.com/"
const mtlsBasePath = "https://genomics.mtls.googleapis.com/"
// NewService creates a new Service.
func NewService(ctx context.Context, opts ...option.ClientOption) (*Service, error) {
opts = append(opts, internaloption.WithDefaultEndpoint(basePath))
opts = append(opts, internaloption.WithDefaultMTLSEndpoint(mtlsBasePath))
client, endpoint, err := htransport.NewClient(ctx, opts...)
if err != nil {
return nil, err
}
s, err := New(client)
if err != nil {
return nil, err
}
if endpoint != "" {
s.BasePath = endpoint
}
return s, nil
}
// New creates a new Service. It uses the provided http.Client for requests.
//
// Deprecated: please use NewService instead.
// To provide a custom HTTP client, use option.WithHTTPClient.
// If you are using google.golang.org/api/googleapis/transport.APIKey, use option.WithAPIKey with NewService instead.
func New(client *http.Client) (*Service, error) {
if client == nil {
return nil, errors.New("client is nil")
}
s := &Service{client: client, BasePath: basePath}
return s, nil
}
type Service struct {
client *http.Client
BasePath string // API endpoint base URL
UserAgent string // optional additional User-Agent fragment
}
func (s *Service) userAgent() string {
if s.UserAgent == "" {
return googleapi.UserAgent
}
return googleapi.UserAgent + " " + s.UserAgent
}
// Accelerator: Carries information about an accelerator that can be
// attached to a VM.
type Accelerator struct {
// Count: How many accelerators of this type to attach.
Count int64 `json:"count,omitempty,string"`
// Type: 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 `json:"type,omitempty"`
// ForceSendFields is a list of field names (e.g. "Count") to
// unconditionally include in API requests. By default, fields with
// empty values are omitted from API requests. However, any non-pointer,
// non-interface field appearing in ForceSendFields will be sent to the
// server regardless of whether the field is empty or not. This may be
// used to include empty fields in Patch requests.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Count") to include in API
// requests with the JSON null value. By default, fields with empty
// values are omitted from API requests. However, any field with an
// empty value appearing in NullFields will be sent to the server as
// null. It is an error if a field in this list has a non-empty value.
// This may be used to include null fields in Patch requests.
NullFields []string `json:"-"`
}
func (s *Accelerator) MarshalJSON() ([]byte, error) {
type NoMethod Accelerator
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// Action: Specifies a single action that runs a Docker container.
type Action struct {
// Commands: 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 `json:"commands,omitempty"`
// Credentials: 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 *Secret `json:"credentials,omitempty"`
// EncryptedEnvironment: 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 *Secret `json:"encryptedEnvironment,omitempty"`
// Entrypoint: If specified, overrides the `ENTRYPOINT` specified in the
// container.
Entrypoint string `json:"entrypoint,omitempty"`
// Environment: 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 map[string]string `json:"environment,omitempty"`
// Flags: The set of flags to apply to this action.
//
// Possible values:
// "FLAG_UNSPECIFIED" - Unspecified flag.
// "IGNORE_EXIT_STATUS" - Normally, a non-zero exit status causes the
// pipeline to fail. This flag allows execution of other actions to
// continue instead.
// "RUN_IN_BACKGROUND" - This flag allows an action to continue
// running in the background while executing subsequent actions. This is
// useful to provide services to other actions (or to provide debugging
// support tools like SSH servers).
// "ALWAYS_RUN" - By default, after an action fails, no further
// actions are run. This flag indicates that this action must be run
// even if the pipeline has already failed. This is useful for actions
// that copy output files off of the VM or for debugging. Note that no
// actions will be run if image prefetching fails.
// "ENABLE_FUSE" - Enable access to the FUSE device for this action.
// Filesystems can then be mounted into disks shared with other actions.
// The other actions do not need the `ENABLE_FUSE` flag to access the
// mounted filesystem. This has the effect of causing the container to
// be executed with `CAP_SYS_ADMIN` and exposes `/dev/fuse` to the
// container, so use it only for containers you trust.
// "PUBLISH_EXPOSED_PORTS" - Exposes all ports specified by `EXPOSE`
// statements in the container. To discover the host side port numbers,
// consult the `ACTION_STARTED` event in the operation metadata.
// "DISABLE_IMAGE_PREFETCH" - All container images are typically
// downloaded before any actions are executed. This helps prevent typos
// in URIs or issues like lack of disk space from wasting large amounts
// of compute resources. If set, this flag prevents the worker from
// downloading the image until just before the action is executed.
// "DISABLE_STANDARD_ERROR_CAPTURE" - A small portion of the
// container's standard error stream is typically captured and returned
// inside the `ContainerStoppedEvent`. Setting this flag disables this
// functionality.
// "BLOCK_EXTERNAL_NETWORK" - Prevents the container from accessing
// the external network.
Flags []string `json:"flags,omitempty"`
// ImageUri: 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 `json:"imageUri,omitempty"`
// Labels: 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 map[string]string `json:"labels,omitempty"`
// Mounts: 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/*/stdout The complete contents of each
// individual action's standard output. - /google/logs/action/*/stderr
// The complete contents of each individual action's standard error
// output.
Mounts []*Mount `json:"mounts,omitempty"`
// Name: 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 `json:"name,omitempty"`
// PidNamespace: 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 `json:"pidNamespace,omitempty"`
// PortMappings: 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 map[string]int64 `json:"portMappings,omitempty"`
// Timeout: 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 `json:"timeout,omitempty"`
// ForceSendFields is a list of field names (e.g. "Commands") to
// unconditionally include in API requests. By default, fields with
// empty values are omitted from API requests. However, any non-pointer,
// non-interface field appearing in ForceSendFields will be sent to the
// server regardless of whether the field is empty or not. This may be
// used to include empty fields in Patch requests.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Commands") to include in
// API requests with the JSON null value. By default, fields with empty
// values are omitted from API requests. However, any field with an
// empty value appearing in NullFields will be sent to the server as
// null. It is an error if a field in this list has a non-empty value.
// This may be used to include null fields in Patch requests.
NullFields []string `json:"-"`
}
func (s *Action) MarshalJSON() ([]byte, error) {
type NoMethod Action
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// ContainerKilledEvent: 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.
type ContainerKilledEvent struct {
// ActionId: The numeric ID of the action that started the container.
ActionId int64 `json:"actionId,omitempty"`
// ForceSendFields is a list of field names (e.g. "ActionId") to
// unconditionally include in API requests. By default, fields with
// empty values are omitted from API requests. However, any non-pointer,
// non-interface field appearing in ForceSendFields will be sent to the
// server regardless of whether the field is empty or not. This may be
// used to include empty fields in Patch requests.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "ActionId") to include in
// API requests with the JSON null value. By default, fields with empty
// values are omitted from API requests. However, any field with an
// empty value appearing in NullFields will be sent to the server as
// null. It is an error if a field in this list has a non-empty value.
// This may be used to include null fields in Patch requests.
NullFields []string `json:"-"`
}
func (s *ContainerKilledEvent) MarshalJSON() ([]byte, error) {
type NoMethod ContainerKilledEvent
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// ContainerStartedEvent: An event generated when a container starts.
type ContainerStartedEvent struct {
// ActionId: The numeric ID of the action that started this container.
ActionId int64 `json:"actionId,omitempty"`
// IpAddress: 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 `json:"ipAddress,omitempty"`
// PortMappings: 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 map[string]int64 `json:"portMappings,omitempty"`
// ForceSendFields is a list of field names (e.g. "ActionId") to
// unconditionally include in API requests. By default, fields with
// empty values are omitted from API requests. However, any non-pointer,
// non-interface field appearing in ForceSendFields will be sent to the
// server regardless of whether the field is empty or not. This may be
// used to include empty fields in Patch requests.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "ActionId") to include in
// API requests with the JSON null value. By default, fields with empty
// values are omitted from API requests. However, any field with an
// empty value appearing in NullFields will be sent to the server as
// null. It is an error if a field in this list has a non-empty value.
// This may be used to include null fields in Patch requests.
NullFields []string `json:"-"`
}
func (s *ContainerStartedEvent) MarshalJSON() ([]byte, error) {
type NoMethod ContainerStartedEvent
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// ContainerStoppedEvent: An event generated when a container exits.
type ContainerStoppedEvent struct {
// ActionId: The numeric ID of the action that started this container.
ActionId int64 `json:"actionId,omitempty"`
// ExitStatus: The exit status of the container.
ExitStatus int64 `json:"exitStatus,omitempty"`
// Stderr: 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 `json:"stderr,omitempty"`
// ForceSendFields is a list of field names (e.g. "ActionId") to
// unconditionally include in API requests. By default, fields with
// empty values are omitted from API requests. However, any non-pointer,
// non-interface field appearing in ForceSendFields will be sent to the
// server regardless of whether the field is empty or not. This may be
// used to include empty fields in Patch requests.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "ActionId") to include in
// API requests with the JSON null value. By default, fields with empty
// values are omitted from API requests. However, any field with an
// empty value appearing in NullFields will be sent to the server as
// null. It is an error if a field in this list has a non-empty value.
// This may be used to include null fields in Patch requests.
NullFields []string `json:"-"`
}
func (s *ContainerStoppedEvent) MarshalJSON() ([]byte, error) {
type NoMethod ContainerStoppedEvent
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// DelayedEvent: An event generated whenever a resource limitation or
// transient error delays execution of a pipeline that was otherwise
// ready to run.
type DelayedEvent struct {
// Cause: 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 `json:"cause,omitempty"`
// Metrics: 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 `json:"metrics,omitempty"`
// ForceSendFields is a list of field names (e.g. "Cause") to
// unconditionally include in API requests. By default, fields with
// empty values are omitted from API requests. However, any non-pointer,
// non-interface field appearing in ForceSendFields will be sent to the
// server regardless of whether the field is empty or not. This may be
// used to include empty fields in Patch requests.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Cause") to include in API
// requests with the JSON null value. By default, fields with empty
// values are omitted from API requests. However, any field with an
// empty value appearing in NullFields will be sent to the server as
// null. It is an error if a field in this list has a non-empty value.
// This may be used to include null fields in Patch requests.
NullFields []string `json:"-"`
}
func (s *DelayedEvent) MarshalJSON() ([]byte, error) {
type NoMethod DelayedEvent
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// Disk: 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.
type Disk struct {
// Name: 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 `json:"name,omitempty"`
// SizeGb: 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 int64 `json:"sizeGb,omitempty"`
// SourceImage: An optional image to put on the disk before attaching it
// to the VM.
SourceImage string `json:"sourceImage,omitempty"`
// Type: The Compute Engine disk type. If unspecified, `pd-standard` is
// used.
Type string `json:"type,omitempty"`
// ForceSendFields is a list of field names (e.g. "Name") to
// unconditionally include in API requests. By default, fields with
// empty values are omitted from API requests. However, any non-pointer,
// non-interface field appearing in ForceSendFields will be sent to the
// server regardless of whether the field is empty or not. This may be
// used to include empty fields in Patch requests.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Name") to include in API
// requests with the JSON null value. By default, fields with empty
// values are omitted from API requests. However, any field with an
// empty value appearing in NullFields will be sent to the server as
// null. It is an error if a field in this list has a non-empty value.
// This may be used to include null fields in Patch requests.
NullFields []string `json:"-"`
}
func (s *Disk) MarshalJSON() ([]byte, error) {
type NoMethod Disk
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// Event: Carries information about events that occur during pipeline
// execution.
type Event struct {
// Description: 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 `json:"description,omitempty"`
// Details: Machine-readable details about the event.
Details googleapi.RawMessage `json:"details,omitempty"`
// Timestamp: The time at which the event occurred.
Timestamp string `json:"timestamp,omitempty"`
// ForceSendFields is a list of field names (e.g. "Description") to
// unconditionally include in API requests. By default, fields with
// empty values are omitted from API requests. However, any non-pointer,
// non-interface field appearing in ForceSendFields will be sent to the
// server regardless of whether the field is empty or not. This may be
// used to include empty fields in Patch requests.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Description") to include
// in API requests with the JSON null value. By default, fields with
// empty values are omitted from API requests. However, any field with
// an empty value appearing in NullFields will be sent to the server as
// null. It is an error if a field in this list has a non-empty value.
// This may be used to include null fields in Patch requests.
NullFields []string `json:"-"`
}
func (s *Event) MarshalJSON() ([]byte, error) {
type NoMethod Event
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// ExistingDisk: Configuration for an existing disk to be attached to
// the VM.
type ExistingDisk struct {
// Disk: 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 `json:"disk,omitempty"`
// ForceSendFields is a list of field names (e.g. "Disk") to
// unconditionally include in API requests. By default, fields with
// empty values are omitted from API requests. However, any non-pointer,
// non-interface field appearing in ForceSendFields will be sent to the
// server regardless of whether the field is empty or not. This may be
// used to include empty fields in Patch requests.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Disk") to include in API
// requests with the JSON null value. By default, fields with empty
// values are omitted from API requests. However, any field with an
// empty value appearing in NullFields will be sent to the server as
// null. It is an error if a field in this list has a non-empty value.
// This may be used to include null fields in Patch requests.
NullFields []string `json:"-"`
}
func (s *ExistingDisk) MarshalJSON() ([]byte, error) {
type NoMethod ExistingDisk
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// FailedEvent: An event generated when the execution of a pipeline has
// failed. Note that other events can continue to occur after this
// event.
type FailedEvent struct {
// Cause: The human-readable description of the cause of the failure.
Cause string `json:"cause,omitempty"`
// Code: The Google standard error code that best describes this
// failure.
//
// Possible values:
// "OK" - Not an error; returned on success HTTP Mapping: 200 OK
// "CANCELLED" - The operation was cancelled, typically by the caller.
// HTTP Mapping: 499 Client Closed Request
// "UNKNOWN" - Unknown error. For example, this error may be returned
// when a `Status` value received from another address space belongs to
// an error space that is not known in this address space. Also errors
// raised by APIs that do not return enough error information may be
// converted to this error. HTTP Mapping: 500 Internal Server Error
// "INVALID_ARGUMENT" - The client specified an invalid argument. Note
// that this differs from `FAILED_PRECONDITION`. `INVALID_ARGUMENT`
// indicates arguments that are problematic regardless of the state of
// the system (e.g., a malformed file name). HTTP Mapping: 400 Bad
// Request
// "DEADLINE_EXCEEDED" - The deadline expired before the operation
// could complete. For operations that change the state of the system,
// this error may be returned even if the operation has completed
// successfully. For example, a successful response from a server could
// have been delayed long enough for the deadline to expire. HTTP
// Mapping: 504 Gateway Timeout
// "NOT_FOUND" - Some requested entity (e.g., file or directory) was
// not found. Note to server developers: if a request is denied for an
// entire class of users, such as gradual feature rollout or
// undocumented allowlist, `NOT_FOUND` may be used. If a request is
// denied for some users within a class of users, such as user-based
// access control, `PERMISSION_DENIED` must be used. HTTP Mapping: 404
// Not Found
// "ALREADY_EXISTS" - The entity that a client attempted to create
// (e.g., file or directory) already exists. HTTP Mapping: 409 Conflict
// "PERMISSION_DENIED" - The caller does not have permission to
// execute the specified operation. `PERMISSION_DENIED` must not be used
// for rejections caused by exhausting some resource (use
// `RESOURCE_EXHAUSTED` instead for those errors). `PERMISSION_DENIED`
// must not be used if the caller can not be identified (use
// `UNAUTHENTICATED` instead for those errors). This error code does not
// imply the request is valid or the requested entity exists or
// satisfies other pre-conditions. HTTP Mapping: 403 Forbidden
// "UNAUTHENTICATED" - The request does not have valid authentication
// credentials for the operation. HTTP Mapping: 401 Unauthorized
// "RESOURCE_EXHAUSTED" - Some resource has been exhausted, perhaps a
// per-user quota, or perhaps the entire file system is out of space.
// HTTP Mapping: 429 Too Many Requests
// "FAILED_PRECONDITION" - The operation was rejected because the
// system is not in a state required for the operation's execution. For
// example, the directory to be deleted is non-empty, an rmdir operation
// is applied to a non-directory, etc. Service implementors can use the
// following guidelines to decide between `FAILED_PRECONDITION`,
// `ABORTED`, and `UNAVAILABLE`: (a) Use `UNAVAILABLE` if the client can
// retry just the failing call. (b) Use `ABORTED` if the client should
// retry at a higher level. For example, when a client-specified
// test-and-set fails, indicating the client should restart a
// read-modify-write sequence. (c) Use `FAILED_PRECONDITION` if the
// client should not retry until the system state has been explicitly
// fixed. For example, if an "rmdir" fails because the directory is
// non-empty, `FAILED_PRECONDITION` should be returned since the client
// should not retry unless the files are deleted from the directory.
// HTTP Mapping: 400 Bad Request
// "ABORTED" - The operation was aborted, typically due to a
// concurrency issue such as a sequencer check failure or transaction
// abort. See the guidelines above for deciding between
// `FAILED_PRECONDITION`, `ABORTED`, and `UNAVAILABLE`. HTTP Mapping:
// 409 Conflict
// "OUT_OF_RANGE" - The operation was attempted past the valid range.
// E.g., seeking or reading past end-of-file. Unlike `INVALID_ARGUMENT`,
// this error indicates a problem that may be fixed if the system state
// changes. For example, a 32-bit file system will generate
// `INVALID_ARGUMENT` if asked to read at an offset that is not in the
// range [0,2^32-1], but it will generate `OUT_OF_RANGE` if asked to
// read from an offset past the current file size. There is a fair bit
// of overlap between `FAILED_PRECONDITION` and `OUT_OF_RANGE`. We
// recommend using `OUT_OF_RANGE` (the more specific error) when it
// applies so that callers who are iterating through a space can easily
// look for an `OUT_OF_RANGE` error to detect when they are done. HTTP
// Mapping: 400 Bad Request
// "UNIMPLEMENTED" - The operation is not implemented or is not
// supported/enabled in this service. HTTP Mapping: 501 Not Implemented
// "INTERNAL" - Internal errors. This means that some invariants
// expected by the underlying system have been broken. This error code
// is reserved for serious errors. HTTP Mapping: 500 Internal Server
// Error
// "UNAVAILABLE" - The service is currently unavailable. This is most
// likely a transient condition, which can be corrected by retrying with
// a backoff. Note that it is not always safe to retry non-idempotent
// operations. See the guidelines above for deciding between
// `FAILED_PRECONDITION`, `ABORTED`, and `UNAVAILABLE`. HTTP Mapping:
// 503 Service Unavailable
// "DATA_LOSS" - Unrecoverable data loss or corruption. HTTP Mapping:
// 500 Internal Server Error
Code string `json:"code,omitempty"`
// ForceSendFields is a list of field names (e.g. "Cause") to
// unconditionally include in API requests. By default, fields with
// empty values are omitted from API requests. However, any non-pointer,
// non-interface field appearing in ForceSendFields will be sent to the
// server regardless of whether the field is empty or not. This may be
// used to include empty fields in Patch requests.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Cause") to include in API
// requests with the JSON null value. By default, fields with empty
// values are omitted from API requests. However, any field with an
// empty value appearing in NullFields will be sent to the server as
// null. It is an error if a field in this list has a non-empty value.
// This may be used to include null fields in Patch requests.
NullFields []string `json:"-"`
}
func (s *FailedEvent) MarshalJSON() ([]byte, error) {
type NoMethod FailedEvent
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// Metadata: Carries information about the pipeline execution that is
// returned in the long running operation's metadata field.
type Metadata struct {
// CreateTime: The time at which the operation was created by the API.
CreateTime string `json:"createTime,omitempty"`
// EndTime: The time at which execution was completed and resources were
// cleaned up.
EndTime string `json:"endTime,omitempty"`
// Events: The list of events that have happened so far during the
// execution of this operation.
Events []*Event `json:"events,omitempty"`
// Labels: The user-defined labels associated with this operation.
Labels map[string]string `json:"labels,omitempty"`
// Pipeline: The pipeline this operation represents.
Pipeline *Pipeline `json:"pipeline,omitempty"`
// StartTime: The first time at which resources were allocated to
// execute the pipeline.
StartTime string `json:"startTime,omitempty"`
// ForceSendFields is a list of field names (e.g. "CreateTime") to
// unconditionally include in API requests. By default, fields with
// empty values are omitted from API requests. However, any non-pointer,
// non-interface field appearing in ForceSendFields will be sent to the
// server regardless of whether the field is empty or not. This may be
// used to include empty fields in Patch requests.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "CreateTime") to include in
// API requests with the JSON null value. By default, fields with empty
// values are omitted from API requests. However, any field with an
// empty value appearing in NullFields will be sent to the server as
// null. It is an error if a field in this list has a non-empty value.
// This may be used to include null fields in Patch requests.
NullFields []string `json:"-"`
}
func (s *Metadata) MarshalJSON() ([]byte, error) {
type NoMethod Metadata
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// Mount: Carries information about a particular disk mount inside a
// container.
type Mount struct {
// Disk: The name of the disk to mount, as specified in the resources
// section.
Disk string `json:"disk,omitempty"`
// Path: The path to mount the disk inside the container.
Path string `json:"path,omitempty"`
// ReadOnly: If true, the disk is mounted read-only inside the
// container.
ReadOnly bool `json:"readOnly,omitempty"`
// ForceSendFields is a list of field names (e.g. "Disk") to
// unconditionally include in API requests. By default, fields with
// empty values are omitted from API requests. However, any non-pointer,
// non-interface field appearing in ForceSendFields will be sent to the
// server regardless of whether the field is empty or not. This may be
// used to include empty fields in Patch requests.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Disk") to include in API
// requests with the JSON null value. By default, fields with empty
// values are omitted from API requests. However, any field with an
// empty value appearing in NullFields will be sent to the server as
// null. It is an error if a field in this list has a non-empty value.
// This may be used to include null fields in Patch requests.
NullFields []string `json:"-"`
}
func (s *Mount) MarshalJSON() ([]byte, error) {
type NoMethod Mount
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// NFSMount: Configuration for an `NFSMount` to be attached to the VM.
type NFSMount struct {
// Target: A target NFS mount. The target must be specified as
// `address:/mount".
Target string `json:"target,omitempty"`
// ForceSendFields is a list of field names (e.g. "Target") to
// unconditionally include in API requests. By default, fields with
// empty values are omitted from API requests. However, any non-pointer,
// non-interface field appearing in ForceSendFields will be sent to the
// server regardless of whether the field is empty or not. This may be
// used to include empty fields in Patch requests.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Target") to include in API
// requests with the JSON null value. By default, fields with empty
// values are omitted from API requests. However, any field with an
// empty value appearing in NullFields will be sent to the server as
// null. It is an error if a field in this list has a non-empty value.
// This may be used to include null fields in Patch requests.
NullFields []string `json:"-"`
}
func (s *NFSMount) MarshalJSON() ([]byte, error) {
type NoMethod NFSMount
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// Network: VM networking options.
type Network struct {
// Name: 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 `json:"name,omitempty"`
// Subnetwork: 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/*/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 `json:"subnetwork,omitempty"`
// UsePrivateAddress: 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 bool `json:"usePrivateAddress,omitempty"`
// ForceSendFields is a list of field names (e.g. "Name") to
// unconditionally include in API requests. By default, fields with
// empty values are omitted from API requests. However, any non-pointer,
// non-interface field appearing in ForceSendFields will be sent to the
// server regardless of whether the field is empty or not. This may be
// used to include empty fields in Patch requests.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Name") to include in API
// requests with the JSON null value. By default, fields with empty
// values are omitted from API requests. However, any field with an
// empty value appearing in NullFields will be sent to the server as
// null. It is an error if a field in this list has a non-empty value.
// This may be used to include null fields in Patch requests.
NullFields []string `json:"-"`
}
func (s *Network) MarshalJSON() ([]byte, error) {
type NoMethod Network
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// PersistentDisk: 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.
type PersistentDisk struct {
// SizeGb: 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 int64 `json:"sizeGb,omitempty"`
// SourceImage: An image to put on the disk before attaching it to the
// VM.
SourceImage string `json:"sourceImage,omitempty"`
// Type: The Compute Engine disk type. If unspecified, `pd-standard` is
// used.
Type string `json:"type,omitempty"`
// ForceSendFields is a list of field names (e.g. "SizeGb") to
// unconditionally include in API requests. By default, fields with
// empty values are omitted from API requests. However, any non-pointer,
// non-interface field appearing in ForceSendFields will be sent to the
// server regardless of whether the field is empty or not. This may be
// used to include empty fields in Patch requests.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "SizeGb") to include in API
// requests with the JSON null value. By default, fields with empty
// values are omitted from API requests. However, any field with an
// empty value appearing in NullFields will be sent to the server as
// null. It is an error if a field in this list has a non-empty value.
// This may be used to include null fields in Patch requests.
NullFields []string `json:"-"`
}
func (s *PersistentDisk) MarshalJSON() ([]byte, error) {
type NoMethod PersistentDisk
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// Pipeline: Specifies a series of actions to execute, expressed as
// Docker containers.
type Pipeline struct {
// Actions: The list of actions to execute, in the order they are
// specified.
Actions []*Action `json:"actions,omitempty"`
// EncryptedEnvironment: 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 *Secret `json:"encryptedEnvironment,omitempty"`
// Environment: 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 map[string]string `json:"environment,omitempty"`
// Resources: The resources required for execution.
Resources *Resources `json:"resources,omitempty"`
// Timeout: 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 `json:"timeout,omitempty"`
// ForceSendFields is a list of field names (e.g. "Actions") to
// unconditionally include in API requests. By default, fields with
// empty values are omitted from API requests. However, any non-pointer,
// non-interface field appearing in ForceSendFields will be sent to the
// server regardless of whether the field is empty or not. This may be
// used to include empty fields in Patch requests.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Actions") to include in
// API requests with the JSON null value. By default, fields with empty
// values are omitted from API requests. However, any field with an
// empty value appearing in NullFields will be sent to the server as
// null. It is an error if a field in this list has a non-empty value.
// This may be used to include null fields in Patch requests.
NullFields []string `json:"-"`
}
func (s *Pipeline) MarshalJSON() ([]byte, error) {
type NoMethod Pipeline
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// PullStartedEvent: An event generated when the worker starts pulling
// an image.
type PullStartedEvent struct {
// ImageUri: The URI of the image that was pulled.
ImageUri string `json:"imageUri,omitempty"`
// ForceSendFields is a list of field names (e.g. "ImageUri") to
// unconditionally include in API requests. By default, fields with
// empty values are omitted from API requests. However, any non-pointer,
// non-interface field appearing in ForceSendFields will be sent to the
// server regardless of whether the field is empty or not. This may be
// used to include empty fields in Patch requests.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "ImageUri") to include in
// API requests with the JSON null value. By default, fields with empty
// values are omitted from API requests. However, any field with an
// empty value appearing in NullFields will be sent to the server as
// null. It is an error if a field in this list has a non-empty value.
// This may be used to include null fields in Patch requests.
NullFields []string `json:"-"`
}