google-cloud-web_risk-v1 0.7.0 → 0.9.0

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

@@ -148,9 +148,22 @@ module Google
                 @quota_project_id = @config.quota_project
                 @quota_project_id ||= credentials.quota_project_id if credentials.respond_to? :quota_project_id
 
+                @operations_client = ::Google::Cloud::WebRisk::V1::WebRiskService::Rest::Operations.new do |config|
+                  config.credentials = credentials
+                  config.quota_project = @quota_project_id
+                  config.endpoint = @config.endpoint
+                end
+
                 @web_risk_service_stub = ::Google::Cloud::WebRisk::V1::WebRiskService::Rest::ServiceStub.new endpoint: @config.endpoint, credentials: credentials
               end
 
+              ##
+              # Get the associated client for long-running operations.
+              #
+              # @return [::Google::Cloud::WebRisk::V1::WebRiskService::Rest::Operations]
+              #
+              attr_reader :operations_client
+
               # Service calls
 
               ##
@@ -177,9 +190,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).
@@ -255,7 +268,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 [result, operation] Access the result along with the TransportOperation object
               # @yieldparam result [::Google::Cloud::WebRisk::V1::SearchUrisResponse]
               # @yieldparam operation [::Gapic::Rest::TransportOperation]
@@ -326,7 +340,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 [result, operation] Access the result along with the TransportOperation object
               # @yieldparam result [::Google::Cloud::WebRisk::V1::SearchHashesResponse]
               # @yieldparam operation [::Gapic::Rest::TransportOperation]
@@ -394,8 +409,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.
               # @yield [result, operation] Access the result along with the TransportOperation object
@@ -440,6 +455,85 @@ 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 [result, operation] Access the result along with the TransportOperation object
+              # @yieldparam result [::Gapic::Operation]
+              # @yieldparam operation [::Gapic::Rest::TransportOperation]
+              #
+              # @return [::Gapic::Operation]
+              #
+              # @raise [::Google::Cloud::Error] if the REST call is aborted.
+              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
+                call_metadata = @config.rpcs.submit_uri.metadata.to_h
+
+                # Set x-goog-api-client and x-goog-user-project headers
+                call_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,
+                  transports_version_send: [:rest]
+
+                call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
+
+                options.apply_defaults timeout:      @config.rpcs.submit_uri.timeout,
+                                       metadata:     call_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.submit_uri request, options do |result, operation|
+                  result = ::Gapic::Operation.new result, @operations_client, options: options
+                  yield result, operation if block_given?
+                  return result
+                end
+              rescue ::Gapic::Rest::Error => e
+                raise ::Google::Cloud::Error.from_error(e)
+              end
+
               ##
               # Configuration class for the WebRiskService REST API.
               #
@@ -478,9 +572,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))
               #    *  (`nil`) indicating no credentials
               #   @return [::Object]
               # @!attribute [rw] scope
@@ -583,6 +677,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
@@ -594,6 +693,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