Class: Google::Cloud::PhishingProtection::V1beta1::PhishingProtectionService::Client

Inherits:
Object
  • Object
show all
Includes:
Paths
Defined in:
lib/google/cloud/phishing_protection/v1beta1/phishing_protection_service/client.rb

Overview

Client for the PhishingProtectionService service.

Service to report phishing URIs.

Defined Under Namespace

Classes: Configuration

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Paths

#project_path

Constructor Details

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

Create a new PhishingProtectionService client object.

Examples:


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

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

Yields:

  • (config) —

    Configure the PhishingProtectionService client.

Yield Parameters:



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
 
# File 'lib/google/cloud/phishing_protection/v1beta1/phishing_protection_service/client.rb', line 123

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/phishingprotection/v1beta1/phishingprotection_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

  @phishing_protection_service_stub = ::Gapic::ServiceStub.new(
    ::Google::Cloud::PhishingProtection::V1beta1::PhishingProtectionServiceV1Beta1::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
  )
end

Class Method Details

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

Configure the PhishingProtectionService Client class.

See Configuration for a description of the configuration fields.

Examples:


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

Yields:

  • (config) —

    Configure the Client client.

Yield Parameters:

Returns:



59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
 
# File 'lib/google/cloud/phishing_protection/v1beta1/phishing_protection_service/client.rb', line 59

def self.configure
  @configure ||= begin
    namespace = ["Google", "Cloud", "PhishingProtection", "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.report_phishing.timeout = 600.0

    default_config
  end
  yield @configure if block_given?
  @configure
end

Instance Method Details

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

Configure the PhishingProtectionService 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:



93
94
95
96
 
# File 'lib/google/cloud/phishing_protection/v1beta1/phishing_protection_service/client.rb', line 93

def configure
  yield @config if block_given?
  @config
end

#report_phishing(request, options = nil) ⇒ ::Google::Cloud::PhishingProtection::V1beta1::ReportPhishingResponse #report_phishing(parent: nil, uri: nil) ⇒ ::Google::Cloud::PhishingProtection::V1beta1::ReportPhishingResponse

Reports a URI suspected of containing phishing content to be reviewed. Once the report review is complete, its result can be found in the Cloud Security Command Center findings dashboard for Phishing Protection. If the result verifies the existence of malicious phishing content, the site will be added the to Google's Social Engineering lists in order to protect users that could get exposed to this threat in the future.

Examples:

Basic example

require "google/cloud/phishing_protection/v1beta1"

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

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

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

# The returned object is of type Google::Cloud::PhishingProtection::V1beta1::ReportPhishingResponse.
p result

Overloads:

  • #report_phishing(request, options = nil) ⇒ ::Google::Cloud::PhishingProtection::V1beta1::ReportPhishingResponse

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

    Parameters:

    • request (::Google::Cloud::PhishingProtection::V1beta1::ReportPhishingRequest, ::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.

  • #report_phishing(parent: nil, uri: nil) ⇒ ::Google::Cloud::PhishingProtection::V1beta1::ReportPhishingResponse

    Pass arguments to report_phishing 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:

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

      Required. The name of the project for which the report will be created, in the format "projects/{project_number}".

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

      Required. The URI that is being reported for phishing content to be analyzed.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



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
252
253
254
255
256
257
 
# File 'lib/google/cloud/phishing_protection/v1beta1/phishing_protection_service/client.rb', line 218

def report_phishing request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::PhishingProtection::V1beta1::ReportPhishingRequest

  # 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.report_phishing.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project 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::PhishingProtection::V1beta1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.parent
    header_params["parent"] = request.parent
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

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

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

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

#universe_domain ⇒ String

The effective universe domain

Returns:

  • (String) 


103
104
105
 
# File 'lib/google/cloud/phishing_protection/v1beta1/phishing_protection_service/client.rb', line 103

def universe_domain
  @phishing_protection_service_stub.universe_domain
end