Reference documentation and code samples for the Web Risk V1beta1 API class Google::Cloud::WebRisk::V1beta1::WebRiskService::Client.
Client for the WebRiskService service.
Web Risk v1beta1 API defines an interface to detect malicious URLs on your website and in client applications.
Inherits
- Object
Methods
.configure
def self.configure() { |config| ... } -> Client::Configuration
Configure the WebRiskService Client class.
See Configuration for a description of the configuration fields.
- (config) — Configure the Client client.
- config (Client::Configuration)
# Modify the configuration for all WebRiskService clients ::Google::Cloud::WebRisk::V1beta1::WebRiskService::Client.configure do |config| config.timeout = 10.0 end
#compute_threat_list_diff
def compute_threat_list_diff(request, options = nil) -> ::Google::Cloud::WebRisk::V1beta1::ComputeThreatListDiffResponse
def compute_threat_list_diff(threat_type: nil, version_token: nil, constraints: nil) -> ::Google::Cloud::WebRisk::V1beta1::ComputeThreatListDiffResponse
Gets the most recent threat list diffs.
def compute_threat_list_diff(request, options = nil) -> ::Google::Cloud::WebRisk::V1beta1::ComputeThreatListDiffResponse
compute_threat_list_diff
via a request object, either of type
ComputeThreatListDiffRequest or an equivalent Hash.
- request (::Google::Cloud::WebRisk::V1beta1::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.
- options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
def compute_threat_list_diff(threat_type: nil, version_token: nil, constraints: nil) -> ::Google::Cloud::WebRisk::V1beta1::ComputeThreatListDiffResponse
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).
- threat_type (::Google::Cloud::WebRisk::V1beta1::ThreatType) — The ThreatList to update.
- 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).
- constraints (::Google::Cloud::WebRisk::V1beta1::ComputeThreatListDiffRequest::Constraints, ::Hash) — Required. The constraints associated with this request.
- (response, operation) — Access the result along with the RPC operation
- response (::Google::Cloud::WebRisk::V1beta1::ComputeThreatListDiffResponse)
- operation (::GRPC::ActiveCall::Operation)
- (::Google::Cloud::Error) — if the RPC is aborted.
Basic example
require "google/cloud/web_risk/v1beta1" # Create a client object. The client can be reused for multiple calls. client = Google::Cloud::WebRisk::V1beta1::WebRiskService::Client.new # Create a request. To set request fields, pass in keyword arguments. request = Google::Cloud::WebRisk::V1beta1::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::V1beta1::ComputeThreatListDiffResponse. p result
#configure
def configure() { |config| ... } -> Client::Configuration
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 Configuration for a description of the configuration fields.
- (config) — Configure the Client client.
- config (Client::Configuration)
#initialize
def initialize() { |config| ... } -> Client
Create a new WebRiskService client object.
- (config) — Configure the WebRiskService client.
- config (Client::Configuration)
- (Client) — a new instance of Client
# Create a client using the default configuration client = ::Google::Cloud::WebRisk::V1beta1::WebRiskService::Client.new # Create a client using a custom configuration client = ::Google::Cloud::WebRisk::V1beta1::WebRiskService::Client.new do |config| config.timeout = 10.0 end
#logger
def logger() -> Logger
The logger used for request/response debug logging.
- (Logger)
#search_hashes
def search_hashes(request, options = nil) -> ::Google::Cloud::WebRisk::V1beta1::SearchHashesResponse
def search_hashes(hash_prefix: nil, threat_types: nil) -> ::Google::Cloud::WebRisk::V1beta1::SearchHashesResponse
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.
def search_hashes(request, options = nil) -> ::Google::Cloud::WebRisk::V1beta1::SearchHashesResponse
search_hashes
via a request object, either of type
SearchHashesRequest or an equivalent Hash.
- request (::Google::Cloud::WebRisk::V1beta1::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.
- options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
def search_hashes(hash_prefix: nil, threat_types: nil) -> ::Google::Cloud::WebRisk::V1beta1::SearchHashesResponse
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).
- 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.
- threat_types (::Array<::Google::Cloud::WebRisk::V1beta1::ThreatType>) — Required. The ThreatLists to search in.
- (response, operation) — Access the result along with the RPC operation
- response (::Google::Cloud::WebRisk::V1beta1::SearchHashesResponse)
- operation (::GRPC::ActiveCall::Operation)
- (::Google::Cloud::Error) — if the RPC is aborted.
Basic example
require "google/cloud/web_risk/v1beta1" # Create a client object. The client can be reused for multiple calls. client = Google::Cloud::WebRisk::V1beta1::WebRiskService::Client.new # Create a request. To set request fields, pass in keyword arguments. request = Google::Cloud::WebRisk::V1beta1::SearchHashesRequest.new # Call the search_hashes method. result = client.search_hashes request # The returned object is of type Google::Cloud::WebRisk::V1beta1::SearchHashesResponse. p result
#search_uris
def search_uris(request, options = nil) -> ::Google::Cloud::WebRisk::V1beta1::SearchUrisResponse
def search_uris(uri: nil, threat_types: nil) -> ::Google::Cloud::WebRisk::V1beta1::SearchUrisResponse
This method is used to check whether a URI is on a given threatList.
def search_uris(request, options = nil) -> ::Google::Cloud::WebRisk::V1beta1::SearchUrisResponse
search_uris
via a request object, either of type
SearchUrisRequest or an equivalent Hash.
- request (::Google::Cloud::WebRisk::V1beta1::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.
- options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
def search_uris(uri: nil, threat_types: nil) -> ::Google::Cloud::WebRisk::V1beta1::SearchUrisResponse
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).
- uri (::String) — Required. The URI to be checked for matches.
- threat_types (::Array<::Google::Cloud::WebRisk::V1beta1::ThreatType>) — Required. The ThreatLists to search in.
- (response, operation) — Access the result along with the RPC operation
- response (::Google::Cloud::WebRisk::V1beta1::SearchUrisResponse)
- operation (::GRPC::ActiveCall::Operation)
- (::Google::Cloud::Error) — if the RPC is aborted.
Basic example
require "google/cloud/web_risk/v1beta1" # Create a client object. The client can be reused for multiple calls. client = Google::Cloud::WebRisk::V1beta1::WebRiskService::Client.new # Create a request. To set request fields, pass in keyword arguments. request = Google::Cloud::WebRisk::V1beta1::SearchUrisRequest.new # Call the search_uris method. result = client.search_uris request # The returned object is of type Google::Cloud::WebRisk::V1beta1::SearchUrisResponse. p result
#universe_domain
def universe_domain() -> String
The effective universe domain
- (String)