google-cloud-billing-budgets-v1beta1 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8b29b0eec5f8684e7a46dbd8cfed7cf761669abd1d9cf1e5a7f9c74900b7dfd2
-  data.tar.gz: 2728272dae7981e0223524967184928c14f82cc99eae310774e49ba4c75fd9cc
+  metadata.gz: baf6d87986bf613550ec305154b1a3f71dc74f20e957e2e39ae4f369322d5355
+  data.tar.gz: 06f9c158df77c4f039fac0ce4946c2d3b28b071b575ec006a24966d3c04be944
 SHA512:
-  metadata.gz: 1c6b468271b79eba0862a14d414bfd2892ed6f1408519aa16ec9b749f928aa2d57067f4c1c227ad523bbc029cc4b938e5021086e8e8248e44f7764b80b793ea7
-  data.tar.gz: f9122d34bee7eae3bf6ae43cc54670de56fcdefd115193d35be63589cab8cac48cad3b91fcc0f4858f717ecd1a1a6bd8d1e710eaf97653c484cbaef8db19e0c4
+  metadata.gz: 3c8ce8a5288befa35c9881bac79901ff685316a2a4f99d5e421855fc56e85872f636151aeaf46701d09620ed27d2c9dd239908b0af312285717a73bcb79e7d6b
+  data.tar.gz: 3822e124e0cfaacd6e2816817c8d087d54f1a23da43fb8657678d012847c45f97ab2dcbaaf25662dc98c887ca828ed122e99eac050b6c26dd292ba06eb8bc1ae

data/lib/google/cloud/billing/budgets/v1beta1/budget_model_pb.rb

@@ -6,6 +6,7 @@ require 'google/protobuf'
 require 'google/api/field_behavior_pb'
 require 'google/api/resource_pb'
 require 'google/protobuf/struct_pb'
+require 'google/type/date_pb'
 require 'google/type/money_pb'
 Google::Protobuf::DescriptorPool.generated_pool.build do
   add_file("google/cloud/billing/budgets/v1beta1/budget_model.proto", :syntax => :proto3) do
@@ -48,6 +49,10 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
       repeated :services, :string, 3
       repeated :subaccounts, :string, 5
       map :labels, :string, :message, 6, "google.protobuf.ListValue"
+      oneof :usage_period do
+        optional :calendar_period, :enum, 8, "google.cloud.billing.budgets.v1beta1.CalendarPeriod"
+        optional :custom_period, :message, 9, "google.cloud.billing.budgets.v1beta1.CustomPeriod"
+      end
     end
     add_enum "google.cloud.billing.budgets.v1beta1.Filter.CreditTypesTreatment" do
       value :CREDIT_TYPES_TREATMENT_UNSPECIFIED, 0
@@ -55,6 +60,16 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
       value :EXCLUDE_ALL_CREDITS, 2
       value :INCLUDE_SPECIFIED_CREDITS, 3
     end
+    add_message "google.cloud.billing.budgets.v1beta1.CustomPeriod" do
+      optional :start_date, :message, 1, "google.type.Date"
+      optional :end_date, :message, 2, "google.type.Date"
+    end
+    add_enum "google.cloud.billing.budgets.v1beta1.CalendarPeriod" do
+      value :CALENDAR_PERIOD_UNSPECIFIED, 0
+      value :MONTH, 1
+      value :QUARTER, 2
+      value :YEAR, 3
+    end
   end
 end
 
@@ -71,6 +86,8 @@ module Google
           AllUpdatesRule = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.billing.budgets.v1beta1.AllUpdatesRule").msgclass
           Filter = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.billing.budgets.v1beta1.Filter").msgclass
           Filter::CreditTypesTreatment = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.billing.budgets.v1beta1.Filter.CreditTypesTreatment").enummodule
+          CustomPeriod = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.billing.budgets.v1beta1.CustomPeriod").msgclass
+          CalendarPeriod = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.billing.budgets.v1beta1.CalendarPeriod").enummodule
         end
       end
     end

