Web Risk V1 API - Class Google::Cloud::WebRisk::V1::WebRiskService::Rest::Client (v0.10.0)

Reference documentation and code samples for the Web Risk V1 API class Google::Cloud::WebRisk::V1::WebRiskService::Rest::Client.

REST client for the WebRiskService service.

Web Risk API defines an interface to detect malicious URLs on your website and in client applications.

Inherits

Object

Includes

Google::Cloud::WebRisk::V1::WebRiskService::Paths

Methods

.configure

def self.configure() { |config| ... } -> Client::Configuration

Configure the WebRiskService Client class.

See Configuration for a description of the configuration fields.

Yields

(config) — Configure the Client client.

Yield Parameter

config (Client::Configuration)

Returns

(Client::Configuration)

Example

# Modify the configuration for all WebRiskService clients
::Google::Cloud::WebRisk::V1::WebRiskService::Rest::Client.configure do |config|
  config.timeout = 10.0
end

#compute_threat_list_diff

def compute_threat_list_diff(request, options = nil) -> ::Google::Cloud::WebRisk::V1::ComputeThreatListDiffResponse
def compute_threat_list_diff(threat_type: nil, version_token: nil, constraints: nil) -> ::Google::Cloud::WebRisk::V1::ComputeThreatListDiffResponse

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.

Overloads

def compute_threat_list_diff(request, options = nil) -> ::Google::Cloud::WebRisk::V1::ComputeThreatListDiffResponse

Pass arguments to compute_threat_list_diff via a request object, either of type ComputeThreatListDiffRequest or an equivalent Hash.

Parameters

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.
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::V1::ComputeThreatListDiffResponse

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).

Parameters

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.
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.
constraints (::Google::Cloud::WebRisk::V1::ComputeThreatListDiffRequest::Constraints, ::Hash) — Required. The constraints associated with this request.

Yields

(result, operation) — Access the result along with the TransportOperation object

Yield Parameters

result (::Google::Cloud::WebRisk::V1::ComputeThreatListDiffResponse)
operation (::Gapic::Rest::TransportOperation)

Returns

(::Google::Cloud::WebRisk::V1::ComputeThreatListDiffResponse)

Raises

(::Google::Cloud::Error) — if the REST call 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::Rest::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

#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.

Yields

(config) — Configure the Client client.

Yield Parameter

config (Client::Configuration)

Returns

(Client::Configuration)

#create_submission

def create_submission(request, options = nil) -> ::Google::Cloud::WebRisk::V1::Submission
def create_submission(parent: nil, submission: nil) -> ::Google::Cloud::WebRisk::V1::Submission

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 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.

Overloads

def create_submission(request, options = nil) -> ::Google::Cloud::WebRisk::V1::Submission

Pass arguments to create_submission via a request object, either of type CreateSubmissionRequest or an equivalent Hash.

Parameters

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.
options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

def create_submission(parent: nil, submission: nil) -> ::Google::Cloud::WebRisk::V1::Submission

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).

Parameters

parent (::String) — Required. The name of the project that is making the submission. This string is in the format "projects/{project_number}".
submission (::Google::Cloud::WebRisk::V1::Submission, ::Hash) — Required. The submission that contains the content of the phishing report.

Yields

(result, operation) — Access the result along with the TransportOperation object

Yield Parameters

result (::Google::Cloud::WebRisk::V1::Submission)
operation (::Gapic::Rest::TransportOperation)

Returns

(::Google::Cloud::WebRisk::V1::Submission)

Raises

(::Google::Cloud::Error) — if the REST call 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::Rest::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

#initialize

def initialize() { |config| ... } -> Client

Create a new WebRiskService REST client object.

Yields

(config) — Configure the WebRiskService client.

Yield Parameter

config (Client::Configuration)

Returns

(Client) — a new instance of Client

Example

# Create a client using the default configuration
client = ::Google::Cloud::WebRisk::V1::WebRiskService::Rest::Client.new

# Create a client using a custom configuration
client = ::Google::Cloud::WebRisk::V1::WebRiskService::Rest::Client.new do |config|
  config.timeout = 10.0
