google-cloud-language-v2 0.1.0 → 0.3.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 5d5ce6fb48fc36a2dca3144b77cde13086c11d84ee28385bd22f39862f4686fe
4
- data.tar.gz: 9a2b1f502734d8ded1f8aeb41c1c97e569e192b34dbc27e008e987f1e97137be
3
+ metadata.gz: 2b375cf835503b8e8adbac957a9b0a8af6692d19b1baf26abd835ebc92bd9ca7
4
+ data.tar.gz: be54816478122a4f2968aa342ee7aa3e2812a046f25ce66c2ddea41682fdbc6c
5
5
  SHA512:
6
- metadata.gz: '08f72d3f21980c87c67bece1d07f65830f126a4a93c0d9cd71cc8a7482674e4311d7579349bc6a7ffaad0068e0fee29605c692be6d96af3133f43884a1b7cdc9'
7
- data.tar.gz: 91678b72bd9427be6ee60a0d75782d8e925cf7a1a85f7180b91e628ecf087da9aebcc3d6f5e727dd2366b1766cadc39d910a25c77a22a46b673f04c3944d4097
6
+ metadata.gz: 3eabd6d8b22170f22110585b4d5b29cad1e19deb142a50b27a047ee1dfd75a3d19daee470747e486471e30fbaab0052594e2c32fa3553f2c7106920cfeea1b15
7
+ data.tar.gz: 5d34eaa1de44289af355966f285e191ffd028d26af3197cb6b4b99c82655a08ea37261c1e33c6b822e5a47fca1715ee58cba238163793bc6092cf6031c8f30c8
data/AUTHENTICATION.md CHANGED
@@ -1,149 +1,122 @@
1
1
  # Authentication
2
2
 
3
- In general, the google-cloud-language-v2 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-language-v2 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 GOOGLE_CLOUD_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/language/v2"
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::Language::V2::LanguageService::Client.new
18
+ ```sh
19
+ gcloud auth application-default login
31
20
  ```
32
21
 
33
- ## Credential Lookup
34
-
35
- The google-cloud-language-v2 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-language-v2 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-language-v2
66
- checks for credentials are configured on the service Credentials class (such as
67
- {::Google::Cloud::Language::V2::LanguageService::Credentials}):
34
+ Credentials are accepted in the following ways, in the following order or precedence:
68
35
 
69
- * `GOOGLE_CLOUD_CREDENTIALS` - Path to JSON file, or JSON contents
70
- * `GOOGLE_CLOUD_KEYFILE` - Path to JSON file, or JSON contents
71
- * `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)
72
41
 
73
- ```ruby
74
- require "google/cloud/language/v2"
75
-
76
- ENV["GOOGLE_CLOUD_CREDENTIALS"] = "path/to/keyfile.json"
42
+ ### Configuration
77
43
 
78
- client = ::Google::Cloud::Language::V2::LanguageService::Client.new
79
- ```
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).
80
49
 
81
- ### 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.
82
53
 
83
- The path to the **Credentials JSON** file can be configured instead of storing
84
- it in an environment variable. Either on an individual client initialization:
54
+ To configure a credentials file for an individual client initialization:
85
55
 
86
56
  ```ruby
87
57
  require "google/cloud/language/v2"
88
58
 
89
59
  client = ::Google::Cloud::Language::V2::LanguageService::Client.new do |config|
90
- config.credentials = "path/to/keyfile.json"
60
+ config.credentials = "path/to/credentialfile.json"
91
61
  end
92
62
  ```
93
63
 
94
- Or globally for all clients:
64
+ To configure a credentials file globally for all clients:
95
65
 
96
66
  ```ruby
97
67
  require "google/cloud/language/v2"
98
68
 
99
69
  ::Google::Cloud::Language::V2::LanguageService::Client.configure do |config|
100
- config.credentials = "path/to/keyfile.json"
70
+ config.credentials = "path/to/credentialfile.json"
101
71
  end
102
72
 
103
73
  client = ::Google::Cloud::Language::V2::LanguageService::Client.new
