google-cloud-billing-budgets-v1 0.5.0 → 0.7.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (8) hide show
  1. checksums.yaml +4 -4
  2. data/AUTHENTICATION.md +72 -101
  3. data/lib/google/cloud/billing/budgets/v1/budget_service/client.rb +41 -9
  4. data/lib/google/cloud/billing/budgets/v1/budget_service/rest/client.rb +117 -7
  5. data/lib/google/cloud/billing/budgets/v1/budget_service/rest/service_stub.rb +14 -2
  6. data/lib/google/cloud/billing/budgets/v1/version.rb +1 -1
  7. data/proto_docs/google/api/client.rb +14 -0
  8. metadata +5 -5
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: a4512fefdd2ce943efad9cab9d454c64b20599c539fc9ad123313c2d4566d250
4
- data.tar.gz: 3f6b8ff259645c2128ac0a84b995e862ef417134397a0d13d6237cd6682a0c69
3
+ metadata.gz: 18f327719955d7847786d40c42e1a98b3edce809aadaa419d9a5035ca8f72193
4
+ data.tar.gz: bcecf9ec1f006adc50b450a53c7379185aba1aeb164668068e6531d2507c9cb3
5
5
  SHA512:
6
- metadata.gz: 82cdeb2eaa09185644b797d58e99197504c78d1d371f10d730e95d74ac7cec6685cfc47f03ca90ea346b1f9119d2d837804ac0593a08bda64fe9081188b5536e
7
- data.tar.gz: e0364409586073eca080fb56986b24cd4c08949ccd1a6819f6567d227674863ce376dfbf74a888cdf012aad494ae4cb9204768c0e7be0c74be6ce28c36e6675d
6
+ metadata.gz: 7c3826e61bf585bab8d9793c1015cfffb431f6efe7b428788b8c2cf8e782887f3115f0491e6925f180a56e85f4bff99b206d4a9413f0b176528b9fc2e0a8b4c2
7
+ data.tar.gz: 3ac704ca4135c8bb58dca01fe90bbbc0bbd0668ce48bc1d7bd2176659b1ebc410b92abd8ce1db838b22cd7725e2749271896c5e4e7603590d66525cc5c61bd21
data/AUTHENTICATION.md CHANGED
@@ -1,151 +1,122 @@
1
1
  # Authentication
2
2
 
