Class: Google::Cloud::WebRisk::V1::WebRiskService::Client
- Inherits:
-
Object
- Object
- Google::Cloud::WebRisk::V1::WebRiskService::Client
- Includes:
- Paths
- Defined in:
- lib/google/cloud/web_risk/v1/web_risk_service/client.rb
Overview
Client for the WebRiskService service.
Web Risk API defines an interface to detect malicious URLs on your website and in client applications.
Defined Under Namespace
Classes: Configuration
Class Method Summary collapse
-
.configure {|config| ... } ⇒ Client::Configuration
Configure the WebRiskService Client class.
Instance Method Summary collapse
-
#compute_threat_list_diff(request, options = nil) {|response, operation| ... } ⇒ ::Google::Cloud::WebRisk::V1::ComputeThreatListDiffResponse
Gets the most recent threat list diffs.
-
#configure {|config| ... } ⇒ Client::Configuration
Configure the WebRiskService Client instance.
-
#create_submission(request, options = nil) {|response, operation| ... } ⇒ ::Google::Cloud::WebRisk::V1::Submission
Creates a Submission of a URI suspected of containing phishing content to be reviewed.
-
#initialize {|config| ... } ⇒ Client
constructor
Create a new WebRiskService client object.
-
#search_hashes(request, options = nil) {|response, operation| ... } ⇒ ::Google::Cloud::WebRisk::V1::SearchHashesResponse
Gets the full hashes that match the requested hash prefix.
-
#search_uris(request, options = nil) {|response, operation| ... } ⇒ ::Google::Cloud::WebRisk::V1::SearchUrisResponse
This method is used to check whether a URI is on a given threatList.
Methods included from Paths
Constructor Details
#initialize {|config| ... } ⇒ Client
Create a new WebRiskService client object.
Examples
To create a new WebRiskService client with the default configuration:
client = ::Google::Cloud::WebRisk::V1::WebRiskService::Client.new
To create a new WebRiskService client with a custom configuration:
client = ::Google::Cloud::WebRisk::V1::WebRiskService::Client.new do |config|
config.timeout = 10.0
end
132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 |
# File 'lib/google/cloud/web_risk/v1/web_risk_service/client.rb', line 132 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 scope and endpoint are unchanged from default, # but only if the default endpoint does not have a region prefix. enable_self_signed_jwt = @config.scope == Client.configure.scope && @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 |
Class Method Details
.configure {|config| ... } ⇒ Client::Configuration
Configure the WebRiskService Client class.
See Configuration for a description of the configuration fields.
Example
To modify the configuration for all WebRiskService clients:
::Google::Cloud::WebRisk::V1::WebRiskService::Client.configure do |config|
config.timeout = 10.0
end
58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 |
# File 'lib/google/cloud/web_risk/v1/web_risk_service/client.rb', line 58 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 |
Instance Method Details
#compute_threat_list_diff(request, options = nil) ⇒ ::Google::Cloud::WebRisk::V1::ComputeThreatListDiffResponse #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.
213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 |
# File 'lib/google/cloud/web_risk/v1/web_risk_service/client.rb', line 213 def compute_threat_list_diff request, = 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 = ::Gapic::CallOptions.new(**.to_h) if .respond_to? :to_h # Customize the options with defaults = @config.rpcs.compute_threat_list_diff..to_h # Set x-goog-api-client and x-goog-user-project headers [:"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 [:"x-goog-user-project"] = @quota_project_id if @quota_project_id .apply_defaults timeout: @config.rpcs.compute_threat_list_diff.timeout, metadata: , retry_policy: @config.rpcs.compute_threat_list_diff.retry_policy .apply_defaults metadata: @config., retry_policy: @config.retry_policy @web_risk_service_stub.call_rpc :compute_threat_list_diff, request, 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 {|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 configure.
See Configuration for a description of the configuration fields.
107 108 109 110 |
# File 'lib/google/cloud/web_risk/v1/web_risk_service/client.rb', line 107 def configure yield @config if block_given? @config end |
#create_submission(request, options = nil) ⇒ ::Google::Cloud::WebRisk::V1::Submission #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 projects with CREATE_SUBMISSION_USERS visibility can use this method.
414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 |
# File 'lib/google/cloud/web_risk/v1/web_risk_service/client.rb', line 414 def create_submission request, = 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 = ::Gapic::CallOptions.new(**.to_h) if .respond_to? :to_h # Customize the options with defaults = @config.rpcs.create_submission..to_h # Set x-goog-api-client and x-goog-user-project headers [:"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 [:"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("&") [:"x-goog-request-params"] ||= request_params_header .apply_defaults timeout: @config.rpcs.create_submission.timeout, metadata: , retry_policy: @config.rpcs.create_submission.retry_policy .apply_defaults metadata: @config., retry_policy: @config.retry_policy @web_risk_service_stub.call_rpc :create_submission, request, 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 |
#search_hashes(request, options = nil) ⇒ ::Google::Cloud::WebRisk::V1::SearchHashesResponse #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.
346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 |
# File 'lib/google/cloud/web_risk/v1/web_risk_service/client.rb', line 346 def search_hashes request, = 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 = ::Gapic::CallOptions.new(**.to_h) if .respond_to? :to_h # Customize the options with defaults = @config.rpcs.search_hashes..to_h # Set x-goog-api-client and x-goog-user-project headers [:"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 [:"x-goog-user-project"] = @quota_project_id if @quota_project_id .apply_defaults timeout: @config.rpcs.search_hashes.timeout, metadata: , retry_policy: @config.rpcs.search_hashes.retry_policy .apply_defaults metadata: @config., retry_policy: @config.retry_policy @web_risk_service_stub.call_rpc :search_hashes, request, 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 |
#search_uris(request, options = nil) ⇒ ::Google::Cloud::WebRisk::V1::SearchUrisResponse #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.
279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 |
# File 'lib/google/cloud/web_risk/v1/web_risk_service/client.rb', line 279 def search_uris request, = 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 = ::Gapic::CallOptions.new(**.to_h) if .respond_to? :to_h # Customize the options with defaults = @config.rpcs.search_uris..to_h # Set x-goog-api-client and x-goog-user-project headers [:"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 [:"x-goog-user-project"] = @quota_project_id if @quota_project_id .apply_defaults timeout: @config.rpcs.search_uris.timeout, metadata: , retry_policy: @config.rpcs.search_uris.retry_policy .apply_defaults metadata: @config., retry_policy: @config.retry_policy @web_risk_service_stub.call_rpc :search_uris, request, 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 |