google-cloud-pubsub-v1 0.19.0 → 0.20.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: e70b0c6d1a3544f1c6e43e3480c9ca285faa0441c48a4d920decdb58e39251a9
4
- data.tar.gz: 39be973c2ef0a2711c307d2164ce455d575be7031218ed0a53a206ce8ad018b8
3
+ metadata.gz: 5479709940e3c5ec0a3e6d1ed4501f5bb5bce26a606a82257b7a9c2defbb44e7
4
+ data.tar.gz: 2700385f177b6d24507c97690211a89a8c0bb75afd47e53ecd799f9afd61c160
5
5
  SHA512:
6
- metadata.gz: f7a32b0a9e6eb45fdb4ed5b2d9d895ca6bad57f8cb4cb7ddf701e40a060cf3c47c387a1d2231d36edbea78e928fa62c991152c0c61bad0a350c2b0be94ff91f5
7
- data.tar.gz: 69b61e7265166659d05ea966feedf9c24909dfa1399985be36b6a131583ca44bcdf5a178688c227c9ddf4c075a25b7659d0826a7aba2a1385e455faa9de3b953
6
+ metadata.gz: ad29abe317f624519de2ae3b4ff3efe01def663bb1d5c0298537993fc0ea3f2bdeaa88e831bc18864fd92de26fa65edb50d07677541bcfb24cd62c81c9896fc4
7
+ data.tar.gz: 99ae9125c5cebe7f28a77d3458960906e9581801a9e87b598cf8a1f52d5a90264a9c7bfb0cfa14a5d1b661954f3c9cf761f91319493ae5e961e8cf476cb1ad58
data/AUTHENTICATION.md CHANGED
@@ -1,151 +1,122 @@
1
1
  # Authentication
2
2
 
3
- In general, the google-cloud-pubsub-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-pubsub-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 PUBSUB_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/pubsub/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::PubSub::V1::SchemaService::Client.new
18
+ ```sh
19
+ gcloud auth application-default login
31
20
  ```
32
21
 
33
- ## Credential Lookup
34
-
35
- The google-cloud-pubsub-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-pubsub-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-pubsub-v1
66
- checks for credentials are configured on the service Credentials class (such as
67
- {::Google::Cloud::PubSub::V1::SchemaService::Credentials}):
34
+ Credentials are accepted in the following ways, in the following order or precedence:
68
35
 
