google-apis-billingbudgets_v1beta1 0.1.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA256:
3
+ metadata.gz: f3951a4681f1f318f38b516aea7096b1816228a2161ca02c96ac1d9bd7727c55
4
+ data.tar.gz: 651b5e2d21e94d325b304ccbdb6aa7abef83e6aa6163daa0b82f2757ec78cfd5
5
+ SHA512:
6
+ metadata.gz: 9f638168abacf4f18ab6870f6b761a1e105d6463e6223c7f9ab3a7bbe1f78ded684e75cc0958466095ca6b9c6cbe92085ba355eac2704a8b3abb71d772bb18e8
7
+ data.tar.gz: 23d151e76cedd81bc842caaa1ba0a1dd7515bdca4a18c1d245d10d8c32bc9bf6ddb3c71349a3d071316a210c08c76d3816092ccf7590a0559e2e4aeb6084bfea
@@ -0,0 +1,13 @@
1
+ --hide-void-return
2
+ --no-private
3
+ --verbose
4
+ --title=google-apis-billingbudgets_v1beta1
5
+ --markup-provider=redcarpet
6
+ --markup=markdown
7
+ --main OVERVIEW.md
8
+ lib/google/apis/billingbudgets_v1beta1/*.rb
9
+ lib/google/apis/billingbudgets_v1beta1.rb
10
+ -
11
+ OVERVIEW.md
12
+ CHANGELOG.md
13
+ LICENSE.md
@@ -0,0 +1,7 @@
1
+ # Release history for google-apis-billingbudgets_v1beta1
2
+
3
+ ### v0.1.0 (2021-01-07)
4
+
5
+ * Regenerated using generator version 0.1.1
6
+ * Regenerated from discovery document revision 20201107
7
+
@@ -0,0 +1,202 @@
1
+
2
+ Apache License
3
+ Version 2.0, January 2004
4
+ http://www.apache.org/licenses/
5
+
6
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
7
+
8
+ 1. Definitions.
9
+
10
+ "License" shall mean the terms and conditions for use, reproduction,
11
+ and distribution as defined by Sections 1 through 9 of this document.
12
+
13
+ "Licensor" shall mean the copyright owner or entity authorized by
14
+ the copyright owner that is granting the License.
15
+
16
+ "Legal Entity" shall mean the union of the acting entity and all
17
+ other entities that control, are controlled by, or are under common
18
+ control with that entity. For the purposes of this definition,
19
+ "control" means (i) the power, direct or indirect, to cause the
20
+ direction or management of such entity, whether by contract or
21
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
22
+ outstanding shares, or (iii) beneficial ownership of such entity.
23
+
24
+ "You" (or "Your") shall mean an individual or Legal Entity
25
+ exercising permissions granted by this License.
26
+
27
+ "Source" form shall mean the preferred form for making modifications,
28
+ including but not limited to software source code, documentation
29
+ source, and configuration files.
30
+
31
+ "Object" form shall mean any form resulting from mechanical
32
+ transformation or translation of a Source form, including but
33
+ not limited to compiled object code, generated documentation,
34
+ and conversions to other media types.
35
+
36
+ "Work" shall mean the work of authorship, whether in Source or
37
+ Object form, made available under the License, as indicated by a
38
+ copyright notice that is included in or attached to the work
39
+ (an example is provided in the Appendix below).
40
+
41
+ "Derivative Works" shall mean any work, whether in Source or Object
42
+ form, that is based on (or derived from) the Work and for which the
43
+ editorial revisions, annotations, elaborations, or other modifications
44
+ represent, as a whole, an original work of authorship. For the purposes
45
+ of this License, Derivative Works shall not include works that remain
46
+ separable from, or merely link (or bind by name) to the interfaces of,
47
+ the Work and Derivative Works thereof.
48
+
49
+ "Contribution" shall mean any work of authorship, including
50
+ the original version of the Work and any modifications or additions
51
+ to that Work or Derivative Works thereof, that is intentionally
52
+ submitted to Licensor for inclusion in the Work by the copyright owner
53
+ or by an individual or Legal Entity authorized to submit on behalf of
54
+ the copyright owner. For the purposes of this definition, "submitted"
55
+ means any form of electronic, verbal, or written communication sent
56
+ to the Licensor or its representatives, including but not limited to
57
+ communication on electronic mailing lists, source code control systems,
58
+ and issue tracking systems that are managed by, or on behalf of, the
59
+ Licensor for the purpose of discussing and improving the Work, but
60
+ excluding communication that is conspicuously marked or otherwise
61
+ designated in writing by the copyright owner as "Not a Contribution."
62
+
63
+ "Contributor" shall mean Licensor and any individual or Legal Entity
64
+ on behalf of whom a Contribution has been received by Licensor and
65
+ subsequently incorporated within the Work.
66
+
67
+ 2. Grant of Copyright License. Subject to the terms and conditions of
68
+ this License, each Contributor hereby grants to You a perpetual,
69
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
70
+ copyright license to reproduce, prepare Derivative Works of,
71
+ publicly display, publicly perform, sublicense, and distribute the
72
+ Work and such Derivative Works in Source or Object form.
73
+
74
+ 3. Grant of Patent License. Subject to the terms and conditions of
75
+ this License, each Contributor hereby grants to You a perpetual,
76
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
77
+ (except as stated in this section) patent license to make, have made,
78
+ use, offer to sell, sell, import, and otherwise transfer the Work,
79
+ where such license applies only to those patent claims licensable
80
+ by such Contributor that are necessarily infringed by their
81
+ Contribution(s) alone or by combination of their Contribution(s)
82
+ with the Work to which such Contribution(s) was submitted. If You
83
+ institute patent litigation against any entity (including a
84
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
85
+ or a Contribution incorporated within the Work constitutes direct
86
+ or contributory patent infringement, then any patent licenses
87
+ granted to You under this License for that Work shall terminate
88
+ as of the date such litigation is filed.
89
+
90
+ 4. Redistribution. You may reproduce and distribute copies of the
91
+ Work or Derivative Works thereof in any medium, with or without
92
+ modifications, and in Source or Object form, provided that You
93
+ meet the following conditions:
94
+
95
+ (a) You must give any other recipients of the Work or
96
+ Derivative Works a copy of this License; and
97
+
98
+ (b) You must cause any modified files to carry prominent notices
99
+ stating that You changed the files; and
100
+
101
+ (c) You must retain, in the Source form of any Derivative Works
102
+ that You distribute, all copyright, patent, trademark, and
103
+ attribution notices from the Source form of the Work,
104
+ excluding those notices that do not pertain to any part of
105
+ the Derivative Works; and
106
+
107
+ (d) If the Work includes a "NOTICE" text file as part of its
108
+ distribution, then any Derivative Works that You distribute must
109
+ include a readable copy of the attribution notices contained
110
+ within such NOTICE file, excluding those notices that do not
111
+ pertain to any part of the Derivative Works, in at least one
112
+ of the following places: within a NOTICE text file distributed
113
+ as part of the Derivative Works; within the Source form or
114
+ documentation, if provided along with the Derivative Works; or,
115
+ within a display generated by the Derivative Works, if and
116
+ wherever such third-party notices normally appear. The contents
117
+ of the NOTICE file are for informational purposes only and
118
+ do not modify the License. You may add Your own attribution
119
+ notices within Derivative Works that You distribute, alongside
120
+ or as an addendum to the NOTICE text from the Work, provided
121
+ that such additional attribution notices cannot be construed
122
+ as modifying the License.
123
+
124
+ You may add Your own copyright statement to Your modifications and
125
+ may provide additional or different license terms and conditions
126
+ for use, reproduction, or distribution of Your modifications, or
127
+ for any such Derivative Works as a whole, provided Your use,
128
+ reproduction, and distribution of the Work otherwise complies with
129
+ the conditions stated in this License.
130
+
131
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
132
+ any Contribution intentionally submitted for inclusion in the Work
133
+ by You to the Licensor shall be under the terms and conditions of
134
+ this License, without any additional terms or conditions.
135
+ Notwithstanding the above, nothing herein shall supersede or modify
136
+ the terms of any separate license agreement you may have executed
137
+ with Licensor regarding such Contributions.
138
+
139
+ 6. Trademarks. This License does not grant permission to use the trade
140
+ names, trademarks, service marks, or product names of the Licensor,
141
+ except as required for reasonable and customary use in describing the
142
+ origin of the Work and reproducing the content of the NOTICE file.
143
+
144
+ 7. Disclaimer of Warranty. Unless required by applicable law or
145
+ agreed to in writing, Licensor provides the Work (and each
146
+ Contributor provides its Contributions) on an "AS IS" BASIS,
147
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
148
+ implied, including, without limitation, any warranties or conditions
149
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
150
+ PARTICULAR PURPOSE. You are solely responsible for determining the
151
+ appropriateness of using or redistributing the Work and assume any
152
+ risks associated with Your exercise of permissions under this License.
153
+
154
+ 8. Limitation of Liability. In no event and under no legal theory,
155
+ whether in tort (including negligence), contract, or otherwise,
156
+ unless required by applicable law (such as deliberate and grossly
157
+ negligent acts) or agreed to in writing, shall any Contributor be
158
+ liable to You for damages, including any direct, indirect, special,
159
+ incidental, or consequential damages of any character arising as a
160
+ result of this License or out of the use or inability to use the
161
+ Work (including but not limited to damages for loss of goodwill,
162
+ work stoppage, computer failure or malfunction, or any and all
163
+ other commercial damages or losses), even if such Contributor
164
+ has been advised of the possibility of such damages.
165
+
166
+ 9. Accepting Warranty or Additional Liability. While redistributing
167
+ the Work or Derivative Works thereof, You may choose to offer,
168
+ and charge a fee for, acceptance of support, warranty, indemnity,
169
+ or other liability obligations and/or rights consistent with this
170
+ License. However, in accepting such obligations, You may act only
171
+ on Your own behalf and on Your sole responsibility, not on behalf
172
+ of any other Contributor, and only if You agree to indemnify,
173
+ defend, and hold each Contributor harmless for any liability
174
+ incurred by, or claims asserted against, such Contributor by reason
175
+ of your accepting any such warranty or additional liability.
176
+
177
+ END OF TERMS AND CONDITIONS
178
+
179
+ APPENDIX: How to apply the Apache License to your work.
180
+
181
+ To apply the Apache License to your work, attach the following
182
+ boilerplate notice, with the fields enclosed by brackets "[]"
183
+ replaced with your own identifying information. (Don't include
184
+ the brackets!) The text should be enclosed in the appropriate
185
+ comment syntax for the file format. We also recommend that a
186
+ file or class name and description of purpose be included on the
187
+ same "printed page" as the copyright notice for easier
188
+ identification within third-party archives.
189
+
190
+ Copyright [yyyy] [name of copyright owner]
191
+
192
+ Licensed under the Apache License, Version 2.0 (the "License");
193
+ you may not use this file except in compliance with the License.
194
+ You may obtain a copy of the License at
195
+
196
+ http://www.apache.org/licenses/LICENSE-2.0
197
+
198
+ Unless required by applicable law or agreed to in writing, software
199
+ distributed under the License is distributed on an "AS IS" BASIS,
200
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
201
+ See the License for the specific language governing permissions and
202
+ limitations under the License.
@@ -0,0 +1,96 @@
1
+ # Simple REST client for version V1beta1 of the Cloud Billing Budget API
2
+
3
+ This is a simple client library for version V1beta1 of the Cloud Billing Budget API. It provides:
4
+
5
+ * A client object that connects to the HTTP/JSON REST endpoint for the service.
6
+ * Ruby objects for data structures related to the service.
7
+ * Integration with the googleauth gem for authentication using OAuth, API keys, and service accounts.
8
+ * Control of retry, pagination, and timeouts.
9
+
10
+ Note that although this client library is supported and will continue to be updated to track changes to the service, it is otherwise considered complete and not under active development. Many Google services, especially Google Cloud Platform services, may provide a more modern client that is under more active development and improvement. See the section below titled *Which client should I use?* for more information.
11
+
12
+ ## Getting started
13
+
14
+ ### Before you begin
15
+
16
+ There are a few setup steps you need to complete before you can use this library:
17
+
18
+ 1. If you don't already have a Google account, [sign up](https://www.google.com/accounts).
19
+ 2. If you have never created a Google APIs Console project, read about [Managing Projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects) and create a project in the [Google API Console](https://console.cloud.google.com/).
20
+ 3. Most APIs need to be enabled for your project. [Enable it](https://console.cloud.google.com/apis/library/billingbudgets.googleapis.com) in the console.
21
+
22
+ ### Installation
23
+
24
+ Add this line to your application's Gemfile:
25
+
26
+ ```ruby
27
+ gem 'google-apis-billingbudgets_v1beta1', '~> 0.1'
28
+ ```
29
+
30
+ And then execute:
31
+
32
+ ```
33
+ $ bundle
34
+ ```
35
+
36
+ Or install it yourself as:
37
+
38
+ ```
39
+ $ gem install google-apis-billingbudgets_v1beta1
40
+ ```
41
+
42
+ ### Creating a client object
43
+
44
+ Once the gem is installed, you can load the client code and instantiate a client.
45
+
46
+ ```ruby
47
+ # Load the client
48
+ require "google/apis/billingbudgets_v1beta1"
49
+
50
+ # Create a client object
51
+ client = Google::Apis::BillingbudgetsV1beta1::CloudBillingBudgetService.new
52
+
53
+ # Authenticate calls
54
+ client.authentication = # ... use the googleauth gem to create credentials
55
+ ```
56
+
57
+ See the class reference docs for information on the methods you can call from a client.
58
+
59
+ ## Documentation
60
+
61
+ More detailed descriptions of the Google simple REST clients are available in two documents.
62
+
63
+ * The [Usage Guide](https://github.com/googleapis/google-api-ruby-client/blob/master/docs/usage-guide.md) discusses how to make API calls, how to use the provided data structures, and how to work the various features of the client library, including media upload and download, error handling, retries, pagination, and logging.
64
+ * The [Auth Guide](https://github.com/googleapis/google-api-ruby-client/blob/master/docs/auth-guide.md) discusses authentication in the client libraries, including API keys, OAuth 2.0, service accounts, and environment variables.
65
+
66
+ (Note: the above documents are written for the simple REST clients in general, and their examples may not reflect the Billingbudgets service in particular.)
67
+
68
+ For reference information on specific calls in the Cloud Billing Budget API, see the {Google::Apis::BillingbudgetsV1beta1::CloudBillingBudgetService class reference docs}.
69
+
70
+ ## Which client should I use?
71
+
72
+ Google provides two types of Ruby API client libraries: **simple REST clients** and **modern clients**.
73
+
74
+ This library, `google-apis-billingbudgets_v1beta1`, is a simple REST client. You can identify these clients by their gem names, which are always in the form `google-apis-<servicename>_<serviceversion>`. The simple REST clients connect to HTTP/JSON REST endpoints and are automatically generated from service discovery documents. They support most API functionality, but their class interfaces are sometimes awkward.
75
+
76
+ Modern clients are produced by a modern code generator, sometimes combined with hand-crafted functionality. Most modern clients connect to high-performance gRPC endpoints, although a few are backed by REST services. Modern clients are available for many Google services, especially Google Cloud Platform services, but do not yet support all the services covered by the simple clients.
77
+
78
+ Gem names for modern clients are often of the form `google-cloud-<service_name>`. (For example, [google-cloud-pubsub](https://rubygems.org/gems/google-cloud-pubsub).) Note that most modern clients also have corresponding "versioned" gems with names like `google-cloud-<service_name>-<version>`. (For example, [google-cloud-pubsub-v1](https://rubygems.org/gems/google-cloud-pubsub-v1).) The "versioned" gems can be used directly, but often provide lower-level interfaces. In most cases, the main gem is recommended.
79
+
80
+ **For most users, we recommend the modern client, if one is available.** Compared with simple clients, modern clients are generally much easier to use and more Ruby-like, support more advanced features such as streaming and long-running operations, and often provide much better performance. You may consider using a simple client instead, if a modern client is not yet available for the service you want to use, or if you are not able to use gRPC on your infrastructure.
81
+
82
+ The [product documentation](https://cloud.google.com/billing/docs/how-to/budget-api-overview) may provide guidance regarding the preferred client library to use.
83
+
84
+ ## Supported Ruby versions
85
+
86
+ This library is supported on Ruby 2.5+.
87
+
88
+ Google provides official support for Ruby versions that are actively supported by Ruby Core -- that is, Ruby versions that are either in normal maintenance or in security maintenance, and not end of life. Currently, this means Ruby 2.5 and later. Older versions of Ruby _may_ still work, but are unsupported and not recommended. See https://www.ruby-lang.org/en/downloads/branches/ for details about the Ruby support schedule.
89
+
90
+ ## License
91
+
92
+ This library is licensed under Apache 2.0. Full license text is available in the {file:LICENSE.md LICENSE}.
93
+
94
+ ## Support
95
+
96
+ Please [report bugs at the project on Github](https://github.com/google/google-api-ruby-client/issues). Don't hesitate to [ask questions](http://stackoverflow.com/questions/tagged/google-api-ruby-client) about the client or APIs on [StackOverflow](http://stackoverflow.com).
@@ -0,0 +1,15 @@
1
+ # Copyright 2020 Google LLC
2
+ #
3
+ # Licensed under the Apache License, Version 2.0 (the "License");
4
+ # you may not use this file except in compliance with the License.
5
+ # You may obtain a copy of the License at
6
+ #
7
+ # http://www.apache.org/licenses/LICENSE-2.0
8
+ #
9
+ # Unless required by applicable law or agreed to in writing, software
10
+ # distributed under the License is distributed on an "AS IS" BASIS,
11
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12
+ # See the License for the specific language governing permissions and
13
+ # limitations under the License.
14
+
15
+ require "google/apis/billingbudgets_v1beta1"
@@ -0,0 +1,40 @@
1
+ # Copyright 2020 Google LLC
2
+ #
3
+ # Licensed under the Apache License, Version 2.0 (the "License");
4
+ # you may not use this file except in compliance with the License.
5
+ # You may obtain a copy of the License at
6
+ #
7
+ # http://www.apache.org/licenses/LICENSE-2.0
8
+ #
9
+ # Unless required by applicable law or agreed to in writing, software
10
+ # distributed under the License is distributed on an "AS IS" BASIS,
11
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12
+ # See the License for the specific language governing permissions and
13
+ # limitations under the License.
14
+
15
+ require 'google/apis/billingbudgets_v1beta1/service.rb'
16
+ require 'google/apis/billingbudgets_v1beta1/classes.rb'
17
+ require 'google/apis/billingbudgets_v1beta1/representations.rb'
18
+ require 'google/apis/billingbudgets_v1beta1/gem_version.rb'
19
+
20
+ module Google
21
+ module Apis
22
+ # Cloud Billing Budget API
23
+ #
24
+ # The Cloud Billing Budget API stores Cloud Billing budgets, which define a
25
+ # budget plan and the rules to execute as spend is tracked against that plan.
26
+ #
27
+ # @see https://cloud.google.com/billing/docs/how-to/budget-api-overview
28
+ module BillingbudgetsV1beta1
29
+ # Version of the Cloud Billing Budget API this client connects to.
30
+ # This is NOT the gem version.
31
+ VERSION = 'V1beta1'
32
+
33
+ # View and manage your Google Cloud Platform billing accounts
34
+ AUTH_CLOUD_BILLING = 'https://www.googleapis.com/auth/cloud-billing'
35
+
36
+ # View and manage your data across Google Cloud Platform services
37
+ AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform'
38
+ end
39
+ end
40
+ end
@@ -0,0 +1,428 @@
1
+ # Copyright 2020 Google LLC
2
+ #
3
+ # Licensed under the Apache License, Version 2.0 (the "License");
4
+ # you may not use this file except in compliance with the License.
5
+ # You may obtain a copy of the License at
6
+ #
7
+ # http://www.apache.org/licenses/LICENSE-2.0
8
+ #
9
+ # Unless required by applicable law or agreed to in writing, software
10
+ # distributed under the License is distributed on an "AS IS" BASIS,
11
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12
+ # See the License for the specific language governing permissions and
13
+ # limitations under the License.
14
+
15
+ require 'date'
16
+ require 'google/apis/core/base_service'
17
+ require 'google/apis/core/json_representation'
18
+ require 'google/apis/core/hashable'
19
+ require 'google/apis/errors'
20
+
21
+ module Google
22
+ module Apis
23
+ module BillingbudgetsV1beta1
24
+
25
+ # AllUpdatesRule defines notifications that are sent based on budget spend and
26
+ # thresholds.
27
+ class GoogleCloudBillingBudgetsV1beta1AllUpdatesRule
28
+ include Google::Apis::Core::Hashable
29
+
30
+ # Optional. When set to true, disables default notifications sent when a
31
+ # threshold is exceeded. Default notifications are sent to those with Billing
32
+ # Account Administrator and Billing Account User IAM roles for the target
33
+ # account.
34
+ # Corresponds to the JSON property `disableDefaultIamRecipients`
35
+ # @return [Boolean]
36
+ attr_accessor :disable_default_iam_recipients
37
+ alias_method :disable_default_iam_recipients?, :disable_default_iam_recipients
38
+
39
+ # Optional. Targets to send notifications to when a threshold is exceeded. This
40
+ # is in addition to default recipients who have billing account IAM roles. The
41
+ # value is the full REST resource name of a monitoring notification channel with
42
+ # the form `projects/`project_id`/notificationChannels/`channel_id``. A maximum
43
+ # of 5 channels are allowed. See https://cloud.google.com/billing/docs/how-to/
44
+ # budgets-notification-recipients for more details.
45
+ # Corresponds to the JSON property `monitoringNotificationChannels`
46
+ # @return [Array<String>]
47
+ attr_accessor :monitoring_notification_channels
48
+
49
+ # Optional. The name of the Pub/Sub topic where budget related messages will be
50
+ # published, in the form `projects/`project_id`/topics/`topic_id``. Updates are
51
+ # sent at regular intervals to the topic. The topic needs to be created before
52
+ # the budget is created; see https://cloud.google.com/billing/docs/how-to/
53
+ # budgets#manage-notifications for more details. Caller is expected to have `
54
+ # pubsub.topics.setIamPolicy` permission on the topic when it's set for a budget,
55
+ # otherwise, the API call will fail with PERMISSION_DENIED. See https://cloud.
56
+ # google.com/billing/docs/how-to/budgets-programmatic-notifications for more
57
+ # details on Pub/Sub roles and permissions.
58
+ # Corresponds to the JSON property `pubsubTopic`
59
+ # @return [String]
60
+ attr_accessor :pubsub_topic
61
+
62
+ # Optional. The schema version of the notification sent to `pubsub_topic`. Only "
63
+ # 1.0" is accepted. It represents the JSON schema as defined in https://cloud.
64
+ # google.com/billing/docs/how-to/budgets-programmatic-notifications#
65
+ # notification_format
66
+ # Corresponds to the JSON property `schemaVersion`
67
+ # @return [String]
68
+ attr_accessor :schema_version
69
+
70
+ def initialize(**args)
71
+ update!(**args)
72
+ end
73
+
74
+ # Update properties of this object
75
+ def update!(**args)
76
+ @disable_default_iam_recipients = args[:disable_default_iam_recipients] if args.key?(:disable_default_iam_recipients)
77
+ @monitoring_notification_channels = args[:monitoring_notification_channels] if args.key?(:monitoring_notification_channels)
78
+ @pubsub_topic = args[:pubsub_topic] if args.key?(:pubsub_topic)
79
+ @schema_version = args[:schema_version] if args.key?(:schema_version)
80
+ end
81
+ end
82
+
83
+ # A budget is a plan that describes what you expect to spend on Cloud projects,
84
+ # plus the rules to execute as spend is tracked against that plan, (for example,
85
+ # send an alert when 90% of the target spend is met). Currently all plans are
86
+ # monthly budgets so the usage period(s) tracked are implied (calendar months of
87
+ # usage back-to-back).
88
+ class GoogleCloudBillingBudgetsV1beta1Budget
89
+ include Google::Apis::Core::Hashable
90
+
91
+ # AllUpdatesRule defines notifications that are sent based on budget spend and
92
+ # thresholds.
93
+ # Corresponds to the JSON property `allUpdatesRule`
94
+ # @return [Google::Apis::BillingbudgetsV1beta1::GoogleCloudBillingBudgetsV1beta1AllUpdatesRule]
95
+ attr_accessor :all_updates_rule
96
+
97
+ # The budgeted amount for each usage period.
98
+ # Corresponds to the JSON property `amount`
99
+ # @return [Google::Apis::BillingbudgetsV1beta1::GoogleCloudBillingBudgetsV1beta1BudgetAmount]
100
+ attr_accessor :amount
101
+
102
+ # A filter for a budget, limiting the scope of the cost to calculate.
103
+ # Corresponds to the JSON property `budgetFilter`
104
+ # @return [Google::Apis::BillingbudgetsV1beta1::GoogleCloudBillingBudgetsV1beta1Filter]
105
+ attr_accessor :budget_filter
106
+
107
+ # User data for display name in UI. Validation: <= 60 chars.
108
+ # Corresponds to the JSON property `displayName`
109
+ # @return [String]
110
+ attr_accessor :display_name
111
+
112
+ # Optional. Etag to validate that the object is unchanged for a read-modify-
113
+ # write operation. An empty etag will cause an update to overwrite other changes.
114
+ # Corresponds to the JSON property `etag`
115
+ # @return [String]
116
+ attr_accessor :etag
117
+
118
+ # Output only. Resource name of the budget. The resource name implies the scope
119
+ # of a budget. Values are of the form `billingAccounts/`billingAccountId`/
120
+ # budgets/`budgetId``.
121
+ # Corresponds to the JSON property `name`
122
+ # @return [String]
123
+ attr_accessor :name
124
+
125
+ # Optional. Rules that trigger alerts (notifications of thresholds being crossed)
126
+ # when spend exceeds the specified percentages of the budget.
127
+ # Corresponds to the JSON property `thresholdRules`
128
+ # @return [Array<Google::Apis::BillingbudgetsV1beta1::GoogleCloudBillingBudgetsV1beta1ThresholdRule>]
129
+ attr_accessor :threshold_rules
130
+
131
+ def initialize(**args)
132
+ update!(**args)
133
+ end
134
+
135
+ # Update properties of this object
136
+ def update!(**args)
137
+ @all_updates_rule = args[:all_updates_rule] if args.key?(:all_updates_rule)
138
+ @amount = args[:amount] if args.key?(:amount)
139
+ @budget_filter = args[:budget_filter] if args.key?(:budget_filter)
140
+ @display_name = args[:display_name] if args.key?(:display_name)
141
+ @etag = args[:etag] if args.key?(:etag)
142
+ @name = args[:name] if args.key?(:name)
143
+ @threshold_rules = args[:threshold_rules] if args.key?(:threshold_rules)
144
+ end
145
+ end
146
+
147
+ # The budgeted amount for each usage period.
148
+ class GoogleCloudBillingBudgetsV1beta1BudgetAmount
149
+ include Google::Apis::Core::Hashable
150
+
151
+ # Describes a budget amount targeted to last period's spend. At this time, the
152
+ # amount is automatically 100% of last period's spend; that is, there are no
153
+ # other options yet. Future configuration will be described here (for example,
154
+ # configuring a percentage of last period's spend).
155
+ # Corresponds to the JSON property `lastPeriodAmount`
156
+ # @return [Google::Apis::BillingbudgetsV1beta1::GoogleCloudBillingBudgetsV1beta1LastPeriodAmount]
157
+ attr_accessor :last_period_amount
158
+
159
+ # Represents an amount of money with its currency type.
160
+ # Corresponds to the JSON property `specifiedAmount`
161
+ # @return [Google::Apis::BillingbudgetsV1beta1::GoogleTypeMoney]
162
+ attr_accessor :specified_amount
163
+
164
+ def initialize(**args)
165
+ update!(**args)
166
+ end
167
+
168
+ # Update properties of this object
169
+ def update!(**args)
170
+ @last_period_amount = args[:last_period_amount] if args.key?(:last_period_amount)
171
+ @specified_amount = args[:specified_amount] if args.key?(:specified_amount)
172
+ end
173
+ end
174
+
175
+ # Request for CreateBudget
176
+ class GoogleCloudBillingBudgetsV1beta1CreateBudgetRequest
177
+ include Google::Apis::Core::Hashable
178
+
179
+ # A budget is a plan that describes what you expect to spend on Cloud projects,
180
+ # plus the rules to execute as spend is tracked against that plan, (for example,
181
+ # send an alert when 90% of the target spend is met). Currently all plans are
182
+ # monthly budgets so the usage period(s) tracked are implied (calendar months of
183
+ # usage back-to-back).
184
+ # Corresponds to the JSON property `budget`
185
+ # @return [Google::Apis::BillingbudgetsV1beta1::GoogleCloudBillingBudgetsV1beta1Budget]
186
+ attr_accessor :budget
187
+
188
+ def initialize(**args)
189
+ update!(**args)
190
+ end
191
+
192
+ # Update properties of this object
193
+ def update!(**args)
194
+ @budget = args[:budget] if args.key?(:budget)
195
+ end
196
+ end
197
+
198
+ # A filter for a budget, limiting the scope of the cost to calculate.
199
+ class GoogleCloudBillingBudgetsV1beta1Filter
200
+ include Google::Apis::Core::Hashable
201
+
202
+ # Optional. If Filter.credit_types_treatment is INCLUDE_SPECIFIED_CREDITS, this
203
+ # is a list of credit types to be subtracted from gross cost to determine the
204
+ # spend for threshold calculations. If Filter.credit_types_treatment is **not**
205
+ # INCLUDE_SPECIFIED_CREDITS, this field must be empty. See [a list of acceptable
206
+ # credit type values](https://cloud.google.com/billing/docs/how-to/export-data-
207
+ # bigquery-tables#credits-type).
208
+ # Corresponds to the JSON property `creditTypes`
209
+ # @return [Array<String>]
210
+ attr_accessor :credit_types
211
+
212
+ # Optional. If not set, default behavior is `INCLUDE_ALL_CREDITS`.
213
+ # Corresponds to the JSON property `creditTypesTreatment`
214
+ # @return [String]
215
+ attr_accessor :credit_types_treatment
216
+
217
+ # Optional. A single label and value pair specifying that usage from only this
218
+ # set of labeled resources should be included in the budget. Currently, multiple
219
+ # entries or multiple values per entry are not allowed. If omitted, the report
220
+ # will include all labeled and unlabeled usage.
221
+ # Corresponds to the JSON property `labels`
222
+ # @return [Hash<String,Array<Object>>]
223
+ attr_accessor :labels
224
+
225
+ # Optional. A set of projects of the form `projects/`project``, specifying that
226
+ # usage from only this set of projects should be included in the budget. If
227
+ # omitted, the report will include all usage for the billing account, regardless
228
+ # of which project the usage occurred on. Only zero or one project can be
229
+ # specified currently.
230
+ # Corresponds to the JSON property `projects`
231
+ # @return [Array<String>]
232
+ attr_accessor :projects
233
+
234
+ # Optional. A set of services of the form `services/`service_id``, specifying
235
+ # that usage from only this set of services should be included in the budget. If
236
+ # omitted, the report will include usage for all the services. The service names
237
+ # are available through the Catalog API: https://cloud.google.com/billing/v1/how-
238
+ # tos/catalog-api.
239
+ # Corresponds to the JSON property `services`
240
+ # @return [Array<String>]
241
+ attr_accessor :services
242
+
243
+ # Optional. A set of subaccounts of the form `billingAccounts/`account_id``,
244
+ # specifying that usage from only this set of subaccounts should be included in
245
+ # the budget. If a subaccount is set to the name of the parent account, usage
246
+ # from the parent account will be included. If omitted, the report will include
247
+ # usage from the parent account and all subaccounts, if they exist.
248
+ # Corresponds to the JSON property `subaccounts`
249
+ # @return [Array<String>]
250
+ attr_accessor :subaccounts
251
+
252
+ def initialize(**args)
253
+ update!(**args)
254
+ end
255
+
256
+ # Update properties of this object
257
+ def update!(**args)
258
+ @credit_types = args[:credit_types] if args.key?(:credit_types)
259
+ @credit_types_treatment = args[:credit_types_treatment] if args.key?(:credit_types_treatment)
260
+ @labels = args[:labels] if args.key?(:labels)
261
+ @projects = args[:projects] if args.key?(:projects)
262
+ @services = args[:services] if args.key?(:services)
263
+ @subaccounts = args[:subaccounts] if args.key?(:subaccounts)
264
+ end
265
+ end
266
+
267
+ # Describes a budget amount targeted to last period's spend. At this time, the
268
+ # amount is automatically 100% of last period's spend; that is, there are no
269
+ # other options yet. Future configuration will be described here (for example,
270
+ # configuring a percentage of last period's spend).
271
+ class GoogleCloudBillingBudgetsV1beta1LastPeriodAmount
272
+ include Google::Apis::Core::Hashable
273
+
274
+ def initialize(**args)
275
+ update!(**args)
276
+ end
277
+
278
+ # Update properties of this object
279
+ def update!(**args)
280
+ end
281
+ end
282
+
283
+ # Response for ListBudgets
284
+ class GoogleCloudBillingBudgetsV1beta1ListBudgetsResponse
285
+ include Google::Apis::Core::Hashable
286
+
287
+ # List of the budgets owned by the requested billing account.
288
+ # Corresponds to the JSON property `budgets`
289
+ # @return [Array<Google::Apis::BillingbudgetsV1beta1::GoogleCloudBillingBudgetsV1beta1Budget>]
290
+ attr_accessor :budgets
291
+
292
+ # If not empty, indicates that there may be more budgets that match the request;
293
+ # this value should be passed in a new `ListBudgetsRequest`.
294
+ # Corresponds to the JSON property `nextPageToken`
295
+ # @return [String]
296
+ attr_accessor :next_page_token
297
+
298
+ def initialize(**args)
299
+ update!(**args)
300
+ end
301
+
302
+ # Update properties of this object
303
+ def update!(**args)
304
+ @budgets = args[:budgets] if args.key?(:budgets)
305
+ @next_page_token = args[:next_page_token] if args.key?(:next_page_token)
306
+ end
307
+ end
308
+
309
+ # ThresholdRule contains a definition of a threshold which triggers an alert (a
310
+ # notification of a threshold being crossed) to be sent when spend goes above
311
+ # the specified amount. Alerts are automatically e-mailed to users with the
312
+ # Billing Account Administrator role or the Billing Account User role. The
313
+ # thresholds here have no effect on notifications sent to anything configured
314
+ # under `Budget.all_updates_rule`.
315
+ class GoogleCloudBillingBudgetsV1beta1ThresholdRule
316
+ include Google::Apis::Core::Hashable
317
+
318
+ # Optional. The type of basis used to determine if spend has passed the
319
+ # threshold. Behavior defaults to CURRENT_SPEND if not set.
320
+ # Corresponds to the JSON property `spendBasis`
321
+ # @return [String]
322
+ attr_accessor :spend_basis
323
+
324
+ # Required. Send an alert when this threshold is exceeded. This is a 1.0-based
325
+ # percentage, so 0.5 = 50%. Validation: non-negative number.
326
+ # Corresponds to the JSON property `thresholdPercent`
327
+ # @return [Float]
328
+ attr_accessor :threshold_percent
329
+
330
+ def initialize(**args)
331
+ update!(**args)
332
+ end
333
+
334
+ # Update properties of this object
335
+ def update!(**args)
336
+ @spend_basis = args[:spend_basis] if args.key?(:spend_basis)
337
+ @threshold_percent = args[:threshold_percent] if args.key?(:threshold_percent)
338
+ end
339
+ end
340
+
341
+ # Request for UpdateBudget
342
+ class GoogleCloudBillingBudgetsV1beta1UpdateBudgetRequest
343
+ include Google::Apis::Core::Hashable
344
+
345
+ # A budget is a plan that describes what you expect to spend on Cloud projects,
346
+ # plus the rules to execute as spend is tracked against that plan, (for example,
347
+ # send an alert when 90% of the target spend is met). Currently all plans are
348
+ # monthly budgets so the usage period(s) tracked are implied (calendar months of
349
+ # usage back-to-back).
350
+ # Corresponds to the JSON property `budget`
351
+ # @return [Google::Apis::BillingbudgetsV1beta1::GoogleCloudBillingBudgetsV1beta1Budget]
352
+ attr_accessor :budget
353
+
354
+ # Optional. Indicates which fields in the provided budget to update. Read-only
355
+ # fields (such as `name`) cannot be changed. If this is not provided, then only
356
+ # fields with non-default values from the request are updated. See https://
357
+ # developers.google.com/protocol-buffers/docs/proto3#default for more details
358
+ # about default values.
359
+ # Corresponds to the JSON property `updateMask`
360
+ # @return [String]
361
+ attr_accessor :update_mask
362
+
363
+ def initialize(**args)
364
+ update!(**args)
365
+ end
366
+
367
+ # Update properties of this object
368
+ def update!(**args)
369
+ @budget = args[:budget] if args.key?(:budget)
370
+ @update_mask = args[:update_mask] if args.key?(:update_mask)
371
+ end
372
+ end
373
+
374
+ # A generic empty message that you can re-use to avoid defining duplicated empty
375
+ # messages in your APIs. A typical example is to use it as the request or the
376
+ # response type of an API method. For instance: service Foo ` rpc Bar(google.
377
+ # protobuf.Empty) returns (google.protobuf.Empty); ` The JSON representation for
378
+ # `Empty` is empty JSON object ````.
379
+ class GoogleProtobufEmpty
380
+ include Google::Apis::Core::Hashable
381
+
382
+ def initialize(**args)
383
+ update!(**args)
384
+ end
385
+
386
+ # Update properties of this object
387
+ def update!(**args)
388
+ end
389
+ end
390
+
391
+ # Represents an amount of money with its currency type.
392
+ class GoogleTypeMoney
393
+ include Google::Apis::Core::Hashable
394
+
395
+ # The three-letter currency code defined in ISO 4217.
396
+ # Corresponds to the JSON property `currencyCode`
397
+ # @return [String]
398
+ attr_accessor :currency_code
399
+
400
+ # Number of nano (10^-9) units of the amount. The value must be between -999,999,
401
+ # 999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be
402
+ # positive or zero. If `units` is zero, `nanos` can be positive, zero, or
403
+ # negative. If `units` is negative, `nanos` must be negative or zero. For
404
+ # example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
405
+ # Corresponds to the JSON property `nanos`
406
+ # @return [Fixnum]
407
+ attr_accessor :nanos
408
+
409
+ # The whole units of the amount. For example if `currencyCode` is `"USD"`, then
410
+ # 1 unit is one US dollar.
411
+ # Corresponds to the JSON property `units`
412
+ # @return [Fixnum]
413
+ attr_accessor :units
414
+
415
+ def initialize(**args)
416
+ update!(**args)
417
+ end
418
+
419
+ # Update properties of this object
420
+ def update!(**args)
421
+ @currency_code = args[:currency_code] if args.key?(:currency_code)
422
+ @nanos = args[:nanos] if args.key?(:nanos)
423
+ @units = args[:units] if args.key?(:units)
424
+ end
425
+ end
426
+ end
427
+ end
428
+ end