google-cloud-billing-budgets-v1beta1 0.1.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 63eeef2e2f9b198587ca684920224fed03884db141982a3ab9932bd4b7e7626e
-  data.tar.gz: 9aabe5a29e721716365cc55ee829fb616624cacb37c6210a28b426c1099d7342
+  metadata.gz: 2bbcf0fb6f62df8d75c567613fdd00c5df295e5c1675acdaf27f76b377ad7f1d
+  data.tar.gz: 8e103ff7a2eb0b8004708ded08b02347665e5fac3f8b29574a2ddeecfd3c6a7e
 SHA512:
-  metadata.gz: b2ff224ead15d6845ea67a86933c1497266e2df9620ec9e466b194474a7486b7d3d27de5decd72e958f2a1f040ec2127b888770d98d9ee21f12f0b6f94d469a9
-  data.tar.gz: e9301e9246b48678b6319892ba3305cd015d5e8a0bddc8bd16d39016232c0c9328d78053bef2e81b12668c05a0879c74d90ff35d2969c965a8aa4d119d4cdf44
+  metadata.gz: '09af4c44f6d749829bbccaf6fa9fefc601b83911eb4835159f700fe89b697727bb73a119d0c164799fec70fc0348dac742728e3b75550290ac23acb6ea02a0f4'
+  data.tar.gz: 30c610dc43850418a078a8fb9600041dc18e368de0ffea1a7f38c42d0ed8393b0c96e6f733dad7242750fc6ce91968b2b1fb6b514674a3efd3daf21f65dd65bb

data/README.md

@@ -6,6 +6,12 @@ Provides methods to view, create, and manage Cloud Billing budgets programmatica
 
 https://github.com/googleapis/google-cloud-ruby
 
