-
Notifications
You must be signed in to change notification settings - Fork 1.1k
/
bigqueryreservation-gen.go
4566 lines (4205 loc) · 176 KB
/
bigqueryreservation-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 2024 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 bigqueryreservation provides access to the BigQuery Reservation API.
//
// For product documentation, see: https://cloud.google.com/bigquery/
//
// # Library status
//
// These client libraries are officially supported by Google. However, this
// library is considered complete and is in maintenance mode. This means
// that we will address critical bugs and security issues but will not add
// any new features.
//
// When possible, we recommend using our newer
// [Cloud Client Libraries for Go](https://pkg.go.dev/cloud.google.com/go)
// that are still actively being worked and iterated on.
//
// # Creating a client
//
// Usage example:
//
// import "google.golang.org/api/bigqueryreservation/v1"
// ...
// ctx := context.Background()
// bigqueryreservationService, err := bigqueryreservation.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
//
// By default, all available scopes (see "Constants") are used to authenticate.
// To restrict scopes, use [google.golang.org/api/option.WithScopes]:
//
// bigqueryreservationService, err := bigqueryreservation.NewService(ctx, option.WithScopes(bigqueryreservation.CloudPlatformScope))
//
// To use an API key for authentication (note: some APIs do not support API
// keys), use [google.golang.org/api/option.WithAPIKey]:
//
// bigqueryreservationService, err := bigqueryreservation.NewService(ctx, option.WithAPIKey("AIza..."))
//
// To use an OAuth token (e.g., a user token obtained via a three-legged OAuth
// flow, use [google.golang.org/api/option.WithTokenSource]:
//
// config := &oauth2.Config{...}
// // ...
// token, err := config.Exchange(ctx, ...)
// bigqueryreservationService, err := bigqueryreservation.NewService(ctx, option.WithTokenSource(config.TokenSource(ctx, token)))
//
// See [google.golang.org/api/option.ClientOption] for details on options.
package bigqueryreservation // import "google.golang.org/api/bigqueryreservation/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
var _ = internal.Version
const apiId = "bigqueryreservation:v1"
const apiName = "bigqueryreservation"
const apiVersion = "v1"
const basePath = "https://bigqueryreservation.googleapis.com/"
const basePathTemplate = "https://bigqueryreservation.UNIVERSE_DOMAIN/"
const mtlsBasePath = "https://bigqueryreservation.mtls.googleapis.com/"
const defaultUniverseDomain = "googleapis.com"
// OAuth2 scopes used by this API.
const (
// View and manage your data in Google BigQuery and see the email
// address for your Google Account
BigqueryScope = "https://www.googleapis.com/auth/bigquery"
// 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 := internaloption.WithDefaultScopes(
"https://www.googleapis.com/auth/bigquery",
"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.WithDefaultEndpointTemplate(basePathTemplate))
opts = append(opts, internaloption.WithDefaultMTLSEndpoint(mtlsBasePath))
opts = append(opts, internaloption.WithDefaultUniverseDomain(defaultUniverseDomain))
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.CapacityCommitments = NewProjectsLocationsCapacityCommitmentsService(s)
rs.Reservations = NewProjectsLocationsReservationsService(s)
return rs
}
type ProjectsLocationsService struct {
s *Service
CapacityCommitments *ProjectsLocationsCapacityCommitmentsService
Reservations *ProjectsLocationsReservationsService
}
func NewProjectsLocationsCapacityCommitmentsService(s *Service) *ProjectsLocationsCapacityCommitmentsService {
rs := &ProjectsLocationsCapacityCommitmentsService{s: s}
return rs
}
type ProjectsLocationsCapacityCommitmentsService struct {
s *Service
}
func NewProjectsLocationsReservationsService(s *Service) *ProjectsLocationsReservationsService {
rs := &ProjectsLocationsReservationsService{s: s}
rs.Assignments = NewProjectsLocationsReservationsAssignmentsService(s)
return rs
}
type ProjectsLocationsReservationsService struct {
s *Service
Assignments *ProjectsLocationsReservationsAssignmentsService
}
func NewProjectsLocationsReservationsAssignmentsService(s *Service) *ProjectsLocationsReservationsAssignmentsService {
rs := &ProjectsLocationsReservationsAssignmentsService{s: s}
return rs
}
type ProjectsLocationsReservationsAssignmentsService struct {
s *Service
}
// Assignment: An assignment allows a project to submit jobs of a
// certain type using slots from the specified reservation.
type Assignment struct {
// Assignee: The resource which will use the reservation. E.g.
// `projects/myproject`, `folders/123`, or `organizations/456`.
Assignee string `json:"assignee,omitempty"`
// JobType: Which type of jobs will use the reservation.
//
// Possible values:
// "JOB_TYPE_UNSPECIFIED" - Invalid type. Requests with this value
// will be rejected with error code `google.rpc.Code.INVALID_ARGUMENT`.
// "PIPELINE" - Pipeline (load/export) jobs from the project will use
// the reservation.
// "QUERY" - Query jobs from the project will use the reservation.
// "ML_EXTERNAL" - BigQuery ML jobs that use services external to
// BigQuery for model training. These jobs will not utilize idle slots
// from other reservations.
// "BACKGROUND" - Background jobs that BigQuery runs for the customers
// in the background.
JobType string `json:"jobType,omitempty"`
// Name: Output only. Name of the resource. E.g.:
// `projects/myproject/locations/US/reservations/team1-prod/assignments/1
// 23`. The assignment_id must only contain lower case alphanumeric
// characters or dashes and the max length is 64 characters.
Name string `json:"name,omitempty"`
// State: Output only. State of the assignment.
//
// Possible values:
// "STATE_UNSPECIFIED" - Invalid state value.
// "PENDING" - Queries from assignee will be executed as on-demand, if
// related assignment is pending.
// "ACTIVE" - Assignment is ready.
State string `json:"state,omitempty"`
// ServerResponse contains the HTTP response code and headers from the
// server.
googleapi.ServerResponse `json:"-"`
// ForceSendFields is a list of field names (e.g. "Assignee") 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. "Assignee") 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 *Assignment) MarshalJSON() ([]byte, error) {
type NoMethod Assignment
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// Autoscale: Auto scaling settings.
type Autoscale struct {
// CurrentSlots: Output only. The slot capacity added to this
// reservation when autoscale happens. Will be between [0, max_slots].
CurrentSlots int64 `json:"currentSlots,omitempty,string"`
// MaxSlots: Number of slots to be scaled when needed.
MaxSlots int64 `json:"maxSlots,omitempty,string"`
// ForceSendFields is a list of field names (e.g. "CurrentSlots") 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. "CurrentSlots") 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 *Autoscale) MarshalJSON() ([]byte, error) {
type NoMethod Autoscale
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// BiReservation: Represents a BI Reservation.
type BiReservation struct {
// Name: The resource name of the singleton BI reservation. Reservation
// names have the form
// `projects/{project_id}/locations/{location_id}/biReservation`.
Name string `json:"name,omitempty"`
// PreferredTables: Preferred tables to use BI capacity for.
PreferredTables []*TableReference `json:"preferredTables,omitempty"`
// Size: Size of a reservation, in bytes.
Size int64 `json:"size,omitempty,string"`
// UpdateTime: Output only. The last update timestamp of a reservation.
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. "Name") 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. "Name") to include in API
// requests with the JSON null value. By default, fields with empty
// values are omitted from API requests. However, any field with an
// empty value appearing in NullFields will be sent to the server as
// null. It is an error if a field in this list has a non-empty value.
// This may be used to include null fields in Patch requests.
NullFields []string `json:"-"`
}
func (s *BiReservation) MarshalJSON() ([]byte, error) {
type NoMethod BiReservation
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// CapacityCommitment: Capacity commitment is a way to purchase compute
// capacity for BigQuery jobs (in the form of slots) with some committed
// period of usage. Annual commitments renew by default. Commitments can
// be removed after their commitment end time passes. In order to remove
// annual commitment, its plan needs to be changed to monthly or flex
// first. A capacity commitment resource exists as a child resource of
// the admin project.
type CapacityCommitment struct {
// CommitmentEndTime: Output only. The end of the current commitment
// period. It is applicable only for ACTIVE capacity commitments.
CommitmentEndTime string `json:"commitmentEndTime,omitempty"`
// CommitmentStartTime: Output only. The start of the current commitment
// period. It is applicable only for ACTIVE capacity commitments.
CommitmentStartTime string `json:"commitmentStartTime,omitempty"`
// Edition: Edition of the capacity commitment.
//
// Possible values:
// "EDITION_UNSPECIFIED" - Default value, which will be treated as
// ENTERPRISE.
// "STANDARD" - Standard edition.
// "ENTERPRISE" - Enterprise edition.
// "ENTERPRISE_PLUS" - Enterprise plus edition.
Edition string `json:"edition,omitempty"`
// FailureStatus: Output only. For FAILED commitment plan, provides the
// reason of failure.
FailureStatus *Status `json:"failureStatus,omitempty"`
// IsFlatRate: Output only. If true, the commitment is a flat-rate
// commitment, otherwise, it's an edition commitment.
IsFlatRate bool `json:"isFlatRate,omitempty"`
// MultiRegionAuxiliary: Applicable only for commitments located within
// one of the BigQuery multi-regions (US or EU). If set to true, this
// commitment is placed in the organization's secondary region which is
// designated for disaster recovery purposes. If false, this commitment
// is placed in the organization's default region. NOTE: this is a
// preview feature. Project must be allow-listed in order to set this
// field.
MultiRegionAuxiliary bool `json:"multiRegionAuxiliary,omitempty"`
// Name: Output only. The resource name of the capacity commitment,
// e.g., `projects/myproject/locations/US/capacityCommitments/123` The
// commitment_id must only contain lower case alphanumeric characters or
// dashes. It must start with a letter and must not end with a dash. Its
// maximum length is 64 characters.
Name string `json:"name,omitempty"`
// Plan: Capacity commitment commitment plan.
//
// Possible values:
// "COMMITMENT_PLAN_UNSPECIFIED" - Invalid plan value. Requests with
// this value will be rejected with error code
// `google.rpc.Code.INVALID_ARGUMENT`.
// "FLEX" - Flex commitments have committed period of 1 minute after
// becoming ACTIVE. After that, they are not in a committed period
// anymore and can be removed any time.
// "FLEX_FLAT_RATE" - Same as FLEX, should only be used if flat-rate
// commitments are still available.
// "TRIAL" - Trial commitments have a committed period of 182 days
// after becoming ACTIVE. After that, they are converted to a new
// commitment based on the `renewal_plan`. Default `renewal_plan` for
// Trial commitment is Flex so that it can be deleted right after
// committed period ends.
// "MONTHLY" - Monthly commitments have a committed period of 30 days
// after becoming ACTIVE. After that, they are not in a committed period
// anymore and can be removed any time.
// "MONTHLY_FLAT_RATE" - Same as MONTHLY, should only be used if
// flat-rate commitments are still available.
// "ANNUAL" - Annual commitments have a committed period of 365 days
// after becoming ACTIVE. After that they are converted to a new
// commitment based on the renewal_plan.
// "ANNUAL_FLAT_RATE" - Same as ANNUAL, should only be used if
// flat-rate commitments are still available.
// "THREE_YEAR" - 3-year commitments have a committed period of 1095(3
// * 365) days after becoming ACTIVE. After that they are converted to a
// new commitment based on the renewal_plan.
// "NONE" - Should only be used for `renewal_plan` and is only
// meaningful if edition is specified to values other than
// EDITION_UNSPECIFIED. Otherwise CreateCapacityCommitmentRequest or
// UpdateCapacityCommitmentRequest will be rejected with error code
// `google.rpc.Code.INVALID_ARGUMENT`. If the renewal_plan is NONE,
// capacity commitment will be removed at the end of its commitment
// period.
Plan string `json:"plan,omitempty"`
// RenewalPlan: The plan this capacity commitment is converted to after
// commitment_end_time passes. Once the plan is changed, committed
// period is extended according to commitment plan. Only applicable for
// ANNUAL and TRIAL commitments.
//
// Possible values:
// "COMMITMENT_PLAN_UNSPECIFIED" - Invalid plan value. Requests with
// this value will be rejected with error code
// `google.rpc.Code.INVALID_ARGUMENT`.
// "FLEX" - Flex commitments have committed period of 1 minute after
// becoming ACTIVE. After that, they are not in a committed period
// anymore and can be removed any time.
// "FLEX_FLAT_RATE" - Same as FLEX, should only be used if flat-rate
// commitments are still available.
// "TRIAL" - Trial commitments have a committed period of 182 days
// after becoming ACTIVE. After that, they are converted to a new
// commitment based on the `renewal_plan`. Default `renewal_plan` for
// Trial commitment is Flex so that it can be deleted right after
// committed period ends.
// "MONTHLY" - Monthly commitments have a committed period of 30 days
// after becoming ACTIVE. After that, they are not in a committed period
// anymore and can be removed any time.
// "MONTHLY_FLAT_RATE" - Same as MONTHLY, should only be used if
// flat-rate commitments are still available.
// "ANNUAL" - Annual commitments have a committed period of 365 days
// after becoming ACTIVE. After that they are converted to a new
// commitment based on the renewal_plan.
// "ANNUAL_FLAT_RATE" - Same as ANNUAL, should only be used if
// flat-rate commitments are still available.
// "THREE_YEAR" - 3-year commitments have a committed period of 1095(3
// * 365) days after becoming ACTIVE. After that they are converted to a
// new commitment based on the renewal_plan.
// "NONE" - Should only be used for `renewal_plan` and is only
// meaningful if edition is specified to values other than
// EDITION_UNSPECIFIED. Otherwise CreateCapacityCommitmentRequest or
// UpdateCapacityCommitmentRequest will be rejected with error code
// `google.rpc.Code.INVALID_ARGUMENT`. If the renewal_plan is NONE,
// capacity commitment will be removed at the end of its commitment
// period.
RenewalPlan string `json:"renewalPlan,omitempty"`
// SlotCount: Number of slots in this commitment.
SlotCount int64 `json:"slotCount,omitempty,string"`
// State: Output only. State of the commitment.
//
// Possible values:
// "STATE_UNSPECIFIED" - Invalid state value.
// "PENDING" - Capacity commitment is pending provisioning. Pending
// capacity commitment does not contribute to the project's
// slot_capacity.
// "ACTIVE" - Once slots are provisioned, capacity commitment becomes
// active. slot_count is added to the project's slot_capacity.
// "FAILED" - Capacity commitment is failed to be activated by the
// backend.
State string `json:"state,omitempty"`
// ServerResponse contains the HTTP response code and headers from the
// server.
googleapi.ServerResponse `json:"-"`
// ForceSendFields is a list of field names (e.g. "CommitmentEndTime")
// 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. "CommitmentEndTime") 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 *CapacityCommitment) MarshalJSON() ([]byte, error) {
type NoMethod CapacityCommitment
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); }
type Empty struct {
// ServerResponse contains the HTTP response code and headers from the
// server.
googleapi.ServerResponse `json:"-"`
}
// ListAssignmentsResponse: The response for
// ReservationService.ListAssignments.
type ListAssignmentsResponse struct {
// Assignments: List of assignments visible to the user.
Assignments []*Assignment `json:"assignments,omitempty"`
// NextPageToken: Token to retrieve the next page of results, or empty
// if there are no more results in the list.
NextPageToken string `json:"nextPageToken,omitempty"`
// ServerResponse contains the HTTP response code and headers from the
// server.
googleapi.ServerResponse `json:"-"`
// ForceSendFields is a list of field names (e.g. "Assignments") 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. "Assignments") 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 *ListAssignmentsResponse) MarshalJSON() ([]byte, error) {
type NoMethod ListAssignmentsResponse
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// ListCapacityCommitmentsResponse: The response for
// ReservationService.ListCapacityCommitments.
type ListCapacityCommitmentsResponse struct {
// CapacityCommitments: List of capacity commitments visible to the
// user.
CapacityCommitments []*CapacityCommitment `json:"capacityCommitments,omitempty"`
// NextPageToken: Token to retrieve the next page of results, or empty
// if there are no more results in the list.
NextPageToken string `json:"nextPageToken,omitempty"`
// ServerResponse contains the HTTP response code and headers from the
// server.
googleapi.ServerResponse `json:"-"`
// ForceSendFields is a list of field names (e.g. "CapacityCommitments")
// 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. "CapacityCommitments") 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 *ListCapacityCommitmentsResponse) MarshalJSON() ([]byte, error) {
type NoMethod ListCapacityCommitmentsResponse
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// ListReservationsResponse: The response for
// ReservationService.ListReservations.
type ListReservationsResponse struct {
// NextPageToken: Token to retrieve the next page of results, or empty
// if there are no more results in the list.
NextPageToken string `json:"nextPageToken,omitempty"`
// Reservations: List of reservations visible to the user.
Reservations []*Reservation `json:"reservations,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 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. "NextPageToken") 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 *ListReservationsResponse) MarshalJSON() ([]byte, error) {
type NoMethod ListReservationsResponse
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// MergeCapacityCommitmentsRequest: The request for
// ReservationService.MergeCapacityCommitments.
type MergeCapacityCommitmentsRequest struct {
// CapacityCommitmentIds: Ids of capacity commitments to merge. These
// capacity commitments must exist under admin project and location
// specified in the parent. ID is the last portion of capacity
// commitment name e.g., 'abc' for
// projects/myproject/locations/US/capacityCommitments/abc
CapacityCommitmentIds []string `json:"capacityCommitmentIds,omitempty"`
// ForceSendFields is a list of field names (e.g.
// "CapacityCommitmentIds") 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. "CapacityCommitmentIds") 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 *MergeCapacityCommitmentsRequest) MarshalJSON() ([]byte, error) {
type NoMethod MergeCapacityCommitmentsRequest
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// MoveAssignmentRequest: The request for
// ReservationService.MoveAssignment. **Note**:
// "bigquery.reservationAssignments.create" permission is required on
// the destination_id. **Note**:
// "bigquery.reservationAssignments.create" and
// "bigquery.reservationAssignments.delete" permission are required on
// the related assignee.
type MoveAssignmentRequest struct {
// AssignmentId: The optional assignment ID. A new assignment name is
// generated if this field is empty. This field can contain only
// lowercase alphanumeric characters or dashes. Max length is 64
// characters.
AssignmentId string `json:"assignmentId,omitempty"`
// DestinationId: The new reservation ID, e.g.:
// `projects/myotherproject/locations/US/reservations/team2-prod`
DestinationId string `json:"destinationId,omitempty"`
// ForceSendFields is a list of field names (e.g. "AssignmentId") 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. "AssignmentId") 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 *MoveAssignmentRequest) MarshalJSON() ([]byte, error) {
type NoMethod MoveAssignmentRequest
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// Reservation: A reservation is a mechanism used to guarantee slots to
// users.
type Reservation struct {
// Autoscale: The configuration parameters for the auto scaling feature.
Autoscale *Autoscale `json:"autoscale,omitempty"`
// Concurrency: Job concurrency target which sets a soft upper bound on
// the number of jobs that can run concurrently in this reservation.
// This is a soft target due to asynchronous nature of the system and
// various optimizations for small queries. Default value is 0 which
// means that concurrency target will be automatically computed by the
// system. NOTE: this field is exposed as `target_job_concurrency` in
// the Information Schema, DDL and BQ CLI.
Concurrency int64 `json:"concurrency,omitempty,string"`
// CreationTime: Output only. Creation time of the reservation.
CreationTime string `json:"creationTime,omitempty"`
// Edition: Edition of the reservation.
//
// Possible values:
// "EDITION_UNSPECIFIED" - Default value, which will be treated as
// ENTERPRISE.
// "STANDARD" - Standard edition.
// "ENTERPRISE" - Enterprise edition.
// "ENTERPRISE_PLUS" - Enterprise plus edition.
Edition string `json:"edition,omitempty"`
// IgnoreIdleSlots: If false, any query or pipeline job using this
// reservation will use idle slots from other reservations within the
// same admin project. If true, a query or pipeline job using this
// reservation will execute with the slot capacity specified in the
// slot_capacity field at most.
IgnoreIdleSlots bool `json:"ignoreIdleSlots,omitempty"`
// MultiRegionAuxiliary: Applicable only for reservations located within
// one of the BigQuery multi-regions (US or EU). If set to true, this
// reservation is placed in the organization's secondary region which is
// designated for disaster recovery purposes. If false, this reservation
// is placed in the organization's default region. NOTE: this is a
// preview feature. Project must be allow-listed in order to set this
// field.
MultiRegionAuxiliary bool `json:"multiRegionAuxiliary,omitempty"`
// Name: The resource name of the reservation, e.g.,
// `projects/*/locations/*/reservations/team1-prod`. The reservation_id
// must only contain lower case alphanumeric characters or dashes. It
// must start with a letter and must not end with a dash. Its maximum
// length is 64 characters.
Name string `json:"name,omitempty"`
// SlotCapacity: Baseline slots available to this reservation. A slot is
// a unit of computational power in BigQuery, and serves as the unit of
// parallelism. Queries using this reservation might use more slots
// during runtime if ignore_idle_slots is set to false, or autoscaling
// is enabled. If edition is EDITION_UNSPECIFIED and total slot_capacity
// of the reservation and its siblings exceeds the total slot_count of
// all capacity commitments, the request will fail with
// `google.rpc.Code.RESOURCE_EXHAUSTED`. If edition is any value but
// EDITION_UNSPECIFIED, then the above requirement is not needed. The
// total slot_capacity of the reservation and its siblings may exceed
// the total slot_count of capacity commitments. In that case, the
// exceeding slots will be charged with the autoscale SKU. You can
// increase the number of baseline slots in a reservation every few
// minutes. If you want to decrease your baseline slots, you are limited
// to once an hour if you have recently changed your baseline slot
// capacity and your baseline slots exceed your committed slots.
// Otherwise, you can decrease your baseline slots every few minutes.
SlotCapacity int64 `json:"slotCapacity,omitempty,string"`
// UpdateTime: Output only. Last update time of the reservation.
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. "Autoscale") 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. "Autoscale") 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 *Reservation) MarshalJSON() ([]byte, error) {
type NoMethod Reservation
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// SearchAllAssignmentsResponse: The response for
// ReservationService.SearchAllAssignments.
type SearchAllAssignmentsResponse struct {
// Assignments: List of assignments visible to the user.
Assignments []*Assignment `json:"assignments,omitempty"`
// NextPageToken: Token to retrieve the next page of results, or empty
// if there are no more results in the list.
NextPageToken string `json:"nextPageToken,omitempty"`
// ServerResponse contains the HTTP response code and headers from the
// server.
googleapi.ServerResponse `json:"-"`
// ForceSendFields is a list of field names (e.g. "Assignments") 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. "Assignments") 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 *SearchAllAssignmentsResponse) MarshalJSON() ([]byte, error) {
type NoMethod SearchAllAssignmentsResponse
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// SearchAssignmentsResponse: The response for
// ReservationService.SearchAssignments.
type SearchAssignmentsResponse struct {
// Assignments: List of assignments visible to the user.
Assignments []*Assignment `json:"assignments,omitempty"`
// NextPageToken: Token to retrieve the next page of results, or empty
// if there are no more results in the list.
NextPageToken string `json:"nextPageToken,omitempty"`
// ServerResponse contains the HTTP response code and headers from the
// server.
googleapi.ServerResponse `json:"-"`
// ForceSendFields is a list of field names (e.g. "Assignments") 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. "Assignments") 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 *SearchAssignmentsResponse) MarshalJSON() ([]byte, error) {
type NoMethod SearchAssignmentsResponse
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// SplitCapacityCommitmentRequest: The request for
// ReservationService.SplitCapacityCommitment.
type SplitCapacityCommitmentRequest struct {
// SlotCount: Number of slots in the capacity commitment after the
// split.
SlotCount int64 `json:"slotCount,omitempty,string"`
// ForceSendFields is a list of field names (e.g. "SlotCount") 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. "SlotCount") 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 *SplitCapacityCommitmentRequest) MarshalJSON() ([]byte, error) {
type NoMethod SplitCapacityCommitmentRequest
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// SplitCapacityCommitmentResponse: The response for
// ReservationService.SplitCapacityCommitment.
type SplitCapacityCommitmentResponse struct {
// First: First capacity commitment, result of a split.
First *CapacityCommitment `json:"first,omitempty"`
// Second: Second capacity commitment, result of a split.
Second *CapacityCommitment `json:"second,omitempty"`
// ServerResponse contains the HTTP response code and headers from the
// server.
googleapi.ServerResponse `json:"-"`
// ForceSendFields is a list of field names (e.g. "First") 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. "First") 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 *SplitCapacityCommitmentResponse) MarshalJSON() ([]byte, error) {
type NoMethod SplitCapacityCommitmentResponse
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// 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). Each
// `Status` message contains three pieces of data: error code, error
// message, and error details. You can find out more about this error
// model and how to work with it in the API Design Guide
// (https://cloud.google.com/apis/design/errors).
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 is a
// common set of message types for APIs to use.
Details []googleapi.RawMessage `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 or default values are omitted from API requests. However, any