google-cloud-pubsub 2.23.0 → 3.0.0

data/lib/google/cloud/pubsub/project.rb

@@ -16,10 +16,8 @@
 require "google/cloud/errors"
 require "google/cloud/pubsub/service"
 require "google/cloud/pubsub/credentials"
-require "google/cloud/pubsub/topic"
-require "google/cloud/pubsub/batch_publisher"
-require "google/cloud/pubsub/schema"
-require "google/cloud/pubsub/snapshot"
+require "google/cloud/pubsub/publisher"
+require "google/cloud/pubsub/subscriber"
 
 module Google
   module Cloud
@@ -31,10 +29,13 @@ module Google
       # # Project
       #
       # Represents the project that pubsub messages are pushed to and pulled
-      # from. {Topic} is a named resource to which messages are sent by
-      # publishers. {Subscription} is a named resource representing the stream
+      # from.
+      #
+      # {Google::Cloud::PubSub::V1::Topic} is a named resource to which
+      # messages are sent by using {Publisher}.
+      # {Google::Cloud::PubSub::V1::Subscription} is a named resource representing the stream
       # of messages from a single, specific topic, to be delivered to the
-      # subscribing application. {Message} is a combination of data and
+      # subscribing application via {Subscriber}. {Message} is a combination of data and
       # attributes that a publisher sends to a topic and is eventually delivered
       # to subscribers.
       #
@@ -45,8 +46,8 @@ module Google
       #
       #   pubsub = Google::Cloud::PubSub.new
       #
-      #   topic = pubsub.topic "my-topic"
-      #   topic.publish "task completed"
+      #   publisher = pubsub.publisher "my-topic"
+      #   publisher.publish "task completed"
       #
       class Project
         ##
@@ -86,574 +87,140 @@ module Google
         end
 
         ##
-        # Retrieves topic by name.
-        #
-        # @param [String] topic_name Name of a topic. The value can be a simple
-        #   topic ID (relative name), in which case the current project ID will
-        #   be supplied, or a fully-qualified topic name in the form
-        #   `projects/{project_id}/topics/{topic_id}`.
-        # @param [String] project If the topic belongs to a project other than
-        #   the one currently connected to, the alternate project ID can be
-        #   specified here. Optional. Not used if a fully-qualified topic name
-        #   is provided for `topic_name`.
-        # @param [Boolean] skip_lookup Optionally create a {Topic} object
-        #   without verifying the topic resource exists on the Pub/Sub service.
-        #   Calls made on this object will raise errors if the topic resource
-        #   does not exist. Default is `false`. Optional.
-        # @param [Hash] async A hash of values to configure the topic's
-        #   {AsyncPublisher} that is created when {Topic#publish_async}
-        #   is called. Optional.
-        #
-        #   Hash keys and values may include the following:
-        #
-        #   * `:max_bytes` (Integer) The maximum size of messages to be collected before the batch is published. Default
-        #     is 1,000,000 (1MB).
-        #   * `:max_messages` (Integer) The maximum number of messages to be collected before the batch is published.
-        #     Default is 100.
-        #   * `:interval` (Numeric) The number of seconds to collect messages before the batch is published. Default is
-        #     0.01.
-        #   * `:threads` (Hash) The number of threads to create to handle concurrent calls by the publisher:
-        #     * `:publish` (Integer) The number of threads used to publish messages. Default is 2.
-        #     * `:callback` (Integer) The number of threads to handle the published messages' callbacks. Default is 4.
-        #   * `:compress` (Boolean) The flag that enables publisher compression. Default is false
-        #   * `:compression_bytes_threshold` (Integer) The number of bytes above which compress should be enabled.
-        #       Default is 240.
-        #   * `:flow_control` (Hash) The client flow control settings for message publishing:
-        #     * `:message_limit` (Integer) The maximum number of messages allowed to wait to be published. Default is
-        #       `10 * max_messages`.
-        #     * `:byte_limit` (Integer) The maximum total size of messages allowed to wait to be published. Default is
-        #       `10 * max_bytes`.
-        #     * `:limit_exceeded_behavior` (Symbol) The action to take when publish flow control limits are exceeded.
-        #       Possible values include: `:ignore` - Flow control is disabled. `:error` - Calls to {Topic#publish_async}
-        #       will raise {FlowControlLimitError} when publish flow control limits are exceeded. `:block` - Calls to
-        #       {Topic#publish_async} will block until capacity is available when publish flow control limits are
-        #       exceeded. The default value is `:ignore`.
-        #
-        # @return [Google::Cloud::PubSub::Topic, nil] Returns `nil` if topic
-        #   does not exist.
-        #
-        # @example
-        #   require "google/cloud/pubsub"
-        #
-        #   pubsub = Google::Cloud::PubSub.new
-        #   topic = pubsub.topic "existing-topic"
-        #
-        # @example By default `nil` will be returned if topic does not exist.
-        #   require "google/cloud/pubsub"
-        #
-        #   pubsub = Google::Cloud::PubSub.new
-        #   topic = pubsub.topic "non-existing-topic" # nil
-        #
-        # @example Create topic in a different project with the `project` flag.
-        #   require "google/cloud/pubsub"
-        #
-        #   pubsub = Google::Cloud::PubSub.new
-        #   topic = pubsub.topic "another-topic", project: "another-project"
-        #
-        # @example Skip the lookup against the service with `skip_lookup`:
-        #   require "google/cloud/pubsub"
-        #
-        #   pubsub = Google::Cloud::PubSub.new
-        #   topic = pubsub.topic "another-topic", skip_lookup: true
-        #
-        # @example Configuring AsyncPublisher to increase concurrent callbacks:
-        #   require "google/cloud/pubsub"
-        #
-        #   pubsub = Google::Cloud::PubSub.new
-        #   topic = pubsub.topic "my-topic",
-        #                        async: { threads: { callback: 16 } }
+        # Retrieve a client for managing subscriptions.
         #
