Migrating to google-cloud-phishing_protection 0.10
The 0.10 release of the google-cloud-phishing_protection client is a significant upgrade based on a next-gen code generator, and includes substantial interface changes. Existing code written for earlier versions of this library will likely require updates to use this version. This document describes the changes that have been made, and what you need to do to update your usage.
To summarize:
- The library has been broken out into two libraries. The new gem
google-cloud-phishing_protection-v1beta1contains the actual client classes for version V1beta1 of the Phishing Protection service, and the gemgoogle-cloud-phishing_protectionnow simply provides a convenience wrapper. See Library Structure for more info. - The library uses a new configuration mechanism giving you closer control over endpoint address, network timeouts, and retry. See Client Configuration for more info. Furthermore, when creating a client object, you can customize its configuration in a block rather than passing arguments to the constructor. See Creating Clients for more info.
- Previously, positional arguments were used to indicate required arguments. Now, all method arguments are keyword arguments, with documentation that specifies whether they are required or optional. Additionally, you can pass a proto request object instead of separate arguments. See Passing Arguments for more info.
- Previously, some client classes included helper methods for constructing resource paths. These methods now take keyword rather than positional arguments, and are also available in a separate paths module. See Resource Path Helpers for more info.
- Previously, clients reported RPC errors by raising instances of
Google::Gax::GaxErrorand its subclasses. Now, RPC exceptions are of typeGoogle::Cloud::Errorand its subclasses. See Handling Errors for more info. - Some classes have moved into different namespaces. In particular, classes
that were under
Google::Cloud::Phishingprotectionwere moved underGoogle::Cloud::PhishingProtection. See Class Namespaces for more info.
Library Structure
Older releases of the google-cloud-phishing_protection gem were all-in-one gems
that included potentially multiple clients for multiple versions of the
Phishing Protection service. The Google::Cloud::PhishingProtection.new factory method would
return you an instance of a Google::Cloud::PhishingProtection::V1beta1::PhishingProtectionClient
object for the V1beta1 version of the service.
With the 0.10 release, the google-cloud-phishing_protection gem still provides factory
methods for obtaining clients. (The method signatures will have changed. See
Creating Clients for details.) However, the actual client
classes have been moved into separate gems, one per service version. Currently,
Phishing Protection has one version, V1beta1. The
Google::Cloud::PhishingProtection::V1beta1::PhishingProtectionService::Client class, along with its
helpers and data types, is now part of the google-cloud-phishing_protection-v1beta1 gem.
If an additional version of the Phishing Protection service is released, an additional gem
may be provided for its client classes.
For normal usage, you can continue to install the google-cloud-phishing_protection gem
(which will bring in the versioned client gems as dependencies) and continue to
use factory methods to create clients. However, you may alternatively choose to
install only one of the versioned gems. For example, if you know you will only
use V1beta1 of the service, you can install google-cloud-phishing_protection-v1beta1 by
itself, and construct instances of the
Google::Cloud::PhishingProtection::V1beta1::PhishingProtectionService::Client client class directly.
Client Configuration
In older releases, if you wanted to customize performance parameters or low-level behavior of the client (such as credentials, timeouts, or instrumentation), you would pass a variety of keyword arguments to the client constructor. It was also extremely difficult to customize the default settings.
With the 0.10 release, a configuration interface provides control over these parameters, including defaults for all instances of a client, and settings for each specific client instance. For example, to set default credentials and timeout for all Phishing Protection V1beta1 clients:
Google::Cloud::PhishingProtection::V1beta1::PhishingProtectionService::Client.configure do |config|
config.credentials = "/path/to/credentials.json"
config.timeout = 10.0
end
Individual RPCs can also be configured independently. For example, to set the
timeout for the report_phishing call:
Google::Cloud::PhishingProtection::V1beta1::PhishingProtectionService::Client.configure do |config|
config.rpcs.report_phishing.timeout = 20.0
end
Defaults for certain configurations can be set for all Phishing Protection versions and services globally:
Google::Cloud::PhishingProtection.configure do |config|
config.credentials = "/path/to/credentials.json"
config.timeout = 10.0
end
Finally, you can override the configuration for each client instance. See the next section on Creating Clients for details.
Creating Clients
In older releases, to create a client object, you would use the
Google::Cloud::PhishingProtection.new class method. Keyword arguments were available to
select a service version and to configure parameters such as credentials and
timeouts.
With the 0.10 release, use the Google::Cloud::PhishingProtection.phishing_protection_service class
method to create a client object. You may select a service version using the
:version keyword argument. However, other configuration parameters should be
set in a configuration block when you create the client.
Old:
client = Google::Cloud::PhishingProtection.new credentials: "/path/to/credentials.json"
New:
client = Google::Cloud::PhishingProtection.phishing_protection_service do |config|
config.credentials = "/path/to/credentials.json"
end
The configuration block is optional. If you do not provide it, or you do not set some configuration parameters, then the default configuration is used. See Client Configuration.
Passing Arguments
In older releases, required arguments would be passed as positional method arguments, while most optional arguments would be passed as keyword arguments.
With the 0.10 release, all RPC arguments are passed as keyword arguments, regardless of whether they are required or optional. For example:
Old:
client = Google::Cloud::PhishingProtection.new
parent = "projects/my-project"
url = "http://example.com"
# Both required arguments are positional arguments.
response = client.report_phishing parent, url
New:
client = Google::Cloud::PhishingProtection.phishing_protection_service
parent = "projects/my-project"
url = "http://example.com"
# All arguments are keyword arguments
response = client.report_phishing parent: parent, url: url
In the 0.10 release, it is also possible to pass a request object, either as a hash or as a protocol buffer.
New:
client = Google::Cloud::PhishingProtection.phishing_protection_service
request = Google::Cloud::PhishingProtection::V1beta1::ReportPhishingRequest.new(
parent: "projects/my-project",
url: "http://example.com"
)
# Pass a request object as a positional argument:
response = client.report_phishing request
Finally, in older releases, to provide call options, you would pass a
Google::Gax::CallOptions object with the :options keyword argument. In the
0.10 release, pass call options using a second set of keyword arguments.
Old:
client = Google::Cloud::PhishingProtection.new
parent = "projects/my-project"
url = "http://example.com"
options = Google::Gax::CallOptions.new timeout: 10.0
response = client.report_phishing parent, url, options: options
New:
client = Google::Cloud::PhishingProtection.phishing_protection_service
parent = "projects/my-project"
url = "http://example.com"
# Use a hash to wrap the normal call arguments (or pass a request object), and
# then add further keyword arguments for the call options.
response = client.report_phishing(
{ parent: parent, url: url },
timeout: 10.0
)
Resource Path Helpers
The client library includes helper methods for generating the resource path strings passed to many calls. These helpers have changed in two ways:
- In older releases, they are both class methods and instance methods on the client class. In the 0.10 release, they are instance methods only. However, they are also available on a separate paths module that you can include elsewhere for convenience.
- In older releases, arguments to a resource path helper are passed as positional arguments. In the 0.10 release, they are passed as named keyword arguments.
Following is an example involving using a resource path helper.
Old:
client = Google::Cloud::PhishingProtection.new
# Call the helper on the client instance
parent = client.project_path "my-project"
url = "http://example.com"
response = client.report_phishing parent, url
New:
client = Google::Cloud::PhishingProtection.phishing_protection_service
# Call the helper on the client instance, and use keyword arguments
parent = client.project_path project: "my-project"
url = "http://example.com"
response = client.report_phishing parent: parent, url: url
In the 0.10 client, you can also use the paths module as a convenience module.
New:
# Bring the path helper methods into the current class
include Google::Cloud::PhishingProtection::V1beta1::PhishingProtectionService::Paths
def foo
client = Google::Cloud::PhishingProtection.phishing_protection_service
# Call the included helper method
parent = project_path project: "my-project"
url = "http://example.com"
response = client.report_phishing parent: parent, url: url
# Do something with response...
end
Handling Errors
The client reports standard
gRPC error codes
by raising exceptions. In older releases, these exceptions were located in the
Google::Gax namespace and were subclasses of the Google::Gax::GaxError base
exception class, defined in the google-gax gem. However, these classes were
different from the standard exceptions (subclasses of Google::Cloud::Error)
thrown by other client libraries such as google-cloud-storage.
The 0.10 client library now uses the Google::Cloud::Error exception hierarchy
for consistency across all the Google Cloud client libraries. In general, these
exceptions have the same name as their counterparts from older releases, but
are located in the Google::Cloud namespace rather than the Google::Gax
namespace.
Old:
client = Google::Cloud::PhishingProtection.new
parent = "projects/my-project"
url = "http://example.com"
begin
client.report_phishing parent, url
rescue Google::Gax::Error => e
# Handle exceptions that subclass Google::Gax::Error
end
New:
client = Google::Cloud::PhishingProtection.phishing_protection_service
parent = "projects/my-project"
url = "http://example.com"
begin
client.report_phishing parent: parent, url: url
rescue Google::Cloud::Error => e
# Handle exceptions that subclass Google::Cloud::Error
end
Class Namespaces
In older releases, (protobuf) data type classes were located under the module
Google::Cloud::Phishingprotection (note the lower-case "p" in the second
word), even though the client class and most other classes were under
Google::Cloud::PhishingProtection (with an upper-case "P"). In the 0.10
release, all classes, including data types, are under the module
Google::Cloud::PhishingProtection.
In older releases, the client object was of classes with names like:
Google::Cloud::PhishingProtection::V1beta1::PhishingProtectionServiceClient.
In the 0.10 release, the client object is of a different class:
Google::Cloud::PhishingProtection::V1beta1::PhishingProtectionService::Client.
Note that most users will use the factory methods such as
Google::Cloud::PhishingProtection.phishing_protection_service to create
instances of the client object, so you may not need to reference the actual
class directly. See Creating Clients.
In older releases, the credentials object was of class
Google::Cloud::PhishingProtection::V1beta1::Credentials.
In the 0.10 release, each service has its own credentials class, e.g.
Google::Cloud::PhishingProtection::V1beta1::PhishingProtectionService::Credentials.
Again, most users will not need to reference this class directly.
See Client Configuration.