google-cloud-commerce-consumer-procurement-v1 0.1.0 → 0.3.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (11) hide show
  1. checksums.yaml +4 -4
  2. data/AUTHENTICATION.md +72 -99
  3. data/lib/google/cloud/commerce/consumer/procurement/v1/consumer_procurement_service/client.rb +42 -9
  4. data/lib/google/cloud/commerce/consumer/procurement/v1/consumer_procurement_service/operations.rb +38 -7
  5. data/lib/google/cloud/commerce/consumer/procurement/v1/consumer_procurement_service/rest/client.rb +93 -7
  6. data/lib/google/cloud/commerce/consumer/procurement/v1/consumer_procurement_service/rest/operations.rb +108 -8
  7. data/lib/google/cloud/commerce/consumer/procurement/v1/consumer_procurement_service/rest/service_stub.rb +14 -2
  8. data/lib/google/cloud/commerce/consumer/procurement/v1/version.rb +1 -1
  9. data/proto_docs/google/api/client.rb +14 -0
  10. data/proto_docs/google/api/field_behavior.rb +14 -0
  11. metadata +5 -5
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 6db8c67fabf11c3f6acfb8f108ba283ed63c6149569e000b9e3413fce7941ae4
4
- data.tar.gz: a320c3c5aa1473805a4a13ceeec3674deedd71306b9e08cd442598292c86796e
3
+ metadata.gz: 49b65de2f1b5d701cf83fd938650b4fac491afc3fb4abfd67c0ff9118a2548a0
4
+ data.tar.gz: 24dbe374e4b8f4eb6a88bb3a542f234d937430d1c8c5fdfc3c290732eebd4900
5
5
  SHA512:
6
- metadata.gz: 77d51aceda0ef8faeb7ba2cc19d6d5633d1c225a58df016c12f8db7917e6cde491e27fd2a05f4d27837ad29dd3d85529c8b1f6baab15af55fc64ef1db65688ad
7
- data.tar.gz: 71f8ecdd76f7a374e883ae07ea1aa60abfe1421de3980790dc70192eaf2f307829ee2a0cda02b2ca9c7875de83b703eacd367b76e7adecc69f9f15eefcb08c70
6
+ metadata.gz: 2e01936ddc1b90e18362ebbc01ce92c2f5b51398bbbee31f079785f29f251ab8a044dada5159c2a637b8730b4b9bdda048c75c98bc95195424f43683d83077a5
7
+ data.tar.gz: c62b2b0f53be27443219a681c7799091fad46d664e482bd018892b7d4eaf3dd4e68980c935906ca773d614eac2716271f2d70075330f6042429d1be9db467cbd
data/AUTHENTICATION.md CHANGED
@@ -1,149 +1,122 @@
1
1
  # Authentication
2
2
 
3
- In general, the google-cloud-commerce-consumer-procurement-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-commerce-consumer-procurement-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 GOOGLE_CLOUD_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/commerce/consumer/procurement/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::Commerce::Consumer::Procurement::V1::ConsumerProcurementService::Client.new
18
+ ```sh
19
+ gcloud auth application-default login
31
20
  ```
32
21
 
33
- ## Credential Lookup
34
-
35
- The google-cloud-commerce-consumer-procurement-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-commerce-consumer-procurement-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-commerce-consumer-procurement-v1
66
- checks for credentials are configured on the service Credentials class (such as
67
- {::Google::Cloud::Commerce::Consumer::Procurement::V1::ConsumerProcurementService::Credentials}):
34
+ Credentials are accepted in the following ways, in the following order or precedence:
68
35
 
69
- * `GOOGLE_CLOUD_CREDENTIALS` - Path to JSON file, or JSON contents
70
- * `GOOGLE_CLOUD_KEYFILE` - Path to JSON file, or JSON contents
71
- * `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)
72
41
 
73
- ```ruby
74
- require "google/cloud/commerce/consumer/procurement/v1"
75
-
76
- ENV["GOOGLE_CLOUD_CREDENTIALS"] = "path/to/keyfile.json"
42
+ ### Configuration
77
43
 
78
- client = ::Google::Cloud::Commerce::Consumer::Procurement::V1::ConsumerProcurementService::Client.new
79
- ```
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).
80
49
 
81
- ### 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.
82
53
 
83
- The path to the **Credentials JSON** file can be configured instead of storing
84
- it in an environment variable. Either on an individual client initialization:
54
+ To configure a credentials file for an individual client initialization:
85
55
 
86
56
  ```ruby
87
57
  require "google/cloud/commerce/consumer/procurement/v1"
88
58
 
89
59
  client = ::Google::Cloud::Commerce::Consumer::Procurement::V1::ConsumerProcurementService::Client.new do |config|