-        #   topic.publish_async "task completed" do |result|
-        #     if result.succeeded?
-        #       log_publish_success result.data
-        #     else
-        #       log_publish_failure result.data, result.error
-        #     end
-        #   end
+        # @return [Google::Cloud::PubSub::SubscriptionAdmin::Client]
         #
-        #   topic.async_publisher.stop!
-        #
-        def topic topic_name, project: nil, skip_lookup: nil, async: nil
-          ensure_service!
-          options = { project: project, async: async }
-          return Topic.from_name topic_name, service, options if skip_lookup
-          grpc = service.get_topic topic_name, options
-          Topic.from_grpc grpc, service, async: async
-        rescue Google::Cloud::NotFoundError
-          nil
+        def subscription_admin
+          service.subscription_admin
         end
-        alias get_topic topic
-        alias find_topic topic
 
         ##
-        # Creates a new topic.
-        #
-        # @param [String] topic_name Name of a topic. Required.
-        #   The value can be a simple topic ID (relative name), in which
-        #   case the current project ID will be supplied, or a fully-qualified
-        #   topic name in the form `projects/{project_id}/topics/{topic_id}`.
-        #
-        #   The topic ID (relative name) must start with a letter, and
-        #   contain only letters (`[A-Za-z]`), numbers (`[0-9]`), dashes (`-`),
-        #   underscores (`_`), periods (`.`), tildes (`~`), plus (`+`) or percent
-        #   signs (`%`). It must be between 3 and 255 characters in length, and
-        #   it must not start with `goog`.
-        # @param [Hash] labels A hash of user-provided labels associated with
-        #   the topic. You can use these to organize and group your topics.
-        #   Label keys and values can be no longer than 63 characters, can only
-        #   contain lowercase letters, numeric characters, underscores and
-        #   dashes. International characters are allowed. Label values are
-        #   optional. Label keys must start with a letter and each label in the
-        #   list must have a different key. See [Creating and Managing
-        #   Labels](https://cloud.google.com/pubsub/docs/labels).
-        # @param [String] kms_key The Cloud KMS encryption key that will be used
-        #   to protect access to messages published on this topic. Optional.
-        #   For example: `projects/a/locations/b/keyRings/c/cryptoKeys/d`
-        # @param [Array<String>] persistence_regions The list of GCP region IDs
-        #   where messages that are published to the topic may be persisted in
-        #   storage. Optional.
-        # @param [Hash] async A hash of values to configure the topic's
-        #   {AsyncPublisher} that is created when {Topic#publish_async}
-        #   is called. Optional.
-        #
-        #   Hash keys and values may include the following:
-        #
-        #   * `:max_bytes` (Integer) The maximum size of messages to be collected
-        #     before the batch is published. Default is 1,000,000 (1MB).
-        #   * `:max_messages` (Integer) The maximum number of messages to be
-        #     collected before the batch is published. Default is 100.
-        #   * `:interval` (Numeric) The number of seconds to collect messages before
-        #     the batch is published. Default is 0.01.
-        #   * `:threads` (Hash) The number of threads to create to handle concurrent
-        #     calls by the publisher:
-        #     * `:publish` (Integer) The number of threads used to publish messages.
-        #       Default is 2.
-        #     * `:callback` (Integer) The number of threads to handle the published
-        #       messages' callbacks. Default is 4.
-        #   * `:compress` (Boolean) The flag that enables publisher compression. Default is false
-        #   * `:compression_bytes_threshold` (Integer) The number of bytes above which compress should be enabled.
-        #       Default is 240.
-        #   * `:flow_control` (Hash) The client flow control settings for message publishing:
-        #     * `:message_limit` (Integer) The maximum number of messages allowed to wait to be published. Default is
-        #       `10 * max_messages`.
-        #     * `:byte_limit` (Integer) The maximum total size of messages allowed to wait to be published. Default is
-        #       `10 * max_bytes`.
-        #     * `:limit_exceeded_behavior` (Symbol) The action to take when publish flow control limits are exceeded.
-        #       Possible values include: `:ignore` - Flow control is disabled. `:error` - Calls to {Topic#publish_async}
-        #       will raise {FlowControlLimitError} when publish flow control limits are exceeded. `:block` - Calls to
-        #       {Topic#publish_async} will block until capacity is available when publish flow control limits are
-        #       exceeded. The default value is `:ignore`.
-        # @param [String] schema_name The name of the schema that messages
-        #   published should be validated against. Optional. The value can be a
-        #   simple schema ID (relative name), in which case the current project
-        #   ID will be supplied, or a fully-qualified schema name in the form
-        #   `projects/{project_id}/schemas/{schema_id}`. If provided,
-        #   `message_encoding` must also be provided.
-        # @param [String, Symbol] message_encoding The encoding of messages validated
-        #   against the schema identified by `schema_name`. Optional. Values include:
-        #
-        #   * `JSON` - JSON encoding.
-        #   * `BINARY` - Binary encoding, as defined by the schema type. For some
-        #     schema types, binary encoding may not be available.
-        # @param [Numeric] retention Indicates the minimum number of seconds to retain a message
-        #   after it is published to the topic. If this field is set, messages published
-        #   to the topic within the `retention` number of seconds are always available to
-        #   subscribers. For instance, it allows any attached subscription to [seek to a
-        #   timestamp](https://cloud.google.com/pubsub/docs/replay-overview#seek_to_a_time)
-        #   that is up to `retention` number of seconds in the past. If this field is
-        #   not set, message retention is controlled by settings on individual
-        #   subscriptions. Cannot be less than 600 (10 minutes) or more than 604,800 (7 days).
-        #   @param ingestion_data_source_settings [::Google::Cloud::PubSub::V1::IngestionDataSourceSettings, ::Hash]
-        #     Optional. Settings for ingestion from a data source into this topic.
-        #
-        # @return [Google::Cloud::PubSub::Topic]
-        #
-        # @example
-        #   require "google/cloud/pubsub"
+        # Retrieve a client for managing topics.
         #
