google-cloud-web_risk-v1 0.6.0 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f4a1e42a4e53cb1cc7bb49da3a6d93e8b6d1fe12d13a6625aa47b4b37079d7b2
-  data.tar.gz: 4f102663e3699e6d4c49471dd85ddf90f8f75f74895c716e124f32fe430e7599
+  metadata.gz: 5917c20c38860aa4203e645388a14d19e694f03231c7227446022b6144d438e3
+  data.tar.gz: 0c62427299f2a62d8261c2fd96cea1c331c4d5275726f006c7aa80eea64e3d09
 SHA512:
-  metadata.gz: 91995f126535a48f2f96c267f15ff441608506e1ec9390edf5887e969da80e1c22850ef3d8c4651d3dd9e9a69fe1899b3d24a31150a0ff7fe0a900db754b2adb
-  data.tar.gz: d49f8bb4a0f765044999c38ea3d78b68325e84984b9781bf1955bcc012b1ef5ab3037cc8c486e5ef6af524edb5c49db8b1de8f02a3572c27e73ed6cc5bbf3db7
+  metadata.gz: f057ccdca509ca2dfb7a5996805ea7e98678ddcb15be0eb6e3f0baf77ec3f9d8bd41b80e0ab72a7c37069707fe17cfcc96b40c15fe4a988c6b341f2c623a5a47
+  data.tar.gz: 2b16c774b6a7302d7b44e26fc25d4f0cafb6aabc9bcb956ee2af970b4d9fe0876090c69133d490a9d8e7d91d15f068c668fd8915b1e734f33052dd6ed11ce2c2

data/README.md