90
- config.credentials = "path/to/keyfile.json"
60
+ config.credentials = "path/to/credentialfile.json"
91
61
  end
92
62
  ```
93
63
 
94
- Or globally for all clients:
64
+ To configure a credentials file globally for all clients:
95
65
 
96
66
  ```ruby
97
67
  require "google/cloud/commerce/consumer/procurement/v1"
98
68
 
99
69
  ::Google::Cloud::Commerce::Consumer::Procurement::V1::ConsumerProcurementService::Client.configure do |config|
100
- config.credentials = "path/to/keyfile.json"
70
+ config.credentials = "path/to/credentialfile.json"
101
71
  end
102
72
 
103
73
  client = ::Google::Cloud::Commerce::Consumer::Procurement::V1::ConsumerProcurementService::Client.new
104
74
  ```
105
75
 
106
- ### Cloud SDK
76
+ ### Environment Variables
107
77
 
108
- This option allows for an easy way to authenticate during development. If
109
- credentials are not provided in code or in environment variables, then Cloud SDK
110
- 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.
111
82
 
112
- 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).
113
87
 
114
- 1. [Download and install the Cloud SDK](https://cloud.google.com/sdk)
115
- 2. Authenticate using OAuth 2.0 `$ gcloud auth application-default login`
116
- 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-commerce-consumer-procurement-v1
93
+ checks for credentials are:
117
94
 
118
- **NOTE:** This is _not_ recommended for running in production. The Cloud SDK
119
- *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
120
97
 
121
- ## Creating a Service Account
98
+ ```ruby
99
+ require "google/cloud/commerce/consumer/procurement/v1"
122
100
 
123
- Google Cloud requires **Service Account Credentials** to
124
- connect to the APIs. You will use the **JSON key file** to
125
- connect to most services with google-cloud-commerce-consumer-procurement-v1.
101
+ ENV["GOOGLE_APPLICATION_CREDENTIALS"] = "path/to/credentialfile.json"
126
102
 
