-
Notifications
You must be signed in to change notification settings - Fork 1.1k
/
billingbudgets-gen.go
1518 lines (1384 loc) · 61 KB
/
billingbudgets-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 billingbudgets provides access to the Cloud Billing Budget API.
//
// For product documentation, see: https://cloud.google.com/billing/docs/how-to/budget-api-overview
//
// Creating a client
//
// Usage example:
//
// import "google.golang.org/api/billingbudgets/v1"
// ...
// ctx := context.Background()
// billingbudgetsService, err := billingbudgets.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 option.WithScopes:
//
// billingbudgetsService, err := billingbudgets.NewService(ctx, option.WithScopes(billingbudgets.CloudPlatformScope))
//
// To use an API key for authentication (note: some APIs do not support API keys), use option.WithAPIKey:
//
// billingbudgetsService, err := billingbudgets.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, ...)
// billingbudgetsService, err := billingbudgets.NewService(ctx, option.WithTokenSource(config.TokenSource(ctx, token)))
//
// See https://godoc.org/google.golang.org/api/option/ for details on options.
package billingbudgets // import "google.golang.org/api/billingbudgets/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 = "billingbudgets:v1"
const apiName = "billingbudgets"
const apiVersion = "v1"
const basePath = "https://billingbudgets.googleapis.com/"
const mtlsBasePath = "https://billingbudgets.mtls.googleapis.com/"
// OAuth2 scopes used by this API.
const (
// View and manage your Google Cloud Platform billing accounts
CloudBillingScope = "https://www.googleapis.com/auth/cloud-billing"
// 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/cloud-billing",
"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.BillingAccounts = NewBillingAccountsService(s)
return s, nil
}
type Service struct {
client *http.Client
BasePath string // API endpoint base URL
UserAgent string // optional additional User-Agent fragment
BillingAccounts *BillingAccountsService
}
func (s *Service) userAgent() string {
if s.UserAgent == "" {
return googleapi.UserAgent
}
return googleapi.UserAgent + " " + s.UserAgent
}
func NewBillingAccountsService(s *Service) *BillingAccountsService {
rs := &BillingAccountsService{s: s}
rs.Budgets = NewBillingAccountsBudgetsService(s)
return rs
}
type BillingAccountsService struct {
s *Service
Budgets *BillingAccountsBudgetsService
}
func NewBillingAccountsBudgetsService(s *Service) *BillingAccountsBudgetsService {
rs := &BillingAccountsBudgetsService{s: s}
return rs
}
type BillingAccountsBudgetsService struct {
s *Service
}
// GoogleCloudBillingBudgetsV1Budget: A budget is a plan that describes
// what you expect to spend on Cloud projects, plus the rules to execute
// as spend is tracked against that plan, (for example, send an alert
// when 90% of the target spend is met). The budget time period is
// configurable, with options such as month (default), quarter, year, or
// custom time period.
type GoogleCloudBillingBudgetsV1Budget struct {
// Amount: Required. Budgeted amount.
Amount *GoogleCloudBillingBudgetsV1BudgetAmount `json:"amount,omitempty"`
// BudgetFilter: Optional. Filters that define which resources are used
// to compute the actual spend against the budget amount, such as
// projects, services, and the budget's time period, as well as other
// filters.
BudgetFilter *GoogleCloudBillingBudgetsV1Filter `json:"budgetFilter,omitempty"`
// DisplayName: User data for display name in UI. The name must be less
// than or equal to 60 characters.
DisplayName string `json:"displayName,omitempty"`
// Etag: Optional. Etag to validate that the object is unchanged for a
// read-modify-write operation. An empty etag causes an update to
// overwrite other changes.
Etag string `json:"etag,omitempty"`
// Name: Output only. Resource name of the budget. The resource name
// implies the scope of a budget. Values are of the form
// `billingAccounts/{billingAccountId}/budgets/{budgetId}`.
Name string `json:"name,omitempty"`
// NotificationsRule: Optional. Rules to apply to notifications sent
// based on budget spend and thresholds.
NotificationsRule *GoogleCloudBillingBudgetsV1NotificationsRule `json:"notificationsRule,omitempty"`
// ThresholdRules: Optional. Rules that trigger alerts (notifications of
// thresholds being crossed) when spend exceeds the specified
// percentages of the budget. Optional for `pubsubTopic` notifications.
// Required if using email notifications.
ThresholdRules []*GoogleCloudBillingBudgetsV1ThresholdRule `json:"thresholdRules,omitempty"`
// ServerResponse contains the HTTP response code and headers from the
// server.
googleapi.ServerResponse `json:"-"`
// ForceSendFields is a list of field names (e.g. "Amount") 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. "Amount") 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 *GoogleCloudBillingBudgetsV1Budget) MarshalJSON() ([]byte, error) {
type NoMethod GoogleCloudBillingBudgetsV1Budget
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// GoogleCloudBillingBudgetsV1BudgetAmount: The budgeted amount for each
// usage period.
type GoogleCloudBillingBudgetsV1BudgetAmount struct {
// LastPeriodAmount: Use the last period's actual spend as the budget
// for the present period. LastPeriodAmount can only be set when the
// budget's time period is a Filter.calendar_period. It cannot be set in
// combination with Filter.custom_period.
LastPeriodAmount *GoogleCloudBillingBudgetsV1LastPeriodAmount `json:"lastPeriodAmount,omitempty"`
// SpecifiedAmount: A specified amount to use as the budget.
// `currency_code` is optional. If specified when creating a budget, it
// must match the currency of the billing account. If specified when
// updating a budget, it must match the currency_code of the existing
// budget. The `currency_code` is provided on output.
SpecifiedAmount *GoogleTypeMoney `json:"specifiedAmount,omitempty"`
// ForceSendFields is a list of field names (e.g. "LastPeriodAmount") 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. "LastPeriodAmount") 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 *GoogleCloudBillingBudgetsV1BudgetAmount) MarshalJSON() ([]byte, error) {
type NoMethod GoogleCloudBillingBudgetsV1BudgetAmount
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// GoogleCloudBillingBudgetsV1CustomPeriod: All date times begin at 12
// AM US and Canadian Pacific Time (UTC-8).
type GoogleCloudBillingBudgetsV1CustomPeriod struct {
// EndDate: Optional. The end date of the time period. Budgets with
// elapsed end date won't be processed. If unset, specifies to track all
// usage incurred since the start_date.
EndDate *GoogleTypeDate `json:"endDate,omitempty"`
// StartDate: Required. The start date must be after January 1, 2017.
StartDate *GoogleTypeDate `json:"startDate,omitempty"`
// ForceSendFields is a list of field names (e.g. "EndDate") 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. "EndDate") 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 *GoogleCloudBillingBudgetsV1CustomPeriod) MarshalJSON() ([]byte, error) {
type NoMethod GoogleCloudBillingBudgetsV1CustomPeriod
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// GoogleCloudBillingBudgetsV1Filter: A filter for a budget, limiting
// the scope of the cost to calculate.
type GoogleCloudBillingBudgetsV1Filter struct {
// CalendarPeriod: Optional. Specifies to track usage for recurring
// calendar period. For example, assume that CalendarPeriod.QUARTER is
// set. The budget tracks usage from April 1 to June 30, when the
// current calendar month is April, May, June. After that, it tracks
// usage from July 1 to September 30 when the current calendar month is
// July, August, September, so on.
//
// Possible values:
// "CALENDAR_PERIOD_UNSPECIFIED" - Calendar period is unset. This is
// the default if the budget is for a custom time period (CustomPeriod).
// "MONTH" - A month. Month starts on the first day of each month,
// such as January 1, February 1, March 1, and so on.
// "QUARTER" - A quarter. Quarters start on dates January 1, April 1,
// July 1, and October 1 of each year.
// "YEAR" - A year. Year starts on January 1.
CalendarPeriod string `json:"calendarPeriod,omitempty"`
// CreditTypes: Optional. If Filter.credit_types_treatment is
// INCLUDE_SPECIFIED_CREDITS, this is a list of credit types to be
// subtracted from gross cost to determine the spend for threshold
// calculations. See a list of acceptable credit type values
// (https://cloud.google.com/billing/docs/how-to/export-data-bigquery-tables#credits-type).
// If Filter.credit_types_treatment is **not**
// INCLUDE_SPECIFIED_CREDITS, this field must be empty.
CreditTypes []string `json:"creditTypes,omitempty"`
// CreditTypesTreatment: Optional. If not set, default behavior is
// `INCLUDE_ALL_CREDITS`.
//
// Possible values:
// "CREDIT_TYPES_TREATMENT_UNSPECIFIED"
// "INCLUDE_ALL_CREDITS" - All types of credit are subtracted from the
// gross cost to determine the spend for threshold calculations.
// "EXCLUDE_ALL_CREDITS" - All types of credit are added to the net
// cost to determine the spend for threshold calculations.
// "INCLUDE_SPECIFIED_CREDITS" - [Credit
// types](https://cloud.google.com/billing/docs/how-to/export-data-bigque
// ry-tables#credits-type) specified in the credit_types field are
// subtracted from the gross cost to determine the spend for threshold
// calculations.
CreditTypesTreatment string `json:"creditTypesTreatment,omitempty"`
// CustomPeriod: Optional. Specifies to track usage from any start date
// (required) to any end date (optional). This time period is static, it
// does not recur.
CustomPeriod *GoogleCloudBillingBudgetsV1CustomPeriod `json:"customPeriod,omitempty"`
// Labels: Optional. A single label and value pair specifying that usage
// from only this set of labeled resources should be included in the
// budget. If omitted, the report includes all labeled and unlabeled
// usage. An object containing a single "key": value` pair. Example: `{
// "name": "wrench" }`. _Currently, multiple entries or multiple values
// per entry are not allowed._
Labels map[string][]interface{} `json:"labels,omitempty"`
// Projects: Optional. A set of projects of the form
// `projects/{project}`, specifying that usage from only this set of
// projects should be included in the budget. If omitted, the report
// includes all usage for the billing account, regardless of which
// project the usage occurred on. Only zero or one project can be
// specified currently.
Projects []string `json:"projects,omitempty"`
// Services: Optional. A set of services of the form
// `services/{service_id}`, specifying that usage from only this set of
// services should be included in the budget. If omitted, the report
// includes usage for all the services. The service names are available
// through the Catalog API:
// https://cloud.google.com/billing/v1/how-tos/catalog-api.
Services []string `json:"services,omitempty"`
// Subaccounts: Optional. A set of subaccounts of the form
// `billingAccounts/{account_id}`, specifying that usage from only this
// set of subaccounts should be included in the budget. If a subaccount
// is set to the name of the parent account, usage from the parent
// account is included. If the field is omitted, the report includes
// usage from the parent account and all subaccounts, if they exist.
Subaccounts []string `json:"subaccounts,omitempty"`
// ForceSendFields is a list of field names (e.g. "CalendarPeriod") 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. "CalendarPeriod") 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 *GoogleCloudBillingBudgetsV1Filter) MarshalJSON() ([]byte, error) {
type NoMethod GoogleCloudBillingBudgetsV1Filter
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// GoogleCloudBillingBudgetsV1LastPeriodAmount: Describes a budget
// amount targeted to the last Filter.calendar_period spend. At this
// time, the amount is automatically 100% of the last calendar period's
// spend; that is, there are no other options yet. LastPeriodAmount
// cannot be set for a budget configured with a Filter.custom_period.
type GoogleCloudBillingBudgetsV1LastPeriodAmount struct {
}
// GoogleCloudBillingBudgetsV1ListBudgetsResponse: Response for
// ListBudgets
type GoogleCloudBillingBudgetsV1ListBudgetsResponse struct {
// Budgets: List of the budgets owned by the requested billing account.
Budgets []*GoogleCloudBillingBudgetsV1Budget `json:"budgets,omitempty"`
// NextPageToken: If not empty, indicates that there may be more budgets
// that match the request; this value should be passed in a new
// `ListBudgetsRequest`.
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. "Budgets") 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. "Budgets") 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 *GoogleCloudBillingBudgetsV1ListBudgetsResponse) MarshalJSON() ([]byte, error) {
type NoMethod GoogleCloudBillingBudgetsV1ListBudgetsResponse
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// GoogleCloudBillingBudgetsV1NotificationsRule: NotificationsRule
// defines notifications that are sent based on budget spend and
// thresholds.
type GoogleCloudBillingBudgetsV1NotificationsRule struct {
// DisableDefaultIamRecipients: Optional. When set to true, disables
// default notifications sent when a threshold is exceeded. Default
// notifications are sent to those with Billing Account Administrator
// and Billing Account User IAM roles for the target account.
DisableDefaultIamRecipients bool `json:"disableDefaultIamRecipients,omitempty"`
// MonitoringNotificationChannels: Optional. Email targets to send
// notifications to when a threshold is exceeded. This is in addition to
// the `DefaultIamRecipients` who receive alert emails based on their
// billing account IAM role. The value is the full REST resource name of
// a Cloud Monitoring email notification channel with the form
// `projects/{project_id}/notificationChannels/{channel_id}`. A maximum
// of 5 email notifications are allowed. To customize budget alert email
// recipients with monitoring notification channels, you _must create
// the monitoring notification channels before you link them to a
// budget_. For guidance on setting up notification channels to use with
// budgets, see Customize budget alert email recipients
// (https://cloud.google.com/billing/docs/how-to/budgets-notification-recipients).
// For Cloud Billing budget alerts, you _must use email notification
// channels_. The other types of notification channels are _not_
// supported, such as Slack, SMS, or PagerDuty. If you want to send
// budget notifications to Slack
// (https://cloud.google.com/billing/docs/how-to/notify#send_notifications_to_slack),
// use a pubsubTopic and configure programmatic notifications
// (https://cloud.google.com/billing/docs/how-to/budgets-programmatic-notifications).
MonitoringNotificationChannels []string `json:"monitoringNotificationChannels,omitempty"`
// PubsubTopic: Optional. The name of the Pub/Sub topic where
// budget-related messages are published, in the form
// `projects/{project_id}/topics/{topic_id}`. Updates are sent to the
// topic at regular intervals; the timing of the updates is not
// dependent on the threshold rules (#thresholdrule) you've set. Note
// that if you want your Pub/Sub JSON object
// (https://cloud.google.com/billing/docs/how-to/budgets-programmatic-notifications#notification_format)
// to contain data for `alertThresholdExceeded`, you need at least one
// alert threshold rule (#thresholdrule). When you set threshold rules,
// you must also enable at least one of the email notification options,
// either using the default IAM recipients or Cloud Monitoring email
// notification channels. To use Pub/Sub topics with budgets, you must
// do the following: 1. Create the Pub/Sub topic before connecting it to
// your budget. For guidance, see Manage programmatic budget alert
// notifications
// (https://cloud.google.com/billing/docs/how-to/budgets-programmatic-notifications).
// 2. Grant the API caller the `pubsub.topics.setIamPolicy` permission
// on the Pub/Sub topic. If not set, the API call fails with
// PERMISSION_DENIED. For additional details on Pub/Sub roles and
// permissions, see Permissions required for this task
// (https://cloud.google.com/billing/docs/how-to/budgets-programmatic-notifications#permissions_required_for_this_task).
PubsubTopic string `json:"pubsubTopic,omitempty"`
// SchemaVersion: Optional. Required when NotificationsRule.pubsub_topic
// is set. The schema version of the notification sent to
// NotificationsRule.pubsub_topic. Only "1.0" is accepted. It represents
// the JSON schema as defined in
// https://cloud.google.com/billing/docs/how-to/budgets-programmatic-notifications#notification_format.
SchemaVersion string `json:"schemaVersion,omitempty"`
// ForceSendFields is a list of field names (e.g.
// "DisableDefaultIamRecipients") 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.
// "DisableDefaultIamRecipients") 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 *GoogleCloudBillingBudgetsV1NotificationsRule) MarshalJSON() ([]byte, error) {
type NoMethod GoogleCloudBillingBudgetsV1NotificationsRule
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// GoogleCloudBillingBudgetsV1ThresholdRule: ThresholdRule contains the
// definition of a threshold. Threshold rules define the triggering
// events used to generate a budget notification email. When a threshold
// is crossed (spend exceeds the specified percentages of the budget),
// budget alert emails are sent to the email recipients you specify in
// the NotificationsRule (#notificationsrule). Threshold rules also
// affect the fields included in the JSON data object
// (https://cloud.google.com/billing/docs/how-to/budgets-programmatic-notifications#notification_format)
// sent to a Pub/Sub topic. Threshold rules are _required_ if using
// email notifications. Threshold rules are _optional_ if only setting a
// `pubsubTopic` NotificationsRule (#NotificationsRule), unless you want
// your JSON data object to include data about the thresholds you set.
// For more information, see set budget threshold rules and actions
// (https://cloud.google.com/billing/docs/how-to/budgets#budget-actions).
type GoogleCloudBillingBudgetsV1ThresholdRule struct {
// SpendBasis: Optional. The type of basis used to determine if spend
// has passed the threshold. Behavior defaults to CURRENT_SPEND if not
// set.
//
// Possible values:
// "BASIS_UNSPECIFIED" - Unspecified threshold basis.
// "CURRENT_SPEND" - Use current spend as the basis for comparison
// against the threshold.
// "FORECASTED_SPEND" - Use forecasted spend for the period as the
// basis for comparison against the threshold. FORECASTED_SPEND can only
// be set when the budget's time period is a Filter.calendar_period. It
// cannot be set in combination with Filter.custom_period.
SpendBasis string `json:"spendBasis,omitempty"`
// ThresholdPercent: Required. Send an alert when this threshold is
// exceeded. This is a 1.0-based percentage, so 0.5 = 50%. Validation:
// non-negative number.
ThresholdPercent float64 `json:"thresholdPercent,omitempty"`
// ForceSendFields is a list of field names (e.g. "SpendBasis") 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. "SpendBasis") 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 *GoogleCloudBillingBudgetsV1ThresholdRule) MarshalJSON() ([]byte, error) {
type NoMethod GoogleCloudBillingBudgetsV1ThresholdRule
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
func (s *GoogleCloudBillingBudgetsV1ThresholdRule) UnmarshalJSON(data []byte) error {
type NoMethod GoogleCloudBillingBudgetsV1ThresholdRule
var s1 struct {
ThresholdPercent gensupport.JSONFloat64 `json:"thresholdPercent"`
*NoMethod
}
s1.NoMethod = (*NoMethod)(s)
if err := json.Unmarshal(data, &s1); err != nil {
return err
}
s.ThresholdPercent = float64(s1.ThresholdPercent)
return nil
}
// GoogleProtobufEmpty: 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 GoogleProtobufEmpty struct {
// ServerResponse contains the HTTP response code and headers from the
// server.
googleapi.ServerResponse `json:"-"`
}
// GoogleTypeDate: Represents a whole or partial calendar date, such as
// a birthday. The time of day and time zone are either specified
// elsewhere or are insignificant. The date is relative to the Gregorian
// Calendar. This can represent one of the following: * A full date,
// with non-zero year, month, and day values. * A month and day, with a
// zero year (for example, an anniversary). * A year on its own, with a
// zero month and a zero day. * A year and month, with a zero day (for
// example, a credit card expiration date). Related types: *
// google.type.TimeOfDay * google.type.DateTime *
// google.protobuf.Timestamp
type GoogleTypeDate struct {
// Day: Day of a month. Must be from 1 to 31 and valid for the year and
// month, or 0 to specify a year by itself or a year and month where the
// day isn't significant.
Day int64 `json:"day,omitempty"`
// Month: Month of a year. Must be from 1 to 12, or 0 to specify a year
// without a month and day.
Month int64 `json:"month,omitempty"`
// Year: Year of the date. Must be from 1 to 9999, or 0 to specify a
// date without a year.
Year int64 `json:"year,omitempty"`
// ForceSendFields is a list of field names (e.g. "Day") 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. "Day") 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 *GoogleTypeDate) MarshalJSON() ([]byte, error) {
type NoMethod GoogleTypeDate
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// GoogleTypeMoney: Represents an amount of money with its currency
// type.
type GoogleTypeMoney struct {
// CurrencyCode: The three-letter currency code defined in ISO 4217.
CurrencyCode string `json:"currencyCode,omitempty"`
// Nanos: Number of nano (10^-9) units of the amount. The value must be
// between -999,999,999 and +999,999,999 inclusive. If `units` is
// positive, `nanos` must be positive or zero. If `units` is zero,
// `nanos` can be positive, zero, or negative. If `units` is negative,
// `nanos` must be negative or zero. For example $-1.75 is represented
// as `units`=-1 and `nanos`=-750,000,000.
Nanos int64 `json:"nanos,omitempty"`
// Units: The whole units of the amount. For example if `currencyCode`
// is "USD", then 1 unit is one US dollar.
Units int64 `json:"units,omitempty,string"`
// ForceSendFields is a list of field names (e.g. "CurrencyCode") 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. "CurrencyCode") 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 *GoogleTypeMoney) MarshalJSON() ([]byte, error) {
type NoMethod GoogleTypeMoney
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// method id "billingbudgets.billingAccounts.budgets.create":
type BillingAccountsBudgetsCreateCall struct {
s *Service
parent string
googlecloudbillingbudgetsv1budget *GoogleCloudBillingBudgetsV1Budget
urlParams_ gensupport.URLParams
ctx_ context.Context
header_ http.Header
}
// Create: Creates a new budget. See Quotas and limits
// (https://cloud.google.com/billing/quotas) for more information on the
// limits of the number of budgets you can create.
//
// - parent: The name of the billing account to create the budget in.
// Values are of the form `billingAccounts/{billingAccountId}`.
func (r *BillingAccountsBudgetsService) Create(parent string, googlecloudbillingbudgetsv1budget *GoogleCloudBillingBudgetsV1Budget) *BillingAccountsBudgetsCreateCall {
c := &BillingAccountsBudgetsCreateCall{s: r.s, urlParams_: make(gensupport.URLParams)}
c.parent = parent
c.googlecloudbillingbudgetsv1budget = googlecloudbillingbudgetsv1budget
return c
}
// Fields allows partial responses to be retrieved. See
// https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
// for more information.
func (c *BillingAccountsBudgetsCreateCall) Fields(s ...googleapi.Field) *BillingAccountsBudgetsCreateCall {
c.urlParams_.Set("fields", googleapi.CombineFields(s))
return c
}
// Context sets the context to be used in this call's Do method. Any
// pending HTTP request will be aborted if the provided context is
// canceled.
func (c *BillingAccountsBudgetsCreateCall) Context(ctx context.Context) *BillingAccountsBudgetsCreateCall {
c.ctx_ = ctx
return c
}
// Header returns an http.Header that can be modified by the caller to
// add HTTP headers to the request.
func (c *BillingAccountsBudgetsCreateCall) Header() http.Header {
if c.header_ == nil {
c.header_ = make(http.Header)
}
return c.header_
}
func (c *BillingAccountsBudgetsCreateCall) doRequest(alt string) (*http.Response, error) {
reqHeaders := make(http.Header)
reqHeaders.Set("x-goog-api-client", "gl-go/"+gensupport.GoVersion()+" gdcl/"+internal.Version)
for k, v := range c.header_ {
reqHeaders[k] = v
}
reqHeaders.Set("User-Agent", c.s.userAgent())
var body io.Reader = nil
body, err := googleapi.WithoutDataWrapper.JSONReader(c.googlecloudbillingbudgetsv1budget)
if err != nil {
return nil, err
}
reqHeaders.Set("Content-Type", "application/json")
c.urlParams_.Set("alt", alt)
c.urlParams_.Set("prettyPrint", "false")
urls := googleapi.ResolveRelative(c.s.BasePath, "v1/{+parent}/budgets")
urls += "?" + c.urlParams_.Encode()
req, err := http.NewRequest("POST", urls, body)
if err != nil {
return nil, err
}
req.Header = reqHeaders
googleapi.Expand(req.URL, map[string]string{
"parent": c.parent,
})
return gensupport.SendRequest(c.ctx_, c.s.client, req)
}
// Do executes the "billingbudgets.billingAccounts.budgets.create" call.
// Exactly one of *GoogleCloudBillingBudgetsV1Budget or error will be
// non-nil. Any non-2xx status code is an error. Response headers are in
// either *GoogleCloudBillingBudgetsV1Budget.ServerResponse.Header or
// (if a response was returned at all) in
// error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check
// whether the returned error was because http.StatusNotModified was
// returned.
func (c *BillingAccountsBudgetsCreateCall) Do(opts ...googleapi.CallOption) (*GoogleCloudBillingBudgetsV1Budget, error) {
gensupport.SetOptions(c.urlParams_, opts...)
res, err := c.doRequest("json")
if res != nil && res.StatusCode == http.StatusNotModified {
if res.Body != nil {
res.Body.Close()
}
return nil, &googleapi.Error{
Code: res.StatusCode,
Header: res.Header,
}
}
if err != nil {
return nil, err
}
defer googleapi.CloseBody(res)
if err := googleapi.CheckResponse(res); err != nil {
return nil, err
}
ret := &GoogleCloudBillingBudgetsV1Budget{
ServerResponse: googleapi.ServerResponse{
Header: res.Header,
HTTPStatusCode: res.StatusCode,
},
}
target := &ret
if err := gensupport.DecodeResponse(target, res); err != nil {
return nil, err
}
return ret, nil
// {
// "description": "Creates a new budget. See [Quotas and limits](https://cloud.google.com/billing/quotas) for more information on the limits of the number of budgets you can create.",
// "flatPath": "v1/billingAccounts/{billingAccountsId}/budgets",
// "httpMethod": "POST",
// "id": "billingbudgets.billingAccounts.budgets.create",
// "parameterOrder": [
// "parent"
// ],
// "parameters": {
// "parent": {
// "description": "Required. The name of the billing account to create the budget in. Values are of the form `billingAccounts/{billingAccountId}`.",
// "location": "path",
// "pattern": "^billingAccounts/[^/]+$",
// "required": true,
// "type": "string"
// }
// },
// "path": "v1/{+parent}/budgets",
// "request": {
// "$ref": "GoogleCloudBillingBudgetsV1Budget"
// },
// "response": {
// "$ref": "GoogleCloudBillingBudgetsV1Budget"
// },
// "scopes": [
// "https://www.googleapis.com/auth/cloud-billing",
// "https://www.googleapis.com/auth/cloud-platform"
// ]
// }
}
// method id "billingbudgets.billingAccounts.budgets.delete":
type BillingAccountsBudgetsDeleteCall struct {
s *Service
name string
urlParams_ gensupport.URLParams
ctx_ context.Context
header_ http.Header
}
// Delete: Deletes a budget. Returns successfully if already deleted.
//
// - name: Name of the budget to delete. Values are of the form
// `billingAccounts/{billingAccountId}/budgets/{budgetId}`.
func (r *BillingAccountsBudgetsService) Delete(name string) *BillingAccountsBudgetsDeleteCall {
c := &BillingAccountsBudgetsDeleteCall{s: r.s, urlParams_: make(gensupport.URLParams)}
c.name = name
return c
}
// Fields allows partial responses to be retrieved. See
// https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
// for more information.
func (c *BillingAccountsBudgetsDeleteCall) Fields(s ...googleapi.Field) *BillingAccountsBudgetsDeleteCall {
c.urlParams_.Set("fields", googleapi.CombineFields(s))
return c
}
// Context sets the context to be used in this call's Do method. Any
// pending HTTP request will be aborted if the provided context is
// canceled.
func (c *BillingAccountsBudgetsDeleteCall) Context(ctx context.Context) *BillingAccountsBudgetsDeleteCall {
c.ctx_ = ctx
return c
}
// Header returns an http.Header that can be modified by the caller to
// add HTTP headers to the request.
func (c *BillingAccountsBudgetsDeleteCall) Header() http.Header {
if c.header_ == nil {
c.header_ = make(http.Header)
}
return c.header_
}
func (c *BillingAccountsBudgetsDeleteCall) doRequest(alt string) (*http.Response, error) {
reqHeaders := make(http.Header)
reqHeaders.Set("x-goog-api-client", "gl-go/"+gensupport.GoVersion()+" gdcl/"+internal.Version)
for k, v := range c.header_ {
reqHeaders[k] = v
}
reqHeaders.Set("User-Agent", c.s.userAgent())
var body io.Reader = nil
c.urlParams_.Set("alt", alt)
c.urlParams_.Set("prettyPrint", "false")
urls := googleapi.ResolveRelative(c.s.BasePath, "v1/{+name}")
urls += "?" + c.urlParams_.Encode()
req, err := http.NewRequest("DELETE", urls, body)
if err != nil {
return nil, err
}
req.Header = reqHeaders
googleapi.Expand(req.URL, map[string]string{
"name": c.name,
})
return gensupport.SendRequest(c.ctx_, c.s.client, req)
}
// Do executes the "billingbudgets.billingAccounts.budgets.delete" call.
// Exactly one of *GoogleProtobufEmpty or error will be non-nil. Any
// non-2xx status code is an error. Response headers are in either
// *GoogleProtobufEmpty.ServerResponse.Header or (if a response was
// returned at all) in error.(*googleapi.Error).Header. Use
// googleapi.IsNotModified to check whether the returned error was
// because http.StatusNotModified was returned.
func (c *BillingAccountsBudgetsDeleteCall) Do(opts ...googleapi.CallOption) (*GoogleProtobufEmpty, error) {
gensupport.SetOptions(c.urlParams_, opts...)
res, err := c.doRequest("json")
if res != nil && res.StatusCode == http.StatusNotModified {
if res.Body != nil {
res.Body.Close()
}
return nil, &googleapi.Error{
Code: res.StatusCode,
Header: res.Header,
}
}
if err != nil {
return nil, err
}
defer googleapi.CloseBody(res)
if err := googleapi.CheckResponse(res); err != nil {
return nil, err
}
ret := &GoogleProtobufEmpty{
ServerResponse: googleapi.ServerResponse{
Header: res.Header,
HTTPStatusCode: res.StatusCode,
},
}
target := &ret
if err := gensupport.DecodeResponse(target, res); err != nil {
return nil, err
}
return ret, nil
// {
// "description": "Deletes a budget. Returns successfully if already deleted.",
// "flatPath": "v1/billingAccounts/{billingAccountsId}/budgets/{budgetsId}",
// "httpMethod": "DELETE",
// "id": "billingbudgets.billingAccounts.budgets.delete",
// "parameterOrder": [
// "name"
// ],
// "parameters": {
// "name": {
// "description": "Required. Name of the budget to delete. Values are of the form `billingAccounts/{billingAccountId}/budgets/{budgetId}`.",
// "location": "path",
// "pattern": "^billingAccounts/[^/]+/budgets/[^/]+$",
// "required": true,
// "type": "string"
// }
// },
// "path": "v1/{+name}",
// "response": {
// "$ref": "GoogleProtobufEmpty"
// },
// "scopes": [
// "https://www.googleapis.com/auth/cloud-billing",
// "https://www.googleapis.com/auth/cloud-platform"
// ]
// }
}
// method id "billingbudgets.billingAccounts.budgets.get":