-
Notifications
You must be signed in to change notification settings - Fork 3
Expand file tree
/
Copy pathproject.go
More file actions
1537 lines (1382 loc) · 55.7 KB
/
project.go
File metadata and controls
1537 lines (1382 loc) · 55.7 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
package gitpod
import (
"context"
"net/http"
"net/url"
"slices"
"time"
"github.com/gitpod-io/gitpod-sdk-go/internal/apijson"
"github.com/gitpod-io/gitpod-sdk-go/internal/apiquery"
"github.com/gitpod-io/gitpod-sdk-go/internal/param"
"github.com/gitpod-io/gitpod-sdk-go/internal/requestconfig"
"github.com/gitpod-io/gitpod-sdk-go/option"
"github.com/gitpod-io/gitpod-sdk-go/packages/pagination"
"github.com/gitpod-io/gitpod-sdk-go/shared"
)
// ProjectService contains methods and other services that help with interacting
// with the gitpod API.
//
// Note, unlike clients, this service does not read variables from the environment
// automatically. You should not instantiate this service directly, and instead use
// the [NewProjectService] method instead.
type ProjectService struct {
Options []option.RequestOption
EnvironmentClases *ProjectEnvironmentClaseService
Policies *ProjectPolicyService
}
// NewProjectService generates a new service that applies the given options to each
// request. These options are applied after the parent client's options (if there
// is one), and before any request-specific options.
func NewProjectService(opts ...option.RequestOption) (r *ProjectService) {
r = &ProjectService{}
r.Options = opts
r.EnvironmentClases = NewProjectEnvironmentClaseService(opts...)
r.Policies = NewProjectPolicyService(opts...)
return
}
// Creates a new project with specified configuration.
//
// Use this method to:
//
// - Set up development projects
// - Configure project environments
// - Define project settings
// - Initialize project content
//
// ### Examples
//
// - Create basic project:
//
// Creates a project with minimal configuration.
//
// ```yaml
// name: "Web Application"
// initializer:
// specs:
// - git:
// remoteUri: "https://github.com/org/repo"
// ```
//
// - Create project with devcontainer:
//
// Creates a project with custom development container.
//
// ```yaml
// name: "Backend Service"
// initializer:
// specs:
// - git:
// remoteUri: "https://github.com/org/backend"
// devcontainerFilePath: ".devcontainer/devcontainer.json"
// automationsFilePath: ".gitpod/automations.yaml"
// ```
func (r *ProjectService) New(ctx context.Context, body ProjectNewParams, opts ...option.RequestOption) (res *ProjectNewResponse, err error) {
opts = slices.Concat(r.Options, opts)
path := "gitpod.v1.ProjectService/CreateProject"
err = requestconfig.ExecuteNewRequest(ctx, http.MethodPost, path, body, &res, opts...)
return res, err
}
// Gets details about a specific project.
//
// Use this method to:
//
// - View project configuration
// - Check project status
// - Get project metadata
//
// ### Examples
//
// - Get project details:
//
// Retrieves information about a specific project.
//
// ```yaml
// projectId: "b0e12f6c-4c67-429d-a4a6-d9838b5da047"
// ```
func (r *ProjectService) Get(ctx context.Context, body ProjectGetParams, opts ...option.RequestOption) (res *ProjectGetResponse, err error) {
opts = slices.Concat(r.Options, opts)
path := "gitpod.v1.ProjectService/GetProject"
err = requestconfig.ExecuteNewRequest(ctx, http.MethodPost, path, body, &res, opts...)
return res, err
}
// Updates a project's configuration.
//
// Use this method to:
//
// - Modify project settings
// - Update environment class
// - Change project name
// - Configure initializers
// - Configure prebuild settings
//
// ### Examples
//
// - Update project name:
//
// Changes the project's display name.
//
// ```yaml
// projectId: "b0e12f6c-4c67-429d-a4a6-d9838b5da047"
// name: "New Project Name"
// ```
//
// - Enable prebuilds with daily schedule:
//
// Configures prebuilds to run daily at 2 AM UTC.
//
// ```yaml
// projectId: "b0e12f6c-4c67-429d-a4a6-d9838b5da047"
// prebuildConfiguration:
// enabled: true
// environmentClassIds:
// - "b0e12f6c-4c67-429d-a4a6-d9838b5da041"
// timeout: "3600s"
// trigger:
// dailySchedule:
// hourUtc: 2
// ```
func (r *ProjectService) Update(ctx context.Context, body ProjectUpdateParams, opts ...option.RequestOption) (res *ProjectUpdateResponse, err error) {
opts = slices.Concat(r.Options, opts)
path := "gitpod.v1.ProjectService/UpdateProject"
err = requestconfig.ExecuteNewRequest(ctx, http.MethodPost, path, body, &res, opts...)
return res, err
}
// Lists projects with optional filtering.
//
// Use this method to:
//
// - View all accessible projects
// - Browse project configurations
// - Monitor project status
//
// ### Examples
//
// - List projects:
//
// Shows all projects with pagination.
//
// ```yaml
// pagination:
// pageSize: 20
// ```
func (r *ProjectService) List(ctx context.Context, params ProjectListParams, opts ...option.RequestOption) (res *pagination.ProjectsPage[Project], err error) {
var raw *http.Response
opts = slices.Concat(r.Options, opts)
opts = append([]option.RequestOption{option.WithResponseInto(&raw)}, opts...)
path := "gitpod.v1.ProjectService/ListProjects"
cfg, err := requestconfig.NewRequestConfig(ctx, http.MethodPost, path, params, &res, opts...)
if err != nil {
return nil, err
}
err = cfg.Execute()
if err != nil {
return nil, err
}
res.SetPageConfig(cfg, raw)
return res, nil
}
// Lists projects with optional filtering.
//
// Use this method to:
//
// - View all accessible projects
// - Browse project configurations
// - Monitor project status
//
// ### Examples
//
// - List projects:
//
// Shows all projects with pagination.
//
// ```yaml
// pagination:
// pageSize: 20
// ```
func (r *ProjectService) ListAutoPaging(ctx context.Context, params ProjectListParams, opts ...option.RequestOption) *pagination.ProjectsPageAutoPager[Project] {
return pagination.NewProjectsPageAutoPager(r.List(ctx, params, opts...))
}
// Deletes a project permanently.
//
// Use this method to:
//
// - Remove unused projects
// - Clean up test projects
// - Delete obsolete configurations
//
// ### Examples
//
// - Delete project:
//
// Permanently removes a project.
//
// ```yaml
// projectId: "b0e12f6c-4c67-429d-a4a6-d9838b5da047"
// ```
func (r *ProjectService) Delete(ctx context.Context, body ProjectDeleteParams, opts ...option.RequestOption) (res *ProjectDeleteResponse, err error) {
opts = slices.Concat(r.Options, opts)
path := "gitpod.v1.ProjectService/DeleteProject"
err = requestconfig.ExecuteNewRequest(ctx, http.MethodPost, path, body, &res, opts...)
return res, err
}
// Creates multiple projects in a single request.
//
// Use this method to:
//
// - Onboard multiple repositories at once
// - Import a batch of projects during initial setup
//
// Returns successfully created projects and details about any failures. Each
// project in the request is processed independently — partial success is possible.
//
// ### Examples
//
// - Create multiple projects:
//
// Creates several projects in one request.
//
// ```yaml
// projects:
// - name: "Frontend"
// initializer:
// specs:
// - git:
// remoteUri: "https://github.com/org/frontend"
// - name: "Backend"
// initializer:
// specs:
// - git:
// remoteUri: "https://github.com/org/backend"
// ```
func (r *ProjectService) BulkNew(ctx context.Context, body ProjectBulkNewParams, opts ...option.RequestOption) (res *ProjectBulkNewResponse, err error) {
opts = slices.Concat(r.Options, opts)
path := "gitpod.v1.ProjectService/CreateProjects"
err = requestconfig.ExecuteNewRequest(ctx, http.MethodPost, path, body, &res, opts...)
return res, err
}
// Deletes multiple projects in a single request.
//
// Use this method to:
//
// - Remove multiple unused projects at once
// - Clean up projects in batch
//
// Returns successfully deleted project IDs and details about any failures. Each
// project in the request is processed independently — partial success is possible.
//
// ### Examples
//
// - Delete multiple projects:
//
// Permanently removes several projects in one request.
//
// ```yaml
// projectIds:
// - "b0e12f6c-4c67-429d-a4a6-d9838b5da047"
// - "c1f23g7d-5d78-430e-b5b7-e0949c6eb158"
// ```
func (r *ProjectService) BulkDelete(ctx context.Context, body ProjectBulkDeleteParams, opts ...option.RequestOption) (res *ProjectBulkDeleteResponse, err error) {
opts = slices.Concat(r.Options, opts)
path := "gitpod.v1.ProjectService/DeleteProjects"
err = requestconfig.ExecuteNewRequest(ctx, http.MethodPost, path, body, &res, opts...)
return res, err
}
// Updates multiple projects in a single request.
//
// Use this method to:
//
// - Modify settings across multiple projects at once
// - Apply configuration changes in batch
//
// Returns successfully updated projects and details about any failures. Each
// project in the request is processed independently — partial success is possible.
//
// ### Examples
//
// - Update multiple projects:
//
// Updates several projects in one request.
//
// ```yaml
// projects:
// - projectId: "b0e12f6c-4c67-429d-a4a6-d9838b5da047"
// name: "Updated Frontend"
// - projectId: "c1f23g7d-5d78-430e-b5b7-e0949c6eb158"
// name: "Updated Backend"
// ```
func (r *ProjectService) BulkUpdate(ctx context.Context, body ProjectBulkUpdateParams, opts ...option.RequestOption) (res *ProjectBulkUpdateResponse, err error) {
opts = slices.Concat(r.Options, opts)
path := "gitpod.v1.ProjectService/UpdateProjects"
err = requestconfig.ExecuteNewRequest(ctx, http.MethodPost, path, body, &res, opts...)
return res, err
}
// Creates a new project using an existing environment as a template.
//
// Use this method to:
//
// - Clone environment configurations
// - Create projects from templates
// - Share environment setups
//
// ### Examples
//
// - Create from environment:
//
// Creates a project based on existing environment.
//
// ```yaml
// name: "Frontend Project"
// environmentId: "07e03a28-65a5-4d98-b532-8ea67b188048"
// ```
func (r *ProjectService) NewFromEnvironment(ctx context.Context, body ProjectNewFromEnvironmentParams, opts ...option.RequestOption) (res *ProjectNewFromEnvironmentResponse, err error) {
opts = slices.Concat(r.Options, opts)
path := "gitpod.v1.ProjectService/CreateProjectFromEnvironment"
err = requestconfig.ExecuteNewRequest(ctx, http.MethodPost, path, body, &res, opts...)
return res, err
}
// EnvironmentInitializer specifies how an environment is to be initialized
type EnvironmentInitializer struct {
Specs []EnvironmentInitializerSpec `json:"specs"`
JSON environmentInitializerJSON `json:"-"`
}
// environmentInitializerJSON contains the JSON metadata for the struct
// [EnvironmentInitializer]
type environmentInitializerJSON struct {
Specs apijson.Field
raw string
ExtraFields map[string]apijson.Field
}
func (r *EnvironmentInitializer) UnmarshalJSON(data []byte) (err error) {
return apijson.UnmarshalRoot(data, r)
}
func (r environmentInitializerJSON) RawJSON() string {
return r.raw
}
type EnvironmentInitializerSpec struct {
ContextURL EnvironmentInitializerSpecsContextURL `json:"contextUrl"`
Git EnvironmentInitializerSpecsGit `json:"git"`
JSON environmentInitializerSpecJSON `json:"-"`
}
// environmentInitializerSpecJSON contains the JSON metadata for the struct
// [EnvironmentInitializerSpec]
type environmentInitializerSpecJSON struct {
ContextURL apijson.Field
Git apijson.Field
raw string
ExtraFields map[string]apijson.Field
}
func (r *EnvironmentInitializerSpec) UnmarshalJSON(data []byte) (err error) {
return apijson.UnmarshalRoot(data, r)
}
func (r environmentInitializerSpecJSON) RawJSON() string {
return r.raw
}
type EnvironmentInitializerSpecsContextURL struct {
// url is the URL from which the environment is created
URL string `json:"url" format:"uri"`
JSON environmentInitializerSpecsContextURLJSON `json:"-"`
}
// environmentInitializerSpecsContextURLJSON contains the JSON metadata for the
// struct [EnvironmentInitializerSpecsContextURL]
type environmentInitializerSpecsContextURLJSON struct {
URL apijson.Field
raw string
ExtraFields map[string]apijson.Field
}
func (r *EnvironmentInitializerSpecsContextURL) UnmarshalJSON(data []byte) (err error) {
return apijson.UnmarshalRoot(data, r)
}
func (r environmentInitializerSpecsContextURLJSON) RawJSON() string {
return r.raw
}
type EnvironmentInitializerSpecsGit struct {
// a path relative to the environment root in which the code will be checked out to
CheckoutLocation string `json:"checkoutLocation"`
// the value for the clone target mode - use depends on the target mode
CloneTarget string `json:"cloneTarget"`
// remote_uri is the Git remote origin
RemoteUri string `json:"remoteUri"`
// the target mode determines what gets checked out
TargetMode EnvironmentInitializerSpecsGitTargetMode `json:"targetMode"`
// upstream_Remote_uri is the fork upstream of a repository
UpstreamRemoteUri string `json:"upstreamRemoteUri"`
JSON environmentInitializerSpecsGitJSON `json:"-"`
}
// environmentInitializerSpecsGitJSON contains the JSON metadata for the struct
// [EnvironmentInitializerSpecsGit]
type environmentInitializerSpecsGitJSON struct {
CheckoutLocation apijson.Field
CloneTarget apijson.Field
RemoteUri apijson.Field
TargetMode apijson.Field
UpstreamRemoteUri apijson.Field
raw string
ExtraFields map[string]apijson.Field
}
func (r *EnvironmentInitializerSpecsGit) UnmarshalJSON(data []byte) (err error) {
return apijson.UnmarshalRoot(data, r)
}
func (r environmentInitializerSpecsGitJSON) RawJSON() string {
return r.raw
}
// the target mode determines what gets checked out
type EnvironmentInitializerSpecsGitTargetMode string
const (
EnvironmentInitializerSpecsGitTargetModeCloneTargetModeUnspecified EnvironmentInitializerSpecsGitTargetMode = "CLONE_TARGET_MODE_UNSPECIFIED"
EnvironmentInitializerSpecsGitTargetModeCloneTargetModeRemoteHead EnvironmentInitializerSpecsGitTargetMode = "CLONE_TARGET_MODE_REMOTE_HEAD"
EnvironmentInitializerSpecsGitTargetModeCloneTargetModeRemoteCommit EnvironmentInitializerSpecsGitTargetMode = "CLONE_TARGET_MODE_REMOTE_COMMIT"
EnvironmentInitializerSpecsGitTargetModeCloneTargetModeRemoteBranch EnvironmentInitializerSpecsGitTargetMode = "CLONE_TARGET_MODE_REMOTE_BRANCH"
EnvironmentInitializerSpecsGitTargetModeCloneTargetModeLocalBranch EnvironmentInitializerSpecsGitTargetMode = "CLONE_TARGET_MODE_LOCAL_BRANCH"
EnvironmentInitializerSpecsGitTargetModeCloneTargetModeRemoteTag EnvironmentInitializerSpecsGitTargetMode = "CLONE_TARGET_MODE_REMOTE_TAG"
)
func (r EnvironmentInitializerSpecsGitTargetMode) IsKnown() bool {
switch r {
case EnvironmentInitializerSpecsGitTargetModeCloneTargetModeUnspecified, EnvironmentInitializerSpecsGitTargetModeCloneTargetModeRemoteHead, EnvironmentInitializerSpecsGitTargetModeCloneTargetModeRemoteCommit, EnvironmentInitializerSpecsGitTargetModeCloneTargetModeRemoteBranch, EnvironmentInitializerSpecsGitTargetModeCloneTargetModeLocalBranch, EnvironmentInitializerSpecsGitTargetModeCloneTargetModeRemoteTag:
return true
}
return false
}
// EnvironmentInitializer specifies how an environment is to be initialized
type EnvironmentInitializerParam struct {
Specs param.Field[[]EnvironmentInitializerSpecParam] `json:"specs"`
}
func (r EnvironmentInitializerParam) MarshalJSON() (data []byte, err error) {
return apijson.MarshalRoot(r)
}
type EnvironmentInitializerSpecParam struct {
ContextURL param.Field[EnvironmentInitializerSpecsContextURLParam] `json:"contextUrl"`
Git param.Field[EnvironmentInitializerSpecsGitParam] `json:"git"`
}
func (r EnvironmentInitializerSpecParam) MarshalJSON() (data []byte, err error) {
return apijson.MarshalRoot(r)
}
type EnvironmentInitializerSpecsContextURLParam struct {
// url is the URL from which the environment is created
URL param.Field[string] `json:"url" format:"uri"`
}
func (r EnvironmentInitializerSpecsContextURLParam) MarshalJSON() (data []byte, err error) {
return apijson.MarshalRoot(r)
}
type EnvironmentInitializerSpecsGitParam struct {
// a path relative to the environment root in which the code will be checked out to
CheckoutLocation param.Field[string] `json:"checkoutLocation"`
// the value for the clone target mode - use depends on the target mode
CloneTarget param.Field[string] `json:"cloneTarget"`
// remote_uri is the Git remote origin
RemoteUri param.Field[string] `json:"remoteUri"`
// the target mode determines what gets checked out
TargetMode param.Field[EnvironmentInitializerSpecsGitTargetMode] `json:"targetMode"`
// upstream_Remote_uri is the fork upstream of a repository
UpstreamRemoteUri param.Field[string] `json:"upstreamRemoteUri"`
}
func (r EnvironmentInitializerSpecsGitParam) MarshalJSON() (data []byte, err error) {
return apijson.MarshalRoot(r)
}
type Project struct {
// Use `environment_classes` instead.
//
// Deprecated: deprecated
EnvironmentClass shared.ProjectEnvironmentClass `json:"environmentClass" api:"required"`
// id is the unique identifier for the project
ID string `json:"id" format:"uuid"`
// automations_file_path is the path to the automations file relative to the repo
// root
AutomationsFilePath string `json:"automationsFilePath"`
// desired_phase is the desired phase of the project When set to DELETED, the
// project is pending deletion
DesiredPhase ProjectPhase `json:"desiredPhase"`
// devcontainer_file_path is the path to the devcontainer file relative to the repo
// root
DevcontainerFilePath string `json:"devcontainerFilePath"`
// environment_classes is the list of environment classes for the project
EnvironmentClasses []shared.ProjectEnvironmentClass `json:"environmentClasses"`
// initializer is the content initializer
Initializer EnvironmentInitializer `json:"initializer"`
Metadata ProjectMetadata `json:"metadata"`
// prebuild_configuration defines how prebuilds are created for this project.
PrebuildConfiguration ProjectPrebuildConfiguration `json:"prebuildConfiguration"`
// recommended_editors specifies the editors recommended for this project.
RecommendedEditors RecommendedEditors `json:"recommendedEditors"`
// technical_description is a detailed technical description of the project This
// field is not returned by default in GetProject or ListProjects responses
TechnicalDescription string `json:"technicalDescription"`
UsedBy ProjectUsedBy `json:"usedBy"`
JSON projectJSON `json:"-"`
}
// projectJSON contains the JSON metadata for the struct [Project]
type projectJSON struct {
EnvironmentClass apijson.Field
ID apijson.Field
AutomationsFilePath apijson.Field
DesiredPhase apijson.Field
DevcontainerFilePath apijson.Field
EnvironmentClasses apijson.Field
Initializer apijson.Field
Metadata apijson.Field
PrebuildConfiguration apijson.Field
RecommendedEditors apijson.Field
TechnicalDescription apijson.Field
UsedBy apijson.Field
raw string
ExtraFields map[string]apijson.Field
}
func (r *Project) UnmarshalJSON(data []byte) (err error) {
return apijson.UnmarshalRoot(data, r)
}
func (r projectJSON) RawJSON() string {
return r.raw
}
type ProjectUsedBy struct {
// Subjects are the 10 most recent subjects who have used the project to create an
// environment
Subjects []shared.Subject `json:"subjects"`
// Total number of unique subjects who have used the project
TotalSubjects int64 `json:"totalSubjects"`
JSON projectUsedByJSON `json:"-"`
}
// projectUsedByJSON contains the JSON metadata for the struct [ProjectUsedBy]
type projectUsedByJSON struct {
Subjects apijson.Field
TotalSubjects apijson.Field
raw string
ExtraFields map[string]apijson.Field
}
func (r *ProjectUsedBy) UnmarshalJSON(data []byte) (err error) {
return apijson.UnmarshalRoot(data, r)
}
func (r projectUsedByJSON) RawJSON() string {
return r.raw
}
type ProjectMetadata struct {
// A Timestamp represents a point in time independent of any time zone or local
// calendar, encoded as a count of seconds and fractions of seconds at nanosecond
// resolution. The count is relative to an epoch at UTC midnight on January 1,
// 1970, in the proleptic Gregorian calendar which extends the Gregorian calendar
// backwards to year one.
//
// All minutes are 60 seconds long. Leap seconds are "smeared" so that no leap
// second table is needed for interpretation, using a
// [24-hour linear smear](https://developers.google.com/time/smear).
//
// The range is from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z. By
// restricting to that range, we ensure that we can convert to and from
// [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) date strings.
//
// # Examples
//
// Example 1: Compute Timestamp from POSIX `time()`.
//
// Timestamp timestamp;
// timestamp.set_seconds(time(NULL));
// timestamp.set_nanos(0);
//
// Example 2: Compute Timestamp from POSIX `gettimeofday()`.
//
// struct timeval tv;
// gettimeofday(&tv, NULL);
//
// Timestamp timestamp;
// timestamp.set_seconds(tv.tv_sec);
// timestamp.set_nanos(tv.tv_usec * 1000);
//
// Example 3: Compute Timestamp from Win32 `GetSystemTimeAsFileTime()`.
//
// FILETIME ft;
// GetSystemTimeAsFileTime(&ft);
// UINT64 ticks = (((UINT64)ft.dwHighDateTime) << 32) | ft.dwLowDateTime;
//
// // A Windows tick is 100 nanoseconds. Windows epoch 1601-01-01T00:00:00Z
// // is 11644473600 seconds before Unix epoch 1970-01-01T00:00:00Z.
// Timestamp timestamp;
// timestamp.set_seconds((INT64) ((ticks / 10000000) - 11644473600LL));
// timestamp.set_nanos((INT32) ((ticks % 10000000) * 100));
//
// Example 4: Compute Timestamp from Java `System.currentTimeMillis()`.
//
// long millis = System.currentTimeMillis();
//
// Timestamp timestamp = Timestamp.newBuilder().setSeconds(millis / 1000)
// .setNanos((int) ((millis % 1000) * 1000000)).build();
//
// Example 5: Compute Timestamp from Java `Instant.now()`.
//
// Instant now = Instant.now();
//
// Timestamp timestamp =
// Timestamp.newBuilder().setSeconds(now.getEpochSecond())
// .setNanos(now.getNano()).build();
//
// Example 6: Compute Timestamp from current time in Python.
//
// timestamp = Timestamp()
// timestamp.GetCurrentTime()
//
// # JSON Mapping
//
// In JSON format, the Timestamp type is encoded as a string in the
// [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format. That is, the format is
// "{year}-{month}-{day}T{hour}:{min}:{sec}[.{frac_sec}]Z" where {year} is always
// expressed using four digits while {month}, {day}, {hour}, {min}, and {sec} are
// zero-padded to two digits each. The fractional seconds, which can go up to 9
// digits (i.e. up to 1 nanosecond resolution), are optional. The "Z" suffix
// indicates the timezone ("UTC"); the timezone is required. A proto3 JSON
// serializer should always use UTC (as indicated by "Z") when printing the
// Timestamp type and a proto3 JSON parser should be able to accept both UTC and
// other timezones (as indicated by an offset).
//
// For example, "2017-01-15T01:30:15.01Z" encodes 15.01 seconds past 01:30 UTC on
// January 15, 2017.
//
// In JavaScript, one can convert a Date object to this format using the standard
// [toISOString()](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toISOString)
// method. In Python, a standard `datetime.datetime` object can be converted to
// this format using
// [`strftime`](https://docs.python.org/2/library/time.html#time.strftime) with the
// time format spec '%Y-%m-%dT%H:%M:%S.%fZ'. Likewise, in Java, one can use the
// Joda Time's
// [`ISODateTimeFormat.dateTime()`](<http://joda-time.sourceforge.net/apidocs/org/joda/time/format/ISODateTimeFormat.html#dateTime()>)
// to obtain a formatter capable of generating timestamps in this format.
CreatedAt time.Time `json:"createdAt" format:"date-time"`
// creator is the identity of the project creator
Creator shared.Subject `json:"creator"`
// name is the human readable name of the project
Name string `json:"name"`
// organization_id is the ID of the organization that contains the environment
OrganizationID string `json:"organizationId" format:"uuid"`
// A Timestamp represents a point in time independent of any time zone or local
// calendar, encoded as a count of seconds and fractions of seconds at nanosecond
// resolution. The count is relative to an epoch at UTC midnight on January 1,
// 1970, in the proleptic Gregorian calendar which extends the Gregorian calendar
// backwards to year one.
//
// All minutes are 60 seconds long. Leap seconds are "smeared" so that no leap
// second table is needed for interpretation, using a
// [24-hour linear smear](https://developers.google.com/time/smear).
//
// The range is from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z. By
// restricting to that range, we ensure that we can convert to and from
// [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) date strings.
//
// # Examples
//
// Example 1: Compute Timestamp from POSIX `time()`.
//
// Timestamp timestamp;
// timestamp.set_seconds(time(NULL));
// timestamp.set_nanos(0);
//
// Example 2: Compute Timestamp from POSIX `gettimeofday()`.
//
// struct timeval tv;
// gettimeofday(&tv, NULL);
//
// Timestamp timestamp;
// timestamp.set_seconds(tv.tv_sec);
// timestamp.set_nanos(tv.tv_usec * 1000);
//
// Example 3: Compute Timestamp from Win32 `GetSystemTimeAsFileTime()`.
//
// FILETIME ft;
// GetSystemTimeAsFileTime(&ft);
// UINT64 ticks = (((UINT64)ft.dwHighDateTime) << 32) | ft.dwLowDateTime;
//
// // A Windows tick is 100 nanoseconds. Windows epoch 1601-01-01T00:00:00Z
// // is 11644473600 seconds before Unix epoch 1970-01-01T00:00:00Z.
// Timestamp timestamp;
// timestamp.set_seconds((INT64) ((ticks / 10000000) - 11644473600LL));
// timestamp.set_nanos((INT32) ((ticks % 10000000) * 100));
//
// Example 4: Compute Timestamp from Java `System.currentTimeMillis()`.
//
// long millis = System.currentTimeMillis();
//
// Timestamp timestamp = Timestamp.newBuilder().setSeconds(millis / 1000)
// .setNanos((int) ((millis % 1000) * 1000000)).build();
//
// Example 5: Compute Timestamp from Java `Instant.now()`.
//
// Instant now = Instant.now();
//
// Timestamp timestamp =
// Timestamp.newBuilder().setSeconds(now.getEpochSecond())
// .setNanos(now.getNano()).build();
//
// Example 6: Compute Timestamp from current time in Python.
//
// timestamp = Timestamp()
// timestamp.GetCurrentTime()
//
// # JSON Mapping
//
// In JSON format, the Timestamp type is encoded as a string in the
// [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format. That is, the format is
// "{year}-{month}-{day}T{hour}:{min}:{sec}[.{frac_sec}]Z" where {year} is always
// expressed using four digits while {month}, {day}, {hour}, {min}, and {sec} are
// zero-padded to two digits each. The fractional seconds, which can go up to 9
// digits (i.e. up to 1 nanosecond resolution), are optional. The "Z" suffix
// indicates the timezone ("UTC"); the timezone is required. A proto3 JSON
// serializer should always use UTC (as indicated by "Z") when printing the
// Timestamp type and a proto3 JSON parser should be able to accept both UTC and
// other timezones (as indicated by an offset).
//
// For example, "2017-01-15T01:30:15.01Z" encodes 15.01 seconds past 01:30 UTC on
// January 15, 2017.
//
// In JavaScript, one can convert a Date object to this format using the standard
// [toISOString()](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toISOString)
// method. In Python, a standard `datetime.datetime` object can be converted to
// this format using
// [`strftime`](https://docs.python.org/2/library/time.html#time.strftime) with the
// time format spec '%Y-%m-%dT%H:%M:%S.%fZ'. Likewise, in Java, one can use the
// Joda Time's
// [`ISODateTimeFormat.dateTime()`](<http://joda-time.sourceforge.net/apidocs/org/joda/time/format/ISODateTimeFormat.html#dateTime()>)
// to obtain a formatter capable of generating timestamps in this format.
UpdatedAt time.Time `json:"updatedAt" format:"date-time"`
JSON projectMetadataJSON `json:"-"`
}
// projectMetadataJSON contains the JSON metadata for the struct [ProjectMetadata]
type projectMetadataJSON struct {
CreatedAt apijson.Field
Creator apijson.Field
Name apijson.Field
OrganizationID apijson.Field
UpdatedAt apijson.Field
raw string
ExtraFields map[string]apijson.Field
}
func (r *ProjectMetadata) UnmarshalJSON(data []byte) (err error) {
return apijson.UnmarshalRoot(data, r)
}
func (r projectMetadataJSON) RawJSON() string {
return r.raw
}
type ProjectPhase string
const (
ProjectPhaseUnspecified ProjectPhase = "PROJECT_PHASE_UNSPECIFIED"
ProjectPhaseActive ProjectPhase = "PROJECT_PHASE_ACTIVE"
ProjectPhaseDeleted ProjectPhase = "PROJECT_PHASE_DELETED"
)
func (r ProjectPhase) IsKnown() bool {
switch r {
case ProjectPhaseUnspecified, ProjectPhaseActive, ProjectPhaseDeleted:
return true
}
return false
}
// ProjectPrebuildConfiguration defines how prebuilds are created for a project.
// Prebuilds create environment snapshots that enable faster environment startup
// times.
type ProjectPrebuildConfiguration struct {
// enabled controls whether prebuilds are created for this project. When disabled,
// no automatic prebuilds will be triggered.
Enabled bool `json:"enabled"`
// enable_jetbrains_warmup controls whether JetBrains IDE warmup runs during
// prebuilds.
EnableJetbrainsWarmup bool `json:"enableJetbrainsWarmup"`
// environment_class_ids specifies which environment classes should have prebuilds
// created. If empty, no prebuilds are created.
EnvironmentClassIDs []string `json:"environmentClassIds" format:"uuid"`
// executor specifies who runs prebuilds for this project. The executor's SCM
// credentials are used to clone the repository. If not set, defaults to the
// project creator.
Executor shared.Subject `json:"executor"`
// timeout is the maximum duration allowed for a prebuild to complete. If not
// specified, defaults to 1 hour. Must be between 5 minutes and 2 hours.
Timeout string `json:"timeout" format:"regex"`
// trigger defines when prebuilds should be created.
Trigger ProjectPrebuildConfigurationTrigger `json:"trigger"`
JSON projectPrebuildConfigurationJSON `json:"-"`
}
// projectPrebuildConfigurationJSON contains the JSON metadata for the struct
// [ProjectPrebuildConfiguration]
type projectPrebuildConfigurationJSON struct {
Enabled apijson.Field
EnableJetbrainsWarmup apijson.Field
EnvironmentClassIDs apijson.Field
Executor apijson.Field
Timeout apijson.Field
Trigger apijson.Field
raw string
ExtraFields map[string]apijson.Field
}
func (r *ProjectPrebuildConfiguration) UnmarshalJSON(data []byte) (err error) {
return apijson.UnmarshalRoot(data, r)
}
func (r projectPrebuildConfigurationJSON) RawJSON() string {
return r.raw
}
// trigger defines when prebuilds should be created.
type ProjectPrebuildConfigurationTrigger struct {
// daily_schedule triggers a prebuild once per day at the specified hour (UTC). The
// actual start time may vary slightly to distribute system load.
DailySchedule ProjectPrebuildConfigurationTriggerDailySchedule `json:"dailySchedule" api:"required"`
JSON projectPrebuildConfigurationTriggerJSON `json:"-"`
}
// projectPrebuildConfigurationTriggerJSON contains the JSON metadata for the
// struct [ProjectPrebuildConfigurationTrigger]
type projectPrebuildConfigurationTriggerJSON struct {
DailySchedule apijson.Field
raw string
ExtraFields map[string]apijson.Field
}
func (r *ProjectPrebuildConfigurationTrigger) UnmarshalJSON(data []byte) (err error) {
return apijson.UnmarshalRoot(data, r)
}
func (r projectPrebuildConfigurationTriggerJSON) RawJSON() string {
return r.raw
}
// daily_schedule triggers a prebuild once per day at the specified hour (UTC). The
// actual start time may vary slightly to distribute system load.
type ProjectPrebuildConfigurationTriggerDailySchedule struct {
// hour_utc is the hour of day (0-23) in UTC when the prebuild should start. The
// actual start time may be adjusted by a few minutes to balance system load.
HourUtc int64 `json:"hourUtc"`
JSON projectPrebuildConfigurationTriggerDailyScheduleJSON `json:"-"`
}
// projectPrebuildConfigurationTriggerDailyScheduleJSON contains the JSON metadata
// for the struct [ProjectPrebuildConfigurationTriggerDailySchedule]
type projectPrebuildConfigurationTriggerDailyScheduleJSON struct {
HourUtc apijson.Field
raw string
ExtraFields map[string]apijson.Field
}
func (r *ProjectPrebuildConfigurationTriggerDailySchedule) UnmarshalJSON(data []byte) (err error) {
return apijson.UnmarshalRoot(data, r)
}
func (r projectPrebuildConfigurationTriggerDailyScheduleJSON) RawJSON() string {
return r.raw
}
// ProjectPrebuildConfiguration defines how prebuilds are created for a project.
// Prebuilds create environment snapshots that enable faster environment startup
// times.
type ProjectPrebuildConfigurationParam struct {
// enabled controls whether prebuilds are created for this project. When disabled,
// no automatic prebuilds will be triggered.
Enabled param.Field[bool] `json:"enabled"`
// enable_jetbrains_warmup controls whether JetBrains IDE warmup runs during
// prebuilds.
EnableJetbrainsWarmup param.Field[bool] `json:"enableJetbrainsWarmup"`
// environment_class_ids specifies which environment classes should have prebuilds
// created. If empty, no prebuilds are created.
EnvironmentClassIDs param.Field[[]string] `json:"environmentClassIds" format:"uuid"`
// executor specifies who runs prebuilds for this project. The executor's SCM
// credentials are used to clone the repository. If not set, defaults to the
// project creator.
Executor param.Field[shared.SubjectParam] `json:"executor"`
// timeout is the maximum duration allowed for a prebuild to complete. If not
// specified, defaults to 1 hour. Must be between 5 minutes and 2 hours.
Timeout param.Field[string] `json:"timeout" format:"regex"`
// trigger defines when prebuilds should be created.
Trigger param.Field[ProjectPrebuildConfigurationTriggerParam] `json:"trigger"`
}
func (r ProjectPrebuildConfigurationParam) MarshalJSON() (data []byte, err error) {
return apijson.MarshalRoot(r)
}
// trigger defines when prebuilds should be created.
type ProjectPrebuildConfigurationTriggerParam struct {
// daily_schedule triggers a prebuild once per day at the specified hour (UTC). The
// actual start time may vary slightly to distribute system load.
DailySchedule param.Field[ProjectPrebuildConfigurationTriggerDailyScheduleParam] `json:"dailySchedule" api:"required"`
}
func (r ProjectPrebuildConfigurationTriggerParam) MarshalJSON() (data []byte, err error) {
return apijson.MarshalRoot(r)
}
// daily_schedule triggers a prebuild once per day at the specified hour (UTC). The
// actual start time may vary slightly to distribute system load.
type ProjectPrebuildConfigurationTriggerDailyScheduleParam struct {
// hour_utc is the hour of day (0-23) in UTC when the prebuild should start. The
// actual start time may be adjusted by a few minutes to balance system load.
HourUtc param.Field[int64] `json:"hourUtc"`
}
func (r ProjectPrebuildConfigurationTriggerDailyScheduleParam) MarshalJSON() (data []byte, err error) {
return apijson.MarshalRoot(r)
}
// RecommendedEditors contains the map of recommended editors and their versions.
type RecommendedEditors struct {
// editors maps editor aliases to their recommended versions. Key is the editor
// alias (e.g., "intellij", "goland", "vscode"). Value contains the list of
// recommended versions for that editor. If versions list is empty, all available
// versions are recommended. Example: {"intellij": {versions: ["2025.1",
// "2024.3"]}, "goland": {}}
Editors map[string]RecommendedEditorsEditor `json:"editors"`
JSON recommendedEditorsJSON `json:"-"`
}
// recommendedEditorsJSON contains the JSON metadata for the struct
// [RecommendedEditors]
type recommendedEditorsJSON struct {
Editors apijson.Field
raw string
ExtraFields map[string]apijson.Field
}
func (r *RecommendedEditors) UnmarshalJSON(data []byte) (err error) {
return apijson.UnmarshalRoot(data, r)
}
func (r recommendedEditorsJSON) RawJSON() string {
return r.raw
}
// EditorVersions contains the recommended versions for an editor.
type RecommendedEditorsEditor struct {
// versions is the list of recommended versions for this editor. If empty, all