127
- If you are not running this client within
128
- [Google Cloud Platform environments](#google-cloud-platform-environments), you
129
- need a Google Developers service account.
103
+ client = ::Google::Cloud::Commerce::Consumer::Procurement::V1::ConsumerProcurementService::Client.new
104
+ ```
130
105
 
131
- 1. Visit the [Google Cloud Console](https://console.cloud.google.com/project).
132
- 2. Create a new project or click on an existing project.
133
- 3. Activate the menu in the upper left and select **APIs & Services**. From
134
- here, you will enable the APIs that your application requires.
106
+ ### Local ADC file
135
107
 
136
- *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.
137
111
 
138
- 4. Select **Credentials** from the side navigation.
112
+ Follow the steps in [Quickstart](#quickstart) to set up a local ADC file.
139
113
 
140
- Find the "Create credentials" drop down near the top of the page, and select
141
- "Service account" to be guided through downloading a new JSON key file.
114
+ ### Google Cloud Platform environments
142
115
 
143
- If you want to re-use an existing service account, you can easily generate a
144
- new key file. Just select the account you wish to re-use, click the pencil
145
- tool on the right side to edit the service account, select the **Keys** tab,
146
- 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.
147
120
 
148
- The key file you download will be used by this library to authenticate API
149
- 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/commerce/consumer/procurement/v1/consumer_procurement_service/client.rb CHANGED
@@ -40,6 +40,9 @@ module Google
40
40
  # for charging for the procured item.
41
41
  #
42
42
  class Client
43
+ # @private
44
+ DEFAULT_ENDPOINT_TEMPLATE = "cloudcommerceconsumerprocurement.$UNIVERSE_DOMAIN$"
45
+
43
46
  include Paths
44
47
 
45
48
  # @private
@@ -112,6 +115,15 @@ module Google
112
115
  @config
113
116
  end
114
117
 
118
+ ##
119
+ # The effective universe domain
120
+ #
121
+ # @return [String]
122
+ #
123
+ def universe_domain
124
+ @consumer_procurement_service_stub.universe_domain
125
+ end
126
+
115
127
  ##
116
128
  # Create a new ConsumerProcurementService client object.
117
129
  #
@@ -145,8 +157,9 @@ module Google
145
157
  credentials = @config.credentials
146
158
  # Use self-signed JWT if the endpoint is unchanged from default,
147
159
  # but only if the default endpoint does not have a region prefix.
148
- enable_self_signed_jwt = @config.endpoint == Configuration::DEFAULT_ENDPOINT &&
149
- !@config.endpoint.split(".").first.include?("-")
160
+ enable_self_signed_jwt = @config.endpoint.nil? ||
161
+ (@config.endpoint == Configuration::DEFAULT_ENDPOINT &&
162
+ !@config.endpoint.split(".").first.include?("-"))
150
163
  credentials ||= Credentials.default scope: @config.scope,
151
164
  enable_self_signed_jwt: enable_self_signed_jwt
152
165
  if credentials.is_a?(::String) || credentials.is_a?(::Hash)
@@ -159,14 +172,18 @@ module Google
159
172
  config.credentials = credentials
160
173
  config.quota_project = @quota_project_id
161
174
  config.endpoint = @config.endpoint
175
+ config.universe_domain = @config.universe_domain
162
176
  end
163
177
 
164
178
  @consumer_procurement_service_stub = ::Gapic::ServiceStub.new(
165
179
  ::Google::Cloud::Commerce::Consumer::Procurement::V1::ConsumerProcurementService::Stub,
166
- credentials: credentials,
167
- endpoint: @config.endpoint,
180
+ credentials: credentials,
181
+ endpoint: @config.endpoint,
182
+ endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
183
+ universe_domain: @config.universe_domain,
168
184
  channel_args: @config.channel_args,
169
- interceptors: @config.interceptors
185
+ interceptors: @config.interceptors,
186
+ channel_pool_config: @config.channel_pool
170
187
  )
171
188
  end
172
189
 
@@ -525,9 +542,9 @@ module Google
525
542
  # end
526
543
  #
527
544
  # @!attribute [rw] endpoint
528
- # The hostname or hostname:port of the service endpoint.
529
- # Defaults to `"cloudcommerceconsumerprocurement.googleapis.com"`.
530
- # @return [::String]
545
+ # A custom service endpoint, as a hostname or hostname:port. The default is
546
+ # nil, indicating to use the default endpoint in the current universe domain.
547
+ # @return [::String,nil]
531
548
  # @!attribute [rw] credentials
532
549
  # Credentials to send with calls. You may provide any of the following types:
533
550
  # * (`String`) The path to a service account key file in JSON format
@@ -573,13 +590,20 @@ module Google
573
590
  # @!attribute [rw] quota_project
574
591
  # A separate project against which to charge quota.
575
592
  # @return [::String]
593
+ # @!attribute [rw] universe_domain
594
+ # The universe domain within which to make requests. This determines the
595
+ # default endpoint URL. The default value of nil uses the environment
596
+ # universe (usually the default "googleapis.com" universe).
597
+ # @return [::String,nil]
576
598
  #
577
599
  class Configuration
578
600
  extend ::Gapic::Config
579
601
 
602
+ # @private
603
+ # The endpoint specific to the default "googleapis.com" universe. Deprecated.
580
604
  DEFAULT_ENDPOINT = "cloudcommerceconsumerprocurement.googleapis.com"
581
605
 
582
- config_attr :endpoint, DEFAULT_ENDPOINT, ::String
606
+ config_attr :endpoint, nil, ::String, nil
583
607
  config_attr :credentials, nil do |value|
584
608
  allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
585
609
  allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
@@ -594,6 +618,7 @@ module Google
594
618
  config_attr :metadata, nil, ::Hash, nil
595
619
  config_attr :retry_policy, nil, ::Hash, ::Proc, nil
596
620
  config_attr :quota_project, nil, ::String, nil
621
+ config_attr :universe_domain, nil, ::String, nil
597
622
 
598
623
  # @private
599
624
  def initialize parent_config = nil
@@ -614,6 +639,14 @@ module Google
614
639
  end
615
640
  end
616
641
 
642
+ ##
643
+ # Configuration for the channel pool
644
+ # @return [::Gapic::ServiceStub::ChannelPool::Configuration]
645
+ #
646
+ def channel_pool
647
+ @channel_pool ||= ::Gapic::ServiceStub::ChannelPool::Configuration.new
648
+ end
649
+
617
650
  ##
618
651
  # Configuration RPC class for the ConsumerProcurementService API.
619
652
  #
data/lib/google/cloud/commerce/consumer/procurement/v1/consumer_procurement_service/operations.rb CHANGED
@@ -28,6 +28,9 @@ module Google
28
28
  module ConsumerProcurementService
29
29
  # Service that implements Longrunning Operations API.
30
30
  class Operations
31
+ # @private
32
+ DEFAULT_ENDPOINT_TEMPLATE = "cloudcommerceconsumerprocurement.$UNIVERSE_DOMAIN$"
33
+
31
34
  # @private
32
35
  attr_reader :operations_stub
33
36
 
@@ -62,6 +65,15 @@ module Google
62
65
  @config
63
66
  end
64
67
 
68
+ ##
69
+ # The effective universe domain
70
+ #
71
+ # @return [String]
72
+ #
73
+ def universe_domain
74
+ @operations_stub.universe_domain
75
+ end
76
+
65
77
  ##
66
78
  # Create a new Operations client object.
67
79
  #
@@ -92,10 +104,13 @@ module Google
92
104
 
93
105
  @operations_stub = ::Gapic::ServiceStub.new(
94
106
  ::Google::Longrunning::Operations::Stub,
95
- credentials: credentials,
96
- endpoint: @config.endpoint,
107
+ credentials: credentials,
108
+ endpoint: @config.endpoint,
109
+ endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
110
+ universe_domain: @config.universe_domain,
97
111
  channel_args: @config.channel_args,
98
- interceptors: @config.interceptors
112
+ interceptors: @config.interceptors,
113
+ channel_pool_config: @config.channel_pool
99
114
  )
100
115
 
101
116
  # Used by an LRO wrapper for some methods of this service
@@ -614,9 +629,9 @@ module Google
614
629
  # end
615
630
  #
616
631
  # @!attribute [rw] endpoint
617
- # The hostname or hostname:port of the service endpoint.
618
- # Defaults to `"cloudcommerceconsumerprocurement.googleapis.com"`.
619
- # @return [::String]
632
+ # A custom service endpoint, as a hostname or hostname:port. The default is
633
+ # nil, indicating to use the default endpoint in the current universe domain.
634
+ # @return [::String,nil]
620
635
  # @!attribute [rw] credentials
621
636
  # Credentials to send with calls. You may provide any of the following types:
622
637
  # * (`String`) The path to a service account key file in JSON format
@@ -662,13 +677,20 @@ module Google
662
677
  # @!attribute [rw] quota_project
663
678
  # A separate project against which to charge quota.
664
679
  # @return [::String]
680
+ # @!attribute [rw] universe_domain
681
+ # The universe domain within which to make requests. This determines the
682
+ # default endpoint URL. The default value of nil uses the environment
683
+ # universe (usually the default "googleapis.com" universe).
684
+ # @return [::String,nil]
665
685
  #
666
686
  class Configuration
667
687
  extend ::Gapic::Config
668
688
 
689
+ # @private
690
+ # The endpoint specific to the default "googleapis.com" universe. Deprecated.
669
691
  DEFAULT_ENDPOINT = "cloudcommerceconsumerprocurement.googleapis.com"
670
692
 
671
- config_attr :endpoint, DEFAULT_ENDPOINT, ::String
693
+ config_attr :endpoint, nil, ::String, nil
672
694
  config_attr :credentials, nil do |value|
673
695
  allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
674
696
  allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
@@ -683,6 +705,7 @@ module Google
683
705
  config_attr :metadata, nil, ::Hash, nil
684
706
  config_attr :retry_policy, nil, ::Hash, ::Proc, nil
685
707
  config_attr :quota_project, nil, ::String, nil
708
+ config_attr :universe_domain, nil, ::String, nil
686
709
 
687
710
  # @private
688
711
  def initialize parent_config = nil
@@ -703,6 +726,14 @@ module Google
703
726
  end
704
727
  end
705
728
 
729
+ ##
730
+ # Configuration for the channel pool
731
+ # @return [::Gapic::ServiceStub::ChannelPool::Configuration]
732
+ #
733
+ def channel_pool
734
+ @channel_pool ||= ::Gapic::ServiceStub::ChannelPool::Configuration.new
735
+ end
736
+
706
737
  ##
707
738
  # Configuration RPC class for the Operations API.
708
739
  #
data/lib/google/cloud/commerce/consumer/procurement/v1/consumer_procurement_service/rest/client.rb CHANGED
@@ -42,6 +42,9 @@ module Google
42
42
  # for charging for the procured item.
43
43
  #
44
44
  class Client
45
+ # @private
46
+ DEFAULT_ENDPOINT_TEMPLATE = "cloudcommerceconsumerprocurement.$UNIVERSE_DOMAIN$"
47
+
45
48
  include Paths
46
49
 
47
50
  # @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
+ @consumer_procurement_service_stub.universe_domain
127
+ end
128
+
117
129
  ##
118
130
  # Create a new ConsumerProcurementService REST client object.
119
131
  #
@@ -141,8 +153,9 @@ module Google
141
153
  credentials = @config.credentials
142
154
  # Use self-signed JWT if the endpoint is unchanged from default,
143
155
  # but only if the default endpoint does not have a region prefix.
144
- enable_self_signed_jwt = @config.endpoint == Configuration::DEFAULT_ENDPOINT &&
145
- !@config.endpoint.split(".").first.include?("-")
156
+ enable_self_signed_jwt = @config.endpoint.nil? ||
157
+ (@config.endpoint == Configuration::DEFAULT_ENDPOINT &&
158
+ !@config.endpoint.split(".").first.include?("-"))
146
159
  credentials ||= Credentials.default scope: @config.scope,
147
160
  enable_self_signed_jwt: enable_self_signed_jwt
148
161
  if credentials.is_a?(::String) || credentials.is_a?(::Hash)
@@ -156,9 +169,15 @@ module Google
156
169
  config.credentials = credentials
157
170
  config.quota_project = @quota_project_id
158
171
  config.endpoint = @config.endpoint
172
+ config.universe_domain = @config.universe_domain
159
173
  end
160
174
 
161
- @consumer_procurement_service_stub = ::Google::Cloud::Commerce::Consumer::Procurement::V1::ConsumerProcurementService::Rest::ServiceStub.new endpoint: @config.endpoint, credentials: credentials
175
+ @consumer_procurement_service_stub = ::Google::Cloud::Commerce::Consumer::Procurement::V1::ConsumerProcurementService::Rest::ServiceStub.new(
176
+ endpoint: @config.endpoint,
177
+ endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
178
+ universe_domain: @config.universe_domain,
179
+ credentials: credentials
180
+ )
162
181
  end
163
182
 
164
183
  ##
@@ -219,6 +238,29 @@ module Google
219
238
  # @return [::Gapic::Operation]
220
239
  #
221
240
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
241
+ #
242
+ # @example Basic example
243
+ # require "google/cloud/commerce/consumer/procurement/v1"
244
+ #
245
+ # # Create a client object. The client can be reused for multiple calls.
246
+ # client = Google::Cloud::Commerce::Consumer::Procurement::V1::ConsumerProcurementService::Rest::Client.new
247
+ #
248
+ # # Create a request. To set request fields, pass in keyword arguments.
249
+ # request = Google::Cloud::Commerce::Consumer::Procurement::V1::PlaceOrderRequest.new
250
+ #
251
+ # # Call the place_order method.
252
+ # result = client.place_order request
253
+ #
254
+ # # The returned object is of type Gapic::Operation. You can use it to
255
+ # # check the status of an operation, cancel it, or wait for results.
256
+ # # Here is how to wait for a response.
257
+ # result.wait_until_done! timeout: 60
258
+ # if result.response?
259
+ # p result.response
260
+ # else
261
+ # puts "No response received."
262
+ # end
263
+ #
222
264
  def place_order request, options = nil
223
265
  raise ::ArgumentError, "request must be provided" if request.nil?
224
266
 
@@ -283,6 +325,22 @@ module Google
283
325
  # @return [::Google::Cloud::Commerce::Consumer::Procurement::V1::Order]
284
326
  #
285
327
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
328
+ #
329
+ # @example Basic example
330
+ # require "google/cloud/commerce/consumer/procurement/v1"
331
+ #
332
+ # # Create a client object. The client can be reused for multiple calls.
333
+ # client = Google::Cloud::Commerce::Consumer::Procurement::V1::ConsumerProcurementService::Rest::Client.new
334
+ #
335
+ # # Create a request. To set request fields, pass in keyword arguments.
336
+ # request = Google::Cloud::Commerce::Consumer::Procurement::V1::GetOrderRequest.new
337
+ #
338
+ # # Call the get_order method.
339
+ # result = client.get_order request
340
+ #
341
+ # # The returned object is of type Google::Cloud::Commerce::Consumer::Procurement::V1::Order.
342
+ # p result
343
+ #
286
344
  def get_order request, options = nil
287
345
  raise ::ArgumentError, "request must be provided" if request.nil?
288
346
 
@@ -370,6 +428,26 @@ module Google
370
428
  # @return [::Gapic::Rest::PagedEnumerable<::Google::Cloud::Commerce::Consumer::Procurement::V1::Order>]
371
429
  #
372
430
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
431
+ #
432
+ # @example Basic example
433
+ # require "google/cloud/commerce/consumer/procurement/v1"
434
+ #
435
+ # # Create a client object. The client can be reused for multiple calls.
436
+ # client = Google::Cloud::Commerce::Consumer::Procurement::V1::ConsumerProcurementService::Rest::Client.new
437
+ #
438
+ # # Create a request. To set request fields, pass in keyword arguments.
439
+ # request = Google::Cloud::Commerce::Consumer::Procurement::V1::ListOrdersRequest.new
440
+ #
441
+ # # Call the list_orders method.
442
+ # result = client.list_orders request
443
+ #
444
+ # # The returned object is of type Gapic::PagedEnumerable. You can iterate
445
+ # # over elements, and API calls will be issued to fetch pages as needed.
446
+ # result.each do |item|
447
+ # # Each element is of type ::Google::Cloud::Commerce::Consumer::Procurement::V1::Order.
448
+ # p item
449
+ # end
450
+ #
373
451
  def list_orders request, options = nil
374
452
  raise ::ArgumentError, "request must be provided" if request.nil?
375
453
 
@@ -436,9 +514,9 @@ module Google
436
514
  # end
437
515
  #
438
516
  # @!attribute [rw] endpoint
439
- # The hostname or hostname:port of the service endpoint.
440
- # Defaults to `"cloudcommerceconsumerprocurement.googleapis.com"`.
441
- # @return [::String]
517
+ # A custom service endpoint, as a hostname or hostname:port. The default is
518
+ # nil, indicating to use the default endpoint in the current universe domain.
519
+ # @return [::String,nil]
442
520
  # @!attribute [rw] credentials
443
521
  # Credentials to send with calls. You may provide any of the following types:
444
522
  # * (`String`) The path to a service account key file in JSON format
@@ -475,13 +553,20 @@ module Google
475
553
  # @!attribute [rw] quota_project
476
554
  # A separate project against which to charge quota.
477
555
  # @return [::String]
556
+ # @!attribute [rw] universe_domain
557
+ # The universe domain within which to make requests. This determines the
558
+ # default endpoint URL. The default value of nil uses the environment
559
+ # universe (usually the default "googleapis.com" universe).
560
+ # @return [::String,nil]
478
561
  #
479
562
  class Configuration
480
563
  extend ::Gapic::Config
481
564
 
565
+ # @private
566
+ # The endpoint specific to the default "googleapis.com" universe. Deprecated.
482
567
  DEFAULT_ENDPOINT = "cloudcommerceconsumerprocurement.googleapis.com"
483
568
 
484
- config_attr :endpoint, DEFAULT_ENDPOINT, ::String
569
+ config_attr :endpoint, nil, ::String, nil
485
570
  config_attr :credentials, nil do |value|
486
571
  allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
487
572
  allowed.any? { |klass| klass === value }
@@ -493,6 +578,7 @@ module Google
493
578
  config_attr :metadata, nil, ::Hash, nil
494
579
  config_attr :retry_policy, nil, ::Hash, ::Proc, nil
495
580
  config_attr :quota_project, nil, ::String, nil
581
+ config_attr :universe_domain, nil, ::String, nil
496
582
 
497
583
  # @private
498
584
  def initialize parent_config = nil
data/lib/google/cloud/commerce/consumer/procurement/v1/consumer_procurement_service/rest/operations.rb CHANGED
@@ -28,6 +28,9 @@ module Google
28
28
  module Rest
29
29
  # Service that implements Longrunning Operations API.
30
30
  class Operations
31
+ # @private
32
+ DEFAULT_ENDPOINT_TEMPLATE = "cloudcommerceconsumerprocurement.$UNIVERSE_DOMAIN$"
33
+
31
34
  # @private
32
35
  attr_reader :operations_stub
33
36
 
@@ -62,6 +65,15 @@ module Google
62
65
  @config
63
66
  end
64
67
 
68
+ ##
69
+ # The effective universe domain
70
+ #
71
+ # @return [String]
72
+ #
73
+ def universe_domain
74
+ @operations_stub.universe_domain
75
+ end
76
+
65
77
  ##
66
78
  # Create a new Operations client object.
67
79
  #
@@ -86,8 +98,10 @@ module Google
86
98
  @quota_project_id ||= credentials.quota_project_id if credentials.respond_to? :quota_project_id
87
99
 
88
100
  @operations_stub = OperationsServiceStub.new(
89
- endpoint: @config.endpoint,
90
- credentials: credentials
101
+ endpoint: @config.endpoint,
102
+ endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
103
+ universe_domain: @config.universe_domain,
104
+ credentials: credentials
91
105
  )
92
106
 
93
107
  # Used by an LRO wrapper for some methods of this service
@@ -138,6 +152,26 @@ module Google
138
152
  # @return [::Gapic::Operation]
139
153
  #
140
154
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
155
+ #
156
+ # @example Basic example
157
+ # require "google/longrunning"
158
+ #
159
+ # # Create a client object. The client can be reused for multiple calls.
160
+ # client = Google::Longrunning::Operations::Rest::Client.new
161
+ #
162
+ # # Create a request. To set request fields, pass in keyword arguments.
163
+ # request = Google::Longrunning::ListOperationsRequest.new
164
+ #
165
+ # # Call the list_operations method.
166
+ # result = client.list_operations request
167
+ #
168
+ # # The returned object is of type Gapic::PagedEnumerable. You can iterate
169
+ # # over elements, and API calls will be issued to fetch pages as needed.
170
+ # result.each do |item|
171
+ # # Each element is of type ::Google::Longrunning::Operation.
172
+ # p item
173
+ # end
174
+ #
141
175
  def list_operations request, options = nil
142
176
  raise ::ArgumentError, "request must be provided" if request.nil?
143
177
 
@@ -203,6 +237,29 @@ module Google
203
237
  # @return [::Gapic::Operation]
204
238
  #
205
239
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
240
+ #
241
+ # @example Basic example
242
+ # require "google/longrunning"
243
+ #
244
+ # # Create a client object. The client can be reused for multiple calls.
245
+ # client = Google::Longrunning::Operations::Rest::Client.new
246
+ #
247
+ # # Create a request. To set request fields, pass in keyword arguments.
248
+ # request = Google::Longrunning::GetOperationRequest.new
249
+ #
250
+ # # Call the get_operation method.
251
+ # result = client.get_operation request
252
+ #
253
+ # # The returned object is of type Gapic::Operation. You can use it to
254
+ # # check the status of an operation, cancel it, or wait for results.
255
+ # # Here is how to wait for a response.
256
+ # result.wait_until_done! timeout: 60
257
+ # if result.response?
258
+ # p result.response
259
+ # else
260
+ # puts "No response received."
261
+ # end
262
+ #
206
263
  def get_operation request, options = nil
207
264
  raise ::ArgumentError, "request must be provided" if request.nil?
208
265
 
@@ -269,6 +326,22 @@ module Google
269
326
  # @return [::Google::Protobuf::Empty]
270
327
  #
271
328
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
329
+ #
330
+ # @example Basic example
331
+ # require "google/longrunning"
332
+ #
333
+ # # Create a client object. The client can be reused for multiple calls.
334
+ # client = Google::Longrunning::Operations::Rest::Client.new
335
+ #
336
+ # # Create a request. To set request fields, pass in keyword arguments.
337
+ # request = Google::Longrunning::DeleteOperationRequest.new
338
+ #
339
+ # # Call the delete_operation method.
340
+ # result = client.delete_operation request
341
+ #
342
+ # # The returned object is of type Google::Protobuf::Empty.
343
+ # p result
344
+ #
272
345
  def delete_operation request, options = nil
273
346
  raise ::ArgumentError, "request must be provided" if request.nil?
274
347
 
@@ -340,6 +413,22 @@ module Google
340
413
  # @return [::Google::Protobuf::Empty]
341
414
  #
342
415
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
416
+ #
417
+ # @example Basic example
418
+ # require "google/longrunning"
419
+ #
420
+ # # Create a client object. The client can be reused for multiple calls.
421
+ # client = Google::Longrunning::Operations::Rest::Client.new
422
+ #
423
+ # # Create a request. To set request fields, pass in keyword arguments.
424
+ # request = Google::Longrunning::CancelOperationRequest.new
425
+ #
426
+ # # Call the cancel_operation method.
427
+ # result = client.cancel_operation request
428
+ #
429
+ # # The returned object is of type Google::Protobuf::Empty.
430
+ # p result
431
+ #
343
432
  def cancel_operation request, options = nil
344
433
  raise ::ArgumentError, "request must be provided" if request.nil?
345
434
 
@@ -405,9 +494,9 @@ module Google
405
494
  # end
406
495
  #
407
496
  # @!attribute [rw] endpoint
408
- # The hostname or hostname:port of the service endpoint.
409
- # Defaults to `"cloudcommerceconsumerprocurement.googleapis.com"`.
410
- # @return [::String]
497
+ # A custom service endpoint, as a hostname or hostname:port. The default is
498
+ # nil, indicating to use the default endpoint in the current universe domain.
499
+ # @return [::String,nil]
411
500
  # @!attribute [rw] credentials
412
501
  # Credentials to send with calls. You may provide any of the following types:
413
502
  # * (`String`) The path to a service account key file in JSON format
@@ -444,13 +533,20 @@ module Google
444
533
  # @!attribute [rw] quota_project
445
534
  # A separate project against which to charge quota.
446
535
  # @return [::String]
536
+ # @!attribute [rw] universe_domain
537
+ # The universe domain within which to make requests. This determines the
538
+ # default endpoint URL. The default value of nil uses the environment
539
+ # universe (usually the default "googleapis.com" universe).
540
+ # @return [::String,nil]
447
541
  #
448
542
  class Configuration
449
543
  extend ::Gapic::Config
450
544
 
545
+ # @private
546
+ # The endpoint specific to the default "googleapis.com" universe. Deprecated.
451
547
  DEFAULT_ENDPOINT = "cloudcommerceconsumerprocurement.googleapis.com"
452
548
 
453
- config_attr :endpoint, DEFAULT_ENDPOINT, ::String
549
+ config_attr :endpoint, nil, ::String, nil
454
550
  config_attr :credentials, nil do |value|
455
551
  allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
456
552
  allowed.any? { |klass| klass === value }
@@ -462,6 +558,7 @@ module Google
462
558
  config_attr :metadata, nil, ::Hash, nil
463
559
  config_attr :retry_policy, nil, ::Hash, ::Proc, nil
464
560
  config_attr :quota_project, nil, ::String, nil
561
+ config_attr :universe_domain, nil, ::String, nil
465
562
 
466
563
  # @private
467
564
  def initialize parent_config = nil
@@ -544,12 +641,15 @@ module Google
544
641
  # Service stub contains baseline method implementations
545
642
  # including transcoding, making the REST call, and deserialing the response.
546
643
  class OperationsServiceStub
547
- def initialize endpoint:, credentials:
644
+ def initialize endpoint:, endpoint_template:, universe_domain:, credentials:
548
645
  # These require statements are intentionally placed here to initialize
549
646
  # the REST modules only when it's required.
550
647
  require "gapic/rest"
551
648
 
552
- @client_stub = ::Gapic::Rest::ClientStub.new endpoint: endpoint, credentials: credentials
649
+ @client_stub = ::Gapic::Rest::ClientStub.new endpoint: endpoint,
650
+ endpoint_template: endpoint_template,
651
+ universe_domain: universe_domain,
652
+ credentials: credentials
553
653
  end
554
654
 
555
655
  ##
data/lib/google/cloud/commerce/consumer/procurement/v1/consumer_procurement_service/rest/service_stub.rb CHANGED
@@ -32,16 +32,28 @@ module Google
32
32
  # including transcoding, making the REST call, and deserialing the response.
33
33
  #
34
34
  class ServiceStub
35
- def initialize endpoint:, credentials:
35
+ def initialize endpoint:, endpoint_template:, universe_domain:, credentials:
36
36
  # These require statements are intentionally placed here to initialize
37
37
  # the REST modules only when it's required.
38
38
  require "gapic/rest"
39
39
 
40
- @client_stub = ::Gapic::Rest::ClientStub.new endpoint: endpoint, credentials: credentials,
40
+ @client_stub = ::Gapic::Rest::ClientStub.new endpoint: endpoint,
41
+ endpoint_template: endpoint_template,
42
+ universe_domain: universe_domain,
43
+ credentials: credentials,
41
44
  numeric_enums: true,
42
45
  raise_faraday_errors: false
43
46
  end
44
47
 
48
+ ##
49
+ # The effective universe domain
50
+ #
51
+ # @return [String]
52
+ #
53
+ def universe_domain
54
+ @client_stub.universe_domain
55
+ end
56
+
45
57
  ##
46
58
  # Baseline implementation for the place_order REST call
47
59
  #
data/lib/google/cloud/commerce/consumer/procurement/v1/version.rb CHANGED
@@ -23,7 +23,7 @@ module Google
23
23
  module Consumer
24
24
  module Procurement
25
25
  module V1
26
- VERSION = "0.1.0"
26
+ VERSION = "0.3.0"
27
27
  end
28
28
  end
29
29
  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
data/proto_docs/google/api/field_behavior.rb CHANGED
@@ -66,6 +66,20 @@ module Google
66
66
  # a non-empty value will be returned. The user will not be aware of what
67
67
  # non-empty value to expect.
68
68
  NON_EMPTY_DEFAULT = 7
69
+
70
+ # Denotes that the field in a resource (a message annotated with
71
+ # google.api.resource) is used in the resource name to uniquely identify the
72
+ # resource. For AIP-compliant APIs, this should only be applied to the
73
+ # `name` field on the resource.
74
+ #
75
+ # This behavior should not be applied to references to other resources within
76
+ # the message.
77
+ #
78
+ # The identifier field of resources often have different field behavior
79
+ # depending on the request it is embedded in (e.g. for Create methods name
80
+ # is optional and unused, while for Update methods it is required). Instead
81
+ # of method-specific annotations, only `IDENTIFIER` is required.
82
+ IDENTIFIER = 8
69
83
  end
70
84
  end
71
85
  end
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: google-cloud-commerce-consumer-procurement-v1
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.1.0
4
+ version: 0.3.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-08-03 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
@@ -217,7 +217,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
217
217
  - !ruby/object:Gem::Version
218
218
  version: '0'
219
219
  requirements: []
220
- rubygems_version: 3.4.2
220
+ rubygems_version: 3.5.3
221
221
  signing_key:
222
222
  specification_version: 4
223
223
  summary: Enables consumers to procure products served by Cloud Marketplace platform.