class Google::Cloud::WebRisk::V1::WebRiskService::Client
Client
for the WebRiskService
service.
Web Risk API defines an interface to detect malicious URLs on your website and in client applications.
Attributes
@private
Public Class Methods
Configure the WebRiskService
Client
class.
See {::Google::Cloud::WebRisk::V1::WebRiskService::Client::Configuration} for a description of the configuration fields.
@example
# 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]
@return [Client::Configuration]
# File lib/google/cloud/web_risk/v1/web_risk_service/client.rb, line 57 def self.configure @configure ||= begin namespace = ["Google", "Cloud", "WebRisk", "V1"] parent_config = while namespace.any? parent_name = namespace.join "::" parent_const = const_get parent_name break parent_const.configure if parent_const.respond_to? :configure namespace.pop end default_config = Client::Configuration.new parent_config 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] } 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] } 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] } default_config.rpcs.create_submission.timeout = 60.0 default_config end yield @configure if block_given? @configure end
Create a new WebRiskService
client object.
@example
# Create a client using the default configuration client = ::Google::Cloud::WebRisk::V1::WebRiskService::Client.new # 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]
# File lib/google/cloud/web_risk/v1/web_risk_service/client.rb, line 127 def initialize # These require statements are intentionally placed here to initialize # the gRPC module only when it's required. # See https://github.com/googleapis/toolkit/issues/446 require "gapic/grpc" require "google/cloud/webrisk/v1/webrisk_services_pb" # Create the configuration object @config = Configuration.new Client.configure # Yield the configuration if needed yield @config if block_given? # Create credentials credentials = @config.credentials # 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.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) credentials = Credentials.new credentials, scope: @config.scope end @quota_project_id = @config.quota_project @quota_project_id ||= credentials.quota_project_id if credentials.respond_to? :quota_project_id @web_risk_service_stub = ::Gapic::ServiceStub.new( ::Google::Cloud::WebRisk::V1::WebRiskService::Stub, credentials: credentials, endpoint: @config.endpoint, channel_args: @config.channel_args, interceptors: @config.interceptors ) end
Public Instance Methods
Gets the most recent threat list diffs. These diffs should be applied to a local database of hashes to keep it up-to-date. If the local database is empty or excessively out-of-date, a complete snapshot of the database will be returned. This Method only updates a single ThreatList at a time. To update multiple ThreatList databases, this method needs to be called once for each list.
@overload compute_threat_list_diff
(request, options = nil)
Pass arguments to `compute_threat_list_diff` via a request object, either of type {::Google::Cloud::WebRisk::V1::ComputeThreatListDiffRequest} or an equivalent Hash. @param request [::Google::Cloud::WebRisk::V1::ComputeThreatListDiffRequest, ::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 compute_threat_list_diff
(threat_type: nil, version_token: nil, constraints: nil)
Pass arguments to `compute_threat_list_diff` 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 threat_type [::Google::Cloud::WebRisk::V1::ThreatType] Required. The threat list to update. Only a single ThreatType should be specified. @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). If the client does not have a version token (this is the first time calling ComputeThreatListDiff), this may be left empty and a full database snapshot will be returned. @param constraints [::Google::Cloud::WebRisk::V1::ComputeThreatListDiffRequest::Constraints, ::Hash] Required. The constraints associated with this request.
@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Google::Cloud::WebRisk::V1::ComputeThreatListDiffResponse] @yieldparam operation [::GRPC::ActiveCall::Operation]
@return [::Google::Cloud::WebRisk::V1::ComputeThreatListDiffResponse]
@raise [::Google::Cloud::Error] if the RPC is aborted.
# File lib/google/cloud/web_risk/v1/web_risk_service/client.rb, line 207 def compute_threat_list_diff request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::WebRisk::V1::ComputeThreatListDiffRequest # 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.compute_threat_list_diff.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 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 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| yield response, operation if block_given? return response end rescue ::GRPC::BadStatus => e raise ::Google::Cloud::Error.from_error(e) end
Configure the WebRiskService
Client
instance.
The configuration is set to the derived mode, meaning that values can be changed, but structural changes (adding new fields, etc.) are not allowed. Structural changes should be made on {Client.configure}.
See {::Google::Cloud::WebRisk::V1::WebRiskService::Client::Configuration} for a description of the configuration fields.
@yield [config] Configure the Client
client. @yieldparam config [Client::Configuration]
@return [Client::Configuration]
# File lib/google/cloud/web_risk/v1/web_risk_service/client.rb, line 106 def configure yield @config if block_given? @config end
Creates a Submission of a URI suspected of containing phishing content to be reviewed. If the result verifies the existence of malicious phishing content, the site will be added to the [Google's Social Engineering lists](support.google.com/webmasters/answer/6350487/) in order to protect users that could get exposed to this threat in the future. Only projects with CREATE_SUBMISSION_USERS visibility can use this method.
@overload create_submission
(request, options = nil)
Pass arguments to `create_submission` via a request object, either of type {::Google::Cloud::WebRisk::V1::CreateSubmissionRequest} or an equivalent Hash. @param request [::Google::Cloud::WebRisk::V1::CreateSubmissionRequest, ::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 create_submission
(parent: nil, submission: nil)
Pass arguments to `create_submission` 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 content of the phishing report.
@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Google::Cloud::WebRisk::V1::Submission] @yieldparam operation [::GRPC::ActiveCall::Operation]
@return [::Google::Cloud::WebRisk::V1::Submission]
@raise [::Google::Cloud::Error] if the RPC is aborted.
# File lib/google/cloud/web_risk/v1/web_risk_service/client.rb, line 414 def create_submission request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::WebRisk::V1::CreateSubmissionRequest # 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.create_submission.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 = { "parent" => request.parent } 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 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| yield response, operation if block_given? return response end rescue ::GRPC::BadStatus => e raise ::Google::Cloud::Error.from_error(e) end
Gets the full hashes that match the requested hash prefix. This is used after a hash prefix is looked up in a threatList and there is a match. The client side threatList only holds partial hashes so the client must query this method to determine if there is a full hash match of a threat.
@overload search_hashes
(request, options = nil)
Pass arguments to `search_hashes` via a request object, either of type {::Google::Cloud::WebRisk::V1::SearchHashesRequest} or an equivalent Hash. @param request [::Google::Cloud::WebRisk::V1::SearchHashesRequest, ::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 search_hashes
(hash_prefix: nil, threat_types: nil)
Pass arguments to `search_hashes` 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 hash_prefix [::String] A hash prefix, consisting of the most significant 4-32 bytes of a SHA256 hash. For JSON requests, this field is base64-encoded. @param threat_types [::Array<::Google::Cloud::WebRisk::V1::ThreatType>] 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] @yieldparam operation [::GRPC::ActiveCall::Operation]
@return [::Google::Cloud::WebRisk::V1::SearchHashesResponse]
@raise [::Google::Cloud::Error] if the RPC is aborted.
# File lib/google/cloud/web_risk/v1/web_risk_service/client.rb, line 344 def search_hashes request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::WebRisk::V1::SearchHashesRequest # 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.search_hashes.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 options.apply_defaults timeout: @config.rpcs.search_hashes.timeout, metadata: metadata, retry_policy: @config.rpcs.search_hashes.retry_policy 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| yield response, operation if block_given? return response end rescue ::GRPC::BadStatus => e raise ::Google::Cloud::Error.from_error(e) end
This method is used to check whether a URI is on a given threatList. Multiple threatLists may be searched in a single query. The response will list all requested threatLists the URI was found to match. If the URI is not found on any of the requested ThreatList an empty response will be returned.
@overload search_uris
(request, options = nil)
Pass arguments to `search_uris` via a request object, either of type {::Google::Cloud::WebRisk::V1::SearchUrisRequest} or an equivalent Hash. @param request [::Google::Cloud::WebRisk::V1::SearchUrisRequest, ::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 search_uris
(uri: nil, threat_types: nil)
Pass arguments to `search_uris` 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 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.
@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Google::Cloud::WebRisk::V1::SearchUrisResponse] @yieldparam operation [::GRPC::ActiveCall::Operation]
@return [::Google::Cloud::WebRisk::V1::SearchUrisResponse]
@raise [::Google::Cloud::Error] if the RPC is aborted.
# File lib/google/cloud/web_risk/v1/web_risk_service/client.rb, line 275 def search_uris request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::WebRisk::V1::SearchUrisRequest # 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.search_uris.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 options.apply_defaults timeout: @config.rpcs.search_uris.timeout, metadata: metadata, retry_policy: @config.rpcs.search_uris.retry_policy 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| yield response, operation if block_given? return response end rescue ::GRPC::BadStatus => e raise ::Google::Cloud::Error.from_error(e) end