data/lib/google/cloud/billing/budgets/v1beta1/budget_service_services_pb.rb

@@ -29,7 +29,7 @@ module Google
             # budget plan and rules to execute as we track spend against that plan.
             class Service
 
-              include GRPC::GenericService
+              include ::GRPC::GenericService
 
               self.marshal_class_method = :encode
               self.unmarshal_class_method = :decode

data/lib/google/cloud/billing/budgets/v1beta1/version.rb

@@ -22,7 +22,7 @@ module Google
     module Billing
       module Budgets
         module V1beta1
-          VERSION = "0.5.0"
+          VERSION = "0.6.0"
         end
       end
     end

data/proto_docs/google/cloud/billing/budgets/v1beta1/budget_model.rb

@@ -25,8 +25,8 @@ module Google
           # A budget is a plan that describes what you expect to spend on Cloud
           # projects, plus the rules to execute as spend is tracked against that plan,
           # (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).
+          # The budget time period is configurable, with options such as month (default),
+          # quarter, year, or custom time period.
           # @!attribute [r] name
           #   @return [::String]
           #     Output only. Resource name of the budget.
@@ -38,8 +38,9 @@ module Google
           #     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.
+          #     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.
@@ -67,21 +68,29 @@ module Google
           #     A specified amount to use as the budget.
           #     `currency_code` is optional. If specified when creating a budget, it must
           #     match the currency of the billing account. If specified when updating a
-          #     budget, it must match the existing budget currency_code.
+          #     budget, it must match the currency_code of the existing budget.
           #     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#custom_period Filter.custom_period}.
           class BudgetAmount
             include ::Google::Protobuf::MessageExts
             extend ::Google::Protobuf::MessageExts::ClassMethods
           end
 
-          # Describes a budget amount targeted to last period's spend.
-          # At this time, the amount is automatically 100% of last period's spend;
-          # that is, there are no other options yet.
-          # Future configuration will be described here (for example, configuring a
-          # percentage of last period's spend).
+          # 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}.
           class LastPeriodAmount
             include ::Google::Protobuf::MessageExts
             extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -117,6 +126,10 @@ module Google
 
               # 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#custom_period Filter.custom_period}.
               FORECASTED_SPEND = 2
             end
           end
@@ -129,12 +142,12 @@ module Google
           #     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#manage-notifications
+          #     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
+          #     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]
@@ -179,13 +192,12 @@ module Google
           #     {::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.
+          #     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. See [a list
-          #     of acceptable credit type
-          #     values](https://cloud.google.com/billing/docs/how-to/export-data-bigquery-tables#credits-type).
+          #     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`.
@@ -211,6 +223,18 @@ module Google
           #     this set of labeled resources should be included in the budget. Currently,
           #     multiple entries or multiple values per entry are not allowed. If omitted,
           #     the report will include all labeled and unlabeled usage.
+          # @!attribute [rw] calendar_period
+          #   @return [::Google::Cloud::Billing::Budgets::V1beta1::CalendarPeriod]
+          #     Optional. Specifies to track usage for recurring calendar period.
+          #     For example, assume that CalendarPeriod.QUARTER is set. The budget will
+          #     track usage from April 1 to June 30, when the current calendar month is
+          #     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.
           class Filter
             include ::Google::Protobuf::MessageExts
             extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -224,8 +248,11 @@ module Google
               extend ::Google::Protobuf::MessageExts::ClassMethods
             end
 
-            # Specifies how credits should be treated when determining spend for
-            # threshold calculations.
+            # Specifies how credits are applied when determining the spend for
+            # threshold calculations. Budgets track the total cost minus any applicable
+            # selected credits.
+            # [See the documentation for a list of credit
+            # types](https://cloud.google.com/billing/docs/how-to/export-data-bigquery-tables#credits-type).
             module CreditTypesTreatment
               CREDIT_TYPES_TREATMENT_UNSPECIFIED = 0
 
