google-apis-billingbudgets_v1 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: fa119d3ea845b17b33ad74f5f9c7e7bce649436dc9702740eee06f8ba5a00611
4
+ data.tar.gz: d1ad2c70e5c1ac641ae90e2f03611b69d38d5ceee41ad03b5654621d9372ab75
5
+ SHA512:
6
+ metadata.gz: 57b33f5c14a5a99970fb636a6ddb1c90e60e3e6834010a43ae8841bfa1fa77019b2c82eeedd554e8c9b080a45a5ce5f3a8fd6229d476f74a087d48a59e2b4af2
7
+ data.tar.gz: b9c809539e6d5ba969366dbe8e7144466b2dde281fee9e54d5b4b1b0d74f79bb8bbb09ca132036f46d21e8e02aeab44424e7b74e17cc6fa38a10b048962e9ad5
@@ -0,0 +1,13 @@
1
+ --hide-void-return
2
+ --no-private
3
+ --verbose
4
+ --title=google-apis-billingbudgets_v1
5
+ --markup-provider=redcarpet
6
+ --markup=markdown
7
+ --main OVERVIEW.md
8
+ lib/google/apis/billingbudgets_v1/*.rb
9
+ lib/google/apis/billingbudgets_v1.rb
10
+ -
11
+ OVERVIEW.md
12
+ CHANGELOG.md
13
+ LICENSE.md
@@ -0,0 +1,7 @@
1
+ # Release history for google-apis-billingbudgets_v1
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 V1 of the Cloud Billing Budget API
2
+
3
+ This is a simple client library for version V1 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_v1', '~> 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_v1
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_v1"
49
+
50
+ # Create a client object
51
+ client = Google::Apis::BillingbudgetsV1::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::BillingbudgetsV1::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_v1`, 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_v1"
@@ -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_v1/service.rb'
16
+ require 'google/apis/billingbudgets_v1/classes.rb'
17
+ require 'google/apis/billingbudgets_v1/representations.rb'
18
+ require 'google/apis/billingbudgets_v1/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 BillingbudgetsV1
29
+ # Version of the Cloud Billing Budget API this client connects to.
30
+ # This is NOT the gem version.
31
+ VERSION = 'V1'
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,373 @@
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 BillingbudgetsV1
24
+
25
+ # A budget is a plan that describes what you expect to spend on Cloud projects,
26
+ # plus the rules to execute as spend is tracked against that plan, (for example,
27
+ # send an alert when 90% of the target spend is met). Currently all plans are
28
+ # monthly budgets so the usage period(s) tracked are implied (calendar months of
29
+ # usage back-to-back).
30
+ class GoogleCloudBillingBudgetsV1Budget
31
+ include Google::Apis::Core::Hashable
32
+
33
+ # The budgeted amount for each usage period.
34
+ # Corresponds to the JSON property `amount`
35
+ # @return [Google::Apis::BillingbudgetsV1::GoogleCloudBillingBudgetsV1BudgetAmount]
36
+ attr_accessor :amount
37
+
38
+ # A filter for a budget, limiting the scope of the cost to calculate.
39
+ # Corresponds to the JSON property `budgetFilter`
40
+ # @return [Google::Apis::BillingbudgetsV1::GoogleCloudBillingBudgetsV1Filter]
41
+ attr_accessor :budget_filter
42
+
43
+ # User data for display name in UI. The name must be less than or equal to 60
44
+ # characters.
45
+ # Corresponds to the JSON property `displayName`
46
+ # @return [String]
47
+ attr_accessor :display_name
48
+
49
+ # Optional. Etag to validate that the object is unchanged for a read-modify-
50
+ # write operation. An empty etag will cause an update to overwrite other changes.
51
+ # Corresponds to the JSON property `etag`
52
+ # @return [String]
53
+ attr_accessor :etag
54
+
55
+ # Output only. Resource name of the budget. The resource name implies the scope
56
+ # of a budget. Values are of the form `billingAccounts/`billingAccountId`/
57
+ # budgets/`budgetId``.
58
+ # Corresponds to the JSON property `name`
59
+ # @return [String]
60
+ attr_accessor :name
61
+
62
+ # NotificationsRule defines notifications that are sent based on budget spend
63
+ # and thresholds.
64
+ # Corresponds to the JSON property `notificationsRule`
65
+ # @return [Google::Apis::BillingbudgetsV1::GoogleCloudBillingBudgetsV1NotificationsRule]
66
+ attr_accessor :notifications_rule
67
+
68
+ # Optional. Rules that trigger alerts (notifications of thresholds being crossed)
69
+ # when spend exceeds the specified percentages of the budget.
70
+ # Corresponds to the JSON property `thresholdRules`
71
+ # @return [Array<Google::Apis::BillingbudgetsV1::GoogleCloudBillingBudgetsV1ThresholdRule>]
72
+ attr_accessor :threshold_rules
73
+
74
+ def initialize(**args)
75
+ update!(**args)
76
+ end
77
+
78
+ # Update properties of this object
79
+ def update!(**args)
80
+ @amount = args[:amount] if args.key?(:amount)
81
+ @budget_filter = args[:budget_filter] if args.key?(:budget_filter)
82
+ @display_name = args[:display_name] if args.key?(:display_name)
83
+ @etag = args[:etag] if args.key?(:etag)
84
+ @name = args[:name] if args.key?(:name)
85
+ @notifications_rule = args[:notifications_rule] if args.key?(:notifications_rule)
86
+ @threshold_rules = args[:threshold_rules] if args.key?(:threshold_rules)
87
+ end
88
+ end
89
+
90
+ # The budgeted amount for each usage period.
91
+ class GoogleCloudBillingBudgetsV1BudgetAmount
92
+ include Google::Apis::Core::Hashable
93
+
94
+ # Describes a budget amount targeted to last period's spend. At this time, the
95
+ # amount is automatically 100% of last period's spend; that is, there are no
96
+ # other options yet. Future configuration will be described here (for example,
97
+ # configuring a percentage of last period's spend).
98
+ # Corresponds to the JSON property `lastPeriodAmount`
99
+ # @return [Google::Apis::BillingbudgetsV1::GoogleCloudBillingBudgetsV1LastPeriodAmount]
100
+ attr_accessor :last_period_amount
101
+
102
+ # Represents an amount of money with its currency type.
103
+ # Corresponds to the JSON property `specifiedAmount`
104
+ # @return [Google::Apis::BillingbudgetsV1::GoogleTypeMoney]
105
+ attr_accessor :specified_amount
106
+
107
+ def initialize(**args)
108
+ update!(**args)
109
+ end
110
+
111
+ # Update properties of this object
112
+ def update!(**args)
113
+ @last_period_amount = args[:last_period_amount] if args.key?(:last_period_amount)
114
+ @specified_amount = args[:specified_amount] if args.key?(:specified_amount)
115
+ end
116
+ end
117
+
118
+ # A filter for a budget, limiting the scope of the cost to calculate.
119
+ class GoogleCloudBillingBudgetsV1Filter
120
+ include Google::Apis::Core::Hashable
121
+
122
+ # Optional. If Filter.credit_types_treatment is INCLUDE_SPECIFIED_CREDITS, this
123
+ # is a list of credit types to be subtracted from gross cost to determine the
124
+ # spend for threshold calculations. If Filter.credit_types_treatment is **not**
125
+ # INCLUDE_SPECIFIED_CREDITS, this field must be empty. See [a list of acceptable
126
+ # credit type values](https://cloud.google.com/billing/docs/how-to/export-data-
127
+ # bigquery-tables#credits-type).
128
+ # Corresponds to the JSON property `creditTypes`
129
+ # @return [Array<String>]
130
+ attr_accessor :credit_types
131
+
132
+ # Optional. If not set, default behavior is `INCLUDE_ALL_CREDITS`.
133
+ # Corresponds to the JSON property `creditTypesTreatment`
134
+ # @return [String]
135
+ attr_accessor :credit_types_treatment
136
+
137
+ # Optional. A single label and value pair specifying that usage from only this
138
+ # set of labeled resources should be included in the budget. Currently, multiple
139
+ # entries or multiple values per entry are not allowed. If omitted, the report
140
+ # will include all labeled and unlabeled usage.
141
+ # Corresponds to the JSON property `labels`
142
+ # @return [Hash<String,Array<Object>>]
143
+ attr_accessor :labels
144
+
145
+ # Optional. A set of projects of the form `projects/`project``, specifying that
146
+ # usage from only this set of projects should be included in the budget. If
147
+ # omitted, the report will include all usage for the billing account, regardless
148
+ # of which project the usage occurred on. Only zero or one project can be
149
+ # specified currently.
150
+ # Corresponds to the JSON property `projects`
151
+ # @return [Array<String>]
152
+ attr_accessor :projects
153
+
154
+ # Optional. A set of services of the form `services/`service_id``, specifying
155
+ # that usage from only this set of services should be included in the budget. If
156
+ # omitted, the report will include usage for all the services. The service names
157
+ # are available through the Catalog API: https://cloud.google.com/billing/v1/how-
158
+ # tos/catalog-api.
159
+ # Corresponds to the JSON property `services`
160
+ # @return [Array<String>]
161
+ attr_accessor :services
162
+
163
+ # Optional. A set of subaccounts of the form `billingAccounts/`account_id``,
164
+ # specifying that usage from only this set of subaccounts should be included in
165
+ # the budget. If a subaccount is set to the name of the parent account, usage
166
+ # from the parent account will be included. If the field is omitted, the report
167
+ # will include usage from the parent account and all subaccounts, if they exist.
168
+ # Corresponds to the JSON property `subaccounts`
169
+ # @return [Array<String>]
170
+ attr_accessor :subaccounts
171
+
172
+ def initialize(**args)
173
+ update!(**args)
174
+ end
175
+
176
+ # Update properties of this object
177
+ def update!(**args)
178
+ @credit_types = args[:credit_types] if args.key?(:credit_types)
179
+ @credit_types_treatment = args[:credit_types_treatment] if args.key?(:credit_types_treatment)
180
+ @labels = args[:labels] if args.key?(:labels)
181
+ @projects = args[:projects] if args.key?(:projects)
182
+ @services = args[:services] if args.key?(:services)
183
+ @subaccounts = args[:subaccounts] if args.key?(:subaccounts)
184
+ end
185
+ end
186
+
187
+ # Describes a budget amount targeted to last period's spend. At this time, the
188
+ # amount is automatically 100% of last period's spend; that is, there are no
189
+ # other options yet. Future configuration will be described here (for example,
190
+ # configuring a percentage of last period's spend).
191
+ class GoogleCloudBillingBudgetsV1LastPeriodAmount
192
+ include Google::Apis::Core::Hashable
193
+
194
+ def initialize(**args)
195
+ update!(**args)
196
+ end
197
+
198
+ # Update properties of this object
199
+ def update!(**args)
200
+ end
201
+ end
202
+
203
+ # Response for ListBudgets
204
+ class GoogleCloudBillingBudgetsV1ListBudgetsResponse
205
+ include Google::Apis::Core::Hashable
206
+
207
+ # List of the budgets owned by the requested billing account.
208
+ # Corresponds to the JSON property `budgets`
209
+ # @return [Array<Google::Apis::BillingbudgetsV1::GoogleCloudBillingBudgetsV1Budget>]
210
+ attr_accessor :budgets
211
+
212
+ # If not empty, indicates that there may be more budgets that match the request;
213
+ # this value should be passed in a new `ListBudgetsRequest`.
214
+ # Corresponds to the JSON property `nextPageToken`
215
+ # @return [String]
216
+ attr_accessor :next_page_token
217
+
218
+ def initialize(**args)
219
+ update!(**args)
220
+ end
221
+
222
+ # Update properties of this object
223
+ def update!(**args)
224
+ @budgets = args[:budgets] if args.key?(:budgets)
225
+ @next_page_token = args[:next_page_token] if args.key?(:next_page_token)
226
+ end
227
+ end
228
+
229
+ # NotificationsRule defines notifications that are sent based on budget spend
230
+ # and thresholds.
231
+ class GoogleCloudBillingBudgetsV1NotificationsRule
232
+ include Google::Apis::Core::Hashable
233
+
234
+ # Optional. When set to true, disables default notifications sent when a
235
+ # threshold is exceeded. Default notifications are sent to those with Billing
236
+ # Account Administrator and Billing Account User IAM roles for the target
237
+ # account.
238
+ # Corresponds to the JSON property `disableDefaultIamRecipients`
239
+ # @return [Boolean]
240
+ attr_accessor :disable_default_iam_recipients
241
+ alias_method :disable_default_iam_recipients?, :disable_default_iam_recipients
242
+
243
+ # Optional. Targets to send notifications to when a threshold is exceeded. This
244
+ # is in addition to default recipients who have billing account IAM roles. The
245
+ # value is the full REST resource name of a monitoring notification channel with
246
+ # the form `projects/`project_id`/notificationChannels/`channel_id``. A maximum
247
+ # of 5 channels are allowed. See https://cloud.google.com/billing/docs/how-to/
248
+ # budgets-notification-recipients for more details.
249
+ # Corresponds to the JSON property `monitoringNotificationChannels`
250
+ # @return [Array<String>]
251
+ attr_accessor :monitoring_notification_channels
252
+
253
+ # Optional. The name of the Pub/Sub topic where budget related messages will be
254
+ # published, in the form `projects/`project_id`/topics/`topic_id``. Updates are
255
+ # sent at regular intervals to the topic. The topic needs to be created before
256
+ # the budget is created; see https://cloud.google.com/billing/docs/how-to/
257
+ # budgets#manage-notifications for more details. Caller is expected to have `
258
+ # pubsub.topics.setIamPolicy` permission on the topic when it's set for a budget,
259
+ # otherwise, the API call will fail with PERMISSION_DENIED. See https://cloud.
260
+ # google.com/billing/docs/how-to/budgets-programmatic-notifications for more
261
+ # details on Pub/Sub roles and permissions.
262
+ # Corresponds to the JSON property `pubsubTopic`
263
+ # @return [String]
264
+ attr_accessor :pubsub_topic
265
+
266
+ # Optional. The schema version of the notification sent to `pubsub_topic`. Only "
267
+ # 1.0" is accepted. It represents the JSON schema as defined in https://cloud.
268
+ # google.com/billing/docs/how-to/budgets-programmatic-notifications#
269
+ # notification_format
270
+ # Corresponds to the JSON property `schemaVersion`
271
+ # @return [String]
272
+ attr_accessor :schema_version
273
+
274
+ def initialize(**args)
275
+ update!(**args)
276
+ end
277
+
278
+ # Update properties of this object
279
+ def update!(**args)
280
+ @disable_default_iam_recipients = args[:disable_default_iam_recipients] if args.key?(:disable_default_iam_recipients)
281
+ @monitoring_notification_channels = args[:monitoring_notification_channels] if args.key?(:monitoring_notification_channels)
282
+ @pubsub_topic = args[:pubsub_topic] if args.key?(:pubsub_topic)
283
+ @schema_version = args[:schema_version] if args.key?(:schema_version)
284
+ end
285
+ end
286
+
287
+ # ThresholdRule contains a definition of a threshold which triggers an alert (a
288
+ # notification of a threshold being crossed) to be sent when spend goes above
289
+ # the specified amount. Alerts are automatically e-mailed to users with the
290
+ # Billing Account Administrator role or the Billing Account User role. The
291
+ # thresholds here have no effect on notifications sent to anything configured
292
+ # under `Budget.all_updates_rule`.
293
+ class GoogleCloudBillingBudgetsV1ThresholdRule
294
+ include Google::Apis::Core::Hashable
295
+
296
+ # Optional. The type of basis used to determine if spend has passed the
297
+ # threshold. Behavior defaults to CURRENT_SPEND if not set.
298
+ # Corresponds to the JSON property `spendBasis`
299
+ # @return [String]
300
+ attr_accessor :spend_basis
301
+
302
+ # Required. Send an alert when this threshold is exceeded. This is a 1.0-based
303
+ # percentage, so 0.5 = 50%. Validation: non-negative number.
304
+ # Corresponds to the JSON property `thresholdPercent`
305
+ # @return [Float]
306
+ attr_accessor :threshold_percent
307
+
308
+ def initialize(**args)
309
+ update!(**args)
310
+ end
311
+
312
+ # Update properties of this object
313
+ def update!(**args)
314
+ @spend_basis = args[:spend_basis] if args.key?(:spend_basis)
315
+ @threshold_percent = args[:threshold_percent] if args.key?(:threshold_percent)
316
+ end
317
+ end
318
+
319
+ # A generic empty message that you can re-use to avoid defining duplicated empty
320
+ # messages in your APIs. A typical example is to use it as the request or the
321
+ # response type of an API method. For instance: service Foo ` rpc Bar(google.
322
+ # protobuf.Empty) returns (google.protobuf.Empty); ` The JSON representation for
323
+ # `Empty` is empty JSON object ````.
324
+ class GoogleProtobufEmpty
325
+ include Google::Apis::Core::Hashable
326
+
327
+ def initialize(**args)
328
+ update!(**args)
329
+ end
330
+
331
+ # Update properties of this object
332
+ def update!(**args)
333
+ end
334
+ end
335
+
336
+ # Represents an amount of money with its currency type.
337
+ class GoogleTypeMoney
338
+ include Google::Apis::Core::Hashable
339
+
340
+ # The three-letter currency code defined in ISO 4217.
341
+ # Corresponds to the JSON property `currencyCode`
342
+ # @return [String]
343
+ attr_accessor :currency_code
344
+
345
+ # Number of nano (10^-9) units of the amount. The value must be between -999,999,
346
+ # 999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be
347
+ # positive or zero. If `units` is zero, `nanos` can be positive, zero, or
348
+ # negative. If `units` is negative, `nanos` must be negative or zero. For
349
+ # example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
350
+ # Corresponds to the JSON property `nanos`
351
+ # @return [Fixnum]
352
+ attr_accessor :nanos
353
+
354
+ # The whole units of the amount. For example if `currencyCode` is `"USD"`, then
355
+ # 1 unit is one US dollar.
356
+ # Corresponds to the JSON property `units`
357
+ # @return [Fixnum]
358
+ attr_accessor :units
359
+
360
+ def initialize(**args)
361
+ update!(**args)
362
+ end
363
+
364
+ # Update properties of this object
365
+ def update!(**args)
366
+ @currency_code = args[:currency_code] if args.key?(:currency_code)
367
+ @nanos = args[:nanos] if args.key?(:nanos)
368
+ @units = args[:units] if args.key?(:units)
369
+ end
370
+ end
371
+ end
372
+ end
373
+ end
@@ -0,0 +1,28 @@
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
+ module Google
16
+ module Apis
17
+ module BillingbudgetsV1
18
+ # Version of the google-apis-billingbudgets_v1 gem
19
+ GEM_VERSION = "0.1.0"
20
+
21
+ # Version of the code generator used to generate this client
22
+ GENERATOR_VERSION = "0.1.1"
23
+
24
+ # Revision of the discovery document this client was generated from
25
+ REVISION = "20201107"
26
+ end
27
+ end
28
+ end
@@ -0,0 +1,171 @@
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 BillingbudgetsV1
24
+
25
+ class GoogleCloudBillingBudgetsV1Budget
26
+ class Representation < Google::Apis::Core::JsonRepresentation; end
27
+
28
+ include Google::Apis::Core::JsonObjectSupport
29
+ end
30
+
31
+ class GoogleCloudBillingBudgetsV1BudgetAmount
32
+ class Representation < Google::Apis::Core::JsonRepresentation; end
33
+
34
+ include Google::Apis::Core::JsonObjectSupport
35
+ end
36
+
37
+ class GoogleCloudBillingBudgetsV1Filter
38
+ class Representation < Google::Apis::Core::JsonRepresentation; end
39
+
40
+ include Google::Apis::Core::JsonObjectSupport
41
+ end
42
+
43
+ class GoogleCloudBillingBudgetsV1LastPeriodAmount
44
+ class Representation < Google::Apis::Core::JsonRepresentation; end
45
+
46
+ include Google::Apis::Core::JsonObjectSupport
47
+ end
48
+
49
+ class GoogleCloudBillingBudgetsV1ListBudgetsResponse
50
+ class Representation < Google::Apis::Core::JsonRepresentation; end
51
+
52
+ include Google::Apis::Core::JsonObjectSupport
53
+ end
54
+
55
+ class GoogleCloudBillingBudgetsV1NotificationsRule
56
+ class Representation < Google::Apis::Core::JsonRepresentation; end
57
+
58
+ include Google::Apis::Core::JsonObjectSupport
59
+ end
60
+
61
+ class GoogleCloudBillingBudgetsV1ThresholdRule
62
+ class Representation < Google::Apis::Core::JsonRepresentation; end
63
+
64
+ include Google::Apis::Core::JsonObjectSupport
65
+ end
66
+
67
+ class GoogleProtobufEmpty
68
+ class Representation < Google::Apis::Core::JsonRepresentation; end
69
+
70
+ include Google::Apis::Core::JsonObjectSupport
71
+ end
72
+
73
+ class GoogleTypeMoney
74
+ class Representation < Google::Apis::Core::JsonRepresentation; end
75
+
76
+ include Google::Apis::Core::JsonObjectSupport
77
+ end
78
+
79
+ class GoogleCloudBillingBudgetsV1Budget
80
+ # @private
81
+ class Representation < Google::Apis::Core::JsonRepresentation
82
+ property :amount, as: 'amount', class: Google::Apis::BillingbudgetsV1::GoogleCloudBillingBudgetsV1BudgetAmount, decorator: Google::Apis::BillingbudgetsV1::GoogleCloudBillingBudgetsV1BudgetAmount::Representation
83
+
84
+ property :budget_filter, as: 'budgetFilter', class: Google::Apis::BillingbudgetsV1::GoogleCloudBillingBudgetsV1Filter, decorator: Google::Apis::BillingbudgetsV1::GoogleCloudBillingBudgetsV1Filter::Representation
85
+
86
+ property :display_name, as: 'displayName'
87
+ property :etag, as: 'etag'
88
+ property :name, as: 'name'
89
+ property :notifications_rule, as: 'notificationsRule', class: Google::Apis::BillingbudgetsV1::GoogleCloudBillingBudgetsV1NotificationsRule, decorator: Google::Apis::BillingbudgetsV1::GoogleCloudBillingBudgetsV1NotificationsRule::Representation
90
+
91
+ collection :threshold_rules, as: 'thresholdRules', class: Google::Apis::BillingbudgetsV1::GoogleCloudBillingBudgetsV1ThresholdRule, decorator: Google::Apis::BillingbudgetsV1::GoogleCloudBillingBudgetsV1ThresholdRule::Representation
92
+
93
+ end
94
+ end
95
+
96
+ class GoogleCloudBillingBudgetsV1BudgetAmount
97
+ # @private
98
+ class Representation < Google::Apis::Core::JsonRepresentation
99
+ property :last_period_amount, as: 'lastPeriodAmount', class: Google::Apis::BillingbudgetsV1::GoogleCloudBillingBudgetsV1LastPeriodAmount, decorator: Google::Apis::BillingbudgetsV1::GoogleCloudBillingBudgetsV1LastPeriodAmount::Representation
100
+
101
+ property :specified_amount, as: 'specifiedAmount', class: Google::Apis::BillingbudgetsV1::GoogleTypeMoney, decorator: Google::Apis::BillingbudgetsV1::GoogleTypeMoney::Representation
102
+
103
+ end
104
+ end
105
+
106
+ class GoogleCloudBillingBudgetsV1Filter
107
+ # @private
108
+ class Representation < Google::Apis::Core::JsonRepresentation
109
+ collection :credit_types, as: 'creditTypes'
110
+ property :credit_types_treatment, as: 'creditTypesTreatment'
111
+ hash :labels, as: 'labels', :class => Array do
112
+ include Representable::JSON::Collection
113
+ items
114
+ end
115
+
116
+ collection :projects, as: 'projects'
117
+ collection :services, as: 'services'
118
+ collection :subaccounts, as: 'subaccounts'
119
+ end
120
+ end
121
+
122
+ class GoogleCloudBillingBudgetsV1LastPeriodAmount
123
+ # @private
124
+ class Representation < Google::Apis::Core::JsonRepresentation
125
+ end
126
+ end
127
+
128
+ class GoogleCloudBillingBudgetsV1ListBudgetsResponse
129
+ # @private
130
+ class Representation < Google::Apis::Core::JsonRepresentation
131
+ collection :budgets, as: 'budgets', class: Google::Apis::BillingbudgetsV1::GoogleCloudBillingBudgetsV1Budget, decorator: Google::Apis::BillingbudgetsV1::GoogleCloudBillingBudgetsV1Budget::Representation
132
+
133
+ property :next_page_token, as: 'nextPageToken'
134
+ end
135
+ end
136
+
137
+ class GoogleCloudBillingBudgetsV1NotificationsRule
138
+ # @private
139
+ class Representation < Google::Apis::Core::JsonRepresentation
140
+ property :disable_default_iam_recipients, as: 'disableDefaultIamRecipients'
141
+ collection :monitoring_notification_channels, as: 'monitoringNotificationChannels'
142
+ property :pubsub_topic, as: 'pubsubTopic'
143
+ property :schema_version, as: 'schemaVersion'
144
+ end
145
+ end
146
+
147
+ class GoogleCloudBillingBudgetsV1ThresholdRule
148
+ # @private
149
+ class Representation < Google::Apis::Core::JsonRepresentation
150
+ property :spend_basis, as: 'spendBasis'
151
+ property :threshold_percent, as: 'thresholdPercent'
152
+ end
153
+ end
154
+
155
+ class GoogleProtobufEmpty
156
+ # @private
157
+ class Representation < Google::Apis::Core::JsonRepresentation
158
+ end
159
+ end
160
+
161
+ class GoogleTypeMoney
162
+ # @private
163
+ class Representation < Google::Apis::Core::JsonRepresentation
164
+ property :currency_code, as: 'currencyCode'
165
+ property :nanos, as: 'nanos'
166
+ property :units, :numeric_string => true, as: 'units'
167
+ end
168
+ end
169
+ end
170
+ end
171
+ end
@@ -0,0 +1,251 @@
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/core/base_service'
16
+ require 'google/apis/core/json_representation'
17
+ require 'google/apis/core/hashable'
18
+ require 'google/apis/errors'
19
+
20
+ module Google
21
+ module Apis
22
+ module BillingbudgetsV1
23
+ # Cloud Billing Budget API
24
+ #
25
+ # The Cloud Billing Budget API stores Cloud Billing budgets, which define a
26
+ # budget plan and the rules to execute as spend is tracked against that plan.
27
+ #
28
+ # @example
29
+ # require 'google/apis/billingbudgets_v1'
30
+ #
31
+ # Billingbudgets = Google::Apis::BillingbudgetsV1 # Alias the module
32
+ # service = Billingbudgets::CloudBillingBudgetService.new
33
+ #
34
+ # @see https://cloud.google.com/billing/docs/how-to/budget-api-overview
35
+ class CloudBillingBudgetService < Google::Apis::Core::BaseService
36
+ # @return [String]
37
+ # API key. Your API key identifies your project and provides you with API access,
38
+ # quota, and reports. Required unless you provide an OAuth 2.0 token.
39
+ attr_accessor :key
40
+
41
+ # @return [String]
42
+ # Available to use for quota purposes for server-side applications. Can be any
43
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
44
+ attr_accessor :quota_user
45
+
46
+ def initialize
47
+ super('https://billingbudgets.googleapis.com/', '',
48
+ client_name: 'google-apis-billingbudgets_v1',
49
+ client_version: Google::Apis::BillingbudgetsV1::GEM_VERSION)
50
+ @batch_path = 'batch'
51
+ end
52
+
53
+ # Creates a new budget. See [Quotas and limits](https://cloud.google.com/billing/
54
+ # quotas) for more information on the limits of the number of budgets you can
55
+ # create.
56
+ # @param [String] parent
57
+ # Required. The name of the billing account to create the budget in. Values are
58
+ # of the form `billingAccounts/`billingAccountId``.
59
+ # @param [Google::Apis::BillingbudgetsV1::GoogleCloudBillingBudgetsV1Budget] google_cloud_billing_budgets_v1_budget_object
60
+ # @param [String] fields
61
+ # Selector specifying which fields to include in a partial response.
62
+ # @param [String] quota_user
63
+ # Available to use for quota purposes for server-side applications. Can be any
64
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
65
+ # @param [Google::Apis::RequestOptions] options
66
+ # Request-specific options
67
+ #
68
+ # @yield [result, err] Result & error if block supplied
69
+ # @yieldparam result [Google::Apis::BillingbudgetsV1::GoogleCloudBillingBudgetsV1Budget] parsed result object
70
+ # @yieldparam err [StandardError] error object if request failed
71
+ #
72
+ # @return [Google::Apis::BillingbudgetsV1::GoogleCloudBillingBudgetsV1Budget]
73
+ #
74
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
75
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
76
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
77
+ def create_billing_account_budget(parent, google_cloud_billing_budgets_v1_budget_object = nil, fields: nil, quota_user: nil, options: nil, &block)
78
+ command = make_simple_command(:post, 'v1/{+parent}/budgets', options)
79
+ command.request_representation = Google::Apis::BillingbudgetsV1::GoogleCloudBillingBudgetsV1Budget::Representation
80
+ command.request_object = google_cloud_billing_budgets_v1_budget_object
81
+ command.response_representation = Google::Apis::BillingbudgetsV1::GoogleCloudBillingBudgetsV1Budget::Representation
82
+ command.response_class = Google::Apis::BillingbudgetsV1::GoogleCloudBillingBudgetsV1Budget
83
+ command.params['parent'] = parent unless parent.nil?
84
+ command.query['fields'] = fields unless fields.nil?
85
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
86
+ execute_or_queue_command(command, &block)
87
+ end
88
+
89
+ # Deletes a budget. Returns successfully if already deleted.
90
+ # @param [String] name
91
+ # Required. Name of the budget to delete. Values are of the form `
92
+ # billingAccounts/`billingAccountId`/budgets/`budgetId``.
93
+ # @param [String] fields
94
+ # Selector specifying which fields to include in a partial response.
95
+ # @param [String] quota_user
96
+ # Available to use for quota purposes for server-side applications. Can be any
97
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
98
+ # @param [Google::Apis::RequestOptions] options
99
+ # Request-specific options
100
+ #
101
+ # @yield [result, err] Result & error if block supplied
102
+ # @yieldparam result [Google::Apis::BillingbudgetsV1::GoogleProtobufEmpty] parsed result object
103
+ # @yieldparam err [StandardError] error object if request failed
104
+ #
105
+ # @return [Google::Apis::BillingbudgetsV1::GoogleProtobufEmpty]
106
+ #
107
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
108
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
109
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
110
+ def delete_billing_account_budget(name, fields: nil, quota_user: nil, options: nil, &block)
111
+ command = make_simple_command(:delete, 'v1/{+name}', options)
112
+ command.response_representation = Google::Apis::BillingbudgetsV1::GoogleProtobufEmpty::Representation
113
+ command.response_class = Google::Apis::BillingbudgetsV1::GoogleProtobufEmpty
114
+ command.params['name'] = name unless name.nil?
115
+ command.query['fields'] = fields unless fields.nil?
116
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
117
+ execute_or_queue_command(command, &block)
118
+ end
119
+
120
+ # Returns a budget. WARNING: There are some fields exposed on the Google Cloud
121
+ # Console that aren't available on this API. When reading from the API, you will
122
+ # not see these fields in the return value, though they may have been set in the
123
+ # Cloud Console.
124
+ # @param [String] name
125
+ # Required. Name of budget to get. Values are of the form `billingAccounts/`
126
+ # billingAccountId`/budgets/`budgetId``.
127
+ # @param [String] fields
128
+ # Selector specifying which fields to include in a partial response.
129
+ # @param [String] quota_user
130
+ # Available to use for quota purposes for server-side applications. Can be any
131
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
132
+ # @param [Google::Apis::RequestOptions] options
133
+ # Request-specific options
134
+ #
135
+ # @yield [result, err] Result & error if block supplied
136
+ # @yieldparam result [Google::Apis::BillingbudgetsV1::GoogleCloudBillingBudgetsV1Budget] parsed result object
137
+ # @yieldparam err [StandardError] error object if request failed
138
+ #
139
+ # @return [Google::Apis::BillingbudgetsV1::GoogleCloudBillingBudgetsV1Budget]
140
+ #
141
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
142
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
143
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
144
+ def get_billing_account_budget(name, fields: nil, quota_user: nil, options: nil, &block)
145
+ command = make_simple_command(:get, 'v1/{+name}', options)
146
+ command.response_representation = Google::Apis::BillingbudgetsV1::GoogleCloudBillingBudgetsV1Budget::Representation
147
+ command.response_class = Google::Apis::BillingbudgetsV1::GoogleCloudBillingBudgetsV1Budget
148
+ command.params['name'] = name unless name.nil?
149
+ command.query['fields'] = fields unless fields.nil?
150
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
151
+ execute_or_queue_command(command, &block)
152
+ end
153
+
154
+ # Returns a list of budgets for a billing account. WARNING: There are some
155
+ # fields exposed on the Google Cloud Console that aren't available on this API.
156
+ # When reading from the API, you will not see these fields in the return value,
157
+ # though they may have been set in the Cloud Console.
158
+ # @param [String] parent
159
+ # Required. Name of billing account to list budgets under. Values are of the
160
+ # form `billingAccounts/`billingAccountId``.
161
+ # @param [Fixnum] page_size
162
+ # Optional. The maximum number of budgets to return per page. The default and
163
+ # maximum value are 100.
164
+ # @param [String] page_token
165
+ # Optional. The value returned by the last `ListBudgetsResponse` which indicates
166
+ # that this is a continuation of a prior `ListBudgets` call, and that the system
167
+ # should return the next page of data.
168
+ # @param [String] fields
169
+ # Selector specifying which fields to include in a partial response.
170
+ # @param [String] quota_user
171
+ # Available to use for quota purposes for server-side applications. Can be any
172
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
173
+ # @param [Google::Apis::RequestOptions] options
174
+ # Request-specific options
175
+ #
176
+ # @yield [result, err] Result & error if block supplied
177
+ # @yieldparam result [Google::Apis::BillingbudgetsV1::GoogleCloudBillingBudgetsV1ListBudgetsResponse] parsed result object
178
+ # @yieldparam err [StandardError] error object if request failed
179
+ #
180
+ # @return [Google::Apis::BillingbudgetsV1::GoogleCloudBillingBudgetsV1ListBudgetsResponse]
181
+ #
182
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
183
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
184
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
185
+ def list_billing_account_budgets(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
186
+ command = make_simple_command(:get, 'v1/{+parent}/budgets', options)
187
+ command.response_representation = Google::Apis::BillingbudgetsV1::GoogleCloudBillingBudgetsV1ListBudgetsResponse::Representation
188
+ command.response_class = Google::Apis::BillingbudgetsV1::GoogleCloudBillingBudgetsV1ListBudgetsResponse
189
+ command.params['parent'] = parent unless parent.nil?
190
+ command.query['pageSize'] = page_size unless page_size.nil?
191
+ command.query['pageToken'] = page_token unless page_token.nil?
192
+ command.query['fields'] = fields unless fields.nil?
193
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
194
+ execute_or_queue_command(command, &block)
195
+ end
196
+
197
+ # Updates a budget and returns the updated budget. WARNING: There are some
198
+ # fields exposed on the Google Cloud Console that aren't available on this API.
199
+ # Budget fields that are not exposed in this API will not be changed by this
200
+ # method.
201
+ # @param [String] name
202
+ # Output only. Resource name of the budget. The resource name implies the scope
203
+ # of a budget. Values are of the form `billingAccounts/`billingAccountId`/
204
+ # budgets/`budgetId``.
205
+ # @param [Google::Apis::BillingbudgetsV1::GoogleCloudBillingBudgetsV1Budget] google_cloud_billing_budgets_v1_budget_object
206
+ # @param [String] update_mask
207
+ # Optional. Indicates which fields in the provided budget to update. Read-only
208
+ # fields (such as `name`) cannot be changed. If this is not provided, then only
209
+ # fields with non-default values from the request are updated. See https://
210
+ # developers.google.com/protocol-buffers/docs/proto3#default for more details
211
+ # about default values.
212
+ # @param [String] fields
213
+ # Selector specifying which fields to include in a partial response.
214
+ # @param [String] quota_user
215
+ # Available to use for quota purposes for server-side applications. Can be any
216
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
217
+ # @param [Google::Apis::RequestOptions] options
218
+ # Request-specific options
219
+ #
220
+ # @yield [result, err] Result & error if block supplied
221
+ # @yieldparam result [Google::Apis::BillingbudgetsV1::GoogleCloudBillingBudgetsV1Budget] parsed result object
222
+ # @yieldparam err [StandardError] error object if request failed
223
+ #
224
+ # @return [Google::Apis::BillingbudgetsV1::GoogleCloudBillingBudgetsV1Budget]
225
+ #
226
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
227
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
228
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
229
+ def patch_billing_account_budget(name, google_cloud_billing_budgets_v1_budget_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
230
+ command = make_simple_command(:patch, 'v1/{+name}', options)
231
+ command.request_representation = Google::Apis::BillingbudgetsV1::GoogleCloudBillingBudgetsV1Budget::Representation
232
+ command.request_object = google_cloud_billing_budgets_v1_budget_object
233
+ command.response_representation = Google::Apis::BillingbudgetsV1::GoogleCloudBillingBudgetsV1Budget::Representation
234
+ command.response_class = Google::Apis::BillingbudgetsV1::GoogleCloudBillingBudgetsV1Budget
235
+ command.params['name'] = name unless name.nil?
236
+ command.query['updateMask'] = update_mask unless update_mask.nil?
237
+ command.query['fields'] = fields unless fields.nil?
238
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
239
+ execute_or_queue_command(command, &block)
240
+ end
241
+
242
+ protected
243
+
244
+ def apply_command_defaults(command)
245
+ command.query['key'] = key unless key.nil?
246
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
247
+ end
248
+ end
249
+ end
250
+ end
251
+ end
metadata ADDED
@@ -0,0 +1,76 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: google-apis-billingbudgets_v1
3
+ version: !ruby/object:Gem::Version
4
+ version: 0.1.0
5
+ platform: ruby
6
+ authors:
7
+ - Google LLC
8
+ autorequire:
9
+ bindir: bin
10
+ cert_chain: []
11
+ date: 2021-01-08 00:00:00.000000000 Z
12
+ dependencies:
13
+ - !ruby/object:Gem::Dependency
14
+ name: google-apis-core
15
+ requirement: !ruby/object:Gem::Requirement
16
+ requirements:
17
+ - - "~>"
18
+ - !ruby/object:Gem::Version
19
+ version: '0.1'
20
+ type: :runtime
21
+ prerelease: false
22
+ version_requirements: !ruby/object:Gem::Requirement
23
+ requirements:
24
+ - - "~>"
25
+ - !ruby/object:Gem::Version
26
+ version: '0.1'
27
+ description: This is the simple REST client for Cloud Billing Budget API V1. Simple
28
+ REST clients are Ruby client libraries that provide access to Google services via
29
+ their HTTP REST API endpoints. These libraries are generated and updated automatically
30
+ based on the discovery documents published by the service, and they handle most
31
+ concerns such as authentication, pagination, retry, timeouts, and logging. You can
32
+ use this client to access the Cloud Billing Budget API, but note that some services
33
+ may provide a separate modern client that is easier to use.
34
+ email: googleapis-packages@google.com
35
+ executables: []
36
+ extensions: []
37
+ extra_rdoc_files: []
38
+ files:
39
+ - ".yardopts"
40
+ - CHANGELOG.md
41
+ - LICENSE.md
42
+ - OVERVIEW.md
43
+ - lib/google-apis-billingbudgets_v1.rb
44
+ - lib/google/apis/billingbudgets_v1.rb
45
+ - lib/google/apis/billingbudgets_v1/classes.rb
46
+ - lib/google/apis/billingbudgets_v1/gem_version.rb
47
+ - lib/google/apis/billingbudgets_v1/representations.rb
48
+ - lib/google/apis/billingbudgets_v1/service.rb
49
+ homepage: https://github.com/google/google-api-ruby-client
50
+ licenses:
51
+ - Apache-2.0
52
+ metadata:
53
+ bug_tracker_uri: https://github.com/googleapis/google-api-ruby-client/issues
54
+ changelog_uri: https://github.com/googleapis/google-api-ruby-client/tree/master/generated/google-apis-billingbudgets_v1/CHANGELOG.md
55
+ documentation_uri: https://googleapis.dev/ruby/google-apis-billingbudgets_v1/v0.1.0
56
+ source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/master/generated/google-apis-billingbudgets_v1
57
+ post_install_message:
58
+ rdoc_options: []
59
+ require_paths:
60
+ - lib
61
+ required_ruby_version: !ruby/object:Gem::Requirement
62
+ requirements:
63
+ - - ">="
64
+ - !ruby/object:Gem::Version
65
+ version: '2.4'
66
+ required_rubygems_version: !ruby/object:Gem::Requirement
67
+ requirements:
68
+ - - ">="
69
+ - !ruby/object:Gem::Version
70
+ version: '0'
71
+ requirements: []
72
+ rubygems_version: 3.1.4
73
+ signing_key:
74
+ specification_version: 4
75
+ summary: Simple REST client for Cloud Billing Budget API V1
76
+ test_files: []