google-cloud-api_gateway-v1 0.4.0 → 0.6.0

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: fcb83e2b772cbc09b4eeadd9c08e95e74a31d0c87fbd45b80a8436457c592d95
4
- data.tar.gz: 45274ef63a4b8ef2d42ca1065175aa86a7d6a741c5806c0c941d1c3d4519ccf6
3
+ metadata.gz: 2b9655532a864c6ccd955d38258464dbb4cf870483058b84385b5cf073db7d3f
4
+ data.tar.gz: 7e6c8648002527dbae4dac38f1cdcae26c0bb1fdd8c7c6d9fb0df55e6ef524d8
5
5
  SHA512:
6
- metadata.gz: f0a6a66f6dd70a8e4e1076308a6045d4f398def0127358594758ff03d85e09a731de47a71a60382e018b935268867aad5c8c12b4dce4596222dc2cfbed32f916
7
- data.tar.gz: 4b8645013351e885cbfbb050e0522756100498b0f70c602713beb5f0a224a9f28d9c30661e2180222fa3811348e11419fedd2dd48392c858426ae0b2482c4410
6
+ metadata.gz: 70a58f4d0d65cbf403cc7c95557ff2219a15f6e3c08e33e389e8d54758c58994641c517d43419e19fe2ce9a067031beb1cb49e39e8e9e9222422b65760bf51de
7
+ data.tar.gz: a5da77d4b29c712e4388797a40bf11820bb234d8507aed5e759b5479db48e0c831ae86c5a2e5243996198cdf9ed493e80d58314bf650f7bbe11a230eb6f72f73
data/AUTHENTICATION.md CHANGED
@@ -1,151 +1,122 @@
1
1
  # Authentication
2
2
 
