google-cloud-web_risk-v1 0.4.0 → 0.4.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6c2c0fd67b41b0e76dfc94bc78f6e3b9c9cb9e3977d65151338c8dc697352810
-  data.tar.gz: b27c5ea76851d46fb94613eee31b45b22fbbd58b7ea7d4b9dc5630f2f20cd545
+  metadata.gz: 2c97449359e074ec74488e11f75c4c4011b3b81cc13134c42fd601c4cac5ec1a
+  data.tar.gz: 898043f5c3eef97de24bf031f53323e9ca19c86f89832eb33e0ce2327b54addc
 SHA512:
-  metadata.gz: 1927a837efbe78d81f9898e9b99f2a9cdf77dce2f61887c17993c34e98a07b806c923f5cf1cb69bfaf97df69aa1360a9c16c4796ca90446e11acff60be93217f
-  data.tar.gz: 446510d3c96f76a6b473b654021b94b643a0fd5a97360b7c6f9be8f62625f1fa278d7c48788c42b82bf033910b5136e1d180861f19f51fab63f344cbd8cc178b
+  metadata.gz: 6177428c0ccef84cf161fd43ee5be97a350f4aa043b0356f8fbe6b67b25ebf914b8422e55cd6ec0ec76e0396102fb155481f606056c6f43fe3590c47503d5057
+  data.tar.gz: 12f6b5113b359101e6d17b8e523c0c6830845be92d5f7b3af055b2733d79e1cf785aa629ac17823432354e486ba74f4260a3f82556042554a2510fc72b4234a7

data/AUTHENTICATION.md

@@ -66,11 +66,11 @@ The environment variables that google-cloud-web_risk-v1
 checks for credentials are configured on the service Credentials class (such as
 {::Google::Cloud::WebRisk::V1::WebRiskService::Credentials}):
 
-1. `WEBRISK_CREDENTIALS` - Path to JSON file, or JSON contents
-2. `WEBRISK_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
+* `WEBRISK_CREDENTIALS` - Path to JSON file, or JSON contents
+* `WEBRISK_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/web_risk/v1"
@@ -82,8 +82,8 @@ client = ::Google::Cloud::WebRisk::V1::WebRiskService::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/web_risk/v1"
@@ -93,7 +93,7 @@ client = ::Google::Cloud::WebRisk::V1::WebRiskService::Client.new do |config|
 end
 ```
 
-Or configured globally for all clients:
+Or globally for all clients:
 
 ```ruby
 require "google/cloud/web_risk/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/web_risk/v1"
 
 client = ::Google::Cloud::WebRisk::V1::WebRiskService::Client.new
