google-cloud-billing-budgets-v1beta1 0.6.4 → 0.6.5
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/README.md +1 -1
- data/lib/google/cloud/billing/budgets/v1beta1/budget_service/client.rb +1 -1
- data/lib/google/cloud/billing/budgets/v1beta1/budget_service_services_pb.rb +1 -1
- data/lib/google/cloud/billing/budgets/v1beta1/version.rb +1 -1
- data/proto_docs/google/cloud/billing/budgets/v1beta1/budget_model.rb +73 -57
- metadata +3 -3
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 2f0a019923807b193b37f5a0e7a94e97f54e2bbc89c9ce752c43e8fbcd6d9160
|
|
4
|
+
data.tar.gz: a8379506fdfb24b54eccf0565d2f99afa0024887335b3d8817fd00936bddf223
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 5b9a2259f7f81933a6421e1503bef5e27a2e30067446ec95fd2b880f786e030efd570d09e91c44b0675462026600295d4a36d1b9ddea6f764af9d1a14b3c57e5
|
|
7
|
+
data.tar.gz: 8d5a140112dbd81ed42b2d635345cefb630a711c8eed9317e1988e64684e6a34ed1329aee026d3b651c316bc9030b148ccf3e17323ef96492b37918bec1aeb9b
|
data/README.md
CHANGED
|
@@ -37,7 +37,7 @@ request = ::Google::Cloud::Billing::Budgets::V1beta1::CreateBudgetRequest.new #
|
|
|
37
37
|
response = client.create_budget request
|
|
38
38
|
```
|
|
39
39
|
|
|
40
|
-
View the [Client Library Documentation](https://
|
|
40
|
+
View the [Client Library Documentation](https://cloud.google.com/ruby/docs/reference/google-cloud-billing-budgets-v1beta1/latest)
|
|
41
41
|
for class and method documentation.
|
|
42
42
|
|
|
43
43
|
See also the [Product Documentation](https://cloud.google.com/billing/docs/how-to/budget-api-overview)
|
|
@@ -170,7 +170,7 @@ module Google
|
|
|
170
170
|
|
|
171
171
|
##
|
|
172
172
|
# Creates a new budget. See
|
|
173
|
-
#
|
|
173
|
+
# [Quotas and limits](https://cloud.google.com/billing/quotas)
|
|
174
174
|
# for more information on the limits of the number of budgets you can create.
|
|
175
175
|
#
|
|
176
176
|
# @overload create_budget(request, options = nil)
|
|
@@ -36,7 +36,7 @@ module Google
|
|
|
36
36
|
self.service_name = 'google.cloud.billing.budgets.v1beta1.BudgetService'
|
|
37
37
|
|
|
38
38
|
# Creates a new budget. See
|
|
39
|
-
#
|
|
39
|
+
# [Quotas and limits](https://cloud.google.com/billing/quotas)
|
|
40
40
|
# for more information on the limits of the number of budgets you can create.
|
|
41
41
|
rpc :CreateBudget, ::Google::Cloud::Billing::Budgets::V1beta1::CreateBudgetRequest, ::Google::Cloud::Billing::Budgets::V1beta1::Budget
|
|
42
42
|
# Updates a budget and returns the updated budget.
|
|
@@ -38,9 +38,9 @@ module Google
|
|
|
38
38
|
# Validation: <= 60 chars.
|
|
39
39
|
# @!attribute [rw] budget_filter
|
|
40
40
|
# @return [::Google::Cloud::Billing::Budgets::V1beta1::Filter]
|
|
41
|
-
# Optional. Filters that define which resources are used to compute the
|
|
42
|
-
#
|
|
43
|
-
#
|
|
41
|
+
# Optional. Filters that define which resources are used to compute the actual spend
|
|
42
|
+
# against the budget amount, such as projects, services, and the budget's
|
|
43
|
+
# time period, as well as other filters.
|
|
44
44
|
# @!attribute [rw] amount
|
|
45
45
|
# @return [::Google::Cloud::Billing::Budgets::V1beta1::BudgetAmount]
|
|
46
46
|
# Required. Budgeted amount.
|
|
@@ -48,10 +48,13 @@ module Google
|
|
|
48
48
|
# @return [::Array<::Google::Cloud::Billing::Budgets::V1beta1::ThresholdRule>]
|
|
49
49
|
# Optional. Rules that trigger alerts (notifications of thresholds
|
|
50
50
|
# being crossed) when spend exceeds the specified percentages of the budget.
|
|
51
|
+
#
|
|
52
|
+
# Optional for `pubsubTopic` notifications.
|
|
53
|
+
#
|
|
54
|
+
# Required if using email notifications.
|
|
51
55
|
# @!attribute [rw] all_updates_rule
|
|
52
56
|
# @return [::Google::Cloud::Billing::Budgets::V1beta1::AllUpdatesRule]
|
|
53
|
-
# Optional. Rules to apply to notifications sent based on budget spend and
|
|
54
|
-
# thresholds.
|
|
57
|
+
# Optional. Rules to apply to notifications sent based on budget spend and thresholds.
|
|
55
58
|
# @!attribute [rw] etag
|
|
56
59
|
# @return [::String]
|
|
57
60
|
# Optional. Etag to validate that the object is unchanged for a
|
|
@@ -74,35 +77,47 @@ module Google
|
|
|
74
77
|
# @return [::Google::Cloud::Billing::Budgets::V1beta1::LastPeriodAmount]
|
|
75
78
|
# Use the last period's actual spend as the budget for the present period.
|
|
76
79
|
# LastPeriodAmount can only be set when the budget's time period is a
|
|
77
|
-
# {::Google::Cloud::Billing::Budgets::V1beta1::Filter#calendar_period Filter.calendar_period}.
|
|
78
|
-
# It cannot be set in combination with
|
|
80
|
+
# {::Google::Cloud::Billing::Budgets::V1beta1::Filter#calendar_period Filter.calendar_period}. It cannot be set in combination with
|
|
79
81
|
# {::Google::Cloud::Billing::Budgets::V1beta1::Filter#custom_period Filter.custom_period}.
|
|
80
82
|
class BudgetAmount
|
|
81
83
|
include ::Google::Protobuf::MessageExts
|
|
82
84
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
83
85
|
end
|
|
84
86
|
|
|
85
|
-
# Describes a budget amount targeted to the last
|
|
86
|
-
# {::Google::Cloud::Billing::Budgets::V1beta1::Filter#calendar_period Filter.calendar_period}
|
|
87
|
+
# Describes a budget amount targeted to the last {::Google::Cloud::Billing::Budgets::V1beta1::Filter#calendar_period Filter.calendar_period}
|
|
87
88
|
# spend. At this time, the amount is automatically 100% of the last calendar
|
|
88
89
|
# period's spend; that is, there are no other options yet.
|
|
89
90
|
# Future configuration options will be described here (for example, configuring
|
|
90
91
|
# a percentage of last period's spend).
|
|
91
92
|
# LastPeriodAmount cannot be set for a budget configured with
|
|
92
|
-
# a
|
|
93
|
-
# {::Google::Cloud::Billing::Budgets::V1beta1::Filter#custom_period Filter.custom_period}.
|
|
93
|
+
# a {::Google::Cloud::Billing::Budgets::V1beta1::Filter#custom_period Filter.custom_period}.
|
|
94
94
|
class LastPeriodAmount
|
|
95
95
|
include ::Google::Protobuf::MessageExts
|
|
96
96
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
97
97
|
end
|
|
98
98
|
|
|
99
|
-
# ThresholdRule contains
|
|
100
|
-
#
|
|
101
|
-
# spend
|
|
102
|
-
#
|
|
103
|
-
#
|
|
104
|
-
#
|
|
105
|
-
#
|
|
99
|
+
# ThresholdRule contains the definition of a threshold. Threshold rules define
|
|
100
|
+
# the triggering events used to generate a budget notification email. When a
|
|
101
|
+
# threshold is crossed (spend exceeds the specified percentages of the
|
|
102
|
+
# budget), budget alert emails are sent to the email recipients you specify
|
|
103
|
+
# in the
|
|
104
|
+
# [NotificationsRule](#notificationsrule).
|
|
105
|
+
#
|
|
106
|
+
# Threshold rules also affect the fields included in the
|
|
107
|
+
# [JSON data
|
|
108
|
+
# object](https://cloud.google.com/billing/docs/how-to/budgets-programmatic-notifications#notification_format)
|
|
109
|
+
# sent to a Pub/Sub topic.
|
|
110
|
+
#
|
|
111
|
+
# Threshold rules are _required_ if using email notifications.
|
|
112
|
+
#
|
|
113
|
+
# Threshold rules are _optional_ if only setting a
|
|
114
|
+
# [`pubsubTopic` NotificationsRule](#NotificationsRule),
|
|
115
|
+
# unless you want your JSON data object to include data about the thresholds
|
|
116
|
+
# you set.
|
|
117
|
+
#
|
|
118
|
+
# For more information, see
|
|
119
|
+
# [set budget threshold rules and
|
|
120
|
+
# actions](https://cloud.google.com/billing/docs/how-to/budgets#budget-actions).
|
|
106
121
|
# @!attribute [rw] threshold_percent
|
|
107
122
|
# @return [::Float]
|
|
108
123
|
# Required. Send an alert when this threshold is exceeded.
|
|
@@ -127,8 +142,7 @@ module Google
|
|
|
127
142
|
# Use forecasted spend for the period as the basis for comparison against
|
|
128
143
|
# the threshold.
|
|
129
144
|
# FORECASTED_SPEND can only be set when the budget's time period is a
|
|
130
|
-
# {::Google::Cloud::Billing::Budgets::V1beta1::Filter#calendar_period Filter.calendar_period}.
|
|
131
|
-
# It cannot be set in combination with
|
|
145
|
+
# {::Google::Cloud::Billing::Budgets::V1beta1::Filter#calendar_period Filter.calendar_period}. It cannot be set in combination with
|
|
132
146
|
# {::Google::Cloud::Billing::Budgets::V1beta1::Filter#custom_period Filter.custom_period}.
|
|
133
147
|
FORECASTED_SPEND = 2
|
|
134
148
|
end
|
|
@@ -138,10 +152,10 @@ module Google
|
|
|
138
152
|
# and thresholds.
|
|
139
153
|
# @!attribute [rw] pubsub_topic
|
|
140
154
|
# @return [::String]
|
|
141
|
-
# Optional. The name of the Pub/Sub topic where budget related messages will
|
|
142
|
-
#
|
|
143
|
-
#
|
|
144
|
-
# created before the budget is created; see
|
|
155
|
+
# Optional. The name of the Pub/Sub topic where budget related messages will be
|
|
156
|
+
# published, in the form `projects/{project_id}/topics/{topic_id}`. Updates
|
|
157
|
+
# are sent at regular intervals to the topic.
|
|
158
|
+
# The topic needs to be created before the budget is created; see
|
|
145
159
|
# https://cloud.google.com/billing/docs/how-to/budgets-programmatic-notifications
|
|
146
160
|
# for more details.
|
|
147
161
|
# Caller is expected to have
|
|
@@ -151,28 +165,25 @@ module Google
|
|
|
151
165
|
# for more details on Pub/Sub roles and permissions.
|
|
152
166
|
# @!attribute [rw] schema_version
|
|
153
167
|
# @return [::String]
|
|
154
|
-
# Optional. Required when
|
|
155
|
-
# {::Google::Cloud::Billing::Budgets::V1beta1::AllUpdatesRule#pubsub_topic AllUpdatesRule.pubsub_topic}
|
|
156
|
-
#
|
|
157
|
-
# {::Google::Cloud::Billing::Budgets::V1beta1::AllUpdatesRule#pubsub_topic AllUpdatesRule.pubsub_topic}.
|
|
158
|
-
# Only "1.0" is accepted. It represents the JSON schema as defined in
|
|
168
|
+
# Optional. Required when {::Google::Cloud::Billing::Budgets::V1beta1::AllUpdatesRule#pubsub_topic AllUpdatesRule.pubsub_topic} is set. The schema version of
|
|
169
|
+
# the notification sent to {::Google::Cloud::Billing::Budgets::V1beta1::AllUpdatesRule#pubsub_topic AllUpdatesRule.pubsub_topic}. Only "1.0" is
|
|
170
|
+
# accepted. It represents the JSON schema as defined in
|
|
159
171
|
# https://cloud.google.com/billing/docs/how-to/budgets-programmatic-notifications#notification_format.
|
|
160
172
|
# @!attribute [rw] monitoring_notification_channels
|
|
161
173
|
# @return [::Array<::String>]
|
|
162
|
-
# Optional. Targets to send notifications to when a threshold is exceeded.
|
|
163
|
-
#
|
|
164
|
-
#
|
|
165
|
-
#
|
|
174
|
+
# Optional. Targets to send notifications to when a threshold is exceeded. This is in
|
|
175
|
+
# addition to default recipients who have billing account IAM roles.
|
|
176
|
+
# The value is the full REST resource name of a monitoring notification
|
|
177
|
+
# channel with the form
|
|
166
178
|
# `projects/{project_id}/notificationChannels/{channel_id}`. A maximum of 5
|
|
167
179
|
# channels are allowed. See
|
|
168
180
|
# https://cloud.google.com/billing/docs/how-to/budgets-notification-recipients
|
|
169
181
|
# for more details.
|
|
170
182
|
# @!attribute [rw] disable_default_iam_recipients
|
|
171
183
|
# @return [::Boolean]
|
|
172
|
-
# Optional. When set to true, disables default notifications sent when a
|
|
173
|
-
#
|
|
174
|
-
#
|
|
175
|
-
# account.
|
|
184
|
+
# Optional. When set to true, disables default notifications sent when a threshold is
|
|
185
|
+
# exceeded. Default notifications are sent to those with Billing Account
|
|
186
|
+
# Administrator and Billing Account User IAM roles for the target account.
|
|
176
187
|
class AllUpdatesRule
|
|
177
188
|
include ::Google::Protobuf::MessageExts
|
|
178
189
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
@@ -188,16 +199,14 @@ module Google
|
|
|
188
199
|
# Only zero or one project can be specified currently.
|
|
189
200
|
# @!attribute [rw] credit_types
|
|
190
201
|
# @return [::Array<::String>]
|
|
191
|
-
# Optional. If
|
|
192
|
-
#
|
|
193
|
-
#
|
|
194
|
-
#
|
|
195
|
-
# calculations. See [a list of acceptable credit type
|
|
202
|
+
# Optional. If {::Google::Cloud::Billing::Budgets::V1beta1::Filter#credit_types_treatment Filter.credit_types_treatment} is INCLUDE_SPECIFIED_CREDITS, this is
|
|
203
|
+
# a list of credit types to be subtracted from gross cost to determine the
|
|
204
|
+
# spend for threshold calculations. See
|
|
205
|
+
# [a list of acceptable credit type
|
|
196
206
|
# values](https://cloud.google.com/billing/docs/how-to/export-data-bigquery-tables#credits-type).
|
|
197
207
|
#
|
|
198
|
-
# If
|
|
199
|
-
#
|
|
200
|
-
# is **not** INCLUDE_SPECIFIED_CREDITS, this field must be empty.
|
|
208
|
+
# If {::Google::Cloud::Billing::Budgets::V1beta1::Filter#credit_types_treatment Filter.credit_types_treatment} is **not** INCLUDE_SPECIFIED_CREDITS,
|
|
209
|
+
# this field must be empty.
|
|
201
210
|
# @!attribute [rw] credit_types_treatment
|
|
202
211
|
# @return [::Google::Cloud::Billing::Budgets::V1beta1::Filter::CreditTypesTreatment]
|
|
203
212
|
# Optional. If not set, default behavior is `INCLUDE_ALL_CREDITS`.
|
|
@@ -211,18 +220,23 @@ module Google
|
|
|
211
220
|
# https://cloud.google.com/billing/v1/how-tos/catalog-api.
|
|
212
221
|
# @!attribute [rw] subaccounts
|
|
213
222
|
# @return [::Array<::String>]
|
|
214
|
-
# Optional. A set of subaccounts of the form `billingAccounts/{account_id}`,
|
|
215
|
-
#
|
|
216
|
-
#
|
|
223
|
+
# Optional. A set of subaccounts of the form `billingAccounts/{account_id}`, specifying
|
|
224
|
+
# that usage from only this set of subaccounts should be included in the
|
|
225
|
+
# budget. If a subaccount is set to the name of the parent account,
|
|
217
226
|
# usage from the parent account will be included. If omitted, the
|
|
218
227
|
# report will include usage from the parent account and all
|
|
219
228
|
# subaccounts, if they exist.
|
|
220
229
|
# @!attribute [rw] labels
|
|
221
230
|
# @return [::Google::Protobuf::Map{::String => ::Google::Protobuf::ListValue}]
|
|
222
|
-
# Optional. A single label and value pair specifying that usage from only
|
|
223
|
-
#
|
|
224
|
-
#
|
|
225
|
-
#
|
|
231
|
+
# Optional. A single label and value pair specifying that usage from only this set of
|
|
232
|
+
# labeled resources should be included in the budget. If omitted, the
|
|
233
|
+
# report will include all labeled and unlabeled usage.
|
|
234
|
+
#
|
|
235
|
+
# An object containing a single `"key": value` pair. Example: `{ "name":
|
|
236
|
+
# "wrench" }`.
|
|
237
|
+
#
|
|
238
|
+
# _Currently, multiple entries or multiple values per entry are not
|
|
239
|
+
# allowed._
|
|
226
240
|
# @!attribute [rw] calendar_period
|
|
227
241
|
# @return [::Google::Cloud::Billing::Budgets::V1beta1::CalendarPeriod]
|
|
228
242
|
# Optional. Specifies to track usage for recurring calendar period.
|
|
@@ -233,8 +247,8 @@ module Google
|
|
|
233
247
|
# so on.
|
|
234
248
|
# @!attribute [rw] custom_period
|
|
235
249
|
# @return [::Google::Cloud::Billing::Budgets::V1beta1::CustomPeriod]
|
|
236
|
-
# Optional. Specifies to track usage from any start date (required) to any
|
|
237
|
-
#
|
|
250
|
+
# Optional. Specifies to track usage from any start date (required) to any end date
|
|
251
|
+
# (optional). This time period is static, it does not recur.
|
|
238
252
|
class Filter
|
|
239
253
|
include ::Google::Protobuf::MessageExts
|
|
240
254
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
@@ -278,9 +292,9 @@ module Google
|
|
|
278
292
|
# Required. The start date must be after January 1, 2017.
|
|
279
293
|
# @!attribute [rw] end_date
|
|
280
294
|
# @return [::Google::Type::Date]
|
|
281
|
-
# Optional. The end date of the time period. Budgets with elapsed end date
|
|
282
|
-
#
|
|
283
|
-
# the start_date.
|
|
295
|
+
# Optional. The end date of the time period. Budgets with elapsed end date won't be
|
|
296
|
+
# processed. If unset, specifies to track all usage
|
|
297
|
+
# incurred since the start_date.
|
|
284
298
|
class CustomPeriod
|
|
285
299
|
include ::Google::Protobuf::MessageExts
|
|
286
300
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
@@ -291,6 +305,8 @@ module Google
|
|
|
291
305
|
# `CalendarPeriod`". All calendar times begin at 12 AM US and Canadian
|
|
292
306
|
# Pacific Time (UTC-8).
|
|
293
307
|
module CalendarPeriod
|
|
308
|
+
# Calendar period is unset. This is the default if the budget is for a
|
|
309
|
+
# custom time period (CustomPeriod).
|
|
294
310
|
CALENDAR_PERIOD_UNSPECIFIED = 0
|
|
295
311
|
|
|
296
312
|
# A month. Month starts on the first day of each month, such as January 1,
|
metadata
CHANGED
|
@@ -1,14 +1,14 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: google-cloud-billing-budgets-v1beta1
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 0.6.
|
|
4
|
+
version: 0.6.5
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- Google LLC
|
|
8
8
|
autorequire:
|
|
9
9
|
bindir: bin
|
|
10
10
|
cert_chain: []
|
|
11
|
-
date: 2022-
|
|
11
|
+
date: 2022-02-16 00:00:00.000000000 Z
|
|
12
12
|
dependencies:
|
|
13
13
|
- !ruby/object:Gem::Dependency
|
|
14
14
|
name: gapic-common
|
|
@@ -208,7 +208,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
|
|
|
208
208
|
- !ruby/object:Gem::Version
|
|
209
209
|
version: '0'
|
|
210
210
|
requirements: []
|
|
211
|
-
rubygems_version: 3.3.
|
|
211
|
+
rubygems_version: 3.3.5
|
|
212
212
|
signing_key:
|
|
213
213
|
specification_version: 4
|
|
214
214
|
summary: API Client library for the Billing Budgets V1beta1 API
|