Web Risk API defines an interface to detect malicious URLs on your website and in client applications.
Equality
Instances of this class created via copy-construction or copy-assignment always compare equal. Instances created with equal std::shared_ptr<*Connection> objects compare equal. Objects that compare equal share the same underlying resources.
Performance
Creating a new instance of this class is a relatively expensive operation, new objects establish new connections to the service. In contrast, copy-construction, move-construction, and the corresponding assignment operations are relatively efficient as the copies share all underlying resources.
Thread Safety
Concurrent access to different instances of this class, even if they compare equal, is guaranteed to work. Two or more threads operating on the same instance of this class is not guaranteed to work. Since copy-construction and move-construction is a relatively efficient operation, consider using such a copy when using this class from multiple threads.
Constructors
WebRiskServiceClient(WebRiskServiceClient const &)
Copy and move support
| Parameter | |
|---|---|
| Name | Description |
|
WebRiskServiceClient const &
|
WebRiskServiceClient(WebRiskServiceClient &&)
Copy and move support
| Parameter | |
|---|---|
| Name | Description |
|
WebRiskServiceClient &&
|
WebRiskServiceClient(std::shared_ptr< WebRiskServiceConnection >, Options)
| Parameters | |
|---|---|
| Name | Description |
connection |
std::shared_ptr< WebRiskServiceConnection >
|
opts |
Options
|
Operators
operator=(WebRiskServiceClient const &)
Copy and move support
| Parameter | |
|---|---|
| Name | Description |
|
WebRiskServiceClient const &
|
| Returns | |
|---|---|
| Type | Description |
WebRiskServiceClient & |
|
operator=(WebRiskServiceClient &&)
Copy and move support
| Parameter | |
|---|---|
| Name | Description |
|
WebRiskServiceClient &&
|
| Returns | |
|---|---|
| Type | Description |
WebRiskServiceClient & |
|
Functions
ComputeThreatListDiff(google::cloud::webrisk::v1::ThreatType, std::string const &, google::cloud::webrisk::v1::ComputeThreatListDiffRequest::Constraints const &, Options)
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.
| Parameters | |
|---|---|
| Name | Description |
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 |
std::string const &
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 const &
Required. The constraints associated with this request. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
StatusOr< google::cloud::webrisk::v1::ComputeThreatListDiffResponse > |
the result of the RPC. The response message type (google.cloud.webrisk.v1.ComputeThreatListDiffResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
ComputeThreatListDiff(google::cloud::webrisk::v1::ComputeThreatListDiffRequest const &, Options)
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.
| Parameters | |
|---|---|
| Name | Description |
request |
google::cloud::webrisk::v1::ComputeThreatListDiffRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
StatusOr< google::cloud::webrisk::v1::ComputeThreatListDiffResponse > |
the result of the RPC. The response message type (google.cloud.webrisk.v1.ComputeThreatListDiffResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
SearchUris(std::string const &, std::vector< google::cloud::webrisk::v1::ThreatType > const &, Options)
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.
| Parameters | |
|---|---|
| Name | Description |
uri |
std::string const &
Required. The URI to be checked for matches. |
threat_types |
std::vector< google::cloud::webrisk::v1::ThreatType > const &
Required. The ThreatLists to search in. Multiple ThreatLists may be specified. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
StatusOr< google::cloud::webrisk::v1::SearchUrisResponse > |
the result of the RPC. The response message type (google.cloud.webrisk.v1.SearchUrisResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
SearchUris(google::cloud::webrisk::v1::SearchUrisRequest const &, Options)
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.
| Parameters | |
|---|---|
| Name | Description |
request |
google::cloud::webrisk::v1::SearchUrisRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
StatusOr< google::cloud::webrisk::v1::SearchUrisResponse > |
the result of the RPC. The response message type (google.cloud.webrisk.v1.SearchUrisResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
SearchHashes(std::string const &, std::vector< google::cloud::webrisk::v1::ThreatType > const &, Options)
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.
| Parameters | |
|---|---|
| Name | Description |
hash_prefix |
std::string const &
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 |
std::vector< google::cloud::webrisk::v1::ThreatType > const &
Required. The ThreatLists to search in. Multiple ThreatLists may be specified. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
StatusOr< google::cloud::webrisk::v1::SearchHashesResponse > |
the result of the RPC. The response message type (google.cloud.webrisk.v1.SearchHashesResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
SearchHashes(google::cloud::webrisk::v1::SearchHashesRequest const &, Options)
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.
| Parameters | |
|---|---|
| Name | Description |
request |
google::cloud::webrisk::v1::SearchHashesRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
StatusOr< google::cloud::webrisk::v1::SearchHashesResponse > |
the result of the RPC. The response message type (google.cloud.webrisk.v1.SearchHashesResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
CreateSubmission(std::string const &, google::cloud::webrisk::v1::Submission const &, Options)
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.
| Parameters | |
|---|---|
| Name | Description |
parent |
std::string const &
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 const &
Required. The submission that contains the content of the phishing report. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
StatusOr< google::cloud::webrisk::v1::Submission > |
the result of the RPC. The response message type (google.cloud.webrisk.v1.Submission) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
CreateSubmission(google::cloud::webrisk::v1::CreateSubmissionRequest const &, Options)
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.
| Parameters | |
|---|---|
| Name | Description |
request |
google::cloud::webrisk::v1::CreateSubmissionRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
StatusOr< google::cloud::webrisk::v1::Submission > |
the result of the RPC. The response message type (google.cloud.webrisk.v1.Submission) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
SubmitUri(google::cloud::webrisk::v1::SubmitUriRequest const &, Options)
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.
| Parameters | |
|---|---|
| Name | Description |
request |
google::cloud::webrisk::v1::SubmitUriRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
future< StatusOr< google::cloud::webrisk::v1::Submission > > |
A |