69
- * `PUBSUB_CREDENTIALS` - Path to JSON file, or JSON contents
70
- * `PUBSUB_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/pubsub/v1"
77
-
78
- ENV["PUBSUB_CREDENTIALS"] = "path/to/keyfile.json"
42
+ ### Configuration
79
43
 
80
- client = ::Google::Cloud::PubSub::V1::SchemaService::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/pubsub/v1"
90
58
 
91
59
  client = ::Google::Cloud::PubSub::V1::SchemaService::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/pubsub/v1"
100
68
 
101
69
  ::Google::Cloud::PubSub::V1::SchemaService::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::PubSub::V1::SchemaService::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-pubsub-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/pubsub/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-pubsub-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::PubSub::V1::SchemaService::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).
@@ -32,6 +32,9 @@ module Google
32
32
  # messages to a topic.
33
33
  #
34
34
  class Client
35
+ # @private
36
+ DEFAULT_ENDPOINT_TEMPLATE = "pubsub.$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
+ @publisher_stub.universe_domain
150
+ end
151
+
140
152
  ##
141
153
  # Create a new Publisher client object.
142
154
  #
@@ -170,8 +182,9 @@ module Google
170
182
  credentials = @config.credentials
171
183
  # Use self-signed JWT if the endpoint is unchanged from default,
172
184
  # but only if the default endpoint does not have a region prefix.
173
- enable_self_signed_jwt = @config.endpoint == Configuration::DEFAULT_ENDPOINT &&
174
- !@config.endpoint.split(".").first.include?("-")
185
+ enable_self_signed_jwt = @config.endpoint.nil? ||
186
+ (@config.endpoint == Configuration::DEFAULT_ENDPOINT &&
187
+ !@config.endpoint.split(".").first.include?("-"))
175
188
  credentials ||= Credentials.default scope: @config.scope,
176
189
  enable_self_signed_jwt: enable_self_signed_jwt
177
190
  if credentials.is_a?(::String) || credentials.is_a?(::Hash)
@@ -184,12 +197,15 @@ module Google
184
197
  config.credentials = credentials
185
198
  config.quota_project = @quota_project_id
186
199
  config.endpoint = @config.endpoint
200
+ config.universe_domain = @config.universe_domain
187
201
  end
188
202
 
189
203
  @publisher_stub = ::Gapic::ServiceStub.new(
190
204
  ::Google::Cloud::PubSub::V1::Publisher::Stub,
191
- credentials: credentials,
192
- endpoint: @config.endpoint,
205
+ credentials: credentials,
206
+ endpoint: @config.endpoint,
207
+ endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
208
+ universe_domain: @config.universe_domain,
193
209
  channel_args: @config.channel_args,
194
210
  interceptors: @config.interceptors,
195
211
  channel_pool_config: @config.channel_pool
@@ -1083,9 +1099,9 @@ module Google
1083
1099
  # end
1084
1100
  #
1085
1101
  # @!attribute [rw] endpoint
1086
- # The hostname or hostname:port of the service endpoint.
1087
- # Defaults to `"pubsub.googleapis.com"`.
1088
- # @return [::String]
1102
+ # A custom service endpoint, as a hostname or hostname:port. The default is
1103
+ # nil, indicating to use the default endpoint in the current universe domain.
1104
+ # @return [::String,nil]
1089
1105
  # @!attribute [rw] credentials
1090
1106
  # Credentials to send with calls. You may provide any of the following types:
1091
1107
  # * (`String`) The path to a service account key file in JSON format
@@ -1131,13 +1147,20 @@ module Google
1131
1147
  # @!attribute [rw] quota_project
1132
1148
  # A separate project against which to charge quota.
1133
1149
  # @return [::String]
1150
+ # @!attribute [rw] universe_domain
1151
+ # The universe domain within which to make requests. This determines the
1152
+ # default endpoint URL. The default value of nil uses the environment
1153
+ # universe (usually the default "googleapis.com" universe).
1154
+ # @return [::String,nil]
1134
1155
  #
1135
1156
  class Configuration
1136
1157
  extend ::Gapic::Config
1137
1158
 
1159
+ # @private
1160
+ # The endpoint specific to the default "googleapis.com" universe. Deprecated.
1138
1161
  DEFAULT_ENDPOINT = "pubsub.googleapis.com"
1139
1162
 
1140
- config_attr :endpoint, DEFAULT_ENDPOINT, ::String
1163
+ config_attr :endpoint, nil, ::String, nil
1141
1164
  config_attr :credentials, nil do |value|
1142
1165
  allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
1143
1166
  allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
@@ -1152,6 +1175,7 @@ module Google
1152
1175
  config_attr :metadata, nil, ::Hash, nil
1153
1176
  config_attr :retry_policy, nil, ::Hash, ::Proc, nil
1154
1177
  config_attr :quota_project, nil, ::String, nil
1178
+ config_attr :universe_domain, nil, ::String, nil
1155
1179
 
1156
1180
  # @private
1157
1181
  def initialize parent_config = nil
@@ -15,11 +15,33 @@
15
15
  # limitations under the License.
16
16
 
17
17
 
18
- Google::Cloud::PubSub::V1::Publisher::Client.configure do |config|
19
- config.channel_args ||= {}
20
- config.channel_args["grpc.max_send_message_length"] = -1
21
- config.channel_args["grpc.max_receive_message_length"] = -1
22
- config.channel_args["grpc.keepalive_time_ms"] = 300_000
23
- # Set max metadata size to 4 MB.
24
- config.channel_args["grpc.max_metadata_size"] = 4 * 1024 * 1024
18
+ module Google
19
+ module Cloud
20
+ module PubSub
21
+ module V1
22
+ module Publisher
23
+ class Client # rubocop:disable Style/Documentation
24
+ class << self
25
+ alias configure_internal configure
26
+
27
+ def configure
28
+ @configure ||= begin
29
+ config = configure_internal
30
+ config.channel_args ||= {}
31
+ config.channel_args["grpc.max_send_message_length"] = -1
32
+ config.channel_args["grpc.max_receive_message_length"] = -1
33
+ config.channel_args["grpc.keepalive_time_ms"] = 300_000
34
+ # Set max metadata size to 4 MB.
35
+ config.channel_args["grpc.max_metadata_size"] = 4 * 1024 * 1024
36
+ config
37
+ end
38
+ yield @configure if block_given?
39
+ @configure
40
+ end
41
+ end
42
+ end
43
+ end
44
+ end
45
+ end
46
+ end
25
47
  end
@@ -31,6 +31,9 @@ module Google
31
31
  # Service for doing schema-related operations.
32
32
  #
33
33
  class Client
34
+ # @private
35
+ DEFAULT_ENDPOINT_TEMPLATE = "pubsub.$UNIVERSE_DOMAIN$"
36
+
34
37
  include Paths
35
38
 
36
39
  # @private
@@ -141,6 +144,15 @@ module Google
141
144
  @config
142
145
  end
143
146
 
147
+ ##
148
+ # The effective universe domain
149
+ #
150
+ # @return [String]
151
+ #
152
+ def universe_domain
153
+ @schema_service_stub.universe_domain
154
+ end
155
+
144
156
  ##
145
157
  # Create a new SchemaService client object.
146
158
  #
@@ -174,8 +186,9 @@ module Google
174
186
  credentials = @config.credentials
175
187
  # Use self-signed JWT if the endpoint is unchanged from default,
176
188
  # but only if the default endpoint does not have a region prefix.
177
- enable_self_signed_jwt = @config.endpoint == Configuration::DEFAULT_ENDPOINT &&
178
- !@config.endpoint.split(".").first.include?("-")
189
+ enable_self_signed_jwt = @config.endpoint.nil? ||
190
+ (@config.endpoint == Configuration::DEFAULT_ENDPOINT &&
191
+ !@config.endpoint.split(".").first.include?("-"))
179
192
  credentials ||= Credentials.default scope: @config.scope,
180
193
  enable_self_signed_jwt: enable_self_signed_jwt
181
194
  if credentials.is_a?(::String) || credentials.is_a?(::Hash)
@@ -188,12 +201,15 @@ module Google
188
201
  config.credentials = credentials
189
202
  config.quota_project = @quota_project_id
190
203
  config.endpoint = @config.endpoint
204
+ config.universe_domain = @config.universe_domain
191
205
  end
192
206
 
193
207
  @schema_service_stub = ::Gapic::ServiceStub.new(
194
208
  ::Google::Cloud::PubSub::V1::SchemaService::Stub,
195
- credentials: credentials,
196
- endpoint: @config.endpoint,
209
+ credentials: credentials,
210
+ endpoint: @config.endpoint,
211
+ endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
212
+ universe_domain: @config.universe_domain,
197
213
  channel_args: @config.channel_args,
198
214
  interceptors: @config.interceptors,
199
215
  channel_pool_config: @config.channel_pool
@@ -1166,9 +1182,9 @@ module Google
1166
1182
  # end
1167
1183
  #
1168
1184
  # @!attribute [rw] endpoint
1169
- # The hostname or hostname:port of the service endpoint.
1170
- # Defaults to `"pubsub.googleapis.com"`.
1171
- # @return [::String]
1185
+ # A custom service endpoint, as a hostname or hostname:port. The default is
1186
+ # nil, indicating to use the default endpoint in the current universe domain.
1187
+ # @return [::String,nil]
1172
1188
  # @!attribute [rw] credentials
1173
1189
  # Credentials to send with calls. You may provide any of the following types:
1174
1190
  # * (`String`) The path to a service account key file in JSON format
@@ -1214,13 +1230,20 @@ module Google
1214
1230
  # @!attribute [rw] quota_project
1215
1231
  # A separate project against which to charge quota.
1216
1232
  # @return [::String]
1233
+ # @!attribute [rw] universe_domain
1234
+ # The universe domain within which to make requests. This determines the
1235
+ # default endpoint URL. The default value of nil uses the environment
1236
+ # universe (usually the default "googleapis.com" universe).
1237
+ # @return [::String,nil]
1217
1238
  #
1218
1239
  class Configuration
1219
1240
  extend ::Gapic::Config
1220
1241
 
1242
+ # @private
1243
+ # The endpoint specific to the default "googleapis.com" universe. Deprecated.
1221
1244
  DEFAULT_ENDPOINT = "pubsub.googleapis.com"
1222
1245
 
1223
- config_attr :endpoint, DEFAULT_ENDPOINT, ::String
1246
+ config_attr :endpoint, nil, ::String, nil
1224
1247
  config_attr :credentials, nil do |value|
1225
1248
  allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
1226
1249
  allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
@@ -1235,6 +1258,7 @@ module Google
1235
1258
  config_attr :metadata, nil, ::Hash, nil
1236
1259
  config_attr :retry_policy, nil, ::Hash, ::Proc, nil
1237
1260
  config_attr :quota_project, nil, ::String, nil
1261
+ config_attr :universe_domain, nil, ::String, nil
1238
1262
 
1239
1263
  # @private
1240
1264
  def initialize parent_config = nil
@@ -33,6 +33,9 @@ module Google
33
33
  # establishing a bi-directional stream using the `StreamingPull` method.
34
34
  #
35
35
  class Client
36
+ # @private
37
+ DEFAULT_ENDPOINT_TEMPLATE = "pubsub.$UNIVERSE_DOMAIN$"
38
+
36
39
  include Paths
37
40
 
38
41
  # @private
@@ -173,6 +176,15 @@ module Google
173
176
  @config
174
177
  end
175
178
 
179
+ ##
180
+ # The effective universe domain
181
+ #
182
+ # @return [String]
183
+ #
184
+ def universe_domain
185
+ @subscriber_stub.universe_domain
186
+ end
187
+
176
188
  ##
177
189
  # Create a new Subscriber client object.
178
190
  #
@@ -206,8 +218,9 @@ module Google
206
218
  credentials = @config.credentials
207
219
  # Use self-signed JWT if the endpoint is unchanged from default,
208
220
  # but only if the default endpoint does not have a region prefix.
209
- enable_self_signed_jwt = @config.endpoint == Configuration::DEFAULT_ENDPOINT &&
210
- !@config.endpoint.split(".").first.include?("-")
221
+ enable_self_signed_jwt = @config.endpoint.nil? ||
222
+ (@config.endpoint == Configuration::DEFAULT_ENDPOINT &&
223
+ !@config.endpoint.split(".").first.include?("-"))
211
224
  credentials ||= Credentials.default scope: @config.scope,
212
225
  enable_self_signed_jwt: enable_self_signed_jwt
213
226
  if credentials.is_a?(::String) || credentials.is_a?(::Hash)
@@ -220,12 +233,15 @@ module Google
220
233
  config.credentials = credentials
221
234
  config.quota_project = @quota_project_id
222
235
  config.endpoint = @config.endpoint
236
+ config.universe_domain = @config.universe_domain
223
237
  end
224
238
 
225
239
  @subscriber_stub = ::Gapic::ServiceStub.new(
226
240
  ::Google::Cloud::PubSub::V1::Subscriber::Stub,
227
- credentials: credentials,
228
- endpoint: @config.endpoint,
241
+ credentials: credentials,
242
+ endpoint: @config.endpoint,
243
+ endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
244
+ universe_domain: @config.universe_domain,
229
245
  channel_args: @config.channel_args,
230
246
  interceptors: @config.interceptors,
231
247
  channel_pool_config: @config.channel_pool
@@ -1917,9 +1933,9 @@ module Google
1917
1933
  # end
1918
1934
  #
1919
1935
  # @!attribute [rw] endpoint
1920
- # The hostname or hostname:port of the service endpoint.
1921
- # Defaults to `"pubsub.googleapis.com"`.
1922
- # @return [::String]
1936
+ # A custom service endpoint, as a hostname or hostname:port. The default is
1937
+ # nil, indicating to use the default endpoint in the current universe domain.
1938
+ # @return [::String,nil]
1923
1939
  # @!attribute [rw] credentials
1924
1940
  # Credentials to send with calls. You may provide any of the following types:
1925
1941
  # * (`String`) The path to a service account key file in JSON format
@@ -1965,13 +1981,20 @@ module Google
1965
1981
  # @!attribute [rw] quota_project
1966
1982
  # A separate project against which to charge quota.
1967
1983
  # @return [::String]
1984
+ # @!attribute [rw] universe_domain
1985
+ # The universe domain within which to make requests. This determines the
1986
+ # default endpoint URL. The default value of nil uses the environment
1987
+ # universe (usually the default "googleapis.com" universe).
1988
+ # @return [::String,nil]
1968
1989
  #
1969
1990
  class Configuration
1970
1991
  extend ::Gapic::Config
1971
1992
 
1993
+ # @private
1994
+ # The endpoint specific to the default "googleapis.com" universe. Deprecated.
1972
1995
  DEFAULT_ENDPOINT = "pubsub.googleapis.com"
1973
1996
 
1974
- config_attr :endpoint, DEFAULT_ENDPOINT, ::String
1997
+ config_attr :endpoint, nil, ::String, nil
1975
1998
  config_attr :credentials, nil do |value|
1976
1999
  allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
1977
2000
  allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
@@ -1986,6 +2009,7 @@ module Google
1986
2009
  config_attr :metadata, nil, ::Hash, nil
1987
2010
  config_attr :retry_policy, nil, ::Hash, ::Proc, nil
1988
2011
  config_attr :quota_project, nil, ::String, nil
2012
+ config_attr :universe_domain, nil, ::String, nil
1989
2013
 
1990
2014
  # @private
1991
2015
  def initialize parent_config = nil
@@ -15,11 +15,33 @@
15
15
  # limitations under the License.
16
16
 
17
17
 
18
- Google::Cloud::PubSub::V1::Subscriber::Client.configure do |config|
19
- config.channel_args ||= {}
20
- config.channel_args["grpc.max_send_message_length"] = -1
21
- config.channel_args["grpc.max_receive_message_length"] = -1
22
- config.channel_args["grpc.keepalive_time_ms"] = 300_000
23
- # Set max metadata size to 4 MB.
24
- config.channel_args["grpc.max_metadata_size"] = 4 * 1024 * 1024
18
+ module Google
19
+ module Cloud
20
+ module PubSub
21
+ module V1
22
+ module Subscriber
23
+ class Client # rubocop:disable Style/Documentation
24
+ class << self
25
+ alias configure_internal configure
26
+
27
+ def configure
28
+ @configure ||= begin
29
+ config = configure_internal
30
+ config.channel_args ||= {}
31
+ config.channel_args["grpc.max_send_message_length"] = -1
32
+ config.channel_args["grpc.max_receive_message_length"] = -1
33
+ config.channel_args["grpc.keepalive_time_ms"] = 300_000
34
+ # Set max metadata size to 4 MB.
35
+ config.channel_args["grpc.max_metadata_size"] = 4 * 1024 * 1024
36
+ config
37
+ end
38
+ yield @configure if block_given?
39
+ @configure
40
+ end
41
+ end
42
+ end
43
+ end
44
+ end
45
+ end
46
+ end
25
47
  end
@@ -21,7 +21,7 @@ module Google
21
21
  module Cloud
22
22
  module PubSub
23
23
  module V1
24
- VERSION = "0.19.0"
24
+ VERSION = "0.20.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
@@ -941,6 +941,7 @@ module Google
941
941
  # Required. The subscription from which messages should be pulled.
942
942
  # Format is `projects/{project}/subscriptions/{sub}`.
943
943
  # @!attribute [rw] return_immediately
944
+ # @deprecated This field is deprecated and may be removed in the next major version update.
944
945
  # @return [::Boolean]
945
946
  # Optional. If this field set to true, the system will respond immediately
946
947
  # even if it there are no messages available to return in the `Pull`
@@ -201,6 +201,7 @@ module Google
201
201
  #
202
202
  # Example: `projects/123/schemas/my-schema@c7cfa2a8`
203
203
  # @!attribute [rw] revision_id
204
+ # @deprecated This field is deprecated and may be removed in the next major version update.
204
205
  # @return [::String]
205
206
  # Optional. This field is deprecated and should not be used for specifying
206
207
  # the revision ID. The revision ID should be specified via the `name`
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: google-cloud-pubsub-v1
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.19.0
4
+ version: 0.20.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-12-08 00:00:00.000000000 Z
11
+ date: 2024-01-11 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: gapic-common
@@ -16,7 +16,7 @@ dependencies:
16
16
  requirements:
17
17
  - - ">="
18
18
  - !ruby/object:Gem::Version
19
- version: 0.20.0
19
+ version: 0.21.1
20
20
  - - "<"
21
21
  - !ruby/object:Gem::Version
22
22
  version: 2.a
@@ -26,7 +26,7 @@ dependencies:
26
26
  requirements:
27
27
  - - ">="
28
28
  - !ruby/object:Gem::Version
29
- version: 0.20.0
29
+ version: 0.21.1
30
30
  - - "<"
31
31
  - !ruby/object:Gem::Version
32
32
  version: 2.a
@@ -50,7 +50,7 @@ dependencies:
50
50
  requirements:
51
51
  - - ">="
52
52
  - !ruby/object:Gem::Version
53
- version: '0.4'
53
+ version: '0.7'
54
54
  - - "<"
55
55
  - !ruby/object:Gem::Version
56
56
  version: 2.a
@@ -60,7 +60,7 @@ dependencies:
60
60
  requirements:
61
61
  - - ">="
62
62
  - !ruby/object:Gem::Version
63
- version: '0.4'
63
+ version: '0.7'
64
64
  - - "<"
65
65
  - !ruby/object:Gem::Version
66
66
  version: 2.a
@@ -245,7 +245,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
245
245
  - !ruby/object:Gem::Version
246
246
  version: '0'
247
247
  requirements: []
248
- rubygems_version: 3.4.19
248
+ rubygems_version: 3.5.3
249
249
  signing_key:
250
250
  specification_version: 4
251
251
  summary: Provides reliable, many-to-many, asynchronous messaging between applications.