@@ -237,11 +264,46 @@ module Google
               # threshold calculations.
               EXCLUDE_ALL_CREDITS = 2
 
-              # Credit types specified in the credit_types field are subtracted from the
+              # [Credit
+              # types](https://cloud.google.com/billing/docs/how-to/export-data-bigquery-tables#credits-type)
+              # specified in the credit_types field are subtracted from the
               # gross cost to determine the spend for threshold calculations.
               INCLUDE_SPECIFIED_CREDITS = 3
             end
           end
+
+          # All date times begin at 12 AM US and Canadian Pacific Time (UTC-8).
+          # @!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.
+          class CustomPeriod
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # A `CalendarPeriod` represents the abstract concept of a time period that
+          # has a canonical start. Grammatically, "the start of the current
+          # `CalendarPeriod`". All calendar times begin at 12 AM US and Canadian
+          # Pacific Time (UTC-8).
+          module CalendarPeriod
+            CALENDAR_PERIOD_UNSPECIFIED = 0
+
+            # A month. Month starts on the first day of each month, such as January 1,
+            # February 1, March 1, and so on.
+            MONTH = 1
+
+            # A quarter. Quarters start on dates January 1, April 1, July 1, and October
+            # 1 of each year.
+            QUARTER = 2
+
+            # A year. Year starts on January 1.
+            YEAR = 3
+          end
         end
       end
     end

data/proto_docs/google/type/date.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+# Copyright 2021 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
+
+
+module Google
+  module Type
+    # Represents a whole or partial calendar date, e.g. a birthday. The time of day
+    # and time zone are either specified elsewhere or are not significant. The date
+    # is relative to the Proleptic Gregorian Calendar. This can represent:
+    #
+    # * A full date, with non-zero year, month and day values
+    # * A month and day value, with a zero year, e.g. an anniversary
+    # * A year on its own, with zero month and day values
+    # * A year and month value, with a zero day, e.g. a credit card expiration date
+    #
+    # Related types are [google.type.TimeOfDay][google.type.TimeOfDay] and `google.protobuf.Timestamp`.
+    # @!attribute [rw] year
+    #   @return [::Integer]
+    #     Year of date. Must be from 1 to 9999, or 0 if specifying a date without
+    #     a year.
+    # @!attribute [rw] month
+    #   @return [::Integer]
+    #     Month of year. Must be from 1 to 12, or 0 if specifying a year without a
+    #     month and day.
+    # @!attribute [rw] day
+    #   @return [::Integer]
+    #     Day of month. Must be from 1 to 31 and valid for the year and month, or 0
+    #     if specifying a year by itself or a year and month where the day is not
+    #     significant.
+    class Date
+      include ::Google::Protobuf::MessageExts
+      extend ::Google::Protobuf::MessageExts::ClassMethods
+    end
+  end
+end

metadata

@@ -1,29 +1,35 @@
 --- !ruby/object:Gem::Specification
 name: google-cloud-billing-budgets-v1beta1
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-03-09 00:00:00.000000000 Z
+date: 2021-06-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gapic-common
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.5'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '0.3'
+        version: 2.a
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.5'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '0.3'
+        version: 2.a
 - !ruby/object:Gem::Dependency
   name: google-cloud-errors
   requirement: !ruby/object:Gem::Requirement
@@ -181,6 +187,7 @@ files:
 - proto_docs/google/protobuf/empty.rb
 - proto_docs/google/protobuf/field_mask.rb
 - proto_docs/google/protobuf/struct.rb
+- proto_docs/google/type/date.rb
 - proto_docs/google/type/money.rb
 homepage: https://github.com/googleapis/google-cloud-ruby
 licenses:
@@ -201,7 +208,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.13
+rubygems_version: 3.2.17
 signing_key: 
 specification_version: 4
 summary: API Client library for the Billing Budgets V1beta1 API