+This gem is a _versioned_ client. It provides basic client classes for a
+specific version of the Billing Budgets V1beta1 API. Most users should consider using
+the main client gem,
+[google-cloud-billing-budgets](https://rubygems.org/gems/google-cloud-billing-budgets).
+See the section below titled *Which client should I use?* for more information.
+
 ## Installation
 
 ```
@@ -73,3 +79,61 @@ in security maintenance, and not end of life. Currently, this means Ruby 2.4
 and later. Older versions of Ruby _may_ still work, but are unsupported and not
 recommended. See https://www.ruby-lang.org/en/downloads/branches/ for details
 about the Ruby support schedule.
+
+## Which client should I use?
+
+Most modern Ruby client libraries for Google APIs come in two flavors: the main
+client library with a name such as `google-cloud-billing-budgets`,
+and lower-level _versioned_ client libraries with names such as
+`google-cloud-billing-budgets-v1beta1`.
+_In most cases, you should install the main client._
+
+### What's the difference between the main client and a versioned client?
+
+A _versioned client_ provides a basic set of data types and client classes for
+a _single version_ of a specific service. (That is, for a service with multiple
+versions, there might be a separate versioned client for each service version.)
+Most versioned clients are written and maintained by a code generator.
+
+The _main client_ is designed to provide you with the _recommended_ client
+interfaces for the service. There will be only one main client for any given
+service, even a service with multiple versions. The main client includes
+factory methods for constructing the client objects we recommend for most
+users. In some cases, those will be classes provided by an underlying versioned
+client; in other cases, they will be handwritten higher-level client objects
+with additional capabilities, convenience methods, or best practices built in.
+Generally, the main client will default to a recommended service version,
+although in some cases you can override this if you need to talk to a specific
+service version.
+
+### Why would I want to use the main client?
+
+We recommend that most users install the main client gem for a service. You can
+identify this gem as the one _without_ a version in its name, e.g.
+`google-cloud-billing-budgets`.
+The main client is recommended because it will embody the best practices for
+accessing the service, and may also provide more convenient interfaces or
+tighter integration into frameworks and third-party libraries. In addition, the
+documentation and samples published by Google will generally demonstrate use of
+the main client.
+
+### Why would I want to use a versioned client?
+
+You can use a versioned client if you are content with a possibly lower-level
+class interface, you explicitly want to avoid features provided by the main
+client, or you want to access a specific service version not be covered by the
+main client. You can identify versioned client gems because the service version
+is part of the name, e.g. `google-cloud-billing-budgets-v1beta1`.
+
+### What about the google-apis-<name> clients?
+
+Client library gems with names that begin with `google-apis-` are based on an
+older code generation technology. They talk to a REST/JSON backend (whereas
+most modern clients talk to a [gRPC](https://grpc.io/) backend) and they may
+not offer the same performance, features, and ease of use provided by more
+modern clients.
+
+The `google-apis-` clients have wide coverage across Google services, so you
+might need to use one if there is no modern client available for the service.
+However, if a modern client is available, we generally recommend it over the
+older `google-apis-` clients.

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

@@ -35,3 +35,6 @@ module Google
     end
   end
 end
+
+helper_path = ::File.join __dir__, "v1beta1", "_helpers.rb"
+require "google/cloud/billing/budgets/v1beta1/_helpers" if ::File.file? helper_path

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

@@ -39,9 +39,11 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
       optional :pubsub_topic, :string, 1
       optional :schema_version, :string, 2
       repeated :monitoring_notification_channels, :string, 3
+      optional :disable_default_iam_recipients, :bool, 4
     end
     add_message "google.cloud.billing.budgets.v1beta1.Filter" do
       repeated :projects, :string, 1
+      repeated :credit_types, :string, 7
       optional :credit_types_treatment, :enum, 4, "google.cloud.billing.budgets.v1beta1.Filter.CreditTypesTreatment"
       repeated :services, :string, 3
       repeated :subaccounts, :string, 5
@@ -51,6 +53,7 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
       value :CREDIT_TYPES_TREATMENT_UNSPECIFIED, 0
       value :INCLUDE_ALL_CREDITS, 1
       value :EXCLUDE_ALL_CREDITS, 2
+      value :INCLUDE_SPECIFIED_CREDITS, 3
     end
   end
 end

data/lib/google/cloud/billing/budgets/v1beta1/budget_service/client.rb

@@ -162,7 +162,13 @@ module Google
 
                 # Create credentials
                 credentials = @config.credentials
-                credentials ||= Credentials.default scope: @config.scope
+                # Use self-signed JWT if the scope and endpoint are unchanged from default,
+                # but only if the default endpoint does not have a region prefix.
+                enable_self_signed_jwt = @config.scope == Client.configure.scope &&
+                                         @config.endpoint == Client.configure.endpoint &&
+                                         !@config.endpoint.split(".").first.include?("-")
+                credentials ||= Credentials.default scope:                  @config.scope,
+                                                    enable_self_signed_jwt: enable_self_signed_jwt
                 if credentials.is_a?(String) || credentials.is_a?(Hash)
                   credentials = Credentials.new credentials, scope: @config.scope
                 end
@@ -673,7 +679,7 @@ module Google
                 # Each configuration object is of type `Gapic::Config::Method` and includes
                 # the following configuration fields:
                 #
-                #  *  `timeout` (*type:* `Numeric`) - The call timeout in milliseconds
+                #  *  `timeout` (*type:* `Numeric`) - The call timeout in seconds
                 #  *  `metadata` (*type:* `Hash{Symbol=>String}`) - Additional gRPC headers
                 #  *  `retry_policy (*type:* `Hash`) - The retry policy. The policy fields
                 #     include the following keys:

data/lib/google/cloud/billing/budgets/v1beta1/budget_service/credentials.rb

@@ -27,6 +27,7 @@ module Google
             # Credentials for the BudgetService API.
             class Credentials < ::Google::Auth::Credentials
               self.scope = [
+                "https://www.googleapis.com/auth/cloud-billing",
                 "https://www.googleapis.com/auth/cloud-platform"
               ]
               self.env_vars = [

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

@@ -38,29 +38,29 @@ module Google
               # Creates a new budget. See
               # <a href="https://cloud.google.com/billing/quotas">Quotas and limits</a>
               # for more information on the limits of the number of budgets you can create.
-              rpc :CreateBudget, Google::Cloud::Billing::Budgets::V1beta1::CreateBudgetRequest, Google::Cloud::Billing::Budgets::V1beta1::Budget
+              rpc :CreateBudget, ::Google::Cloud::Billing::Budgets::V1beta1::CreateBudgetRequest, ::Google::Cloud::Billing::Budgets::V1beta1::Budget
               # Updates a budget and returns the updated budget.
               #
               # WARNING: There are some fields exposed on the Google Cloud Console that
               # aren't available on this API. Budget fields that are not exposed in
               # this API will not be changed by this method.
-              rpc :UpdateBudget, Google::Cloud::Billing::Budgets::V1beta1::UpdateBudgetRequest, Google::Cloud::Billing::Budgets::V1beta1::Budget
+              rpc :UpdateBudget, ::Google::Cloud::Billing::Budgets::V1beta1::UpdateBudgetRequest, ::Google::Cloud::Billing::Budgets::V1beta1::Budget
               # Returns a budget.
               #
               # WARNING: There are some fields exposed on the Google Cloud Console that
               # aren't available on this API. When reading from the API, you will not
               # see these fields in the return value, though they may have been set
               # in the Cloud Console.
-              rpc :GetBudget, Google::Cloud::Billing::Budgets::V1beta1::GetBudgetRequest, Google::Cloud::Billing::Budgets::V1beta1::Budget
+              rpc :GetBudget, ::Google::Cloud::Billing::Budgets::V1beta1::GetBudgetRequest, ::Google::Cloud::Billing::Budgets::V1beta1::Budget
               # Returns a list of budgets for a billing account.
               #
               # WARNING: There are some fields exposed on the Google Cloud Console that
               # aren't available on this API. When reading from the API, you will not
               # see these fields in the return value, though they may have been set
               # in the Cloud Console.
-              rpc :ListBudgets, Google::Cloud::Billing::Budgets::V1beta1::ListBudgetsRequest, Google::Cloud::Billing::Budgets::V1beta1::ListBudgetsResponse
+              rpc :ListBudgets, ::Google::Cloud::Billing::Budgets::V1beta1::ListBudgetsRequest, ::Google::Cloud::Billing::Budgets::V1beta1::ListBudgetsResponse
               # Deletes a budget. Returns successfully if already deleted.
-              rpc :DeleteBudget, Google::Cloud::Billing::Budgets::V1beta1::DeleteBudgetRequest, Google::Protobuf::Empty
+              rpc :DeleteBudget, ::Google::Cloud::Billing::Budgets::V1beta1::DeleteBudgetRequest, ::Google::Protobuf::Empty
             end
 
             Stub = Service.rpc_stub_class

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

@@ -22,7 +22,7 @@ module Google
     module Billing
       module Budgets
         module V1beta1
-          VERSION = "0.1.0"
+          VERSION = "0.4.0"
         end
       end
     end

data/proto_docs/google/api/field_behavior.rb

@@ -54,6 +54,12 @@ module Google
       # This indicates that the field may be set once in a request to create a
       # resource, but may not be changed thereafter.
       IMMUTABLE = 5
+
+      # Denotes that a (repeated) field is an unordered list.
+      # This indicates that the service may provide the elements of the list
+      # in any arbitrary order, rather than the order the user originally
+      # provided. Additionally, the list's order may or may not be stable.
+      UNORDERED_LIST = 6
     end
   end
 end

data/proto_docs/google/api/resource.rb

@@ -43,12 +43,12 @@ module Google
     #
     # The ResourceDescriptor Yaml config will look like:
     #
-    #    resources:
-    #    - type: "pubsub.googleapis.com/Topic"
-    #      name_descriptor:
-    #        - pattern: "projects/\\{project}/topics/\\{topic}"
-    #          parent_type: "cloudresourcemanager.googleapis.com/Project"
-    #          parent_name_extractor: "projects/\\{project}"
+    #     resources:
+    #     - type: "pubsub.googleapis.com/Topic"
+    #       name_descriptor:
+    #         - pattern: "projects/{project}/topics/{topic}"
+    #           parent_type: "cloudresourcemanager.googleapis.com/Project"
+    #           parent_name_extractor: "projects/{project}"
     #
     # Sometimes, resources have multiple patterns, typically because they can
     # live under multiple parents.
@@ -183,15 +183,24 @@ module Google
     #         }
     # @!attribute [rw] plural
     #   @return [::String]
-    #     The plural name used in the resource name, such as 'projects' for
-    #     the name of 'projects/\\{project}'. It is the same concept of the `plural`
-    #     field in k8s CRD spec
+    #     The plural name used in the resource name and permission names, such as
+    #     'projects' for the resource name of 'projects/\\{project}' and the permission
+    #     name of 'cloudresourcemanager.googleapis.com/projects.get'. It is the same
+    #     concept of the `plural` field in k8s CRD spec
     #     https://kubernetes.io/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions/
+    #
+    #     Note: The plural form is required even for singleton resources. See
+    #     https://aip.dev/156
     # @!attribute [rw] singular
     #   @return [::String]
     #     The same concept of the `singular` field in k8s CRD spec
     #     https://kubernetes.io/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions/
     #     Such as "project" for the `resourcemanager.googleapis.com/Project` type.
+    # @!attribute [rw] style
+    #   @return [::Array<::Google::Api::ResourceDescriptor::Style>]
+    #     Style flag(s) for this resource.
+    #     These indicate that a resource is expected to conform to a given
+    #     style. See the specific style flags for additional information.
     class ResourceDescriptor
       include ::Google::Protobuf::MessageExts
       extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -211,6 +220,22 @@ module Google
         # that from being necessary once there are multiple patterns.)
         FUTURE_MULTI_PATTERN = 2
       end
+
+      # A flag representing a specific style that a resource claims to conform to.
+      module Style
+        # The unspecified value. Do not use.
+        STYLE_UNSPECIFIED = 0
+
+        # This resource is intended to be "declarative-friendly".
+        #
+        # Declarative-friendly resources must be more strictly consistent, and
+        # setting this to true communicates to tools that this resource should
+        # adhere to declarative-friendly expectations.
+        #
+        # Note: This is used by the API linter (linter.aip.dev) to enable
+        # additional checks.
+        DECLARATIVE_FRIENDLY = 1
+      end
     end
 
     # Defines a proto annotation that describes a string field that refers to
@@ -226,6 +251,17 @@ module Google
     #             type: "pubsub.googleapis.com/Topic"
     #           }];
     #         }
+    #
+    #     Occasionally, a field may reference an arbitrary resource. In this case,
+    #     APIs use the special value * in their resource reference.
+    #
+    #     Example:
+    #
+    #         message GetIamPolicyRequest {
+    #           string resource = 2 [(google.api.resource_reference) = {
+    #             type: "*"
+    #           }];
+    #         }
     # @!attribute [rw] child_type
     #   @return [::String]
     #     The resource type of a child collection that the annotated field
@@ -234,11 +270,11 @@ module Google
     #
     #     Example:
     #
-    #       message ListLogEntriesRequest {
-    #         string parent = 1 [(google.api.resource_reference) = {
-    #           child_type: "logging.googleapis.com/LogEntry"
-    #         };
-    #       }
+    #         message ListLogEntriesRequest {
+    #           string parent = 1 [(google.api.resource_reference) = {
+    #             child_type: "logging.googleapis.com/LogEntry"
+    #           };
+    #         }
     class ResourceReference
       include ::Google::Protobuf::MessageExts
       extend ::Google::Protobuf::MessageExts::ClassMethods

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

@@ -124,8 +124,8 @@ module Google
           # and thresholds.
           # @!attribute [rw] pubsub_topic
           #   @return [::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}`.
+          #     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#manage-notifications
@@ -133,21 +133,29 @@ module Google
           #     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/pubsub/docs/access-control for more details on
-          #     Pub/Sub roles and permissions.
+          #     https://cloud.google.com/billing/docs/how-to/budgets-programmatic-notifications
+          #     for more details on Pub/Sub roles and permissions.
           # @!attribute [rw] schema_version
           #   @return [::String]
-          #     Required. The schema version of the notification sent to `pubsub_topic`.
+          #     Optional. The schema version of the notification sent to `pubsub_topic`.
           #     Only "1.0" is accepted. It represents the JSON schema as defined in
-          #     https://cloud.google.com/billing/docs/how-to/budgets#notification_format
+          #     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 roles.
-          #     The value is the full REST resource name of a monitoring notification
-          #     channel with the form
+          #     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.
+          #     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.
           class AllUpdatesRule
             include ::Google::Protobuf::MessageExts
             extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -161,6 +169,19 @@ module Google
           #     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] 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.
+          #
+          #     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).
           # @!attribute [rw] credit_types_treatment
           #   @return [::Google::Cloud::Billing::Budgets::V1beta1::Filter::CreditTypesTreatment]
           #     Optional. If not set, default behavior is `INCLUDE_ALL_CREDITS`.
@@ -176,10 +197,10 @@ module Google
           #   @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 reseller account,
-          #     usage from the reseller account will be included. If omitted, the report
-          #     will include usage from the reseller account and all subaccounts, if they
-          #     exist.
+          #     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
@@ -211,6 +232,10 @@ module Google
               # All types of credit are added to the net cost to determine the spend for
               # threshold calculations.
               EXCLUDE_ALL_CREDITS = 2
+
+              # Credit types 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
         end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google-cloud-billing-budgets-v1beta1
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-09-10 00:00:00.000000000 Z
+date: 2021-02-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gapic-common
@@ -151,7 +151,9 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0.9'
 description: Provides methods to view, create, and manage Cloud Billing budgets programmatically
-  at scale.
+  at scale. Note that google-cloud-billing-budgets-v1beta1 is a version-specific client
+  library. For most uses, we recommend installing the main client library google-cloud-billing-budgets
+  instead. See the readme for more details.
 email: googleapis-packages@google.com
 executables: []
 extensions: []
@@ -199,7 +201,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.3
+rubygems_version: 3.2.6
 signing_key: 
 specification_version: 4
 summary: API Client library for the Billing Budgets V1beta1 API