-        #   pubsub = Google::Cloud::PubSub.new
-        #   topic = pubsub.create_topic "my-topic"
+        # @return [Google::Cloud::PubSub::TopicAdmin::Client]
         #
-        def create_topic topic_name,
-                         labels: nil,
-                         kms_key: nil,
-                         persistence_regions: nil,
-                         async: nil,
-                         schema_name: nil,
-                         message_encoding: nil,
-                         retention: nil,
-                         ingestion_data_source_settings: nil
-          ensure_service!
-          grpc = service.create_topic topic_name,
-                                      labels: labels,
-                                      kms_key_name: kms_key,
-                                      persistence_regions: persistence_regions,
-                                      schema_name: schema_name,
-                                      message_encoding: message_encoding,
-                                      retention: retention,
-                                      ingestion_data_source_settings: ingestion_data_source_settings
-          Topic.from_grpc grpc, service, async: async
+        def topic_admin
+          service.topic_admin
         end
-        alias new_topic create_topic
 
         ##
-        # Retrieves a list of topics for the given project.
-        #
-        # @param [String] token The `token` value returned by the last call to
-        #   `topics`; indicates that this is a continuation of a call, and that
-        #   the system should return the next page of data.
-        # @param [Integer] max Maximum number of topics to return.
-        #
-        # @return [Array<Google::Cloud::PubSub::Topic>] (See
-        #   {Google::Cloud::PubSub::Topic::List})
+        # Retrieve a client for managing schemas.
         #
