/
genomics-gen.go
2357 lines (2097 loc) · 85.7 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
// Package genomics provides access to the Genomics API.
//
// See https://cloud.google.com/genomics/
//
// Usage example:
//
// import "google.golang.org/api/genomics/v1alpha2"
// ...
// genomicsService, err := genomics.New(oauthHttpClient)
package genomics // import "google.golang.org/api/genomics/v1alpha2"
import (
"bytes"
"encoding/json"
"errors"
"fmt"
context "golang.org/x/net/context"
ctxhttp "golang.org/x/net/context/ctxhttp"
gensupport "google.golang.org/api/gensupport"
googleapi "google.golang.org/api/googleapi"
"io"
"net/http"
"net/url"
"strconv"
"strings"
)
// 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 _ = ctxhttp.Do
const apiId = "genomics:v1alpha2"
const apiName = "genomics"
const apiVersion = "v1alpha2"
const basePath = "https://genomics.googleapis.com/"
// OAuth2 scopes used by this API.
const (
// View and manage your data across Google Cloud Platform services
CloudPlatformScope = "https://www.googleapis.com/auth/cloud-platform"
// View and manage your Google Compute Engine resources
ComputeScope = "https://www.googleapis.com/auth/compute"
// View and manage Genomics data
GenomicsScope = "https://www.googleapis.com/auth/genomics"
)
func New(client *http.Client) (*Service, error) {
if client == nil {
return nil, errors.New("client is nil")
}
s := &Service{client: client, BasePath: basePath}
s.Operations = NewOperationsService(s)
s.Pipelines = NewPipelinesService(s)
return s, nil
}
type Service struct {
client *http.Client
BasePath string // API endpoint base URL
UserAgent string // optional additional User-Agent fragment
Operations *OperationsService
Pipelines *PipelinesService
}
func (s *Service) userAgent() string {
if s.UserAgent == "" {
return googleapi.UserAgent
}
return googleapi.UserAgent + " " + s.UserAgent
}
func NewOperationsService(s *Service) *OperationsService {
rs := &OperationsService{s: s}
return rs
}
type OperationsService struct {
s *Service
}
func NewPipelinesService(s *Service) *PipelinesService {
rs := &PipelinesService{s: s}
return rs
}
type PipelinesService struct {
s *Service
}
// CancelOperationRequest: The request message for
// Operations.CancelOperation.
type CancelOperationRequest struct {
}
// ComputeEngine: Describes a Compute Engine resource that is being
// managed by a running pipeline.
type ComputeEngine struct {
// DiskNames: The names of the disks that were created for this
// pipeline.
DiskNames []string `json:"diskNames,omitempty"`
// InstanceName: The instance on which the operation is running.
InstanceName string `json:"instanceName,omitempty"`
// MachineType: The machine type of the instance.
MachineType string `json:"machineType,omitempty"`
// Zone: The availability zone in which the instance resides.
Zone string `json:"zone,omitempty"`
// ForceSendFields is a list of field names (e.g. "DiskNames") 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:"-"`
}
func (s *ComputeEngine) MarshalJSON() ([]byte, error) {
type noMethod ComputeEngine
raw := noMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields)
}
// ControllerConfig: Stores the information that the controller will
// fetch from the server in order to run. Should only be used by VMs
// created by the Pipelines Service and not by end users.
type ControllerConfig struct {
Cmd string `json:"cmd,omitempty"`
Disks map[string]string `json:"disks,omitempty"`
GcsLogPath string `json:"gcsLogPath,omitempty"`
GcsSinks map[string]RepeatedString `json:"gcsSinks,omitempty"`
GcsSources map[string]RepeatedString `json:"gcsSources,omitempty"`
Image string `json:"image,omitempty"`
MachineType string `json:"machineType,omitempty"`
Vars map[string]string `json:"vars,omitempty"`
// ServerResponse contains the HTTP response code and headers from the
// server.
googleapi.ServerResponse `json:"-"`
// ForceSendFields is a list of field names (e.g. "Cmd") 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:"-"`
}
func (s *ControllerConfig) MarshalJSON() ([]byte, error) {
type noMethod ControllerConfig
raw := noMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields)
}
// Disk: A Google Compute Engine disk resource specification.
type Disk struct {
// AutoDelete: Specifies whether or not to delete the disk when the
// pipeline completes. This field is applicable only for newly created
// disks. See
// https://cloud.google.com/compute/docs/reference/latest/instances#resource for more details. By default, `autoDelete` is `false`. `autoDelete` will be enabled if set to `true` at create time or run
// time.
AutoDelete bool `json:"autoDelete,omitempty"`
// MountPoint: Required at create time and cannot be overridden at run
// time. Specifies the path in the docker container where files on this
// disk should be located. For example, if `mountPoint` is `/mnt/disk`,
// and the parameter has `localPath` `inputs/file.txt`, the docker
// container can access the data at `/mnt/disk/inputs/file.txt`.
MountPoint string `json:"mountPoint,omitempty"`
// Name: Required. The name of the disk that can be used in the pipeline
// parameters. Must be 1 - 63 characters. The name "boot" is reserved
// for system use.
Name string `json:"name,omitempty"`
// ReadOnly: Specifies how a sourced-base persistent disk will be
// mounted. See
// https://cloud.google.com/compute/docs/disks/persistent-disks#use_multi_instances for more details. Can only be set at create
// time.
ReadOnly bool `json:"readOnly,omitempty"`
// SizeGb: The size of the disk. Defaults to 500 (GB). This field is not
// applicable for local SSD.
SizeGb int64 `json:"sizeGb,omitempty"`
// Source: The full or partial URL of the persistent disk to attach. See
// https://cloud.google.com/compute/docs/reference/latest/instances#resource and https://cloud.google.com/compute/docs/disks/persistent-disks#snapshots for more
// details.
Source string `json:"source,omitempty"`
// Type: Required. The type of the disk to create.
//
// Possible values:
// "TYPE_UNSPECIFIED"
// "PERSISTENT_HDD"
// "PERSISTENT_SSD"
// "LOCAL_SSD"
Type string `json:"type,omitempty"`
// ForceSendFields is a list of field names (e.g. "AutoDelete") 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:"-"`
}
func (s *Disk) MarshalJSON() ([]byte, error) {
type noMethod Disk
raw := noMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields)
}
// DockerExecutor: The Docker execuctor specification.
type DockerExecutor struct {
// Cmd: Required. The command string to run. Parameters that do not have
// `localCopy` specified should be used as environment variables, while
// those that do can be accessed at the defined paths.
Cmd string `json:"cmd,omitempty"`
// ImageName: Required. Image name from either Docker Hub or Google
// Container Repository. Users that run pipelines must have READ access
// to the image.
ImageName string `json:"imageName,omitempty"`
// ForceSendFields is a list of field names (e.g. "Cmd") 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:"-"`
}
func (s *DockerExecutor) MarshalJSON() ([]byte, error) {
type noMethod DockerExecutor
raw := noMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields)
}
// Empty: 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 `{}`.
type Empty struct {
// ServerResponse contains the HTTP response code and headers from the
// server.
googleapi.ServerResponse `json:"-"`
}
// ImportReadGroupSetsResponse: The read group set import response.
type ImportReadGroupSetsResponse struct {
// ReadGroupSetIds: IDs of the read group sets that were created.
ReadGroupSetIds []string `json:"readGroupSetIds,omitempty"`
// ForceSendFields is a list of field names (e.g. "ReadGroupSetIds") 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:"-"`
}
func (s *ImportReadGroupSetsResponse) MarshalJSON() ([]byte, error) {
type noMethod ImportReadGroupSetsResponse
raw := noMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields)
}
// ImportVariantsResponse: The variant data import response.
type ImportVariantsResponse struct {
// CallSetIds: IDs of the call sets created during the import.
CallSetIds []string `json:"callSetIds,omitempty"`
// ForceSendFields is a list of field names (e.g. "CallSetIds") 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:"-"`
}
func (s *ImportVariantsResponse) MarshalJSON() ([]byte, error) {
type noMethod ImportVariantsResponse
raw := noMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields)
}
// ListOperationsResponse: The response message for
// Operations.ListOperations.
type ListOperationsResponse struct {
// NextPageToken: The standard List next-page token.
NextPageToken string `json:"nextPageToken,omitempty"`
// Operations: A list of operations that matches the specified filter in
// the request.
Operations []*Operation `json:"operations,omitempty"`
// ServerResponse contains the HTTP response code and headers from the
// server.
googleapi.ServerResponse `json:"-"`
// ForceSendFields is a list of field names (e.g. "NextPageToken") 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:"-"`
}
func (s *ListOperationsResponse) MarshalJSON() ([]byte, error) {
type noMethod ListOperationsResponse
raw := noMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields)
}
// ListPipelinesResponse: The response of ListPipelines. Contains at
// most `pageSize` pipelines. If it contains `pageSize` pipelines, and
// more pipelines exist, then `nextPageToken` will be populated and
// should be used as the `pageToken` argument to a subsequent
// ListPipelines request.
type ListPipelinesResponse struct {
// NextPageToken: The token to use to get the next page of results.
NextPageToken string `json:"nextPageToken,omitempty"`
// Pipelines: The matched pipelines.
Pipelines []*Pipeline `json:"pipelines,omitempty"`
// ServerResponse contains the HTTP response code and headers from the
// server.
googleapi.ServerResponse `json:"-"`
// ForceSendFields is a list of field names (e.g. "NextPageToken") 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:"-"`
}
func (s *ListPipelinesResponse) MarshalJSON() ([]byte, error) {
type noMethod ListPipelinesResponse
raw := noMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields)
}
// LocalCopy: LocalCopy defines how a remote file should be copied to
// and from the VM.
type LocalCopy struct {
// Disk: Required. The name of the disk where this parameter is located.
// Can be the name of one of the disks specified in the Resources field,
// or "boot", which represents the Docker instance's boot disk and has a
// mount point of `/`.
Disk string `json:"disk,omitempty"`
// Path: Required. The path within the user's docker container where
// this input should be localized to and from, relative to the specified
// disk's mount point. For example: file.txt,
Path string `json:"path,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:"-"`
}
func (s *LocalCopy) MarshalJSON() ([]byte, error) {
type noMethod LocalCopy
raw := noMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields)
}
// LoggingOptions: The logging options for the pipeline run.
type LoggingOptions struct {
// GcsPath: The location in Google Cloud Storage to which the pipeline
// logs will be copied. Can be specified as a fully qualified directory
// path, in which case logs will be output with a unique identifier as
// the filename in that directory, or as a fully specified path, which
// must end in `.log`, in which case that path will be used, and the
// user must ensure that logs are not overwritten. Stdout and stderr
// logs from the run are also generated and output as `-stdout.log` and
// `-stderr.log`.
GcsPath string `json:"gcsPath,omitempty"`
// ForceSendFields is a list of field names (e.g. "GcsPath") 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:"-"`
}
func (s *LoggingOptions) MarshalJSON() ([]byte, error) {
type noMethod LoggingOptions
raw := noMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields)
}
// Operation: This resource represents a long-running operation that is
// the result of a network API call.
type Operation struct {
// Done: 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 bool `json:"done,omitempty"`
// Error: The error result of the operation in case of failure.
Error *Status `json:"error,omitempty"`
// Metadata: An OperationMetadata object. This will always be returned
// with the Operation.
Metadata OperationMetadata `json:"metadata,omitempty"`
// Name: The server-assigned name, which is only unique within the same
// service that originally returns it. For example:
// `operations/CJHU7Oi_ChDrveSpBRjfuL-qzoWAgEw`
Name string `json:"name,omitempty"`
// Response: If importing ReadGroupSets, an ImportReadGroupSetsResponse
// is returned. If importing Variants, an ImportVariantsResponse is
// returned. For exports, an empty response is returned.
Response OperationResponse `json:"response,omitempty"`
// ServerResponse contains the HTTP response code and headers from the
// server.
googleapi.ServerResponse `json:"-"`
// ForceSendFields is a list of field names (e.g. "Done") 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:"-"`
}
func (s *Operation) MarshalJSON() ([]byte, error) {
type noMethod Operation
raw := noMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields)
}
type OperationMetadata interface{}
type OperationResponse interface{}
// OperationEvent: An event that occurred during an Operation.
type OperationEvent struct {
// Description: Required description of event.
Description string `json:"description,omitempty"`
// EndTime: Optional time of when event finished. An event can have a
// start time and no finish time. If an event has a finish time, there
// must be a start time.
EndTime string `json:"endTime,omitempty"`
// StartTime: Optional time of when event started.
StartTime string `json:"startTime,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:"-"`
}
func (s *OperationEvent) MarshalJSON() ([]byte, error) {
type noMethod OperationEvent
raw := noMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields)
}
// OperationMetadata1: Metadata describing an Operation.
type OperationMetadata1 struct {
// ClientId: Optionally provided by the caller when submitting the
// request that creates the operation.
ClientId string `json:"clientId,omitempty"`
// CreateTime: The time at which the job was submitted to the Genomics
// service.
CreateTime string `json:"createTime,omitempty"`
// EndTime: The time at which the job stopped running.
EndTime string `json:"endTime,omitempty"`
// Events: Optional event messages that were generated during the job's
// execution. This also contains any warnings that were generated during
// import or export.
Events []*OperationEvent `json:"events,omitempty"`
// ProjectId: The Google Cloud Project in which the job is scoped.
ProjectId string `json:"projectId,omitempty"`
// Request: The original request that started the operation. Note that
// this will be in current version of the API. If the operation was
// started with v1beta2 API and a GetOperation is performed on v1 API, a
// v1 request will be returned.
Request OperationMetadataRequest `json:"request,omitempty"`
// RuntimeMetadata: Runtime metadata on this Operation.
RuntimeMetadata OperationMetadataRuntimeMetadata `json:"runtimeMetadata,omitempty"`
// StartTime: The time at which the job began to run.
StartTime string `json:"startTime,omitempty"`
// ForceSendFields is a list of field names (e.g. "ClientId") 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:"-"`
}
func (s *OperationMetadata1) MarshalJSON() ([]byte, error) {
type noMethod OperationMetadata1
raw := noMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields)
}
type OperationMetadataRequest interface{}
type OperationMetadataRuntimeMetadata interface{}
// Pipeline: The pipeline object. Represents a transformation from a set
// of input parameters to a set of output parameters. The transformation
// is defined as a docker image and command to run within that image.
// Each pipeline is run on a Google Compute Engine VM. A pipeline can be
// created with the `create` method and then later run with the `run`
// method, or a pipeline can be defined and run all at once with the
// `run` method.
type Pipeline struct {
// Description: User-specified description.
Description string `json:"description,omitempty"`
// Docker: Specifies the docker run information.
Docker *DockerExecutor `json:"docker,omitempty"`
// InputParameters: Input parameters of the pipeline.
InputParameters []*PipelineParameter `json:"inputParameters,omitempty"`
// Name: Required. A user specified pipeline name that does not have to
// be unique. This name can be used for filtering Pipelines in
// ListPipelines.
Name string `json:"name,omitempty"`
// OutputParameters: Output parameters of the pipeline.
OutputParameters []*PipelineParameter `json:"outputParameters,omitempty"`
// PipelineId: Unique pipeline id that is generated by the service when
// CreatePipeline is called. Cannot be specified in the Pipeline used in
// the CreatePipelineRequest, and will be populated in the response to
// CreatePipeline and all subsequent Get and List calls. Indicates that
// the service has registered this pipeline.
PipelineId string `json:"pipelineId,omitempty"`
// ProjectId: Required. The project in which to create the pipeline. The
// caller must have WRITE access.
ProjectId string `json:"projectId,omitempty"`
// Resources: Required. Specifies resource requirements for the pipeline
// run. Required fields: * minimumCpuCores * minimumRamGb
Resources *PipelineResources `json:"resources,omitempty"`
// ServerResponse contains the HTTP response code and headers from the
// server.
googleapi.ServerResponse `json:"-"`
// 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:"-"`
}
func (s *Pipeline) MarshalJSON() ([]byte, error) {
type noMethod Pipeline
raw := noMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields)
}
// PipelineParameter: Parameters facilitate setting and delivering data
// into the pipeline's execution environment. They are defined at create
// time, with optional defaults, and can be overridden at run time. If
// `localCopy` is unset, then the parameter specifies a string that is
// passed as-is into the pipeline, as the value of the environment
// variable with the given name. A default value can be optionally
// specified at create time. The default can be overridden at run time
// using the inputs map. If no default is given, a value must be
// supplied at runtime. If `localCopy` is defined, then the parameter
// specifies a data source or sink, both in Google Cloud Storage and on
// the Docker container where the pipeline computation is run. The
// service account associated with the Pipeline (by default the
// project's Compute Engine service account) must have access to the
// Google Cloud Storage paths. At run time, the Google Cloud Storage
// paths can be overridden if a default was provided at create time, or
// must be set otherwise. The pipeline runner should add a key/value
// pair to either the inputs or outputs map. The indicated data copies
// will be carried out before/after pipeline execution, just as if the
// corresponding arguments were provided to `gsutil cp`. For example:
// Given the following `PipelineParameter`, specified in the
// `inputParameters` list: ``` {name: "input_file", localCopy: {path:
// "file.txt", disk: "pd1"}} ``` where `disk` is defined in the
// `PipelineResources` object as: ``` {name: "pd1", mountPoint:
// "/mnt/disk/"} ``` We create a disk named `pd1`, mount it on the host
// VM, and map `/mnt/pd1` to `/mnt/disk` in the docker container. At
// runtime, an entry for `input_file` would be required in the inputs
// map, such as: ``` inputs["input_file"] = "gs://my-bucket/bar.txt" ```
// This would generate the following gsutil call: ``` gsutil cp
// gs://my-bucket/bar.txt /mnt/pd1/file.txt ``` The file
// `/mnt/pd1/file.txt` maps to `/mnt/disk/file.txt` in the Docker
// container. Acceptable paths are: Google Cloud storage pathLocal
// path filefile globdirectory For outputs, the direction of the
// copy is reversed: ``` gsutil cp /mnt/disk/file.txt
// gs://my-bucket/bar.txt ``` Acceptable paths are: Local pathGoogle
// Cloud Storage path filefile file directory - directory must
// already exist glob directory - directory will be created if it
// doesn't exist One restriction due to docker limitations, is that
// for outputs that are found on the boot disk, the local path cannot be
// a glob and must be a file.
type PipelineParameter struct {
// DefaultValue: The default value for this parameter. Can be overridden
// at runtime. If `localCopy` is present, then this must be a Google
// Cloud Storage path beginning with `gs://`.
DefaultValue string `json:"defaultValue,omitempty"`
// Description: Human-readable description.
Description string `json:"description,omitempty"`
// LocalCopy: If present, this parameter is marked for copying to and
// from the VM. `LocalCopy` indicates where on the VM the file should
// be. The value given to this parameter (either at runtime or using
// `defaultValue`) must be the remote path where the file should be.
LocalCopy *LocalCopy `json:"localCopy,omitempty"`
// Name: Required. Name of the parameter - the pipeline runner uses this
// string as the key to the input and output maps in RunPipeline.
Name string `json:"name,omitempty"`
// ForceSendFields is a list of field names (e.g. "DefaultValue") 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:"-"`
}
func (s *PipelineParameter) MarshalJSON() ([]byte, error) {
type noMethod PipelineParameter
raw := noMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields)
}
// PipelineResources: The system resources for the pipeline run.
type PipelineResources struct {
// BootDiskSizeGb: The size of the boot disk. Defaults to 10 (GB).
BootDiskSizeGb int64 `json:"bootDiskSizeGb,omitempty"`
// Disks: Disks to attach.
Disks []*Disk `json:"disks,omitempty"`
// MinimumCpuCores: The minimum number of cores to use. Defaults to 1.
MinimumCpuCores int64 `json:"minimumCpuCores,omitempty"`
// MinimumRamGb: The minimum amount of RAM to use. Defaults to 3.75 (GB)
MinimumRamGb float64 `json:"minimumRamGb,omitempty"`
// Preemptible: At create time means that preemptible machines may be
// used for the run. At run time, means they should be used. Cannot be
// true at run time if false at create time. Defaults to `false`.
Preemptible bool `json:"preemptible,omitempty"`
// Zones: List of Google Compute Engine availability zones to which
// resource creation will restricted. If empty, any zone may be chosen.
Zones []string `json:"zones,omitempty"`
// ForceSendFields is a list of field names (e.g. "BootDiskSizeGb") 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:"-"`
}
func (s *PipelineResources) MarshalJSON() ([]byte, error) {
type noMethod PipelineResources
raw := noMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields)
}
type RepeatedString struct {
Values []string `json:"values,omitempty"`
// ForceSendFields is a list of field names (e.g. "Values") 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:"-"`
}
func (s *RepeatedString) MarshalJSON() ([]byte, error) {
type noMethod RepeatedString
raw := noMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields)
}
// RunPipelineArgs: The pipeline run arguments.
type RunPipelineArgs struct {
// ClientId: Client-specified pipeline operation identifier.
ClientId string `json:"clientId,omitempty"`
// Inputs: Pipeline input arguments; keys are defined in the pipeline
// documentation. All input parameters that do not have default values
// must be specified. If parameters with defaults are specified here,
// the defaults will be overridden.
Inputs map[string]string `json:"inputs,omitempty"`
// KeepVmAliveOnFailureDuration: How long to keep the VM up after a
// failure (for example docker command failed, copying input or output
// files failed, etc). While the VM is up, one can ssh into the VM to
// debug. Default is 0; maximum allowed value is 1 day.
KeepVmAliveOnFailureDuration string `json:"keepVmAliveOnFailureDuration,omitempty"`
// Logging: Required. Logging options. Used by the service to
// communicate results to the user.
Logging *LoggingOptions `json:"logging,omitempty"`
// Outputs: Pipeline output arguments; keys are defined in the pipeline
// documentation. All output parameters of without default values must
// be specified. If parameters with defaults are specified here, the
// defaults will be overridden.
Outputs map[string]string `json:"outputs,omitempty"`
// ProjectId: Required. The project in which to run the pipeline. The
// caller must have WRITER access to all Google Cloud services and
// resources (e.g. Google Compute Engine) will be used.
ProjectId string `json:"projectId,omitempty"`
// Resources: Specifies resource requirements/overrides for the pipeline
// run.
Resources *PipelineResources `json:"resources,omitempty"`
// ServiceAccount: The Google Cloud Service Account that will be used to
// access data and services. By default, the compute service account
// associated with `projectId` is used.
ServiceAccount *ServiceAccount `json:"serviceAccount,omitempty"`
// ForceSendFields is a list of field names (e.g. "ClientId") 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:"-"`
}
func (s *RunPipelineArgs) MarshalJSON() ([]byte, error) {
type noMethod RunPipelineArgs
raw := noMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields)
}
// RunPipelineRequest: The request to run a pipeline. If `pipelineId` is
// specified, it refers to a saved pipeline created with CreatePipeline
// and set as the `pipelineId` of the returned Pipeline object. If
// `ephemeralPipeline` is specified, that pipeline is run once with the
// given args and not saved. It is an error to specify both `pipelineId`
// and `ephemeralPipeline`. `pipelineArgs` must be specified.
type RunPipelineRequest struct {
// EphemeralPipeline: A new pipeline object to run once and then delete.
EphemeralPipeline *Pipeline `json:"ephemeralPipeline,omitempty"`
// PipelineArgs: The arguments to use when running this pipeline.
PipelineArgs *RunPipelineArgs `json:"pipelineArgs,omitempty"`
// PipelineId: The already created pipeline to run.
PipelineId string `json:"pipelineId,omitempty"`
// ForceSendFields is a list of field names (e.g. "EphemeralPipeline")
// 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:"-"`
}
func (s *RunPipelineRequest) MarshalJSON() ([]byte, error) {
type noMethod RunPipelineRequest
raw := noMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields)
}
// RuntimeMetadata: Runtime metadata that will be populated in the
// runtimeMetadata field of the Operation associated with a RunPipeline
// execution.
type RuntimeMetadata struct {
// ComputeEngine: Execution information specific to Google Compute
// Engine.
ComputeEngine *ComputeEngine `json:"computeEngine,omitempty"`
// ForceSendFields is a list of field names (e.g. "ComputeEngine") 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:"-"`
}
func (s *RuntimeMetadata) MarshalJSON() ([]byte, error) {
type noMethod RuntimeMetadata
raw := noMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields)
}
// ServiceAccount: A Google Cloud Service Account.
type ServiceAccount struct {
// Email: Email address of the service account. Defaults to `default`,
// which uses the compute service account associated with the project.
Email string `json:"email,omitempty"`
// Scopes: List of scopes to be enabled for this service account on the
// pipeline virtual machine. The following scopes are automatically
// included: * https://www.googleapis.com/auth/genomics *
// https://www.googleapis.com/auth/compute *
// https://www.googleapis.com/auth/devstorage.full_control
Scopes []string `json:"scopes,omitempty"`
// ForceSendFields is a list of field names (e.g. "Email") 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:"-"`
}
func (s *ServiceAccount) MarshalJSON() ([]byte, error) {
type noMethod ServiceAccount
raw := noMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields)
}
// SetOperationStatusRequest: Request to set operation status. Should
// only be used by VMs created by the Pipelines Service and not by end
// users.
type SetOperationStatusRequest struct {
// Possible values:
// "OK"
// "CANCELLED"
// "UNKNOWN"
// "INVALID_ARGUMENT"
// "DEADLINE_EXCEEDED"
// "NOT_FOUND"
// "ALREADY_EXISTS"
// "PERMISSION_DENIED"
// "UNAUTHENTICATED"
// "RESOURCE_EXHAUSTED"
// "FAILED_PRECONDITION"
// "ABORTED"
// "OUT_OF_RANGE"
// "UNIMPLEMENTED"
// "INTERNAL"
// "UNAVAILABLE"
// "DATA_LOSS"
ErrorCode string `json:"errorCode,omitempty"`
ErrorMessage string `json:"errorMessage,omitempty"`
OperationId string `json:"operationId,omitempty"`
TimestampEvents []*TimestampEvent `json:"timestampEvents,omitempty"`
ValidationToken uint64 `json:"validationToken,omitempty,string"`
// ForceSendFields is a list of field names (e.g. "ErrorCode") 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:"-"`
}
func (s *SetOperationStatusRequest) MarshalJSON() ([]byte, error) {
type noMethod SetOperationStatusRequest
raw := noMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields)
}
// Status: The `Status` type defines a logical error model that is
// suitable for different programming environments, including REST APIs
// and RPC APIs. It is used by [gRPC](https://github.com/grpc). The
// error model is designed to be: - Simple to use and understand for
// most users - Flexible enough to meet unexpected needs # Overview The
// `Status` message contains three pieces of data: error code, error
// message, and error details. The error code should be an enum value of
// google.rpc.Code, but it may accept additional error codes if needed.
// The error message should be a developer-facing English message that
// helps developers *understand* and *resolve* the error. If a localized
// user-facing error message is needed, put the localized message in the
// error details or localize it in the client. The optional error
// details may contain arbitrary information about the error. There is a
// predefined set of error detail types in the package `google.rpc`
// which can be used for common error conditions. # Language mapping The
// `Status` message is the logical representation of the error model,
// but it is not necessarily the actual wire format. When the `Status`
// message is exposed in different client libraries and different wire
// protocols, it can be mapped differently. For example, it will likely
// be mapped to some exceptions in Java, but more likely mapped to some
// error codes in C. # Other uses The error model and the `Status`
// message can be used in a variety of environments, either with or
// without APIs, to provide a consistent developer experience across
// different environments. Example uses of this error model include: -
// Partial errors. If a service needs to return partial errors to the
// client, it may embed the `Status` in the normal response to indicate
// the partial errors. - Workflow errors. A typical workflow has
// multiple steps. Each step may have a `Status` message for error
// reporting purpose. - Batch operations. If a client uses batch request
// and batch response, the `Status` message should be used directly
// inside batch response, one for each error sub-response. -
// Asynchronous operations. If an API call embeds asynchronous operation
// results in its response, the status of those operations should be
// represented directly using the `Status` message. - Logging. If some
// API errors are stored in logs, the message `Status` could be used
// directly after any stripping needed for security/privacy reasons.
type Status struct {
// Code: The status code, which should be an enum value of
// google.rpc.Code.
Code int64 `json:"code,omitempty"`
// Details: A list of messages that carry the error details. There will
// be a common set of message types for APIs to use.
Details []StatusDetails `json:"details,omitempty"`
// Message: 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 `json:"message,omitempty"`
// ForceSendFields is a list of field names (e.g. "Code") 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:"-"`
}
func (s *Status) MarshalJSON() ([]byte, error) {
type noMethod Status
raw := noMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields)
}