google-shopping-merchant-inventories-v1beta 0.1.0 → 0.2.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/shopping/merchant/inventories/v1beta/local_inventory_service/client.rb +31 -8
  4. data/lib/google/shopping/merchant/inventories/v1beta/local_inventory_service/rest/client.rb +33 -7
  5. data/lib/google/shopping/merchant/inventories/v1beta/local_inventory_service/rest/service_stub.rb +14 -2
  6. data/lib/google/shopping/merchant/inventories/v1beta/regional_inventory_service/client.rb +31 -8
  7. data/lib/google/shopping/merchant/inventories/v1beta/regional_inventory_service/rest/client.rb +33 -7
  8. data/lib/google/shopping/merchant/inventories/v1beta/regional_inventory_service/rest/service_stub.rb +14 -2
  9. data/lib/google/shopping/merchant/inventories/v1beta/version.rb +1 -1
  10. data/proto_docs/google/api/client.rb +14 -0
  11. metadata +5 -5
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: f948d31682e54b68f8fa36d908d1c008697df3a39c0427452d0d306dd12e8abb
4
- data.tar.gz: 8f698a8f56f5e57bb04437a696b409ca8b809c92eead3d4f2e2cdd19e89e859b
3
+ metadata.gz: 26949a7ce0f03e002a6f9c988e1050b99113f94dc0d3bbbaffd22e2cfb4803d3
4
+ data.tar.gz: 7eaacac60114cd06ab3da409147041304d5ac5d84feabf945043d83a1d2de6fc
5
5
  SHA512:
6
- metadata.gz: 39dfaa4b7cf469ce6dcfc1061a2ee1cb71ca5f8320c6563f3dc3cc6e2d83b1d90613668b8e28a385d2759e4a381c538d2b91201fd6a19848f0a5b1c652e33f0b
7
- data.tar.gz: 4ecbe6d4b40e57d77aca4b2eb7495799f70bc13292552e4e9302b3c20d69b9b7101f68181c0a4994332e9fbb6f3b25ed550a06923e85a339a276129ac9a29536
6
+ metadata.gz: 419c2f772f39ac0eafda050e9d4e5d1dc35e5778e88327505c5e4c0abab40b555bd8d8a3208f62be4cc0dab79766aa9b297859776b76486f763044f120396372
7
+ data.tar.gz: 8340fc16095e991dcfc09a3de24b86553d4f1fe951e9b0102e3bc017c6dd125a8e18325fd8e8c7603ae53013c94d34a5c443da8fe8972a51d6d63e2d87d0d9f6
data/AUTHENTICATION.md CHANGED
@@ -1,149 +1,122 @@
1
1
  # Authentication
2
2
 
3
- In general, the google-shopping-merchant-inventories-v1beta 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-shopping-merchant-inventories-v1beta 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/shopping/merchant/inventories/v1beta"
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::Shopping::Merchant::Inventories::V1beta::LocalInventoryService::Client.new
18
+ ```sh
19
+ gcloud auth application-default login
31
20
  ```
32
21
 
