google-cloud-commerce-consumer-procurement-v1 0.2.0 → 0.3.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/AUTHENTICATION.md +72 -99
- data/lib/google/cloud/commerce/consumer/procurement/v1/consumer_procurement_service/client.rb +32 -8
- data/lib/google/cloud/commerce/consumer/procurement/v1/consumer_procurement_service/operations.rb +28 -6
- data/lib/google/cloud/commerce/consumer/procurement/v1/consumer_procurement_service/rest/client.rb +34 -7
- data/lib/google/cloud/commerce/consumer/procurement/v1/consumer_procurement_service/rest/operations.rb +33 -8
- data/lib/google/cloud/commerce/consumer/procurement/v1/consumer_procurement_service/rest/service_stub.rb +14 -2
- data/lib/google/cloud/commerce/consumer/procurement/v1/version.rb +1 -1
- data/proto_docs/google/api/client.rb +14 -0
- metadata +5 -5
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 49b65de2f1b5d701cf83fd938650b4fac491afc3fb4abfd67c0ff9118a2548a0
|
|
4
|
+
data.tar.gz: 24dbe374e4b8f4eb6a88bb3a542f234d937430d1c8c5fdfc3c290732eebd4900
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 2e01936ddc1b90e18362ebbc01ce92c2f5b51398bbbee31f079785f29f251ab8a044dada5159c2a637b8730b4b9bdda048c75c98bc95195424f43683d83077a5
|
|
7
|
+
data.tar.gz: c62b2b0f53be27443219a681c7799091fad46d664e482bd018892b7d4eaf3dd4e68980c935906ca773d614eac2716271f2d70075330f6042429d1be9db467cbd
|
data/AUTHENTICATION.md
CHANGED
|
@@ -1,149 +1,122 @@
|
|
|
1
1
|
# Authentication
|
|
2
2
|
|
|
3
|
-
|
|
4
|
-
[
|
|
5
|
-
|
|
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
|
-
|
|
19
|
-
|
|
9
|
+
The following example shows how to set up authentication for a local development
|
|
10
|
+
environment with your user credentials.
|
|
20
11
|
|
|
21
|
-
|
|
22
|
-
|
|
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
|
-
|
|
28
|
-
|
|
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
|
-
|
|
18
|
+
```sh
|
|
19
|
+
gcloud auth application-default login
|
|
31
20
|
```
|
|
32
21
|
|
|
33
|
-
|
|
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
|
-
|
|
51
|
-
|
|
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
|
-
|
|
27
|
+
## Credential Lookup
|
|
56
28
|
|
|
57
|
-
The
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
|
|
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
|
-
|
|
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
|
-
|
|
70
|
-
|
|
71
|
-
|
|
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
|
-
|
|
74
|
-
require "google/cloud/commerce/consumer/procurement/v1"
|
|
75
|
-
|
|
76
|
-
ENV["GOOGLE_CLOUD_CREDENTIALS"] = "path/to/keyfile.json"
|
|
42
|
+
### Configuration
|
|
77
43
|
|
|
78
|
-
client
|
|
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
|
-
|
|
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
|
-
|
|
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/
|
|
60
|
+
config.credentials = "path/to/credentialfile.json"
|
|
91
61
|
end
|
|
92
62
|
```
|
|
93
63
|
|
|
94
|
-
|
|
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/
|
|
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
|
-
###
|
|
76
|
+
### Environment Variables
|
|
107
77
|
|
|
108
|
-
|
|
109
|
-
|
|
110
|
-
|
|
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
|
-
|
|
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
|
-
|
|
115
|
-
|
|
116
|
-
|
|
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
|
-
|
|
119
|
-
*
|
|
95
|
+
* `GOOGLE_CLOUD_CREDENTIALS` - Path to JSON file, or JSON contents
|
|
96
|
+
* `GOOGLE_APPLICATION_CREDENTIALS` - Path to JSON file
|
|
120
97
|
|
|
121
|
-
|
|
98
|
+
```ruby
|
|
99
|
+
require "google/cloud/commerce/consumer/procurement/v1"
|
|
122
100
|
|
|
123
|
-
|
|
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
|
-
|
|
128
|
-
|
|
129
|
-
need a Google Developers service account.
|
|
103
|
+
client = ::Google::Cloud::Commerce::Consumer::Procurement::V1::ConsumerProcurementService::Client.new
|
|
104
|
+
```
|
|
130
105
|
|
|
131
|
-
|
|
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
|
-
|
|
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
|
-
|
|
112
|
+
Follow the steps in [Quickstart](#quickstart) to set up a local ADC file.
|
|
139
113
|
|
|
140
|
-
|
|
141
|
-
"Service account" to be guided through downloading a new JSON key file.
|
|
114
|
+
### Google Cloud Platform environments
|
|
142
115
|
|
|
143
|
-
|
|
144
|
-
|
|
145
|
-
|
|
146
|
-
|
|
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
|
-
|
|
149
|
-
|
|
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
|
|
149
|
-
|
|
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,12 +172,15 @@ 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:
|
|
167
|
-
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
185
|
interceptors: @config.interceptors,
|
|
170
186
|
channel_pool_config: @config.channel_pool
|
|
@@ -526,9 +542,9 @@ module Google
|
|
|
526
542
|
# end
|
|
527
543
|
#
|
|
528
544
|
# @!attribute [rw] endpoint
|
|
529
|
-
#
|
|
530
|
-
#
|
|
531
|
-
# @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]
|
|
532
548
|
# @!attribute [rw] credentials
|
|
533
549
|
# Credentials to send with calls. You may provide any of the following types:
|
|
534
550
|
# * (`String`) The path to a service account key file in JSON format
|
|
@@ -574,13 +590,20 @@ module Google
|
|
|
574
590
|
# @!attribute [rw] quota_project
|
|
575
591
|
# A separate project against which to charge quota.
|
|
576
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]
|
|
577
598
|
#
|
|
578
599
|
class Configuration
|
|
579
600
|
extend ::Gapic::Config
|
|
580
601
|
|
|
602
|
+
# @private
|
|
603
|
+
# The endpoint specific to the default "googleapis.com" universe. Deprecated.
|
|
581
604
|
DEFAULT_ENDPOINT = "cloudcommerceconsumerprocurement.googleapis.com"
|
|
582
605
|
|
|
583
|
-
config_attr :endpoint,
|
|
606
|
+
config_attr :endpoint, nil, ::String, nil
|
|
584
607
|
config_attr :credentials, nil do |value|
|
|
585
608
|
allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
|
|
586
609
|
allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
|
|
@@ -595,6 +618,7 @@ module Google
|
|
|
595
618
|
config_attr :metadata, nil, ::Hash, nil
|
|
596
619
|
config_attr :retry_policy, nil, ::Hash, ::Proc, nil
|
|
597
620
|
config_attr :quota_project, nil, ::String, nil
|
|
621
|
+
config_attr :universe_domain, nil, ::String, nil
|
|
598
622
|
|
|
599
623
|
# @private
|
|
600
624
|
def initialize parent_config = nil
|
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,8 +104,10 @@ module Google
|
|
|
92
104
|
|
|
93
105
|
@operations_stub = ::Gapic::ServiceStub.new(
|
|
94
106
|
::Google::Longrunning::Operations::Stub,
|
|
95
|
-
credentials:
|
|
96
|
-
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
112
|
interceptors: @config.interceptors,
|
|
99
113
|
channel_pool_config: @config.channel_pool
|
|
@@ -615,9 +629,9 @@ module Google
|
|
|
615
629
|
# end
|
|
616
630
|
#
|
|
617
631
|
# @!attribute [rw] endpoint
|
|
618
|
-
#
|
|
619
|
-
#
|
|
620
|
-
# @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]
|
|
621
635
|
# @!attribute [rw] credentials
|
|
622
636
|
# Credentials to send with calls. You may provide any of the following types:
|
|
623
637
|
# * (`String`) The path to a service account key file in JSON format
|
|
@@ -663,13 +677,20 @@ module Google
|
|
|
663
677
|
# @!attribute [rw] quota_project
|
|
664
678
|
# A separate project against which to charge quota.
|
|
665
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]
|
|
666
685
|
#
|
|
667
686
|
class Configuration
|
|
668
687
|
extend ::Gapic::Config
|
|
669
688
|
|
|
689
|
+
# @private
|
|
690
|
+
# The endpoint specific to the default "googleapis.com" universe. Deprecated.
|
|
670
691
|
DEFAULT_ENDPOINT = "cloudcommerceconsumerprocurement.googleapis.com"
|
|
671
692
|
|
|
672
|
-
config_attr :endpoint,
|
|
693
|
+
config_attr :endpoint, nil, ::String, nil
|
|
673
694
|
config_attr :credentials, nil do |value|
|
|
674
695
|
allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
|
|
675
696
|
allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
|
|
@@ -684,6 +705,7 @@ module Google
|
|
|
684
705
|
config_attr :metadata, nil, ::Hash, nil
|
|
685
706
|
config_attr :retry_policy, nil, ::Hash, ::Proc, nil
|
|
686
707
|
config_attr :quota_project, nil, ::String, nil
|
|
708
|
+
config_attr :universe_domain, nil, ::String, nil
|
|
687
709
|
|
|
688
710
|
# @private
|
|
689
711
|
def initialize parent_config = nil
|
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
|
|
145
|
-
|
|
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
|
|
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
|
##
|
|
@@ -495,9 +514,9 @@ module Google
|
|
|
495
514
|
# end
|
|
496
515
|
#
|
|
497
516
|
# @!attribute [rw] endpoint
|
|
498
|
-
#
|
|
499
|
-
#
|
|
500
|
-
# @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]
|
|
501
520
|
# @!attribute [rw] credentials
|
|
502
521
|
# Credentials to send with calls. You may provide any of the following types:
|
|
503
522
|
# * (`String`) The path to a service account key file in JSON format
|
|
@@ -534,13 +553,20 @@ module Google
|
|
|
534
553
|
# @!attribute [rw] quota_project
|
|
535
554
|
# A separate project against which to charge quota.
|
|
536
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]
|
|
537
561
|
#
|
|
538
562
|
class Configuration
|
|
539
563
|
extend ::Gapic::Config
|
|
540
564
|
|
|
565
|
+
# @private
|
|
566
|
+
# The endpoint specific to the default "googleapis.com" universe. Deprecated.
|
|
541
567
|
DEFAULT_ENDPOINT = "cloudcommerceconsumerprocurement.googleapis.com"
|
|
542
568
|
|
|
543
|
-
config_attr :endpoint,
|
|
569
|
+
config_attr :endpoint, nil, ::String, nil
|
|
544
570
|
config_attr :credentials, nil do |value|
|
|
545
571
|
allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
|
|
546
572
|
allowed.any? { |klass| klass === value }
|
|
@@ -552,6 +578,7 @@ module Google
|
|
|
552
578
|
config_attr :metadata, nil, ::Hash, nil
|
|
553
579
|
config_attr :retry_policy, nil, ::Hash, ::Proc, nil
|
|
554
580
|
config_attr :quota_project, nil, ::String, nil
|
|
581
|
+
config_attr :universe_domain, nil, ::String, nil
|
|
555
582
|
|
|
556
583
|
# @private
|
|
557
584
|
def initialize parent_config = nil
|
|
@@ -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:
|
|
90
|
-
|
|
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
|
|
@@ -480,9 +494,9 @@ module Google
|
|
|
480
494
|
# end
|
|
481
495
|
#
|
|
482
496
|
# @!attribute [rw] endpoint
|
|
483
|
-
#
|
|
484
|
-
#
|
|
485
|
-
# @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]
|
|
486
500
|
# @!attribute [rw] credentials
|
|
487
501
|
# Credentials to send with calls. You may provide any of the following types:
|
|
488
502
|
# * (`String`) The path to a service account key file in JSON format
|
|
@@ -519,13 +533,20 @@ module Google
|
|
|
519
533
|
# @!attribute [rw] quota_project
|
|
520
534
|
# A separate project against which to charge quota.
|
|
521
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]
|
|
522
541
|
#
|
|
523
542
|
class Configuration
|
|
524
543
|
extend ::Gapic::Config
|
|
525
544
|
|
|
545
|
+
# @private
|
|
546
|
+
# The endpoint specific to the default "googleapis.com" universe. Deprecated.
|
|
526
547
|
DEFAULT_ENDPOINT = "cloudcommerceconsumerprocurement.googleapis.com"
|
|
527
548
|
|
|
528
|
-
config_attr :endpoint,
|
|
549
|
+
config_attr :endpoint, nil, ::String, nil
|
|
529
550
|
config_attr :credentials, nil do |value|
|
|
530
551
|
allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
|
|
531
552
|
allowed.any? { |klass| klass === value }
|
|
@@ -537,6 +558,7 @@ module Google
|
|
|
537
558
|
config_attr :metadata, nil, ::Hash, nil
|
|
538
559
|
config_attr :retry_policy, nil, ::Hash, ::Proc, nil
|
|
539
560
|
config_attr :quota_project, nil, ::String, nil
|
|
561
|
+
config_attr :universe_domain, nil, ::String, nil
|
|
540
562
|
|
|
541
563
|
# @private
|
|
542
564
|
def initialize parent_config = nil
|
|
@@ -619,12 +641,15 @@ module Google
|
|
|
619
641
|
# Service stub contains baseline method implementations
|
|
620
642
|
# including transcoding, making the REST call, and deserialing the response.
|
|
621
643
|
class OperationsServiceStub
|
|
622
|
-
def initialize endpoint:, credentials:
|
|
644
|
+
def initialize endpoint:, endpoint_template:, universe_domain:, credentials:
|
|
623
645
|
# These require statements are intentionally placed here to initialize
|
|
624
646
|
# the REST modules only when it's required.
|
|
625
647
|
require "gapic/rest"
|
|
626
648
|
|
|
627
|
-
@client_stub = ::Gapic::Rest::ClientStub.new endpoint: endpoint,
|
|
649
|
+
@client_stub = ::Gapic::Rest::ClientStub.new endpoint: endpoint,
|
|
650
|
+
endpoint_template: endpoint_template,
|
|
651
|
+
universe_domain: universe_domain,
|
|
652
|
+
credentials: credentials
|
|
628
653
|
end
|
|
629
654
|
|
|
630
655
|
##
|
|
@@ -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,
|
|
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
|
#
|
|
@@ -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-commerce-consumer-procurement-v1
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 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:
|
|
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
|
+
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.
|
|
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.
|
|
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.
|