Class: Google::Cloud::WebRisk::V1beta1::WebRiskService::Client

Inherits:
Object
  • Object
show all
Defined in:
lib/google/cloud/web_risk/v1beta1/web_risk_service/client.rb

Overview

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

Instance Method Summary collapse

Constructor Details

#initialize {|config| ... } ⇒ Client

Create a new WebRiskService client object.

Examples:


# Create a client using the default configuration
client = ::Google::Cloud::WebRisk::V1beta1::WebRiskService::Client.new

# Create a client using a custom configuration
client = ::Google::Cloud::WebRisk::V1beta1::WebRiskService::Client.new do |config|
  config.timeout = 10.0
end

Yields:

  • (config) —

    Configure the WebRiskService client.

Yield Parameters:



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
 
# File 'lib/google/cloud/web_risk/v1beta1/web_risk_service/client.rb', line 138

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/v1beta1/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 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 = ::Gapic::ServiceStub.new(
    ::Google::Cloud::WebRisk::V1beta1::WebRiskServiceV1Beta1::Stub,
    credentials: credentials,
    endpoint: @config.endpoint,
    endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
    universe_domain: @config.universe_domain,
    channel_args: @config.channel_args,
    interceptors: @config.interceptors,
    channel_pool_config: @config.channel_pool,
    logger: @config.logger
  )

  @web_risk_service_stub.stub_logger&.info do |entry|
    entry.set_system_name
    entry.set_service
    entry.message = "Created client for #{entry.service}"
    entry.set_credentials_fields credentials
    entry.set "customEndpoint", @config.endpoint if @config.endpoint
    entry.set "defaultTimeout", @config.timeout if @config.timeout
    entry.set "quotaProject", @quota_project_id if @quota_project_id
  end
end

Class Method Details

.configure {|config| ... } ⇒ Client::Configuration

Configure the WebRiskService Client class.

See Configuration for a description of the configuration fields.

Examples:


# Modify the configuration for all WebRiskService clients
::Google::Cloud::WebRisk::V1beta1::WebRiskService::Client.configure do |config|
  config.timeout = 10.0
end

Yields:

  • (config) —

    Configure the Client client.

Yield Parameters:

Returns:



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
91
 
# File 'lib/google/cloud/web_risk/v1beta1/web_risk_service/client.rb', line 61

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.

Examples:

Basic example

require "google/cloud/web_risk/v1beta1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::WebRisk::V1beta1::WebRiskService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::WebRisk::V1beta1::ComputeThreatListDiffRequest.new

# Call the compute_threat_list_diff method.
result = client.compute_threat_list_diff request

# The returned object is of type Google::Cloud::WebRisk::V1beta1::ComputeThreatListDiffResponse.
p result

Overloads:

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
 
# File 'lib/google/cloud/web_risk/v1beta1/web_risk_service/client.rb', line 249

def compute_threat_list_diff request, options = 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
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.compute_threat_list_diff.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  metadata[:"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
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.compute_threat_list_diff.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.compute_threat_list_diff.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @web_risk_service_stub.call_rpc :compute_threat_list_diff, request, options: options do |response, operation|
    yield response, operation if block_given?
  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.

Yields:

  • (config) —

    Configure the Client client.

Yield Parameters:

Returns:



108
109
110
111
 
# File 'lib/google/cloud/web_risk/v1beta1/web_risk_service/client.rb', line 108

def configure
  yield @config if block_given?
  @config
end

#logger ⇒ Logger

The logger used for request/response debug logging.

Returns:

  • (Logger) 


194
195
196
 
# File 'lib/google/cloud/web_risk/v1beta1/web_risk_service/client.rb', line 194

def logger
  @web_risk_service_stub.logger
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.

Examples:

Basic example

require "google/cloud/web_risk/v1beta1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::WebRisk::V1beta1::WebRiskService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::WebRisk::V1beta1::SearchHashesRequest.new

# Call the search_hashes method.
result = client.search_hashes request

# The returned object is of type Google::Cloud::WebRisk::V1beta1::SearchHashesResponse.
p result

Overloads:

  • #search_hashes(request, options = nil) ⇒ ::Google::Cloud::WebRisk::V1beta1::SearchHashesResponse

    Pass arguments to search_hashes via a request object, either of type SearchHashesRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::WebRisk::V1beta1::SearchHashesRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

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

  • #search_hashes(hash_prefix: nil, threat_types: nil) ⇒ ::Google::Cloud::WebRisk::V1beta1::SearchHashesResponse

    Pass arguments to search_hashes via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • 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.

    • threat_types (::Array<::Google::Cloud::WebRisk::V1beta1::ThreatType>) (defaults to: nil) —

      Required. The ThreatLists to search in.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



412
413
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
 
# File 'lib/google/cloud/web_risk/v1beta1/web_risk_service/client.rb', line 412

def search_hashes request, options = 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
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.search_hashes.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  metadata[:"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
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.search_hashes.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.search_hashes.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @web_risk_service_stub.call_rpc :search_hashes, request, options: options do |response, operation|
    yield response, operation if block_given?
  end
rescue ::GRPC::BadStatus => 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.

Examples:

Basic example

require "google/cloud/web_risk/v1beta1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::WebRisk::V1beta1::WebRiskService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::WebRisk::V1beta1::SearchUrisRequest.new

# Call the search_uris method.
result = client.search_uris request

# The returned object is of type Google::Cloud::WebRisk::V1beta1::SearchUrisResponse.
p result

Overloads:

  • #search_uris(request, options = nil) ⇒ ::Google::Cloud::WebRisk::V1beta1::SearchUrisResponse

    Pass arguments to search_uris via a request object, either of type SearchUrisRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::WebRisk::V1beta1::SearchUrisRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

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

  • #search_uris(uri: nil, threat_types: nil) ⇒ ::Google::Cloud::WebRisk::V1beta1::SearchUrisResponse

    Pass arguments to search_uris via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
 
# File 'lib/google/cloud/web_risk/v1beta1/web_risk_service/client.rb', line 328

def search_uris request, options = 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
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.search_uris.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  metadata[:"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
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.search_uris.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.search_uris.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @web_risk_service_stub.call_rpc :search_uris, request, options: options do |response, operation|
    yield response, operation if block_given?
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#universe_domain ⇒ String

The effective universe domain

Returns:

  • (String) 


118
119
120
 
# File 'lib/google/cloud/web_risk/v1beta1/web_risk_service/client.rb', line 118

def universe_domain
  @web_risk_service_stub.universe_domain
end