google-cloud-apigee_connect-v1 0.5.0 → 0.6.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 -101
- data/lib/google/cloud/apigee_connect/v1/connection_service/client.rb +31 -8
- data/lib/google/cloud/apigee_connect/v1/connection_service/rest/client.rb +33 -7
- data/lib/google/cloud/apigee_connect/v1/connection_service/rest/service_stub.rb +14 -2
- data/lib/google/cloud/apigee_connect/v1/tether/client.rb +31 -8
- data/lib/google/cloud/apigee_connect/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: 9a95d95bde120d4c17dbfc880ffc679d9dbcbf3fc128ff9ffe01f1da14b2a3c5
|
|
4
|
+
data.tar.gz: 2a46eee24c9e3f2d453c020c01f941799674347059110df34bfa1cb106e097b1
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: a9fa46e693780816f0f1e86694b8388239407d9ca453341540ddc732377c3dd63f0b42487e7767daa90cae64a1bbc43b82990db4ec0daec9a33aa86c2a0b0f46
|
|
7
|
+
data.tar.gz: 74cef07f57a53764ad9ff3d1f7aa749571aba7fffee733207eb3a0a3741fe66014e3914cfb23ea0fe625c983fa47a886a874b71e963d5a31f9215e266ae93b88
|
data/AUTHENTICATION.md
CHANGED
|
@@ -1,151 +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-apigee_connect-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-apigee_connect-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-apigee_connect-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::ApigeeConnect::V1::ConnectionService::Credentials}):
|
|
34
|
+
Credentials are accepted in the following ways, in the following order or precedence:
|
|
68
35
|
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
|
|
36
|
+
1. Credentials specified in method arguments
|
|
37
|
+
2. Credentials specified in configuration
|
|
38
|
+
3. Credentials pointed to or included in environment variables
|
|
39
|
+
4. Credentials found in local ADC file
|
|
40
|
+
5. Credentials returned by the metadata server for the attached service account (GCP)
|
|
74
41
|
|
|
75
|
-
|
|
76
|
-
require "google/cloud/apigee_connect/v1"
|
|
77
|
-
|
|
78
|
-
ENV["APIGEE_CONNECT_CREDENTIALS"] = "path/to/keyfile.json"
|
|
42
|
+
### Configuration
|
|
79
43
|
|
|
80
|
-
client
|
|
81
|
-
|
|
44
|
+
You can configure a path to a JSON credentials file, either for an individual client object or
|
|
45
|
+
globally, for all client objects. The JSON file can contain credentials created for
|
|
46
|
+
[workload identity federation](https://cloud.google.com/iam/docs/workload-identity-federation),
|
|
47
|
+
[workforce identity federation](https://cloud.google.com/iam/docs/workforce-identity-federation), or a
|
|
48
|
+
[service account key](https://cloud.google.com/docs/authentication/provide-credentials-adc#local-key).
|
|
82
49
|
|
|
83
|
-
|
|
50
|
+
Note: Service account keys are a security risk if not managed correctly. You should
|
|
51
|
+
[choose a more secure alternative to service account keys](https://cloud.google.com/docs/authentication#auth-decision-tree)
|
|
52
|
+
whenever possible.
|
|
84
53
|
|
|
85
|
-
|
|
86
|
-
it in an environment variable. Either on an individual client initialization:
|
|
54
|
+
To configure a credentials file for an individual client initialization:
|
|
87
55
|
|
|
88
56
|
```ruby
|
|
89
57
|
require "google/cloud/apigee_connect/v1"
|
|
90
58
|
|
|
91
59
|
client = ::Google::Cloud::ApigeeConnect::V1::ConnectionService::Client.new do |config|
|
|
92
|
-
config.credentials = "path/to/
|
|
60
|
+
config.credentials = "path/to/credentialfile.json"
|
|
93
61
|
end
|
|
94
62
|
```
|
|
95
63
|
|
|
96
|
-
|
|
64
|
+
To configure a credentials file globally for all clients:
|
|
97
65
|
|
|
98
66
|
```ruby
|
|
99
67
|
require "google/cloud/apigee_connect/v1"
|
|
100
68
|
|
|
101
69
|
::Google::Cloud::ApigeeConnect::V1::ConnectionService::Client.configure do |config|
|
|
102
|
-
config.credentials = "path/to/
|
|
70
|
+
config.credentials = "path/to/credentialfile.json"
|
|
103
71
|
end
|
|
104
72
|
|
|
105
73
|
client = ::Google::Cloud::ApigeeConnect::V1::ConnectionService::Client.new
|
|
106
74
|
```
|
|
107
75
|
|
|
108
|
-
###
|
|
76
|
+
### Environment Variables
|
|
109
77
|
|
|
110
|
-
|
|
111
|
-
|
|
112
|
-
|
|
78
|
+
You can also use an environment variable to provide a JSON credentials file.
|
|
79
|
+
The environment variable can contain a path to the credentials file or, for
|
|
80
|
+
environments such as Docker containers where writing files is not encouraged,
|
|
81
|
+
you can include the credentials file itself.
|
|
113
82
|
|
|
114
|
-
|
|
83
|
+
The JSON file can contain credentials created for
|
|
84
|
+
[workload identity federation](https://cloud.google.com/iam/docs/workload-identity-federation),
|
|
85
|
+
[workforce identity federation](https://cloud.google.com/iam/docs/workforce-identity-federation), or a
|
|
86
|
+
[service account key](https://cloud.google.com/docs/authentication/provide-credentials-adc#local-key).
|
|
115
87
|
|
|
116
|
-
|
|
117
|
-
|
|
118
|
-
|
|
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-apigee_connect-v1
|
|
93
|
+
checks for credentials are:
|
|
119
94
|
|
|
120
|
-
|
|
121
|
-
*
|
|
95
|
+
* `GOOGLE_CLOUD_CREDENTIALS` - Path to JSON file, or JSON contents
|
|
96
|
+
* `GOOGLE_APPLICATION_CREDENTIALS` - Path to JSON file
|
|
122
97
|
|
|
123
|
-
|
|
98
|
+
```ruby
|
|
99
|
+
require "google/cloud/apigee_connect/v1"
|
|
124
100
|
|
|
125
|
-
|
|
126
|
-
connect to the APIs. You will use the **JSON key file** to
|
|
127
|
-
connect to most services with google-cloud-apigee_connect-v1.
|
|
101
|
+
ENV["GOOGLE_APPLICATION_CREDENTIALS"] = "path/to/credentialfile.json"
|
|
128
102
|
|
|
129
|
-
|
|
130
|
-
|
|
131
|
-
need a Google Developers service account.
|
|
103
|
+
client = ::Google::Cloud::ApigeeConnect::V1::ConnectionService::Client.new
|
|
104
|
+
```
|
|
132
105
|
|
|
133
|
-
|
|
134
|
-
2. Create a new project or click on an existing project.
|
|
135
|
-
3. Activate the menu in the upper left and select **APIs & Services**. From
|
|
136
|
-
here, you will enable the APIs that your application requires.
|
|
106
|
+
### Local ADC file
|
|
137
107
|
|
|
138
|
-
|
|
108
|
+
You can set up a local ADC file with your user credentials for authentication during
|
|
109
|
+
development. If credentials are not provided in code or in environment variables,
|
|
110
|
+
then the local ADC credentials are discovered.
|
|
139
111
|
|
|
140
|
-
|
|
112
|
+
Follow the steps in [Quickstart](#quickstart) to set up a local ADC file.
|
|
141
113
|
|
|
142
|
-
|
|
143
|
-
"Service account" to be guided through downloading a new JSON key file.
|
|
114
|
+
### Google Cloud Platform environments
|
|
144
115
|
|
|
145
|
-
|
|
146
|
-
|
|
147
|
-
|
|
148
|
-
|
|
116
|
+
When running on Google Cloud Platform (GCP), including Google Compute Engine
|
|
117
|
+
(GCE), Google Kubernetes Engine (GKE), Google App Engine (GAE), Google Cloud
|
|
118
|
+
Functions (GCF) and Cloud Run, credentials are retrieved from the attached
|
|
119
|
+
service account automatically. Code should be written as if already authenticated.
|
|
149
120
|
|
|
150
|
-
|
|
151
|
-
|
|
121
|
+
For more information, see
|
|
122
|
+
[Set up ADC for Google Cloud services](https://cloud.google.com/docs/authentication/provide-credentials-adc#attached-sa).
|
|
@@ -30,6 +30,9 @@ module Google
|
|
|
30
30
|
# Service Interface for the Apigee Connect connection management APIs.
|
|
31
31
|
#
|
|
32
32
|
class Client
|
|
33
|
+
# @private
|
|
34
|
+
DEFAULT_ENDPOINT_TEMPLATE = "apigeeconnect.$UNIVERSE_DOMAIN$"
|
|
35
|
+
|
|
33
36
|
include Paths
|
|
34
37
|
|
|
35
38
|
# @private
|
|
@@ -95,6 +98,15 @@ module Google
|
|
|
95
98
|
@config
|
|
96
99
|
end
|
|
97
100
|
|
|
101
|
+
##
|
|
102
|
+
# The effective universe domain
|
|
103
|
+
#
|
|
104
|
+
# @return [String]
|
|
105
|
+
#
|
|
106
|
+
def universe_domain
|
|
107
|
+
@connection_service_stub.universe_domain
|
|
108
|
+
end
|
|
109
|
+
|
|
98
110
|
##
|
|
99
111
|
# Create a new ConnectionService client object.
|
|
100
112
|
#
|
|
@@ -128,8 +140,9 @@ module Google
|
|
|
128
140
|
credentials = @config.credentials
|
|
129
141
|
# Use self-signed JWT if the endpoint is unchanged from default,
|
|
130
142
|
# but only if the default endpoint does not have a region prefix.
|
|
131
|
-
enable_self_signed_jwt = @config.endpoint
|
|
132
|
-
|
|
143
|
+
enable_self_signed_jwt = @config.endpoint.nil? ||
|
|
144
|
+
(@config.endpoint == Configuration::DEFAULT_ENDPOINT &&
|
|
145
|
+
!@config.endpoint.split(".").first.include?("-"))
|
|
133
146
|
credentials ||= Credentials.default scope: @config.scope,
|
|
134
147
|
enable_self_signed_jwt: enable_self_signed_jwt
|
|
135
148
|
if credentials.is_a?(::String) || credentials.is_a?(::Hash)
|
|
@@ -140,8 +153,10 @@ module Google
|
|
|
140
153
|
|
|
141
154
|
@connection_service_stub = ::Gapic::ServiceStub.new(
|
|
142
155
|
::Google::Cloud::ApigeeConnect::V1::ConnectionService::Stub,
|
|
143
|
-
credentials:
|
|
144
|
-
endpoint:
|
|
156
|
+
credentials: credentials,
|
|
157
|
+
endpoint: @config.endpoint,
|
|
158
|
+
endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
|
|
159
|
+
universe_domain: @config.universe_domain,
|
|
145
160
|
channel_args: @config.channel_args,
|
|
146
161
|
interceptors: @config.interceptors,
|
|
147
162
|
channel_pool_config: @config.channel_pool
|
|
@@ -282,9 +297,9 @@ module Google
|
|
|
282
297
|
# end
|
|
283
298
|
#
|
|
284
299
|
# @!attribute [rw] endpoint
|
|
285
|
-
#
|
|
286
|
-
#
|
|
287
|
-
# @return [::String]
|
|
300
|
+
# A custom service endpoint, as a hostname or hostname:port. The default is
|
|
301
|
+
# nil, indicating to use the default endpoint in the current universe domain.
|
|
302
|
+
# @return [::String,nil]
|
|
288
303
|
# @!attribute [rw] credentials
|
|
289
304
|
# Credentials to send with calls. You may provide any of the following types:
|
|
290
305
|
# * (`String`) The path to a service account key file in JSON format
|
|
@@ -330,13 +345,20 @@ module Google
|
|
|
330
345
|
# @!attribute [rw] quota_project
|
|
331
346
|
# A separate project against which to charge quota.
|
|
332
347
|
# @return [::String]
|
|
348
|
+
# @!attribute [rw] universe_domain
|
|
349
|
+
# The universe domain within which to make requests. This determines the
|
|
350
|
+
# default endpoint URL. The default value of nil uses the environment
|
|
351
|
+
# universe (usually the default "googleapis.com" universe).
|
|
352
|
+
# @return [::String,nil]
|
|
333
353
|
#
|
|
334
354
|
class Configuration
|
|
335
355
|
extend ::Gapic::Config
|
|
336
356
|
|
|
357
|
+
# @private
|
|
358
|
+
# The endpoint specific to the default "googleapis.com" universe. Deprecated.
|
|
337
359
|
DEFAULT_ENDPOINT = "apigeeconnect.googleapis.com"
|
|
338
360
|
|
|
339
|
-
config_attr :endpoint,
|
|
361
|
+
config_attr :endpoint, nil, ::String, nil
|
|
340
362
|
config_attr :credentials, nil do |value|
|
|
341
363
|
allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
|
|
342
364
|
allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
|
|
@@ -351,6 +373,7 @@ module Google
|
|
|
351
373
|
config_attr :metadata, nil, ::Hash, nil
|
|
352
374
|
config_attr :retry_policy, nil, ::Hash, ::Proc, nil
|
|
353
375
|
config_attr :quota_project, nil, ::String, nil
|
|
376
|
+
config_attr :universe_domain, nil, ::String, nil
|
|
354
377
|
|
|
355
378
|
# @private
|
|
356
379
|
def initialize parent_config = nil
|
|
@@ -32,6 +32,9 @@ module Google
|
|
|
32
32
|
# Service Interface for the Apigee Connect connection management APIs.
|
|
33
33
|
#
|
|
34
34
|
class Client
|
|
35
|
+
# @private
|
|
36
|
+
DEFAULT_ENDPOINT_TEMPLATE = "apigeeconnect.$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
|
+
@connection_service_stub.universe_domain
|
|
110
|
+
end
|
|
111
|
+
|
|
100
112
|
##
|
|
101
113
|
# Create a new ConnectionService REST client object.
|
|
102
114
|
#
|
|
@@ -124,8 +136,9 @@ module Google
|
|
|
124
136
|
credentials = @config.credentials
|
|
125
137
|
# Use self-signed JWT if the endpoint is unchanged from default,
|
|
126
138
|
# but only if the default endpoint does not have a region prefix.
|
|
127
|
-
enable_self_signed_jwt = @config.endpoint
|
|
128
|
-
|
|
139
|
+
enable_self_signed_jwt = @config.endpoint.nil? ||
|
|
140
|
+
(@config.endpoint == Configuration::DEFAULT_ENDPOINT &&
|
|
141
|
+
!@config.endpoint.split(".").first.include?("-"))
|
|
129
142
|
credentials ||= Credentials.default scope: @config.scope,
|
|
130
143
|
enable_self_signed_jwt: enable_self_signed_jwt
|
|
131
144
|
if credentials.is_a?(::String) || credentials.is_a?(::Hash)
|
|
@@ -135,7 +148,12 @@ module Google
|
|
|
135
148
|
@quota_project_id = @config.quota_project
|
|
136
149
|
@quota_project_id ||= credentials.quota_project_id if credentials.respond_to? :quota_project_id
|
|
137
150
|
|
|
138
|
-
@connection_service_stub = ::Google::Cloud::ApigeeConnect::V1::ConnectionService::Rest::ServiceStub.new
|
|
151
|
+
@connection_service_stub = ::Google::Cloud::ApigeeConnect::V1::ConnectionService::Rest::ServiceStub.new(
|
|
152
|
+
endpoint: @config.endpoint,
|
|
153
|
+
endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
|
|
154
|
+
universe_domain: @config.universe_domain,
|
|
155
|
+
credentials: credentials
|
|
156
|
+
)
|
|
139
157
|
end
|
|
140
158
|
|
|
141
159
|
# Service calls
|
|
@@ -265,9 +283,9 @@ module Google
|
|
|
265
283
|
# end
|
|
266
284
|
#
|
|
267
285
|
# @!attribute [rw] endpoint
|
|
268
|
-
#
|
|
269
|
-
#
|
|
270
|
-
# @return [::String]
|
|
286
|
+
# A custom service endpoint, as a hostname or hostname:port. The default is
|
|
287
|
+
# nil, indicating to use the default endpoint in the current universe domain.
|
|
288
|
+
# @return [::String,nil]
|
|
271
289
|
# @!attribute [rw] credentials
|
|
272
290
|
# Credentials to send with calls. You may provide any of the following types:
|
|
273
291
|
# * (`String`) The path to a service account key file in JSON format
|
|
@@ -304,13 +322,20 @@ module Google
|
|
|
304
322
|
# @!attribute [rw] quota_project
|
|
305
323
|
# A separate project against which to charge quota.
|
|
306
324
|
# @return [::String]
|
|
325
|
+
# @!attribute [rw] universe_domain
|
|
326
|
+
# The universe domain within which to make requests. This determines the
|
|
327
|
+
# default endpoint URL. The default value of nil uses the environment
|
|
328
|
+
# universe (usually the default "googleapis.com" universe).
|
|
329
|
+
# @return [::String,nil]
|
|
307
330
|
#
|
|
308
331
|
class Configuration
|
|
309
332
|
extend ::Gapic::Config
|
|
310
333
|
|
|
334
|
+
# @private
|
|
335
|
+
# The endpoint specific to the default "googleapis.com" universe. Deprecated.
|
|
311
336
|
DEFAULT_ENDPOINT = "apigeeconnect.googleapis.com"
|
|
312
337
|
|
|
313
|
-
config_attr :endpoint,
|
|
338
|
+
config_attr :endpoint, nil, ::String, nil
|
|
314
339
|
config_attr :credentials, nil do |value|
|
|
315
340
|
allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
|
|
316
341
|
allowed.any? { |klass| klass === value }
|
|
@@ -322,6 +347,7 @@ module Google
|
|
|
322
347
|
config_attr :metadata, nil, ::Hash, nil
|
|
323
348
|
config_attr :retry_policy, nil, ::Hash, ::Proc, nil
|
|
324
349
|
config_attr :quota_project, nil, ::String, nil
|
|
350
|
+
config_attr :universe_domain, nil, ::String, nil
|
|
325
351
|
|
|
326
352
|
# @private
|
|
327
353
|
def initialize parent_config = nil
|
|
@@ -30,16 +30,28 @@ module Google
|
|
|
30
30
|
# including transcoding, making the REST call, and deserialing the response.
|
|
31
31
|
#
|
|
32
32
|
class ServiceStub
|
|
33
|
-
def initialize endpoint:, credentials:
|
|
33
|
+
def initialize endpoint:, endpoint_template:, universe_domain:, credentials:
|
|
34
34
|
# These require statements are intentionally placed here to initialize
|
|
35
35
|
# the REST modules only when it's required.
|
|
36
36
|
require "gapic/rest"
|
|
37
37
|
|
|
38
|
-
@client_stub = ::Gapic::Rest::ClientStub.new endpoint: endpoint,
|
|
38
|
+
@client_stub = ::Gapic::Rest::ClientStub.new endpoint: endpoint,
|
|
39
|
+
endpoint_template: endpoint_template,
|
|
40
|
+
universe_domain: universe_domain,
|
|
41
|
+
credentials: credentials,
|
|
39
42
|
numeric_enums: true,
|
|
40
43
|
raise_faraday_errors: false
|
|
41
44
|
end
|
|
42
45
|
|
|
46
|
+
##
|
|
47
|
+
# The effective universe domain
|
|
48
|
+
#
|
|
49
|
+
# @return [String]
|
|
50
|
+
#
|
|
51
|
+
def universe_domain
|
|
52
|
+
@client_stub.universe_domain
|
|
53
|
+
end
|
|
54
|
+
|
|
43
55
|
##
|
|
44
56
|
# Baseline implementation for the list_connections REST call
|
|
45
57
|
#
|
|
@@ -32,6 +32,9 @@ module Google
|
|
|
32
32
|
# requiring customers to open firewalls on their runtime plane.
|
|
33
33
|
#
|
|
34
34
|
class Client
|
|
35
|
+
# @private
|
|
36
|
+
DEFAULT_ENDPOINT_TEMPLATE = "apigeeconnect.$UNIVERSE_DOMAIN$"
|
|
37
|
+
|
|
35
38
|
# @private
|
|
36
39
|
attr_reader :tether_stub
|
|
37
40
|
|
|
@@ -90,6 +93,15 @@ module Google
|
|
|
90
93
|
@config
|
|
91
94
|
end
|
|
92
95
|
|
|
96
|
+
##
|
|
97
|
+
# The effective universe domain
|
|
98
|
+
#
|
|
99
|
+
# @return [String]
|
|
100
|
+
#
|
|
101
|
+
def universe_domain
|
|
102
|
+
@tether_stub.universe_domain
|
|
103
|
+
end
|
|
104
|
+
|
|
93
105
|
##
|
|
94
106
|
# Create a new Tether client object.
|
|
95
107
|
#
|
|
@@ -123,8 +135,9 @@ module Google
|
|
|
123
135
|
credentials = @config.credentials
|
|
124
136
|
# Use self-signed JWT if the endpoint is unchanged from default,
|
|
125
137
|
# but only if the default endpoint does not have a region prefix.
|
|
126
|
-
enable_self_signed_jwt = @config.endpoint
|
|
127
|
-
|
|
138
|
+
enable_self_signed_jwt = @config.endpoint.nil? ||
|
|
139
|
+
(@config.endpoint == Configuration::DEFAULT_ENDPOINT &&
|
|
140
|
+
!@config.endpoint.split(".").first.include?("-"))
|
|
128
141
|
credentials ||= Credentials.default scope: @config.scope,
|
|
129
142
|
enable_self_signed_jwt: enable_self_signed_jwt
|
|
130
143
|
if credentials.is_a?(::String) || credentials.is_a?(::Hash)
|
|
@@ -135,8 +148,10 @@ module Google
|
|
|
135
148
|
|
|
136
149
|
@tether_stub = ::Gapic::ServiceStub.new(
|
|
137
150
|
::Google::Cloud::ApigeeConnect::V1::Tether::Stub,
|
|
138
|
-
credentials:
|
|
139
|
-
endpoint:
|
|
151
|
+
credentials: credentials,
|
|
152
|
+
endpoint: @config.endpoint,
|
|
153
|
+
endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
|
|
154
|
+
universe_domain: @config.universe_domain,
|
|
140
155
|
channel_args: @config.channel_args,
|
|
141
156
|
interceptors: @config.interceptors,
|
|
142
157
|
channel_pool_config: @config.channel_pool
|
|
@@ -259,9 +274,9 @@ module Google
|
|
|
259
274
|
# end
|
|
260
275
|
#
|
|
261
276
|
# @!attribute [rw] endpoint
|
|
262
|
-
#
|
|
263
|
-
#
|
|
264
|
-
# @return [::String]
|
|
277
|
+
# A custom service endpoint, as a hostname or hostname:port. The default is
|
|
278
|
+
# nil, indicating to use the default endpoint in the current universe domain.
|
|
279
|
+
# @return [::String,nil]
|
|
265
280
|
# @!attribute [rw] credentials
|
|
266
281
|
# Credentials to send with calls. You may provide any of the following types:
|
|
267
282
|
# * (`String`) The path to a service account key file in JSON format
|
|
@@ -307,13 +322,20 @@ module Google
|
|
|
307
322
|
# @!attribute [rw] quota_project
|
|
308
323
|
# A separate project against which to charge quota.
|
|
309
324
|
# @return [::String]
|
|
325
|
+
# @!attribute [rw] universe_domain
|
|
326
|
+
# The universe domain within which to make requests. This determines the
|
|
327
|
+
# default endpoint URL. The default value of nil uses the environment
|
|
328
|
+
# universe (usually the default "googleapis.com" universe).
|
|
329
|
+
# @return [::String,nil]
|
|
310
330
|
#
|
|
311
331
|
class Configuration
|
|
312
332
|
extend ::Gapic::Config
|
|
313
333
|
|
|
334
|
+
# @private
|
|
335
|
+
# The endpoint specific to the default "googleapis.com" universe. Deprecated.
|
|
314
336
|
DEFAULT_ENDPOINT = "apigeeconnect.googleapis.com"
|
|
315
337
|
|
|
316
|
-
config_attr :endpoint,
|
|
338
|
+
config_attr :endpoint, nil, ::String, nil
|
|
317
339
|
config_attr :credentials, nil do |value|
|
|
318
340
|
allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
|
|
319
341
|
allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
|
|
@@ -328,6 +350,7 @@ module Google
|
|
|
328
350
|
config_attr :metadata, nil, ::Hash, nil
|
|
329
351
|
config_attr :retry_policy, nil, ::Hash, ::Proc, nil
|
|
330
352
|
config_attr :quota_project, nil, ::String, nil
|
|
353
|
+
config_attr :universe_domain, nil, ::String, nil
|
|
331
354
|
|
|
332
355
|
# @private
|
|
333
356
|
def initialize parent_config = nil
|
|
@@ -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-apigee_connect-v1
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 0.
|
|
4
|
+
version: 0.6.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
|
|
@@ -219,7 +219,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
|
|
|
219
219
|
- !ruby/object:Gem::Version
|
|
220
220
|
version: '0'
|
|
221
221
|
requirements: []
|
|
222
|
-
rubygems_version: 3.
|
|
222
|
+
rubygems_version: 3.5.3
|
|
223
223
|
signing_key:
|
|
224
224
|
specification_version: 4
|
|
225
225
|
summary: API Client library for the Apigee Connect V1 API
|