104
74
  ```
105
75
 
106
- ### Cloud SDK
76
+ ### Environment Variables
107
77
 
108
- This option allows for an easy way to authenticate during development. If
109
- credentials are not provided in code or in environment variables, then Cloud SDK
110
- 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.
111
82
 
112
- 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).
113
87
 
114
- 1. [Download and install the Cloud SDK](https://cloud.google.com/sdk)
115
- 2. Authenticate using OAuth 2.0 `$ gcloud auth application-default login`
116
- 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-language-v2
93
+ checks for credentials are:
117
94
 
118
- **NOTE:** This is _not_ recommended for running in production. The Cloud SDK
119
- *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
120
97
 
121
- ## Creating a Service Account
98
+ ```ruby
99
+ require "google/cloud/language/v2"
122
100
 
123
- Google Cloud requires **Service Account Credentials** to
124
- connect to the APIs. You will use the **JSON key file** to
125
- connect to most services with google-cloud-language-v2.
101
+ ENV["GOOGLE_APPLICATION_CREDENTIALS"] = "path/to/credentialfile.json"
126
102
 
127
- If you are not running this client within
128
- [Google Cloud Platform environments](#google-cloud-platform-environments), you
129
- need a Google Developers service account.
103
+ client = ::Google::Cloud::Language::V2::LanguageService::Client.new
104
+ ```
130
105
 
131
- 1. Visit the [Google Cloud Console](https://console.cloud.google.com/project).
132
- 2. Create a new project or click on an existing project.
133
- 3. Activate the menu in the upper left and select **APIs & Services**. From
134
- here, you will enable the APIs that your application requires.
106
+ ### Local ADC file
135
107
 
136
- *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.
137
111
 
138
- 4. Select **Credentials** from the side navigation.
112
+ Follow the steps in [Quickstart](#quickstart) to set up a local ADC file.
139
113
 
140
- Find the "Create credentials" drop down near the top of the page, and select
141
- "Service account" to be guided through downloading a new JSON key file.
114
+ ### Google Cloud Platform environments
142
115
 
143
- If you want to re-use an existing service account, you can easily generate a
144
- new key file. Just select the account you wish to re-use, click the pencil
145
- tool on the right side to edit the service account, select the **Keys** tab,
146
- 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.
147
120
 
148
- The key file you download will be used by this library to authenticate API
149
- 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).
@@ -31,6 +31,9 @@ module Google
31
31
  # recognition.
32
32
  #
33
33
  class Client
34
+ # @private
35
+ DEFAULT_ENDPOINT_TEMPLATE = "language.$UNIVERSE_DOMAIN$"
36
+
34
37
  # @private
35
38
  attr_reader :language_service_stub
36
39
 
@@ -114,6 +117,15 @@ module Google
114
117
  @config
115
118
  end
116
119
 
120
+ ##
121
+ # The effective universe domain
122
+ #
123
+ # @return [String]
124
+ #
125
+ def universe_domain
126
+ @language_service_stub.universe_domain
127
+ end
128
+
117
129
  ##
118
130
  # Create a new LanguageService client object.
119
131
  #
@@ -147,8 +159,9 @@ module Google
147
159
  credentials = @config.credentials
148
160
  # Use self-signed JWT if the endpoint is unchanged from default,
149
161
  # but only if the default endpoint does not have a region prefix.
150
- enable_self_signed_jwt = @config.endpoint == Configuration::DEFAULT_ENDPOINT &&
151
- !@config.endpoint.split(".").first.include?("-")
162
+ enable_self_signed_jwt = @config.endpoint.nil? ||
163
+ (@config.endpoint == Configuration::DEFAULT_ENDPOINT &&
164
+ !@config.endpoint.split(".").first.include?("-"))
152
165
  credentials ||= Credentials.default scope: @config.scope,
153
166
  enable_self_signed_jwt: enable_self_signed_jwt
154
167
  if credentials.is_a?(::String) || credentials.is_a?(::Hash)
@@ -159,10 +172,13 @@ module Google
159
172
 
160
173
  @language_service_stub = ::Gapic::ServiceStub.new(
161
174
  ::Google::Cloud::Language::V2::LanguageService::Stub,
162
- credentials: credentials,
163
- endpoint: @config.endpoint,
175
+ credentials: credentials,
176
+ endpoint: @config.endpoint,
177
+ endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
178
+ universe_domain: @config.universe_domain,
164
179
  channel_args: @config.channel_args,
165
- interceptors: @config.interceptors
180
+ interceptors: @config.interceptors,
181
+ channel_pool_config: @config.channel_pool
166
182
  )
167
183
  end
168
184
 
@@ -593,9 +609,9 @@ module Google
593
609
  # end
594
610
  #
595
611
  # @!attribute [rw] endpoint
596
- # The hostname or hostname:port of the service endpoint.
597
- # Defaults to `"language.googleapis.com"`.
598
- # @return [::String]
612
+ # A custom service endpoint, as a hostname or hostname:port. The default is
613
+ # nil, indicating to use the default endpoint in the current universe domain.
614
+ # @return [::String,nil]
599
615
  # @!attribute [rw] credentials
600
616
  # Credentials to send with calls. You may provide any of the following types:
601
617
  # * (`String`) The path to a service account key file in JSON format
@@ -641,13 +657,20 @@ module Google
641
657
  # @!attribute [rw] quota_project
642
658
  # A separate project against which to charge quota.
643
659
  # @return [::String]
660
+ # @!attribute [rw] universe_domain
661
+ # The universe domain within which to make requests. This determines the
662
+ # default endpoint URL. The default value of nil uses the environment
663
+ # universe (usually the default "googleapis.com" universe).
664
+ # @return [::String,nil]
644
665
  #
645
666
  class Configuration
646
667
  extend ::Gapic::Config
647
668
 
669
+ # @private
670
+ # The endpoint specific to the default "googleapis.com" universe. Deprecated.
648
671
  DEFAULT_ENDPOINT = "language.googleapis.com"
649
672
 
650
- config_attr :endpoint, DEFAULT_ENDPOINT, ::String
673
+ config_attr :endpoint, nil, ::String, nil
651
674
  config_attr :credentials, nil do |value|
652
675
  allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
653
676
  allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
@@ -662,6 +685,7 @@ module Google
662
685
  config_attr :metadata, nil, ::Hash, nil
663
686
  config_attr :retry_policy, nil, ::Hash, ::Proc, nil
664
687
  config_attr :quota_project, nil, ::String, nil
688
+ config_attr :universe_domain, nil, ::String, nil
665
689
 
666
690
  # @private
667
691
  def initialize parent_config = nil
@@ -682,6 +706,14 @@ module Google
682
706
  end
683
707
  end
684
708
 
709
+ ##
710
+ # Configuration for the channel pool
711
+ # @return [::Gapic::ServiceStub::ChannelPool::Configuration]
712
+ #
713
+ def channel_pool
714
+ @channel_pool ||= ::Gapic::ServiceStub::ChannelPool::Configuration.new
715
+ end
716
+
685
717
  ##
686
718
  # Configuration RPC class for the LanguageService API.
687
719
  #
@@ -33,6 +33,9 @@ module Google
33
33
  # recognition.
34
34
  #
35
35
  class Client
36
+ # @private
37
+ DEFAULT_ENDPOINT_TEMPLATE = "language.$UNIVERSE_DOMAIN$"
38
+
36
39
  # @private
37
40
  attr_reader :language_service_stub
38
41
 
@@ -116,6 +119,15 @@ module Google
116
119
  @config
117
120
  end
118
121
 
122
+ ##
123
+ # The effective universe domain
124
+ #
125
+ # @return [String]
126
+ #
127
+ def universe_domain
128
+ @language_service_stub.universe_domain
129
+ end
130
+
119
131
  ##
120
132
  # Create a new LanguageService REST client object.
121
133
  #
@@ -143,8 +155,9 @@ module Google
143
155
  credentials = @config.credentials
144
156
  # Use self-signed JWT if the endpoint is unchanged from default,
145
157
  # but only if the default endpoint does not have a region prefix.
146
- enable_self_signed_jwt = @config.endpoint == Configuration::DEFAULT_ENDPOINT &&
147
- !@config.endpoint.split(".").first.include?("-")
158
+ enable_self_signed_jwt = @config.endpoint.nil? ||
159
+ (@config.endpoint == Configuration::DEFAULT_ENDPOINT &&
160
+ !@config.endpoint.split(".").first.include?("-"))
148
161
  credentials ||= Credentials.default scope: @config.scope,
149
162
  enable_self_signed_jwt: enable_self_signed_jwt
150
163
  if credentials.is_a?(::String) || credentials.is_a?(::Hash)
@@ -154,7 +167,12 @@ module Google
154
167
  @quota_project_id = @config.quota_project
155
168
  @quota_project_id ||= credentials.quota_project_id if credentials.respond_to? :quota_project_id
156
169
 
157
- @language_service_stub = ::Google::Cloud::Language::V2::LanguageService::Rest::ServiceStub.new endpoint: @config.endpoint, credentials: credentials
170
+ @language_service_stub = ::Google::Cloud::Language::V2::LanguageService::Rest::ServiceStub.new(
171
+ endpoint: @config.endpoint,
172
+ endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
173
+ universe_domain: @config.universe_domain,
174
+ credentials: credentials
175
+ )
158
176
  end
159
177
 
160
178
  # Service calls
@@ -188,6 +206,22 @@ module Google
188
206
  # @return [::Google::Cloud::Language::V2::AnalyzeSentimentResponse]
189
207
  #
190
208
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
209
+ #
210
+ # @example Basic example
211
+ # require "google/cloud/language/v2"
212
+ #
213
+ # # Create a client object. The client can be reused for multiple calls.
214
+ # client = Google::Cloud::Language::V2::LanguageService::Rest::Client.new
215
+ #
216
+ # # Create a request. To set request fields, pass in keyword arguments.
217
+ # request = Google::Cloud::Language::V2::AnalyzeSentimentRequest.new
218
+ #
219
+ # # Call the analyze_sentiment method.
220
+ # result = client.analyze_sentiment request
221
+ #
222
+ # # The returned object is of type Google::Cloud::Language::V2::AnalyzeSentimentResponse.
223
+ # p result
224
+ #
191
225
  def analyze_sentiment request, options = nil
192
226
  raise ::ArgumentError, "request must be provided" if request.nil?
193
227
 
@@ -254,6 +288,22 @@ module Google
254
288
  # @return [::Google::Cloud::Language::V2::AnalyzeEntitiesResponse]
255
289
  #
256
290
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
291
+ #
292
+ # @example Basic example
293
+ # require "google/cloud/language/v2"
294
+ #
295
+ # # Create a client object. The client can be reused for multiple calls.
296
+ # client = Google::Cloud::Language::V2::LanguageService::Rest::Client.new
297
+ #
298
+ # # Create a request. To set request fields, pass in keyword arguments.
299
+ # request = Google::Cloud::Language::V2::AnalyzeEntitiesRequest.new
300
+ #
301
+ # # Call the analyze_entities method.
302
+ # result = client.analyze_entities request
303
+ #
304
+ # # The returned object is of type Google::Cloud::Language::V2::AnalyzeEntitiesResponse.
305
+ # p result
306
+ #
257
307
  def analyze_entities request, options = nil
258
308
  raise ::ArgumentError, "request must be provided" if request.nil?
259
309
 
@@ -316,6 +366,22 @@ module Google
316
366
  # @return [::Google::Cloud::Language::V2::ClassifyTextResponse]
317
367
  #
318
368
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
369
+ #
370
+ # @example Basic example
371
+ # require "google/cloud/language/v2"
372
+ #
373
+ # # Create a client object. The client can be reused for multiple calls.
374
+ # client = Google::Cloud::Language::V2::LanguageService::Rest::Client.new
375
+ #
376
+ # # Create a request. To set request fields, pass in keyword arguments.
377
+ # request = Google::Cloud::Language::V2::ClassifyTextRequest.new
378
+ #
379
+ # # Call the classify_text method.
380
+ # result = client.classify_text request
381
+ #
382
+ # # The returned object is of type Google::Cloud::Language::V2::ClassifyTextResponse.
383
+ # p result
384
+ #
319
385
  def classify_text request, options = nil
320
386
  raise ::ArgumentError, "request must be provided" if request.nil?
321
387
 
@@ -378,6 +444,22 @@ module Google
378
444
  # @return [::Google::Cloud::Language::V2::ModerateTextResponse]
379
445
  #
380
446
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
447
+ #
448
+ # @example Basic example
449
+ # require "google/cloud/language/v2"
450
+ #
451
+ # # Create a client object. The client can be reused for multiple calls.
452
+ # client = Google::Cloud::Language::V2::LanguageService::Rest::Client.new
453
+ #
454
+ # # Create a request. To set request fields, pass in keyword arguments.
455
+ # request = Google::Cloud::Language::V2::ModerateTextRequest.new
456
+ #
457
+ # # Call the moderate_text method.
458
+ # result = client.moderate_text request
459
+ #
460
+ # # The returned object is of type Google::Cloud::Language::V2::ModerateTextResponse.
461
+ # p result
462
+ #
381
463
  def moderate_text request, options = nil
382
464
  raise ::ArgumentError, "request must be provided" if request.nil?
383
465
 
@@ -444,6 +526,22 @@ module Google
444
526
  # @return [::Google::Cloud::Language::V2::AnnotateTextResponse]
445
527
  #
446
528
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
529
+ #
530
+ # @example Basic example
531
+ # require "google/cloud/language/v2"
532
+ #
533
+ # # Create a client object. The client can be reused for multiple calls.
534
+ # client = Google::Cloud::Language::V2::LanguageService::Rest::Client.new
535
+ #
536
+ # # Create a request. To set request fields, pass in keyword arguments.
537
+ # request = Google::Cloud::Language::V2::AnnotateTextRequest.new
538
+ #
539
+ # # Call the annotate_text method.
540
+ # result = client.annotate_text request
541
+ #
542
+ # # The returned object is of type Google::Cloud::Language::V2::AnnotateTextResponse.
543
+ # p result
544
+ #
447
545
  def annotate_text request, options = nil
448
546
  raise ::ArgumentError, "request must be provided" if request.nil?
449
547
 
@@ -509,9 +607,9 @@ module Google
509
607
  # end
510
608
  #
511
609
  # @!attribute [rw] endpoint
512
- # The hostname or hostname:port of the service endpoint.
513
- # Defaults to `"language.googleapis.com"`.
514
- # @return [::String]
610
+ # A custom service endpoint, as a hostname or hostname:port. The default is
611
+ # nil, indicating to use the default endpoint in the current universe domain.
612
+ # @return [::String,nil]
515
613
  # @!attribute [rw] credentials
516
614
  # Credentials to send with calls. You may provide any of the following types:
517
615
  # * (`String`) The path to a service account key file in JSON format
@@ -548,13 +646,20 @@ module Google
548
646
  # @!attribute [rw] quota_project
549
647
  # A separate project against which to charge quota.
550
648
  # @return [::String]
649
+ # @!attribute [rw] universe_domain
650
+ # The universe domain within which to make requests. This determines the
651
+ # default endpoint URL. The default value of nil uses the environment
652
+ # universe (usually the default "googleapis.com" universe).
653
+ # @return [::String,nil]
551
654
  #
552
655
  class Configuration
553
656
  extend ::Gapic::Config
554
657
 
658
+ # @private
659
+ # The endpoint specific to the default "googleapis.com" universe. Deprecated.
555
660
  DEFAULT_ENDPOINT = "language.googleapis.com"
556
661
 
557
- config_attr :endpoint, DEFAULT_ENDPOINT, ::String
662
+ config_attr :endpoint, nil, ::String, nil
558
663
  config_attr :credentials, nil do |value|
559
664
  allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
560
665
  allowed.any? { |klass| klass === value }
@@ -566,6 +671,7 @@ module Google
566
671
  config_attr :metadata, nil, ::Hash, nil
567
672
  config_attr :retry_policy, nil, ::Hash, ::Proc, nil
568
673
  config_attr :quota_project, nil, ::String, nil
674
+ config_attr :universe_domain, nil, ::String, nil
569
675
 
570
676
  # @private
571
677
  def initialize parent_config = nil
@@ -30,16 +30,28 @@ module Google
30
30
  # including transcoding, making the REST call, and deserialing the response.
31
31
  #
32
32
  class ServiceStub
33
- def initialize endpoint:, credentials:
33
+ def initialize endpoint:, endpoint_template:, universe_domain:, credentials:
34
34
  # These require statements are intentionally placed here to initialize
35
35
  # the REST modules only when it's required.
36
36
  require "gapic/rest"
37
37
 
38
- @client_stub = ::Gapic::Rest::ClientStub.new endpoint: endpoint, 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 analyze_sentiment REST call
45
57
  #
@@ -21,7 +21,7 @@ module Google
21
21
  module Cloud
22
22
  module Language
23
23
  module V2
24
- VERSION = "0.1.0"
24
+ VERSION = "0.3.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
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: google-cloud-language-v2
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.1.0
4
+ version: 0.3.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-08-23 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
@@ -208,7 +208,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
208
208
  - !ruby/object:Gem::Version
209
209
  version: '0'
210
210
  requirements: []
211
- rubygems_version: 3.4.19
211
+ rubygems_version: 3.5.3
212
212
  signing_key:
213
213
  specification_version: 4
214
214
  summary: Provides natural language understanding technologies, such as sentiment analysis,