class Google::Cloud::PhishingProtection::V1beta1::PhishingProtectionService::Client
Client
for the PhishingProtectionService
service.
Service to report phishing URIs.
Attributes
@private
Public Class Methods
Configure the PhishingProtectionService
Client
class.
See {::Google::Cloud::PhishingProtection::V1beta1::PhishingProtectionService::Client::Configuration} for a description of the configuration fields.
@example
# Modify the configuration for all PhishingProtectionService clients ::Google::Cloud::PhishingProtection::V1beta1::PhishingProtectionService::Client.configure do |config| config.timeout = 10.0 end
@yield [config] Configure the Client
client. @yieldparam config [Client::Configuration]
@return [Client::Configuration]
# File lib/google/cloud/phishing_protection/v1beta1/phishing_protection_service/client.rb, line 56 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
Create a new PhishingProtectionService
client object.
@example
# 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
@yield [config] Configure the PhishingProtectionService
client. @yieldparam config [Client::Configuration]
# File lib/google/cloud/phishing_protection/v1beta1/phishing_protection_service/client.rb, line 111 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 == Client.configure.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, channel_args: @config.channel_args, interceptors: @config.interceptors ) end
Public Instance Methods
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 {Client.configure}.
See {::Google::Cloud::PhishingProtection::V1beta1::PhishingProtectionService::Client::Configuration} for a description of the configuration fields.
@yield [config] Configure the Client
client. @yieldparam config [Client::Configuration]
@return [Client::Configuration]
# File lib/google/cloud/phishing_protection/v1beta1/phishing_protection_service/client.rb, line 90 def configure yield @config if block_given? @config end
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](support.google.com/webmasters/answer/6350487/) in order to protect users that could get exposed to this threat in the future.
@overload report_phishing
(request, options = nil)
Pass arguments to `report_phishing` via a request object, either of type {::Google::Cloud::PhishingProtection::V1beta1::ReportPhishingRequest} or an equivalent Hash. @param 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. @param options [::Gapic::CallOptions, ::Hash] Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
@overload report_phishing
(parent: nil, uri: nil)
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). @param parent [::String] Required. The name of the project for which the report will be created, in the format "projects/\\{project_number}". @param uri [::String] Required. The URI that is being reported for phishing content to be analyzed.
@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Google::Cloud::PhishingProtection::V1beta1::ReportPhishingResponse] @yieldparam operation [::GRPC::ActiveCall::Operation]
@return [::Google::Cloud::PhishingProtection::V1beta1::ReportPhishingResponse]
@raise [::Google::Cloud::Error] if the RPC is aborted.
# File lib/google/cloud/phishing_protection/v1beta1/phishing_protection_service/client.rb, line 187 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 = { "parent" => request.parent } 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