end

#operations_client

def operations_client() -> ::Google::Cloud::WebRisk::V1::WebRiskService::Rest::Operations

Get the associated client for long-running operations.

Returns

(::Google::Cloud::WebRisk::V1::WebRiskService::Rest::Operations)

#search_hashes

def search_hashes(request, options = nil) -> ::Google::Cloud::WebRisk::V1::SearchHashesResponse
def search_hashes(hash_prefix: nil, threat_types: nil) -> ::Google::Cloud::WebRisk::V1::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.

Overloads

def search_hashes(request, options = nil) -> ::Google::Cloud::WebRisk::V1::SearchHashesResponse

Pass arguments to search_hashes via a request object, either of type SearchHashesRequest or an equivalent Hash.

Parameters

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.
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::V1::SearchHashesResponse

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).

Parameters

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. Note that if this parameter is provided by a URI, it must be encoded using the web safe base64 variant (RFC 4648).
threat_types (::Array<::Google::Cloud::WebRisk::V1::ThreatType>) — Required. The ThreatLists to search in. Multiple ThreatLists may be specified.

Yields

(result, operation) — Access the result along with the TransportOperation object

Yield Parameters

result (::Google::Cloud::WebRisk::V1::SearchHashesResponse)
operation (::Gapic::Rest::TransportOperation)

Returns

(::Google::Cloud::WebRisk::V1::SearchHashesResponse)

Raises

(::Google::Cloud::Error) — if the REST call 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::Rest::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

#search_uris

def search_uris(request, options = nil) -> ::Google::Cloud::WebRisk::V1::SearchUrisResponse
def search_uris(uri: nil, threat_types: nil) -> ::Google::Cloud::WebRisk::V1::SearchUrisResponse

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.

Overloads

def search_uris(request, options = nil) -> ::Google::Cloud::WebRisk::V1::SearchUrisResponse

Pass arguments to search_uris via a request object, either of type SearchUrisRequest or an equivalent Hash.

Parameters

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.
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::V1::SearchUrisResponse

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).

Parameters

uri (::String) — Required. The URI to be checked for matches.
threat_types (::Array<::Google::Cloud::WebRisk::V1::ThreatType>) — Required. The ThreatLists to search in. Multiple ThreatLists may be specified.

Yields

(result, operation) — Access the result along with the TransportOperation object

Yield Parameters

result (::Google::Cloud::WebRisk::V1::SearchUrisResponse)
operation (::Gapic::Rest::TransportOperation)

Returns

(::Google::Cloud::WebRisk::V1::SearchUrisResponse)

Raises

(::Google::Cloud::Error) — if the REST call 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::Rest::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

#submit_uri

def submit_uri(request, options = nil) -> ::Gapic::Operation
def submit_uri(parent: nil, submission: nil, threat_info: nil, threat_discovery: nil) -> ::Gapic::Operation

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 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 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.

Overloads

def submit_uri(request, options = nil) -> ::Gapic::Operation

Pass arguments to submit_uri via a request object, either of type SubmitUriRequest or an equivalent Hash.

Parameters

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.
options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

def submit_uri(parent: nil, submission: nil, threat_info: nil, threat_discovery: nil) -> ::Gapic::Operation

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).

Parameters

parent (::String) — Required. The name of the project that is making the submission. This string is in the format "projects/{project_number}".
submission (::Google::Cloud::WebRisk::V1::Submission, ::Hash) — Required. The submission that contains the URI to be scanned.
threat_info (::Google::Cloud::WebRisk::V1::ThreatInfo, ::Hash) — Provides additional information about the submission.
threat_discovery (::Google::Cloud::WebRisk::V1::ThreatDiscovery, ::Hash) — Provides additional information about how the submission was discovered.

Yields

(result, operation) — Access the result along with the TransportOperation object

Yield Parameters

result (::Gapic::Operation)
operation (::Gapic::Rest::TransportOperation)

Returns

(::Gapic::Operation)

Raises

(::Google::Cloud::Error) — if the REST call 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::Rest::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