google-cloud-language-v1 0.8.1 → 0.10.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: 71e72c9da0fbf33ce83e5215d419c7a6c90919841494e4aca31f70a0c22af05a
4
- data.tar.gz: 11afd32a7f9db2feebca1688c6fbc7f20975e883254ba4f4df826fef23c378df
3
+ metadata.gz: 6b94c94b9be637ab14422a30db5ebdaf1ed6f69d7d40ec9f0522a84810a435e6
4
+ data.tar.gz: e9c65461b73cb070504620b55edfd255a75dc713a5849b7d3f873ee4a52985e4
5
5
  SHA512:
6
- metadata.gz: be7b9e3a9bf09b1bbfb340638fa69921bc45976d0f5a2fa74f195858af14c2c30197efa2586c0b2715d20e9096cc078cd634ec62194668705a57bb7571160f08
7
- data.tar.gz: 3beaba77e6ea94368e17318bac432a41b43b1d2ec762004594e01b0651bc49509f461bd537cc160ebba16072e163872433e02495ad3f4d5b3fb4bce6bff93f48
6
+ metadata.gz: dffbfefe9bd8dd0c7378295b8389bcbe2e49e71febef8f7d42cffecd5b3da1591bab1b2deeaa17558185aa9346018e5c3bd3830f3c381a912fb1366f2bc22d08
7
+ data.tar.gz: 680563a9b4d6e1c22015d0301e5493aec40323044b5bd2c834abcf72b5d31eea73c5f15c61b8f7bd31989f0bdd254722e03ea9b8bf3abd926f95cbed2f17534d
data/AUTHENTICATION.md CHANGED
@@ -1,151 +1,122 @@
1
1
  # Authentication
2
2
 
3
- In general, the google-cloud-language-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-language-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 LANGUAGE_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/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::Language::V1::LanguageService::Client.new
18
+ ```sh
19
+ gcloud auth application-default login
31
20
  ```
32
21
 
33
- ## Credential Lookup
34
-
35
- The google-cloud-language-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-language-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-language-v1
66
- checks for credentials are configured on the service Credentials class (such as
67
- {::Google::Cloud::Language::V1::LanguageService::Credentials}):
34
+ Credentials are accepted in the following ways, in the following order or precedence:
68
35
 
