google-cloud-dataqna-v1alpha 0.2.0 → 0.2.4

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.
Files changed (10) hide show
  1. checksums.yaml +4 -4
  2. data/AUTHENTICATION.md +8 -8
  3. data/README.md +1 -4
  4. data/lib/google/cloud/dataqna/v1alpha/auto_suggestion_service/client.rb +33 -38
  5. data/lib/google/cloud/dataqna/v1alpha/auto_suggestion_service_services_pb.rb +1 -1
  6. data/lib/google/cloud/dataqna/v1alpha/question_service/client.rb +46 -46
  7. data/lib/google/cloud/dataqna/v1alpha/question_service_services_pb.rb +1 -1
  8. data/lib/google/cloud/dataqna/v1alpha/version.rb +1 -1
  9. data/proto_docs/google/api/field_behavior.rb +7 -1
  10. metadata +13 -7
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 415208ed58868b8a703917e8511b1f1b8371f5da09ce050784645423346b34d0
4
- data.tar.gz: d2dd176fe28b4955c5279c95e8842bc569e8059ded4427f16727836beea9fbfb
3
+ metadata.gz: 9fae500f6801b10c3544142902d3eaebf78c856ff49aa51067897fcc13d3af4e
4
+ data.tar.gz: 155a758433bcca4929e191cb1d0262f1e5a7b04c2a0af240122489437ba0a99b
5
5
  SHA512:
6
- metadata.gz: 79ebf08d4e0a662d4e1519cb1fa6ab13446a7f18f04dd5c2c4e2bfce9d8a2eef4c6e8585a27e3ea3a820772b373a6619654f25fcd961af87c0f75788d058fc5a
7
- data.tar.gz: 58f252ab580091a60480422da99027ea60df783dd54cd5eca66a75c2d9fe743bade86cdbb11fe8a4549e1c52e301369c064d5a17d538e81b75c7b3a4a066faf8
6
+ metadata.gz: fa875972b613d9e3446cc19e6b2ecc03ca689f86848e2b424d897d10f705393de94daa27d0f20c6fbaec8f9473070e3a8f8a9e1feb2d2f3e259bf485ad0797b5
7
+ data.tar.gz: b371a1c7cd27330954d595547848a00ffc17254d8870c18ec07ad0a30bce4828b7b2636a96d057dca4a853ac994e160179b518cc25874bb36c8179cbda1f3c5c
data/AUTHENTICATION.md CHANGED
@@ -66,11 +66,11 @@ The environment variables that google-cloud-dataqna-v1alpha
66
66
  checks for credentials are configured on the service Credentials class (such as
67
67
  {::Google::Cloud::DataQnA::V1alpha::AutoSuggestionService::Credentials}):
68
68
 
69
- 1. `BIGQUERY_DATAQNA_CREDENTIALS` - Path to JSON file, or JSON contents
70
- 2. `BIGQUERY_DATAQNA_KEYFILE` - Path to JSON file, or JSON contents
71
- 3. `GOOGLE_CLOUD_CREDENTIALS` - Path to JSON file, or JSON contents
72
- 4. `GOOGLE_CLOUD_KEYFILE` - Path to JSON file, or JSON contents
73
- 5. `GOOGLE_APPLICATION_CREDENTIALS` - Path to JSON file
69
+ * `BIGQUERY_DATAQNA_CREDENTIALS` - Path to JSON file, or JSON contents
70
+ * `BIGQUERY_DATAQNA_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
74
74
 
75
75
  ```ruby
76
76
  require "google/cloud/dataqna/v1alpha"
@@ -82,8 +82,8 @@ client = ::Google::Cloud::DataQnA::V1alpha::AutoSuggestionService::Client.new
82
82
 
83
83
  ### Configuration
84
84
 
85
- The **Credentials JSON** can be configured instead of placing them in
86
- environment variables. Either on an individual client initialization:
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:
87
87
 
88
88
  ```ruby
89
89
  require "google/cloud/dataqna/v1alpha"
@@ -93,7 +93,7 @@ client = ::Google::Cloud::DataQnA::V1alpha::AutoSuggestionService::Client.new do
93
93
  end
94
94
  ```
95
95
 
96
- Or configured globally for all clients:
96
+ Or globally for all clients:
97
97
 
98
98
  ```ruby
99
99
  require "google/cloud/dataqna/v1alpha"
data/README.md CHANGED
@@ -33,16 +33,13 @@ In order to use this library, you first need to go through the following steps:
33
33
  require "google/cloud/dataqna/v1alpha"
34
34
 
35
35
  client = ::Google::Cloud::DataQnA::V1alpha::AutoSuggestionService::Client.new
36
- request = my_create_request
36
+ request = ::Google::Cloud::DataQnA::V1alpha::SuggestQueriesRequest.new # (request fields as keyword arguments...)
37
37
  response = client.suggest_queries request
38
38
  ```