-        # @example
-        #   require "google/cloud/pubsub"
+        # @return [Google::Cloud::PubSub::V1::SchemaService::Client]
         #
-        #   pubsub = Google::Cloud::PubSub.new
+        def schemas
+          service.schemas
+        end
+
+        ##
+        # Retrieve a client specific for Iam Policy related functions.
         #
-        #   topics = pubsub.topics
-        #   topics.each do |topic|
-        #     puts topic.name
-        #   end
+        # @return [Google::Iam::V1::IAMPolicy::Client]
         #
-        # @example Retrieve all topics: (See {Topic::List#all})
-        #   require "google/cloud/pubsub"
+        def iam
+          service.iam
+        end
+
+        ##
+        # Retrieves a Publisher by topic name or full project path.
         #
-        #   pubsub = Google::Cloud::PubSub.new
+        # @param [String] topic_name Name of a topic. The value can be a simple
+        #   topic ID (relative name) or a fully-qualified topic name.
+        # @param [String] project The alternate project ID can be specified here.
+        #   Optional. Not used if a fully-qualified topic name is provided
+        #   for `topic_name`.
+        # @param [Hash] async A hash of values to configure the topic's
+        #   {AsyncPublisher} that is created when {Publisher#publish_async}
+        #   is called. Optional.
         #
-        #   topics = pubsub.topics
-        #   topics.all do |topic|
-        #     puts topic.name
-        #   end
+        # @return [Google::Cloud::PubSub::Publisher]
         #
-        def topics token: nil, max: nil
+        def publisher topic_name, project: nil, async: nil
           ensure_service!
-          options = { token: token, max: max }
-          grpc = service.list_topics options
-          Topic::List.from_grpc grpc, service, max
+          options = { project: project, async: async }
+          grpc = topic_admin.get_topic topic: service.topic_path(topic_name, options)
+          Publisher.from_grpc grpc, service, async: async
         end
-        alias find_topics topics
-        alias list_topics topics
 
         ##
-        # Retrieves subscription by name.
+        # Retrieves a Subscriber by subscription name or full project path.
         #
         # @param [String] subscription_name Name of a subscription. The value can
-        #   be a simple subscription ID, in which case the current project ID
-        #   will be supplied, or a fully-qualified subscription name in the form
-        #   `projects/{project_id}/subscriptions/{subscription_id}`.
-        # @param [String] project If the subscription belongs to a project other
-        #   than the one currently connected to, the alternate project ID can be
-        #   specified here. Not used if a fully-qualified subscription name is
-        #   provided for `subscription_name`.
-        # @param [Boolean] skip_lookup Optionally create a {Subscription} object
-        #   without verifying the subscription resource exists on the Pub/Sub
+        #   be a simple subscription ID (relative name) or a fully-qualified
+        #   subscription name.
+        # @param [String] project The alternate project ID can be specified here.
+        #   Optional. Not used if a fully-qualified topic name is provided
+        #   for `topic_name`.
+        # @param [Boolean] skip_lookup Optionally create a {Google::Cloud::PubSub::V1::Subscription}
+        #   object without verifying the subscription resource exists on the Pub/Sub
         #   service. Calls made on this object will raise errors if the service
         #   resource does not exist. Default is `false`.
         #
-        # @return [Google::Cloud::PubSub::Subscription, nil] Returns `nil` if
-        #   the subscription does not exist
-        #
-        # @example
-        #   require "google/cloud/pubsub"
+        # @return [Google::Cloud::PubSub::Subscriber, nil] Returns `nil` if
+        #   the subscription does not exist.
         #
-        #   pubsub = Google::Cloud::PubSub.new
-        #
-        #   sub = pubsub.subscription "my-sub"
-        #   sub.name #=> "projects/my-project/subscriptions/my-sub"
-        #
-        # @example Skip the lookup against the service with `skip_lookup`:
-        #   require "google/cloud/pubsub"
-        #
-        #   pubsub = Google::Cloud::PubSub.new
-        #
-        #   # No API call is made to retrieve the subscription information.
-        #   sub = pubsub.subscription "my-sub", skip_lookup: true
-        #   sub.name #=> "projects/my-project/subscriptions/my-sub"
-        #
-        def subscription subscription_name, project: nil, skip_lookup: nil
+        def subscriber subscription_name, project: nil, skip_lookup: nil
           ensure_service!
           options = { project: project }
-          return Subscription.from_name subscription_name, service, options if skip_lookup
-          grpc = service.get_subscription subscription_name, options
-          Subscription.from_grpc grpc, service
-        rescue Google::Cloud::NotFoundError
-          nil
+          return Subscriber.from_name subscription_name, service, options if skip_lookup
+          grpc = subscription_admin.get_subscription subscription: service.subscription_path(subscription_name, options)
+          Subscriber.from_grpc grpc, service
         end
-        alias get_subscription subscription
-        alias find_subscription subscription
 
         ##
-        # Retrieves a list of subscriptions for the given project.
-        #
-        # @param [String] token A previously-returned page token representing
-        #   part of the larger set of results to view.
-        # @param [Integer] max Maximum number of subscriptions to return.
-        #
-        # @return [Array<Google::Cloud::PubSub::Subscription>] (See
-        #   {Google::Cloud::PubSub::Subscription::List})
-        #
-        # @example
-        #   require "google/cloud/pubsub"
-        #
-        #   pubsub = Google::Cloud::PubSub.new
+        # Returns a fully-qualified project path in the form of
+        #   `projects/{project_id}`
+        # @param [String] project_name A project name. Optional.
+        #   If provided, this will be used in place of the default `project_id`.
         #
-        #   subs = pubsub.subscriptions
-        #   subs.each do |sub|
-        #     puts sub.name
-        #   end
-        #
-        # @example Retrieve all subscriptions: (See {Subscription::List#all})
-        #   require "google/cloud/pubsub"
-        #
-        #   pubsub = Google::Cloud::PubSub.new
-        #
-        #   subs = pubsub.subscriptions
-        #   subs.all do |sub|
-        #     puts sub.name
-        #   end
-        #
-        def subscriptions token: nil, max: nil
-          ensure_service!
-          options = { token: token, max: max }
-          grpc = service.list_subscriptions options
-          Subscription::List.from_grpc grpc, service, max
+        def project_path project_name: nil
+          service.project_path options: { "project" => project_name }.compact
         end
-        alias find_subscriptions subscriptions
-        alias list_subscriptions subscriptions
-
 
         ##
