google-api-client 0.43.0 → 0.48.0

data/generated/google/apis/billingbudgets_v1/service.rb

@@ -0,0 +1,249 @@
+# Copyright 2015 Google Inc.
+#
+# 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
+#
+#      http://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.
+
+require 'google/apis/core/base_service'
+require 'google/apis/core/json_representation'
+require 'google/apis/core/hashable'
+require 'google/apis/errors'
+
+module Google
+  module Apis
+    module BillingbudgetsV1
+      # Cloud Billing Budget API
+      #
+      # The Cloud Billing Budget API stores Cloud Billing budgets, which define a
+      #  budget plan and the rules to execute as spend is tracked against that plan.
+      #
+      # @example
+      #    require 'google/apis/billingbudgets_v1'
+      #
+      #    Billingbudgets = Google::Apis::BillingbudgetsV1 # Alias the module
+      #    service = Billingbudgets::CloudBillingBudgetService.new
+      #
+      # @see https://cloud.google.com/billing/docs/how-to/budget-api-overview
+      class CloudBillingBudgetService < Google::Apis::Core::BaseService
+        # @return [String]
+        #  API key. Your API key identifies your project and provides you with API access,
+        #  quota, and reports. Required unless you provide an OAuth 2.0 token.
+        attr_accessor :key
+
+        # @return [String]
+        #  Available to use for quota purposes for server-side applications. Can be any
+        #  arbitrary string assigned to a user, but should not exceed 40 characters.
+        attr_accessor :quota_user
+
+        def initialize
+          super('https://billingbudgets.googleapis.com/', '')
+          @batch_path = 'batch'
+        end
+        
+        # Creates a new budget. See [Quotas and limits](https://cloud.google.com/billing/
+        # quotas) for more information on the limits of the number of budgets you can
+        # create.
+        # @param [String] parent
+        #   Required. The name of the billing account to create the budget in. Values are
+        #   of the form `billingAccounts/`billingAccountId``.
+        # @param [Google::Apis::BillingbudgetsV1::GoogleCloudBillingBudgetsV1Budget] google_cloud_billing_budgets_v1_budget_object
+        # @param [String] fields
+        #   Selector specifying which fields to include in a partial response.
+        # @param [String] quota_user
+        #   Available to use for quota purposes for server-side applications. Can be any
+        #   arbitrary string assigned to a user, but should not exceed 40 characters.
+        # @param [Google::Apis::RequestOptions] options
+        #   Request-specific options
+        #
+        # @yield [result, err] Result & error if block supplied
+        # @yieldparam result [Google::Apis::BillingbudgetsV1::GoogleCloudBillingBudgetsV1Budget] parsed result object
+        # @yieldparam err [StandardError] error object if request failed
+        #
+        # @return [Google::Apis::BillingbudgetsV1::GoogleCloudBillingBudgetsV1Budget]
+        #
+        # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
+        # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
+        # @raise [Google::Apis::AuthorizationError] Authorization is required
+        def create_billing_account_budget(parent, google_cloud_billing_budgets_v1_budget_object = nil, fields: nil, quota_user: nil, options: nil, &block)
+          command = make_simple_command(:post, 'v1/{+parent}/budgets', options)
+          command.request_representation = Google::Apis::BillingbudgetsV1::GoogleCloudBillingBudgetsV1Budget::Representation
+          command.request_object = google_cloud_billing_budgets_v1_budget_object
+          command.response_representation = Google::Apis::BillingbudgetsV1::GoogleCloudBillingBudgetsV1Budget::Representation
+          command.response_class = Google::Apis::BillingbudgetsV1::GoogleCloudBillingBudgetsV1Budget
+          command.params['parent'] = parent unless parent.nil?
+          command.query['fields'] = fields unless fields.nil?
+          command.query['quotaUser'] = quota_user unless quota_user.nil?
+          execute_or_queue_command(command, &block)
+        end
+        
+        # Deletes a budget. Returns successfully if already deleted.
+        # @param [String] name
+        #   Required. Name of the budget to delete. Values are of the form `
+        #   billingAccounts/`billingAccountId`/budgets/`budgetId``.
+        # @param [String] fields
+        #   Selector specifying which fields to include in a partial response.
+        # @param [String] quota_user
+        #   Available to use for quota purposes for server-side applications. Can be any
+        #   arbitrary string assigned to a user, but should not exceed 40 characters.
+        # @param [Google::Apis::RequestOptions] options
+        #   Request-specific options
+        #
+        # @yield [result, err] Result & error if block supplied
+        # @yieldparam result [Google::Apis::BillingbudgetsV1::GoogleProtobufEmpty] parsed result object
+        # @yieldparam err [StandardError] error object if request failed
+        #
+        # @return [Google::Apis::BillingbudgetsV1::GoogleProtobufEmpty]
+        #
+        # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
+        # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
+        # @raise [Google::Apis::AuthorizationError] Authorization is required
+        def delete_billing_account_budget(name, fields: nil, quota_user: nil, options: nil, &block)
+          command = make_simple_command(:delete, 'v1/{+name}', options)
+          command.response_representation = Google::Apis::BillingbudgetsV1::GoogleProtobufEmpty::Representation
+          command.response_class = Google::Apis::BillingbudgetsV1::GoogleProtobufEmpty
+          command.params['name'] = name unless name.nil?
+          command.query['fields'] = fields unless fields.nil?
+          command.query['quotaUser'] = quota_user unless quota_user.nil?
+          execute_or_queue_command(command, &block)
+        end
+        
+        # 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.
+        # @param [String] name
+        #   Required. Name of budget to get. Values are of the form `billingAccounts/`
+        #   billingAccountId`/budgets/`budgetId``.
+        # @param [String] fields
+        #   Selector specifying which fields to include in a partial response.
+        # @param [String] quota_user
+        #   Available to use for quota purposes for server-side applications. Can be any
+        #   arbitrary string assigned to a user, but should not exceed 40 characters.
+        # @param [Google::Apis::RequestOptions] options
+        #   Request-specific options
+        #
+        # @yield [result, err] Result & error if block supplied
+        # @yieldparam result [Google::Apis::BillingbudgetsV1::GoogleCloudBillingBudgetsV1Budget] parsed result object
+        # @yieldparam err [StandardError] error object if request failed
+        #
+        # @return [Google::Apis::BillingbudgetsV1::GoogleCloudBillingBudgetsV1Budget]
+        #
+        # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
+        # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
+        # @raise [Google::Apis::AuthorizationError] Authorization is required
+        def get_billing_account_budget(name, fields: nil, quota_user: nil, options: nil, &block)
+          command = make_simple_command(:get, 'v1/{+name}', options)
+          command.response_representation = Google::Apis::BillingbudgetsV1::GoogleCloudBillingBudgetsV1Budget::Representation
+          command.response_class = Google::Apis::BillingbudgetsV1::GoogleCloudBillingBudgetsV1Budget
+          command.params['name'] = name unless name.nil?
+          command.query['fields'] = fields unless fields.nil?
+          command.query['quotaUser'] = quota_user unless quota_user.nil?
+          execute_or_queue_command(command, &block)
+        end
+        
+        # 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.
+        # @param [String] parent
+        #   Required. Name of billing account to list budgets under. Values are of the
+        #   form `billingAccounts/`billingAccountId``.
+        # @param [Fixnum] page_size
+        #   Optional. The maximum number of budgets to return per page. The default and
+        #   maximum value are 100.
+        # @param [String] page_token
+        #   Optional. The value returned by the last `ListBudgetsResponse` which indicates
+        #   that this is a continuation of a prior `ListBudgets` call, and that the system
+        #   should return the next page of data.
+        # @param [String] fields
+        #   Selector specifying which fields to include in a partial response.
+        # @param [String] quota_user
+        #   Available to use for quota purposes for server-side applications. Can be any
+        #   arbitrary string assigned to a user, but should not exceed 40 characters.
+        # @param [Google::Apis::RequestOptions] options
+        #   Request-specific options
+        #
+        # @yield [result, err] Result & error if block supplied
+        # @yieldparam result [Google::Apis::BillingbudgetsV1::GoogleCloudBillingBudgetsV1ListBudgetsResponse] parsed result object
+        # @yieldparam err [StandardError] error object if request failed
+        #
+        # @return [Google::Apis::BillingbudgetsV1::GoogleCloudBillingBudgetsV1ListBudgetsResponse]
+        #
+        # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
+        # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
+        # @raise [Google::Apis::AuthorizationError] Authorization is required
+        def list_billing_account_budgets(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
+          command = make_simple_command(:get, 'v1/{+parent}/budgets', options)
+          command.response_representation = Google::Apis::BillingbudgetsV1::GoogleCloudBillingBudgetsV1ListBudgetsResponse::Representation
+          command.response_class = Google::Apis::BillingbudgetsV1::GoogleCloudBillingBudgetsV1ListBudgetsResponse
+          command.params['parent'] = parent unless parent.nil?
+          command.query['pageSize'] = page_size unless page_size.nil?
+          command.query['pageToken'] = page_token unless page_token.nil?
+          command.query['fields'] = fields unless fields.nil?
+          command.query['quotaUser'] = quota_user unless quota_user.nil?
+          execute_or_queue_command(command, &block)
+        end
+        
+        # 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.
+        # @param [String] name
+        #   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``.
+        # @param [Google::Apis::BillingbudgetsV1::GoogleCloudBillingBudgetsV1Budget] google_cloud_billing_budgets_v1_budget_object
+        # @param [String] update_mask
+        #   Optional. Indicates which fields in the provided budget to update. Read-only
+        #   fields (such as `name`) cannot be changed. If this is not provided, then only
+        #   fields with non-default values from the request are updated. See https://
+        #   developers.google.com/protocol-buffers/docs/proto3#default for more details
+        #   about default values.
+        # @param [String] fields
+        #   Selector specifying which fields to include in a partial response.
+        # @param [String] quota_user
+        #   Available to use for quota purposes for server-side applications. Can be any
+        #   arbitrary string assigned to a user, but should not exceed 40 characters.
+        # @param [Google::Apis::RequestOptions] options
+        #   Request-specific options
+        #
+        # @yield [result, err] Result & error if block supplied
+        # @yieldparam result [Google::Apis::BillingbudgetsV1::GoogleCloudBillingBudgetsV1Budget] parsed result object
+        # @yieldparam err [StandardError] error object if request failed
+        #
+        # @return [Google::Apis::BillingbudgetsV1::GoogleCloudBillingBudgetsV1Budget]
+        #
+        # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
+        # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
+        # @raise [Google::Apis::AuthorizationError] Authorization is required
+        def patch_billing_account_budget(name, google_cloud_billing_budgets_v1_budget_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
+          command = make_simple_command(:patch, 'v1/{+name}', options)
+          command.request_representation = Google::Apis::BillingbudgetsV1::GoogleCloudBillingBudgetsV1Budget::Representation
+          command.request_object = google_cloud_billing_budgets_v1_budget_object
+          command.response_representation = Google::Apis::BillingbudgetsV1::GoogleCloudBillingBudgetsV1Budget::Representation
+          command.response_class = Google::Apis::BillingbudgetsV1::GoogleCloudBillingBudgetsV1Budget
+          command.params['name'] = name unless name.nil?
+          command.query['updateMask'] = update_mask unless update_mask.nil?
+          command.query['fields'] = fields unless fields.nil?
+          command.query['quotaUser'] = quota_user unless quota_user.nil?
+          execute_or_queue_command(command, &block)
+        end
+
+        protected
+
+        def apply_command_defaults(command)
+          command.query['key'] = key unless key.nil?
+          command.query['quotaUser'] = quota_user unless quota_user.nil?
+        end
+      end
+    end
+  end
+end

data/generated/google/apis/billingbudgets_v1.rb

@@ -0,0 +1,38 @@
+# Copyright 2015 Google Inc.
+#
+# 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
+#
+#      http://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.
+
+require 'google/apis/billingbudgets_v1/service.rb'
+require 'google/apis/billingbudgets_v1/classes.rb'
+require 'google/apis/billingbudgets_v1/representations.rb'
+
+module Google
+  module Apis
+    # Cloud Billing Budget API
+    #
+    # The Cloud Billing Budget API stores Cloud Billing budgets, which define a
+    # budget plan and the rules to execute as spend is tracked against that plan.
+    #
+    # @see https://cloud.google.com/billing/docs/how-to/budget-api-overview
+    module BillingbudgetsV1
+      VERSION = 'V1'
+      REVISION = '20201026'
+
+      # View and manage your Google Cloud Platform billing accounts
+      AUTH_CLOUD_BILLING = 'https://www.googleapis.com/auth/cloud-billing'
+
+      # View and manage your data across Google Cloud Platform services
+      AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform'
+    end
+  end
+end

data/generated/google/apis/billingbudgets_v1beta1/classes.rb

@@ -27,12 +27,21 @@ module Google
       class GoogleCloudBillingBudgetsV1beta1AllUpdatesRule
         include Google::Apis::Core::Hashable
       
+        # 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.
+        # Corresponds to the JSON property `disableDefaultIamRecipients`
+        # @return [Boolean]
+        attr_accessor :disable_default_iam_recipients
+        alias_method :disable_default_iam_recipients?, :disable_default_iam_recipients
+      
         # 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 `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.
+        # 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.
         # Corresponds to the JSON property `monitoringNotificationChannels`
         # @return [Array<String>]
         attr_accessor :monitoring_notification_channels
@@ -64,6 +73,7 @@ module Google
       
         # Update properties of this object
         def update!(**args)
+          @disable_default_iam_recipients = args[:disable_default_iam_recipients] if args.key?(:disable_default_iam_recipients)
           @monitoring_notification_channels = args[:monitoring_notification_channels] if args.key?(:monitoring_notification_channels)
           @pubsub_topic = args[:pubsub_topic] if args.key?(:pubsub_topic)
           @schema_version = args[:schema_version] if args.key?(:schema_version)
@@ -189,6 +199,16 @@ module Google
       class GoogleCloudBillingBudgetsV1beta1Filter
         include Google::Apis::Core::Hashable
       
+        # Optional. A list of credit types to be subtracted from gross cost to determine
+        # the spend for threshold calculations if and only if credit_types_treatment is
+        # INCLUDE_SPECIFIED_CREDITS. If credit_types_treatment is not
+        # INCLUDE_SPECIFIED_CREDITS, this field must be empty. See credits.type at https:
+        # //cloud.google.com/billing/docs/how-to/export-data-bigquery-tables#data-schema
+        # for a list of acceptable credit type values in this field.
+        # Corresponds to the JSON property `creditTypes`
+        # @return [Array<String>]
+        attr_accessor :credit_types
+      
         # Optional. If not set, default behavior is `INCLUDE_ALL_CREDITS`.
         # Corresponds to the JSON property `creditTypesTreatment`
         # @return [String]
@@ -235,6 +255,7 @@ module Google
       
         # Update properties of this object
         def update!(**args)
+          @credit_types = args[:credit_types] if args.key?(:credit_types)
           @credit_types_treatment = args[:credit_types_treatment] if args.key?(:credit_types_treatment)
           @labels = args[:labels] if args.key?(:labels)
           @projects = args[:projects] if args.key?(:projects)
@@ -371,7 +392,7 @@ module Google
       class GoogleTypeMoney
         include Google::Apis::Core::Hashable
       
-        # The 3-letter currency code defined in ISO 4217.
+        # The three-letter currency code defined in ISO 4217.
         # Corresponds to the JSON property `currencyCode`
         # @return [String]
         attr_accessor :currency_code

data/generated/google/apis/billingbudgets_v1beta1/representations.rb

@@ -91,6 +91,7 @@ module Google
       class GoogleCloudBillingBudgetsV1beta1AllUpdatesRule
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation
+          property :disable_default_iam_recipients, as: 'disableDefaultIamRecipients'
           collection :monitoring_notification_channels, as: 'monitoringNotificationChannels'
           property :pubsub_topic, as: 'pubsubTopic'
           property :schema_version, as: 'schemaVersion'
@@ -135,6 +136,7 @@ module Google
       class GoogleCloudBillingBudgetsV1beta1Filter
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation
+          collection :credit_types, as: 'creditTypes'
           property :credit_types_treatment, as: 'creditTypesTreatment'
           hash :labels, as: 'labels', :class => Array do
         include Representable::JSON::Collection

data/generated/google/apis/billingbudgets_v1beta1.rb

@@ -26,7 +26,10 @@ module Google
     # @see https://cloud.google.com/billing/docs/how-to/budget-api-overview
     module BillingbudgetsV1beta1
       VERSION = 'V1beta1'
-      REVISION = '20200801'
+      REVISION = '20201026'
+
+      # View and manage your Google Cloud Platform billing accounts
+      AUTH_CLOUD_BILLING = 'https://www.googleapis.com/auth/cloud-billing'
 
       # View and manage your data across Google Cloud Platform services
       AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform'