google-cloud-language-v1 0.4.0 → 0.4.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f25f2eb315094473226e0dc4ec339904a6bffc49adf06c2d3ece94264131a9ed
-  data.tar.gz: bbcd900443953b905d025c2b39b8d19c4e5c936780dd80312b2351787c4d47b1
+  metadata.gz: bbcc94c308a251c418ef0fe5643cbe4c8d17f3af4772ee218637111af4a0f0ec
+  data.tar.gz: e6418d2c570381facac07163133f1d5b557996e08d5cf2763705bcf238029aa8
 SHA512:
-  metadata.gz: 6df72bae6acb960223aa5de715f06685aa1e4d0c5fa60754a24f73bb48637742a624447962578e459c1c168d1a654f7eee0dff3ce4ecd051ccc26a0eb2dea647
-  data.tar.gz: 7e8d238f03113699466140f796884a81760dfd613fbebb483eed11b138e47637b5adb09d16756903475578eafcf8a966f0cd91079387042a088fe345d5eed6af
+  metadata.gz: d95a3c1fd8317c3f854caedb538246cb752ead140975094d63595166f87a7e8935076a10c9810db7df5f071ec4536153c06cd06baccbe738c8fcffd531872b6e
+  data.tar.gz: b78562de34b89c7d6f47e18e6881d70fc0df436f54560014b815923f69ea966671fb3a9c81c64c86a7ff5616193c8bcb04ec12801452a766836311a494f772d8

data/AUTHENTICATION.md

@@ -66,11 +66,11 @@ The environment variables that google-cloud-language-v1
 checks for credentials are configured on the service Credentials class (such as
 {::Google::Cloud::Language::V1::LanguageService::Credentials}):
 
-1. `LANGUAGE_CREDENTIALS` - Path to JSON file, or JSON contents
-2. `LANGUAGE_KEYFILE` - Path to JSON file, or JSON contents
-3. `GOOGLE_CLOUD_CREDENTIALS` - Path to JSON file, or JSON contents
-4. `GOOGLE_CLOUD_KEYFILE` - Path to JSON file, or JSON contents
-5. `GOOGLE_APPLICATION_CREDENTIALS` - Path to JSON file
+* `LANGUAGE_CREDENTIALS` - Path to JSON file, or JSON contents
+* `LANGUAGE_KEYFILE` - Path to JSON file, or JSON contents
+* `GOOGLE_CLOUD_CREDENTIALS` - Path to JSON file, or JSON contents
+* `GOOGLE_CLOUD_KEYFILE` - Path to JSON file, or JSON contents
+* `GOOGLE_APPLICATION_CREDENTIALS` - Path to JSON file
 
 ```ruby
 require "google/cloud/language/v1"
@@ -82,8 +82,8 @@ client = ::Google::Cloud::Language::V1::LanguageService::Client.new
 
 ### Configuration
 
-The **Credentials JSON** can be configured instead of placing them in
-environment variables. Either on an individual client initialization:
+The path to the **Credentials JSON** file can be configured instead of storing
+it in an environment variable. Either on an individual client initialization:
 
 ```ruby
 require "google/cloud/language/v1"
@@ -93,7 +93,7 @@ client = ::Google::Cloud::Language::V1::LanguageService::Client.new do |config|
 end
 ```
 
-Or configured globally for all clients:
+Or globally for all clients:
 
 ```ruby
 require "google/cloud/language/v1"

data/README.md

@@ -33,7 +33,7 @@ In order to use this library, you first need to go through the following steps:
 require "google/cloud/language/v1"
 
 client = ::Google::Cloud::Language::V1::LanguageService::Client.new