39
39
 
40
40
  View the [Client Library Documentation](https://googleapis.dev/ruby/google-cloud-dataqna-v1alpha/latest)
41
41
  for class and method documentation.
42
42
 
43
- See also the [Product Documentation](https://cloud.google.com/bigquery/docs/dataqna/)
44
- for general usage information.
45
-
46
43
  ## Enabling Logging
47
44
 
48
45
  To enable logging for this library, set the logger for the underlying [gRPC](https://github.com/grpc/grpc/tree/master/src/ruby) library.
data/lib/google/cloud/dataqna/v1alpha/auto_suggestion_service/client.rb CHANGED
@@ -106,13 +106,12 @@ module Google
106
106
  # See {::Google::Cloud::DataQnA::V1alpha::AutoSuggestionService::Client::Configuration}
107
107
  # for a description of the configuration fields.
108
108
  #
109
- # ## Example
109
+ # @example
110
110
  #
111
- # To modify the configuration for all AutoSuggestionService clients:
112
- #
113
- # ::Google::Cloud::DataQnA::V1alpha::AutoSuggestionService::Client.configure do |config|
114
- # config.timeout = 10.0
115
- # end
111
+ # # Modify the configuration for all AutoSuggestionService clients
112
+ # ::Google::Cloud::DataQnA::V1alpha::AutoSuggestionService::Client.configure do |config|
113
+ # config.timeout = 10.0
114
+ # end
116
115
  #
117
116
  # @yield [config] Configure the Client client.
118
117
  # @yieldparam config [Client::Configuration]
@@ -161,19 +160,15 @@ module Google
161
160
  ##
162
161
  # Create a new AutoSuggestionService client object.
163
162
  #
164
- # ## Examples
165
- #
166
- # To create a new AutoSuggestionService client with the default
167
- # configuration:
163
+ # @example
168
164
  #
169
- # client = ::Google::Cloud::DataQnA::V1alpha::AutoSuggestionService::Client.new
165
+ # # Create a client using the default configuration
166
+ # client = ::Google::Cloud::DataQnA::V1alpha::AutoSuggestionService::Client.new
170
167
  #
171
- # To create a new AutoSuggestionService client with a custom
172
- # configuration:
173
- #
174
- # client = ::Google::Cloud::DataQnA::V1alpha::AutoSuggestionService::Client.new do |config|
175
- # config.timeout = 10.0
176
- # end
168
+ # # Create a client using a custom configuration
169
+ # client = ::Google::Cloud::DataQnA::V1alpha::AutoSuggestionService::Client.new do |config|
170
+ # config.timeout = 10.0
171
+ # end
177
172
  #
178
173
  # @yield [config] Configure the AutoSuggestionService client.
179
174
  # @yieldparam config [Client::Configuration]
@@ -193,14 +188,13 @@ module Google
193
188
 
194
189
  # Create credentials
195
190
  credentials = @config.credentials
196
- # Use self-signed JWT if the scope and endpoint are unchanged from default,
191
+ # Use self-signed JWT if the endpoint is unchanged from default,
197
192
  # but only if the default endpoint does not have a region prefix.
198
- enable_self_signed_jwt = @config.scope == Client.configure.scope &&
199
- @config.endpoint == Client.configure.endpoint &&
193
+ enable_self_signed_jwt = @config.endpoint == Client.configure.endpoint &&
200
194
  !@config.endpoint.split(".").first.include?("-")
201
195
  credentials ||= Credentials.default scope: @config.scope,
202
196
  enable_self_signed_jwt: enable_self_signed_jwt
203
- if credentials.is_a?(String) || credentials.is_a?(Hash)
197
+ if credentials.is_a?(::String) || credentials.is_a?(::Hash)
204
198
  credentials = Credentials.new credentials, scope: @config.scope
205
199
  end
206
200
  @quota_project_id = @config.quota_project
@@ -289,7 +283,9 @@ module Google
289
283
  options.apply_defaults timeout: @config.rpcs.suggest_queries.timeout,
290
284
  metadata: metadata,
291
285
  retry_policy: @config.rpcs.suggest_queries.retry_policy
292
- options.apply_defaults metadata: @config.metadata,
286
+
287
+ options.apply_defaults timeout: @config.timeout,
288
+ metadata: @config.metadata,
293
289
  retry_policy: @config.retry_policy
294
290
 
295
291
  @auto_suggestion_service_stub.call_rpc :suggest_queries, request, options: options do |response, operation|
@@ -313,22 +309,21 @@ module Google
313
309
  # Configuration can be applied globally to all clients, or to a single client
314
310
  # on construction.
315
311
  #
316
- # # Examples
317
- #
318
- # To modify the global config, setting the timeout for suggest_queries
319
- # to 20 seconds, and all remaining timeouts to 10 seconds:
320
- #
321
- # ::Google::Cloud::DataQnA::V1alpha::AutoSuggestionService::Client.configure do |config|
322
- # config.timeout = 10.0
323
- # config.rpcs.suggest_queries.timeout = 20.0
324
- # end
325
- #
326
- # To apply the above configuration only to a new client:
327
- #
328
- # client = ::Google::Cloud::DataQnA::V1alpha::AutoSuggestionService::Client.new do |config|
329
- # config.timeout = 10.0
330
- # config.rpcs.suggest_queries.timeout = 20.0
331
- # end
312
+ # @example
313
+ #
314
+ # # Modify the global config, setting the timeout for
315
+ # # suggest_queries to 20 seconds,
316
+ # # and all remaining timeouts to 10 seconds.
317
+ # ::Google::Cloud::DataQnA::V1alpha::AutoSuggestionService::Client.configure do |config|
318
+ # config.timeout = 10.0
319
+ # config.rpcs.suggest_queries.timeout = 20.0
320
+ # end
321
+ #
322
+ # # Apply the above configuration only to a new client.
323
+ # client = ::Google::Cloud::DataQnA::V1alpha::AutoSuggestionService::Client.new do |config|
324
+ # config.timeout = 10.0
325
+ # config.rpcs.suggest_queries.timeout = 20.0
326
+ # end
332
327
  #
333
328
  # @!attribute [rw] endpoint
334
329
  # The hostname or hostname:port of the service endpoint.
data/lib/google/cloud/dataqna/v1alpha/auto_suggestion_service_services_pb.rb CHANGED
@@ -92,7 +92,7 @@ module Google
92
92
  # ```
93
93
  class Service
94
94
 
95
- include GRPC::GenericService
95
+ include ::GRPC::GenericService
96
96
 
97
97
  self.marshal_class_method = :encode
98
98
  self.unmarshal_class_method = :decode
data/lib/google/cloud/dataqna/v1alpha/question_service/client.rb CHANGED
@@ -55,13 +55,12 @@ module Google
55
55
  # See {::Google::Cloud::DataQnA::V1alpha::QuestionService::Client::Configuration}
56
56
  # for a description of the configuration fields.
57
57
  #
58
- # ## Example
58
+ # @example
59
59
  #
60
- # To modify the configuration for all QuestionService clients:
61
- #
62
- # ::Google::Cloud::DataQnA::V1alpha::QuestionService::Client.configure do |config|
63
- # config.timeout = 10.0
64
- # end
60
+ # # Modify the configuration for all QuestionService clients
61
+ # ::Google::Cloud::DataQnA::V1alpha::QuestionService::Client.configure do |config|
62
+ # config.timeout = 10.0
63
+ # end
65
64
  #
66
65
  # @yield [config] Configure the Client client.
67
66
  # @yieldparam config [Client::Configuration]
@@ -81,10 +80,7 @@ module Google
81
80
 
82
81
  default_config.timeout = 60.0
83
82
  default_config.retry_policy = {
84
- initial_delay: 1.0,
85
- max_delay: 10.0,
86
- multiplier: 1.3,
87
- retry_codes: [14]
83
+ initial_delay: 1.0, max_delay: 10.0, multiplier: 1.3, retry_codes: [14]
88
84
  }
89
85
 
90
86
  default_config.rpcs.create_question.timeout = 60.0
@@ -122,19 +118,15 @@ module Google
122
118
  ##
123
119
  # Create a new QuestionService client object.
124
120
  #
125
- # ## Examples
126
- #
127
- # To create a new QuestionService client with the default
128
- # configuration:
129
- #
130
- # client = ::Google::Cloud::DataQnA::V1alpha::QuestionService::Client.new
121
+ # @example
131
122
  #
132
- # To create a new QuestionService client with a custom
133
- # configuration:
123
+ # # Create a client using the default configuration
124
+ # client = ::Google::Cloud::DataQnA::V1alpha::QuestionService::Client.new
134
125
  #
135
- # client = ::Google::Cloud::DataQnA::V1alpha::QuestionService::Client.new do |config|
136
- # config.timeout = 10.0
137
- # end
126
+ # # Create a client using a custom configuration
127
+ # client = ::Google::Cloud::DataQnA::V1alpha::QuestionService::Client.new do |config|
128
+ # config.timeout = 10.0
129
+ # end
138
130
  #
139
131
  # @yield [config] Configure the QuestionService client.
140
132
  # @yieldparam config [Client::Configuration]
@@ -154,14 +146,13 @@ module Google
154
146
 
155
147
  # Create credentials
156
148
  credentials = @config.credentials
157
- # Use self-signed JWT if the scope and endpoint are unchanged from default,
149
+ # Use self-signed JWT if the endpoint is unchanged from default,
158
150
  # but only if the default endpoint does not have a region prefix.
159
- enable_self_signed_jwt = @config.scope == Client.configure.scope &&
160
- @config.endpoint == Client.configure.endpoint &&
151
+ enable_self_signed_jwt = @config.endpoint == Client.configure.endpoint &&
161
152
  !@config.endpoint.split(".").first.include?("-")
162
153
  credentials ||= Credentials.default scope: @config.scope,
163
154
  enable_self_signed_jwt: enable_self_signed_jwt
164
- if credentials.is_a?(String) || credentials.is_a?(Hash)
155
+ if credentials.is_a?(::String) || credentials.is_a?(::Hash)
165
156
  credentials = Credentials.new credentials, scope: @config.scope
166
157
  end
167
158
  @quota_project_id = @config.quota_project
@@ -236,7 +227,9 @@ module Google
236
227
  options.apply_defaults timeout: @config.rpcs.get_question.timeout,
237
228
  metadata: metadata,
238
229
  retry_policy: @config.rpcs.get_question.retry_policy
239
- options.apply_defaults metadata: @config.metadata,
230
+
231
+ options.apply_defaults timeout: @config.timeout,
232
+ metadata: @config.metadata,
240
233
  retry_policy: @config.retry_policy
241
234
 
242
235
  @question_service_stub.call_rpc :get_question, request, options: options do |response, operation|
@@ -305,7 +298,9 @@ module Google
305
298
  options.apply_defaults timeout: @config.rpcs.create_question.timeout,
306
299
  metadata: metadata,
307
300
  retry_policy: @config.rpcs.create_question.retry_policy
308
- options.apply_defaults metadata: @config.metadata,
301
+
302
+ options.apply_defaults timeout: @config.timeout,
303
+ metadata: @config.metadata,
309
304
  retry_policy: @config.retry_policy
310
305
 
311
306
  @question_service_stub.call_rpc :create_question, request, options: options do |response, operation|
@@ -374,7 +369,9 @@ module Google
374
369
  options.apply_defaults timeout: @config.rpcs.execute_question.timeout,
375
370
  metadata: metadata,
376
371
  retry_policy: @config.rpcs.execute_question.retry_policy
377
- options.apply_defaults metadata: @config.metadata,
372
+
373
+ options.apply_defaults timeout: @config.timeout,
374
+ metadata: @config.metadata,
378
375
  retry_policy: @config.retry_policy
379
376
 
380
377
  @question_service_stub.call_rpc :execute_question, request, options: options do |response, operation|
@@ -442,7 +439,9 @@ module Google
442
439
  options.apply_defaults timeout: @config.rpcs.get_user_feedback.timeout,
443
440
  metadata: metadata,
444
441
  retry_policy: @config.rpcs.get_user_feedback.retry_policy
445
- options.apply_defaults metadata: @config.metadata,
442
+
443
+ options.apply_defaults timeout: @config.timeout,
444
+ metadata: @config.metadata,
446
445
  retry_policy: @config.retry_policy
447
446
 
448
447
  @question_service_stub.call_rpc :get_user_feedback, request, options: options do |response, operation|
@@ -514,7 +513,9 @@ module Google
514
513
  options.apply_defaults timeout: @config.rpcs.update_user_feedback.timeout,
515
514
  metadata: metadata,
516
515
  retry_policy: @config.rpcs.update_user_feedback.retry_policy
517
- options.apply_defaults metadata: @config.metadata,
516
+
517
+ options.apply_defaults timeout: @config.timeout,
518
+ metadata: @config.metadata,
518
519
  retry_policy: @config.retry_policy
519
520
 
520
521
  @question_service_stub.call_rpc :update_user_feedback, request, options: options do |response, operation|
@@ -538,22 +539,21 @@ module Google
538
539
  # Configuration can be applied globally to all clients, or to a single client
539
540
  # on construction.
540
541
  #
541
- # # Examples
542
- #
543
- # To modify the global config, setting the timeout for get_question
544
- # to 20 seconds, and all remaining timeouts to 10 seconds:
545
- #
546
- # ::Google::Cloud::DataQnA::V1alpha::QuestionService::Client.configure do |config|
547
- # config.timeout = 10.0
548
- # config.rpcs.get_question.timeout = 20.0
549
- # end
550
- #
551
- # To apply the above configuration only to a new client:
552
- #
553
- # client = ::Google::Cloud::DataQnA::V1alpha::QuestionService::Client.new do |config|
554
- # config.timeout = 10.0
555
- # config.rpcs.get_question.timeout = 20.0
556
- # end
542
+ # @example
543
+ #
544
+ # # Modify the global config, setting the timeout for
545
+ # # get_question to 20 seconds,
546
+ # # and all remaining timeouts to 10 seconds.
547
+ # ::Google::Cloud::DataQnA::V1alpha::QuestionService::Client.configure do |config|
548
+ # config.timeout = 10.0
549
+ # config.rpcs.get_question.timeout = 20.0
550
+ # end
551
+ #
552
+ # # Apply the above configuration only to a new client.
553
+ # client = ::Google::Cloud::DataQnA::V1alpha::QuestionService::Client.new do |config|
554
+ # config.timeout = 10.0
555
+ # config.rpcs.get_question.timeout = 20.0
556
+ # end
557
557
  #
558
558
  # @!attribute [rw] endpoint
559
559
  # The hostname or hostname:port of the service endpoint.
data/lib/google/cloud/dataqna/v1alpha/question_service_services_pb.rb CHANGED
@@ -41,7 +41,7 @@ module Google
41
41
  # user feedback.
42
42
  class Service
43
43
 
44
- include GRPC::GenericService
44
+ include ::GRPC::GenericService
45
45
 
46
46
  self.marshal_class_method = :encode
47
47
  self.unmarshal_class_method = :decode
data/lib/google/cloud/dataqna/v1alpha/version.rb CHANGED
@@ -21,7 +21,7 @@ module Google
21
21
  module Cloud
22
22
  module DataQnA
23
23
  module V1alpha
24
- VERSION = "0.2.0"
24
+ VERSION = "0.2.4"
25
25
  end
26
26
  end
27
27
  end
data/proto_docs/google/api/field_behavior.rb CHANGED
@@ -57,9 +57,15 @@ module Google
57
57
 
58
58
  # Denotes that a (repeated) field is an unordered list.
59
59
  # This indicates that the service may provide the elements of the list
60
- # in any arbitrary order, rather than the order the user originally
60
+ # in any arbitrary order, rather than the order the user originally
61
61
  # provided. Additionally, the list's order may or may not be stable.
62
62
  UNORDERED_LIST = 6
63
+
64
+ # Denotes that this field returns a non-empty default value if not set.
65
+ # This indicates that if the user provides the empty value in a request,
66
+ # a non-empty value will be returned. The user will not be aware of what
67
+ # non-empty value to expect.
68
+ NON_EMPTY_DEFAULT = 7
63
69
  end
64
70
  end
65
71
  end
metadata CHANGED
@@ -1,29 +1,35 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: google-cloud-dataqna-v1alpha
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.2.0
4
+ version: 0.2.4
5
5
  platform: ruby
6
6
  authors:
7
7
  - Google LLC
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2021-03-09 00:00:00.000000000 Z
11
+ date: 2021-09-28 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: gapic-common
15
15
  requirement: !ruby/object:Gem::Requirement
16
16
  requirements:
17
- - - "~>"
17
+ - - ">="
18
+ - !ruby/object:Gem::Version
19
+ version: '0.7'
20
+ - - "<"
18
21
  - !ruby/object:Gem::Version
19
- version: '0.3'
22
+ version: 2.a
20
23
  type: :runtime
21
24
  prerelease: false
22
25
  version_requirements: !ruby/object:Gem::Requirement
23
26
  requirements:
24
- - - "~>"
27
+ - - ">="
28
+ - !ruby/object:Gem::Version
29
+ version: '0.7'
30
+ - - "<"
25
31
  - !ruby/object:Gem::Version
26
- version: '0.3'
32
+ version: 2.a
27
33
  - !ruby/object:Gem::Dependency
28
34
  name: google-cloud-errors
29
35
  requirement: !ruby/object:Gem::Requirement
@@ -212,7 +218,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
212
218
  - !ruby/object:Gem::Version
213
219
  version: '0'
214
220
  requirements: []
215
- rubygems_version: 3.2.13
221
+ rubygems_version: 3.2.17
216
222
  signing_key:
217
223
  specification_version: 4
218
224
  summary: API Client library for the BigQuery Data QnA V1alpha API