3
- In general, the google-cloud-api_gateway-v1 library uses
4
- [Service Account](https://cloud.google.com/iam/docs/creating-managing-service-accounts)
5
- credentials to connect to Google Cloud services. When running within
6
- [Google Cloud Platform environments](#google-cloud-platform-environments) the
7
- credentials will be discovered automatically. When running on other
8
- environments, the Service Account credentials can be specified by providing the
9
- path to the
10
- [JSON keyfile](https://cloud.google.com/iam/docs/managing-service-account-keys)
11
- for the account (or the JSON itself) in
12
- [environment variables](#environment-variables). Additionally, Cloud SDK
13
- credentials can also be discovered automatically, but this is only recommended
14
- during development.
3
+ The recommended way to authenticate to the google-cloud-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
- 1. [Create a service account and credentials](#creating-a-service-account).
19
- 2. Set the [environment variable](#environment-variables).
9
+ The following example shows how to set up authentication for a local development
10
+ environment with your user credentials.
20
11
 
21
- ```sh
22
- export API_GATEWAY_CREDENTIALS=path/to/keyfile.json
23
- ```
24
-
25
- 3. Initialize the client.
12
+ **NOTE:** This method is _not_ recommended for running in production. User credentials
13
+ should be used only during development.
26
14
 
27
- ```ruby
28
- require "google/cloud/api_gateway/v1"
15
+ 1. [Download and install the Google Cloud CLI](https://cloud.google.com/sdk).
16
+ 2. Set up a local ADC file with your user credentials:
29
17
 
30
- client = ::Google::Cloud::ApiGateway::V1::ApiGatewayService::Client.new
18
+ ```sh
19
+ gcloud auth application-default login
31
20
  ```
32
21
 
33
- ## Credential Lookup
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
- When running on Google Cloud Platform (GCP), including Google Compute Engine
51
- (GCE), Google Kubernetes Engine (GKE), Google App Engine (GAE), Google Cloud
52
- Functions (GCF) and Cloud Run, **Credentials** are discovered automatically.
53
- Code should be written as if already authenticated.
24
+ For more information about setting up authentication for a local development environment, see
25
+ [Set up Application Default Credentials](https://cloud.google.com/docs/authentication/provide-credentials-adc#local-dev).
54
26
 
55
- ### Environment Variables
27
+ ## Credential Lookup
56
28
 
57
- The **Credentials JSON** can be placed in environment variables instead of
58
- declaring them directly in code. Each service has its own environment variable,
59
- allowing for different service accounts to be used for different services. (See
60
- the READMEs for the individual service gems for details.) The path to the
61
- **Credentials JSON** file can be stored in the environment variable, or the
62
- **Credentials JSON** itself can be stored for environments such as Docker
63
- containers where writing files is difficult or not encouraged.
29
+ The google-cloud-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
- The environment variables that google-cloud-api_gateway-v1
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
- * `API_GATEWAY_CREDENTIALS` - Path to JSON file, or JSON contents
70
- * `API_GATEWAY_KEYFILE` - Path to JSON file, or JSON contents
71
- * `GOOGLE_CLOUD_CREDENTIALS` - Path to JSON file, or JSON contents
72
- * `GOOGLE_CLOUD_KEYFILE` - Path to JSON file, or JSON contents
73
- * `GOOGLE_APPLICATION_CREDENTIALS` - Path to JSON file
36
+ 1. Credentials specified in method arguments
37
+ 2. Credentials specified in configuration
38
+ 3. Credentials pointed to or included in environment variables
39
+ 4. Credentials found in local ADC file
40
+ 5. Credentials returned by the metadata server for the attached service account (GCP)
74
41
 
75
- ```ruby
76
- require "google/cloud/api_gateway/v1"
77
-
78
- ENV["API_GATEWAY_CREDENTIALS"] = "path/to/keyfile.json"
42
+ ### Configuration
79
43
 
80
- client = ::Google::Cloud::ApiGateway::V1::ApiGatewayService::Client.new
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
- ### Configuration
50
+ Note: Service account keys are a security risk if not managed correctly. You should
51
+ [choose a more secure alternative to service account keys](https://cloud.google.com/docs/authentication#auth-decision-tree)
52
+ whenever possible.
84
53
 
85
- The path to the **Credentials JSON** file can be configured instead of storing
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/keyfile.json"
60
+ config.credentials = "path/to/credentialfile.json"
93
61
  end
94
62
  ```
95
63
 
96
- Or globally for all clients:
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/keyfile.json"
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
- ### Cloud SDK
76
+ ### Environment Variables
109
77
 
110
- This option allows for an easy way to authenticate during development. If
111
- credentials are not provided in code or in environment variables, then Cloud SDK
112
- credentials are discovered.
78
+ You can also use an environment variable to provide a JSON credentials file.
79
+ The environment variable can contain a path to the credentials file or, for
80
+ environments such as Docker containers where writing files is not encouraged,
81
+ you can include the credentials file itself.
113
82
 
114
- To configure your system for this, simply:
83
+ The JSON file can contain credentials created for
84
+ [workload identity federation](https://cloud.google.com/iam/docs/workload-identity-federation),
85
+ [workforce identity federation](https://cloud.google.com/iam/docs/workforce-identity-federation), or a
86
+ [service account key](https://cloud.google.com/docs/authentication/provide-credentials-adc#local-key).
115
87
 
116
- 1. [Download and install the Cloud SDK](https://cloud.google.com/sdk)
117
- 2. Authenticate using OAuth 2.0 `$ gcloud auth application-default login`
118
- 3. Write code as if already authenticated.
88
+ Note: Service account keys are a security risk if not managed correctly. You should
89
+ [choose a more secure alternative to service account keys](https://cloud.google.com/docs/authentication#auth-decision-tree)
90
+ whenever possible.
91
+
92
+ The environment variables that google-cloud-api_gateway-v1
93
+ checks for credentials are:
119
94
 
120
- **NOTE:** This is _not_ recommended for running in production. The Cloud SDK
121
- *should* only be used during development.
95
+ * `GOOGLE_CLOUD_CREDENTIALS` - Path to JSON file, or JSON contents
96
+ * `GOOGLE_APPLICATION_CREDENTIALS` - Path to JSON file
122
97
 
123
- ## Creating a Service Account
98
+ ```ruby
99
+ require "google/cloud/api_gateway/v1"
124
100
 
125
- Google Cloud requires **Service Account Credentials** to
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
- If you are not running this client within
130
- [Google Cloud Platform environments](#google-cloud-platform-environments), you
131
- need a Google Developers service account.
103
+ client = ::Google::Cloud::ApiGateway::V1::ApiGatewayService::Client.new
104
+ ```
132
105
 
133
- 1. Visit the [Google Cloud Console](https://console.cloud.google.com/project).
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
- *Note: You may need to enable billing in order to use these services.*
108
+ You can set up a local ADC file with your user credentials for authentication during
109
+ development. If credentials are not provided in code or in environment variables,
110
+ then the local ADC credentials are discovered.
139
111
 
140
- 4. Select **Credentials** from the side navigation.
112
+ Follow the steps in [Quickstart](#quickstart) to set up a local ADC file.
141
113
 
142
- Find the "Create credentials" drop down near the top of the page, and select
143
- "Service account" to be guided through downloading a new JSON key file.
114
+ ### Google Cloud Platform environments
144
115
 
145
- If you want to re-use an existing service account, you can easily generate a
146
- new key file. Just select the account you wish to re-use, click the pencil
147
- tool on the right side to edit the service account, select the **Keys** tab,
148
- and then select **Add Key**.
116
+ When running on Google Cloud Platform (GCP), including Google Compute Engine
117
+ (GCE), Google Kubernetes Engine (GKE), Google App Engine (GAE), Google Cloud
118
+ Functions (GCF) and Cloud Run, credentials are retrieved from the attached
119
+ service account automatically. Code should be written as if already authenticated.
149
120
 
150
- The key file you download will be used by this library to authenticate API
151
- requests and should be stored in a secure location.
121
+ For more information, see
122
+ [Set up ADC for Google Cloud services](https://cloud.google.com/docs/authentication/provide-credentials-adc#attached-sa).
@@ -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 == Configuration::DEFAULT_ENDPOINT &&
172
- !@config.endpoint.split(".").first.include?("-")
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,14 +195,18 @@ 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: credentials,
190
- endpoint: @config.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
- interceptors: @config.interceptors
208
+ interceptors: @config.interceptors,
209
+ channel_pool_config: @config.channel_pool
193
210
  )
194
211
  end
195
212
 
@@ -1666,9 +1683,9 @@ module Google
1666
1683
  # end
1667
1684
  #
1668
1685
  # @!attribute [rw] endpoint
1669
- # The hostname or hostname:port of the service endpoint.
1670
- # Defaults to `"apigateway.googleapis.com"`.
1671
- # @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]
1672
1689
  # @!attribute [rw] credentials
1673
1690
  # Credentials to send with calls. You may provide any of the following types:
1674
1691
  # * (`String`) The path to a service account key file in JSON format
@@ -1714,13 +1731,20 @@ module Google
1714
1731
  # @!attribute [rw] quota_project
1715
1732
  # A separate project against which to charge quota.
1716
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]
1717
1739
  #
1718
1740
  class Configuration
1719
1741
  extend ::Gapic::Config
1720
1742
 
1743
+ # @private
1744
+ # The endpoint specific to the default "googleapis.com" universe. Deprecated.
1721
1745
  DEFAULT_ENDPOINT = "apigateway.googleapis.com"
1722
1746
 
1723
- config_attr :endpoint, DEFAULT_ENDPOINT, ::String
1747
+ config_attr :endpoint, nil, ::String, nil
1724
1748
  config_attr :credentials, nil do |value|
1725
1749
  allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
1726
1750
  allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
@@ -1735,6 +1759,7 @@ module Google
1735
1759
  config_attr :metadata, nil, ::Hash, nil
1736
1760
  config_attr :retry_policy, nil, ::Hash, ::Proc, nil
1737
1761
  config_attr :quota_project, nil, ::String, nil
1762
+ config_attr :universe_domain, nil, ::String, nil
1738
1763
 
1739
1764
  # @private
1740
1765
  def initialize parent_config = nil
@@ -1755,6 +1780,14 @@ module Google
1755
1780
  end
1756
1781
  end
1757
1782
 
1783
+ ##
1784
+ # Configuration for the channel pool
1785
+ # @return [::Gapic::ServiceStub::ChannelPool::Configuration]
1786
+ #
1787
+ def channel_pool
1788
+ @channel_pool ||= ::Gapic::ServiceStub::ChannelPool::Configuration.new
1789
+ end
1790
+
1758
1791
  ##
1759
1792
  # Configuration RPC class for the ApiGatewayService API.
1760
1793
  #
@@ -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,10 +102,13 @@ module Google
90
102
 
91
103
  @operations_stub = ::Gapic::ServiceStub.new(
92
104
  ::Google::Longrunning::Operations::Stub,
93
- credentials: credentials,
94
- endpoint: @config.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
- interceptors: @config.interceptors
110
+ interceptors: @config.interceptors,
111
+ channel_pool_config: @config.channel_pool
97
112
  )
98
113
 
99
114
  # Used by an LRO wrapper for some methods of this service
@@ -612,9 +627,9 @@ module Google
612
627
  # end
613
628
  #
614
629
  # @!attribute [rw] endpoint
615
- # The hostname or hostname:port of the service endpoint.
616
- # Defaults to `"apigateway.googleapis.com"`.
617
- # @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]
618
633
  # @!attribute [rw] credentials
619
634
  # Credentials to send with calls. You may provide any of the following types:
620
635
  # * (`String`) The path to a service account key file in JSON format
@@ -660,13 +675,20 @@ module Google
660
675
  # @!attribute [rw] quota_project
661
676
  # A separate project against which to charge quota.
662
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]
663
683
  #
664
684
  class Configuration
665
685
  extend ::Gapic::Config
666
686
 
687
+ # @private
688
+ # The endpoint specific to the default "googleapis.com" universe. Deprecated.
667
689
  DEFAULT_ENDPOINT = "apigateway.googleapis.com"
668
690
 
669
- config_attr :endpoint, DEFAULT_ENDPOINT, ::String
691
+ config_attr :endpoint, nil, ::String, nil
670
692
  config_attr :credentials, nil do |value|
671
693
  allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
672
694
  allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
@@ -681,6 +703,7 @@ module Google
681
703
  config_attr :metadata, nil, ::Hash, nil
682
704
  config_attr :retry_policy, nil, ::Hash, ::Proc, nil
683
705
  config_attr :quota_project, nil, ::String, nil
706
+ config_attr :universe_domain, nil, ::String, nil
684
707
 
685
708
  # @private
686
709
  def initialize parent_config = nil
@@ -701,6 +724,14 @@ module Google
701
724
  end
702
725
  end
703
726
 
727
+ ##
728
+ # Configuration for the channel pool
729
+ # @return [::Gapic::ServiceStub::ChannelPool::Configuration]
730
+ #
731
+ def channel_pool
732
+ @channel_pool ||= ::Gapic::ServiceStub::ChannelPool::Configuration.new
733
+ end
734
+
704
735
  ##
705
736
  # Configuration RPC class for the Operations API.
706
737
  #
@@ -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 == Configuration::DEFAULT_ENDPOINT &&
168
- !@config.endpoint.split(".").first.include?("-")
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 endpoint: @config.endpoint, credentials: credentials
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
  ##
@@ -229,6 +248,26 @@ module Google
229
248
  # @return [::Google::Cloud::ApiGateway::V1::ListGatewaysResponse]
230
249
  #
231
250
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
251
+ #
252
+ # @example Basic example
253
+ # require "google/cloud/api_gateway/v1"
254
+ #
255
+ # # Create a client object. The client can be reused for multiple calls.
256
+ # client = Google::Cloud::ApiGateway::V1::ApiGatewayService::Rest::Client.new
257
+ #
258
+ # # Create a request. To set request fields, pass in keyword arguments.
259
+ # request = Google::Cloud::ApiGateway::V1::ListGatewaysRequest.new
260
+ #
261
+ # # Call the list_gateways method.
262
+ # result = client.list_gateways request
263
+ #
264
+ # # The returned object is of type Gapic::PagedEnumerable. You can iterate
265
+ # # over elements, and API calls will be issued to fetch pages as needed.
266
+ # result.each do |item|
267
+ # # Each element is of type ::Google::Cloud::ApiGateway::V1::Gateway.
268
+ # p item
269
+ # end
270
+ #
232
271
  def list_gateways request, options = nil
233
272
  raise ::ArgumentError, "request must be provided" if request.nil?
234
273
 
@@ -292,6 +331,22 @@ module Google
292
331
  # @return [::Google::Cloud::ApiGateway::V1::Gateway]
293
332
  #
294
333
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
334
+ #
335
+ # @example Basic example
336
+ # require "google/cloud/api_gateway/v1"
337
+ #
338
+ # # Create a client object. The client can be reused for multiple calls.
339
+ # client = Google::Cloud::ApiGateway::V1::ApiGatewayService::Rest::Client.new
340
+ #
341
+ # # Create a request. To set request fields, pass in keyword arguments.
342
+ # request = Google::Cloud::ApiGateway::V1::GetGatewayRequest.new
343
+ #
344
+ # # Call the get_gateway method.
345
+ # result = client.get_gateway request
346
+ #
347
+ # # The returned object is of type Google::Cloud::ApiGateway::V1::Gateway.
348
+ # p result
349
+ #
295
350
  def get_gateway request, options = nil
296
351
  raise ::ArgumentError, "request must be provided" if request.nil?
297
352
 
@@ -360,6 +415,29 @@ module Google
360
415
  # @return [::Gapic::Operation]
361
416
  #
362
417
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
418
+ #
419
+ # @example Basic example
420
+ # require "google/cloud/api_gateway/v1"
421
+ #
422
+ # # Create a client object. The client can be reused for multiple calls.
423
+ # client = Google::Cloud::ApiGateway::V1::ApiGatewayService::Rest::Client.new
424
+ #
425
+ # # Create a request. To set request fields, pass in keyword arguments.
426
+ # request = Google::Cloud::ApiGateway::V1::CreateGatewayRequest.new
427
+ #
428
+ # # Call the create_gateway method.
429
+ # result = client.create_gateway request
430
+ #
431
+ # # The returned object is of type Gapic::Operation. You can use it to
432
+ # # check the status of an operation, cancel it, or wait for results.
433
+ # # Here is how to wait for a response.
434
+ # result.wait_until_done! timeout: 60
435
+ # if result.response?
436
+ # p result.response
437
+ # else
438
+ # puts "No response received."
439
+ # end
440
+ #
363
441
  def create_gateway request, options = nil
364
442
  raise ::ArgumentError, "request must be provided" if request.nil?
365
443
 
@@ -429,6 +507,29 @@ module Google
429
507
  # @return [::Gapic::Operation]
430
508
  #
431
509
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
510
+ #
511
+ # @example Basic example
512
+ # require "google/cloud/api_gateway/v1"
513
+ #
514
+ # # Create a client object. The client can be reused for multiple calls.
515
+ # client = Google::Cloud::ApiGateway::V1::ApiGatewayService::Rest::Client.new
516
+ #
517
+ # # Create a request. To set request fields, pass in keyword arguments.
518
+ # request = Google::Cloud::ApiGateway::V1::UpdateGatewayRequest.new
519
+ #
520
+ # # Call the update_gateway method.
521
+ # result = client.update_gateway request
522
+ #
523
+ # # The returned object is of type Gapic::Operation. You can use it to
524
+ # # check the status of an operation, cancel it, or wait for results.
525
+ # # Here is how to wait for a response.
526
+ # result.wait_until_done! timeout: 60
527
+ # if result.response?
528
+ # p result.response
529
+ # else
530
+ # puts "No response received."
531
+ # end
532
+ #
432
533
  def update_gateway request, options = nil
433
534
  raise ::ArgumentError, "request must be provided" if request.nil?
434
535
 
@@ -493,6 +594,29 @@ module Google
493
594
  # @return [::Gapic::Operation]
494
595
  #
495
596
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
597
+ #
598
+ # @example Basic example
599
+ # require "google/cloud/api_gateway/v1"
600
+ #
601
+ # # Create a client object. The client can be reused for multiple calls.
602
+ # client = Google::Cloud::ApiGateway::V1::ApiGatewayService::Rest::Client.new
603
+ #
604
+ # # Create a request. To set request fields, pass in keyword arguments.
605
+ # request = Google::Cloud::ApiGateway::V1::DeleteGatewayRequest.new
606
+ #
607
+ # # Call the delete_gateway method.
608
+ # result = client.delete_gateway request
609
+ #
610
+ # # The returned object is of type Gapic::Operation. You can use it to
611
+ # # check the status of an operation, cancel it, or wait for results.
612
+ # # Here is how to wait for a response.
613
+ # result.wait_until_done! timeout: 60
614
+ # if result.response?
615
+ # p result.response
616
+ # else
617
+ # puts "No response received."
618
+ # end
619
+ #
496
620
  def delete_gateway request, options = nil
497
621
  raise ::ArgumentError, "request must be provided" if request.nil?
498
622
 
@@ -565,6 +689,26 @@ module Google
565
689
  # @return [::Google::Cloud::ApiGateway::V1::ListApisResponse]
566
690
  #
567
691
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
692
+ #
693
+ # @example Basic example
694
+ # require "google/cloud/api_gateway/v1"
695
+ #
696
+ # # Create a client object. The client can be reused for multiple calls.
697
+ # client = Google::Cloud::ApiGateway::V1::ApiGatewayService::Rest::Client.new
698
+ #
699
+ # # Create a request. To set request fields, pass in keyword arguments.
700
+ # request = Google::Cloud::ApiGateway::V1::ListApisRequest.new
701
+ #
702
+ # # Call the list_apis method.
703
+ # result = client.list_apis request
704
+ #
705
+ # # The returned object is of type Gapic::PagedEnumerable. You can iterate
706
+ # # over elements, and API calls will be issued to fetch pages as needed.
707
+ # result.each do |item|
708
+ # # Each element is of type ::Google::Cloud::ApiGateway::V1::Api.
709
+ # p item
710
+ # end
711
+ #
568
712
  def list_apis request, options = nil
569
713
  raise ::ArgumentError, "request must be provided" if request.nil?
570
714
 
@@ -628,6 +772,22 @@ module Google
628
772
  # @return [::Google::Cloud::ApiGateway::V1::Api]
629
773
  #
630
774
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
775
+ #
776
+ # @example Basic example
777
+ # require "google/cloud/api_gateway/v1"
778
+ #
779
+ # # Create a client object. The client can be reused for multiple calls.
780
+ # client = Google::Cloud::ApiGateway::V1::ApiGatewayService::Rest::Client.new
781
+ #
782
+ # # Create a request. To set request fields, pass in keyword arguments.
783
+ # request = Google::Cloud::ApiGateway::V1::GetApiRequest.new
784
+ #
785
+ # # Call the get_api method.
786
+ # result = client.get_api request
787
+ #
788
+ # # The returned object is of type Google::Cloud::ApiGateway::V1::Api.
789
+ # p result
790
+ #
631
791
  def get_api request, options = nil
632
792
  raise ::ArgumentError, "request must be provided" if request.nil?
633
793
 
@@ -696,6 +856,29 @@ module Google
696
856
  # @return [::Gapic::Operation]
697
857
  #
698
858
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
859
+ #
860
+ # @example Basic example
861
+ # require "google/cloud/api_gateway/v1"
862
+ #
863
+ # # Create a client object. The client can be reused for multiple calls.
864
+ # client = Google::Cloud::ApiGateway::V1::ApiGatewayService::Rest::Client.new
865
+ #
866
+ # # Create a request. To set request fields, pass in keyword arguments.
867
+ # request = Google::Cloud::ApiGateway::V1::CreateApiRequest.new
868
+ #
869
+ # # Call the create_api method.
870
+ # result = client.create_api request
871
+ #
872
+ # # The returned object is of type Gapic::Operation. You can use it to
873
+ # # check the status of an operation, cancel it, or wait for results.
874
+ # # Here is how to wait for a response.
875
+ # result.wait_until_done! timeout: 60
876
+ # if result.response?
877
+ # p result.response
878
+ # else
879
+ # puts "No response received."
880
+ # end
881
+ #
699
882
  def create_api request, options = nil
700
883
  raise ::ArgumentError, "request must be provided" if request.nil?
701
884
 
@@ -765,6 +948,29 @@ module Google
765
948
  # @return [::Gapic::Operation]
766
949
  #
767
950
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
951
+ #
952
+ # @example Basic example
953
+ # require "google/cloud/api_gateway/v1"
954
+ #
955
+ # # Create a client object. The client can be reused for multiple calls.
956
+ # client = Google::Cloud::ApiGateway::V1::ApiGatewayService::Rest::Client.new
957
+ #
958
+ # # Create a request. To set request fields, pass in keyword arguments.
959
+ # request = Google::Cloud::ApiGateway::V1::UpdateApiRequest.new
960
+ #
961
+ # # Call the update_api method.
962
+ # result = client.update_api request
963
+ #
964
+ # # The returned object is of type Gapic::Operation. You can use it to
965
+ # # check the status of an operation, cancel it, or wait for results.
966
+ # # Here is how to wait for a response.
967
+ # result.wait_until_done! timeout: 60
968
+ # if result.response?
969
+ # p result.response
970
+ # else
971
+ # puts "No response received."
972
+ # end
973
+ #
768
974
  def update_api request, options = nil
769
975
  raise ::ArgumentError, "request must be provided" if request.nil?
770
976
 
@@ -829,6 +1035,29 @@ module Google
829
1035
  # @return [::Gapic::Operation]
830
1036
  #
831
1037
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
1038
+ #
1039
+ # @example Basic example
1040
+ # require "google/cloud/api_gateway/v1"
1041
+ #
1042
+ # # Create a client object. The client can be reused for multiple calls.
1043
+ # client = Google::Cloud::ApiGateway::V1::ApiGatewayService::Rest::Client.new
1044
+ #
1045
+ # # Create a request. To set request fields, pass in keyword arguments.
1046
+ # request = Google::Cloud::ApiGateway::V1::DeleteApiRequest.new
1047
+ #
1048
+ # # Call the delete_api method.
1049
+ # result = client.delete_api request
1050
+ #
1051
+ # # The returned object is of type Gapic::Operation. You can use it to
1052
+ # # check the status of an operation, cancel it, or wait for results.
1053
+ # # Here is how to wait for a response.
1054
+ # result.wait_until_done! timeout: 60
1055
+ # if result.response?
1056
+ # p result.response
1057
+ # else
1058
+ # puts "No response received."
1059
+ # end
1060
+ #
832
1061
  def delete_api request, options = nil
833
1062
  raise ::ArgumentError, "request must be provided" if request.nil?
834
1063
 
@@ -901,6 +1130,26 @@ module Google
901
1130
  # @return [::Google::Cloud::ApiGateway::V1::ListApiConfigsResponse]
902
1131
  #
903
1132
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
1133
+ #
1134
+ # @example Basic example
1135
+ # require "google/cloud/api_gateway/v1"
1136
+ #
1137
+ # # Create a client object. The client can be reused for multiple calls.
1138
+ # client = Google::Cloud::ApiGateway::V1::ApiGatewayService::Rest::Client.new
1139
+ #
1140
+ # # Create a request. To set request fields, pass in keyword arguments.
1141
+ # request = Google::Cloud::ApiGateway::V1::ListApiConfigsRequest.new
1142
+ #
1143
+ # # Call the list_api_configs method.
1144
+ # result = client.list_api_configs request
1145
+ #
1146
+ # # The returned object is of type Gapic::PagedEnumerable. You can iterate
1147
+ # # over elements, and API calls will be issued to fetch pages as needed.
1148
+ # result.each do |item|
1149
+ # # Each element is of type ::Google::Cloud::ApiGateway::V1::ApiConfig.
1150
+ # p item
1151
+ # end
1152
+ #
904
1153
  def list_api_configs request, options = nil
905
1154
  raise ::ArgumentError, "request must be provided" if request.nil?
906
1155
 
@@ -967,6 +1216,22 @@ module Google
967
1216
  # @return [::Google::Cloud::ApiGateway::V1::ApiConfig]
968
1217
  #
969
1218
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
1219
+ #
1220
+ # @example Basic example
1221
+ # require "google/cloud/api_gateway/v1"
1222
+ #
1223
+ # # Create a client object. The client can be reused for multiple calls.
1224
+ # client = Google::Cloud::ApiGateway::V1::ApiGatewayService::Rest::Client.new
1225
+ #
1226
+ # # Create a request. To set request fields, pass in keyword arguments.
1227
+ # request = Google::Cloud::ApiGateway::V1::GetApiConfigRequest.new
1228
+ #
1229
+ # # Call the get_api_config method.
1230
+ # result = client.get_api_config request
1231
+ #
1232
+ # # The returned object is of type Google::Cloud::ApiGateway::V1::ApiConfig.
1233
+ # p result
1234
+ #
970
1235
  def get_api_config request, options = nil
971
1236
  raise ::ArgumentError, "request must be provided" if request.nil?
972
1237
 
@@ -1035,6 +1300,29 @@ module Google
1035
1300
  # @return [::Gapic::Operation]
1036
1301
  #
1037
1302
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
1303
+ #
1304
+ # @example Basic example
1305
+ # require "google/cloud/api_gateway/v1"
1306
+ #
1307
+ # # Create a client object. The client can be reused for multiple calls.
1308
+ # client = Google::Cloud::ApiGateway::V1::ApiGatewayService::Rest::Client.new
1309
+ #
1310
+ # # Create a request. To set request fields, pass in keyword arguments.
1311
+ # request = Google::Cloud::ApiGateway::V1::CreateApiConfigRequest.new
1312
+ #
1313
+ # # Call the create_api_config method.
1314
+ # result = client.create_api_config request
1315
+ #
1316
+ # # The returned object is of type Gapic::Operation. You can use it to
1317
+ # # check the status of an operation, cancel it, or wait for results.
1318
+ # # Here is how to wait for a response.
1319
+ # result.wait_until_done! timeout: 60
1320
+ # if result.response?
1321
+ # p result.response
1322
+ # else
1323
+ # puts "No response received."
1324
+ # end
1325
+ #
1038
1326
  def create_api_config request, options = nil
1039
1327
  raise ::ArgumentError, "request must be provided" if request.nil?
1040
1328
 
@@ -1104,6 +1392,29 @@ module Google
1104
1392
  # @return [::Gapic::Operation]
1105
1393
  #
1106
1394
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
1395
+ #
1396
+ # @example Basic example
1397
+ # require "google/cloud/api_gateway/v1"
1398
+ #
1399
+ # # Create a client object. The client can be reused for multiple calls.
1400
+ # client = Google::Cloud::ApiGateway::V1::ApiGatewayService::Rest::Client.new
1401
+ #
1402
+ # # Create a request. To set request fields, pass in keyword arguments.
1403
+ # request = Google::Cloud::ApiGateway::V1::UpdateApiConfigRequest.new
1404
+ #
1405
+ # # Call the update_api_config method.
1406
+ # result = client.update_api_config request
1407
+ #
1408
+ # # The returned object is of type Gapic::Operation. You can use it to
1409
+ # # check the status of an operation, cancel it, or wait for results.
1410
+ # # Here is how to wait for a response.
1411
+ # result.wait_until_done! timeout: 60
1412
+ # if result.response?
1413
+ # p result.response
1414
+ # else
1415
+ # puts "No response received."
1416
+ # end
1417
+ #
1107
1418
  def update_api_config request, options = nil
1108
1419
  raise ::ArgumentError, "request must be provided" if request.nil?
1109
1420
 
@@ -1168,6 +1479,29 @@ module Google
1168
1479
  # @return [::Gapic::Operation]
1169
1480
  #
1170
1481
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
1482
+ #
1483
+ # @example Basic example
1484
+ # require "google/cloud/api_gateway/v1"
1485
+ #
1486
+ # # Create a client object. The client can be reused for multiple calls.
1487
+ # client = Google::Cloud::ApiGateway::V1::ApiGatewayService::Rest::Client.new
1488
+ #
1489
+ # # Create a request. To set request fields, pass in keyword arguments.
1490
+ # request = Google::Cloud::ApiGateway::V1::DeleteApiConfigRequest.new
1491
+ #
1492
+ # # Call the delete_api_config method.
1493
+ # result = client.delete_api_config request
1494
+ #
1495
+ # # The returned object is of type Gapic::Operation. You can use it to
1496
+ # # check the status of an operation, cancel it, or wait for results.
1497
+ # # Here is how to wait for a response.
1498
+ # result.wait_until_done! timeout: 60
1499
+ # if result.response?
1500
+ # p result.response
1501
+ # else
1502
+ # puts "No response received."
1503
+ # end
1504
+ #
1171
1505
  def delete_api_config request, options = nil
1172
1506
  raise ::ArgumentError, "request must be provided" if request.nil?
1173
1507
 
@@ -1234,9 +1568,9 @@ module Google
1234
1568
  # end
1235
1569
  #
1236
1570
  # @!attribute [rw] endpoint
1237
- # The hostname or hostname:port of the service endpoint.
1238
- # Defaults to `"apigateway.googleapis.com"`.
1239
- # @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]
1240
1574
  # @!attribute [rw] credentials
1241
1575
  # Credentials to send with calls. You may provide any of the following types:
1242
1576
  # * (`String`) The path to a service account key file in JSON format
@@ -1273,13 +1607,20 @@ module Google
1273
1607
  # @!attribute [rw] quota_project
1274
1608
  # A separate project against which to charge quota.
1275
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]
1276
1615
  #
1277
1616
  class Configuration
1278
1617
  extend ::Gapic::Config
1279
1618
 
1619
+ # @private
1620
+ # The endpoint specific to the default "googleapis.com" universe. Deprecated.
1280
1621
  DEFAULT_ENDPOINT = "apigateway.googleapis.com"
1281
1622
 
1282
- config_attr :endpoint, DEFAULT_ENDPOINT, ::String
1623
+ config_attr :endpoint, nil, ::String, nil
1283
1624
  config_attr :credentials, nil do |value|
1284
1625
  allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
1285
1626
  allowed.any? { |klass| klass === value }
@@ -1291,6 +1632,7 @@ module Google
1291
1632
  config_attr :metadata, nil, ::Hash, nil
1292
1633
  config_attr :retry_policy, nil, ::Hash, ::Proc, nil
1293
1634
  config_attr :quota_project, nil, ::String, nil
1635
+ config_attr :universe_domain, nil, ::String, nil
1294
1636
 
1295
1637
  # @private
1296
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: @config.endpoint,
88
- credentials: credentials
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
@@ -136,6 +150,26 @@ module Google
136
150
  # @return [::Gapic::Operation]
137
151
  #
138
152
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
153
+ #
154
+ # @example Basic example
155
+ # require "google/longrunning"
156
+ #
157
+ # # Create a client object. The client can be reused for multiple calls.
158
+ # client = Google::Longrunning::Operations::Rest::Client.new
159
+ #
160
+ # # Create a request. To set request fields, pass in keyword arguments.
161
+ # request = Google::Longrunning::ListOperationsRequest.new
162
+ #
163
+ # # Call the list_operations method.
164
+ # result = client.list_operations request
165
+ #
166
+ # # The returned object is of type Gapic::PagedEnumerable. You can iterate
167
+ # # over elements, and API calls will be issued to fetch pages as needed.
168
+ # result.each do |item|
169
+ # # Each element is of type ::Google::Longrunning::Operation.
170
+ # p item
171
+ # end
172
+ #
139
173
  def list_operations request, options = nil
140
174
  raise ::ArgumentError, "request must be provided" if request.nil?
141
175
 
@@ -201,6 +235,29 @@ module Google
201
235
  # @return [::Gapic::Operation]
202
236
  #
203
237
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
238
+ #
239
+ # @example Basic example
240
+ # require "google/longrunning"
241
+ #
242
+ # # Create a client object. The client can be reused for multiple calls.
243
+ # client = Google::Longrunning::Operations::Rest::Client.new
244
+ #
245
+ # # Create a request. To set request fields, pass in keyword arguments.
246
+ # request = Google::Longrunning::GetOperationRequest.new
247
+ #
248
+ # # Call the get_operation method.
249
+ # result = client.get_operation request
250
+ #
251
+ # # The returned object is of type Gapic::Operation. You can use it to
252
+ # # check the status of an operation, cancel it, or wait for results.
253
+ # # Here is how to wait for a response.
254
+ # result.wait_until_done! timeout: 60
255
+ # if result.response?
256
+ # p result.response
257
+ # else
258
+ # puts "No response received."
259
+ # end
260
+ #
204
261
  def get_operation request, options = nil
205
262
  raise ::ArgumentError, "request must be provided" if request.nil?
206
263
 
@@ -267,6 +324,22 @@ module Google
267
324
  # @return [::Google::Protobuf::Empty]
268
325
  #
269
326
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
327
+ #
328
+ # @example Basic example
329
+ # require "google/longrunning"
330
+ #
331
+ # # Create a client object. The client can be reused for multiple calls.
332
+ # client = Google::Longrunning::Operations::Rest::Client.new
333
+ #
334
+ # # Create a request. To set request fields, pass in keyword arguments.
335
+ # request = Google::Longrunning::DeleteOperationRequest.new
336
+ #
337
+ # # Call the delete_operation method.
338
+ # result = client.delete_operation request
339
+ #
340
+ # # The returned object is of type Google::Protobuf::Empty.
341
+ # p result
342
+ #
270
343
  def delete_operation request, options = nil
271
344
  raise ::ArgumentError, "request must be provided" if request.nil?
272
345
 
@@ -338,6 +411,22 @@ module Google
338
411
  # @return [::Google::Protobuf::Empty]
339
412
  #
340
413
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
414
+ #
415
+ # @example Basic example
416
+ # require "google/longrunning"
417
+ #
418
+ # # Create a client object. The client can be reused for multiple calls.
419
+ # client = Google::Longrunning::Operations::Rest::Client.new
420
+ #
421
+ # # Create a request. To set request fields, pass in keyword arguments.
422
+ # request = Google::Longrunning::CancelOperationRequest.new
423
+ #
424
+ # # Call the cancel_operation method.
425
+ # result = client.cancel_operation request
426
+ #
427
+ # # The returned object is of type Google::Protobuf::Empty.
428
+ # p result
429
+ #
341
430
  def cancel_operation request, options = nil
342
431
  raise ::ArgumentError, "request must be provided" if request.nil?
343
432
 
@@ -403,9 +492,9 @@ module Google
403
492
  # end
404
493
  #
405
494
  # @!attribute [rw] endpoint
406
- # The hostname or hostname:port of the service endpoint.
407
- # Defaults to `"apigateway.googleapis.com"`.
408
- # @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]
409
498
  # @!attribute [rw] credentials
410
499
  # Credentials to send with calls. You may provide any of the following types:
411
500
  # * (`String`) The path to a service account key file in JSON format
@@ -442,13 +531,20 @@ module Google
442
531
  # @!attribute [rw] quota_project
443
532
  # A separate project against which to charge quota.
444
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]
445
539
  #
446
540
  class Configuration
447
541
  extend ::Gapic::Config
448
542
 
543
+ # @private
544
+ # The endpoint specific to the default "googleapis.com" universe. Deprecated.
449
545
  DEFAULT_ENDPOINT = "apigateway.googleapis.com"
450
546
 
451
- config_attr :endpoint, DEFAULT_ENDPOINT, ::String
547
+ config_attr :endpoint, nil, ::String, nil
452
548
  config_attr :credentials, nil do |value|
453
549
  allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
454
550
  allowed.any? { |klass| klass === value }
@@ -460,6 +556,7 @@ module Google
460
556
  config_attr :metadata, nil, ::Hash, nil
461
557
  config_attr :retry_policy, nil, ::Hash, ::Proc, nil
462
558
  config_attr :quota_project, nil, ::String, nil
559
+ config_attr :universe_domain, nil, ::String, nil
463
560
 
464
561
  # @private
465
562
  def initialize parent_config = nil
@@ -542,12 +639,15 @@ module Google
542
639
  # Service stub contains baseline method implementations
543
640
  # including transcoding, making the REST call, and deserialing the response.
544
641
  class OperationsServiceStub
545
- def initialize endpoint:, credentials:
642
+ def initialize endpoint:, endpoint_template:, universe_domain:, credentials:
546
643
  # These require statements are intentionally placed here to initialize
547
644
  # the REST modules only when it's required.
548
645
  require "gapic/rest"
549
646
 
550
- @client_stub = ::Gapic::Rest::ClientStub.new endpoint: endpoint, credentials: credentials
647
+ @client_stub = ::Gapic::Rest::ClientStub.new endpoint: endpoint,
648
+ endpoint_template: endpoint_template,
649
+ universe_domain: universe_domain,
650
+ credentials: credentials
551
651
  end
552
652
 
553
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, credentials: credentials,
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,7 +21,7 @@ module Google
21
21
  module Cloud
22
22
  module ApiGateway
23
23
  module V1
24
- VERSION = "0.4.0"
24
+ VERSION = "0.6.0"
25
25
  end
26
26
  end
27
27
  end
@@ -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
@@ -66,6 +66,20 @@ module Google
66
66
  # a non-empty value will be returned. The user will not be aware of what
67
67
  # non-empty value to expect.
68
68
  NON_EMPTY_DEFAULT = 7
69
+
70
+ # Denotes that the field in a resource (a message annotated with
71
+ # google.api.resource) is used in the resource name to uniquely identify the
72
+ # resource. For AIP-compliant APIs, this should only be applied to the
73
+ # `name` field on the resource.
74
+ #
75
+ # This behavior should not be applied to references to other resources within
76
+ # the message.
77
+ #
78
+ # The identifier field of resources often have different field behavior
79
+ # depending on the request it is embedded in (e.g. for Create methods name
80
+ # is optional and unused, while for Update methods it is required). Instead
81
+ # of method-specific annotations, only `IDENTIFIER` is required.
82
+ IDENTIFIER = 8
69
83
  end
70
84
  end
71
85
  end
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: google-cloud-api_gateway-v1
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.4.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: 2023-06-06 00:00:00.000000000 Z
11
+ date: 2024-01-11 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: gapic-common
@@ -16,7 +16,7 @@ dependencies:
16
16
  requirements:
17
17
  - - ">="
18
18
  - !ruby/object:Gem::Version
19
- version: 0.19.1
19
+ version: 0.21.1
20
20
  - - "<"
21
21
  - !ruby/object:Gem::Version
22
22
  version: 2.a
@@ -26,7 +26,7 @@ dependencies:
26
26
  requirements:
27
27
  - - ">="
28
28
  - !ruby/object:Gem::Version
29
- version: 0.19.1
29
+ version: 0.21.1
30
30
  - - "<"
31
31
  - !ruby/object:Gem::Version
32
32
  version: 2.a
@@ -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.4.2
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