proto_docs/google/cloud/billing/budgets/v1beta1/budget_model.rb in google-cloud-billing-budgets-v1beta1-0.7.0 vs proto_docs/google/cloud/billing/budgets/v1beta1/budget_model.rb in google-cloud-billing-budgets-v1beta1-0.8.0

- old
+ new

@@ -36,13 +36,13 @@ # @return [::String] # User data for display name in UI. # Validation: <= 60 chars. # @!attribute [rw] budget_filter # @return [::Google::Cloud::Billing::Budgets::V1beta1::Filter] - # Optional. Filters that define which resources are used to compute the actual spend - # against the budget amount, such as projects, services, and the budget's - # time period, as well as other filters. + # Optional. Filters that define which resources are used to compute the + # actual spend against the budget amount, such as projects, services, and the + # budget's time period, as well as other filters. # @!attribute [rw] amount # @return [::Google::Cloud::Billing::Budgets::V1beta1::BudgetAmount] # Required. Budgeted amount. # @!attribute [rw] threshold_rules # @return [::Array<::Google::Cloud::Billing::Budgets::V1beta1::ThresholdRule>] @@ -52,11 +52,12 @@ # Optional for `pubsubTopic` notifications. # # Required if using email notifications. # @!attribute [rw] all_updates_rule # @return [::Google::Cloud::Billing::Budgets::V1beta1::AllUpdatesRule] - # Optional. Rules to apply to notifications sent based on budget spend and thresholds. + # Optional. Rules to apply to notifications sent based on budget spend and + # thresholds. # @!attribute [rw] etag # @return [::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. @@ -75,24 +76,27 @@ # The `currency_code` is provided on output. # @!attribute [rw] last_period_amount # @return [::Google::Cloud::Billing::Budgets::V1beta1::LastPeriodAmount] # Use the last period's actual spend as the budget for the present period. # LastPeriodAmount can only be set when the budget's time period is a - # {::Google::Cloud::Billing::Budgets::V1beta1::Filter#calendar_period Filter.calendar_period}. It cannot be set in combination with + # {::Google::Cloud::Billing::Budgets::V1beta1::Filter#calendar_period Filter.calendar_period}. + # It cannot be set in combination with # {::Google::Cloud::Billing::Budgets::V1beta1::Filter#custom_period Filter.custom_period}. class BudgetAmount include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end - # Describes a budget amount targeted to the last {::Google::Cloud::Billing::Budgets::V1beta1::Filter#calendar_period Filter.calendar_period} + # Describes a budget amount targeted to the last + # {::Google::Cloud::Billing::Budgets::V1beta1::Filter#calendar_period Filter.calendar_period} # spend. At this time, the amount is automatically 100% of the last calendar # period's spend; that is, there are no other options yet. # Future configuration options will be described here (for example, configuring # a percentage of last period's spend). # LastPeriodAmount cannot be set for a budget configured with - # a {::Google::Cloud::Billing::Budgets::V1beta1::Filter#custom_period Filter.custom_period}. + # a + # {::Google::Cloud::Billing::Budgets::V1beta1::Filter#custom_period Filter.custom_period}. class LastPeriodAmount include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end @@ -140,52 +144,56 @@ CURRENT_SPEND = 1 # Use forecasted spend for the period as the basis for comparison against # the threshold. # FORECASTED_SPEND can only be set when the budget's time period is a - # {::Google::Cloud::Billing::Budgets::V1beta1::Filter#calendar_period Filter.calendar_period}. It cannot be set in combination with + # {::Google::Cloud::Billing::Budgets::V1beta1::Filter#calendar_period Filter.calendar_period}. + # It cannot be set in combination with # {::Google::Cloud::Billing::Budgets::V1beta1::Filter#custom_period Filter.custom_period}. FORECASTED_SPEND = 2 end end # AllUpdatesRule defines notifications that are sent based on budget spend # and thresholds. # @!attribute [rw] pubsub_topic # @return [::String] - # Optional. The name of the 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. - # The topic needs to be created before the budget is created; see + # Optional. The name of the 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. The topic needs to be + # created before the budget is created; see # https://cloud.google.com/billing/docs/how-to/budgets-programmatic-notifications # for more details. # Caller is expected to have # `pubsub.topics.setIamPolicy` permission on the topic when it's set for a # budget, otherwise, the API call will fail with PERMISSION_DENIED. See # https://cloud.google.com/billing/docs/how-to/budgets-programmatic-notifications#permissions_required_for_this_task # for more details on Pub/Sub roles and permissions. # @!attribute [rw] schema_version # @return [::String] - # Optional. Required when {::Google::Cloud::Billing::Budgets::V1beta1::AllUpdatesRule#pubsub_topic AllUpdatesRule.pubsub_topic} is set. The schema version of - # the notification sent to {::Google::Cloud::Billing::Budgets::V1beta1::AllUpdatesRule#pubsub_topic AllUpdatesRule.pubsub_topic}. Only "1.0" is - # accepted. It represents the JSON schema as defined in + # Optional. Required when + # {::Google::Cloud::Billing::Budgets::V1beta1::AllUpdatesRule#pubsub_topic AllUpdatesRule.pubsub_topic} + # is set. The schema version of the notification sent to + # {::Google::Cloud::Billing::Budgets::V1beta1::AllUpdatesRule#pubsub_topic AllUpdatesRule.pubsub_topic}. + # Only "1.0" is accepted. It represents the JSON schema as defined in # https://cloud.google.com/billing/docs/how-to/budgets-programmatic-notifications#notification_format. # @!attribute [rw] monitoring_notification_channels # @return [::Array<::String>] - # Optional. Targets to send notifications to when a threshold is exceeded. This is in - # addition to default recipients who have billing account IAM roles. - # The value is the full REST resource name of a monitoring notification - # channel with the form + # Optional. Targets to send notifications to when a threshold is exceeded. + # This is in addition to default recipients who have billing account IAM + # roles. The value is the full REST resource name of a monitoring + # notification channel with the form # `projects/{project_id}/notificationChannels/{channel_id}`. A maximum of 5 # channels are allowed. See # https://cloud.google.com/billing/docs/how-to/budgets-notification-recipients # for more details. # @!attribute [rw] disable_default_iam_recipients # @return [::Boolean] - # Optional. When set to true, disables default notifications sent when a threshold is - # exceeded. Default notifications are sent to those with Billing Account - # Administrator and Billing Account User IAM roles for the target account. + # Optional. When set to true, disables default notifications sent when a + # threshold is exceeded. Default notifications are sent to those with Billing + # Account Administrator and Billing Account User IAM roles for the target + # account. class AllUpdatesRule include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end @@ -194,21 +202,29 @@ # @return [::Array<::String>] # 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. + # @!attribute [rw] resource_ancestors + # @return [::Array<::String>] + # Optional. A set of folder and organization names of the form + # `folders/{folderId}` or `organizations/{organizationId}`, specifying that + # usage from only this set of folders and organizations should be included in + # the budget. If omitted, the report includes all usage for all + # organizations, regardless of which organization the usage occurred on. # @!attribute [rw] credit_types # @return [::Array<::String>] - # Optional. If {::Google::Cloud::Billing::Budgets::V1beta1::Filter#credit_types_treatment Filter.credit_types_treatment} is INCLUDE_SPECIFIED_CREDITS, this is - # a list of credit types to be subtracted from gross cost to determine the - # spend for threshold calculations. See - # [a list of acceptable credit type + # Optional. If + # {::Google::Cloud::Billing::Budgets::V1beta1::Filter#credit_types_treatment Filter.credit_types_treatment} + # is INCLUDE_SPECIFIED_CREDITS, this is a list of credit types to be + # subtracted from gross cost to determine the spend for threshold + # calculations. See [a list of acceptable credit type # values](https://cloud.google.com/billing/docs/how-to/export-data-bigquery-tables#credits-type). # - # If {::Google::Cloud::Billing::Budgets::V1beta1::Filter#credit_types_treatment Filter.credit_types_treatment} is **not** INCLUDE_SPECIFIED_CREDITS, - # this field must be empty. + # If + # {::Google::Cloud::Billing::Budgets::V1beta1::Filter#credit_types_treatment Filter.credit_types_treatment} + # is **not** INCLUDE_SPECIFIED_CREDITS, this field must be empty. # @!attribute [rw] credit_types_treatment # @return [::Google::Cloud::Billing::Budgets::V1beta1::Filter::CreditTypesTreatment] # Optional. If not set, default behavior is `INCLUDE_ALL_CREDITS`. # @!attribute [rw] services # @return [::Array<::String>] @@ -218,21 +234,21 @@ # all the services. # The service names are available through the Catalog API: # https://cloud.google.com/billing/v1/how-tos/catalog-api. # @!attribute [rw] subaccounts # @return [::Array<::String>] - # Optional. A set of subaccounts of the form `billingAccounts/{account_id}`, specifying - # that usage from only this set of subaccounts should be included in the - # budget. If a subaccount is set to the name of the parent account, + # Optional. A set of subaccounts of the form `billingAccounts/{account_id}`, + # specifying that usage from only this set of subaccounts should be included + # in the budget. If a subaccount is set to the name of the parent account, # usage from the parent account will be included. If omitted, the # report will include usage from the parent account and all # subaccounts, if they exist. # @!attribute [rw] labels # @return [::Google::Protobuf::Map{::String => ::Google::Protobuf::ListValue}] - # Optional. A single label and value pair specifying that usage from only this set of - # labeled resources should be included in the budget. If omitted, the - # report will include all labeled and unlabeled usage. + # Optional. A single label and value pair specifying that usage from only + # this set of labeled resources should be included in the budget. If omitted, + # the report will include all labeled and unlabeled usage. # # An object containing a single `"key": value` pair. Example: `{ "name": # "wrench" }`. # # _Currently, multiple entries or multiple values per entry are not @@ -245,12 +261,12 @@ # April, May, June. After that, it will track usage from July 1 to # September 30 when the current calendar month is July, August, September, # so on. # @!attribute [rw] custom_period # @return [::Google::Cloud::Billing::Budgets::V1beta1::CustomPeriod] - # Optional. Specifies to track usage from any start date (required) to any end date - # (optional). This time period is static, it does not recur. + # Optional. Specifies to track usage from any start date (required) to any + # end date (optional). This time period is static, it does not recur. class Filter include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # @!attribute [rw] key @@ -290,12 +306,12 @@ # @!attribute [rw] start_date # @return [::Google::Type::Date] # Required. The start date must be after January 1, 2017. # @!attribute [rw] end_date # @return [::Google::Type::Date] - # Optional. The end date of the time period. Budgets with elapsed end date won't be - # processed. If unset, specifies to track all usage - # incurred since the start_date. + # Optional. The end date of the time period. Budgets with elapsed end date + # won't be processed. If unset, specifies to track all usage incurred since + # the start_date. class CustomPeriod include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end