Class: Google::Cloud::WebRisk::V1beta1::WebRiskService::Rest::Client
- Inherits:
-
Object
- Object
- Google::Cloud::WebRisk::V1beta1::WebRiskService::Rest::Client
- Defined in:
- lib/google/cloud/web_risk/v1beta1/web_risk_service/rest/client.rb
Overview
REST client for the WebRiskService service.
Web Risk v1beta1 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) {|result, operation| ... } ⇒ ::Google::Cloud::WebRisk::V1beta1::ComputeThreatListDiffResponse
Gets the most recent threat list diffs.
-
#configure {|config| ... } ⇒ Client::Configuration
Configure the WebRiskService Client instance.
-
#initialize {|config| ... } ⇒ Client
constructor
Create a new WebRiskService REST client object.
-
#search_hashes(request, options = nil) {|result, operation| ... } ⇒ ::Google::Cloud::WebRisk::V1beta1::SearchHashesResponse
Gets the full hashes that match the requested hash prefix.
-
#search_uris(request, options = nil) {|result, operation| ... } ⇒ ::Google::Cloud::WebRisk::V1beta1::SearchUrisResponse
This method is used to check whether a URI is on a given threatList.
-
#universe_domain ⇒ String
The effective universe domain.
Constructor Details
#initialize {|config| ... } ⇒ Client
Create a new WebRiskService REST client object.
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 |
# File 'lib/google/cloud/web_risk/v1beta1/web_risk_service/rest/client.rb', line 137 def initialize # 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.nil? || (@config.endpoint == Configuration::DEFAULT_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 = ::Google::Cloud::WebRisk::V1beta1::WebRiskService::Rest::ServiceStub.new( endpoint: @config.endpoint, endpoint_template: DEFAULT_ENDPOINT_TEMPLATE, universe_domain: @config.universe_domain, credentials: credentials ) end |
Class Method Details
.configure {|config| ... } ⇒ Client::Configuration
Configure the WebRiskService Client class.
See Configuration for a description of the configuration fields.
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/v1beta1/web_risk_service/rest/client.rb', line 60 def self.configure @configure ||= begin namespace = ["Google", "Cloud", "WebRisk", "V1beta1"] 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 end yield @configure if block_given? @configure end |
Instance Method Details
#compute_threat_list_diff(request, options = nil) ⇒ ::Google::Cloud::WebRisk::V1beta1::ComputeThreatListDiffResponse #compute_threat_list_diff(threat_type: nil, version_token: nil, constraints: nil) ⇒ ::Google::Cloud::WebRisk::V1beta1::ComputeThreatListDiffResponse
Gets the most recent threat list diffs.
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 243 244 245 246 247 248 249 250 251 |
# File 'lib/google/cloud/web_risk/v1beta1/web_risk_service/rest/client.rb', line 218 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::V1beta1::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::V1beta1::VERSION, transports_version_send: [:rest] [:"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 timeout: @config.timeout, metadata: @config., retry_policy: @config.retry_policy @web_risk_service_stub.compute_threat_list_diff request, do |result, operation| yield result, operation if block_given? return result end rescue ::Gapic::Rest::Error => 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/v1beta1/web_risk_service/rest/client.rb', line 107 def configure yield @config if block_given? @config end |
#search_hashes(request, options = nil) ⇒ ::Google::Cloud::WebRisk::V1beta1::SearchHashesResponse #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.
383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 |
# File 'lib/google/cloud/web_risk/v1beta1/web_risk_service/rest/client.rb', line 383 def search_hashes request, = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::WebRisk::V1beta1::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::V1beta1::VERSION, transports_version_send: [:rest] [:"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 timeout: @config.timeout, metadata: @config., retry_policy: @config.retry_policy @web_risk_service_stub.search_hashes request, do |result, operation| yield result, operation if block_given? return result end rescue ::Gapic::Rest::Error => e raise ::Google::Cloud::Error.from_error(e) end |
#search_uris(request, options = nil) ⇒ ::Google::Cloud::WebRisk::V1beta1::SearchUrisResponse #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.
298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 |
# File 'lib/google/cloud/web_risk/v1beta1/web_risk_service/rest/client.rb', line 298 def search_uris request, = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::WebRisk::V1beta1::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::V1beta1::VERSION, transports_version_send: [:rest] [:"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 timeout: @config.timeout, metadata: @config., retry_policy: @config.retry_policy @web_risk_service_stub.search_uris request, do |result, operation| yield result, operation if block_given? return result end rescue ::Gapic::Rest::Error => e raise ::Google::Cloud::Error.from_error(e) end |
#universe_domain ⇒ String
The effective universe domain
117 118 119 |
# File 'lib/google/cloud/web_risk/v1beta1/web_risk_service/rest/client.rb', line 117 def universe_domain @web_risk_service_stub.universe_domain end |