69
- * `LANGUAGE_CREDENTIALS` - Path to JSON file, or JSON contents
70
- * `LANGUAGE_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/language/v1"
77
-
78
- ENV["LANGUAGE_CREDENTIALS"] = "path/to/keyfile.json"
42
+ ### Configuration
79
43
 
80
- client = ::Google::Cloud::Language::V1::LanguageService::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/language/v1"
90
58
 
91
59
  client = ::Google::Cloud::Language::V1::LanguageService::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/language/v1"
100
68
 
101
69
  ::Google::Cloud::Language::V1::LanguageService::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::Language::V1::LanguageService::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-language-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/language/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-language-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::Language::V1::LanguageService::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).
@@ -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
 
@@ -119,6 +122,15 @@ module Google
119
122
  @config
120
123
  end
121
124
 
125
+ ##
126
+ # The effective universe domain
127
+ #
128
+ # @return [String]
129
+ #
130
+ def universe_domain
131
+ @language_service_stub.universe_domain
132
+ end
133
+
122
134
  ##
123
135
  # Create a new LanguageService client object.
124
136
  #
@@ -152,8 +164,9 @@ module Google
152
164
  credentials = @config.credentials
153
165
  # Use self-signed JWT if the endpoint is unchanged from default,
154
166
  # but only if the default endpoint does not have a region prefix.
155
- enable_self_signed_jwt = @config.endpoint == Configuration::DEFAULT_ENDPOINT &&
156
- !@config.endpoint.split(".").first.include?("-")
167
+ enable_self_signed_jwt = @config.endpoint.nil? ||
168
+ (@config.endpoint == Configuration::DEFAULT_ENDPOINT &&
169
+ !@config.endpoint.split(".").first.include?("-"))
157
170
  credentials ||= Credentials.default scope: @config.scope,
158
171
  enable_self_signed_jwt: enable_self_signed_jwt
159
172
  if credentials.is_a?(::String) || credentials.is_a?(::Hash)
@@ -164,10 +177,13 @@ module Google
164
177
 
165
178
  @language_service_stub = ::Gapic::ServiceStub.new(
166
179
  ::Google::Cloud::Language::V1::LanguageService::Stub,
167
- credentials: credentials,
168
- endpoint: @config.endpoint,
180
+ credentials: credentials,
181
+ endpoint: @config.endpoint,
182
+ endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
183
+ universe_domain: @config.universe_domain,
169
184
  channel_args: @config.channel_args,
170
- interceptors: @config.interceptors
185
+ interceptors: @config.interceptors,
186
+ channel_pool_config: @config.channel_pool
171
187
  )
172
188
  end
173
189
 
@@ -765,9 +781,9 @@ module Google
765
781
  # end
766
782
  #
767
783
  # @!attribute [rw] endpoint
768
- # The hostname or hostname:port of the service endpoint.
769
- # Defaults to `"language.googleapis.com"`.
770
- # @return [::String]
784
+ # A custom service endpoint, as a hostname or hostname:port. The default is
785
+ # nil, indicating to use the default endpoint in the current universe domain.
786
+ # @return [::String,nil]
771
787
  # @!attribute [rw] credentials
772
788
  # Credentials to send with calls. You may provide any of the following types:
773
789
  # * (`String`) The path to a service account key file in JSON format
@@ -813,13 +829,20 @@ module Google
813
829
  # @!attribute [rw] quota_project
814
830
  # A separate project against which to charge quota.
815
831
  # @return [::String]
832
+ # @!attribute [rw] universe_domain
833
+ # The universe domain within which to make requests. This determines the
834
+ # default endpoint URL. The default value of nil uses the environment
835
+ # universe (usually the default "googleapis.com" universe).
836
+ # @return [::String,nil]
816
837
  #
817
838
  class Configuration
818
839
  extend ::Gapic::Config
819
840
 
841
+ # @private
842
+ # The endpoint specific to the default "googleapis.com" universe. Deprecated.
820
843
  DEFAULT_ENDPOINT = "language.googleapis.com"
821
844
 
822
- config_attr :endpoint, DEFAULT_ENDPOINT, ::String
845
+ config_attr :endpoint, nil, ::String, nil
823
846
  config_attr :credentials, nil do |value|
824
847
  allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
825
848
  allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
@@ -834,6 +857,7 @@ module Google
834
857
  config_attr :metadata, nil, ::Hash, nil
835
858
  config_attr :retry_policy, nil, ::Hash, ::Proc, nil
836
859
  config_attr :quota_project, nil, ::String, nil
860
+ config_attr :universe_domain, nil, ::String, nil
837
861
 
838
862
  # @private
839
863
  def initialize parent_config = nil
@@ -854,6 +878,14 @@ module Google
854
878
  end
855
879
  end
856
880
 
881
+ ##
882
+ # Configuration for the channel pool
883
+ # @return [::Gapic::ServiceStub::ChannelPool::Configuration]
884
+ #
885
+ def channel_pool
886
+ @channel_pool ||= ::Gapic::ServiceStub::ChannelPool::Configuration.new
887
+ end
888
+
857
889
  ##
858
890
  # Configuration RPC class for the LanguageService API.
859
891
  #
@@ -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
 
@@ -121,6 +124,15 @@ module Google
121
124
  @config
122
125
  end
123
126
 
127
+ ##
128
+ # The effective universe domain
129
+ #
130
+ # @return [String]
131
+ #
132
+ def universe_domain
133
+ @language_service_stub.universe_domain
134
+ end
135
+
124
136
  ##
125
137
  # Create a new LanguageService REST client object.
126
138
  #
@@ -148,8 +160,9 @@ module Google
148
160
  credentials = @config.credentials
149
161
  # Use self-signed JWT if the endpoint is unchanged from default,
150
162
  # but only if the default endpoint does not have a region prefix.
151
- enable_self_signed_jwt = @config.endpoint == Configuration::DEFAULT_ENDPOINT &&
152
- !@config.endpoint.split(".").first.include?("-")
163
+ enable_self_signed_jwt = @config.endpoint.nil? ||
164
+ (@config.endpoint == Configuration::DEFAULT_ENDPOINT &&
165
+ !@config.endpoint.split(".").first.include?("-"))
153
166
  credentials ||= Credentials.default scope: @config.scope,
154
167
  enable_self_signed_jwt: enable_self_signed_jwt
155
168
  if credentials.is_a?(::String) || credentials.is_a?(::Hash)
@@ -159,7 +172,12 @@ module Google
159
172
  @quota_project_id = @config.quota_project
160
173
  @quota_project_id ||= credentials.quota_project_id if credentials.respond_to? :quota_project_id
161
174
 
162
- @language_service_stub = ::Google::Cloud::Language::V1::LanguageService::Rest::ServiceStub.new endpoint: @config.endpoint, credentials: credentials
175
+ @language_service_stub = ::Google::Cloud::Language::V1::LanguageService::Rest::ServiceStub.new(
176
+ endpoint: @config.endpoint,
177
+ endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
178
+ universe_domain: @config.universe_domain,
179
+ credentials: credentials
180
+ )
163
181
  end
164
182
 
165
183
  # Service calls
@@ -193,6 +211,22 @@ module Google
193
211
  # @return [::Google::Cloud::Language::V1::AnalyzeSentimentResponse]
194
212
  #
195
213
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
214
+ #
215
+ # @example Basic example
216
+ # require "google/cloud/language/v1"
217
+ #
218
+ # # Create a client object. The client can be reused for multiple calls.
219
+ # client = Google::Cloud::Language::V1::LanguageService::Rest::Client.new
220
+ #
221
+ # # Create a request. To set request fields, pass in keyword arguments.
222
+ # request = Google::Cloud::Language::V1::AnalyzeSentimentRequest.new
223
+ #
224
+ # # Call the analyze_sentiment method.
225
+ # result = client.analyze_sentiment request
226
+ #
227
+ # # The returned object is of type Google::Cloud::Language::V1::AnalyzeSentimentResponse.
228
+ # p result
229
+ #
196
230
  def analyze_sentiment request, options = nil
197
231
  raise ::ArgumentError, "request must be provided" if request.nil?
198
232
 
@@ -259,6 +293,22 @@ module Google
259
293
  # @return [::Google::Cloud::Language::V1::AnalyzeEntitiesResponse]
260
294
  #
261
295
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
296
+ #
297
+ # @example Basic example
298
+ # require "google/cloud/language/v1"
299
+ #
300
+ # # Create a client object. The client can be reused for multiple calls.
301
+ # client = Google::Cloud::Language::V1::LanguageService::Rest::Client.new
302
+ #
303
+ # # Create a request. To set request fields, pass in keyword arguments.
304
+ # request = Google::Cloud::Language::V1::AnalyzeEntitiesRequest.new
305
+ #
306
+ # # Call the analyze_entities method.
307
+ # result = client.analyze_entities request
308
+ #
309
+ # # The returned object is of type Google::Cloud::Language::V1::AnalyzeEntitiesResponse.
310
+ # p result
311
+ #
262
312
  def analyze_entities request, options = nil
263
313
  raise ::ArgumentError, "request must be provided" if request.nil?
264
314
 
@@ -326,6 +376,22 @@ module Google
326
376
  # @return [::Google::Cloud::Language::V1::AnalyzeEntitySentimentResponse]
327
377
  #
328
378
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
379
+ #
380
+ # @example Basic example
381
+ # require "google/cloud/language/v1"
382
+ #
383
+ # # Create a client object. The client can be reused for multiple calls.
384
+ # client = Google::Cloud::Language::V1::LanguageService::Rest::Client.new
385
+ #
386
+ # # Create a request. To set request fields, pass in keyword arguments.
387
+ # request = Google::Cloud::Language::V1::AnalyzeEntitySentimentRequest.new
388
+ #
389
+ # # Call the analyze_entity_sentiment method.
390
+ # result = client.analyze_entity_sentiment request
391
+ #
392
+ # # The returned object is of type Google::Cloud::Language::V1::AnalyzeEntitySentimentResponse.
393
+ # p result
394
+ #
329
395
  def analyze_entity_sentiment request, options = nil
330
396
  raise ::ArgumentError, "request must be provided" if request.nil?
331
397
 
@@ -392,6 +458,22 @@ module Google
392
458
  # @return [::Google::Cloud::Language::V1::AnalyzeSyntaxResponse]
393
459
  #
394
460
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
461
+ #
462
+ # @example Basic example
463
+ # require "google/cloud/language/v1"
464
+ #
465
+ # # Create a client object. The client can be reused for multiple calls.
466
+ # client = Google::Cloud::Language::V1::LanguageService::Rest::Client.new
467
+ #
468
+ # # Create a request. To set request fields, pass in keyword arguments.
469
+ # request = Google::Cloud::Language::V1::AnalyzeSyntaxRequest.new
470
+ #
471
+ # # Call the analyze_syntax method.
472
+ # result = client.analyze_syntax request
473
+ #
474
+ # # The returned object is of type Google::Cloud::Language::V1::AnalyzeSyntaxResponse.
475
+ # p result
476
+ #
395
477
  def analyze_syntax request, options = nil
396
478
  raise ::ArgumentError, "request must be provided" if request.nil?
397
479
 
@@ -457,6 +539,22 @@ module Google
457
539
  # @return [::Google::Cloud::Language::V1::ClassifyTextResponse]
458
540
  #
459
541
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
542
+ #
543
+ # @example Basic example
544
+ # require "google/cloud/language/v1"
545
+ #
546
+ # # Create a client object. The client can be reused for multiple calls.
547
+ # client = Google::Cloud::Language::V1::LanguageService::Rest::Client.new
548
+ #
549
+ # # Create a request. To set request fields, pass in keyword arguments.
550
+ # request = Google::Cloud::Language::V1::ClassifyTextRequest.new
551
+ #
552
+ # # Call the classify_text method.
553
+ # result = client.classify_text request
554
+ #
555
+ # # The returned object is of type Google::Cloud::Language::V1::ClassifyTextResponse.
556
+ # p result
557
+ #
460
558
  def classify_text request, options = nil
461
559
  raise ::ArgumentError, "request must be provided" if request.nil?
462
560
 
@@ -519,6 +617,22 @@ module Google
519
617
  # @return [::Google::Cloud::Language::V1::ModerateTextResponse]
520
618
  #
521
619
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
620
+ #
621
+ # @example Basic example
622
+ # require "google/cloud/language/v1"
623
+ #
624
+ # # Create a client object. The client can be reused for multiple calls.
625
+ # client = Google::Cloud::Language::V1::LanguageService::Rest::Client.new
626
+ #
627
+ # # Create a request. To set request fields, pass in keyword arguments.
628
+ # request = Google::Cloud::Language::V1::ModerateTextRequest.new
629
+ #
630
+ # # Call the moderate_text method.
631
+ # result = client.moderate_text request
632
+ #
633
+ # # The returned object is of type Google::Cloud::Language::V1::ModerateTextResponse.
634
+ # p result
635
+ #
522
636
  def moderate_text request, options = nil
523
637
  raise ::ArgumentError, "request must be provided" if request.nil?
524
638
 
@@ -586,6 +700,22 @@ module Google
586
700
  # @return [::Google::Cloud::Language::V1::AnnotateTextResponse]
587
701
  #
588
702
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
703
+ #
704
+ # @example Basic example
705
+ # require "google/cloud/language/v1"
706
+ #
707
+ # # Create a client object. The client can be reused for multiple calls.
708
+ # client = Google::Cloud::Language::V1::LanguageService::Rest::Client.new
709
+ #
710
+ # # Create a request. To set request fields, pass in keyword arguments.
711
+ # request = Google::Cloud::Language::V1::AnnotateTextRequest.new
712
+ #
713
+ # # Call the annotate_text method.
714
+ # result = client.annotate_text request
715
+ #
716
+ # # The returned object is of type Google::Cloud::Language::V1::AnnotateTextResponse.
717
+ # p result
718
+ #
589
719
  def annotate_text request, options = nil
590
720
  raise ::ArgumentError, "request must be provided" if request.nil?
591
721
 
@@ -651,9 +781,9 @@ module Google
651
781
  # end
652
782
  #
653
783
  # @!attribute [rw] endpoint
654
- # The hostname or hostname:port of the service endpoint.
655
- # Defaults to `"language.googleapis.com"`.
656
- # @return [::String]
784
+ # A custom service endpoint, as a hostname or hostname:port. The default is
785
+ # nil, indicating to use the default endpoint in the current universe domain.
786
+ # @return [::String,nil]
657
787
  # @!attribute [rw] credentials
658
788
  # Credentials to send with calls. You may provide any of the following types:
659
789
  # * (`String`) The path to a service account key file in JSON format
@@ -690,13 +820,20 @@ module Google
690
820
  # @!attribute [rw] quota_project
691
821
  # A separate project against which to charge quota.
692
822
  # @return [::String]
823
+ # @!attribute [rw] universe_domain
824
+ # The universe domain within which to make requests. This determines the
825
+ # default endpoint URL. The default value of nil uses the environment
826
+ # universe (usually the default "googleapis.com" universe).
827
+ # @return [::String,nil]
693
828
  #
694
829
  class Configuration
695
830
  extend ::Gapic::Config
696
831
 
832
+ # @private
833
+ # The endpoint specific to the default "googleapis.com" universe. Deprecated.
697
834
  DEFAULT_ENDPOINT = "language.googleapis.com"
698
835
 
699
- config_attr :endpoint, DEFAULT_ENDPOINT, ::String
836
+ config_attr :endpoint, nil, ::String, nil
700
837
  config_attr :credentials, nil do |value|
701
838
  allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
702
839
  allowed.any? { |klass| klass === value }
@@ -708,6 +845,7 @@ module Google
708
845
  config_attr :metadata, nil, ::Hash, nil
709
846
  config_attr :retry_policy, nil, ::Hash, ::Proc, nil
710
847
  config_attr :quota_project, nil, ::String, nil
848
+ config_attr :universe_domain, nil, ::String, nil
711
849
 
712
850
  # @private
713
851
  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 V1
24
- VERSION = "0.8.1"
24
+ VERSION = "0.10.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-language-v1
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.8.1
4
+ version: 0.10.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
@@ -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.2
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,