Class: Google::Cloud::Webrisk::V1beta1::WebRiskServiceV1Beta1Client

Inherits:
Object
  • Object
show all
Defined in:
lib/google/cloud/webrisk/v1beta1/web_risk_service_v1_beta1_client.rb

Overview

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

Constant Summary collapse

SERVICE_ADDRESS =

The default address of the service.

"webrisk.googleapis.com".freeze
DEFAULT_SERVICE_PORT =

The default port of the service.

443
GRPC_INTERCEPTORS =

The default set of gRPC interceptors.

[]
DEFAULT_TIMEOUT = 
30
ALL_SCOPES =

The scopes needed to make gRPC calls to all of the methods defined in this service.

[
  "https://www.googleapis.com/auth/cloud-platform"
].freeze

Instance Method Summary collapse

Constructor Details

#initialize(credentials: nil, scopes: ALL_SCOPES, client_config: {}, timeout: DEFAULT_TIMEOUT, metadata: nil, service_address: nil, service_port: nil, exception_transformer: nil, lib_name: nil, lib_version: "") ⇒ WebRiskServiceV1Beta1Client

Returns a new instance of WebRiskServiceV1Beta1Client.

Parameters:

  • credentials (Google::Auth::Credentials, String, Hash, GRPC::Core::Channel, GRPC::Core::ChannelCredentials, Proc) (defaults to: nil) —

    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>) (defaults to: ALL_SCOPES) —

    The OAuth scopes for this service. This parameter is ignored if an updater_proc is supplied.

  • client_config (Hash) (defaults to: {}) —

    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) (defaults to: DEFAULT_TIMEOUT) —

    The default timeout, in seconds, for calls made through this client.

  • metadata (Hash) (defaults to: nil) —

    Default metadata to be sent with each request. This can be overridden on a per call basis.

  • service_address (String) (defaults to: nil) —

    Override for the service hostname, or nil to leave as the default.

  • service_port (Integer) (defaults to: nil) —

    Override for the service port, or nil to leave as the default.

  • exception_transformer (Proc) (defaults to: nil) —

    An optional proc that intercepts any exceptions raised during an API call to inject custom error handling.



96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
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
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
 
# File 'lib/google/cloud/webrisk/v1beta1/web_risk_service_v1_beta1_client.rb', line 96

def initialize \
    credentials: nil,
    scopes: ALL_SCOPES,
    client_config: {},
    timeout: DEFAULT_TIMEOUT,
    metadata: nil,
    service_address: nil,
    service_port: nil,
    exception_transformer: nil,
    lib_name: nil,
    lib_version: ""
  # 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 "google/gax/grpc"
  require "google/cloud/webrisk/v1beta1/webrisk_services_pb"

  credentials ||= Google::Cloud::Webrisk::V1beta1::Credentials.default

  if credentials.is_a?(String) || credentials.is_a?(Hash)
    updater_proc = Google::Cloud::Webrisk::V1beta1::Credentials.new(credentials).updater_proc
  end
  if credentials.is_a?(GRPC::Core::Channel)
    channel = credentials
  end
  if credentials.is_a?(GRPC::Core::ChannelCredentials)
    chan_creds = credentials
  end
  if credentials.is_a?(Proc)
    updater_proc = credentials
  end
  if credentials.is_a?(Google::Auth::Credentials)
    updater_proc = credentials.updater_proc
  end

  package_version = Google::Cloud::Webrisk::VERSION

  google_api_client = "gl-ruby/#{RUBY_VERSION}"
  google_api_client << " #{lib_name}/#{lib_version}" if lib_name
  google_api_client << " gapic/#{package_version} gax/#{Google::Gax::VERSION}"
  google_api_client << " grpc/#{GRPC::VERSION}"
  google_api_client.freeze

  headers = { :"x-goog-api-client" => google_api_client }
  if credentials.respond_to?(:quota_project_id) && credentials.quota_project_id
    headers[:"x-goog-user-project"] = credentials.quota_project_id
  end
  headers.merge!(metadata) unless metadata.nil?
  client_config_file = Pathname.new(__dir__).join(
    "web_risk_service_v1_beta1_client_config.json"
  )
  defaults = client_config_file.open do |f|
    Google::Gax.construct_settings(
      "google.cloud.webrisk.v1beta1.WebRiskServiceV1Beta1",
      JSON.parse(f.read),
      client_config,
      Google::Gax::Grpc::STATUS_CODE_NAMES,
      timeout,
      errors: Google::Gax::Grpc::API_ERRORS,
      metadata: headers
    )
  end

  # Allow overriding the service path/port in subclasses.
  service_path = service_address || self.class::SERVICE_ADDRESS
  port = service_port || self.class::DEFAULT_SERVICE_PORT
  interceptors = self.class::GRPC_INTERCEPTORS
  @web_risk_service_v1_beta1_stub = Google::Gax::Grpc.create_stub(
    service_path,
    port,
    chan_creds: chan_creds,
    channel: channel,
    updater_proc: updater_proc,
    scopes: scopes,
    interceptors: interceptors,
    &Google::Cloud::Webrisk::V1beta1::WebRiskServiceV1Beta1::Stub.method(:new)
  )

  @compute_threat_list_diff = Google::Gax.create_api_call(
    @web_risk_service_v1_beta1_stub.method(:compute_threat_list_diff),
    defaults["compute_threat_list_diff"],
    exception_transformer: exception_transformer
  )
  @search_uris = Google::Gax.create_api_call(
    @web_risk_service_v1_beta1_stub.method(:search_uris),
    defaults["search_uris"],
    exception_transformer: exception_transformer
  )
  @search_hashes = Google::Gax.create_api_call(
    @web_risk_service_v1_beta1_stub.method(:search_hashes),
    defaults["search_hashes"],
    exception_transformer: exception_transformer
  )
