Class: Google::Cloud::Billing::Budgets::V1::BudgetService::Client
- Inherits:
-
Object
- Object
- Google::Cloud::Billing::Budgets::V1::BudgetService::Client
- Includes:
- Paths
- Defined in:
- lib/google/cloud/billing/budgets/v1/budget_service/client.rb
Overview
Client for the BudgetService service.
BudgetService stores Cloud Billing budgets, which define a budget plan and rules to execute as we track spend against that plan.
Defined Under Namespace
Classes: Configuration
Class Method Summary collapse
-
.configure {|config| ... } ⇒ Client::Configuration
Configure the BudgetService Client class.
Instance Method Summary collapse
-
#configure {|config| ... } ⇒ Client::Configuration
Configure the BudgetService Client instance.
-
#create_budget(request, options = nil) {|response, operation| ... } ⇒ ::Google::Cloud::Billing::Budgets::V1::Budget
Creates a new budget.
-
#delete_budget(request, options = nil) {|response, operation| ... } ⇒ ::Google::Protobuf::Empty
Deletes a budget.
-
#get_budget(request, options = nil) {|response, operation| ... } ⇒ ::Google::Cloud::Billing::Budgets::V1::Budget
Returns a budget.
-
#initialize {|config| ... } ⇒ Client
constructor
Create a new BudgetService client object.
-
#list_budgets(request, options = nil) {|response, operation| ... } ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Billing::Budgets::V1::Budget>
Returns a list of budgets for a billing account.
-
#update_budget(request, options = nil) {|response, operation| ... } ⇒ ::Google::Cloud::Billing::Budgets::V1::Budget
Updates a budget and returns the updated budget.
Methods included from Paths
#billing_account_path, #budget_path
Constructor Details
#initialize {|config| ... } ⇒ Client
Create a new BudgetService client object.
133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 |
# File 'lib/google/cloud/billing/budgets/v1/budget_service/client.rb', line 133 def initialize # These require statements are intentionally placed here to initialize # the gRPC module only when it's required. # See https://github.com/googleapis/toolkit/issues/446 require "gapic/grpc" require "google/cloud/billing/budgets/v1/budget_service_services_pb" # Create the configuration object @config = Configuration.new Client.configure # Yield the configuration if needed yield @config if block_given? # Create credentials credentials = @config.credentials # Use self-signed JWT if the endpoint is unchanged from default, # but only if the default endpoint does not have a region prefix. enable_self_signed_jwt = @config.endpoint == Configuration::DEFAULT_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 @quota_project_id = @config.quota_project @quota_project_id ||= credentials.quota_project_id if credentials.respond_to? :quota_project_id @budget_service_stub = ::Gapic::ServiceStub.new( ::Google::Cloud::Billing::Budgets::V1::BudgetService::Stub, credentials: credentials, endpoint: @config.endpoint, channel_args: @config.channel_args, interceptors: @config.interceptors, channel_pool_config: @config.channel_pool ) end |
Class Method Details
.configure {|config| ... } ⇒ Client::Configuration
Configure the BudgetService Client class.
See for a description of the configuration fields.
58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 |
# File 'lib/google/cloud/billing/budgets/v1/budget_service/client.rb', line 58 def self.configure @configure ||= begin namespace = ["Google", "Cloud", "Billing", "Budgets", "V1"] parent_config = while namespace.any? parent_name = namespace.join "::" parent_const = const_get parent_name break parent_const.configure if parent_const.respond_to? :configure namespace.pop end default_config = Client::Configuration.new parent_config default_config.rpcs.create_budget.timeout = 60.0 default_config.rpcs.update_budget.timeout = 60.0 default_config.rpcs.update_budget.retry_policy = { initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [4, 14] } default_config.rpcs.get_budget.timeout = 60.0 default_config.rpcs.get_budget.retry_policy = { initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [4, 14] } default_config.rpcs.list_budgets.timeout = 60.0 default_config.rpcs.list_budgets.retry_policy = { initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [4, 14] } default_config.rpcs.delete_budget.timeout = 60.0 default_config.rpcs.delete_budget.retry_policy = { initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [4, 14] } default_config end yield @configure if block_given? @configure end |
Instance Method Details
#configure {|config| ... } ⇒ Client::Configuration
Configure the BudgetService Client instance.
The configuration is set to the derived mode, meaning that values can be changed, but structural changes (adding new fields, etc.) are not allowed. Structural changes should be made on configure.
See for a description of the configuration fields.
112 113 114 115 |
# File 'lib/google/cloud/billing/budgets/v1/budget_service/client.rb', line 112 def configure yield @config if block_given? @config end |
#create_budget(request, options = nil) ⇒ ::Google::Cloud::Billing::Budgets::V1::Budget #create_budget(parent: nil, budget: nil) ⇒ ::Google::Cloud::Billing::Budgets::V1::Budget
Creates a new budget. See Quotas and limits for more information on the limits of the number of budgets you can create.
221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 |
# File 'lib/google/cloud/billing/budgets/v1/budget_service/client.rb', line 221 def create_budget request, = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Billing::Budgets::V1::CreateBudgetRequest # Converts hash and nil to an options object = ::Gapic::CallOptions.new(**.to_h) if .respond_to? :to_h # Customize the options with defaults = @config.rpcs.create_budget..to_h # Set x-goog-api-client and x-goog-user-project headers [:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::Billing::Budgets::V1::VERSION [:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = {} if request.parent header_params["parent"] = request.parent end request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&") [:"x-goog-request-params"] ||= request_params_header .apply_defaults timeout: @config.rpcs.create_budget.timeout, metadata: , retry_policy: @config.rpcs.create_budget.retry_policy .apply_defaults timeout: @config.timeout, metadata: @config., retry_policy: @config.retry_policy @budget_service_stub.call_rpc :create_budget, request, options: do |response, operation| yield response, operation if block_given? return response end rescue ::GRPC::BadStatus => e raise ::Google::Cloud::Error.from_error(e) end |
#delete_budget(request, options = nil) ⇒ ::Google::Protobuf::Empty #delete_budget(name: nil) ⇒ ::Google::Protobuf::Empty
Deletes a budget. Returns successfully if already deleted.
605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 |
# File 'lib/google/cloud/billing/budgets/v1/budget_service/client.rb', line 605 def delete_budget request, = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Billing::Budgets::V1::DeleteBudgetRequest # Converts hash and nil to an options object = ::Gapic::CallOptions.new(**.to_h) if .respond_to? :to_h # Customize the options with defaults = @config.rpcs.delete_budget..to_h # Set x-goog-api-client and x-goog-user-project headers [:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::Billing::Budgets::V1::VERSION [:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = {} if request.name header_params["name"] = request.name end request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&") [:"x-goog-request-params"] ||= request_params_header .apply_defaults timeout: @config.rpcs.delete_budget.timeout, metadata: , retry_policy: @config.rpcs.delete_budget.retry_policy .apply_defaults timeout: @config.timeout, metadata: @config., retry_policy: @config.retry_policy @budget_service_stub.call_rpc :delete_budget, request, options: do |response, operation| yield response, operation if block_given? return response end rescue ::GRPC::BadStatus => e raise ::Google::Cloud::Error.from_error(e) end |
#get_budget(request, options = nil) ⇒ ::Google::Cloud::Billing::Budgets::V1::Budget #get_budget(name: nil) ⇒ ::Google::Cloud::Billing::Budgets::V1::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.
409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 |
# File 'lib/google/cloud/billing/budgets/v1/budget_service/client.rb', line 409 def get_budget request, = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Billing::Budgets::V1::GetBudgetRequest # Converts hash and nil to an options object = ::Gapic::CallOptions.new(**.to_h) if .respond_to? :to_h # Customize the options with defaults = @config.rpcs.get_budget..to_h # Set x-goog-api-client and x-goog-user-project headers [:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::Billing::Budgets::V1::VERSION [:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = {} if request.name header_params["name"] = request.name end request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&") [:"x-goog-request-params"] ||= request_params_header .apply_defaults timeout: @config.rpcs.get_budget.timeout, metadata: , retry_policy: @config.rpcs.get_budget.retry_policy .apply_defaults timeout: @config.timeout, metadata: @config., retry_policy: @config.retry_policy @budget_service_stub.call_rpc :get_budget, request, options: do |response, operation| yield response, operation if block_given? return response end rescue ::GRPC::BadStatus => e raise ::Google::Cloud::Error.from_error(e) end |
#list_budgets(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Billing::Budgets::V1::Budget> #list_budgets(parent: nil, scope: nil, page_size: nil, page_token: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Billing::Budgets::V1::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.
518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 |
# File 'lib/google/cloud/billing/budgets/v1/budget_service/client.rb', line 518 def list_budgets request, = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Billing::Budgets::V1::ListBudgetsRequest # Converts hash and nil to an options object = ::Gapic::CallOptions.new(**.to_h) if .respond_to? :to_h # Customize the options with defaults = @config.rpcs.list_budgets..to_h # Set x-goog-api-client and x-goog-user-project headers [:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::Billing::Budgets::V1::VERSION [:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = {} if request.parent header_params["parent"] = request.parent end request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&") [:"x-goog-request-params"] ||= request_params_header .apply_defaults timeout: @config.rpcs.list_budgets.timeout, metadata: , retry_policy: @config.rpcs.list_budgets.retry_policy .apply_defaults timeout: @config.timeout, metadata: @config., retry_policy: @config.retry_policy @budget_service_stub.call_rpc :list_budgets, request, options: do |response, operation| response = ::Gapic::PagedEnumerable.new @budget_service_stub, :list_budgets, request, response, operation, yield response, operation if block_given? return response end rescue ::GRPC::BadStatus => e raise ::Google::Cloud::Error.from_error(e) end |
#update_budget(request, options = nil) ⇒ ::Google::Cloud::Billing::Budgets::V1::Budget #update_budget(budget: nil, update_mask: nil) ⇒ ::Google::Cloud::Billing::Budgets::V1::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.
318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 |
# File 'lib/google/cloud/billing/budgets/v1/budget_service/client.rb', line 318 def update_budget request, = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Billing::Budgets::V1::UpdateBudgetRequest # Converts hash and nil to an options object = ::Gapic::CallOptions.new(**.to_h) if .respond_to? :to_h # Customize the options with defaults = @config.rpcs.update_budget..to_h # Set x-goog-api-client and x-goog-user-project headers [:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::Billing::Budgets::V1::VERSION [:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = {} if request.budget&.name header_params["budget.name"] = request.budget.name end request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&") [:"x-goog-request-params"] ||= request_params_header .apply_defaults timeout: @config.rpcs.update_budget.timeout, metadata: , retry_policy: @config.rpcs.update_budget.retry_policy .apply_defaults timeout: @config.timeout, metadata: @config., retry_policy: @config.retry_policy @budget_service_stub.call_rpc :update_budget, request, options: do |response, operation| yield response, operation if block_given? return response end rescue ::GRPC::BadStatus => e raise ::Google::Cloud::Error.from_error(e) end |