33
- ## Credential Lookup
34
-
35
- The google-shopping-merchant-inventories-v1beta 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-shopping-merchant-inventories-v1beta 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-shopping-merchant-inventories-v1beta
66
- checks for credentials are configured on the service Credentials class (such as
67
- {::Google::Shopping::Merchant::Inventories::V1beta::LocalInventoryService::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/shopping/merchant/inventories/v1beta"
75
-
76
- ENV["GOOGLE_CLOUD_CREDENTIALS"] = "path/to/keyfile.json"
42
+ ### Configuration
77
43
 
78
- client = ::Google::Shopping::Merchant::Inventories::V1beta::LocalInventoryService::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/shopping/merchant/inventories/v1beta"
88
58
 
89
59
  client = ::Google::Shopping::Merchant::Inventories::V1beta::LocalInventoryService::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/shopping/merchant/inventories/v1beta"
98
68
 
99
69
  ::Google::Shopping::Merchant::Inventories::V1beta::LocalInventoryService::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::Shopping::Merchant::Inventories::V1beta::LocalInventoryService::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-shopping-merchant-inventories-v1beta
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/shopping/merchant/inventories/v1beta"
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-shopping-merchant-inventories-v1beta.
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::Shopping::Merchant::Inventories::V1beta::LocalInventoryService::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/shopping/merchant/inventories/v1beta/local_inventory_service/client.rb CHANGED
@@ -31,6 +31,9 @@ module Google
31
31
  # Service to manage local inventory for products
32
32
  #
33
33
  class Client
34
+ # @private
35
+ DEFAULT_ENDPOINT_TEMPLATE = "merchantapi.$UNIVERSE_DOMAIN$"
36
+
34
37
  include Paths
35
38
 
36
39
  # @private
@@ -96,6 +99,15 @@ module Google
96
99
  @config
97
100
  end
98
101
 
102
+ ##
103
+ # The effective universe domain
104
+ #
105
+ # @return [String]
106
+ #
107
+ def universe_domain
108
+ @local_inventory_service_stub.universe_domain
109
+ end
110
+
99
111
  ##
100
112
  # Create a new LocalInventoryService client object.
101
113
  #
@@ -129,8 +141,9 @@ module Google
129
141
  credentials = @config.credentials
130
142
  # Use self-signed JWT if the endpoint is unchanged from default,
131
143
  # but only if the default endpoint does not have a region prefix.
132
- enable_self_signed_jwt = @config.endpoint == Configuration::DEFAULT_ENDPOINT &&
133
- !@config.endpoint.split(".").first.include?("-")
144
+ enable_self_signed_jwt = @config.endpoint.nil? ||
145
+ (@config.endpoint == Configuration::DEFAULT_ENDPOINT &&
146
+ !@config.endpoint.split(".").first.include?("-"))
134
147
  credentials ||= Credentials.default scope: @config.scope,
135
148
  enable_self_signed_jwt: enable_self_signed_jwt
136
149
  if credentials.is_a?(::String) || credentials.is_a?(::Hash)
@@ -141,8 +154,10 @@ module Google
141
154
 
142
155
  @local_inventory_service_stub = ::Gapic::ServiceStub.new(
143
156
  ::Google::Shopping::Merchant::Inventories::V1beta::LocalInventoryService::Stub,
144
- credentials: credentials,
145
- endpoint: @config.endpoint,
157
+ credentials: credentials,
158
+ endpoint: @config.endpoint,
159
+ endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
160
+ universe_domain: @config.universe_domain,
146
161
  channel_args: @config.channel_args,
147
162
  interceptors: @config.interceptors,
148
163
  channel_pool_config: @config.channel_pool
@@ -481,9 +496,9 @@ module Google
481
496
  # end
482
497
  #
483
498
  # @!attribute [rw] endpoint
484
- # The hostname or hostname:port of the service endpoint.
485
- # Defaults to `"merchantapi.googleapis.com"`.
486
- # @return [::String]
499
+ # A custom service endpoint, as a hostname or hostname:port. The default is
500
+ # nil, indicating to use the default endpoint in the current universe domain.
501
+ # @return [::String,nil]
487
502
  # @!attribute [rw] credentials
488
503
  # Credentials to send with calls. You may provide any of the following types:
489
504
  # * (`String`) The path to a service account key file in JSON format
@@ -529,13 +544,20 @@ module Google
529
544
  # @!attribute [rw] quota_project
530
545
  # A separate project against which to charge quota.
531
546
  # @return [::String]
547
+ # @!attribute [rw] universe_domain
548
+ # The universe domain within which to make requests. This determines the
549
+ # default endpoint URL. The default value of nil uses the environment
550
+ # universe (usually the default "googleapis.com" universe).
551
+ # @return [::String,nil]
532
552
  #
533
553
  class Configuration
534
554
  extend ::Gapic::Config
535
555
 
556
+ # @private
557
+ # The endpoint specific to the default "googleapis.com" universe. Deprecated.
536
558
  DEFAULT_ENDPOINT = "merchantapi.googleapis.com"
537
559
 
538
- config_attr :endpoint, DEFAULT_ENDPOINT, ::String
560
+ config_attr :endpoint, nil, ::String, nil
539
561
  config_attr :credentials, nil do |value|
540
562
  allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
541
563
  allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
@@ -550,6 +572,7 @@ module Google
550
572
  config_attr :metadata, nil, ::Hash, nil
551
573
  config_attr :retry_policy, nil, ::Hash, ::Proc, nil
552
574
  config_attr :quota_project, nil, ::String, nil
575
+ config_attr :universe_domain, nil, ::String, nil
553
576
 
554
577
  # @private
555
578
  def initialize parent_config = nil
data/lib/google/shopping/merchant/inventories/v1beta/local_inventory_service/rest/client.rb CHANGED
@@ -33,6 +33,9 @@ module Google
33
33
  # Service to manage local inventory for products
34
34
  #
35
35
  class Client
36
+ # @private
37
+ DEFAULT_ENDPOINT_TEMPLATE = "merchantapi.$UNIVERSE_DOMAIN$"
38
+
36
39
  include Paths
37
40
 
38
41
  # @private
@@ -98,6 +101,15 @@ module Google
98
101
  @config
99
102
  end
100
103
 
104
+ ##
105
+ # The effective universe domain
106
+ #
107
+ # @return [String]
108
+ #
109
+ def universe_domain
110
+ @local_inventory_service_stub.universe_domain
111
+ end
112
+
101
113
  ##
102
114
  # Create a new LocalInventoryService REST client object.
103
115
  #
@@ -125,8 +137,9 @@ module Google
125
137
  credentials = @config.credentials
126
138
  # Use self-signed JWT if the endpoint is unchanged from default,
127
139
  # but only if the default endpoint does not have a region prefix.
128
- enable_self_signed_jwt = @config.endpoint == Configuration::DEFAULT_ENDPOINT &&
129
- !@config.endpoint.split(".").first.include?("-")
140
+ enable_self_signed_jwt = @config.endpoint.nil? ||
141
+ (@config.endpoint == Configuration::DEFAULT_ENDPOINT &&
142
+ !@config.endpoint.split(".").first.include?("-"))
130
143
  credentials ||= Credentials.default scope: @config.scope,
131
144
  enable_self_signed_jwt: enable_self_signed_jwt
132
145
  if credentials.is_a?(::String) || credentials.is_a?(::Hash)
@@ -136,7 +149,12 @@ module Google
136
149
  @quota_project_id = @config.quota_project
137
150
  @quota_project_id ||= credentials.quota_project_id if credentials.respond_to? :quota_project_id
138
151
 
139
- @local_inventory_service_stub = ::Google::Shopping::Merchant::Inventories::V1beta::LocalInventoryService::Rest::ServiceStub.new endpoint: @config.endpoint, credentials: credentials
152
+ @local_inventory_service_stub = ::Google::Shopping::Merchant::Inventories::V1beta::LocalInventoryService::Rest::ServiceStub.new(
153
+ endpoint: @config.endpoint,
154
+ endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
155
+ universe_domain: @config.universe_domain,
156
+ credentials: credentials
157
+ )
140
158
  end
141
159
 
142
160
  # Service calls
@@ -450,9 +468,9 @@ module Google
450
468
  # end
451
469
  #
452
470
  # @!attribute [rw] endpoint
453
- # The hostname or hostname:port of the service endpoint.
454
- # Defaults to `"merchantapi.googleapis.com"`.
455
- # @return [::String]
471
+ # A custom service endpoint, as a hostname or hostname:port. The default is
472
+ # nil, indicating to use the default endpoint in the current universe domain.
473
+ # @return [::String,nil]
456
474
  # @!attribute [rw] credentials
457
475
  # Credentials to send with calls. You may provide any of the following types:
458
476
  # * (`String`) The path to a service account key file in JSON format
@@ -489,13 +507,20 @@ module Google
489
507
  # @!attribute [rw] quota_project
490
508
  # A separate project against which to charge quota.
491
509
  # @return [::String]
510
+ # @!attribute [rw] universe_domain
511
+ # The universe domain within which to make requests. This determines the
512
+ # default endpoint URL. The default value of nil uses the environment
513
+ # universe (usually the default "googleapis.com" universe).
514
+ # @return [::String,nil]
492
515
  #
493
516
  class Configuration
494
517
  extend ::Gapic::Config
495
518
 
519
+ # @private
520
+ # The endpoint specific to the default "googleapis.com" universe. Deprecated.
496
521
  DEFAULT_ENDPOINT = "merchantapi.googleapis.com"
497
522
 
498
- config_attr :endpoint, DEFAULT_ENDPOINT, ::String
523
+ config_attr :endpoint, nil, ::String, nil
499
524
  config_attr :credentials, nil do |value|
500
525
  allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
501
526
  allowed.any? { |klass| klass === value }
@@ -507,6 +532,7 @@ module Google
507
532
  config_attr :metadata, nil, ::Hash, nil
508
533
  config_attr :retry_policy, nil, ::Hash, ::Proc, nil
509
534
  config_attr :quota_project, nil, ::String, nil
535
+ config_attr :universe_domain, nil, ::String, nil
510
536
 
511
537
  # @private
512
538
  def initialize parent_config = nil
data/lib/google/shopping/merchant/inventories/v1beta/local_inventory_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 list_local_inventories REST call
46
58
  #
data/lib/google/shopping/merchant/inventories/v1beta/regional_inventory_service/client.rb CHANGED
@@ -32,6 +32,9 @@ module Google
32
32
  # `regions` resource and API to manage regions definitions.
33
33
  #
34
34
  class Client
35
+ # @private
36
+ DEFAULT_ENDPOINT_TEMPLATE = "merchantapi.$UNIVERSE_DOMAIN$"
37
+
35
38
  include Paths
36
39
 
37
40
  # @private
@@ -97,6 +100,15 @@ module Google
97
100
  @config
98
101
  end
99
102
 
103
+ ##
104
+ # The effective universe domain
105
+ #
106
+ # @return [String]
107
+ #
108
+ def universe_domain
109
+ @regional_inventory_service_stub.universe_domain
110
+ end
111
+
100
112
  ##
101
113
  # Create a new RegionalInventoryService client object.
102
114
  #
@@ -130,8 +142,9 @@ module Google
130
142
  credentials = @config.credentials
131
143
  # Use self-signed JWT if the endpoint is unchanged from default,
132
144
  # but only if the default endpoint does not have a region prefix.
133
- enable_self_signed_jwt = @config.endpoint == Configuration::DEFAULT_ENDPOINT &&
134
- !@config.endpoint.split(".").first.include?("-")
145
+ enable_self_signed_jwt = @config.endpoint.nil? ||
146
+ (@config.endpoint == Configuration::DEFAULT_ENDPOINT &&
147
+ !@config.endpoint.split(".").first.include?("-"))
135
148
  credentials ||= Credentials.default scope: @config.scope,
136
149
  enable_self_signed_jwt: enable_self_signed_jwt
137
150
  if credentials.is_a?(::String) || credentials.is_a?(::Hash)
@@ -142,8 +155,10 @@ module Google
142
155
 
143
156
  @regional_inventory_service_stub = ::Gapic::ServiceStub.new(
144
157
  ::Google::Shopping::Merchant::Inventories::V1beta::RegionalInventoryService::Stub,
145
- credentials: credentials,
146
- endpoint: @config.endpoint,
158
+ credentials: credentials,
159
+ endpoint: @config.endpoint,
160
+ endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
161
+ universe_domain: @config.universe_domain,
147
162
  channel_args: @config.channel_args,
148
163
  interceptors: @config.interceptors,
149
164
  channel_pool_config: @config.channel_pool
@@ -481,9 +496,9 @@ module Google
481
496
  # end
482
497
  #
483
498
  # @!attribute [rw] endpoint
484
- # The hostname or hostname:port of the service endpoint.
485
- # Defaults to `"merchantapi.googleapis.com"`.
486
- # @return [::String]
499
+ # A custom service endpoint, as a hostname or hostname:port. The default is
500
+ # nil, indicating to use the default endpoint in the current universe domain.
501
+ # @return [::String,nil]
487
502
  # @!attribute [rw] credentials
488
503
  # Credentials to send with calls. You may provide any of the following types:
489
504
  # * (`String`) The path to a service account key file in JSON format
@@ -529,13 +544,20 @@ module Google
529
544
  # @!attribute [rw] quota_project
530
545
  # A separate project against which to charge quota.
531
546
  # @return [::String]
547
+ # @!attribute [rw] universe_domain
548
+ # The universe domain within which to make requests. This determines the
549
+ # default endpoint URL. The default value of nil uses the environment
550
+ # universe (usually the default "googleapis.com" universe).
551
+ # @return [::String,nil]
532
552
  #
533
553
  class Configuration
534
554
  extend ::Gapic::Config
535
555
 
556
+ # @private
557
+ # The endpoint specific to the default "googleapis.com" universe. Deprecated.
536
558
  DEFAULT_ENDPOINT = "merchantapi.googleapis.com"
537
559
 
538
- config_attr :endpoint, DEFAULT_ENDPOINT, ::String
560
+ config_attr :endpoint, nil, ::String, nil
539
561
  config_attr :credentials, nil do |value|
540
562
  allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
541
563
  allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
@@ -550,6 +572,7 @@ module Google
550
572
  config_attr :metadata, nil, ::Hash, nil
551
573
  config_attr :retry_policy, nil, ::Hash, ::Proc, nil
552
574
  config_attr :quota_project, nil, ::String, nil
575
+ config_attr :universe_domain, nil, ::String, nil
553
576
 
554
577
  # @private
555
578
  def initialize parent_config = nil
data/lib/google/shopping/merchant/inventories/v1beta/regional_inventory_service/rest/client.rb CHANGED
@@ -34,6 +34,9 @@ module Google
34
34
  # `regions` resource and API to manage regions definitions.
35
35
  #
36
36
  class Client
37
+ # @private
38
+ DEFAULT_ENDPOINT_TEMPLATE = "merchantapi.$UNIVERSE_DOMAIN$"
39
+
37
40
  include Paths
38
41
 
39
42
  # @private
@@ -99,6 +102,15 @@ module Google
99
102
  @config
100
103
  end
101
104
 
105
+ ##
106
+ # The effective universe domain
107
+ #
108
+ # @return [String]
109
+ #
110
+ def universe_domain
111
+ @regional_inventory_service_stub.universe_domain
112
+ end
113
+
102
114
  ##
103
115
  # Create a new RegionalInventoryService REST client object.
104
116
  #
@@ -126,8 +138,9 @@ module Google
126
138
  credentials = @config.credentials
127
139
  # Use self-signed JWT if the endpoint is unchanged from default,
128
140
  # but only if the default endpoint does not have a region prefix.
129
- enable_self_signed_jwt = @config.endpoint == Configuration::DEFAULT_ENDPOINT &&
130
- !@config.endpoint.split(".").first.include?("-")
141
+ enable_self_signed_jwt = @config.endpoint.nil? ||
142
+ (@config.endpoint == Configuration::DEFAULT_ENDPOINT &&
143
+ !@config.endpoint.split(".").first.include?("-"))
131
144
  credentials ||= Credentials.default scope: @config.scope,
132
145
  enable_self_signed_jwt: enable_self_signed_jwt
133
146
  if credentials.is_a?(::String) || credentials.is_a?(::Hash)
@@ -137,7 +150,12 @@ module Google
137
150
  @quota_project_id = @config.quota_project
138
151
  @quota_project_id ||= credentials.quota_project_id if credentials.respond_to? :quota_project_id
139
152
 
140
- @regional_inventory_service_stub = ::Google::Shopping::Merchant::Inventories::V1beta::RegionalInventoryService::Rest::ServiceStub.new endpoint: @config.endpoint, credentials: credentials
153
+ @regional_inventory_service_stub = ::Google::Shopping::Merchant::Inventories::V1beta::RegionalInventoryService::Rest::ServiceStub.new(
154
+ endpoint: @config.endpoint,
155
+ endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
156
+ universe_domain: @config.universe_domain,
157
+ credentials: credentials
158
+ )
141
159
  end
142
160
 
143
161
  # Service calls
@@ -450,9 +468,9 @@ module Google
450
468
  # end
451
469
  #
452
470
  # @!attribute [rw] endpoint
453
- # The hostname or hostname:port of the service endpoint.
454
- # Defaults to `"merchantapi.googleapis.com"`.
455
- # @return [::String]
471
+ # A custom service endpoint, as a hostname or hostname:port. The default is
472
+ # nil, indicating to use the default endpoint in the current universe domain.
473
+ # @return [::String,nil]
456
474
  # @!attribute [rw] credentials
457
475
  # Credentials to send with calls. You may provide any of the following types:
458
476
  # * (`String`) The path to a service account key file in JSON format
@@ -489,13 +507,20 @@ module Google
489
507
  # @!attribute [rw] quota_project
490
508
  # A separate project against which to charge quota.
491
509
  # @return [::String]
510
+ # @!attribute [rw] universe_domain
511
+ # The universe domain within which to make requests. This determines the
512
+ # default endpoint URL. The default value of nil uses the environment
513
+ # universe (usually the default "googleapis.com" universe).
514
+ # @return [::String,nil]
492
515
  #
493
516
  class Configuration
494
517
  extend ::Gapic::Config
495
518
 
519
+ # @private
520
+ # The endpoint specific to the default "googleapis.com" universe. Deprecated.
496
521
  DEFAULT_ENDPOINT = "merchantapi.googleapis.com"
497
522
 
498
- config_attr :endpoint, DEFAULT_ENDPOINT, ::String
523
+ config_attr :endpoint, nil, ::String, nil
499
524
  config_attr :credentials, nil do |value|
500
525
  allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
501
526
  allowed.any? { |klass| klass === value }
@@ -507,6 +532,7 @@ module Google
507
532
  config_attr :metadata, nil, ::Hash, nil
508
533
  config_attr :retry_policy, nil, ::Hash, ::Proc, nil
509
534
  config_attr :quota_project, nil, ::String, nil
535
+ config_attr :universe_domain, nil, ::String, nil
510
536
 
511
537
  # @private
512
538
  def initialize parent_config = nil
data/lib/google/shopping/merchant/inventories/v1beta/regional_inventory_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 list_regional_inventories REST call
46
58
  #
data/lib/google/shopping/merchant/inventories/v1beta/version.rb CHANGED
@@ -22,7 +22,7 @@ module Google
22
22
  module Merchant
23
23
  module Inventories
24
24
  module V1beta
25
- VERSION = "0.1.0"
25
+ VERSION = "0.2.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-shopping-merchant-inventories-v1beta
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.1.0
4
+ version: 0.2.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-10-23 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.20.0
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.20.0
29
+ version: 0.21.1
30
30
  - - "<"
31
31
  - !ruby/object:Gem::Version
32
32
  version: 2.a
@@ -242,7 +242,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
242
242
  - !ruby/object:Gem::Version
243
243
  version: '0'
244
244
  requirements: []
245
- rubygems_version: 3.4.19
245
+ rubygems_version: 3.5.3
246
246
  signing_key:
247
247
  specification_version: 4
248
248
  summary: Programmatically manage your Merchant Center accounts.