docs: update docs (#916)
* fix: re-run script
* test: fix noxfile
diff --git a/docs/dyn/billingbudgets_v1beta1.billingAccounts.budgets.html b/docs/dyn/billingbudgets_v1beta1.billingAccounts.budgets.html
index c6faf22..268c7af 100644
--- a/docs/dyn/billingbudgets_v1beta1.billingAccounts.budgets.html
+++ b/docs/dyn/billingbudgets_v1beta1.billingAccounts.budgets.html
@@ -111,6 +111,46 @@
# (for example, send an alert when 90% of the target spend is met).
# Currently all plans are monthly budgets so the usage period(s) tracked are
# implied (calendar months of usage back-to-back).
+ "name": "A String", # Output only. Resource name of the budget.
+ # The resource name implies the scope of a budget. Values are of the form
+ # `billingAccounts/{billingAccountId}/budgets/{budgetId}`.
+ "budgetFilter": { # A filter for a budget, limiting the scope of the cost to calculate. # Optional. Filters that define which resources are used to compute
+ # the actual spend against the budget.
+ "services": [ # Optional. A set of services of the form `services/{service_id}`,
+ # specifying that usage from only this set of services should be
+ # included in the budget. If omitted, the report will include usage for
+ # all the services.
+ # The service names are available through the Catalog API:
+ # https://cloud.google.com/billing/v1/how-tos/catalog-api.
+ "A String",
+ ],
+ "labels": { # Optional. A single label and value pair specifying that usage from only this set of
+ # labeled resources should be included in the budget. Multiple entries or
+ # multiple values per entry are not allowed. If omitted, the report will
+ # include all labeled and unlabeled usage.
+ "a_key": [
+ "",
+ ],
+ },
+ "projects": [ # Optional. A set of projects of the form `projects/{project}`,
+ # specifying that usage from only this set of projects should be
+ # included in the budget. If omitted, the report will include all usage for
+ # the billing account, regardless of which project the usage occurred on.
+ # Only zero or one project can be specified currently.
+ "A String",
+ ],
+ "subaccounts": [ # Optional. A set of subaccounts of the form `billingAccounts/{account_id}`, specifying
+ # that usage from only this set of subaccounts should be included in the
+ # budget. If a subaccount is set to the name of the master account, usage
+ # from the master account will be included. If omitted, the report will
+ # include usage from the master account and all subaccounts, if they exist.
+ "A String",
+ ],
+ "creditTypesTreatment": "A String", # Optional. If not set, default behavior is `INCLUDE_ALL_CREDITS`.
+ },
+ "etag": "A String", # Optional. Etag to validate that the object is unchanged for a
+ # read-modify-write operation.
+ # An empty etag will cause an update to overwrite other changes.
"amount": { # The budgeted amount for each usage period. # Required. Budgeted amount.
"lastPeriodAmount": { # Describes a budget amount targeted to last period's spend. # Use the last period's actual spend as the budget for the present period.
# At this time, the amount is automatically 100% of last period's spend;
@@ -122,9 +162,9 @@
# `currency_code` is optional. If specified, it must match the
# currency of the billing account. The `currency_code` is provided on
# output.
- "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
"units": "A String", # The whole units of the amount.
# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
+ "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
"nanos": 42, # Number of nano (10^-9) units of the amount.
# The value must be between -999,999,999 and +999,999,999 inclusive.
# If `units` is positive, `nanos` must be positive or zero.
@@ -133,16 +173,10 @@
# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
},
},
- "etag": "A String", # Optional. Etag to validate that the object is unchanged for a
- # read-modify-write operation.
- # An empty etag will cause an update to overwrite other changes.
"allUpdatesRule": { # AllUpdatesRule defines notifications that are sent on every update to the # Optional. Rules to apply to all updates to the actual spend, regardless
# of the thresholds set in `threshold_rules`.
# billing account's spend, regardless of the thresholds defined using
# threshold rules.
- "schemaVersion": "A String", # Required. The schema version of the notification.
- # Only "1.0" is accepted. It represents the JSON schema as defined in
- # https://cloud.google.com/billing/docs/how-to/budgets#notification_format
"pubsubTopic": "A String", # Required. The name of the Cloud Pub/Sub topic where budget related messages will be
# published, in the form `projects/{project_id}/topics/{topic_id}`. Updates
# are sent at regular intervals to the topic.
@@ -154,10 +188,12 @@
# budget, otherwise, the API call will fail with PERMISSION_DENIED. See
# https://cloud.google.com/pubsub/docs/access-control for more details on
# Pub/Sub roles and permissions.
+ "schemaVersion": "A String", # Required. The schema version of the notification.
+ # Only "1.0" is accepted. It represents the JSON schema as defined in
+ # https://cloud.google.com/billing/docs/how-to/budgets#notification_format
},
- "name": "A String", # Output only. Resource name of the budget.
- # The resource name implies the scope of a budget. Values are of the form
- # `billingAccounts/{billingAccountId}/budgets/{budgetId}`.
+ "displayName": "A String", # User data for display name in UI.
+ # Validation: <= 60 chars.
"thresholdRules": [ # Optional. Rules that trigger alerts (notifications of thresholds
# being crossed) when spend exceeds the specified percentages of the budget.
{ # ThresholdRule contains a definition of a threshold which triggers
@@ -167,34 +203,13 @@
# Administrator role or the Billing Account User role.
# The thresholds here have no effect on notifications sent to anything
# configured under `Budget.all_updates_rule`.
- "spendBasis": "A String", # Optional. The type of basis used to determine if spend has passed the
- # threshold. Behavior defaults to CURRENT_SPEND if not set.
"thresholdPercent": 3.14, # Required. Send an alert when this threshold is exceeded.
# This is a 1.0-based percentage, so 0.5 = 50%.
# Validation: non-negative number.
+ "spendBasis": "A String", # Optional. The type of basis used to determine if spend has passed the
+ # threshold. Behavior defaults to CURRENT_SPEND if not set.
},
],
- "budgetFilter": { # A filter for a budget, limiting the scope of the cost to calculate. # Optional. Filters that define which resources are used to compute
- # the actual spend against the budget.
- "services": [ # Optional. A set of services of the form `services/{service_id}`,
- # specifying that usage from only this set of services should be
- # included in the budget. If omitted, the report will include usage for
- # all the services.
- # The service names are available through the Catalog API:
- # https://cloud.google.com/billing/v1/how-tos/catalog-api.
- "A String",
- ],
- "creditTypesTreatment": "A String", # Optional. If not set, default behavior is `INCLUDE_ALL_CREDITS`.
- "projects": [ # Optional. A set of projects of the form `projects/{project}`,
- # specifying that usage from only this set of projects should be
- # included in the budget. If omitted, the report will include all usage for
- # the billing account, regardless of which project the usage occurred on.
- # Only zero or one project can be specified currently.
- "A String",
- ],
- },
- "displayName": "A String", # User data for display name in UI.
- # Validation: <= 60 chars.
},
}
@@ -211,6 +226,46 @@
# (for example, send an alert when 90% of the target spend is met).
# Currently all plans are monthly budgets so the usage period(s) tracked are
# implied (calendar months of usage back-to-back).
+ "name": "A String", # Output only. Resource name of the budget.
+ # The resource name implies the scope of a budget. Values are of the form
+ # `billingAccounts/{billingAccountId}/budgets/{budgetId}`.
+ "budgetFilter": { # A filter for a budget, limiting the scope of the cost to calculate. # Optional. Filters that define which resources are used to compute
+ # the actual spend against the budget.
+ "services": [ # Optional. A set of services of the form `services/{service_id}`,
+ # specifying that usage from only this set of services should be
+ # included in the budget. If omitted, the report will include usage for
+ # all the services.
+ # The service names are available through the Catalog API:
+ # https://cloud.google.com/billing/v1/how-tos/catalog-api.
+ "A String",
+ ],
+ "labels": { # Optional. A single label and value pair specifying that usage from only this set of
+ # labeled resources should be included in the budget. Multiple entries or
+ # multiple values per entry are not allowed. If omitted, the report will
+ # include all labeled and unlabeled usage.
+ "a_key": [
+ "",
+ ],
+ },
+ "projects": [ # Optional. A set of projects of the form `projects/{project}`,
+ # specifying that usage from only this set of projects should be
+ # included in the budget. If omitted, the report will include all usage for
+ # the billing account, regardless of which project the usage occurred on.
+ # Only zero or one project can be specified currently.
+ "A String",
+ ],
+ "subaccounts": [ # Optional. A set of subaccounts of the form `billingAccounts/{account_id}`, specifying
+ # that usage from only this set of subaccounts should be included in the
+ # budget. If a subaccount is set to the name of the master account, usage
+ # from the master account will be included. If omitted, the report will
+ # include usage from the master account and all subaccounts, if they exist.
+ "A String",
+ ],
+ "creditTypesTreatment": "A String", # Optional. If not set, default behavior is `INCLUDE_ALL_CREDITS`.
+ },
+ "etag": "A String", # Optional. Etag to validate that the object is unchanged for a
+ # read-modify-write operation.
+ # An empty etag will cause an update to overwrite other changes.
"amount": { # The budgeted amount for each usage period. # Required. Budgeted amount.
"lastPeriodAmount": { # Describes a budget amount targeted to last period's spend. # Use the last period's actual spend as the budget for the present period.
# At this time, the amount is automatically 100% of last period's spend;
@@ -222,9 +277,9 @@
# `currency_code` is optional. If specified, it must match the
# currency of the billing account. The `currency_code` is provided on
# output.
- "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
"units": "A String", # The whole units of the amount.
# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
+ "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
"nanos": 42, # Number of nano (10^-9) units of the amount.
# The value must be between -999,999,999 and +999,999,999 inclusive.
# If `units` is positive, `nanos` must be positive or zero.
@@ -233,16 +288,10 @@
# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
},
},
- "etag": "A String", # Optional. Etag to validate that the object is unchanged for a
- # read-modify-write operation.
- # An empty etag will cause an update to overwrite other changes.
"allUpdatesRule": { # AllUpdatesRule defines notifications that are sent on every update to the # Optional. Rules to apply to all updates to the actual spend, regardless
# of the thresholds set in `threshold_rules`.
# billing account's spend, regardless of the thresholds defined using
# threshold rules.
- "schemaVersion": "A String", # Required. The schema version of the notification.
- # Only "1.0" is accepted. It represents the JSON schema as defined in
- # https://cloud.google.com/billing/docs/how-to/budgets#notification_format
"pubsubTopic": "A String", # Required. The name of the Cloud Pub/Sub topic where budget related messages will be
# published, in the form `projects/{project_id}/topics/{topic_id}`. Updates
# are sent at regular intervals to the topic.
@@ -254,10 +303,12 @@
# budget, otherwise, the API call will fail with PERMISSION_DENIED. See
# https://cloud.google.com/pubsub/docs/access-control for more details on
# Pub/Sub roles and permissions.
+ "schemaVersion": "A String", # Required. The schema version of the notification.
+ # Only "1.0" is accepted. It represents the JSON schema as defined in
+ # https://cloud.google.com/billing/docs/how-to/budgets#notification_format
},
- "name": "A String", # Output only. Resource name of the budget.
- # The resource name implies the scope of a budget. Values are of the form
- # `billingAccounts/{billingAccountId}/budgets/{budgetId}`.
+ "displayName": "A String", # User data for display name in UI.
+ # Validation: <= 60 chars.
"thresholdRules": [ # Optional. Rules that trigger alerts (notifications of thresholds
# being crossed) when spend exceeds the specified percentages of the budget.
{ # ThresholdRule contains a definition of a threshold which triggers
@@ -267,34 +318,13 @@
# Administrator role or the Billing Account User role.
# The thresholds here have no effect on notifications sent to anything
# configured under `Budget.all_updates_rule`.
- "spendBasis": "A String", # Optional. The type of basis used to determine if spend has passed the
- # threshold. Behavior defaults to CURRENT_SPEND if not set.
"thresholdPercent": 3.14, # Required. Send an alert when this threshold is exceeded.
# This is a 1.0-based percentage, so 0.5 = 50%.
# Validation: non-negative number.
+ "spendBasis": "A String", # Optional. The type of basis used to determine if spend has passed the
+ # threshold. Behavior defaults to CURRENT_SPEND if not set.
},
],
- "budgetFilter": { # A filter for a budget, limiting the scope of the cost to calculate. # Optional. Filters that define which resources are used to compute
- # the actual spend against the budget.
- "services": [ # Optional. A set of services of the form `services/{service_id}`,
- # specifying that usage from only this set of services should be
- # included in the budget. If omitted, the report will include usage for
- # all the services.
- # The service names are available through the Catalog API:
- # https://cloud.google.com/billing/v1/how-tos/catalog-api.
- "A String",
- ],
- "creditTypesTreatment": "A String", # Optional. If not set, default behavior is `INCLUDE_ALL_CREDITS`.
- "projects": [ # Optional. A set of projects of the form `projects/{project}`,
- # specifying that usage from only this set of projects should be
- # included in the budget. If omitted, the report will include all usage for
- # the billing account, regardless of which project the usage occurred on.
- # Only zero or one project can be specified currently.
- "A String",
- ],
- },
- "displayName": "A String", # User data for display name in UI.
- # Validation: <= 60 chars.
}</pre>
</div>
@@ -350,6 +380,46 @@
# (for example, send an alert when 90% of the target spend is met).
# Currently all plans are monthly budgets so the usage period(s) tracked are
# implied (calendar months of usage back-to-back).
+ "name": "A String", # Output only. Resource name of the budget.
+ # The resource name implies the scope of a budget. Values are of the form
+ # `billingAccounts/{billingAccountId}/budgets/{budgetId}`.
+ "budgetFilter": { # A filter for a budget, limiting the scope of the cost to calculate. # Optional. Filters that define which resources are used to compute
+ # the actual spend against the budget.
+ "services": [ # Optional. A set of services of the form `services/{service_id}`,
+ # specifying that usage from only this set of services should be
+ # included in the budget. If omitted, the report will include usage for
+ # all the services.
+ # The service names are available through the Catalog API:
+ # https://cloud.google.com/billing/v1/how-tos/catalog-api.
+ "A String",
+ ],
+ "labels": { # Optional. A single label and value pair specifying that usage from only this set of
+ # labeled resources should be included in the budget. Multiple entries or
+ # multiple values per entry are not allowed. If omitted, the report will
+ # include all labeled and unlabeled usage.
+ "a_key": [
+ "",
+ ],
+ },
+ "projects": [ # Optional. A set of projects of the form `projects/{project}`,
+ # specifying that usage from only this set of projects should be
+ # included in the budget. If omitted, the report will include all usage for
+ # the billing account, regardless of which project the usage occurred on.
+ # Only zero or one project can be specified currently.
+ "A String",
+ ],
+ "subaccounts": [ # Optional. A set of subaccounts of the form `billingAccounts/{account_id}`, specifying
+ # that usage from only this set of subaccounts should be included in the
+ # budget. If a subaccount is set to the name of the master account, usage
+ # from the master account will be included. If omitted, the report will
+ # include usage from the master account and all subaccounts, if they exist.
+ "A String",
+ ],
+ "creditTypesTreatment": "A String", # Optional. If not set, default behavior is `INCLUDE_ALL_CREDITS`.
+ },
+ "etag": "A String", # Optional. Etag to validate that the object is unchanged for a
+ # read-modify-write operation.
+ # An empty etag will cause an update to overwrite other changes.
"amount": { # The budgeted amount for each usage period. # Required. Budgeted amount.
"lastPeriodAmount": { # Describes a budget amount targeted to last period's spend. # Use the last period's actual spend as the budget for the present period.
# At this time, the amount is automatically 100% of last period's spend;
@@ -361,9 +431,9 @@
# `currency_code` is optional. If specified, it must match the
# currency of the billing account. The `currency_code` is provided on
# output.
- "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
"units": "A String", # The whole units of the amount.
# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
+ "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
"nanos": 42, # Number of nano (10^-9) units of the amount.
# The value must be between -999,999,999 and +999,999,999 inclusive.
# If `units` is positive, `nanos` must be positive or zero.
@@ -372,16 +442,10 @@
# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
},
},
- "etag": "A String", # Optional. Etag to validate that the object is unchanged for a
- # read-modify-write operation.
- # An empty etag will cause an update to overwrite other changes.
"allUpdatesRule": { # AllUpdatesRule defines notifications that are sent on every update to the # Optional. Rules to apply to all updates to the actual spend, regardless
# of the thresholds set in `threshold_rules`.
# billing account's spend, regardless of the thresholds defined using
# threshold rules.
- "schemaVersion": "A String", # Required. The schema version of the notification.
- # Only "1.0" is accepted. It represents the JSON schema as defined in
- # https://cloud.google.com/billing/docs/how-to/budgets#notification_format
"pubsubTopic": "A String", # Required. The name of the Cloud Pub/Sub topic where budget related messages will be
# published, in the form `projects/{project_id}/topics/{topic_id}`. Updates
# are sent at regular intervals to the topic.
@@ -393,10 +457,12 @@
# budget, otherwise, the API call will fail with PERMISSION_DENIED. See
# https://cloud.google.com/pubsub/docs/access-control for more details on
# Pub/Sub roles and permissions.
+ "schemaVersion": "A String", # Required. The schema version of the notification.
+ # Only "1.0" is accepted. It represents the JSON schema as defined in
+ # https://cloud.google.com/billing/docs/how-to/budgets#notification_format
},
- "name": "A String", # Output only. Resource name of the budget.
- # The resource name implies the scope of a budget. Values are of the form
- # `billingAccounts/{billingAccountId}/budgets/{budgetId}`.
+ "displayName": "A String", # User data for display name in UI.
+ # Validation: <= 60 chars.
"thresholdRules": [ # Optional. Rules that trigger alerts (notifications of thresholds
# being crossed) when spend exceeds the specified percentages of the budget.
{ # ThresholdRule contains a definition of a threshold which triggers
@@ -406,34 +472,13 @@
# Administrator role or the Billing Account User role.
# The thresholds here have no effect on notifications sent to anything
# configured under `Budget.all_updates_rule`.
- "spendBasis": "A String", # Optional. The type of basis used to determine if spend has passed the
- # threshold. Behavior defaults to CURRENT_SPEND if not set.
"thresholdPercent": 3.14, # Required. Send an alert when this threshold is exceeded.
# This is a 1.0-based percentage, so 0.5 = 50%.
# Validation: non-negative number.
+ "spendBasis": "A String", # Optional. The type of basis used to determine if spend has passed the
+ # threshold. Behavior defaults to CURRENT_SPEND if not set.
},
],
- "budgetFilter": { # A filter for a budget, limiting the scope of the cost to calculate. # Optional. Filters that define which resources are used to compute
- # the actual spend against the budget.
- "services": [ # Optional. A set of services of the form `services/{service_id}`,
- # specifying that usage from only this set of services should be
- # included in the budget. If omitted, the report will include usage for
- # all the services.
- # The service names are available through the Catalog API:
- # https://cloud.google.com/billing/v1/how-tos/catalog-api.
- "A String",
- ],
- "creditTypesTreatment": "A String", # Optional. If not set, default behavior is `INCLUDE_ALL_CREDITS`.
- "projects": [ # Optional. A set of projects of the form `projects/{project}`,
- # specifying that usage from only this set of projects should be
- # included in the budget. If omitted, the report will include all usage for
- # the billing account, regardless of which project the usage occurred on.
- # Only zero or one project can be specified currently.
- "A String",
- ],
- },
- "displayName": "A String", # User data for display name in UI.
- # Validation: <= 60 chars.
}</pre>
</div>
@@ -471,6 +516,46 @@
# (for example, send an alert when 90% of the target spend is met).
# Currently all plans are monthly budgets so the usage period(s) tracked are
# implied (calendar months of usage back-to-back).
+ "name": "A String", # Output only. Resource name of the budget.
+ # The resource name implies the scope of a budget. Values are of the form
+ # `billingAccounts/{billingAccountId}/budgets/{budgetId}`.
+ "budgetFilter": { # A filter for a budget, limiting the scope of the cost to calculate. # Optional. Filters that define which resources are used to compute
+ # the actual spend against the budget.
+ "services": [ # Optional. A set of services of the form `services/{service_id}`,
+ # specifying that usage from only this set of services should be
+ # included in the budget. If omitted, the report will include usage for
+ # all the services.
+ # The service names are available through the Catalog API:
+ # https://cloud.google.com/billing/v1/how-tos/catalog-api.
+ "A String",
+ ],
+ "labels": { # Optional. A single label and value pair specifying that usage from only this set of
+ # labeled resources should be included in the budget. Multiple entries or
+ # multiple values per entry are not allowed. If omitted, the report will
+ # include all labeled and unlabeled usage.
+ "a_key": [
+ "",
+ ],
+ },
+ "projects": [ # Optional. A set of projects of the form `projects/{project}`,
+ # specifying that usage from only this set of projects should be
+ # included in the budget. If omitted, the report will include all usage for
+ # the billing account, regardless of which project the usage occurred on.
+ # Only zero or one project can be specified currently.
+ "A String",
+ ],
+ "subaccounts": [ # Optional. A set of subaccounts of the form `billingAccounts/{account_id}`, specifying
+ # that usage from only this set of subaccounts should be included in the
+ # budget. If a subaccount is set to the name of the master account, usage
+ # from the master account will be included. If omitted, the report will
+ # include usage from the master account and all subaccounts, if they exist.
+ "A String",
+ ],
+ "creditTypesTreatment": "A String", # Optional. If not set, default behavior is `INCLUDE_ALL_CREDITS`.
+ },
+ "etag": "A String", # Optional. Etag to validate that the object is unchanged for a
+ # read-modify-write operation.
+ # An empty etag will cause an update to overwrite other changes.
"amount": { # The budgeted amount for each usage period. # Required. Budgeted amount.
"lastPeriodAmount": { # Describes a budget amount targeted to last period's spend. # Use the last period's actual spend as the budget for the present period.
# At this time, the amount is automatically 100% of last period's spend;
@@ -482,9 +567,9 @@
# `currency_code` is optional. If specified, it must match the
# currency of the billing account. The `currency_code` is provided on
# output.
- "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
"units": "A String", # The whole units of the amount.
# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
+ "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
"nanos": 42, # Number of nano (10^-9) units of the amount.
# The value must be between -999,999,999 and +999,999,999 inclusive.
# If `units` is positive, `nanos` must be positive or zero.
@@ -493,16 +578,10 @@
# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
},
},
- "etag": "A String", # Optional. Etag to validate that the object is unchanged for a
- # read-modify-write operation.
- # An empty etag will cause an update to overwrite other changes.
"allUpdatesRule": { # AllUpdatesRule defines notifications that are sent on every update to the # Optional. Rules to apply to all updates to the actual spend, regardless
# of the thresholds set in `threshold_rules`.
# billing account's spend, regardless of the thresholds defined using
# threshold rules.
- "schemaVersion": "A String", # Required. The schema version of the notification.
- # Only "1.0" is accepted. It represents the JSON schema as defined in
- # https://cloud.google.com/billing/docs/how-to/budgets#notification_format
"pubsubTopic": "A String", # Required. The name of the Cloud Pub/Sub topic where budget related messages will be
# published, in the form `projects/{project_id}/topics/{topic_id}`. Updates
# are sent at regular intervals to the topic.
@@ -514,10 +593,12 @@
# budget, otherwise, the API call will fail with PERMISSION_DENIED. See
# https://cloud.google.com/pubsub/docs/access-control for more details on
# Pub/Sub roles and permissions.
+ "schemaVersion": "A String", # Required. The schema version of the notification.
+ # Only "1.0" is accepted. It represents the JSON schema as defined in
+ # https://cloud.google.com/billing/docs/how-to/budgets#notification_format
},
- "name": "A String", # Output only. Resource name of the budget.
- # The resource name implies the scope of a budget. Values are of the form
- # `billingAccounts/{billingAccountId}/budgets/{budgetId}`.
+ "displayName": "A String", # User data for display name in UI.
+ # Validation: <= 60 chars.
"thresholdRules": [ # Optional. Rules that trigger alerts (notifications of thresholds
# being crossed) when spend exceeds the specified percentages of the budget.
{ # ThresholdRule contains a definition of a threshold which triggers
@@ -527,34 +608,13 @@
# Administrator role or the Billing Account User role.
# The thresholds here have no effect on notifications sent to anything
# configured under `Budget.all_updates_rule`.
- "spendBasis": "A String", # Optional. The type of basis used to determine if spend has passed the
- # threshold. Behavior defaults to CURRENT_SPEND if not set.
"thresholdPercent": 3.14, # Required. Send an alert when this threshold is exceeded.
# This is a 1.0-based percentage, so 0.5 = 50%.
# Validation: non-negative number.
+ "spendBasis": "A String", # Optional. The type of basis used to determine if spend has passed the
+ # threshold. Behavior defaults to CURRENT_SPEND if not set.
},
],
- "budgetFilter": { # A filter for a budget, limiting the scope of the cost to calculate. # Optional. Filters that define which resources are used to compute
- # the actual spend against the budget.
- "services": [ # Optional. A set of services of the form `services/{service_id}`,
- # specifying that usage from only this set of services should be
- # included in the budget. If omitted, the report will include usage for
- # all the services.
- # The service names are available through the Catalog API:
- # https://cloud.google.com/billing/v1/how-tos/catalog-api.
- "A String",
- ],
- "creditTypesTreatment": "A String", # Optional. If not set, default behavior is `INCLUDE_ALL_CREDITS`.
- "projects": [ # Optional. A set of projects of the form `projects/{project}`,
- # specifying that usage from only this set of projects should be
- # included in the budget. If omitted, the report will include all usage for
- # the billing account, regardless of which project the usage occurred on.
- # Only zero or one project can be specified currently.
- "A String",
- ],
- },
- "displayName": "A String", # User data for display name in UI.
- # Validation: <= 60 chars.
},
],
}</pre>
@@ -596,6 +656,46 @@
# (for example, send an alert when 90% of the target spend is met).
# Currently all plans are monthly budgets so the usage period(s) tracked are
# implied (calendar months of usage back-to-back).
+ "name": "A String", # Output only. Resource name of the budget.
+ # The resource name implies the scope of a budget. Values are of the form
+ # `billingAccounts/{billingAccountId}/budgets/{budgetId}`.
+ "budgetFilter": { # A filter for a budget, limiting the scope of the cost to calculate. # Optional. Filters that define which resources are used to compute
+ # the actual spend against the budget.
+ "services": [ # Optional. A set of services of the form `services/{service_id}`,
+ # specifying that usage from only this set of services should be
+ # included in the budget. If omitted, the report will include usage for
+ # all the services.
+ # The service names are available through the Catalog API:
+ # https://cloud.google.com/billing/v1/how-tos/catalog-api.
+ "A String",
+ ],
+ "labels": { # Optional. A single label and value pair specifying that usage from only this set of
+ # labeled resources should be included in the budget. Multiple entries or
+ # multiple values per entry are not allowed. If omitted, the report will
+ # include all labeled and unlabeled usage.
+ "a_key": [
+ "",
+ ],
+ },
+ "projects": [ # Optional. A set of projects of the form `projects/{project}`,
+ # specifying that usage from only this set of projects should be
+ # included in the budget. If omitted, the report will include all usage for
+ # the billing account, regardless of which project the usage occurred on.
+ # Only zero or one project can be specified currently.
+ "A String",
+ ],
+ "subaccounts": [ # Optional. A set of subaccounts of the form `billingAccounts/{account_id}`, specifying
+ # that usage from only this set of subaccounts should be included in the
+ # budget. If a subaccount is set to the name of the master account, usage
+ # from the master account will be included. If omitted, the report will
+ # include usage from the master account and all subaccounts, if they exist.
+ "A String",
+ ],
+ "creditTypesTreatment": "A String", # Optional. If not set, default behavior is `INCLUDE_ALL_CREDITS`.
+ },
+ "etag": "A String", # Optional. Etag to validate that the object is unchanged for a
+ # read-modify-write operation.
+ # An empty etag will cause an update to overwrite other changes.
"amount": { # The budgeted amount for each usage period. # Required. Budgeted amount.
"lastPeriodAmount": { # Describes a budget amount targeted to last period's spend. # Use the last period's actual spend as the budget for the present period.
# At this time, the amount is automatically 100% of last period's spend;
@@ -607,9 +707,9 @@
# `currency_code` is optional. If specified, it must match the
# currency of the billing account. The `currency_code` is provided on
# output.
- "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
"units": "A String", # The whole units of the amount.
# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
+ "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
"nanos": 42, # Number of nano (10^-9) units of the amount.
# The value must be between -999,999,999 and +999,999,999 inclusive.
# If `units` is positive, `nanos` must be positive or zero.
@@ -618,16 +718,10 @@
# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
},
},
- "etag": "A String", # Optional. Etag to validate that the object is unchanged for a
- # read-modify-write operation.
- # An empty etag will cause an update to overwrite other changes.
"allUpdatesRule": { # AllUpdatesRule defines notifications that are sent on every update to the # Optional. Rules to apply to all updates to the actual spend, regardless
# of the thresholds set in `threshold_rules`.
# billing account's spend, regardless of the thresholds defined using
# threshold rules.
- "schemaVersion": "A String", # Required. The schema version of the notification.
- # Only "1.0" is accepted. It represents the JSON schema as defined in
- # https://cloud.google.com/billing/docs/how-to/budgets#notification_format
"pubsubTopic": "A String", # Required. The name of the Cloud Pub/Sub topic where budget related messages will be
# published, in the form `projects/{project_id}/topics/{topic_id}`. Updates
# are sent at regular intervals to the topic.
@@ -639,10 +733,12 @@
# budget, otherwise, the API call will fail with PERMISSION_DENIED. See
# https://cloud.google.com/pubsub/docs/access-control for more details on
# Pub/Sub roles and permissions.
+ "schemaVersion": "A String", # Required. The schema version of the notification.
+ # Only "1.0" is accepted. It represents the JSON schema as defined in
+ # https://cloud.google.com/billing/docs/how-to/budgets#notification_format
},
- "name": "A String", # Output only. Resource name of the budget.
- # The resource name implies the scope of a budget. Values are of the form
- # `billingAccounts/{billingAccountId}/budgets/{budgetId}`.
+ "displayName": "A String", # User data for display name in UI.
+ # Validation: <= 60 chars.
"thresholdRules": [ # Optional. Rules that trigger alerts (notifications of thresholds
# being crossed) when spend exceeds the specified percentages of the budget.
{ # ThresholdRule contains a definition of a threshold which triggers
@@ -652,34 +748,13 @@
# Administrator role or the Billing Account User role.
# The thresholds here have no effect on notifications sent to anything
# configured under `Budget.all_updates_rule`.
- "spendBasis": "A String", # Optional. The type of basis used to determine if spend has passed the
- # threshold. Behavior defaults to CURRENT_SPEND if not set.
"thresholdPercent": 3.14, # Required. Send an alert when this threshold is exceeded.
# This is a 1.0-based percentage, so 0.5 = 50%.
# Validation: non-negative number.
+ "spendBasis": "A String", # Optional. The type of basis used to determine if spend has passed the
+ # threshold. Behavior defaults to CURRENT_SPEND if not set.
},
],
- "budgetFilter": { # A filter for a budget, limiting the scope of the cost to calculate. # Optional. Filters that define which resources are used to compute
- # the actual spend against the budget.
- "services": [ # Optional. A set of services of the form `services/{service_id}`,
- # specifying that usage from only this set of services should be
- # included in the budget. If omitted, the report will include usage for
- # all the services.
- # The service names are available through the Catalog API:
- # https://cloud.google.com/billing/v1/how-tos/catalog-api.
- "A String",
- ],
- "creditTypesTreatment": "A String", # Optional. If not set, default behavior is `INCLUDE_ALL_CREDITS`.
- "projects": [ # Optional. A set of projects of the form `projects/{project}`,
- # specifying that usage from only this set of projects should be
- # included in the budget. If omitted, the report will include all usage for
- # the billing account, regardless of which project the usage occurred on.
- # Only zero or one project can be specified currently.
- "A String",
- ],
- },
- "displayName": "A String", # User data for display name in UI.
- # Validation: <= 60 chars.
},
"updateMask": "A String", # Optional. Indicates which fields in the provided budget to update.
# Read-only fields (such as `name`) cannot be changed. If this is not
@@ -702,6 +777,46 @@
# (for example, send an alert when 90% of the target spend is met).
# Currently all plans are monthly budgets so the usage period(s) tracked are
# implied (calendar months of usage back-to-back).
+ "name": "A String", # Output only. Resource name of the budget.
+ # The resource name implies the scope of a budget. Values are of the form
+ # `billingAccounts/{billingAccountId}/budgets/{budgetId}`.
+ "budgetFilter": { # A filter for a budget, limiting the scope of the cost to calculate. # Optional. Filters that define which resources are used to compute
+ # the actual spend against the budget.
+ "services": [ # Optional. A set of services of the form `services/{service_id}`,
+ # specifying that usage from only this set of services should be
+ # included in the budget. If omitted, the report will include usage for
+ # all the services.
+ # The service names are available through the Catalog API:
+ # https://cloud.google.com/billing/v1/how-tos/catalog-api.
+ "A String",
+ ],
+ "labels": { # Optional. A single label and value pair specifying that usage from only this set of
+ # labeled resources should be included in the budget. Multiple entries or
+ # multiple values per entry are not allowed. If omitted, the report will
+ # include all labeled and unlabeled usage.
+ "a_key": [
+ "",
+ ],
+ },
+ "projects": [ # Optional. A set of projects of the form `projects/{project}`,
+ # specifying that usage from only this set of projects should be
+ # included in the budget. If omitted, the report will include all usage for
+ # the billing account, regardless of which project the usage occurred on.
+ # Only zero or one project can be specified currently.
+ "A String",
+ ],
+ "subaccounts": [ # Optional. A set of subaccounts of the form `billingAccounts/{account_id}`, specifying
+ # that usage from only this set of subaccounts should be included in the
+ # budget. If a subaccount is set to the name of the master account, usage
+ # from the master account will be included. If omitted, the report will
+ # include usage from the master account and all subaccounts, if they exist.
+ "A String",
+ ],
+ "creditTypesTreatment": "A String", # Optional. If not set, default behavior is `INCLUDE_ALL_CREDITS`.
+ },
+ "etag": "A String", # Optional. Etag to validate that the object is unchanged for a
+ # read-modify-write operation.
+ # An empty etag will cause an update to overwrite other changes.
"amount": { # The budgeted amount for each usage period. # Required. Budgeted amount.
"lastPeriodAmount": { # Describes a budget amount targeted to last period's spend. # Use the last period's actual spend as the budget for the present period.
# At this time, the amount is automatically 100% of last period's spend;
@@ -713,9 +828,9 @@
# `currency_code` is optional. If specified, it must match the
# currency of the billing account. The `currency_code` is provided on
# output.
- "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
"units": "A String", # The whole units of the amount.
# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
+ "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
"nanos": 42, # Number of nano (10^-9) units of the amount.
# The value must be between -999,999,999 and +999,999,999 inclusive.
# If `units` is positive, `nanos` must be positive or zero.
@@ -724,16 +839,10 @@
# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
},
},
- "etag": "A String", # Optional. Etag to validate that the object is unchanged for a
- # read-modify-write operation.
- # An empty etag will cause an update to overwrite other changes.
"allUpdatesRule": { # AllUpdatesRule defines notifications that are sent on every update to the # Optional. Rules to apply to all updates to the actual spend, regardless
# of the thresholds set in `threshold_rules`.
# billing account's spend, regardless of the thresholds defined using
# threshold rules.
- "schemaVersion": "A String", # Required. The schema version of the notification.
- # Only "1.0" is accepted. It represents the JSON schema as defined in
- # https://cloud.google.com/billing/docs/how-to/budgets#notification_format
"pubsubTopic": "A String", # Required. The name of the Cloud Pub/Sub topic where budget related messages will be
# published, in the form `projects/{project_id}/topics/{topic_id}`. Updates
# are sent at regular intervals to the topic.
@@ -745,10 +854,12 @@
# budget, otherwise, the API call will fail with PERMISSION_DENIED. See
# https://cloud.google.com/pubsub/docs/access-control for more details on
# Pub/Sub roles and permissions.
+ "schemaVersion": "A String", # Required. The schema version of the notification.
+ # Only "1.0" is accepted. It represents the JSON schema as defined in
+ # https://cloud.google.com/billing/docs/how-to/budgets#notification_format
},
- "name": "A String", # Output only. Resource name of the budget.
- # The resource name implies the scope of a budget. Values are of the form
- # `billingAccounts/{billingAccountId}/budgets/{budgetId}`.
+ "displayName": "A String", # User data for display name in UI.
+ # Validation: <= 60 chars.
"thresholdRules": [ # Optional. Rules that trigger alerts (notifications of thresholds
# being crossed) when spend exceeds the specified percentages of the budget.
{ # ThresholdRule contains a definition of a threshold which triggers
@@ -758,34 +869,13 @@
# Administrator role or the Billing Account User role.
# The thresholds here have no effect on notifications sent to anything
# configured under `Budget.all_updates_rule`.
- "spendBasis": "A String", # Optional. The type of basis used to determine if spend has passed the
- # threshold. Behavior defaults to CURRENT_SPEND if not set.
"thresholdPercent": 3.14, # Required. Send an alert when this threshold is exceeded.
# This is a 1.0-based percentage, so 0.5 = 50%.
# Validation: non-negative number.
+ "spendBasis": "A String", # Optional. The type of basis used to determine if spend has passed the
+ # threshold. Behavior defaults to CURRENT_SPEND if not set.
},
],
- "budgetFilter": { # A filter for a budget, limiting the scope of the cost to calculate. # Optional. Filters that define which resources are used to compute
- # the actual spend against the budget.
- "services": [ # Optional. A set of services of the form `services/{service_id}`,
- # specifying that usage from only this set of services should be
- # included in the budget. If omitted, the report will include usage for
- # all the services.
- # The service names are available through the Catalog API:
- # https://cloud.google.com/billing/v1/how-tos/catalog-api.
- "A String",
- ],
- "creditTypesTreatment": "A String", # Optional. If not set, default behavior is `INCLUDE_ALL_CREDITS`.
- "projects": [ # Optional. A set of projects of the form `projects/{project}`,
- # specifying that usage from only this set of projects should be
- # included in the budget. If omitted, the report will include all usage for
- # the billing account, regardless of which project the usage occurred on.
- # Only zero or one project can be specified currently.
- "A String",
- ],
- },
- "displayName": "A String", # User data for display name in UI.
- # Validation: <= 60 chars.
}</pre>
</div>