-        # Retrieves a list of snapshots for the given project.
-        #
-        # @param [String] token A previously-returned page token representing
-        #   part of the larger set of results to view.
-        # @param [Integer] max Maximum number of snapshots to return.
-        #
-        # @return [Array<Google::Cloud::PubSub::Snapshot>] (See
-        #   {Google::Cloud::PubSub::Snapshot::List})
-        #
-        # @example
-        #   require "google/cloud/pubsub"
-        #
-        #   pubsub = Google::Cloud::PubSub.new
-        #
-        #   snapshots = pubsub.snapshots
-        #   snapshots.each do |snapshot|
-        #     puts snapshot.name
-        #   end
-        #
-        # @example Retrieve all snapshots: (See {Snapshot::List#all})
-        #   require "google/cloud/pubsub"
-        #
-        #   pubsub = Google::Cloud::PubSub.new
-        #
-        #   snapshots = pubsub.snapshots
-        #   snapshots.all do |snapshot|
-        #     puts snapshot.name
-        #   end
-        #
-        def snapshots token: nil, max: nil
-          ensure_service!
-          options = { token: token, max: max }
-          grpc = service.list_snapshots options
-          Snapshot::List.from_grpc grpc, service, max
-        end
-        alias find_snapshots snapshots
-        alias list_snapshots snapshots
-
-        ##
-        # Retrieves schema by name.
-        #
-        # @param [String] schema_name Name of a schema. The value can
-        #   be a simple schema ID, in which case the current project ID
-        #   will be supplied, or a fully-qualified schema name in the form
-        #   `projects/{project_id}/schemas/{schema_id}`.
-        # @param view [Symbol, String, nil] Possible values:
-        #   * `BASIC` - Include the `name` and `type` of the schema, but not the `definition`.
-        #   * `FULL` - Include all Schema object fields.
-        #
-        #   The default value is `FULL`.
-        # @param [String] project If the schema belongs to a project other
-        #   than the one currently connected to, the alternate project ID can be
-        #   specified here. Not used if a fully-qualified schema name is
-        #   provided for `schema_name`.
-        # @param [Boolean] skip_lookup Optionally create a {Schema} object
-        #   without verifying the schema resource exists on the Pub/Sub
-        #   service. Calls made on this object will raise errors if the service
-        #   resource does not exist. Default is `false`.
-        #
-        # @return [Google::Cloud::PubSub::Schema, nil] Returns `nil` if
-        #   the schema does not exist.
-        #
-        # @example
-        #   require "google/cloud/pubsub"
-        #
-        #   pubsub = Google::Cloud::PubSub.new
-        #
-        #   schema = pubsub.schema "my-schema"
-        #   schema.name #=> "projects/my-project/schemas/my-schema"
-        #   schema.type #=> :PROTOCOL_BUFFER
-        #   schema.definition # The schema definition
-        #
-        # @example Skip the lookup against the service with `skip_lookup`:
-        #   require "google/cloud/pubsub"
-        #
-        #   pubsub = Google::Cloud::PubSub.new
-        #
-        #   # No API call is made to retrieve the schema information.
-        #   # The default project is used in the name.
-        #   schema = pubsub.schema "my-schema", skip_lookup: true
-        #   schema.name #=> "projects/my-project/schemas/my-schema"
-        #   schema.type #=> nil
-        #   schema.definition #=> nil
-        #
-        # @example Omit the schema definition with `view: :basic`:
-        #   require "google/cloud/pubsub"
-        #
-        #   pubsub = Google::Cloud::PubSub.new
-        #
-        #   schema = pubsub.schema "my-schema", view: :basic
-        #   schema.name #=> "projects/my-project/schemas/my-schema"
-        #   schema.type #=> :PROTOCOL_BUFFER
-        #   schema.definition #=> nil
-        #
-        def schema schema_name, view: nil, project: nil, skip_lookup: nil
-          ensure_service!
-          options = { project: project }
-          return Schema.from_name schema_name, view, service, options if skip_lookup
-          view ||= :FULL
-          grpc = service.get_schema schema_name, view, options
-          Schema.from_grpc grpc, service
-        rescue Google::Cloud::NotFoundError
-          nil
+        # Returns a fully-qualified topic path in the form of
+        #   `projects/{project_id}/topics/{topic_name}`
+        # @param [String] topic_name A topic name.
+        # @param [String] project_name A project name. Optional.
+        #   If provided, this will be used in place of the default `project_id`.
+        #
+        def topic_path topic_name, project_name: nil
+          service.topic_path topic_name, options: { "project" => project_name }.compact
         end
-        alias get_schema schema
-        alias find_schema schema
 
         ##
-        # Creates a new schema.
-        #
-        # @param [String] schema_id The ID to use for the schema, which will
-        #   become the final component of the schema's resource name. Required.
-        #
-        #   The schema ID (relative name) must start with a letter, and
-        #   contain only letters (`[A-Za-z]`), numbers (`[0-9]`), dashes (`-`),
-        #   underscores (`_`), periods (`.`), tildes (`~`), plus (`+`) or percent
-        #   signs (`%`). It must be between 3 and 255 characters in length, and
-        #   it must not start with `goog`.
-        # @param [String, Symbol] type The type of the schema. Required. Possible
-        #   values are case-insensitive and include:
-        #
-        #     * `PROTOCOL_BUFFER` - A Protocol Buffer schema definition.
-        #     * `AVRO` - An Avro schema definition.
-        # @param [String] definition  The definition of the schema. Required. This
-        #   should be a string representing the full definition of the schema that
-        #   is a valid schema definition of the type specified in `type`.
-        # @param [String] project If the schema belongs to a project other
-        #   than the one currently connected to, the alternate project ID can be
-        #   specified here. Optional.
-        #
-        # @return [Google::Cloud::PubSub::Schema]
-        #
-        # @example
-        #   require "google/cloud/pubsub"
-        #
-        #   pubsub = Google::Cloud::PubSub.new
-        #
-        #   definition = "..."
-        #   schema = pubsub.create_schema "my-schema", :avro, definition
-        #   schema.name #=> "projects/my-project/schemas/my-schema"
-        #
-        def create_schema schema_id, type, definition, project: nil
-          ensure_service!
-          type = type.to_s.upcase
-          grpc = service.create_schema schema_id, type, definition, project: project
-          Schema.from_grpc grpc, service
+        # Returns a fully-qualified subscription path in the form of
+        #   `projects/{project_id}/subscriptions/{subscription_name}`
+        # @param [String] subscription_name A subscription name.
+        # @param [String] project_name A project name. Optional.
+        #   If provided, this will be used in place of the default `project_id`.
+        #
+        def subscription_path subscription_name, project_name: nil
+          service.subscription_path subscription_name, options: { "project" => project_name }.compact
         end
