/
notebooks-gen.go
11916 lines (10860 loc) · 440 KB
/
notebooks-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 2022 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 notebooks provides access to the Notebooks API.
//
// For product documentation, see: https://cloud.google.com/notebooks/docs/
//
// Creating a client
//
// Usage example:
//
// import "google.golang.org/api/notebooks/v1"
// ...
// ctx := context.Background()
// notebooksService, err := notebooks.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:
//
// notebooksService, err := notebooks.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, ...)
// notebooksService, err := notebooks.NewService(ctx, option.WithTokenSource(config.TokenSource(ctx, token)))
//
// See https://godoc.org/google.golang.org/api/option/ for details on options.
package notebooks // import "google.golang.org/api/notebooks/v1"
import (
"bytes"
"context"
"encoding/json"
"errors"
"fmt"
"io"
"net/http"
"net/url"
"strconv"
"strings"
googleapi "google.golang.org/api/googleapi"
internal "google.golang.org/api/internal"
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 = "notebooks:v1"
const apiName = "notebooks"
const apiVersion = "v1"
const basePath = "https://notebooks.googleapis.com/"
const mtlsBasePath = "https://notebooks.mtls.googleapis.com/"
// OAuth2 scopes used by this API.
const (
// See, edit, configure, and delete your Google Cloud data and see the
// email address for your Google Account.
CloudPlatformScope = "https://www.googleapis.com/auth/cloud-platform"
)
// NewService creates a new Service.
func NewService(ctx context.Context, opts ...option.ClientOption) (*Service, error) {
scopesOption := option.WithScopes(
"https://www.googleapis.com/auth/cloud-platform",
)
// NOTE: prepend, so we don't override user-specified scopes.
opts = append([]option.ClientOption{scopesOption}, opts...)
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}
s.Projects = NewProjectsService(s)
return s, nil
}
type Service struct {
client *http.Client
BasePath string // API endpoint base URL
UserAgent string // optional additional User-Agent fragment
Projects *ProjectsService
}
func (s *Service) userAgent() string {
if s.UserAgent == "" {
return googleapi.UserAgent
}
return googleapi.UserAgent + " " + s.UserAgent
}
func NewProjectsService(s *Service) *ProjectsService {
rs := &ProjectsService{s: s}
rs.Locations = NewProjectsLocationsService(s)
return rs
}
type ProjectsService struct {
s *Service
Locations *ProjectsLocationsService
}
func NewProjectsLocationsService(s *Service) *ProjectsLocationsService {
rs := &ProjectsLocationsService{s: s}
rs.Environments = NewProjectsLocationsEnvironmentsService(s)
rs.Executions = NewProjectsLocationsExecutionsService(s)
rs.Instances = NewProjectsLocationsInstancesService(s)
rs.Operations = NewProjectsLocationsOperationsService(s)
rs.Runtimes = NewProjectsLocationsRuntimesService(s)
rs.Schedules = NewProjectsLocationsSchedulesService(s)
return rs
}
type ProjectsLocationsService struct {
s *Service
Environments *ProjectsLocationsEnvironmentsService
Executions *ProjectsLocationsExecutionsService
Instances *ProjectsLocationsInstancesService
Operations *ProjectsLocationsOperationsService
Runtimes *ProjectsLocationsRuntimesService
Schedules *ProjectsLocationsSchedulesService
}
func NewProjectsLocationsEnvironmentsService(s *Service) *ProjectsLocationsEnvironmentsService {
rs := &ProjectsLocationsEnvironmentsService{s: s}
return rs
}
type ProjectsLocationsEnvironmentsService struct {
s *Service
}
func NewProjectsLocationsExecutionsService(s *Service) *ProjectsLocationsExecutionsService {
rs := &ProjectsLocationsExecutionsService{s: s}
return rs
}
type ProjectsLocationsExecutionsService struct {
s *Service
}
func NewProjectsLocationsInstancesService(s *Service) *ProjectsLocationsInstancesService {
rs := &ProjectsLocationsInstancesService{s: s}
return rs
}
type ProjectsLocationsInstancesService struct {
s *Service
}
func NewProjectsLocationsOperationsService(s *Service) *ProjectsLocationsOperationsService {
rs := &ProjectsLocationsOperationsService{s: s}
return rs
}
type ProjectsLocationsOperationsService struct {
s *Service
}
func NewProjectsLocationsRuntimesService(s *Service) *ProjectsLocationsRuntimesService {
rs := &ProjectsLocationsRuntimesService{s: s}
return rs
}
type ProjectsLocationsRuntimesService struct {
s *Service
}
func NewProjectsLocationsSchedulesService(s *Service) *ProjectsLocationsSchedulesService {
rs := &ProjectsLocationsSchedulesService{s: s}
return rs
}
type ProjectsLocationsSchedulesService struct {
s *Service
}
// AcceleratorConfig: Definition of a hardware accelerator. Note that
// not all combinations of `type` and `core_count` are valid. Check GPUs
// on Compute Engine (/compute/docs/gpus/#gpus-list) to find a valid
// combination. TPUs are not supported.
type AcceleratorConfig struct {
// CoreCount: Count of cores of this accelerator.
CoreCount int64 `json:"coreCount,omitempty,string"`
// Type: Type of this accelerator.
//
// Possible values:
// "ACCELERATOR_TYPE_UNSPECIFIED" - Accelerator type is not specified.
// "NVIDIA_TESLA_K80" - Accelerator type is Nvidia Tesla K80.
// "NVIDIA_TESLA_P100" - Accelerator type is Nvidia Tesla P100.
// "NVIDIA_TESLA_V100" - Accelerator type is Nvidia Tesla V100.
// "NVIDIA_TESLA_P4" - Accelerator type is Nvidia Tesla P4.
// "NVIDIA_TESLA_T4" - Accelerator type is Nvidia Tesla T4.
// "NVIDIA_TESLA_A100" - Accelerator type is Nvidia Tesla A100.
// "NVIDIA_TESLA_T4_VWS" - Accelerator type is NVIDIA Tesla T4 Virtual
// Workstations.
// "NVIDIA_TESLA_P100_VWS" - Accelerator type is NVIDIA Tesla P100
// Virtual Workstations.
// "NVIDIA_TESLA_P4_VWS" - Accelerator type is NVIDIA Tesla P4 Virtual
// Workstations.
// "TPU_V2" - (Coming soon) Accelerator type is TPU V2.
// "TPU_V3" - (Coming soon) Accelerator type is TPU V3.
Type string `json:"type,omitempty"`
// ForceSendFields is a list of field names (e.g. "CoreCount") to
// unconditionally include in API requests. By default, fields with
// empty or default 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. "CoreCount") 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 *AcceleratorConfig) MarshalJSON() ([]byte, error) {
type NoMethod AcceleratorConfig
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// Binding: Associates `members`, or principals, with a `role`.
type Binding struct {
// Condition: The condition that is associated with this binding. If the
// condition evaluates to `true`, then this binding applies to the
// current request. If the condition evaluates to `false`, then this
// binding does not apply to the current request. However, a different
// role binding might grant the same role to one or more of the
// principals in this binding. To learn which resources support
// conditions in their IAM policies, see the IAM documentation
// (https://cloud.google.com/iam/help/conditions/resource-policies).
Condition *Expr `json:"condition,omitempty"`
// Members: Specifies the principals requesting access for a Cloud
// Platform resource. `members` can have the following values: *
// `allUsers`: A special identifier that represents anyone who is on the
// internet; with or without a Google account. *
// `allAuthenticatedUsers`: A special identifier that represents anyone
// who is authenticated with a Google account or a service account. *
// `user:{emailid}`: An email address that represents a specific Google
// account. For example, `alice@example.com` . *
// `serviceAccount:{emailid}`: An email address that represents a
// service account. For example,
// `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An
// email address that represents a Google group. For example,
// `admins@example.com`. * `deleted:user:{emailid}?uid={uniqueid}`: An
// email address (plus unique identifier) representing a user that has
// been recently deleted. For example,
// `alice@example.com?uid=123456789012345678901`. If the user is
// recovered, this value reverts to `user:{emailid}` and the recovered
// user retains the role in the binding. *
// `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address
// (plus unique identifier) representing a service account that has been
// recently deleted. For example,
// `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`.
// If the service account is undeleted, this value reverts to
// `serviceAccount:{emailid}` and the undeleted service account retains
// the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`:
// An email address (plus unique identifier) representing a Google group
// that has been recently deleted. For example,
// `admins@example.com?uid=123456789012345678901`. If the group is
// recovered, this value reverts to `group:{emailid}` and the recovered
// group retains the role in the binding. * `domain:{domain}`: The G
// Suite domain (primary) that represents all the users of that domain.
// For example, `google.com` or `example.com`.
Members []string `json:"members,omitempty"`
// Role: Role that is assigned to the list of `members`, or principals.
// For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
Role string `json:"role,omitempty"`
// ForceSendFields is a list of field names (e.g. "Condition") to
// unconditionally include in API requests. By default, fields with
// empty or default 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. "Condition") 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 *Binding) MarshalJSON() ([]byte, error) {
type NoMethod Binding
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// CancelOperationRequest: The request message for
// Operations.CancelOperation.
type CancelOperationRequest struct {
}
// ContainerImage: Definition of a container image for starting a
// notebook instance with the environment installed in a container.
type ContainerImage struct {
// Repository: Required. The path to the container image repository. For
// example: `gcr.io/{project_id}/{image_name}`
Repository string `json:"repository,omitempty"`
// Tag: The tag of the container image. If not specified, this defaults
// to the latest tag.
Tag string `json:"tag,omitempty"`
// ForceSendFields is a list of field names (e.g. "Repository") to
// unconditionally include in API requests. By default, fields with
// empty or default 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. "Repository") 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 *ContainerImage) MarshalJSON() ([]byte, error) {
type NoMethod ContainerImage
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// DataprocParameters: Parameters used in Dataproc JobType executions.
type DataprocParameters struct {
// Cluster: URI for cluster used to run Dataproc execution. Format:
// `projects/{PROJECT_ID}/regions/{REGION}/clusters/{CLUSTER_NAME}`
Cluster string `json:"cluster,omitempty"`
// ForceSendFields is a list of field names (e.g. "Cluster") to
// unconditionally include in API requests. By default, fields with
// empty or default 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. "Cluster") 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 *DataprocParameters) MarshalJSON() ([]byte, error) {
type NoMethod DataprocParameters
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// Disk: An instance-attached disk resource.
type Disk struct {
// AutoDelete: Indicates whether the disk will be auto-deleted when the
// instance is deleted (but not when the disk is detached from the
// instance).
AutoDelete bool `json:"autoDelete,omitempty"`
// Boot: Indicates that this is a boot disk. The virtual machine will
// use the first partition of the disk for its root filesystem.
Boot bool `json:"boot,omitempty"`
// DeviceName: Indicates a unique device name of your choice that is
// reflected into the /dev/disk/by-id/google-* tree of a Linux operating
// system running within the instance. This name can be used to
// reference the device for mounting, resizing, and so on, from within
// the instance. If not specified, the server chooses a default device
// name to apply to this disk, in the form persistent-disk-x, where x is
// a number assigned by Google Compute Engine.This field is only
// applicable for persistent disks.
DeviceName string `json:"deviceName,omitempty"`
// DiskSizeGb: Indicates the size of the disk in base-2 GB.
DiskSizeGb int64 `json:"diskSizeGb,omitempty,string"`
// GuestOsFeatures: Indicates a list of features to enable on the guest
// operating system. Applicable only for bootable images. Read Enabling
// guest operating system features to see a list of available options.
GuestOsFeatures []*GuestOsFeature `json:"guestOsFeatures,omitempty"`
// Index: A zero-based index to this disk, where 0 is reserved for the
// boot disk. If you have many disks attached to an instance, each disk
// would have a unique index number.
Index int64 `json:"index,omitempty,string"`
// Interface: Indicates the disk interface to use for attaching this
// disk, which is either SCSI or NVME. The default is SCSI. Persistent
// disks must always use SCSI and the request will fail if you attempt
// to attach a persistent disk in any other format than SCSI. Local SSDs
// can use either NVME or SCSI. For performance characteristics of SCSI
// over NVMe, see Local SSD performance. Valid values: * NVME * SCSI
Interface string `json:"interface,omitempty"`
// Kind: Type of the resource. Always compute#attachedDisk for attached
// disks.
Kind string `json:"kind,omitempty"`
// Licenses: A list of publicly visible licenses. Reserved for Google's
// use. A License represents billing and aggregate usage data for public
// and marketplace images.
Licenses []string `json:"licenses,omitempty"`
// Mode: The mode in which to attach this disk, either READ_WRITE or
// READ_ONLY. If not specified, the default is to attach the disk in
// READ_WRITE mode. Valid values: * READ_ONLY * READ_WRITE
Mode string `json:"mode,omitempty"`
// Source: Indicates a valid partial or full URL to an existing
// Persistent Disk resource.
Source string `json:"source,omitempty"`
// Type: Indicates the type of the disk, either SCRATCH or PERSISTENT.
// Valid values: * PERSISTENT * SCRATCH
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 or default 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. "AutoDelete") 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)
}
// 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:"-"`
}
// EncryptionConfig: Represents a custom encryption key configuration
// that can be applied to a resource. This will encrypt all disks in
// Virtual Machine.
type EncryptionConfig struct {
// KmsKey: The Cloud KMS resource identifier of the customer-managed
// encryption key used to protect a resource, such as a disks. It has
// the following format:
// `projects/{PROJECT_ID}/locations/{REGION}/keyRings/{KEY_RING_NAME}/cry
// ptoKeys/{KEY_NAME}`
KmsKey string `json:"kmsKey,omitempty"`
// ForceSendFields is a list of field names (e.g. "KmsKey") to
// unconditionally include in API requests. By default, fields with
// empty or default 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. "KmsKey") 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 *EncryptionConfig) MarshalJSON() ([]byte, error) {
type NoMethod EncryptionConfig
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// Environment: Definition of a software environment that is used to
// start a notebook instance.
type Environment struct {
// ContainerImage: Use a container image to start the notebook instance.
ContainerImage *ContainerImage `json:"containerImage,omitempty"`
// CreateTime: Output only. The time at which this environment was
// created.
CreateTime string `json:"createTime,omitempty"`
// Description: A brief description of this environment.
Description string `json:"description,omitempty"`
// DisplayName: Display name of this environment for the UI.
DisplayName string `json:"displayName,omitempty"`
// Name: Output only. Name of this environment. Format:
// `projects/{project_id}/locations/{location}/environments/{environment_
// id}`
Name string `json:"name,omitempty"`
// PostStartupScript: Path to a Bash script that automatically runs
// after a notebook instance fully boots up. The path must be a URL or
// Cloud Storage path. Example: "gs://path-to-file/file-name"
PostStartupScript string `json:"postStartupScript,omitempty"`
// VmImage: Use a Compute Engine VM image to start the notebook
// instance.
VmImage *VmImage `json:"vmImage,omitempty"`
// ServerResponse contains the HTTP response code and headers from the
// server.
googleapi.ServerResponse `json:"-"`
// ForceSendFields is a list of field names (e.g. "ContainerImage") to
// unconditionally include in API requests. By default, fields with
// empty or default 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. "ContainerImage") 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 *Environment) MarshalJSON() ([]byte, error) {
type NoMethod Environment
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// Event: The definition of an Event for a managed / semi-managed
// notebook instance.
type Event struct {
// Details: Optional. Event details. This field is used to pass event
// information.
Details map[string]string `json:"details,omitempty"`
// ReportTime: Event report time.
ReportTime string `json:"reportTime,omitempty"`
// Type: Event type.
//
// Possible values:
// "EVENT_TYPE_UNSPECIFIED" - Event is not specified.
// "IDLE" - The instance / runtime is idle
// "HEARTBEAT" - The instance / runtime is available. This event
// indicates that instance / runtime underlying compute is operational.
// "HEALTH" - The instance / runtime health is available. This event
// indicates that instance / runtime health information.
Type string `json:"type,omitempty"`
// ForceSendFields is a list of field names (e.g. "Details") to
// unconditionally include in API requests. By default, fields with
// empty or default 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. "Details") 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)
}
// Execution: The definition of a single executed notebook.
type Execution struct {
// CreateTime: Output only. Time the Execution was instantiated.
CreateTime string `json:"createTime,omitempty"`
// Description: A brief description of this execution.
Description string `json:"description,omitempty"`
// DisplayName: Output only. Name used for UI purposes. Name can only
// contain alphanumeric characters and underscores '_'.
DisplayName string `json:"displayName,omitempty"`
// ExecutionTemplate: execute metadata including name, hardware spec,
// region, labels, etc.
ExecutionTemplate *ExecutionTemplate `json:"executionTemplate,omitempty"`
// JobUri: Output only. The URI of the external job used to execute the
// notebook.
JobUri string `json:"jobUri,omitempty"`
// Name: Output only. The resource name of the execute. Format:
// `projects/{project_id}/locations/{location}/executions/{execution_id}`
Name string `json:"name,omitempty"`
// OutputNotebookFile: Output notebook file generated by this execution
OutputNotebookFile string `json:"outputNotebookFile,omitempty"`
// State: Output only. State of the underlying AI Platform job.
//
// Possible values:
// "STATE_UNSPECIFIED" - The job state is unspecified.
// "QUEUED" - The job has been just created and processing has not yet
// begun.
// "PREPARING" - The service is preparing to execution the job.
// "RUNNING" - The job is in progress.
// "SUCCEEDED" - The job completed successfully.
// "FAILED" - The job failed. `error_message` should contain the
// details of the failure.
// "CANCELLING" - The job is being cancelled. `error_message` should
// describe the reason for the cancellation.
// "CANCELLED" - The job has been cancelled. `error_message` should
// describe the reason for the cancellation.
// "EXPIRED" - The job has become expired (relevant to Vertex AI jobs)
// https://cloud.google.com/vertex-ai/docs/reference/rest/v1/JobState
// "INITIALIZING" - The Execution is being created.
State string `json:"state,omitempty"`
// UpdateTime: Output only. Time the Execution was last updated.
UpdateTime string `json:"updateTime,omitempty"`
// ServerResponse contains the HTTP response code and headers from the
// server.
googleapi.ServerResponse `json:"-"`
// ForceSendFields is a list of field names (e.g. "CreateTime") to
// unconditionally include in API requests. By default, fields with
// empty or default 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 *Execution) MarshalJSON() ([]byte, error) {
type NoMethod Execution
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// ExecutionTemplate: The description a notebook execution workload.
type ExecutionTemplate struct {
// AcceleratorConfig: Configuration (count and accelerator type) for
// hardware running notebook execution.
AcceleratorConfig *SchedulerAcceleratorConfig `json:"acceleratorConfig,omitempty"`
// ContainerImageUri: Container Image URI to a DLVM Example:
// 'gcr.io/deeplearning-platform-release/base-cu100' More examples can
// be found at:
// https://cloud.google.com/ai-platform/deep-learning-containers/docs/choosing-container
ContainerImageUri string `json:"containerImageUri,omitempty"`
// DataprocParameters: Parameters used in Dataproc JobType executions.
DataprocParameters *DataprocParameters `json:"dataprocParameters,omitempty"`
// InputNotebookFile: Path to the notebook file to execute. Must be in a
// Google Cloud Storage bucket. Format:
// `gs://{bucket_name}/{folder}/{notebook_file_name}` Ex:
// `gs://notebook_user/scheduled_notebooks/sentiment_notebook.ipynb`
InputNotebookFile string `json:"inputNotebookFile,omitempty"`
// JobType: The type of Job to be used on this execution.
//
// Possible values:
// "JOB_TYPE_UNSPECIFIED" - No type specified.
// "VERTEX_AI" - Custom Job in `aiplatform.googleapis.com`. Default
// value for an execution.
// "DATAPROC" - Run execution on a cluster with Dataproc as a job.
// https://cloud.google.com/dataproc/docs/reference/rest/v1/projects.regions.jobs
JobType string `json:"jobType,omitempty"`
// KernelSpec: Name of the kernel spec to use. This must be specified if
// the kernel spec name on the execution target does not match the name
// in the input notebook file.
KernelSpec string `json:"kernelSpec,omitempty"`
// Labels: Labels for execution. If execution is scheduled, a field
// included will be 'nbs-scheduled'. Otherwise, it is an immediate
// execution, and an included field will be 'nbs-immediate'. Use fields
// to efficiently index between various types of executions.
Labels map[string]string `json:"labels,omitempty"`
// MasterType: Specifies the type of virtual machine to use for your
// training job's master worker. You must specify this field when
// `scaleTier` is set to `CUSTOM`. You can use certain Compute Engine
// machine types directly in this field. The following types are
// supported: - `n1-standard-4` - `n1-standard-8` - `n1-standard-16` -
// `n1-standard-32` - `n1-standard-64` - `n1-standard-96` -
// `n1-highmem-2` - `n1-highmem-4` - `n1-highmem-8` - `n1-highmem-16` -
// `n1-highmem-32` - `n1-highmem-64` - `n1-highmem-96` - `n1-highcpu-16`
// - `n1-highcpu-32` - `n1-highcpu-64` - `n1-highcpu-96` Alternatively,
// you can use the following legacy machine types: - `standard` -
// `large_model` - `complex_model_s` - `complex_model_m` -
// `complex_model_l` - `standard_gpu` - `complex_model_m_gpu` -
// `complex_model_l_gpu` - `standard_p100` - `complex_model_m_p100` -
// `standard_v100` - `large_model_v100` - `complex_model_m_v100` -
// `complex_model_l_v100` Finally, if you want to use a TPU for
// training, specify `cloud_tpu` in this field. Learn more about the
// special configuration options for training with TPU
// (https://cloud.google.com/ai-platform/training/docs/using-tpus#configuring_a_custom_tpu_machine).
MasterType string `json:"masterType,omitempty"`
// OutputNotebookFolder: Path to the notebook folder to write to. Must
// be in a Google Cloud Storage bucket path. Format:
// `gs://{bucket_name}/{folder}` Ex:
// `gs://notebook_user/scheduled_notebooks`
OutputNotebookFolder string `json:"outputNotebookFolder,omitempty"`
// Parameters: Parameters used within the 'input_notebook_file'
// notebook.
Parameters string `json:"parameters,omitempty"`
// ParamsYamlFile: Parameters to be overridden in the notebook during
// execution. Ref
// https://papermill.readthedocs.io/en/latest/usage-parameterize.html on
// how to specifying parameters in the input notebook and pass them here
// in an YAML file. Ex:
// `gs://notebook_user/scheduled_notebooks/sentiment_notebook_params.yaml
// `
ParamsYamlFile string `json:"paramsYamlFile,omitempty"`
// ScaleTier: Required. Scale tier of the hardware used for notebook
// execution. DEPRECATED Will be discontinued. As right now only CUSTOM
// is supported.
//
// Possible values:
// "SCALE_TIER_UNSPECIFIED" - Unspecified Scale Tier.
// "BASIC" - A single worker instance. This tier is suitable for
// learning how to use Cloud ML, and for experimenting with new models
// using small datasets.
// "STANDARD_1" - Many workers and a few parameter servers.
// "PREMIUM_1" - A large number of workers with many parameter
// servers.
// "BASIC_GPU" - A single worker instance with a K80 GPU.
// "BASIC_TPU" - A single worker instance with a Cloud TPU.
// "CUSTOM" - The CUSTOM tier is not a set tier, but rather enables
// you to use your own cluster specification. When you use this tier,
// set values to configure your processing cluster according to these
// guidelines: * You _must_ set `ExecutionTemplate.masterType` to
// specify the type of machine to use for your master node. This is the
// only required setting.
ScaleTier string `json:"scaleTier,omitempty"`
// ServiceAccount: The email address of a service account to use when
// running the execution. You must have the `iam.serviceAccounts.actAs`
// permission for the specified service account.
ServiceAccount string `json:"serviceAccount,omitempty"`
// Tensorboard: The name of a Vertex AI [Tensorboard] resource to which
// this execution will upload Tensorboard logs. Format:
// `projects/{project}/locations/{location}/tensorboards/{tensorboard}`
Tensorboard string `json:"tensorboard,omitempty"`
// VertexAiParameters: Parameters used in Vertex AI JobType executions.
VertexAiParameters *VertexAIParameters `json:"vertexAiParameters,omitempty"`
// ForceSendFields is a list of field names (e.g. "AcceleratorConfig")
// to unconditionally include in API requests. By default, fields with
// empty or default 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. "AcceleratorConfig") 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 *ExecutionTemplate) MarshalJSON() ([]byte, error) {
type NoMethod ExecutionTemplate
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// Expr: Represents a textual expression in the Common Expression
// Language (CEL) syntax. CEL is a C-like expression language. The
// syntax and semantics of CEL are documented at
// https://github.com/google/cel-spec. Example (Comparison): title:
// "Summary size limit" description: "Determines if a summary is less
// than 100 chars" expression: "document.summary.size() < 100" Example
// (Equality): title: "Requestor is owner" description: "Determines if
// requestor is the document owner" expression: "document.owner ==
// request.auth.claims.email" Example (Logic): title: "Public documents"
// description: "Determine whether the document should be publicly
// visible" expression: "document.type != 'private' && document.type !=
// 'internal'" Example (Data Manipulation): title: "Notification string"
// description: "Create a notification string with a timestamp."
// expression: "'New message received at ' +
// string(document.create_time)" The exact variables and functions that
// may be referenced within an expression are determined by the service
// that evaluates it. See the service documentation for additional
// information.
type Expr struct {
// Description: Optional. Description of the expression. This is a
// longer text which describes the expression, e.g. when hovered over it
// in a UI.
Description string `json:"description,omitempty"`
// Expression: Textual representation of an expression in Common
// Expression Language syntax.
Expression string `json:"expression,omitempty"`
// Location: Optional. String indicating the location of the expression
// for error reporting, e.g. a file name and a position in the file.
Location string `json:"location,omitempty"`
// Title: Optional. Title for the expression, i.e. a short string
// describing its purpose. This can be used e.g. in UIs which allow to
// enter the expression.
Title string `json:"title,omitempty"`
// ForceSendFields is a list of field names (e.g. "Description") to
// unconditionally include in API requests. By default, fields with
// empty or default 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 *Expr) MarshalJSON() ([]byte, error) {
type NoMethod Expr
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// GetInstanceHealthResponse: Response for checking if a notebook
// instance is healthy.
type GetInstanceHealthResponse struct {
// HealthInfo: Output only. Additional information about instance
// health. Example: healthInfo": { "docker_proxy_agent_status": "1",
// "docker_status": "1", "jupyterlab_api_status": "-1",
// "jupyterlab_status": "-1", "updated": "2020-10-18 09:40:03.573409" }
HealthInfo map[string]string `json:"healthInfo,omitempty"`
// HealthState: Output only. Runtime health_state.
//
// Possible values:
// "HEALTH_STATE_UNSPECIFIED" - The instance substate is unknown.
// "HEALTHY" - The instance is known to be in an healthy state (for
// example, critical daemons are running) Applies to ACTIVE state.
// "UNHEALTHY" - The instance is known to be in an unhealthy state
// (for example, critical daemons are not running) Applies to ACTIVE
// state.
// "AGENT_NOT_INSTALLED" - The instance has not installed health
// monitoring agent. Applies to ACTIVE state.
// "AGENT_NOT_RUNNING" - The instance health monitoring agent is not
// running. Applies to ACTIVE state.
HealthState string `json:"healthState,omitempty"`
// ServerResponse contains the HTTP response code and headers from the
// server.
googleapi.ServerResponse `json:"-"`
// ForceSendFields is a list of field names (e.g. "HealthInfo") to
// unconditionally include in API requests. By default, fields with
// empty or default 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. "HealthInfo") 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 *GetInstanceHealthResponse) MarshalJSON() ([]byte, error) {
type NoMethod GetInstanceHealthResponse
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// GuestOsFeature: Guest OS features for boot disk.
type GuestOsFeature struct {
// Type: The ID of a supported feature. Read Enabling guest operating
// system features to see a list of available options. Valid values: *
// FEATURE_TYPE_UNSPECIFIED * MULTI_IP_SUBNET * SECURE_BOOT *
// UEFI_COMPATIBLE * VIRTIO_SCSI_MULTIQUEUE * WINDOWS
Type string `json:"type,omitempty"`
// ForceSendFields is a list of field names (e.g. "Type") to
// unconditionally include in API requests. By default, fields with
// empty or default 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.