-request = my_create_request
+request = ::Google::Cloud::WebRisk::V1::ComputeThreatListDiffRequest.new # (request fields as keyword arguments...)
 response = client.compute_threat_list_diff request
 ```
 

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

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

data/lib/google/cloud/web_risk/v1/web_risk_service/client.rb

@@ -42,13 +42,12 @@ module Google
             # See {::Google::Cloud::WebRisk::V1::WebRiskService::Client::Configuration}
             # for a description of the configuration fields.
             #
-            # ## Example
+            # @example
             #
-            # To modify the configuration for all WebRiskService clients:
-            #
-            #     ::Google::Cloud::WebRisk::V1::WebRiskService::Client.configure do |config|
-            #       config.timeout = 10.0
-            #     end
+            #   # Modify the configuration for all WebRiskService clients
+            #   ::Google::Cloud::WebRisk::V1::WebRiskService::Client.configure do |config|
+            #     config.timeout = 10.0
+            #   end
             #
             # @yield [config] Configure the Client client.
             # @yieldparam config [Client::Configuration]
@@ -68,26 +67,17 @@ module Google
 
                 default_config.rpcs.compute_threat_list_diff.timeout = 600.0
                 default_config.rpcs.compute_threat_list_diff.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.search_uris.timeout = 600.0
                 default_config.rpcs.search_uris.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.search_hashes.timeout = 600.0
                 default_config.rpcs.search_hashes.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.create_submission.timeout = 60.0
@@ -121,19 +111,15 @@ module Google
             ##
             # Create a new WebRiskService client object.
             #
-            # ## Examples
-            #
-            # To create a new WebRiskService client with the default
-            # configuration:
-            #
-            #     client = ::Google::Cloud::WebRisk::V1::WebRiskService::Client.new
+            # @example
             #
-            # To create a new WebRiskService client with a custom
-            # configuration:
+            #   # Create a client using the default configuration
+            #   client = ::Google::Cloud::WebRisk::V1::WebRiskService::Client.new
             #
-            #     client = ::Google::Cloud::WebRisk::V1::WebRiskService::Client.new do |config|
-            #       config.timeout = 10.0
-            #     end
+            #   # Create a client using a custom configuration
+            #   client = ::Google::Cloud::WebRisk::V1::WebRiskService::Client.new do |config|
+            #     config.timeout = 10.0
+            #   end
             #
             # @yield [config] Configure the WebRiskService client.
             # @yieldparam config [Client::Configuration]
@@ -153,14 +139,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
@@ -219,6 +204,21 @@ module Google
             #
             # @raise [::Google::Cloud::Error] if the RPC is aborted.
             #
+            # @example Basic example
+            #   require "google/cloud/web_risk/v1"
+            #
+            #   # Create a client object. The client can be reused for multiple calls.
+            #   client = Google::Cloud::WebRisk::V1::WebRiskService::Client.new
+            #
+            #   # Create a request. To set request fields, pass in keyword arguments.
+            #   request = Google::Cloud::WebRisk::V1::ComputeThreatListDiffRequest.new
+            #
+            #   # Call the compute_threat_list_diff method.
+            #   result = client.compute_threat_list_diff request
+            #
+            #   # The returned object is of type Google::Cloud::WebRisk::V1::ComputeThreatListDiffResponse.
+            #   p result
+            #
             def compute_threat_list_diff request, options = nil
               raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -239,7 +239,9 @@ module Google
               options.apply_defaults timeout:      @config.rpcs.compute_threat_list_diff.timeout,
                                      metadata:     metadata,
                                      retry_policy: @config.rpcs.compute_threat_list_diff.retry_policy
-              options.apply_defaults metadata:     @config.metadata,
+
+              options.apply_defaults timeout:      @config.timeout,
+                                     metadata:     @config.metadata,
                                      retry_policy: @config.retry_policy
 
               @web_risk_service_stub.call_rpc :compute_threat_list_diff, request, options: options do |response, operation|
@@ -285,6 +287,21 @@ module Google
             #
             # @raise [::Google::Cloud::Error] if the RPC is aborted.
             #
+            # @example Basic example
+            #   require "google/cloud/web_risk/v1"
+            #
+            #   # Create a client object. The client can be reused for multiple calls.
+            #   client = Google::Cloud::WebRisk::V1::WebRiskService::Client.new
+            #
+            #   # Create a request. To set request fields, pass in keyword arguments.
+            #   request = Google::Cloud::WebRisk::V1::SearchUrisRequest.new
+            #
+            #   # Call the search_uris method.
+            #   result = client.search_uris request
+            #
+            #   # The returned object is of type Google::Cloud::WebRisk::V1::SearchUrisResponse.
+            #   p result
+            #
             def search_uris request, options = nil
               raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -305,7 +322,9 @@ module Google
               options.apply_defaults timeout:      @config.rpcs.search_uris.timeout,
                                      metadata:     metadata,
                                      retry_policy: @config.rpcs.search_uris.retry_policy
-              options.apply_defaults metadata:     @config.metadata,
+
+              options.apply_defaults timeout:      @config.timeout,
+                                     metadata:     @config.metadata,
                                      retry_policy: @config.retry_policy
 
               @web_risk_service_stub.call_rpc :search_uris, request, options: options do |response, operation|
@@ -352,6 +371,21 @@ module Google
             #
             # @raise [::Google::Cloud::Error] if the RPC is aborted.
             #
+            # @example Basic example
+            #   require "google/cloud/web_risk/v1"
+            #
+            #   # Create a client object. The client can be reused for multiple calls.
+            #   client = Google::Cloud::WebRisk::V1::WebRiskService::Client.new
+            #
+            #   # Create a request. To set request fields, pass in keyword arguments.
+            #   request = Google::Cloud::WebRisk::V1::SearchHashesRequest.new
+            #
+            #   # Call the search_hashes method.
+            #   result = client.search_hashes request
+            #
+            #   # The returned object is of type Google::Cloud::WebRisk::V1::SearchHashesResponse.
+            #   p result
+            #
             def search_hashes request, options = nil
               raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -372,7 +406,9 @@ module Google
               options.apply_defaults timeout:      @config.rpcs.search_hashes.timeout,
                                      metadata:     metadata,
                                      retry_policy: @config.rpcs.search_hashes.retry_policy
-              options.apply_defaults metadata:     @config.metadata,
+
+              options.apply_defaults timeout:      @config.timeout,
+                                     metadata:     @config.metadata,
                                      retry_policy: @config.retry_policy
 
               @web_risk_service_stub.call_rpc :search_hashes, request, options: options do |response, operation|
@@ -420,6 +456,21 @@ module Google
             #
             # @raise [::Google::Cloud::Error] if the RPC is aborted.
             #
+            # @example Basic example
+            #   require "google/cloud/web_risk/v1"
+            #
+            #   # Create a client object. The client can be reused for multiple calls.
+            #   client = Google::Cloud::WebRisk::V1::WebRiskService::Client.new
+            #
+            #   # Create a request. To set request fields, pass in keyword arguments.
+            #   request = Google::Cloud::WebRisk::V1::CreateSubmissionRequest.new
+            #
+            #   # Call the create_submission method.
+            #   result = client.create_submission request
+            #
+            #   # The returned object is of type Google::Cloud::WebRisk::V1::Submission.
+            #   p result
+            #
             def create_submission request, options = nil
               raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -437,16 +488,20 @@ module Google
                 gapic_version: ::Google::Cloud::WebRisk::V1::VERSION
               metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
 
-              header_params = {
-                "parent" => request.parent
-              }
+              header_params = {}
+              if request.parent
+                header_params["parent"] = request.parent
+              end
+
               request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
               metadata[:"x-goog-request-params"] ||= request_params_header
 
               options.apply_defaults timeout:      @config.rpcs.create_submission.timeout,
                                      metadata:     metadata,
                                      retry_policy: @config.rpcs.create_submission.retry_policy
-              options.apply_defaults metadata:     @config.metadata,
+
+              options.apply_defaults timeout:      @config.timeout,
+                                     metadata:     @config.metadata,
                                      retry_policy: @config.retry_policy
 
               @web_risk_service_stub.call_rpc :create_submission, request, options: options do |response, operation|
@@ -470,22 +525,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 compute_threat_list_diff
-            # to 20 seconds, and all remaining timeouts to 10 seconds:
-            #
-            #     ::Google::Cloud::WebRisk::V1::WebRiskService::Client.configure do |config|
-            #       config.timeout = 10.0
-            #       config.rpcs.compute_threat_list_diff.timeout = 20.0
-            #     end
-            #
-            # To apply the above configuration only to a new client:
-            #
-            #     client = ::Google::Cloud::WebRisk::V1::WebRiskService::Client.new do |config|
-            #       config.timeout = 10.0
-            #       config.rpcs.compute_threat_list_diff.timeout = 20.0
-            #     end
+            # @example
+            #
+            #   # Modify the global config, setting the timeout for
+            #   # compute_threat_list_diff to 20 seconds,
+            #   # and all remaining timeouts to 10 seconds.
+            #   ::Google::Cloud::WebRisk::V1::WebRiskService::Client.configure do |config|
+            #     config.timeout = 10.0
+            #     config.rpcs.compute_threat_list_diff.timeout = 20.0
+            #   end
+            #
+            #   # Apply the above configuration only to a new client.
+            #   client = ::Google::Cloud::WebRisk::V1::WebRiskService::Client.new do |config|
+            #     config.timeout = 10.0
+            #     config.rpcs.compute_threat_list_diff.timeout = 20.0
+            #   end
             #
             # @!attribute [rw] endpoint
             #   The hostname or hostname:port of the service endpoint.

data/lib/google/cloud/webrisk/v1/webrisk_pb.rb

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

data/lib/google/cloud/webrisk/v1/webrisk_services_pb.rb

@@ -28,7 +28,7 @@ module Google
           # website and in client applications.
           class Service
 
-            include GRPC::GenericService
+            include ::GRPC::GenericService
 
             self.marshal_class_method = :encode
             self.unmarshal_class_method = :decode

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-web_risk-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
@@ -197,7 +203,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 Web Risk V1 API