-        alias new_schema create_schema
 
         ##
-        # Retrieves a list of schemas for the given project.
-        #
-        # @param view [String, Symbol, nil] The set of fields to return in the response. Possible values:
-        #
-        #     * `BASIC` - Include the `name` and `type` of the schema, but not the `definition`.
-        #     * `FULL` - Include all Schema object fields.
-        #
-        #   The default value is `FULL`.
-        # @param [String] token A previously-returned page token representing
-        #   part of the larger set of results to view.
-        # @param [Integer] max Maximum number of schemas to return.
-        #
-        # @return [Array<Google::Cloud::PubSub::Schema>] (See
-        #   {Google::Cloud::PubSub::Schema::List})
-        #
-        # @example
-        #   require "google/cloud/pubsub"
-        #
-        #   pubsub = Google::Cloud::PubSub.new
-        #
-        #   schemas = pubsub.schemas
-        #   schemas.each do |schema|
-        #     puts schema.name
-        #   end
-        #
-        # @example Retrieve all schemas: (See {Schema::List#all})
-        #   require "google/cloud/pubsub"
-        #
-        #   pubsub = Google::Cloud::PubSub.new
-        #
-        #   schemas = pubsub.schemas
-        #   schemas.all do |schema|
-        #     puts schema.name
-        #   end
-        #
-        def schemas view: nil, token: nil, max: nil
-          ensure_service!
-          view ||= :FULL
-          options = { token: token, max: max }
-          grpc = service.list_schemas view, options
-          Schema::List.from_grpc grpc, service, view, max
+        # Returns a fully-qualified snapshot path in the form of
+        #   `projects/{project_id}/snapshots/{snapshot_name}`
+        # @param [String] snapshot_name A snapshot name.
+        # @param [String] project_name A project name. Optional.
+        #   If provided, this will be used in place of the default `project_id`.
+        #
+        def snapshot_path snapshot_name, project_name: nil
+          service.snapshot_path snapshot_name, options: { "project" => project_name }.compact
         end
-        alias find_schemas schemas
-        alias list_schemas schemas
 
         ##
-        # Validates a schema type and definition.
-        #
-        # @param [String, Symbol] type The type of the schema. Required. Possible
-        #   values are case-insensitive and include:
-        #
-        #     * `PROTOCOL_BUFFER` - A Protocol Buffer schema definition.
-        #     * `AVRO` - An Avro schema definition.
-        # @param [String] definition  The definition of the schema. Required. This
-        #   should be a string representing the full definition of the schema that
-        #   is a valid schema definition of the type specified in `type`.
-        # @param [String] project If the schema belongs to a project other
-        #   than the one currently connected to, the alternate project ID can be
-        #   specified here. Optional.
-        #
-        # @return [Boolean] `true` if the schema is valid, `false` otherwise.
-        #
-        # @example
-        #   require "google/cloud/pubsub"
-        #
-        #   pubsub = Google::Cloud::PubSub.new
-        #
-        #   definition = "..."
-        #   pubsub.validate_schema :avro, definition #=> true
-        #
-        def valid_schema? type, definition, project: nil
-          ensure_service!
-          type = type.to_s.upcase
-          service.validate_schema type, definition, project: project # return type is empty
-          true
-        rescue Google::Cloud::InvalidArgumentError
-          false
+        # Returns a fully-qualified schema path in the form of
+        #   `projects/{project_id}/schemas/{schema_name}`
+        # @param [String] schema_name A schema name.
+        # @param [String] project_name A project name. Optional.
+        #   If provided, this will be used in place of the default `project_id`.
+        #
+        def schema_path schema_name, project_name: nil
+          service.schema_path schema_name, options: { "project" => project_name }.compact
         end
-        alias validate_schema valid_schema?
 
         protected