@@ -46,8 +46,8 @@ for general usage information.
 ## Enabling Logging
 
 To enable logging for this library, set the logger for the underlying [gRPC](https://github.com/grpc/grpc/tree/master/src/ruby) library.
-The logger that you set may be a Ruby stdlib [`Logger`](https://ruby-doc.org/stdlib/libdoc/logger/rdoc/Logger.html) as shown below,
-or a [`Google::Cloud::Logging::Logger`](https://googleapis.dev/ruby/google-cloud-logging/latest)
+The logger that you set may be a Ruby stdlib [`Logger`](https://ruby-doc.org/current/stdlibs/logger/Logger.html) as shown below,
+or a [`Google::Cloud::Logging::Logger`](https://cloud.google.com/ruby/docs/reference/google-cloud-logging/latest)
 that will write logs to [Cloud Logging](https://cloud.google.com/logging/). See [grpc/logconfig.rb](https://github.com/grpc/grpc/blob/master/src/ruby/lib/grpc/logconfig.rb)
 and the gRPC [spec_helper.rb](https://github.com/grpc/grpc/blob/master/src/ruby/spec/spec_helper.rb) for additional information.
 

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

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+# Copyright 2023 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
+
+require "google/cloud/web_risk/v1/web_risk_service/rest"
+require "google/cloud/web_risk/v1/version"
+
+module Google
+  module Cloud
+    module WebRisk
+      ##
+      # To load just the REST part of this package, including all its services, and instantiate a REST client:
+      #
+      # @example
+      #
+      #     require "google/cloud/web_risk/v1/rest"
+      #     client = ::Google::Cloud::WebRisk::V1::WebRiskService::Rest::Client.new
+      #
+      module V1
+      end
+    end
+  end
+end

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

@@ -21,7 +21,7 @@ module Google
   module Cloud
     module WebRisk
       module V1
-        VERSION = "0.6.0"
+        VERSION = "0.8.0"
       end
     end
   end

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

@@ -151,6 +151,12 @@ module Google
               @quota_project_id = @config.quota_project
               @quota_project_id ||= credentials.quota_project_id if credentials.respond_to? :quota_project_id
 
+              @operations_client = Operations.new do |config|
+                config.credentials = credentials
+                config.quota_project = @quota_project_id
+                config.endpoint = @config.endpoint
+              end
+
               @web_risk_service_stub = ::Gapic::ServiceStub.new(
                 ::Google::Cloud::WebRisk::V1::WebRiskService::Stub,
                 credentials:  credentials,
@@ -160,6 +166,13 @@ module Google
               )
             end
 
+            ##
+            # Get the associated client for long-running operations.
+            #
+            # @return [::Google::Cloud::WebRisk::V1::WebRiskService::Operations]
+            #
+            attr_reader :operations_client
+
             # Service calls
 
             ##
@@ -186,9 +199,9 @@ module Google
             #   the default parameter values, pass an empty Hash as a request object (see above).
             #
             #   @param threat_type [::Google::Cloud::WebRisk::V1::ThreatType]
-            #     Required. The threat list to update. Only a single ThreatType should be specified
-            #     per request. If you want to handle multiple ThreatTypes, you must make one
-            #     request per ThreatType.
+            #     Required. The threat list to update. Only a single ThreatType should be
+            #     specified per request. If you want to handle multiple ThreatTypes, you must
+            #     make one request per ThreatType.
             #   @param version_token [::String]
             #     The current version token of the client for the requested list (the
             #     client version that was received from the last successful diff).
@@ -279,7 +292,8 @@ module Google
             #   @param uri [::String]
             #     Required. The URI to be checked for matches.
             #   @param threat_types [::Array<::Google::Cloud::WebRisk::V1::ThreatType>]
-            #     Required. The ThreatLists to search in. Multiple ThreatLists may be specified.
+            #     Required. The ThreatLists to search in. Multiple ThreatLists may be
+            #     specified.
             #
             # @yield [response, operation] Access the result along with the RPC operation
             # @yieldparam response [::Google::Cloud::WebRisk::V1::SearchUrisResponse]
@@ -365,7 +379,8 @@ module Google
             #     Note that if this parameter is provided by a URI, it must be encoded using
             #     the web safe base64 variant (RFC 4648).
             #   @param threat_types [::Array<::Google::Cloud::WebRisk::V1::ThreatType>]
-            #     Required. The ThreatLists to search in. Multiple ThreatLists may be specified.
+            #     Required. The ThreatLists to search in. Multiple ThreatLists may be
+            #     specified.
             #
             # @yield [response, operation] Access the result along with the RPC operation
             # @yieldparam response [::Google::Cloud::WebRisk::V1::SearchHashesResponse]
@@ -448,8 +463,8 @@ module Google
             #   the default parameter values, pass an empty Hash as a request object (see above).
             #
             #   @param parent [::String]
-            #     Required. The name of the project that is making the submission. This string is in
-            #     the format "projects/\\{project_number}".
+            #     Required. The name of the project that is making the submission. This
+            #     string is in the format "projects/\\{project_number}".
             #   @param submission [::Google::Cloud::WebRisk::V1::Submission, ::Hash]
             #     Required. The submission that contains the content of the phishing report.
             #
@@ -517,6 +532,115 @@ module Google
               raise ::Google::Cloud::Error.from_error(e)
             end
 
+            ##
+            # Submits a URI suspected of containing malicious content to be reviewed.
+            # Returns a google.longrunning.Operation which, once the review is complete,
+            # is updated with its result. You can use the [Pub/Sub API]
+            # (https://cloud.google.com/pubsub) to receive notifications for the returned
+            # Operation. If the result verifies the existence of malicious content, the
+            # site will be added to the [Google's Social Engineering lists]
+            # (https://support.google.com/webmasters/answer/6350487/) in order to
+            # protect users that could get exposed to this threat in the future. Only
+            # allowlisted projects can use this method during Early Access. Please reach
+            # out to Sales or your customer engineer to obtain access.
+            #
+            # @overload submit_uri(request, options = nil)
+            #   Pass arguments to `submit_uri` via a request object, either of type
+            #   {::Google::Cloud::WebRisk::V1::SubmitUriRequest} or an equivalent Hash.
+            #
+            #   @param request [::Google::Cloud::WebRisk::V1::SubmitUriRequest, ::Hash]
+            #     A request object representing the call parameters. Required. To specify no
+            #     parameters, or to keep all the default parameter values, pass an empty Hash.
+            #   @param options [::Gapic::CallOptions, ::Hash]
+            #     Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
+            #
+            # @overload submit_uri(parent: nil, submission: nil, threat_info: nil, threat_discovery: nil)
+            #   Pass arguments to `submit_uri` via keyword arguments. Note that at
+            #   least one keyword argument is required. To specify no parameters, or to keep all
+            #   the default parameter values, pass an empty Hash as a request object (see above).
+            #
+            #   @param parent [::String]
+            #     Required. The name of the project that is making the submission. This
+            #     string is in the format "projects/\\{project_number}".
+            #   @param submission [::Google::Cloud::WebRisk::V1::Submission, ::Hash]
+            #     Required. The submission that contains the URI to be scanned.
+            #   @param threat_info [::Google::Cloud::WebRisk::V1::ThreatInfo, ::Hash]
+            #     Provides additional information about the submission.
+            #   @param threat_discovery [::Google::Cloud::WebRisk::V1::ThreatDiscovery, ::Hash]
+            #     Provides additional information about how the submission was discovered.
+            #
+            # @yield [response, operation] Access the result along with the RPC operation
+            # @yieldparam response [::Gapic::Operation]
+            # @yieldparam operation [::GRPC::ActiveCall::Operation]
+            #
+            # @return [::Gapic::Operation]
+            #
+            # @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::SubmitUriRequest.new
+            #
+            #   # Call the submit_uri method.
+            #   result = client.submit_uri request
+            #
+            #   # The returned object is of type Gapic::Operation. You can use it to
+            #   # check the status of an operation, cancel it, or wait for results.
+            #   # Here is how to wait for a response.
+            #   result.wait_until_done! timeout: 60
+            #   if result.response?
+            #     p result.response
+            #   else
+            #     puts "No response received."
+            #   end
+            #
+            def submit_uri request, options = nil
+              raise ::ArgumentError, "request must be provided" if request.nil?
+
+              request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::WebRisk::V1::SubmitUriRequest
+
+              # Converts hash and nil to an options object
+              options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
+
+              # Customize the options with defaults
+              metadata = @config.rpcs.submit_uri.metadata.to_h
+
+              # Set x-goog-api-client and x-goog-user-project headers
+              metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
+                lib_name: @config.lib_name, lib_version: @config.lib_version,
+                gapic_version: ::Google::Cloud::WebRisk::V1::VERSION
+              metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
+
+              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.submit_uri.timeout,
+                                     metadata:     metadata,
+                                     retry_policy: @config.rpcs.submit_uri.retry_policy
+
+              options.apply_defaults timeout:      @config.timeout,
+                                     metadata:     @config.metadata,
+                                     retry_policy: @config.retry_policy
+
+              @web_risk_service_stub.call_rpc :submit_uri, request, options: options do |response, operation|
+                response = ::Gapic::Operation.new response, @operations_client, options: options
+                yield response, operation if block_given?
+                return response
+              end
+            rescue ::GRPC::BadStatus => e
+              raise ::Google::Cloud::Error.from_error(e)
+            end
+
             ##
             # Configuration class for the WebRiskService API.
             #
@@ -555,9 +679,9 @@ module Google
             #    *  (`String`) The path to a service account key file in JSON format
             #    *  (`Hash`) A service account key as a Hash
             #    *  (`Google::Auth::Credentials`) A googleauth credentials object
-            #       (see the [googleauth docs](https://googleapis.dev/ruby/googleauth/latest/index.html))
+            #       (see the [googleauth docs](https://rubydoc.info/gems/googleauth/Google/Auth/Credentials))
             #    *  (`Signet::OAuth2::Client`) A signet oauth2 client object
-            #       (see the [signet docs](https://googleapis.dev/ruby/signet/latest/Signet/OAuth2/Client.html))
+            #       (see the [signet docs](https://rubydoc.info/gems/signet/Signet/OAuth2/Client))
             #    *  (`GRPC::Core::Channel`) a gRPC channel with included credentials
             #    *  (`GRPC::Core::ChannelCredentials`) a gRPC credentails object
             #    *  (`nil`) indicating no credentials
@@ -672,6 +796,11 @@ module Google
                 # @return [::Gapic::Config::Method]
                 #
                 attr_reader :create_submission
+                ##
+                # RPC-specific configuration for `submit_uri`
+                # @return [::Gapic::Config::Method]
+                #
+                attr_reader :submit_uri
 
                 # @private
                 def initialize parent_rpcs = nil
@@ -683,6 +812,8 @@ module Google
                   @search_hashes = ::Gapic::Config::Method.new search_hashes_config
                   create_submission_config = parent_rpcs.create_submission if parent_rpcs.respond_to? :create_submission
                   @create_submission = ::Gapic::Config::Method.new create_submission_config
+                  submit_uri_config = parent_rpcs.submit_uri if parent_rpcs.respond_to? :submit_uri
+                  @submit_uri = ::Gapic::Config::Method.new submit_uri_config
 
                   yield self if block_given?
                 end