-request = my_create_request
+request = ::Google::Cloud::Language::V1::AnalyzeSentimentRequest.new # (request fields as keyword arguments...)
 response = client.analyze_sentiment request
 ```
 

data/lib/google/cloud/language/v1/language_service/client.rb

@@ -40,13 +40,12 @@ module Google
             # See {::Google::Cloud::Language::V1::LanguageService::Client::Configuration}
             # for a description of the configuration fields.
             #
-            # ## Example
+            # @example
             #
-            # To modify the configuration for all LanguageService clients:
-            #
-            #     ::Google::Cloud::Language::V1::LanguageService::Client.configure do |config|
-            #       config.timeout = 10.0
-            #     end
+            #   # Modify the configuration for all LanguageService clients
+            #   ::Google::Cloud::Language::V1::LanguageService::Client.configure do |config|
+            #     config.timeout = 10.0
+            #   end
             #
             # @yield [config] Configure the Client client.
             # @yieldparam config [Client::Configuration]
@@ -66,50 +65,32 @@ module Google
 
                 default_config.rpcs.analyze_sentiment.timeout = 600.0
                 default_config.rpcs.analyze_sentiment.retry_policy = {
-                  initial_delay: 0.1,
-              max_delay: 60.0,
-              multiplier: 1.3,
-              retry_codes: [4, 14]
+                  initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [4, 14]
                 }
 
                 default_config.rpcs.analyze_entities.timeout = 600.0
                 default_config.rpcs.analyze_entities.retry_policy = {
-                  initial_delay: 0.1,
-              max_delay: 60.0,
-              multiplier: 1.3,
-              retry_codes: [4, 14]
+                  initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [4, 14]
                 }
 
                 default_config.rpcs.analyze_entity_sentiment.timeout = 600.0
                 default_config.rpcs.analyze_entity_sentiment.retry_policy = {
-                  initial_delay: 0.1,
-              max_delay: 60.0,
-              multiplier: 1.3,
-              retry_codes: [4, 14]
+                  initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [4, 14]
                 }
 
                 default_config.rpcs.analyze_syntax.timeout = 600.0
                 default_config.rpcs.analyze_syntax.retry_policy = {
-                  initial_delay: 0.1,
-              max_delay: 60.0,
-              multiplier: 1.3,
-              retry_codes: [4, 14]
+                  initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [4, 14]
                 }
 
                 default_config.rpcs.classify_text.timeout = 600.0
                 default_config.rpcs.classify_text.retry_policy = {
-                  initial_delay: 0.1,
-              max_delay: 60.0,
-              multiplier: 1.3,
-              retry_codes: [4, 14]
+                  initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [4, 14]
                 }
 
                 default_config.rpcs.annotate_text.timeout = 600.0
                 default_config.rpcs.annotate_text.retry_policy = {
-                  initial_delay: 0.1,
-              max_delay: 60.0,
-              multiplier: 1.3,
-              retry_codes: [4, 14]
+                  initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [4, 14]
                 }
 
                 default_config
@@ -141,19 +122,15 @@ module Google
             ##
             # Create a new LanguageService client object.
             #
-            # ## Examples
-            #
-            # To create a new LanguageService client with the default
-            # configuration:
-            #
-            #     client = ::Google::Cloud::Language::V1::LanguageService::Client.new
+            # @example
             #
-            # To create a new LanguageService client with a custom
-            # configuration:
+            #   # Create a client using the default configuration
+            #   client = ::Google::Cloud::Language::V1::LanguageService::Client.new
             #
-            #     client = ::Google::Cloud::Language::V1::LanguageService::Client.new do |config|
-            #       config.timeout = 10.0
-            #     end
+            #   # Create a client using a custom configuration
+            #   client = ::Google::Cloud::Language::V1::LanguageService::Client.new do |config|
+            #     config.timeout = 10.0
+            #   end
             #
             # @yield [config] Configure the LanguageService client.
             # @yieldparam config [Client::Configuration]
@@ -173,14 +150,13 @@ module Google
 
               # Create credentials
               credentials = @config.credentials
-              # Use self-signed JWT if the scope and endpoint are unchanged from default,
+              # Use self-signed JWT if the endpoint is unchanged from default,
               # but only if the default endpoint does not have a region prefix.
-              enable_self_signed_jwt = @config.scope == Client.configure.scope &&
-                                       @config.endpoint == Client.configure.endpoint &&
+              enable_self_signed_jwt = @config.endpoint == Client.configure.endpoint &&
                                        !@config.endpoint.split(".").first.include?("-")
               credentials ||= Credentials.default scope: @config.scope,
                                                   enable_self_signed_jwt: enable_self_signed_jwt
-              if credentials.is_a?(String) || credentials.is_a?(Hash)
+              if credentials.is_a?(::String) || credentials.is_a?(::Hash)
                 credentials = Credentials.new credentials, scope: @config.scope
               end
               @quota_project_id = @config.quota_project
@@ -228,6 +204,21 @@ module Google
             #
             # @raise [::Google::Cloud::Error] if the RPC is aborted.
             #
+            # @example Basic example
+            #   require "google/cloud/language/v1"
+            #
+            #   # Create a client object. The client can be reused for multiple calls.
+            #   client = Google::Cloud::Language::V1::LanguageService::Client.new
+            #
+            #   # Create a request. To set request fields, pass in keyword arguments.
+            #   request = Google::Cloud::Language::V1::AnalyzeSentimentRequest.new
+            #
+            #   # Call the analyze_sentiment method.
+            #   result = client.analyze_sentiment request
+            #
+            #   # The returned object is of type Google::Cloud::Language::V1::AnalyzeSentimentResponse.
+            #   p result
+            #
             def analyze_sentiment request, options = nil
               raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -248,7 +239,9 @@ module Google
               options.apply_defaults timeout:      @config.rpcs.analyze_sentiment.timeout,
                                      metadata:     metadata,
                                      retry_policy: @config.rpcs.analyze_sentiment.retry_policy
-              options.apply_defaults metadata:     @config.metadata,
+
+              options.apply_defaults timeout:      @config.timeout,
+                                     metadata:     @config.metadata,
                                      retry_policy: @config.retry_policy
 
               @language_service_stub.call_rpc :analyze_sentiment, request, options: options do |response, operation|
@@ -292,6 +285,21 @@ module Google
             #
             # @raise [::Google::Cloud::Error] if the RPC is aborted.
             #
+            # @example Basic example
+            #   require "google/cloud/language/v1"
+            #
+            #   # Create a client object. The client can be reused for multiple calls.
+            #   client = Google::Cloud::Language::V1::LanguageService::Client.new
+            #
+            #   # Create a request. To set request fields, pass in keyword arguments.
+            #   request = Google::Cloud::Language::V1::AnalyzeEntitiesRequest.new
+            #
+            #   # Call the analyze_entities method.
+            #   result = client.analyze_entities request
+            #
+            #   # The returned object is of type Google::Cloud::Language::V1::AnalyzeEntitiesResponse.
+            #   p result
+            #
             def analyze_entities request, options = nil
               raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -312,7 +320,9 @@ module Google
               options.apply_defaults timeout:      @config.rpcs.analyze_entities.timeout,
                                      metadata:     metadata,
                                      retry_policy: @config.rpcs.analyze_entities.retry_policy
-              options.apply_defaults metadata:     @config.metadata,
+
+              options.apply_defaults timeout:      @config.timeout,
+                                     metadata:     @config.metadata,
                                      retry_policy: @config.retry_policy
 
               @language_service_stub.call_rpc :analyze_entities, request, options: options do |response, operation|
@@ -355,6 +365,21 @@ module Google
             #
             # @raise [::Google::Cloud::Error] if the RPC is aborted.
             #
+            # @example Basic example
+            #   require "google/cloud/language/v1"
+            #
+            #   # Create a client object. The client can be reused for multiple calls.
+            #   client = Google::Cloud::Language::V1::LanguageService::Client.new
+            #
+            #   # Create a request. To set request fields, pass in keyword arguments.
+            #   request = Google::Cloud::Language::V1::AnalyzeEntitySentimentRequest.new
+            #
+            #   # Call the analyze_entity_sentiment method.
+            #   result = client.analyze_entity_sentiment request
+            #
+            #   # The returned object is of type Google::Cloud::Language::V1::AnalyzeEntitySentimentResponse.
+            #   p result
+            #
             def analyze_entity_sentiment request, options = nil
               raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -375,7 +400,9 @@ module Google
               options.apply_defaults timeout:      @config.rpcs.analyze_entity_sentiment.timeout,
                                      metadata:     metadata,
                                      retry_policy: @config.rpcs.analyze_entity_sentiment.retry_policy
-              options.apply_defaults metadata:     @config.metadata,
+
+              options.apply_defaults timeout:      @config.timeout,
+                                     metadata:     @config.metadata,
                                      retry_policy: @config.retry_policy
 
               @language_service_stub.call_rpc :analyze_entity_sentiment, request, options: options do |response, operation|
@@ -419,6 +446,21 @@ module Google
             #
             # @raise [::Google::Cloud::Error] if the RPC is aborted.
             #
+            # @example Basic example
+            #   require "google/cloud/language/v1"
+            #
+            #   # Create a client object. The client can be reused for multiple calls.
+            #   client = Google::Cloud::Language::V1::LanguageService::Client.new
+            #
+            #   # Create a request. To set request fields, pass in keyword arguments.
+            #   request = Google::Cloud::Language::V1::AnalyzeSyntaxRequest.new
+            #
+            #   # Call the analyze_syntax method.
+            #   result = client.analyze_syntax request
+            #
+            #   # The returned object is of type Google::Cloud::Language::V1::AnalyzeSyntaxResponse.
+            #   p result
+            #
             def analyze_syntax request, options = nil
               raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -439,7 +481,9 @@ module Google
               options.apply_defaults timeout:      @config.rpcs.analyze_syntax.timeout,
                                      metadata:     metadata,
                                      retry_policy: @config.rpcs.analyze_syntax.retry_policy
-              options.apply_defaults metadata:     @config.metadata,
+
+              options.apply_defaults timeout:      @config.timeout,
+                                     metadata:     @config.metadata,
                                      retry_policy: @config.retry_policy
 
               @language_service_stub.call_rpc :analyze_syntax, request, options: options do |response, operation|
@@ -479,6 +523,21 @@ module Google
             #
             # @raise [::Google::Cloud::Error] if the RPC is aborted.
             #
+            # @example Basic example
+            #   require "google/cloud/language/v1"
+            #
+            #   # Create a client object. The client can be reused for multiple calls.
+            #   client = Google::Cloud::Language::V1::LanguageService::Client.new
+            #
+            #   # Create a request. To set request fields, pass in keyword arguments.
+            #   request = Google::Cloud::Language::V1::ClassifyTextRequest.new
+            #
+            #   # Call the classify_text method.
+            #   result = client.classify_text request
+            #
+            #   # The returned object is of type Google::Cloud::Language::V1::ClassifyTextResponse.
+            #   p result
+            #
             def classify_text request, options = nil
               raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -499,7 +558,9 @@ module Google
               options.apply_defaults timeout:      @config.rpcs.classify_text.timeout,
                                      metadata:     metadata,
                                      retry_policy: @config.rpcs.classify_text.retry_policy
-              options.apply_defaults metadata:     @config.metadata,
+
+              options.apply_defaults timeout:      @config.timeout,
+                                     metadata:     @config.metadata,
                                      retry_policy: @config.retry_policy
 
               @language_service_stub.call_rpc :classify_text, request, options: options do |response, operation|
@@ -544,6 +605,21 @@ module Google
             #
             # @raise [::Google::Cloud::Error] if the RPC is aborted.
             #
+            # @example Basic example
+            #   require "google/cloud/language/v1"
+            #
+            #   # Create a client object. The client can be reused for multiple calls.
+            #   client = Google::Cloud::Language::V1::LanguageService::Client.new
+            #
+            #   # Create a request. To set request fields, pass in keyword arguments.
+            #   request = Google::Cloud::Language::V1::AnnotateTextRequest.new
+            #
+            #   # Call the annotate_text method.
+            #   result = client.annotate_text request
+            #
+            #   # The returned object is of type Google::Cloud::Language::V1::AnnotateTextResponse.
+            #   p result
+            #
             def annotate_text request, options = nil
               raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -564,7 +640,9 @@ module Google
               options.apply_defaults timeout:      @config.rpcs.annotate_text.timeout,
                                      metadata:     metadata,
                                      retry_policy: @config.rpcs.annotate_text.retry_policy
-              options.apply_defaults metadata:     @config.metadata,
+
+              options.apply_defaults timeout:      @config.timeout,
+                                     metadata:     @config.metadata,
                                      retry_policy: @config.retry_policy
 
               @language_service_stub.call_rpc :annotate_text, request, options: options do |response, operation|
@@ -588,22 +666,21 @@ module Google
             # Configuration can be applied globally to all clients, or to a single client
             # on construction.
             #
-            # # Examples
-            #
-            # To modify the global config, setting the timeout for analyze_sentiment
-            # to 20 seconds, and all remaining timeouts to 10 seconds:
-            #
-            #     ::Google::Cloud::Language::V1::LanguageService::Client.configure do |config|
-            #       config.timeout = 10.0
-            #       config.rpcs.analyze_sentiment.timeout = 20.0
-            #     end
-            #
-            # To apply the above configuration only to a new client:
-            #
-            #     client = ::Google::Cloud::Language::V1::LanguageService::Client.new do |config|
-            #       config.timeout = 10.0
-            #       config.rpcs.analyze_sentiment.timeout = 20.0
-            #     end
+            # @example
+            #
+            #   # Modify the global config, setting the timeout for
+            #   # analyze_sentiment to 20 seconds,
+            #   # and all remaining timeouts to 10 seconds.
+            #   ::Google::Cloud::Language::V1::LanguageService::Client.configure do |config|
+            #     config.timeout = 10.0
+            #     config.rpcs.analyze_sentiment.timeout = 20.0
+            #   end
+            #
+            #   # Apply the above configuration only to a new client.
+            #   client = ::Google::Cloud::Language::V1::LanguageService::Client.new do |config|
+            #     config.timeout = 10.0
+            #     config.rpcs.analyze_sentiment.timeout = 20.0
+            #   end
             #
             # @!attribute [rw] endpoint
             #   The hostname or hostname:port of the service endpoint.

data/lib/google/cloud/language/v1/language_service_pb.rb

@@ -1,11 +1,11 @@
 # Generated by the protocol buffer compiler.  DO NOT EDIT!
 # source: google/cloud/language/v1/language_service.proto
 
-require 'google/protobuf'
-
 require 'google/api/annotations_pb'
 require 'google/api/client_pb'
 require 'google/api/field_behavior_pb'
+require 'google/protobuf'
+
 Google::Protobuf::DescriptorPool.generated_pool.build do
   add_file("google/cloud/language/v1/language_service.proto", :syntax => :proto3) do
     add_message "google.cloud.language.v1.Document" do

data/lib/google/cloud/language/v1/language_service_services_pb.rb

@@ -29,7 +29,7 @@ module Google
           # recognition.
           class Service
 
-            include GRPC::GenericService
+            include ::GRPC::GenericService
 
             self.marshal_class_method = :encode
             self.unmarshal_class_method = :decode

data/lib/google/cloud/language/v1/version.rb

@@ -21,7 +21,7 @@ module Google
   module Cloud
     module Language
       module V1
-        VERSION = "0.4.0"
+        VERSION = "0.4.4"
       end
     end
   end

data/proto_docs/google/api/field_behavior.rb

@@ -57,9 +57,15 @@ module Google
 
       # Denotes that a (repeated) field is an unordered list.
       # This indicates that the service may provide the elements of the list
-      # in any arbitrary order, rather than the order the user originally
+      # in any arbitrary  order, rather than the order the user originally
       # provided. Additionally, the list's order may or may not be stable.
       UNORDERED_LIST = 6
+
+      # Denotes that this field returns a non-empty default value if not set.
+      # This indicates that if the user provides the empty value in a request,
+      # a non-empty value will be returned. The user will not be aware of what
+      # non-empty value to expect.
+      NON_EMPTY_DEFAULT = 7
     end
   end
 end

metadata

@@ -1,29 +1,35 @@
 --- !ruby/object:Gem::Specification
 name: google-cloud-language-v1
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.4.4
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-03-09 00:00:00.000000000 Z
+date: 2021-11-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gapic-common
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.7'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '0.3'
+        version: 2.a
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.7'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '0.3'
+        version: 2.a
 - !ruby/object:Gem::Dependency
   name: google-cloud-errors
   requirement: !ruby/object:Gem::Requirement
@@ -195,7 +201,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.13
+rubygems_version: 3.2.17
 signing_key: 
 specification_version: 4
 summary: API Client library for the Natural Language V1 API