3
- In general, the google-cloud-billing-budgets-v1 library uses
4
- [Service Account](https://cloud.google.com/iam/docs/creating-managing-service-accounts)
5
- credentials to connect to Google Cloud services. When running within
6
- [Google Cloud Platform environments](#google-cloud-platform-environments) the
7
- credentials will be discovered automatically. When running on other
8
- environments, the Service Account credentials can be specified by providing the
9
- path to the
10
- [JSON keyfile](https://cloud.google.com/iam/docs/managing-service-account-keys)
11
- for the account (or the JSON itself) in
12
- [environment variables](#environment-variables). Additionally, Cloud SDK
13
- credentials can also be discovered automatically, but this is only recommended
14
- during development.
3
+ The recommended way to authenticate to the google-cloud-billing-budgets-v1 library is to use
4
+ [Application Default Credentials (ADC)](https://cloud.google.com/docs/authentication/application-default-credentials).
5
+ To review all of your authentication options, see [Credentials lookup](#credential-lookup).
15
6
 
16
7
  ## Quickstart
17
8
 
18
- 1. [Create a service account and credentials](#creating-a-service-account).
19
- 2. Set the [environment variable](#environment-variables).
9
+ The following example shows how to set up authentication for a local development
10
+ environment with your user credentials.
20
11
 
21
- ```sh
22
- export BILLING_BUDGETS_CREDENTIALS=path/to/keyfile.json
23
- ```
24
-
25
- 3. Initialize the client.
12
+ **NOTE:** This method is _not_ recommended for running in production. User credentials
13
+ should be used only during development.
26
14
 
27
- ```ruby
28
- require "google/cloud/billing/budgets/v1"
15
+ 1. [Download and install the Google Cloud CLI](https://cloud.google.com/sdk).
16
+ 2. Set up a local ADC file with your user credentials:
29
17
 
30
- client = ::Google::Cloud::Billing::Budgets::V1::BudgetService::Client.new
18
+ ```sh
19
+ gcloud auth application-default login
31
20
  ```
32
21
 
33
- ## Credential Lookup
34
-
35
- The google-cloud-billing-budgets-v1 library aims to make authentication
36
- as simple as possible, and provides several mechanisms to configure your system
37
- without requiring **Service Account Credentials** directly in code.
38
-
39
- **Credentials** are discovered in the following order:
40
-
41
- 1. Specify credentials in method arguments
42
- 2. Specify credentials in configuration
43
- 3. Discover credentials path in environment variables
44
- 4. Discover credentials JSON in environment variables
45
- 5. Discover credentials file in the Cloud SDK's path
46
- 6. Discover GCP credentials
47
-
48
- ### Google Cloud Platform environments
22
+ 3. Write code as if already authenticated.
49
23
 
50
- When running on Google Cloud Platform (GCP), including Google Compute Engine
51
- (GCE), Google Kubernetes Engine (GKE), Google App Engine (GAE), Google Cloud
52
- Functions (GCF) and Cloud Run, **Credentials** are discovered automatically.
53
- Code should be written as if already authenticated.
24
+ For more information about setting up authentication for a local development environment, see
25
+ [Set up Application Default Credentials](https://cloud.google.com/docs/authentication/provide-credentials-adc#local-dev).
54
26
 
55
- ### Environment Variables
27
+ ## Credential Lookup
56
28
 
57
- The **Credentials JSON** can be placed in environment variables instead of
58
- declaring them directly in code. Each service has its own environment variable,
59
- allowing for different service accounts to be used for different services. (See
60
- the READMEs for the individual service gems for details.) The path to the
61
- **Credentials JSON** file can be stored in the environment variable, or the
62
- **Credentials JSON** itself can be stored for environments such as Docker
63
- containers where writing files is difficult or not encouraged.
29
+ The google-cloud-billing-budgets-v1 library provides several mechanisms to configure your system.
30
+ Generally, using Application Default Credentials to facilitate automatic
31
+ credentials discovery is the easist method. But if you need to explicitly specify
32
+ credentials, there are several methods available to you.
64
33
 
65
- The environment variables that google-cloud-billing-budgets-v1
66
- checks for credentials are configured on the service Credentials class (such as
67
- {::Google::Cloud::Billing::Budgets::V1::BudgetService::Credentials}):
34
+ Credentials are accepted in the following ways, in the following order or precedence:
68
35
 
69
- * `BILLING_BUDGETS_CREDENTIALS` - Path to JSON file, or JSON contents
70
- * `BILLING_BUDGETS_KEYFILE` - Path to JSON file, or JSON contents
71
- * `GOOGLE_CLOUD_CREDENTIALS` - Path to JSON file, or JSON contents
72
- * `GOOGLE_CLOUD_KEYFILE` - Path to JSON file, or JSON contents
73
- * `GOOGLE_APPLICATION_CREDENTIALS` - Path to JSON file
36
+ 1. Credentials specified in method arguments
37
+ 2. Credentials specified in configuration
38
+ 3. Credentials pointed to or included in environment variables
39
+ 4. Credentials found in local ADC file
40
+ 5. Credentials returned by the metadata server for the attached service account (GCP)
74
41
 
75
- ```ruby
76
- require "google/cloud/billing/budgets/v1"
77
-
78
- ENV["BILLING_BUDGETS_CREDENTIALS"] = "path/to/keyfile.json"
42
+ ### Configuration
79
43
 
80
- client = ::Google::Cloud::Billing::Budgets::V1::BudgetService::Client.new
81
- ```
44
+ You can configure a path to a JSON credentials file, either for an individual client object or
45
+ globally, for all client objects. The JSON file can contain credentials created for
46
+ [workload identity federation](https://cloud.google.com/iam/docs/workload-identity-federation),
47
+ [workforce identity federation](https://cloud.google.com/iam/docs/workforce-identity-federation), or a
48
+ [service account key](https://cloud.google.com/docs/authentication/provide-credentials-adc#local-key).
82
49
 
83
- ### Configuration
50
+ Note: Service account keys are a security risk if not managed correctly. You should
51
+ [choose a more secure alternative to service account keys](https://cloud.google.com/docs/authentication#auth-decision-tree)
52
+ whenever possible.
84
53
 
85
- The path to the **Credentials JSON** file can be configured instead of storing
86
- it in an environment variable. Either on an individual client initialization:
54
+ To configure a credentials file for an individual client initialization:
87
55
 
88
56
  ```ruby
89
57
  require "google/cloud/billing/budgets/v1"
90
58
 
91
59
  client = ::Google::Cloud::Billing::Budgets::V1::BudgetService::Client.new do |config|
92
- config.credentials = "path/to/keyfile.json"
60
+ config.credentials = "path/to/credentialfile.json"
93
61
  end
94
62
  ```
95
63
 
96
- Or globally for all clients:
64
+ To configure a credentials file globally for all clients:
97
65
 
98
66
  ```ruby
99
67
  require "google/cloud/billing/budgets/v1"
100
68
 
101
69
  ::Google::Cloud::Billing::Budgets::V1::BudgetService::Client.configure do |config|
102
- config.credentials = "path/to/keyfile.json"
70
+ config.credentials = "path/to/credentialfile.json"
103
71
  end
104
72
 
105
73
  client = ::Google::Cloud::Billing::Budgets::V1::BudgetService::Client.new
106
74
  ```
107
75
 
108
- ### Cloud SDK
76
+ ### Environment Variables
109
77
 
110
- This option allows for an easy way to authenticate during development. If
111
- credentials are not provided in code or in environment variables, then Cloud SDK
112
- credentials are discovered.
78
+ You can also use an environment variable to provide a JSON credentials file.
79
+ The environment variable can contain a path to the credentials file or, for
80
+ environments such as Docker containers where writing files is not encouraged,
81
+ you can include the credentials file itself.
113
82
 
114
- To configure your system for this, simply:
83
+ The JSON file can contain credentials created for
84
+ [workload identity federation](https://cloud.google.com/iam/docs/workload-identity-federation),
85
+ [workforce identity federation](https://cloud.google.com/iam/docs/workforce-identity-federation), or a
86
+ [service account key](https://cloud.google.com/docs/authentication/provide-credentials-adc#local-key).
115
87
 
116
- 1. [Download and install the Cloud SDK](https://cloud.google.com/sdk)
117
- 2. Authenticate using OAuth 2.0 `$ gcloud auth application-default login`
118
- 3. Write code as if already authenticated.
88
+ Note: Service account keys are a security risk if not managed correctly. You should
89
+ [choose a more secure alternative to service account keys](https://cloud.google.com/docs/authentication#auth-decision-tree)
90
+ whenever possible.
91
+
92
+ The environment variables that google-cloud-billing-budgets-v1
93
+ checks for credentials are:
119
94
 
120
- **NOTE:** This is _not_ recommended for running in production. The Cloud SDK
121
- *should* only be used during development.
95
+ * `GOOGLE_CLOUD_CREDENTIALS` - Path to JSON file, or JSON contents
96
+ * `GOOGLE_APPLICATION_CREDENTIALS` - Path to JSON file
122
97
 
123
- ## Creating a Service Account
98
+ ```ruby
99
+ require "google/cloud/billing/budgets/v1"
124
100
 
125
- Google Cloud requires **Service Account Credentials** to
126
- connect to the APIs. You will use the **JSON key file** to
127
- connect to most services with google-cloud-billing-budgets-v1.
101
+ ENV["GOOGLE_APPLICATION_CREDENTIALS"] = "path/to/credentialfile.json"
128
102
 
129
- If you are not running this client within
130
- [Google Cloud Platform environments](#google-cloud-platform-environments), you
131
- need a Google Developers service account.
103
+ client = ::Google::Cloud::Billing::Budgets::V1::BudgetService::Client.new
104
+ ```
132
105
 
133
- 1. Visit the [Google Cloud Console](https://console.cloud.google.com/project).
134
- 2. Create a new project or click on an existing project.
135
- 3. Activate the menu in the upper left and select **APIs & Services**. From
136
- here, you will enable the APIs that your application requires.
106
+ ### Local ADC file
137
107
 
138
- *Note: You may need to enable billing in order to use these services.*
108
+ You can set up a local ADC file with your user credentials for authentication during
109
+ development. If credentials are not provided in code or in environment variables,
110
+ then the local ADC credentials are discovered.
139
111
 
140
- 4. Select **Credentials** from the side navigation.
112
+ Follow the steps in [Quickstart](#quickstart) to set up a local ADC file.
141
113
 
142
- Find the "Create credentials" drop down near the top of the page, and select
143
- "Service account" to be guided through downloading a new JSON key file.
114
+ ### Google Cloud Platform environments
144
115
 
145
- If you want to re-use an existing service account, you can easily generate a
146
- new key file. Just select the account you wish to re-use, click the pencil
147
- tool on the right side to edit the service account, select the **Keys** tab,
148
- and then select **Add Key**.
116
+ When running on Google Cloud Platform (GCP), including Google Compute Engine
117
+ (GCE), Google Kubernetes Engine (GKE), Google App Engine (GAE), Google Cloud
118
+ Functions (GCF) and Cloud Run, credentials are retrieved from the attached
119
+ service account automatically. Code should be written as if already authenticated.
149
120
 
150
- The key file you download will be used by this library to authenticate API
151
- requests and should be stored in a secure location.
121
+ For more information, see
122
+ [Set up ADC for Google Cloud services](https://cloud.google.com/docs/authentication/provide-credentials-adc#attached-sa).
data/lib/google/cloud/billing/budgets/v1/budget_service/client.rb CHANGED
@@ -32,6 +32,9 @@ module Google
32
32
  # budget plan and rules to execute as we track spend against that plan.
33
33
  #
34
34
  class Client
35
+ # @private
36
+ DEFAULT_ENDPOINT_TEMPLATE = "billingbudgets.$UNIVERSE_DOMAIN$"
37
+
35
38
  include Paths
36
39
 
37
40
  # @private
@@ -114,6 +117,15 @@ module Google
114
117
  @config
115
118
  end
116
119
 
120
+ ##
121
+ # The effective universe domain
122
+ #
123
+ # @return [String]
124
+ #
125
+ def universe_domain
126
+ @budget_service_stub.universe_domain
127
+ end
128
+
117
129
  ##
118
130
  # Create a new BudgetService client object.
119
131
  #
@@ -147,8 +159,9 @@ module Google
147
159
  credentials = @config.credentials
148
160
  # Use self-signed JWT if the endpoint is unchanged from default,
149
161
  # but only if the default endpoint does not have a region prefix.
150
- enable_self_signed_jwt = @config.endpoint == Configuration::DEFAULT_ENDPOINT &&
151
- !@config.endpoint.split(".").first.include?("-")
162
+ enable_self_signed_jwt = @config.endpoint.nil? ||
163
+ (@config.endpoint == Configuration::DEFAULT_ENDPOINT &&
164
+ !@config.endpoint.split(".").first.include?("-"))
152
165
  credentials ||= Credentials.default scope: @config.scope,
153
166
  enable_self_signed_jwt: enable_self_signed_jwt
154
167
  if credentials.is_a?(::String) || credentials.is_a?(::Hash)
@@ -159,10 +172,13 @@ module Google
159
172
 
160
173
  @budget_service_stub = ::Gapic::ServiceStub.new(
161
174
  ::Google::Cloud::Billing::Budgets::V1::BudgetService::Stub,
162
- credentials: credentials,
163
- endpoint: @config.endpoint,
175
+ credentials: credentials,
176
+ endpoint: @config.endpoint,
177
+ endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
178
+ universe_domain: @config.universe_domain,
164
179
  channel_args: @config.channel_args,
165
- interceptors: @config.interceptors
180
+ interceptors: @config.interceptors,
181
+ channel_pool_config: @config.channel_pool
166
182
  )
167
183
  end
168
184
 
@@ -672,9 +688,9 @@ module Google
672
688
  # end
673
689
  #
674
690
  # @!attribute [rw] endpoint
675
- # The hostname or hostname:port of the service endpoint.
676
- # Defaults to `"billingbudgets.googleapis.com"`.
677
- # @return [::String]
691
+ # A custom service endpoint, as a hostname or hostname:port. The default is
692
+ # nil, indicating to use the default endpoint in the current universe domain.
693
+ # @return [::String,nil]
678
694
  # @!attribute [rw] credentials
679
695
  # Credentials to send with calls. You may provide any of the following types:
680
696
  # * (`String`) The path to a service account key file in JSON format
@@ -720,13 +736,20 @@ module Google
720
736
  # @!attribute [rw] quota_project
721
737
  # A separate project against which to charge quota.
722
738
  # @return [::String]
739
+ # @!attribute [rw] universe_domain
740
+ # The universe domain within which to make requests. This determines the
741
+ # default endpoint URL. The default value of nil uses the environment
742
+ # universe (usually the default "googleapis.com" universe).
743
+ # @return [::String,nil]
723
744
  #
724
745
  class Configuration
725
746
  extend ::Gapic::Config
726
747
 
748
+ # @private
749
+ # The endpoint specific to the default "googleapis.com" universe. Deprecated.
727
750
  DEFAULT_ENDPOINT = "billingbudgets.googleapis.com"
728
751
 
729
- config_attr :endpoint, DEFAULT_ENDPOINT, ::String
752
+ config_attr :endpoint, nil, ::String, nil
730
753
  config_attr :credentials, nil do |value|
731
754
  allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
732
755
  allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
@@ -741,6 +764,7 @@ module Google
741
764
  config_attr :metadata, nil, ::Hash, nil
742
765
  config_attr :retry_policy, nil, ::Hash, ::Proc, nil
743
766
  config_attr :quota_project, nil, ::String, nil
767
+ config_attr :universe_domain, nil, ::String, nil
744
768
 
745
769
  # @private
746
770
  def initialize parent_config = nil
@@ -761,6 +785,14 @@ module Google
761
785
  end
762
786
  end
763
787
 
788
+ ##
789
+ # Configuration for the channel pool
790
+ # @return [::Gapic::ServiceStub::ChannelPool::Configuration]
791
+ #
792
+ def channel_pool
793
+ @channel_pool ||= ::Gapic::ServiceStub::ChannelPool::Configuration.new
794
+ end
795
+
764
796
  ##
765
797
  # Configuration RPC class for the BudgetService API.
766
798
  #
data/lib/google/cloud/billing/budgets/v1/budget_service/rest/client.rb CHANGED
@@ -34,6 +34,9 @@ module Google
34
34
  # budget plan and rules to execute as we track spend against that plan.
35
35
  #
36
36
  class Client
37
+ # @private
38
+ DEFAULT_ENDPOINT_TEMPLATE = "billingbudgets.$UNIVERSE_DOMAIN$"
39
+
37
40
  include Paths
38
41
 
39
42
  # @private
@@ -116,6 +119,15 @@ module Google
116
119
  @config
117
120
  end
118
121
 
122
+ ##
123
+ # The effective universe domain
124
+ #
125
+ # @return [String]
126
+ #
127
+ def universe_domain
128
+ @budget_service_stub.universe_domain
129
+ end
130
+
119
131
  ##
120
132
  # Create a new BudgetService REST client object.
121
133
  #
@@ -143,8 +155,9 @@ module Google
143
155
  credentials = @config.credentials
144
156
  # Use self-signed JWT if the endpoint is unchanged from default,
145
157
  # but only if the default endpoint does not have a region prefix.
146
- enable_self_signed_jwt = @config.endpoint == Configuration::DEFAULT_ENDPOINT &&
147
- !@config.endpoint.split(".").first.include?("-")
158
+ enable_self_signed_jwt = @config.endpoint.nil? ||
159
+ (@config.endpoint == Configuration::DEFAULT_ENDPOINT &&
160
+ !@config.endpoint.split(".").first.include?("-"))
148
161
  credentials ||= Credentials.default scope: @config.scope,
149
162
  enable_self_signed_jwt: enable_self_signed_jwt
150
163
  if credentials.is_a?(::String) || credentials.is_a?(::Hash)
@@ -154,7 +167,12 @@ module Google
154
167
  @quota_project_id = @config.quota_project
155
168
  @quota_project_id ||= credentials.quota_project_id if credentials.respond_to? :quota_project_id
156
169
 
157
- @budget_service_stub = ::Google::Cloud::Billing::Budgets::V1::BudgetService::Rest::ServiceStub.new endpoint: @config.endpoint, credentials: credentials
170
+ @budget_service_stub = ::Google::Cloud::Billing::Budgets::V1::BudgetService::Rest::ServiceStub.new(
171
+ endpoint: @config.endpoint,
172
+ endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
173
+ universe_domain: @config.universe_domain,
174
+ credentials: credentials
175
+ )
158
176
  end
159
177
 
160
178
  # Service calls
@@ -191,6 +209,22 @@ module Google
191
209
  # @return [::Google::Cloud::Billing::Budgets::V1::Budget]
192
210
  #
193
211
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
212
+ #
213
+ # @example Basic example
214
+ # require "google/cloud/billing/budgets/v1"
215
+ #
216
+ # # Create a client object. The client can be reused for multiple calls.
217
+ # client = Google::Cloud::Billing::Budgets::V1::BudgetService::Rest::Client.new
218
+ #
219
+ # # Create a request. To set request fields, pass in keyword arguments.
220
+ # request = Google::Cloud::Billing::Budgets::V1::CreateBudgetRequest.new
221
+ #
222
+ # # Call the create_budget method.
223
+ # result = client.create_budget request
224
+ #
225
+ # # The returned object is of type Google::Cloud::Billing::Budgets::V1::Budget.
226
+ # p result
227
+ #
194
228
  def create_budget request, options = nil
195
229
  raise ::ArgumentError, "request must be provided" if request.nil?
196
230
 
@@ -265,6 +299,22 @@ module Google
265
299
  # @return [::Google::Cloud::Billing::Budgets::V1::Budget]
266
300
  #
267
301
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
302
+ #
303
+ # @example Basic example
304
+ # require "google/cloud/billing/budgets/v1"
305
+ #
306
+ # # Create a client object. The client can be reused for multiple calls.
307
+ # client = Google::Cloud::Billing::Budgets::V1::BudgetService::Rest::Client.new
308
+ #
309
+ # # Create a request. To set request fields, pass in keyword arguments.
310
+ # request = Google::Cloud::Billing::Budgets::V1::UpdateBudgetRequest.new
311
+ #
312
+ # # Call the update_budget method.
313
+ # result = client.update_budget request
314
+ #
315
+ # # The returned object is of type Google::Cloud::Billing::Budgets::V1::Budget.
316
+ # p result
317
+ #
268
318
  def update_budget request, options = nil
269
319
  raise ::ArgumentError, "request must be provided" if request.nil?
270
320
 
@@ -333,6 +383,22 @@ module Google
333
383
  # @return [::Google::Cloud::Billing::Budgets::V1::Budget]
334
384
  #
335
385
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
386
+ #
387
+ # @example Basic example
388
+ # require "google/cloud/billing/budgets/v1"
389
+ #
390
+ # # Create a client object. The client can be reused for multiple calls.
391
+ # client = Google::Cloud::Billing::Budgets::V1::BudgetService::Rest::Client.new
392
+ #
393
+ # # Create a request. To set request fields, pass in keyword arguments.
394
+ # request = Google::Cloud::Billing::Budgets::V1::GetBudgetRequest.new
395
+ #
396
+ # # Call the get_budget method.
397
+ # result = client.get_budget request
398
+ #
399
+ # # The returned object is of type Google::Cloud::Billing::Budgets::V1::Budget.
400
+ # p result
401
+ #
336
402
  def get_budget request, options = nil
337
403
  raise ::ArgumentError, "request must be provided" if request.nil?
338
404
 
@@ -415,6 +481,26 @@ module Google
415
481
  # @return [::Gapic::Rest::PagedEnumerable<::Google::Cloud::Billing::Budgets::V1::Budget>]
416
482
  #
417
483
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
484
+ #
485
+ # @example Basic example
486
+ # require "google/cloud/billing/budgets/v1"
487
+ #
488
+ # # Create a client object. The client can be reused for multiple calls.
489
+ # client = Google::Cloud::Billing::Budgets::V1::BudgetService::Rest::Client.new
490
+ #
491
+ # # Create a request. To set request fields, pass in keyword arguments.
492
+ # request = Google::Cloud::Billing::Budgets::V1::ListBudgetsRequest.new
493
+ #
494
+ # # Call the list_budgets method.
495
+ # result = client.list_budgets request
496
+ #
497
+ # # The returned object is of type Gapic::PagedEnumerable. You can iterate
498
+ # # over elements, and API calls will be issued to fetch pages as needed.
499
+ # result.each do |item|
500
+ # # Each element is of type ::Google::Cloud::Billing::Budgets::V1::Budget.
501
+ # p item
502
+ # end
503
+ #
418
504
  def list_budgets request, options = nil
419
505
  raise ::ArgumentError, "request must be provided" if request.nil?
420
506
 
@@ -479,6 +565,22 @@ module Google
479
565
  # @return [::Google::Protobuf::Empty]
480
566
  #
481
567
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
568
+ #
569
+ # @example Basic example
570
+ # require "google/cloud/billing/budgets/v1"
571
+ #
572
+ # # Create a client object. The client can be reused for multiple calls.
573
+ # client = Google::Cloud::Billing::Budgets::V1::BudgetService::Rest::Client.new
574
+ #
575
+ # # Create a request. To set request fields, pass in keyword arguments.
576
+ # request = Google::Cloud::Billing::Budgets::V1::DeleteBudgetRequest.new
577
+ #
578
+ # # Call the delete_budget method.
579
+ # result = client.delete_budget request
580
+ #
581
+ # # The returned object is of type Google::Protobuf::Empty.
582
+ # p result
583
+ #
482
584
  def delete_budget request, options = nil
483
585
  raise ::ArgumentError, "request must be provided" if request.nil?
484
586
 
@@ -544,9 +646,9 @@ module Google
544
646
  # end
545
647
  #
546
648
  # @!attribute [rw] endpoint
547
- # The hostname or hostname:port of the service endpoint.
548
- # Defaults to `"billingbudgets.googleapis.com"`.
549
- # @return [::String]
649
+ # A custom service endpoint, as a hostname or hostname:port. The default is
650
+ # nil, indicating to use the default endpoint in the current universe domain.
651
+ # @return [::String,nil]
550
652
  # @!attribute [rw] credentials
551
653
  # Credentials to send with calls. You may provide any of the following types:
552
654
  # * (`String`) The path to a service account key file in JSON format
@@ -583,13 +685,20 @@ module Google
583
685
  # @!attribute [rw] quota_project
584
686
  # A separate project against which to charge quota.
585
687
  # @return [::String]
688
+ # @!attribute [rw] universe_domain
689
+ # The universe domain within which to make requests. This determines the
690
+ # default endpoint URL. The default value of nil uses the environment
691
+ # universe (usually the default "googleapis.com" universe).
692
+ # @return [::String,nil]
586
693
  #
587
694
  class Configuration
588
695
  extend ::Gapic::Config
589
696
 
697
+ # @private
698
+ # The endpoint specific to the default "googleapis.com" universe. Deprecated.
590
699
  DEFAULT_ENDPOINT = "billingbudgets.googleapis.com"
591
700
 
592
- config_attr :endpoint, DEFAULT_ENDPOINT, ::String
701
+ config_attr :endpoint, nil, ::String, nil
593
702
  config_attr :credentials, nil do |value|
594
703
  allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
595
704
  allowed.any? { |klass| klass === value }
@@ -601,6 +710,7 @@ module Google
601
710
  config_attr :metadata, nil, ::Hash, nil
602
711
  config_attr :retry_policy, nil, ::Hash, ::Proc, nil
603
712
  config_attr :quota_project, nil, ::String, nil
713
+ config_attr :universe_domain, nil, ::String, nil
604
714
 
605
715
  # @private
606
716
  def initialize parent_config = nil
data/lib/google/cloud/billing/budgets/v1/budget_service/rest/service_stub.rb CHANGED
@@ -31,16 +31,28 @@ module Google
31
31
  # including transcoding, making the REST call, and deserialing the response.
32
32
  #
33
33
  class ServiceStub
34
- def initialize endpoint:, credentials:
34
+ def initialize endpoint:, endpoint_template:, universe_domain:, credentials:
35
35
  # These require statements are intentionally placed here to initialize
36
36
  # the REST modules only when it's required.
37
37
  require "gapic/rest"
38
38
 
39
- @client_stub = ::Gapic::Rest::ClientStub.new endpoint: endpoint, credentials: credentials,
39
+ @client_stub = ::Gapic::Rest::ClientStub.new endpoint: endpoint,
40
+ endpoint_template: endpoint_template,
41
+ universe_domain: universe_domain,
42
+ credentials: credentials,
40
43
  numeric_enums: true,
41
44
  raise_faraday_errors: false
42
45
  end
43
46
 
47
+ ##
48
+ # The effective universe domain
49
+ #
50
+ # @return [String]
51
+ #
52
+ def universe_domain
53
+ @client_stub.universe_domain
54
+ end
55
+
44
56
  ##
45
57
  # Baseline implementation for the create_budget REST call
46
58
  #
data/lib/google/cloud/billing/budgets/v1/version.rb CHANGED
@@ -22,7 +22,7 @@ module Google
22
22
  module Billing
23
23
  module Budgets
24
24
  module V1
25
- VERSION = "0.5.0"
25
+ VERSION = "0.7.0"
26
26
  end
27
27
  end
28
28
  end
data/proto_docs/google/api/client.rb CHANGED
@@ -21,6 +21,7 @@ module Google
21
21
  module Api
22
22
  # Required information for every language.
23
23
  # @!attribute [rw] reference_docs_uri
24
+ # @deprecated This field is deprecated and may be removed in the next major version update.
24
25
  # @return [::String]
25
26
  # Link to automatically generated reference documentation. Example:
26
27
  # https://cloud.google.com/nodejs/docs/reference/asset/latest
@@ -304,6 +305,19 @@ module Google
304
305
  # seconds: 360 # 6 minutes
305
306
  # total_poll_timeout:
306
307
  # seconds: 54000 # 90 minutes
308
+ # @!attribute [rw] auto_populated_fields
309
+ # @return [::Array<::String>]
310
+ # List of top-level fields of the request message, that should be
311
+ # automatically populated by the client libraries based on their
312
+ # (google.api.field_info).format. Currently supported format: UUID4.
313
+ #
314
+ # Example of a YAML configuration:
315
+ #
316
+ # publishing:
317
+ # method_settings:
318
+ # - selector: google.example.v1.ExampleService.CreateExample
319
+ # auto_populated_fields:
320
+ # - request_id
307
321
  class MethodSettings
308
322
  include ::Google::Protobuf::MessageExts
309
323
  extend ::Google::Protobuf::MessageExts::ClassMethods
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: google-cloud-billing-budgets-v1
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.5.0
4
+ version: 0.7.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Google LLC
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2023-09-04 00:00:00.000000000 Z
11
+ date: 2024-01-11 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: gapic-common
@@ -16,7 +16,7 @@ dependencies:
16
16
  requirements:
17
17
  - - ">="
18
18
  - !ruby/object:Gem::Version
19
- version: 0.19.1
19
+ version: 0.21.1
20
20
  - - "<"
21
21
  - !ruby/object:Gem::Version
22
22
  version: 2.a
@@ -26,7 +26,7 @@ dependencies:
26
26
  requirements:
27
27
  - - ">="
28
28
  - !ruby/object:Gem::Version
29
- version: 0.19.1
29
+ version: 0.21.1
30
30
  - - "<"
31
31
  - !ruby/object:Gem::Version
32
32
  version: 2.a
@@ -215,7 +215,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
215
215
  - !ruby/object:Gem::Version
216
216
  version: '0'
217
217
  requirements: []
218
- rubygems_version: 3.4.19
218
+ rubygems_version: 3.5.3
219
219
  signing_key:
220
220
  specification_version: 4
221
221
  summary: The Cloud Billing Budget API stores Cloud Billing budgets, which define a