Class: Google::Cloud::Billing::Budgets::V1beta1::BudgetService::Client

Inherits:
Object
  • Object
show all
Includes:
Paths
Defined in:
lib/google/cloud/billing/budgets/v1beta1/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

Instance Method Summary collapse

Methods included from Paths

#billing_account_path, #budget_path

Constructor Details

#initialize {|config| ... } ⇒ Client

Create a new BudgetService client object.

Examples:


# Create a client using the default configuration
client = ::Google::Cloud::Billing::Budgets::V1beta1::BudgetService::Client.new

# Create a client using a custom configuration
client = ::Google::Cloud::Billing::Budgets::V1beta1::BudgetService::Client.new do |config|
  config.timeout = 10.0
end

Yields:

  • (config) —

    Configure the BudgetService client.

Yield Parameters:



148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
 
# File 'lib/google/cloud/billing/budgets/v1beta1/budget_service/client.rb', line 148

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/v1beta1/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.nil? ||
                           (@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::V1beta1::BudgetService::Stub,
    credentials: credentials,
    endpoint: @config.endpoint,
    endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
    universe_domain: @config.universe_domain,
    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 Configuration for a description of the configuration fields.

Examples:


# Modify the configuration for all BudgetService clients
::Google::Cloud::Billing::Budgets::V1beta1::BudgetService::Client.configure do |config|
  config.timeout = 10.0
end

Yields:

  • (config) —

    Configure the Client client.

Yield Parameters:

Returns:



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
96
97
98
99
100
101
 
# File 'lib/google/cloud/billing/budgets/v1beta1/budget_service/client.rb', line 64

def self.configure
  @configure ||= begin
    namespace = ["Google", "Cloud", "Billing", "Budgets", "V1beta1"]
    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 Configuration for a description of the configuration fields.

Yields:

  • (config) —

    Configure the Client client.

Yield Parameters:

Returns:



118
119
120
121
 
# File 'lib/google/cloud/billing/budgets/v1beta1/budget_service/client.rb', line 118

def configure
  yield @config if block_given?
  @config
end

#create_budget(request, options = nil) ⇒ ::Google::Cloud::Billing::Budgets::V1beta1::Budget #create_budget(parent: nil, budget: nil) ⇒ ::Google::Cloud::Billing::Budgets::V1beta1::Budget

Creates a new budget. See Quotas and limits for more information on the limits of the number of budgets you can create.

Examples:

Basic example

require "google/cloud/billing/budgets/v1beta1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Billing::Budgets::V1beta1::BudgetService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Billing::Budgets::V1beta1::CreateBudgetRequest.new

# Call the create_budget method.
result = client.create_budget request

# The returned object is of type Google::Cloud::Billing::Budgets::V1beta1::Budget.
p result

Overloads:

  • #create_budget(request, options = nil) ⇒ ::Google::Cloud::Billing::Budgets::V1beta1::Budget

    Pass arguments to create_budget via a request object, either of type CreateBudgetRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Billing::Budgets::V1beta1::CreateBudgetRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #create_budget(parent: nil, budget: nil) ⇒ ::Google::Cloud::Billing::Budgets::V1beta1::Budget

    Pass arguments to create_budget via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • parent (::String) (defaults to: nil) —

      Required. The name of the billing account to create the budget in. Values are of the form billingAccounts/{billingAccountId}.

    • budget (::Google::Cloud::Billing::Budgets::V1beta1::Budget, ::Hash) (defaults to: nil) —

      Required. Budget to create.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
 
# File 'lib/google/cloud/billing/budgets/v1beta1/budget_service/client.rb', line 239

def create_budget request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Billing::Budgets::V1beta1::CreateBudgetRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.create_budget.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  metadata[:"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::V1beta1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"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("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.create_budget.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.create_budget.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @budget_service_stub.call_rpc :create_budget, request, options: 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.

Examples:

Basic example

require "google/cloud/billing/budgets/v1beta1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Billing::Budgets::V1beta1::BudgetService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Billing::Budgets::V1beta1::DeleteBudgetRequest.new

# Call the delete_budget method.
result = client.delete_budget request

# The returned object is of type Google::Protobuf::Empty.
p result

Overloads:

  • #delete_budget(request, options = nil) ⇒ ::Google::Protobuf::Empty

    Pass arguments to delete_budget via a request object, either of type DeleteBudgetRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Billing::Budgets::V1beta1::DeleteBudgetRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #delete_budget(name: nil) ⇒ ::Google::Protobuf::Empty

    Pass arguments to delete_budget via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • name (::String) (defaults to: nil) —

      Required. Name of the budget to delete. Values are of the form billingAccounts/{billingAccountId}/budgets/{budgetId}.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
 
# File 'lib/google/cloud/billing/budgets/v1beta1/budget_service/client.rb', line 627

def delete_budget request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Billing::Budgets::V1beta1::DeleteBudgetRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.delete_budget.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  metadata[:"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::V1beta1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"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("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.delete_budget.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.delete_budget.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @budget_service_stub.call_rpc :delete_budget, request, options: 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::V1beta1::Budget #get_budget(name: nil) ⇒ ::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.

Examples:

Basic example

require "google/cloud/billing/budgets/v1beta1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Billing::Budgets::V1beta1::BudgetService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Billing::Budgets::V1beta1::GetBudgetRequest.new

# Call the get_budget method.
result = client.get_budget request

# The returned object is of type Google::Cloud::Billing::Budgets::V1beta1::Budget.
p result

Overloads:

  • #get_budget(request, options = nil) ⇒ ::Google::Cloud::Billing::Budgets::V1beta1::Budget

    Pass arguments to get_budget via a request object, either of type GetBudgetRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Billing::Budgets::V1beta1::GetBudgetRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #get_budget(name: nil) ⇒ ::Google::Cloud::Billing::Budgets::V1beta1::Budget

    Pass arguments to get_budget via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • name (::String) (defaults to: nil) —

      Required. Name of budget to get. Values are of the form billingAccounts/{billingAccountId}/budgets/{budgetId}.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
 
# File 'lib/google/cloud/billing/budgets/v1beta1/budget_service/client.rb', line 429

def get_budget request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Billing::Budgets::V1beta1::GetBudgetRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.get_budget.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  metadata[:"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::V1beta1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"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("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.get_budget.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.get_budget.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @budget_service_stub.call_rpc :get_budget, request, options: 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::V1beta1::Budget> #list_budgets(parent: nil, scope: nil, page_size: nil, page_token: nil) ⇒ ::Gapic::PagedEnumerable<::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.

Examples:

Basic example

require "google/cloud/billing/budgets/v1beta1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Billing::Budgets::V1beta1::BudgetService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Billing::Budgets::V1beta1::ListBudgetsRequest.new

# Call the list_budgets method.
result = client.list_budgets request

# The returned object is of type Gapic::PagedEnumerable. You can iterate
# over elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Cloud::Billing::Budgets::V1beta1::Budget.
  p item
end

Overloads:

  • #list_budgets(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Billing::Budgets::V1beta1::Budget>

    Pass arguments to list_budgets via a request object, either of type ListBudgetsRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Billing::Budgets::V1beta1::ListBudgetsRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #list_budgets(parent: nil, scope: nil, page_size: nil, page_token: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Billing::Budgets::V1beta1::Budget>

    Pass arguments to list_budgets via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • parent (::String) (defaults to: nil) —

      Required. Name of billing account to list budgets under. Values are of the form billingAccounts/{billingAccountId}.

    • scope (::String) (defaults to: nil) —

      Optional. Set the scope of the budgets to be returned, in the format of the resource name. The scope of a budget is the cost that it tracks, such as costs for a single project, or the costs for all projects in a folder. Only project scope (in the format of "projects/project-id" or "projects/123") is supported in this field. When this field is set to a project's resource name, the budgets returned are tracking the costs for that project.

    • page_size (::Integer) (defaults to: nil) —

      Optional. The maximum number of budgets to return per page. The default and maximum value are 100.

    • page_token (::String) (defaults to: nil) —

      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.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
 
# File 'lib/google/cloud/billing/budgets/v1beta1/budget_service/client.rb', line 539

def list_budgets request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Billing::Budgets::V1beta1::ListBudgetsRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.list_budgets.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  metadata[:"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::V1beta1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"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("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.list_budgets.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.list_budgets.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @budget_service_stub.call_rpc :list_budgets, request, options: options do |response, operation|
    response = ::Gapic::PagedEnumerable.new @budget_service_stub, :list_budgets, request, response, operation, options
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#universe_domain ⇒ String

The effective universe domain

Returns:

  • (String) 


128
129
130
 
# File 'lib/google/cloud/billing/budgets/v1beta1/budget_service/client.rb', line 128

def universe_domain
  @budget_service_stub.universe_domain
end

#update_budget(request, options = nil) ⇒ ::Google::Cloud::Billing::Budgets::V1beta1::Budget #update_budget(budget: nil, update_mask: nil) ⇒ ::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.

Examples:

Basic example

require "google/cloud/billing/budgets/v1beta1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Billing::Budgets::V1beta1::BudgetService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Billing::Budgets::V1beta1::UpdateBudgetRequest.new

# Call the update_budget method.
result = client.update_budget request

# The returned object is of type Google::Cloud::Billing::Budgets::V1beta1::Budget.
p result

Overloads:

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
 
# File 'lib/google/cloud/billing/budgets/v1beta1/budget_service/client.rb', line 337

def update_budget request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Billing::Budgets::V1beta1::UpdateBudgetRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.update_budget.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  metadata[:"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::V1beta1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"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("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.update_budget.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.update_budget.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @budget_service_stub.call_rpc :update_budget, request, options: 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