module Google::Cloud::Webrisk::V1beta1
# Ruby Client for Web Risk API
[Web Risk API][Product Documentation]:
- Product Documentation][
## Quick Start In order to use this library, you first need to go through the following steps:
-
[Select or create a
Cloud
Platform project.](console.cloud.google.com/project) -
[Enable billing for your project.](cloud.google.com/billing/docs/how-to/modify-project#enable_billing_for_a_project)
-
[Enable the Web Risk API.](console.cloud.google.com/apis/library/webrisk.googleapis.com)
-
[Setup Authentication.](googleapis.dev/ruby/google-cloud-webrisk/latest/file.AUTHENTICATION.html)
### Installation “` $ gem install google-cloud-webrisk “`
### Next Steps
-
Read the [Web Risk API Product documentation][Product Documentation] to learn more about the product and see How-to Guides.
-
View this [repository's main README](github.com/googleapis/google-cloud-ruby/blob/master/README.md) to see the full list of
Cloud
APIs that we cover.
[Product Documentation]: cloud.google.com/web-risk
## Enabling Logging
To enable logging for this library, set the logger for the underlying [gRPC](github.com/grpc/grpc/tree/master/src/ruby) library. The logger that you set may be a Ruby stdlib [`Logger`](ruby-doc.org/stdlib-2.5.0/libdoc/logger/rdoc/Logger.html) as shown below, or a [`Google::Cloud::Logging::Logger`](googleapis.dev/ruby/google-cloud-logging/latest) that will write logs to [Stackdriver Logging](cloud.google.com/logging/). See [grpc/logconfig.rb](github.com/grpc/grpc/blob/master/src/ruby/lib/grpc/logconfig.rb) and the gRPC [spec_helper.rb](github.com/grpc/grpc/blob/master/src/ruby/spec/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 “`
Constants
- CompressionType
- ComputeThreatListDiffRequest
- ComputeThreatListDiffResponse
- RawHashes
- RawIndices
- RiceDeltaEncoding
- SearchHashesRequest
- SearchHashesResponse
- SearchUrisRequest
- SearchUrisResponse
- ThreatEntryAdditions
- ThreatEntryRemovals
- ThreatType
Public Class Methods
Web Risk v1beta1 API defines an interface to detect malicious URLs on your website and in client applications.
@param 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.
@param scopes [Array<String>]
The OAuth scopes for this service. This parameter is ignored if an updater_proc is supplied.
@param 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.
@param timeout [Numeric]
The default timeout, in seconds, for calls made through this client.
@param metadata [Hash]
Default metadata to be sent with each request. This can be overridden on a per call basis.
@param service_address [String]
Override for the service hostname, or `nil` to leave as the default.
@param service_port [Integer]
Override for the service port, or `nil` to leave as the default.
@param exception_transformer [Proc]
An optional proc that intercepts any exceptions raised during an API call to inject custom error handling.
# File lib/google/cloud/webrisk/v1beta1.rb, line 118 def self.new \ credentials: nil, scopes: nil, client_config: nil, timeout: nil, metadata: nil, service_address: nil, service_port: nil, exception_transformer: nil, lib_name: nil, lib_version: nil kwargs = { credentials: credentials, scopes: scopes, client_config: client_config, timeout: timeout, metadata: metadata, exception_transformer: exception_transformer, lib_name: lib_name, service_address: service_address, service_port: service_port, lib_version: lib_version }.select { |_, v| v != nil } Google::Cloud::Webrisk::V1beta1::WebRiskServiceV1Beta1Client.new(**kwargs) end