google-cloud-webrisk - Module Google::Cloud::Webrisk (v0.6.1)

Reference documentation and code samples for the google-cloud-webrisk module Google::Cloud::Webrisk.

Ruby Client for Web Risk API

This library is deprecated, and will no longer receive updates. Please use the google-cloud-web_risk library instead. For detailed information on the differences, see the migration guide.

Web Risk API:

Quick Start

In order to use this library, you first need to go through the following steps:

  1. Select or create a Cloud Platform project.
  2. Enable billing for your project.
  3. Enable the Web Risk API.
  4. Setup Authentication.

Installation

$ gem install google-cloud-webrisk

Next Steps

Enabling Logging

To enable logging for this library, set the logger for the underlying gRPC library. The logger that you set may be a Ruby stdlib Logger as shown below, or a Google::Cloud::Logging::Logger that will write logs to Stackdriver Logging. See grpc/logconfig.rb and the gRPC spec_helper.rb for additional information.

Configuring a Ruby stdlib logger:

```ruby require "logger"

module MyLogger LOGGER = Logger.new $stderr, level: Logger::WARN def logger LOGGER end end

Define a gRPC module-level logger method before grpc/logconfig.rb loads.

module GRPC extend MyLogger end ```

Methods

.new

def self.new(version:, credentials:, scopes:, client_config:, timeout:)

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

Overloads 
def self.new(version:, credentials:, scopes:, client_config:, timeout:)
Web Risk v1beta1 API defines an interface to detect malicious URLs on your website and in client applications.
Parameters
  • credentials (Google::Auth::Credentials, String, Hash, GRPC::Core::Channel, GRPC::Core::ChannelCredentials, Proc) — Provides the means for authenticating requests made by the client. This parameter can be many types. A Google::Auth::Credentials uses a the properties of its represented keyfile for authenticating requests made by this client. A String will be treated as the path to the keyfile to be used for the construction of credentials for this client. A Hash will be treated as the contents of a keyfile to be used for the construction of credentials for this client. A GRPC::Core::Channel will be used to make calls through. A GRPC::Core::ChannelCredentials for the setting up the RPC client. The channel credentials should already be composed with a GRPC::Core::CallCredentials object. A Proc will be used as an updater_proc for the Grpc channel. The proc transforms the metadata for requests, generally, to give OAuth credentials.
  • scopes (Array<String>) — The OAuth scopes for this service. This parameter is ignored if an updater_proc is supplied.
  • client_config (Hash) — A Hash for call options for each method. See Google::Gax#construct_settings for the structure of this data. Falls back to the default config if not specified or the specified config is missing data points.
  • timeout (Numeric) — The default timeout, in seconds, for calls made through this client.
  • metadata (Hash) — Default metadata to be sent with each request. This can be overridden on a per call basis.
  • service_address (String) — Override for the service hostname, or nil to leave as the default.
  • service_port (Integer) — Override for the service port, or nil to leave as the default.
  • exception_transformer (Proc) — An optional proc that intercepts any exceptions raised during an API call to inject custom error handling.

Constants

FILE_DIR

value: File.realdirpath(Pathname.new(FILE).join("..").join("webrisk"))
rubocop:enable LineLength

AVAILABLE_VERSIONS

value: Dir["#FILE_DIR/*"] .select { |file| File.directory?(file) } .select { |dir| Google::Gax::VERSION_MATCHER.match(File.basename(dir)) } .select { |dir| File.exist?(dir + ".rb") } .map { |dir| File.basename(dir) }

VERSION

value: "0.6.1".freeze