end

Instance Method Details

#compute_threat_list_diff(threat_type, constraints, version_token: nil, options: nil) {|result, operation| ... } ⇒ Google::Cloud::Webrisk::V1beta1::ComputeThreatListDiffResponse

Gets the most recent threat list diffs.

Examples:

require "google/cloud/webrisk"

web_risk_service_v1_beta1_client = Google::Cloud::Webrisk.new(version: :v1beta1)

# TODO: Initialize `threat_type`:
threat_type = :THREAT_TYPE_UNSPECIFIED

# TODO: Initialize `constraints`:
constraints = {}
response = web_risk_service_v1_beta1_client.compute_threat_list_diff(threat_type, constraints)

Parameters:

  • threat_type (Google::Cloud::Webrisk::V1beta1::ThreatType) —

    The ThreatList to update.

  • constraints (Google::Cloud::Webrisk::V1beta1::ComputeThreatListDiffRequest::Constraints | Hash) —

    Required. The constraints associated with this request. A hash of the same form as Google::Cloud::Webrisk::V1beta1::ComputeThreatListDiffRequest::Constraints can also be provided.

  • version_token (String) (defaults to: nil) —

    The current version token of the client for the requested list (the client version that was received from the last successful diff).

  • options (Google::Gax::CallOptions) (defaults to: nil) —

    Overrides the default settings for this call, e.g, timeout, retries, etc.

Yields:

  • (result, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (Google::Gax::GaxError) —

    if the RPC is aborted.



224
225
226
227
228
229
230
231
232
233
234
235
236
237
 
# File 'lib/google/cloud/webrisk/v1beta1/web_risk_service_v1_beta1_client.rb', line 224

def compute_threat_list_diff \
    threat_type,
    constraints,
    version_token: nil,
    options: nil,
    &block
  req = {
    threat_type: threat_type,
    constraints: constraints,
    version_token: version_token
  }.delete_if { |_, v| v.nil? }
  req = Google::Gax::to_proto(req, Google::Cloud::Webrisk::V1beta1::ComputeThreatListDiffRequest)
  @compute_threat_list_diff.call(req, options, &block)
end

#search_hashes(threat_types, hash_prefix: nil, options: nil) {|result, operation| ... } ⇒ 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.

Examples:

require "google/cloud/webrisk"

web_risk_service_v1_beta1_client = Google::Cloud::Webrisk.new(version: :v1beta1)

# TODO: Initialize `threat_types`:
threat_types = []
response = web_risk_service_v1_beta1_client.search_hashes(threat_types)

Parameters:

  • threat_types (Array<Google::Cloud::Webrisk::V1beta1::ThreatType>) —

    Required. The ThreatLists to search in.

  • hash_prefix (String) (defaults to: nil) —

    A hash prefix, consisting of the most significant 4-32 bytes of a SHA256 hash. For JSON requests, this field is base64-encoded.

  • options (Google::Gax::CallOptions) (defaults to: nil) —

    Overrides the default settings for this call, e.g, timeout, retries, etc.

Yields:

  • (result, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (Google::Gax::GaxError) —

    if the RPC is aborted.



306
307
308
309
310
311
312
313
314
315
316
317
 
# File 'lib/google/cloud/webrisk/v1beta1/web_risk_service_v1_beta1_client.rb', line 306

def search_hashes \
    threat_types,
    hash_prefix: nil,
    options: nil,
    &block
  req = {
    threat_types: threat_types,
    hash_prefix: hash_prefix
  }.delete_if { |_, v| v.nil? }
  req = Google::Gax::to_proto(req, Google::Cloud::Webrisk::V1beta1::SearchHashesRequest)
  @search_hashes.call(req, options, &block)
end

#search_uris(uri, threat_types, options: nil) {|result, operation| ... } ⇒ Google::Cloud::Webrisk::V1beta1::SearchUrisResponse

This method is used to check whether a URI is on a given threatList.

Examples:

require "google/cloud/webrisk"

web_risk_service_v1_beta1_client = Google::Cloud::Webrisk.new(version: :v1beta1)

# TODO: Initialize `uri`:
uri = ''

# TODO: Initialize `threat_types`:
threat_types = []
response = web_risk_service_v1_beta1_client.search_uris(uri, threat_types)

Parameters:

  • uri (String) —

    Required. The URI to be checked for matches.

  • threat_types (Array<Google::Cloud::Webrisk::V1beta1::ThreatType>) —

    Required. The ThreatLists to search in.

  • options (Google::Gax::CallOptions) (defaults to: nil) —

    Overrides the default settings for this call, e.g, timeout, retries, etc.

Yields:

  • (result, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (Google::Gax::GaxError) —

    if the RPC is aborted.



265
266
267
268
269
270
271
272
273
274
275
276
 
# File 'lib/google/cloud/webrisk/v1beta1/web_risk_service_v1_beta1_client.rb', line 265

def search_uris \
    uri,
    threat_types,
    options: nil,
    &block
  req = {
    uri: uri,
    threat_types: threat_types
  }.delete_if { |_, v| v.nil? }
  req = Google::Gax::to_proto(req, Google::Cloud::Webrisk::V1beta1::SearchUrisRequest)
  @search_uris.call(req, options, &block)
end