google-cloud-api_gateway-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/api_gateway/v1/api_gateway_service/client.rb +32 -8
- data/lib/google/cloud/api_gateway/v1/api_gateway_service/operations.rb +28 -6
- data/lib/google/cloud/api_gateway/v1/api_gateway_service/rest/client.rb +34 -7
- data/lib/google/cloud/api_gateway/v1/api_gateway_service/rest/operations.rb +33 -8
- data/lib/google/cloud/api_gateway/v1/api_gateway_service/rest/service_stub.rb +14 -2
- data/lib/google/cloud/api_gateway/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: 2b9655532a864c6ccd955d38258464dbb4cf870483058b84385b5cf073db7d3f
|
|
4
|
+
data.tar.gz: 7e6c8648002527dbae4dac38f1cdcae26c0bb1fdd8c7c6d9fb0df55e6ef524d8
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 70a58f4d0d65cbf403cc7c95557ff2219a15f6e3c08e33e389e8d54758c58994641c517d43419e19fe2ce9a067031beb1cb49e39e8e9e9222422b65760bf51de
|
|
7
|
+
data.tar.gz: a5da77d4b29c712e4388797a40bf11820bb234d8507aed5e759b5479db48e0c831ae86c5a2e5243996198cdf9ed493e80d58314bf650f7bbe11a230eb6f72f73
|
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-api_gateway-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-api_gateway-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-api_gateway-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::ApiGateway::V1::ApiGatewayService::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/api_gateway/v1"
|
|
77
|
-
|
|
78
|
-
ENV["API_GATEWAY_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/api_gateway/v1"
|
|
90
58
|
|
|
91
59
|
client = ::Google::Cloud::ApiGateway::V1::ApiGatewayService::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/api_gateway/v1"
|
|
100
68
|
|
|
101
69
|
::Google::Cloud::ApiGateway::V1::ApiGatewayService::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::ApiGateway::V1::ApiGatewayService::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-api_gateway-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/api_gateway/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-api_gateway-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::ApiGateway::V1::ApiGatewayService::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
|
# The API Gateway Service is the interface for managing API Gateways.
|
|
31
31
|
#
|
|
32
32
|
class Client
|
|
33
|
+
# @private
|
|
34
|
+
DEFAULT_ENDPOINT_TEMPLATE = "apigateway.$UNIVERSE_DOMAIN$"
|
|
35
|
+
|
|
33
36
|
include Paths
|
|
34
37
|
|
|
35
38
|
# @private
|
|
@@ -135,6 +138,15 @@ module Google
|
|
|
135
138
|
@config
|
|
136
139
|
end
|
|
137
140
|
|
|
141
|
+
##
|
|
142
|
+
# The effective universe domain
|
|
143
|
+
#
|
|
144
|
+
# @return [String]
|
|
145
|
+
#
|
|
146
|
+
def universe_domain
|
|
147
|
+
@api_gateway_service_stub.universe_domain
|
|
148
|
+
end
|
|
149
|
+
|
|
138
150
|
##
|
|
139
151
|
# Create a new ApiGatewayService client object.
|
|
140
152
|
#
|
|
@@ -168,8 +180,9 @@ module Google
|
|
|
168
180
|
credentials = @config.credentials
|
|
169
181
|
# Use self-signed JWT if the endpoint is unchanged from default,
|
|
170
182
|
# but only if the default endpoint does not have a region prefix.
|
|
171
|
-
enable_self_signed_jwt = @config.endpoint
|
|
172
|
-
|
|
183
|
+
enable_self_signed_jwt = @config.endpoint.nil? ||
|
|
184
|
+
(@config.endpoint == Configuration::DEFAULT_ENDPOINT &&
|
|
185
|
+
!@config.endpoint.split(".").first.include?("-"))
|
|
173
186
|
credentials ||= Credentials.default scope: @config.scope,
|
|
174
187
|
enable_self_signed_jwt: enable_self_signed_jwt
|
|
175
188
|
if credentials.is_a?(::String) || credentials.is_a?(::Hash)
|
|
@@ -182,12 +195,15 @@ module Google
|
|
|
182
195
|
config.credentials = credentials
|
|
183
196
|
config.quota_project = @quota_project_id
|
|
184
197
|
config.endpoint = @config.endpoint
|
|
198
|
+
config.universe_domain = @config.universe_domain
|
|
185
199
|
end
|
|
186
200
|
|
|
187
201
|
@api_gateway_service_stub = ::Gapic::ServiceStub.new(
|
|
188
202
|
::Google::Cloud::ApiGateway::V1::ApiGatewayService::Stub,
|
|
189
|
-
credentials:
|
|
190
|
-
endpoint:
|
|
203
|
+
credentials: credentials,
|
|
204
|
+
endpoint: @config.endpoint,
|
|
205
|
+
endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
|
|
206
|
+
universe_domain: @config.universe_domain,
|
|
191
207
|
channel_args: @config.channel_args,
|
|
192
208
|
interceptors: @config.interceptors,
|
|
193
209
|
channel_pool_config: @config.channel_pool
|
|
@@ -1667,9 +1683,9 @@ module Google
|
|
|
1667
1683
|
# end
|
|
1668
1684
|
#
|
|
1669
1685
|
# @!attribute [rw] endpoint
|
|
1670
|
-
#
|
|
1671
|
-
#
|
|
1672
|
-
# @return [::String]
|
|
1686
|
+
# A custom service endpoint, as a hostname or hostname:port. The default is
|
|
1687
|
+
# nil, indicating to use the default endpoint in the current universe domain.
|
|
1688
|
+
# @return [::String,nil]
|
|
1673
1689
|
# @!attribute [rw] credentials
|
|
1674
1690
|
# Credentials to send with calls. You may provide any of the following types:
|
|
1675
1691
|
# * (`String`) The path to a service account key file in JSON format
|
|
@@ -1715,13 +1731,20 @@ module Google
|
|
|
1715
1731
|
# @!attribute [rw] quota_project
|
|
1716
1732
|
# A separate project against which to charge quota.
|
|
1717
1733
|
# @return [::String]
|
|
1734
|
+
# @!attribute [rw] universe_domain
|
|
1735
|
+
# The universe domain within which to make requests. This determines the
|
|
1736
|
+
# default endpoint URL. The default value of nil uses the environment
|
|
1737
|
+
# universe (usually the default "googleapis.com" universe).
|
|
1738
|
+
# @return [::String,nil]
|
|
1718
1739
|
#
|
|
1719
1740
|
class Configuration
|
|
1720
1741
|
extend ::Gapic::Config
|
|
1721
1742
|
|
|
1743
|
+
# @private
|
|
1744
|
+
# The endpoint specific to the default "googleapis.com" universe. Deprecated.
|
|
1722
1745
|
DEFAULT_ENDPOINT = "apigateway.googleapis.com"
|
|
1723
1746
|
|
|
1724
|
-
config_attr :endpoint,
|
|
1747
|
+
config_attr :endpoint, nil, ::String, nil
|
|
1725
1748
|
config_attr :credentials, nil do |value|
|
|
1726
1749
|
allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
|
|
1727
1750
|
allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
|
|
@@ -1736,6 +1759,7 @@ module Google
|
|
|
1736
1759
|
config_attr :metadata, nil, ::Hash, nil
|
|
1737
1760
|
config_attr :retry_policy, nil, ::Hash, ::Proc, nil
|
|
1738
1761
|
config_attr :quota_project, nil, ::String, nil
|
|
1762
|
+
config_attr :universe_domain, nil, ::String, nil
|
|
1739
1763
|
|
|
1740
1764
|
# @private
|
|
1741
1765
|
def initialize parent_config = nil
|
|
@@ -26,6 +26,9 @@ module Google
|
|
|
26
26
|
module ApiGatewayService
|
|
27
27
|
# Service that implements Longrunning Operations API.
|
|
28
28
|
class Operations
|
|
29
|
+
# @private
|
|
30
|
+
DEFAULT_ENDPOINT_TEMPLATE = "apigateway.$UNIVERSE_DOMAIN$"
|
|
31
|
+
|
|
29
32
|
# @private
|
|
30
33
|
attr_reader :operations_stub
|
|
31
34
|
|
|
@@ -60,6 +63,15 @@ module Google
|
|
|
60
63
|
@config
|
|
61
64
|
end
|
|
62
65
|
|
|
66
|
+
##
|
|
67
|
+
# The effective universe domain
|
|
68
|
+
#
|
|
69
|
+
# @return [String]
|
|
70
|
+
#
|
|
71
|
+
def universe_domain
|
|
72
|
+
@operations_stub.universe_domain
|
|
73
|
+
end
|
|
74
|
+
|
|
63
75
|
##
|
|
64
76
|
# Create a new Operations client object.
|
|
65
77
|
#
|
|
@@ -90,8 +102,10 @@ module Google
|
|
|
90
102
|
|
|
91
103
|
@operations_stub = ::Gapic::ServiceStub.new(
|
|
92
104
|
::Google::Longrunning::Operations::Stub,
|
|
93
|
-
credentials:
|
|
94
|
-
endpoint:
|
|
105
|
+
credentials: credentials,
|
|
106
|
+
endpoint: @config.endpoint,
|
|
107
|
+
endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
|
|
108
|
+
universe_domain: @config.universe_domain,
|
|
95
109
|
channel_args: @config.channel_args,
|
|
96
110
|
interceptors: @config.interceptors,
|
|
97
111
|
channel_pool_config: @config.channel_pool
|
|
@@ -613,9 +627,9 @@ module Google
|
|
|
613
627
|
# end
|
|
614
628
|
#
|
|
615
629
|
# @!attribute [rw] endpoint
|
|
616
|
-
#
|
|
617
|
-
#
|
|
618
|
-
# @return [::String]
|
|
630
|
+
# A custom service endpoint, as a hostname or hostname:port. The default is
|
|
631
|
+
# nil, indicating to use the default endpoint in the current universe domain.
|
|
632
|
+
# @return [::String,nil]
|
|
619
633
|
# @!attribute [rw] credentials
|
|
620
634
|
# Credentials to send with calls. You may provide any of the following types:
|
|
621
635
|
# * (`String`) The path to a service account key file in JSON format
|
|
@@ -661,13 +675,20 @@ module Google
|
|
|
661
675
|
# @!attribute [rw] quota_project
|
|
662
676
|
# A separate project against which to charge quota.
|
|
663
677
|
# @return [::String]
|
|
678
|
+
# @!attribute [rw] universe_domain
|
|
679
|
+
# The universe domain within which to make requests. This determines the
|
|
680
|
+
# default endpoint URL. The default value of nil uses the environment
|
|
681
|
+
# universe (usually the default "googleapis.com" universe).
|
|
682
|
+
# @return [::String,nil]
|
|
664
683
|
#
|
|
665
684
|
class Configuration
|
|
666
685
|
extend ::Gapic::Config
|
|
667
686
|
|
|
687
|
+
# @private
|
|
688
|
+
# The endpoint specific to the default "googleapis.com" universe. Deprecated.
|
|
668
689
|
DEFAULT_ENDPOINT = "apigateway.googleapis.com"
|
|
669
690
|
|
|
670
|
-
config_attr :endpoint,
|
|
691
|
+
config_attr :endpoint, nil, ::String, nil
|
|
671
692
|
config_attr :credentials, nil do |value|
|
|
672
693
|
allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
|
|
673
694
|
allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
|
|
@@ -682,6 +703,7 @@ module Google
|
|
|
682
703
|
config_attr :metadata, nil, ::Hash, nil
|
|
683
704
|
config_attr :retry_policy, nil, ::Hash, ::Proc, nil
|
|
684
705
|
config_attr :quota_project, nil, ::String, nil
|
|
706
|
+
config_attr :universe_domain, nil, ::String, nil
|
|
685
707
|
|
|
686
708
|
# @private
|
|
687
709
|
def initialize parent_config = nil
|
|
@@ -32,6 +32,9 @@ module Google
|
|
|
32
32
|
# The API Gateway Service is the interface for managing API Gateways.
|
|
33
33
|
#
|
|
34
34
|
class Client
|
|
35
|
+
# @private
|
|
36
|
+
DEFAULT_ENDPOINT_TEMPLATE = "apigateway.$UNIVERSE_DOMAIN$"
|
|
37
|
+
|
|
35
38
|
include Paths
|
|
36
39
|
|
|
37
40
|
# @private
|
|
@@ -137,6 +140,15 @@ module Google
|
|
|
137
140
|
@config
|
|
138
141
|
end
|
|
139
142
|
|
|
143
|
+
##
|
|
144
|
+
# The effective universe domain
|
|
145
|
+
#
|
|
146
|
+
# @return [String]
|
|
147
|
+
#
|
|
148
|
+
def universe_domain
|
|
149
|
+
@api_gateway_service_stub.universe_domain
|
|
150
|
+
end
|
|
151
|
+
|
|
140
152
|
##
|
|
141
153
|
# Create a new ApiGatewayService REST client object.
|
|
142
154
|
#
|
|
@@ -164,8 +176,9 @@ module Google
|
|
|
164
176
|
credentials = @config.credentials
|
|
165
177
|
# Use self-signed JWT if the endpoint is unchanged from default,
|
|
166
178
|
# but only if the default endpoint does not have a region prefix.
|
|
167
|
-
enable_self_signed_jwt = @config.endpoint
|
|
168
|
-
|
|
179
|
+
enable_self_signed_jwt = @config.endpoint.nil? ||
|
|
180
|
+
(@config.endpoint == Configuration::DEFAULT_ENDPOINT &&
|
|
181
|
+
!@config.endpoint.split(".").first.include?("-"))
|
|
169
182
|
credentials ||= Credentials.default scope: @config.scope,
|
|
170
183
|
enable_self_signed_jwt: enable_self_signed_jwt
|
|
171
184
|
if credentials.is_a?(::String) || credentials.is_a?(::Hash)
|
|
@@ -179,9 +192,15 @@ module Google
|
|
|
179
192
|
config.credentials = credentials
|
|
180
193
|
config.quota_project = @quota_project_id
|
|
181
194
|
config.endpoint = @config.endpoint
|
|
195
|
+
config.universe_domain = @config.universe_domain
|
|
182
196
|
end
|
|
183
197
|
|
|
184
|
-
@api_gateway_service_stub = ::Google::Cloud::ApiGateway::V1::ApiGatewayService::Rest::ServiceStub.new
|
|
198
|
+
@api_gateway_service_stub = ::Google::Cloud::ApiGateway::V1::ApiGatewayService::Rest::ServiceStub.new(
|
|
199
|
+
endpoint: @config.endpoint,
|
|
200
|
+
endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
|
|
201
|
+
universe_domain: @config.universe_domain,
|
|
202
|
+
credentials: credentials
|
|
203
|
+
)
|
|
185
204
|
end
|
|
186
205
|
|
|
187
206
|
##
|
|
@@ -1549,9 +1568,9 @@ module Google
|
|
|
1549
1568
|
# end
|
|
1550
1569
|
#
|
|
1551
1570
|
# @!attribute [rw] endpoint
|
|
1552
|
-
#
|
|
1553
|
-
#
|
|
1554
|
-
# @return [::String]
|
|
1571
|
+
# A custom service endpoint, as a hostname or hostname:port. The default is
|
|
1572
|
+
# nil, indicating to use the default endpoint in the current universe domain.
|
|
1573
|
+
# @return [::String,nil]
|
|
1555
1574
|
# @!attribute [rw] credentials
|
|
1556
1575
|
# Credentials to send with calls. You may provide any of the following types:
|
|
1557
1576
|
# * (`String`) The path to a service account key file in JSON format
|
|
@@ -1588,13 +1607,20 @@ module Google
|
|
|
1588
1607
|
# @!attribute [rw] quota_project
|
|
1589
1608
|
# A separate project against which to charge quota.
|
|
1590
1609
|
# @return [::String]
|
|
1610
|
+
# @!attribute [rw] universe_domain
|
|
1611
|
+
# The universe domain within which to make requests. This determines the
|
|
1612
|
+
# default endpoint URL. The default value of nil uses the environment
|
|
1613
|
+
# universe (usually the default "googleapis.com" universe).
|
|
1614
|
+
# @return [::String,nil]
|
|
1591
1615
|
#
|
|
1592
1616
|
class Configuration
|
|
1593
1617
|
extend ::Gapic::Config
|
|
1594
1618
|
|
|
1619
|
+
# @private
|
|
1620
|
+
# The endpoint specific to the default "googleapis.com" universe. Deprecated.
|
|
1595
1621
|
DEFAULT_ENDPOINT = "apigateway.googleapis.com"
|
|
1596
1622
|
|
|
1597
|
-
config_attr :endpoint,
|
|
1623
|
+
config_attr :endpoint, nil, ::String, nil
|
|
1598
1624
|
config_attr :credentials, nil do |value|
|
|
1599
1625
|
allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
|
|
1600
1626
|
allowed.any? { |klass| klass === value }
|
|
@@ -1606,6 +1632,7 @@ module Google
|
|
|
1606
1632
|
config_attr :metadata, nil, ::Hash, nil
|
|
1607
1633
|
config_attr :retry_policy, nil, ::Hash, ::Proc, nil
|
|
1608
1634
|
config_attr :quota_project, nil, ::String, nil
|
|
1635
|
+
config_attr :universe_domain, nil, ::String, nil
|
|
1609
1636
|
|
|
1610
1637
|
# @private
|
|
1611
1638
|
def initialize parent_config = nil
|
|
@@ -26,6 +26,9 @@ module Google
|
|
|
26
26
|
module Rest
|
|
27
27
|
# Service that implements Longrunning Operations API.
|
|
28
28
|
class Operations
|
|
29
|
+
# @private
|
|
30
|
+
DEFAULT_ENDPOINT_TEMPLATE = "apigateway.$UNIVERSE_DOMAIN$"
|
|
31
|
+
|
|
29
32
|
# @private
|
|
30
33
|
attr_reader :operations_stub
|
|
31
34
|
|
|
@@ -60,6 +63,15 @@ module Google
|
|
|
60
63
|
@config
|
|
61
64
|
end
|
|
62
65
|
|
|
66
|
+
##
|
|
67
|
+
# The effective universe domain
|
|
68
|
+
#
|
|
69
|
+
# @return [String]
|
|
70
|
+
#
|
|
71
|
+
def universe_domain
|
|
72
|
+
@operations_stub.universe_domain
|
|
73
|
+
end
|
|
74
|
+
|
|
63
75
|
##
|
|
64
76
|
# Create a new Operations client object.
|
|
65
77
|
#
|
|
@@ -84,8 +96,10 @@ module Google
|
|
|
84
96
|
@quota_project_id ||= credentials.quota_project_id if credentials.respond_to? :quota_project_id
|
|
85
97
|
|
|
86
98
|
@operations_stub = OperationsServiceStub.new(
|
|
87
|
-
endpoint:
|
|
88
|
-
|
|
99
|
+
endpoint: @config.endpoint,
|
|
100
|
+
endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
|
|
101
|
+
universe_domain: @config.universe_domain,
|
|
102
|
+
credentials: credentials
|
|
89
103
|
)
|
|
90
104
|
|
|
91
105
|
# Used by an LRO wrapper for some methods of this service
|
|
@@ -478,9 +492,9 @@ module Google
|
|
|
478
492
|
# end
|
|
479
493
|
#
|
|
480
494
|
# @!attribute [rw] endpoint
|
|
481
|
-
#
|
|
482
|
-
#
|
|
483
|
-
# @return [::String]
|
|
495
|
+
# A custom service endpoint, as a hostname or hostname:port. The default is
|
|
496
|
+
# nil, indicating to use the default endpoint in the current universe domain.
|
|
497
|
+
# @return [::String,nil]
|
|
484
498
|
# @!attribute [rw] credentials
|
|
485
499
|
# Credentials to send with calls. You may provide any of the following types:
|
|
486
500
|
# * (`String`) The path to a service account key file in JSON format
|
|
@@ -517,13 +531,20 @@ module Google
|
|
|
517
531
|
# @!attribute [rw] quota_project
|
|
518
532
|
# A separate project against which to charge quota.
|
|
519
533
|
# @return [::String]
|
|
534
|
+
# @!attribute [rw] universe_domain
|
|
535
|
+
# The universe domain within which to make requests. This determines the
|
|
536
|
+
# default endpoint URL. The default value of nil uses the environment
|
|
537
|
+
# universe (usually the default "googleapis.com" universe).
|
|
538
|
+
# @return [::String,nil]
|
|
520
539
|
#
|
|
521
540
|
class Configuration
|
|
522
541
|
extend ::Gapic::Config
|
|
523
542
|
|
|
543
|
+
# @private
|
|
544
|
+
# The endpoint specific to the default "googleapis.com" universe. Deprecated.
|
|
524
545
|
DEFAULT_ENDPOINT = "apigateway.googleapis.com"
|
|
525
546
|
|
|
526
|
-
config_attr :endpoint,
|
|
547
|
+
config_attr :endpoint, nil, ::String, nil
|
|
527
548
|
config_attr :credentials, nil do |value|
|
|
528
549
|
allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
|
|
529
550
|
allowed.any? { |klass| klass === value }
|
|
@@ -535,6 +556,7 @@ module Google
|
|
|
535
556
|
config_attr :metadata, nil, ::Hash, nil
|
|
536
557
|
config_attr :retry_policy, nil, ::Hash, ::Proc, nil
|
|
537
558
|
config_attr :quota_project, nil, ::String, nil
|
|
559
|
+
config_attr :universe_domain, nil, ::String, nil
|
|
538
560
|
|
|
539
561
|
# @private
|
|
540
562
|
def initialize parent_config = nil
|
|
@@ -617,12 +639,15 @@ module Google
|
|
|
617
639
|
# Service stub contains baseline method implementations
|
|
618
640
|
# including transcoding, making the REST call, and deserialing the response.
|
|
619
641
|
class OperationsServiceStub
|
|
620
|
-
def initialize endpoint:, credentials:
|
|
642
|
+
def initialize endpoint:, endpoint_template:, universe_domain:, credentials:
|
|
621
643
|
# These require statements are intentionally placed here to initialize
|
|
622
644
|
# the REST modules only when it's required.
|
|
623
645
|
require "gapic/rest"
|
|
624
646
|
|
|
625
|
-
@client_stub = ::Gapic::Rest::ClientStub.new endpoint: endpoint,
|
|
647
|
+
@client_stub = ::Gapic::Rest::ClientStub.new endpoint: endpoint,
|
|
648
|
+
endpoint_template: endpoint_template,
|
|
649
|
+
universe_domain: universe_domain,
|
|
650
|
+
credentials: credentials
|
|
626
651
|
end
|
|
627
652
|
|
|
628
653
|
##
|
|
@@ -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_gateways REST call
|
|
45
57
|
#
|
|
@@ -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-api_gateway-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
|
|
@@ -221,7 +221,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
|
|
|
221
221
|
- !ruby/object:Gem::Version
|
|
222
222
|
version: '0'
|
|
223
223
|
requirements: []
|
|
224
|
-
rubygems_version: 3.
|
|
224
|
+
rubygems_version: 3.5.3
|
|
225
225
|
signing_key:
|
|
226
226
|
specification_version: 4
|
|
227
227
|
summary: API Client library for the API Gateway V1 API
|