google-apis-pubsub_v1 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: df439ad10857a425c21394a4d4d6f92815a59702f9d85a8a2b8fd669a511db44
+  data.tar.gz: 2203405d3978546745ab6de6851682b336740788e7cdbac1a1aff2312bbbaabb
+SHA512:
+  metadata.gz: 924b2010e73028bb6861f080855b0f9fffd47eb968b9bdb96d26529f9dbb0b6e05584e04ac516a40607ba13b00f03fd1fd43880d2b68a88741d7846a3e4305b5
+  data.tar.gz: f2f8d542f5a5c34dd13a3bc882f91cef9f526b90c0559ce71d608ab47d529b6c9b11ed24b7946589ff4c9b1dd7e7e13dce5426701cff395d97af54e494c86181

data/.yardopts

@@ -0,0 +1,13 @@
+--hide-void-return
+--no-private
+--verbose
+--title=google-apis-pubsub_v1
+--markup-provider=redcarpet
+--markup=markdown
+--main OVERVIEW.md
+lib/google/apis/pubsub_v1/*.rb
+lib/google/apis/pubsub_v1.rb
+-
+OVERVIEW.md
+CHANGELOG.md
+LICENSE.md

data/CHANGELOG.md

@@ -0,0 +1,7 @@
+# Release history for google-apis-pubsub_v1
+
+### v0.1.0 (2021-01-07)
+
+* Regenerated using generator version 0.1.1
+* Regenerated from discovery document revision 20201201
+

data/LICENSE.md

@@ -0,0 +1,202 @@
+
+                                  Apache License
+                            Version 2.0, January 2004
+                         http://www.apache.org/licenses/
+
+    TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+    1. Definitions.
+
+       "License" shall mean the terms and conditions for use, reproduction,
+       and distribution as defined by Sections 1 through 9 of this document.
+
+       "Licensor" shall mean the copyright owner or entity authorized by
+       the copyright owner that is granting the License.
+
+       "Legal Entity" shall mean the union of the acting entity and all
+       other entities that control, are controlled by, or are under common
+       control with that entity. For the purposes of this definition,
+       "control" means (i) the power, direct or indirect, to cause the
+       direction or management of such entity, whether by contract or
+       otherwise, or (ii) ownership of fifty percent (50%) or more of the
+       outstanding shares, or (iii) beneficial ownership of such entity.
+
+       "You" (or "Your") shall mean an individual or Legal Entity
+       exercising permissions granted by this License.
+
+       "Source" form shall mean the preferred form for making modifications,
+       including but not limited to software source code, documentation
+       source, and configuration files.
+
+       "Object" form shall mean any form resulting from mechanical
+       transformation or translation of a Source form, including but
+       not limited to compiled object code, generated documentation,
+       and conversions to other media types.
+
+       "Work" shall mean the work of authorship, whether in Source or
+       Object form, made available under the License, as indicated by a
+       copyright notice that is included in or attached to the work
+       (an example is provided in the Appendix below).
+
+       "Derivative Works" shall mean any work, whether in Source or Object
+       form, that is based on (or derived from) the Work and for which the
+       editorial revisions, annotations, elaborations, or other modifications
+       represent, as a whole, an original work of authorship. For the purposes
+       of this License, Derivative Works shall not include works that remain
+       separable from, or merely link (or bind by name) to the interfaces of,
+       the Work and Derivative Works thereof.
+
+       "Contribution" shall mean any work of authorship, including
+       the original version of the Work and any modifications or additions
+       to that Work or Derivative Works thereof, that is intentionally
+       submitted to Licensor for inclusion in the Work by the copyright owner
+       or by an individual or Legal Entity authorized to submit on behalf of
+       the copyright owner. For the purposes of this definition, "submitted"
+       means any form of electronic, verbal, or written communication sent
+       to the Licensor or its representatives, including but not limited to
+       communication on electronic mailing lists, source code control systems,
+       and issue tracking systems that are managed by, or on behalf of, the
+       Licensor for the purpose of discussing and improving the Work, but
+       excluding communication that is conspicuously marked or otherwise
+       designated in writing by the copyright owner as "Not a Contribution."
+
+       "Contributor" shall mean Licensor and any individual or Legal Entity
+       on behalf of whom a Contribution has been received by Licensor and
+       subsequently incorporated within the Work.
+
+    2. Grant of Copyright License. Subject to the terms and conditions of
+       this License, each Contributor hereby grants to You a perpetual,
+       worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+       copyright license to reproduce, prepare Derivative Works of,
+       publicly display, publicly perform, sublicense, and distribute the
+       Work and such Derivative Works in Source or Object form.
+
+    3. Grant of Patent License. Subject to the terms and conditions of
+       this License, each Contributor hereby grants to You a perpetual,
+       worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+       (except as stated in this section) patent license to make, have made,
+       use, offer to sell, sell, import, and otherwise transfer the Work,
+       where such license applies only to those patent claims licensable
+       by such Contributor that are necessarily infringed by their
+       Contribution(s) alone or by combination of their Contribution(s)
+       with the Work to which such Contribution(s) was submitted. If You
+       institute patent litigation against any entity (including a
+       cross-claim or counterclaim in a lawsuit) alleging that the Work
+       or a Contribution incorporated within the Work constitutes direct
+       or contributory patent infringement, then any patent licenses
+       granted to You under this License for that Work shall terminate
+       as of the date such litigation is filed.
+
+    4. Redistribution. You may reproduce and distribute copies of the
+       Work or Derivative Works thereof in any medium, with or without
+       modifications, and in Source or Object form, provided that You
+       meet the following conditions:
+
+       (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+       (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+       (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+       (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+       You may add Your own copyright statement to Your modifications and
+       may provide additional or different license terms and conditions
+       for use, reproduction, or distribution of Your modifications, or
+       for any such Derivative Works as a whole, provided Your use,
+       reproduction, and distribution of the Work otherwise complies with
+       the conditions stated in this License.
+
+    5. Submission of Contributions. Unless You explicitly state otherwise,
+       any Contribution intentionally submitted for inclusion in the Work
+       by You to the Licensor shall be under the terms and conditions of
+       this License, without any additional terms or conditions.
+       Notwithstanding the above, nothing herein shall supersede or modify
+       the terms of any separate license agreement you may have executed
+       with Licensor regarding such Contributions.
+
+    6. Trademarks. This License does not grant permission to use the trade
+       names, trademarks, service marks, or product names of the Licensor,
+       except as required for reasonable and customary use in describing the
+       origin of the Work and reproducing the content of the NOTICE file.
+
+    7. Disclaimer of Warranty. Unless required by applicable law or
+       agreed to in writing, Licensor provides the Work (and each
+       Contributor provides its Contributions) on an "AS IS" BASIS,
+       WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+       implied, including, without limitation, any warranties or conditions
+       of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+       PARTICULAR PURPOSE. You are solely responsible for determining the
+       appropriateness of using or redistributing the Work and assume any
+       risks associated with Your exercise of permissions under this License.
+
+    8. Limitation of Liability. In no event and under no legal theory,
+       whether in tort (including negligence), contract, or otherwise,
+       unless required by applicable law (such as deliberate and grossly
+       negligent acts) or agreed to in writing, shall any Contributor be
+       liable to You for damages, including any direct, indirect, special,
+       incidental, or consequential damages of any character arising as a
+       result of this License or out of the use or inability to use the
+       Work (including but not limited to damages for loss of goodwill,
+       work stoppage, computer failure or malfunction, or any and all
+       other commercial damages or losses), even if such Contributor
+       has been advised of the possibility of such damages.
+
+    9. Accepting Warranty or Additional Liability. While redistributing
+       the Work or Derivative Works thereof, You may choose to offer,
+       and charge a fee for, acceptance of support, warranty, indemnity,
+       or other liability obligations and/or rights consistent with this
+       License. However, in accepting such obligations, You may act only
+       on Your own behalf and on Your sole responsibility, not on behalf
+       of any other Contributor, and only if You agree to indemnify,
+       defend, and hold each Contributor harmless for any liability
+       incurred by, or claims asserted against, such Contributor by reason
+       of your accepting any such warranty or additional liability.
+
+    END OF TERMS AND CONDITIONS
+
+    APPENDIX: How to apply the Apache License to your work.
+
+       To apply the Apache License to your work, attach the following
+       boilerplate notice, with the fields enclosed by brackets "[]"
+       replaced with your own identifying information. (Don't include
+       the brackets!)  The text should be enclosed in the appropriate
+       comment syntax for the file format. We also recommend that a
+       file or class name and description of purpose be included on the
+       same "printed page" as the copyright notice for easier
+       identification within third-party archives.
+
+    Copyright [yyyy] [name of copyright owner]
+
+    Licensed under the Apache License, Version 2.0 (the "License");
+    you may not use this file except in compliance with the License.
+    You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+    Unless required by applicable law or agreed to in writing, software
+    distributed under the License is distributed on an "AS IS" BASIS,
+    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+    See the License for the specific language governing permissions and
+    limitations under the License.

data/OVERVIEW.md

@@ -0,0 +1,96 @@
+# Simple REST client for version V1 of the Cloud Pub/Sub API
+
+This is a simple client library for version V1 of the Cloud Pub/Sub API. It provides:
+
+* A client object that connects to the HTTP/JSON REST endpoint for the service.
+* Ruby objects for data structures related to the service.
+* Integration with the googleauth gem for authentication using OAuth, API keys, and service accounts.
+* Control of retry, pagination, and timeouts.
+
+Note that although this client library is supported and will continue to be updated to track changes to the service, it is otherwise considered complete and not under active development. Many Google services, especially Google Cloud Platform services, may provide a more modern client that is under more active development and improvement. See the section below titled *Which client should I use?* for more information.
+
+## Getting started
+
+### Before you begin
+
+There are a few setup steps you need to complete before you can use this library:
+
+ 1. If you don't already have a Google account, [sign up](https://www.google.com/accounts).
+ 2. If you have never created a Google APIs Console project, read about [Managing Projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects) and create a project in the [Google API Console](https://console.cloud.google.com/).
+ 3. Most APIs need to be enabled for your project. [Enable it](https://console.cloud.google.com/apis/library/pubsub.googleapis.com) in the console.
+
+### Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'google-apis-pubsub_v1', '~> 0.1'
+```
+
+And then execute:
+
+```
+$ bundle
+```
+
+Or install it yourself as:
+
+```
+$ gem install google-apis-pubsub_v1
+```
+
+### Creating a client object
+
+Once the gem is installed, you can load the client code and instantiate a client.
+
+```ruby
+# Load the client
+require "google/apis/pubsub_v1"
+
+# Create a client object
+client = Google::Apis::PubsubV1::PubsubService.new
+
+# Authenticate calls
+client.authentication = # ... use the googleauth gem to create credentials
+```
+
+See the class reference docs for information on the methods you can call from a client.
+
+## Documentation
+
+More detailed descriptions of the Google simple REST clients are available in two documents.
+
+ *  The [Usage Guide](https://github.com/googleapis/google-api-ruby-client/blob/master/docs/usage-guide.md) discusses how to make API calls, how to use the provided data structures, and how to work the various features of the client library, including media upload and download, error handling, retries, pagination, and logging.
+ *  The [Auth Guide](https://github.com/googleapis/google-api-ruby-client/blob/master/docs/auth-guide.md) discusses authentication in the client libraries, including API keys, OAuth 2.0, service accounts, and environment variables.
+
+(Note: the above documents are written for the simple REST clients in general, and their examples may not reflect the Pubsub service in particular.)
+
+For reference information on specific calls in the Cloud Pub/Sub API, see the {Google::Apis::PubsubV1::PubsubService class reference docs}.
+
+## Which client should I use?
+
+Google provides two types of Ruby API client libraries: **simple REST clients** and **modern clients**.
+
+This library, `google-apis-pubsub_v1`, is a simple REST client. You can identify these clients by their gem names, which are always in the form `google-apis-<servicename>_<serviceversion>`. The simple REST clients connect to HTTP/JSON REST endpoints and are automatically generated from service discovery documents. They support most API functionality, but their class interfaces are sometimes awkward.
+
+Modern clients are produced by a modern code generator, sometimes combined with hand-crafted functionality. Most modern clients connect to high-performance gRPC endpoints, although a few are backed by REST services. Modern clients are available for many Google services, especially Google Cloud Platform services, but do not yet support all the services covered by the simple clients.
+
+Gem names for modern clients are often of the form `google-cloud-<service_name>`. (For example, [google-cloud-pubsub](https://rubygems.org/gems/google-cloud-pubsub).) Note that most modern clients also have corresponding "versioned" gems with names like `google-cloud-<service_name>-<version>`. (For example, [google-cloud-pubsub-v1](https://rubygems.org/gems/google-cloud-pubsub-v1).) The "versioned" gems can be used directly, but often provide lower-level interfaces. In most cases, the main gem is recommended.
+
+**For most users, we recommend the modern client, if one is available.** Compared with simple clients, modern clients are generally much easier to use and more Ruby-like, support more advanced features such as streaming and long-running operations, and often provide much better performance. You may consider using a simple client instead, if a modern client is not yet available for the service you want to use, or if you are not able to use gRPC on your infrastructure.
+
+The [product documentation](https://cloud.google.com/pubsub/docs) may provide guidance regarding the preferred client library to use.
+
+## Supported Ruby versions
+
+This library is supported on Ruby 2.5+.
+
+Google provides official support for Ruby versions that are actively supported by Ruby Core -- that is, Ruby versions that are either in normal maintenance or in security maintenance, and not end of life. Currently, this means Ruby 2.5 and later. Older versions of Ruby _may_ still work, but are unsupported and not recommended. See https://www.ruby-lang.org/en/downloads/branches/ for details about the Ruby support schedule.
+
+## License
+
+This library is licensed under Apache 2.0. Full license text is available in the {file:LICENSE.md LICENSE}.
+
+## Support
+
+Please [report bugs at the project on Github](https://github.com/google/google-api-ruby-client/issues). Don't hesitate to [ask questions](http://stackoverflow.com/questions/tagged/google-api-ruby-client) about the client or APIs on [StackOverflow](http://stackoverflow.com).

data/lib/google-apis-pubsub_v1.rb

@@ -0,0 +1,15 @@
+# Copyright 2020 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require "google/apis/pubsub_v1"

data/lib/google/apis/pubsub_v1.rb

@@ -0,0 +1,39 @@
+# Copyright 2020 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require 'google/apis/pubsub_v1/service.rb'
+require 'google/apis/pubsub_v1/classes.rb'
+require 'google/apis/pubsub_v1/representations.rb'
+require 'google/apis/pubsub_v1/gem_version.rb'
+
+module Google
+  module Apis
+    # Cloud Pub/Sub API
+    #
+    # Provides reliable, many-to-many, asynchronous messaging between applications.
+    #
+    # @see https://cloud.google.com/pubsub/docs
+    module PubsubV1
+      # Version of the Cloud Pub/Sub API this client connects to.
+      # This is NOT the gem version.
+      VERSION = 'V1'
+
+      # View and manage your data across Google Cloud Platform services
+      AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform'
+
+      # View and manage Pub/Sub topics and subscriptions
+      AUTH_PUBSUB = 'https://www.googleapis.com/auth/pubsub'
+    end
+  end
+end

data/lib/google/apis/pubsub_v1/classes.rb

@@ -0,0 +1,1362 @@
+# Copyright 2020 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require 'date'
+require 'google/apis/core/base_service'
+require 'google/apis/core/json_representation'
+require 'google/apis/core/hashable'
+require 'google/apis/errors'
+
+module Google
+  module Apis
+    module PubsubV1
+      
+      # Request for the Acknowledge method.
+      class AcknowledgeRequest
+        include Google::Apis::Core::Hashable
+      
+        # Required. The acknowledgment ID for the messages being acknowledged that was
+        # returned by the Pub/Sub system in the `Pull` response. Must not be empty.
+        # Corresponds to the JSON property `ackIds`
+        # @return [Array<String>]
+        attr_accessor :ack_ids
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @ack_ids = args[:ack_ids] if args.key?(:ack_ids)
+        end
+      end
+      
+      # Associates `members` with a `role`.
+      class Binding
+        include Google::Apis::Core::Hashable
+      
+        # Represents a textual expression in the Common Expression Language (CEL) syntax.
+        # CEL is a C-like expression language. The syntax and semantics of CEL are
+        # documented at https://github.com/google/cel-spec. Example (Comparison): title:
+        # "Summary size limit" description: "Determines if a summary is less than 100
+        # chars" expression: "document.summary.size() < 100" Example (Equality): title: "
+        # Requestor is owner" description: "Determines if requestor is the document
+        # owner" expression: "document.owner == request.auth.claims.email" Example (
+        # Logic): title: "Public documents" description: "Determine whether the document
+        # should be publicly visible" expression: "document.type != 'private' &&
+        # document.type != 'internal'" Example (Data Manipulation): title: "Notification
+        # string" description: "Create a notification string with a timestamp."
+        # expression: "'New message received at ' + string(document.create_time)" The
+        # exact variables and functions that may be referenced within an expression are
+        # determined by the service that evaluates it. See the service documentation for
+        # additional information.
+        # Corresponds to the JSON property `condition`
+        # @return [Google::Apis::PubsubV1::Expr]
+        attr_accessor :condition
+      
+        # Specifies the identities requesting access for a Cloud Platform resource. `
+        # members` can have the following values: * `allUsers`: A special identifier
+        # that represents anyone who is on the internet; with or without a Google
+        # account. * `allAuthenticatedUsers`: A special identifier that represents
+        # anyone who is authenticated with a Google account or a service account. * `
+        # user:`emailid``: An email address that represents a specific Google account.
+        # For example, `alice@example.com` . * `serviceAccount:`emailid``: An email
+        # address that represents a service account. For example, `my-other-app@appspot.
+        # gserviceaccount.com`. * `group:`emailid``: An email address that represents a
+        # Google group. For example, `admins@example.com`. * `deleted:user:`emailid`?uid=
+        # `uniqueid``: An email address (plus unique identifier) representing a user
+        # that has been recently deleted. For example, `alice@example.com?uid=
+        # 123456789012345678901`. If the user is recovered, this value reverts to `user:`
+        # emailid`` and the recovered user retains the role in the binding. * `deleted:
+        # serviceAccount:`emailid`?uid=`uniqueid``: An email address (plus unique
+        # identifier) representing a service account that has been recently deleted. For
+        # example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`.
+        # If the service account is undeleted, this value reverts to `serviceAccount:`
+        # emailid`` and the undeleted service account retains the role in the binding. *
+        # `deleted:group:`emailid`?uid=`uniqueid``: An email address (plus unique
+        # identifier) representing a Google group that has been recently deleted. For
+        # example, `admins@example.com?uid=123456789012345678901`. If the group is
+        # recovered, this value reverts to `group:`emailid`` and the recovered group
+        # retains the role in the binding. * `domain:`domain``: The G Suite domain (
+        # primary) that represents all the users of that domain. For example, `google.
+        # com` or `example.com`.
+        # Corresponds to the JSON property `members`
+        # @return [Array<String>]
+        attr_accessor :members
+      
+        # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`
+        # , or `roles/owner`.
+        # Corresponds to the JSON property `role`
+        # @return [String]
+        attr_accessor :role
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @condition = args[:condition] if args.key?(:condition)
+          @members = args[:members] if args.key?(:members)
+          @role = args[:role] if args.key?(:role)
+        end
+      end
+      
+      # Request for the `CreateSnapshot` method.
+      class CreateSnapshotRequest
+        include Google::Apis::Core::Hashable
+      
+        # See Creating and managing labels.
+        # Corresponds to the JSON property `labels`
+        # @return [Hash<String,String>]
+        attr_accessor :labels
+      
+        # Required. The subscription whose backlog the snapshot retains. Specifically,
+        # the created snapshot is guaranteed to retain: (a) The existing backlog on the
+        # subscription. More precisely, this is defined as the messages in the
+        # subscription's backlog that are unacknowledged upon the successful completion
+        # of the `CreateSnapshot` request; as well as: (b) Any messages published to the
+        # subscription's topic following the successful completion of the CreateSnapshot
+        # request. Format is `projects/`project`/subscriptions/`sub``.
+        # Corresponds to the JSON property `subscription`
+        # @return [String]
+        attr_accessor :subscription
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @labels = args[:labels] if args.key?(:labels)
+          @subscription = args[:subscription] if args.key?(:subscription)
+        end
+      end
+      
+      # Dead lettering is done on a best effort basis. The same message might be dead
+      # lettered multiple times. If validation on any of the fields fails at
+      # subscription creation/updation, the create/update subscription request will
+      # fail.
+      class DeadLetterPolicy
+        include Google::Apis::Core::Hashable
+      
+        # The name of the topic to which dead letter messages should be published.
+        # Format is `projects/`project`/topics/`topic``.The Cloud Pub/Sub service
+        # account associated with the enclosing subscription's parent project (i.e.,
+        # service-`project_number`@gcp-sa-pubsub.iam.gserviceaccount.com) must have
+        # permission to Publish() to this topic. The operation will fail if the topic
+        # does not exist. Users should ensure that there is a subscription attached to
+        # this topic since messages published to a topic with no subscriptions are lost.
+        # Corresponds to the JSON property `deadLetterTopic`
+        # @return [String]
+        attr_accessor :dead_letter_topic
+      
+        # The maximum number of delivery attempts for any message. The value must be
+        # between 5 and 100. The number of delivery attempts is defined as 1 + (the sum
+        # of number of NACKs and number of times the acknowledgement deadline has been
+        # exceeded for the message). A NACK is any call to ModifyAckDeadline with a 0
+        # deadline. Note that client libraries may automatically extend ack_deadlines.
+        # This field will be honored on a best effort basis. If this parameter is 0, a
+        # default value of 5 is used.
+        # Corresponds to the JSON property `maxDeliveryAttempts`
+        # @return [Fixnum]
+        attr_accessor :max_delivery_attempts
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @dead_letter_topic = args[:dead_letter_topic] if args.key?(:dead_letter_topic)
+          @max_delivery_attempts = args[:max_delivery_attempts] if args.key?(:max_delivery_attempts)
+        end
+      end
+      
+      # Response for the DetachSubscription method. Reserved for future use.
+      class DetachSubscriptionResponse
+        include Google::Apis::Core::Hashable
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+        end
+      end
+      
+      # A generic empty message that you can re-use to avoid defining duplicated empty
+      # messages in your APIs. A typical example is to use it as the request or the
+      # response type of an API method. For instance: service Foo ` rpc Bar(google.
+      # protobuf.Empty) returns (google.protobuf.Empty); ` The JSON representation for
+      # `Empty` is empty JSON object ````.
+      class Empty
+        include Google::Apis::Core::Hashable
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+        end
+      end
+      
+      # A policy that specifies the conditions for resource expiration (i.e.,
+      # automatic resource deletion).
+      class ExpirationPolicy
+        include Google::Apis::Core::Hashable
+      
+        # Specifies the "time-to-live" duration for an associated resource. The resource
+        # expires if it is not active for a period of `ttl`. The definition of "activity"
+        # depends on the type of the associated resource. The minimum and maximum
+        # allowed values for `ttl` depend on the type of the associated resource, as
+        # well. If `ttl` is not set, the associated resource never expires.
+        # Corresponds to the JSON property `ttl`
+        # @return [String]
+        attr_accessor :ttl
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @ttl = args[:ttl] if args.key?(:ttl)
+        end
+      end
+      
+      # Represents a textual expression in the Common Expression Language (CEL) syntax.
+      # CEL is a C-like expression language. The syntax and semantics of CEL are
+      # documented at https://github.com/google/cel-spec. Example (Comparison): title:
+      # "Summary size limit" description: "Determines if a summary is less than 100
+      # chars" expression: "document.summary.size() < 100" Example (Equality): title: "
+      # Requestor is owner" description: "Determines if requestor is the document
+      # owner" expression: "document.owner == request.auth.claims.email" Example (
+      # Logic): title: "Public documents" description: "Determine whether the document
+      # should be publicly visible" expression: "document.type != 'private' &&
+      # document.type != 'internal'" Example (Data Manipulation): title: "Notification
+      # string" description: "Create a notification string with a timestamp."
+      # expression: "'New message received at ' + string(document.create_time)" The
+      # exact variables and functions that may be referenced within an expression are
+      # determined by the service that evaluates it. See the service documentation for
+      # additional information.
+      class Expr
+        include Google::Apis::Core::Hashable
+      
+        # Optional. Description of the expression. This is a longer text which describes
+        # the expression, e.g. when hovered over it in a UI.
+        # Corresponds to the JSON property `description`
+        # @return [String]
+        attr_accessor :description
+      
+        # Textual representation of an expression in Common Expression Language syntax.
+        # Corresponds to the JSON property `expression`
+        # @return [String]
+        attr_accessor :expression
+      
+        # Optional. String indicating the location of the expression for error reporting,
+        # e.g. a file name and a position in the file.
+        # Corresponds to the JSON property `location`
+        # @return [String]
+        attr_accessor :location
+      
+        # Optional. Title for the expression, i.e. a short string describing its purpose.
+        # This can be used e.g. in UIs which allow to enter the expression.
+        # Corresponds to the JSON property `title`
+        # @return [String]
+        attr_accessor :title
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @description = args[:description] if args.key?(:description)
+          @expression = args[:expression] if args.key?(:expression)
+          @location = args[:location] if args.key?(:location)
+          @title = args[:title] if args.key?(:title)
+        end
+      end
+      
+      # Response for the `ListSnapshots` method.
+      class ListSnapshotsResponse
+        include Google::Apis::Core::Hashable
+      
+        # If not empty, indicates that there may be more snapshot that match the request;
+        # this value should be passed in a new `ListSnapshotsRequest`.
+        # Corresponds to the JSON property `nextPageToken`
+        # @return [String]
+        attr_accessor :next_page_token
+      
+        # The resulting snapshots.
+        # Corresponds to the JSON property `snapshots`
+        # @return [Array<Google::Apis::PubsubV1::Snapshot>]
+        attr_accessor :snapshots
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @next_page_token = args[:next_page_token] if args.key?(:next_page_token)
+          @snapshots = args[:snapshots] if args.key?(:snapshots)
+        end
+      end
+      
+      # Response for the `ListSubscriptions` method.
+      class ListSubscriptionsResponse
+        include Google::Apis::Core::Hashable
+      
+        # If not empty, indicates that there may be more subscriptions that match the
+        # request; this value should be passed in a new `ListSubscriptionsRequest` to
+        # get more subscriptions.
+        # Corresponds to the JSON property `nextPageToken`
+        # @return [String]
+        attr_accessor :next_page_token
+      
+        # The subscriptions that match the request.
+        # Corresponds to the JSON property `subscriptions`
+        # @return [Array<Google::Apis::PubsubV1::Subscription>]
+        attr_accessor :subscriptions
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @next_page_token = args[:next_page_token] if args.key?(:next_page_token)
+          @subscriptions = args[:subscriptions] if args.key?(:subscriptions)
+        end
+      end
+      
+      # Response for the `ListTopicSnapshots` method.
+      class ListTopicSnapshotsResponse
+        include Google::Apis::Core::Hashable
+      
+        # If not empty, indicates that there may be more snapshots that match the
+        # request; this value should be passed in a new `ListTopicSnapshotsRequest` to
+        # get more snapshots.
+        # Corresponds to the JSON property `nextPageToken`
+        # @return [String]
+        attr_accessor :next_page_token
+      
+        # The names of the snapshots that match the request.
+        # Corresponds to the JSON property `snapshots`
+        # @return [Array<String>]
+        attr_accessor :snapshots
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @next_page_token = args[:next_page_token] if args.key?(:next_page_token)
+          @snapshots = args[:snapshots] if args.key?(:snapshots)
+        end
+      end
+      
+      # Response for the `ListTopicSubscriptions` method.
+      class ListTopicSubscriptionsResponse
+        include Google::Apis::Core::Hashable
+      
+        # If not empty, indicates that there may be more subscriptions that match the
+        # request; this value should be passed in a new `ListTopicSubscriptionsRequest`
+        # to get more subscriptions.
+        # Corresponds to the JSON property `nextPageToken`
+        # @return [String]
+        attr_accessor :next_page_token
+      
+        # The names of subscriptions attached to the topic specified in the request.
+        # Corresponds to the JSON property `subscriptions`
+        # @return [Array<String>]
+        attr_accessor :subscriptions
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @next_page_token = args[:next_page_token] if args.key?(:next_page_token)
+          @subscriptions = args[:subscriptions] if args.key?(:subscriptions)
+        end
+      end
+      
+      # Response for the `ListTopics` method.
+      class ListTopicsResponse
+        include Google::Apis::Core::Hashable
+      
+        # If not empty, indicates that there may be more topics that match the request;
+        # this value should be passed in a new `ListTopicsRequest`.
+        # Corresponds to the JSON property `nextPageToken`
+        # @return [String]
+        attr_accessor :next_page_token
+      
+        # The resulting topics.
+        # Corresponds to the JSON property `topics`
+        # @return [Array<Google::Apis::PubsubV1::Topic>]
+        attr_accessor :topics
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @next_page_token = args[:next_page_token] if args.key?(:next_page_token)
+          @topics = args[:topics] if args.key?(:topics)
+        end
+      end
+      
+      # A policy constraining the storage of messages published to the topic.
+      class MessageStoragePolicy
+        include Google::Apis::Core::Hashable
+      
+        # A list of IDs of GCP regions where messages that are published to the topic
+        # may be persisted in storage. Messages published by publishers running in non-
+        # allowed GCP regions (or running outside of GCP altogether) will be routed for
+        # storage in one of the allowed regions. An empty list means that no regions are
+        # allowed, and is not a valid configuration.
+        # Corresponds to the JSON property `allowedPersistenceRegions`
+        # @return [Array<String>]
+        attr_accessor :allowed_persistence_regions
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @allowed_persistence_regions = args[:allowed_persistence_regions] if args.key?(:allowed_persistence_regions)
+        end
+      end
+      
+      # Request for the ModifyAckDeadline method.
+      class ModifyAckDeadlineRequest
+        include Google::Apis::Core::Hashable
+      
+        # Required. The new ack deadline with respect to the time this request was sent
+        # to the Pub/Sub system. For example, if the value is 10, the new ack deadline
+        # will expire 10 seconds after the `ModifyAckDeadline` call was made. Specifying
+        # zero might immediately make the message available for delivery to another
+        # subscriber client. This typically results in an increase in the rate of
+        # message redeliveries (that is, duplicates). The minimum deadline you can
+        # specify is 0 seconds. The maximum deadline you can specify is 600 seconds (10
+        # minutes).
+        # Corresponds to the JSON property `ackDeadlineSeconds`
+        # @return [Fixnum]
+        attr_accessor :ack_deadline_seconds
+      
+        # Required. List of acknowledgment IDs.
+        # Corresponds to the JSON property `ackIds`
+        # @return [Array<String>]
+        attr_accessor :ack_ids
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @ack_deadline_seconds = args[:ack_deadline_seconds] if args.key?(:ack_deadline_seconds)
+          @ack_ids = args[:ack_ids] if args.key?(:ack_ids)
+        end
+      end
+      
+      # Request for the ModifyPushConfig method.
+      class ModifyPushConfigRequest
+        include Google::Apis::Core::Hashable
+      
+        # Configuration for a push delivery endpoint.
+        # Corresponds to the JSON property `pushConfig`
+        # @return [Google::Apis::PubsubV1::PushConfig]
+        attr_accessor :push_config
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @push_config = args[:push_config] if args.key?(:push_config)
+        end
+      end
+      
+      # Contains information needed for generating an [OpenID Connect token](https://
+      # developers.google.com/identity/protocols/OpenIDConnect).
+      class OidcToken
+        include Google::Apis::Core::Hashable
+      
+        # Audience to be used when generating OIDC token. The audience claim identifies
+        # the recipients that the JWT is intended for. The audience value is a single
+        # case-sensitive string. Having multiple values (array) for the audience field
+        # is not supported. More info about the OIDC JWT token audience here: https://
+        # tools.ietf.org/html/rfc7519#section-4.1.3 Note: if not specified, the Push
+        # endpoint URL will be used.
+        # Corresponds to the JSON property `audience`
+        # @return [String]
+        attr_accessor :audience
+      
+        # [Service account email](https://cloud.google.com/iam/docs/service-accounts) to
+        # be used for generating the OIDC token. The caller (for CreateSubscription,
+        # UpdateSubscription, and ModifyPushConfig RPCs) must have the iam.
+        # serviceAccounts.actAs permission for the service account.
+        # Corresponds to the JSON property `serviceAccountEmail`
+        # @return [String]
+        attr_accessor :service_account_email
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @audience = args[:audience] if args.key?(:audience)
+          @service_account_email = args[:service_account_email] if args.key?(:service_account_email)
+        end
+      end
+      
+      # An Identity and Access Management (IAM) policy, which specifies access
+      # controls for Google Cloud resources. A `Policy` is a collection of `bindings`.
+      # A `binding` binds one or more `members` to a single `role`. Members can be
+      # user accounts, service accounts, Google groups, and domains (such as G Suite).
+      # A `role` is a named list of permissions; each `role` can be an IAM predefined
+      # role or a user-created custom role. For some types of Google Cloud resources,
+      # a `binding` can also specify a `condition`, which is a logical expression that
+      # allows access to a resource only if the expression evaluates to `true`. A
+      # condition can add constraints based on attributes of the request, the resource,
+      # or both. To learn which resources support conditions in their IAM policies,
+      # see the [IAM documentation](https://cloud.google.com/iam/help/conditions/
+      # resource-policies). **JSON example:** ` "bindings": [ ` "role": "roles/
+      # resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "
+      # group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@
+      # appspot.gserviceaccount.com" ] `, ` "role": "roles/resourcemanager.
+      # organizationViewer", "members": [ "user:eve@example.com" ], "condition": ` "
+      # title": "expirable access", "description": "Does not grant access after Sep
+      # 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", `
+      # ` ], "etag": "BwWWja0YfJA=", "version": 3 ` **YAML example:** bindings: -
+      # members: - user:mike@example.com - group:admins@example.com - domain:google.
+      # com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/
+      # resourcemanager.organizationAdmin - members: - user:eve@example.com role:
+      # roles/resourcemanager.organizationViewer condition: title: expirable access
+      # description: Does not grant access after Sep 2020 expression: request.time <
+      # timestamp('2020-10-01T00:00:00.000Z') - etag: BwWWja0YfJA= - version: 3 For a
+      # description of IAM and its features, see the [IAM documentation](https://cloud.
+      # google.com/iam/docs/).
+      class Policy
+        include Google::Apis::Core::Hashable
+      
+        # Associates a list of `members` to a `role`. Optionally, may specify a `
+        # condition` that determines how and when the `bindings` are applied. Each of
+        # the `bindings` must contain at least one member.
+        # Corresponds to the JSON property `bindings`
+        # @return [Array<Google::Apis::PubsubV1::Binding>]
+        attr_accessor :bindings
+      
+        # `etag` is used for optimistic concurrency control as a way to help prevent
+        # simultaneous updates of a policy from overwriting each other. It is strongly
+        # suggested that systems make use of the `etag` in the read-modify-write cycle
+        # to perform policy updates in order to avoid race conditions: An `etag` is
+        # returned in the response to `getIamPolicy`, and systems are expected to put
+        # that etag in the request to `setIamPolicy` to ensure that their change will be
+        # applied to the same version of the policy. **Important:** If you use IAM
+        # Conditions, you must include the `etag` field whenever you call `setIamPolicy`.
+        # If you omit this field, then IAM allows you to overwrite a version `3` policy
+        # with a version `1` policy, and all of the conditions in the version `3` policy
+        # are lost.
+        # Corresponds to the JSON property `etag`
+        # NOTE: Values are automatically base64 encoded/decoded in the client library.
+        # @return [String]
+        attr_accessor :etag
+      
+        # Specifies the format of the policy. Valid values are `0`, `1`, and `3`.
+        # Requests that specify an invalid value are rejected. Any operation that
+        # affects conditional role bindings must specify version `3`. This requirement
+        # applies to the following operations: * Getting a policy that includes a
+        # conditional role binding * Adding a conditional role binding to a policy *
+        # Changing a conditional role binding in a policy * Removing any role binding,
+        # with or without a condition, from a policy that includes conditions **
+        # Important:** If you use IAM Conditions, you must include the `etag` field
+        # whenever you call `setIamPolicy`. If you omit this field, then IAM allows you
+        # to overwrite a version `3` policy with a version `1` policy, and all of the
+        # conditions in the version `3` policy are lost. If a policy does not include
+        # any conditions, operations on that policy may specify any valid version or
+        # leave the field unset. To learn which resources support conditions in their
+        # IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/
+        # conditions/resource-policies).
+        # Corresponds to the JSON property `version`
+        # @return [Fixnum]
+        attr_accessor :version
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @bindings = args[:bindings] if args.key?(:bindings)
+          @etag = args[:etag] if args.key?(:etag)
+          @version = args[:version] if args.key?(:version)
+        end
+      end
+      
+      # Request for the Publish method.
+      class PublishRequest
+        include Google::Apis::Core::Hashable
+      
+        # Required. The messages to publish.
+        # Corresponds to the JSON property `messages`
+        # @return [Array<Google::Apis::PubsubV1::Message>]
+        attr_accessor :messages
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @messages = args[:messages] if args.key?(:messages)
+        end
+      end
+      
+      # Response for the `Publish` method.
+      class PublishResponse
+        include Google::Apis::Core::Hashable
+      
+        # The server-assigned ID of each published message, in the same order as the
+        # messages in the request. IDs are guaranteed to be unique within the topic.
+        # Corresponds to the JSON property `messageIds`
+        # @return [Array<String>]
+        attr_accessor :message_ids
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @message_ids = args[:message_ids] if args.key?(:message_ids)
+        end
+      end
+      
+      # A message that is published by publishers and consumed by subscribers. The
+      # message must contain either a non-empty data field or at least one attribute.
+      # Note that client libraries represent this object differently depending on the
+      # language. See the corresponding [client library documentation](https://cloud.
+      # google.com/pubsub/docs/reference/libraries) for more information. See [quotas
+      # and limits] (https://cloud.google.com/pubsub/quotas) for more information
+      # about message limits.
+      class Message
+        include Google::Apis::Core::Hashable
+      
+        # Attributes for this message. If this field is empty, the message must contain
+        # non-empty data. This can be used to filter messages on the subscription.
+        # Corresponds to the JSON property `attributes`
+        # @return [Hash<String,String>]
+        attr_accessor :attributes
+      
+        # The message data field. If this field is empty, the message must contain at
+        # least one attribute.
+        # Corresponds to the JSON property `data`
+        # NOTE: Values are automatically base64 encoded/decoded in the client library.
+        # @return [String]
+        attr_accessor :data
+      
+        # ID of this message, assigned by the server when the message is published.
+        # Guaranteed to be unique within the topic. This value may be read by a
+        # subscriber that receives a `PubsubMessage` via a `Pull` call or a push
+        # delivery. It must not be populated by the publisher in a `Publish` call.
+        # Corresponds to the JSON property `messageId`
+        # @return [String]
+        attr_accessor :message_id
+      
+        # If non-empty, identifies related messages for which publish order should be
+        # respected. If a `Subscription` has `enable_message_ordering` set to `true`,
+        # messages published with the same non-empty `ordering_key` value will be
+        # delivered to subscribers in the order in which they are received by the Pub/
+        # Sub system. All `PubsubMessage`s published in a given `PublishRequest` must
+        # specify the same `ordering_key` value.
+        # Corresponds to the JSON property `orderingKey`
+        # @return [String]
+        attr_accessor :ordering_key
+      
+        # The time at which the message was published, populated by the server when it
+        # receives the `Publish` call. It must not be populated by the publisher in a `
+        # Publish` call.
+        # Corresponds to the JSON property `publishTime`
+        # @return [String]
+        attr_accessor :publish_time
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @attributes = args[:attributes] if args.key?(:attributes)
+          @data = args[:data] if args.key?(:data)
+          @message_id = args[:message_id] if args.key?(:message_id)
+          @ordering_key = args[:ordering_key] if args.key?(:ordering_key)
+          @publish_time = args[:publish_time] if args.key?(:publish_time)
+        end
+      end
+      
+      # Request for the `Pull` method.
+      class PullRequest
+        include Google::Apis::Core::Hashable
+      
+        # Required. The maximum number of messages to return for this request. Must be a
+        # positive integer. The Pub/Sub system may return fewer than the number
+        # specified.
+        # Corresponds to the JSON property `maxMessages`
+        # @return [Fixnum]
+        attr_accessor :max_messages
+      
+        # Optional. If this field set to true, the system will respond immediately even
+        # if it there are no messages available to return in the `Pull` response.
+        # Otherwise, the system may wait (for a bounded amount of time) until at least
+        # one message is available, rather than returning no messages. Warning: setting
+        # this field to `true` is discouraged because it adversely impacts the
+        # performance of `Pull` operations. We recommend that users do not set this
+        # field.
+        # Corresponds to the JSON property `returnImmediately`
+        # @return [Boolean]
+        attr_accessor :return_immediately
+        alias_method :return_immediately?, :return_immediately
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @max_messages = args[:max_messages] if args.key?(:max_messages)
+          @return_immediately = args[:return_immediately] if args.key?(:return_immediately)
+        end
+      end
+      
+      # Response for the `Pull` method.
+      class PullResponse
+        include Google::Apis::Core::Hashable
+      
+        # Received Pub/Sub messages. The list will be empty if there are no more
+        # messages available in the backlog. For JSON, the response can be entirely
+        # empty. The Pub/Sub system may return fewer than the `maxMessages` requested
+        # even if there are more messages available in the backlog.
+        # Corresponds to the JSON property `receivedMessages`
+        # @return [Array<Google::Apis::PubsubV1::ReceivedMessage>]
+        attr_accessor :received_messages
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @received_messages = args[:received_messages] if args.key?(:received_messages)
+        end
+      end
+      
+      # Configuration for a push delivery endpoint.
+      class PushConfig
+        include Google::Apis::Core::Hashable
+      
+        # Endpoint configuration attributes that can be used to control different
+        # aspects of the message delivery. The only currently supported attribute is `x-
+        # goog-version`, which you can use to change the format of the pushed message.
+        # This attribute indicates the version of the data expected by the endpoint.
+        # This controls the shape of the pushed message (i.e., its fields and metadata).
+        # If not present during the `CreateSubscription` call, it will default to the
+        # version of the Pub/Sub API used to make such call. If not present in a `
+        # ModifyPushConfig` call, its value will not be changed. `GetSubscription` calls
+        # will always return a valid version, even if the subscription was created
+        # without this attribute. The only supported values for the `x-goog-version`
+        # attribute are: * `v1beta1`: uses the push format defined in the v1beta1 Pub/
+        # Sub API. * `v1` or `v1beta2`: uses the push format defined in the v1 Pub/Sub
+        # API. For example: attributes ` "x-goog-version": "v1" `
+        # Corresponds to the JSON property `attributes`
+        # @return [Hash<String,String>]
+        attr_accessor :attributes
+      
+        # Contains information needed for generating an [OpenID Connect token](https://
+        # developers.google.com/identity/protocols/OpenIDConnect).
+        # Corresponds to the JSON property `oidcToken`
+        # @return [Google::Apis::PubsubV1::OidcToken]
+        attr_accessor :oidc_token
+      
+        # A URL locating the endpoint to which messages should be pushed. For example, a
+        # Webhook endpoint might use `https://example.com/push`.
+        # Corresponds to the JSON property `pushEndpoint`
+        # @return [String]
+        attr_accessor :push_endpoint
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @attributes = args[:attributes] if args.key?(:attributes)
+          @oidc_token = args[:oidc_token] if args.key?(:oidc_token)
+          @push_endpoint = args[:push_endpoint] if args.key?(:push_endpoint)
+        end
+      end
+      
+      # A message and its corresponding acknowledgment ID.
+      class ReceivedMessage
+        include Google::Apis::Core::Hashable
+      
+        # This ID can be used to acknowledge the received message.
+        # Corresponds to the JSON property `ackId`
+        # @return [String]
+        attr_accessor :ack_id
+      
+        # The approximate number of times that Cloud Pub/Sub has attempted to deliver
+        # the associated message to a subscriber. More precisely, this is 1 + (number of
+        # NACKs) + (number of ack_deadline exceeds) for this message. A NACK is any call
+        # to ModifyAckDeadline with a 0 deadline. An ack_deadline exceeds event is
+        # whenever a message is not acknowledged within ack_deadline. Note that
+        # ack_deadline is initially Subscription.ackDeadlineSeconds, but may get
+        # extended automatically by the client library. Upon the first delivery of a
+        # given message, `delivery_attempt` will have a value of 1. The value is
+        # calculated at best effort and is approximate. If a DeadLetterPolicy is not set
+        # on the subscription, this will be 0.
+        # Corresponds to the JSON property `deliveryAttempt`
+        # @return [Fixnum]
+        attr_accessor :delivery_attempt
+      
+        # A message that is published by publishers and consumed by subscribers. The
+        # message must contain either a non-empty data field or at least one attribute.
+        # Note that client libraries represent this object differently depending on the
+        # language. See the corresponding [client library documentation](https://cloud.
+        # google.com/pubsub/docs/reference/libraries) for more information. See [quotas
+        # and limits] (https://cloud.google.com/pubsub/quotas) for more information
+        # about message limits.
+        # Corresponds to the JSON property `message`
+        # @return [Google::Apis::PubsubV1::Message]
+        attr_accessor :message
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @ack_id = args[:ack_id] if args.key?(:ack_id)
+          @delivery_attempt = args[:delivery_attempt] if args.key?(:delivery_attempt)
+          @message = args[:message] if args.key?(:message)
+        end
+      end
+      
+      # A policy that specifies how Cloud Pub/Sub retries message delivery. Retry
+      # delay will be exponential based on provided minimum and maximum backoffs.
+      # https://en.wikipedia.org/wiki/Exponential_backoff. RetryPolicy will be
+      # triggered on NACKs or acknowledgement deadline exceeded events for a given
+      # message. Retry Policy is implemented on a best effort basis. At times, the
+      # delay between consecutive deliveries may not match the configuration. That is,
+      # delay can be more or less than configured backoff.
+      class RetryPolicy
+        include Google::Apis::Core::Hashable
+      
+        # The maximum delay between consecutive deliveries of a given message. Value
+        # should be between 0 and 600 seconds. Defaults to 600 seconds.
+        # Corresponds to the JSON property `maximumBackoff`
+        # @return [String]
+        attr_accessor :maximum_backoff
+      
+        # The minimum delay between consecutive deliveries of a given message. Value
+        # should be between 0 and 600 seconds. Defaults to 10 seconds.
+        # Corresponds to the JSON property `minimumBackoff`
+        # @return [String]
+        attr_accessor :minimum_backoff
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @maximum_backoff = args[:maximum_backoff] if args.key?(:maximum_backoff)
+          @minimum_backoff = args[:minimum_backoff] if args.key?(:minimum_backoff)
+        end
+      end
+      
+      # Request for the `Seek` method.
+      class SeekRequest
+        include Google::Apis::Core::Hashable
+      
+        # The snapshot to seek to. The snapshot's topic must be the same as that of the
+        # provided subscription. Format is `projects/`project`/snapshots/`snap``.
+        # Corresponds to the JSON property `snapshot`
+        # @return [String]
+        attr_accessor :snapshot
+      
+        # The time to seek to. Messages retained in the subscription that were published
+        # before this time are marked as acknowledged, and messages retained in the
+        # subscription that were published after this time are marked as unacknowledged.
+        # Note that this operation affects only those messages retained in the
+        # subscription (configured by the combination of `message_retention_duration`
+        # and `retain_acked_messages`). For example, if `time` corresponds to a point
+        # before the message retention window (or to a point before the system's notion
+        # of the subscription creation time), only retained messages will be marked as
+        # unacknowledged, and already-expunged messages will not be restored.
+        # Corresponds to the JSON property `time`
+        # @return [String]
+        attr_accessor :time
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @snapshot = args[:snapshot] if args.key?(:snapshot)
+          @time = args[:time] if args.key?(:time)
+        end
+      end
+      
+      # Response for the `Seek` method (this response is empty).
+      class SeekResponse
+        include Google::Apis::Core::Hashable
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+        end
+      end
+      
+      # Request message for `SetIamPolicy` method.
+      class SetIamPolicyRequest
+        include Google::Apis::Core::Hashable
+      
+        # An Identity and Access Management (IAM) policy, which specifies access
+        # controls for Google Cloud resources. A `Policy` is a collection of `bindings`.
+        # A `binding` binds one or more `members` to a single `role`. Members can be
+        # user accounts, service accounts, Google groups, and domains (such as G Suite).
+        # A `role` is a named list of permissions; each `role` can be an IAM predefined
+        # role or a user-created custom role. For some types of Google Cloud resources,
+        # a `binding` can also specify a `condition`, which is a logical expression that
+        # allows access to a resource only if the expression evaluates to `true`. A
+        # condition can add constraints based on attributes of the request, the resource,
+        # or both. To learn which resources support conditions in their IAM policies,
+        # see the [IAM documentation](https://cloud.google.com/iam/help/conditions/
+        # resource-policies). **JSON example:** ` "bindings": [ ` "role": "roles/
+        # resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "
+        # group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@
+        # appspot.gserviceaccount.com" ] `, ` "role": "roles/resourcemanager.
+        # organizationViewer", "members": [ "user:eve@example.com" ], "condition": ` "
+        # title": "expirable access", "description": "Does not grant access after Sep
+        # 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", `
+        # ` ], "etag": "BwWWja0YfJA=", "version": 3 ` **YAML example:** bindings: -
+        # members: - user:mike@example.com - group:admins@example.com - domain:google.
+        # com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/
+        # resourcemanager.organizationAdmin - members: - user:eve@example.com role:
+        # roles/resourcemanager.organizationViewer condition: title: expirable access
+        # description: Does not grant access after Sep 2020 expression: request.time <
+        # timestamp('2020-10-01T00:00:00.000Z') - etag: BwWWja0YfJA= - version: 3 For a
+        # description of IAM and its features, see the [IAM documentation](https://cloud.
+        # google.com/iam/docs/).
+        # Corresponds to the JSON property `policy`
+        # @return [Google::Apis::PubsubV1::Policy]
+        attr_accessor :policy
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @policy = args[:policy] if args.key?(:policy)
+        end
+      end
+      
+      # A snapshot resource. Snapshots are used in [Seek](https://cloud.google.com/
+      # pubsub/docs/replay-overview) operations, which allow you to manage message
+      # acknowledgments in bulk. That is, you can set the acknowledgment state of
+      # messages in an existing subscription to the state captured by a snapshot.
+      class Snapshot
+        include Google::Apis::Core::Hashable
+      
+        # The snapshot is guaranteed to exist up until this time. A newly-created
+        # snapshot expires no later than 7 days from the time of its creation. Its exact
+        # lifetime is determined at creation by the existing backlog in the source
+        # subscription. Specifically, the lifetime of the snapshot is `7 days - (age of
+        # oldest unacked message in the subscription)`. For example, consider a
+        # subscription whose oldest unacked message is 3 days old. If a snapshot is
+        # created from this subscription, the snapshot -- which will always capture this
+        # 3-day-old backlog as long as the snapshot exists -- will expire in 4 days. The
+        # service will refuse to create a snapshot that would expire in less than 1 hour
+        # after creation.
+        # Corresponds to the JSON property `expireTime`
+        # @return [String]
+        attr_accessor :expire_time
+      
+        # See [Creating and managing labels] (https://cloud.google.com/pubsub/docs/
+        # labels).
+        # Corresponds to the JSON property `labels`
+        # @return [Hash<String,String>]
+        attr_accessor :labels
+      
+        # The name of the snapshot.
+        # Corresponds to the JSON property `name`
+        # @return [String]
+        attr_accessor :name
+      
+        # The name of the topic from which this snapshot is retaining messages.
+        # Corresponds to the JSON property `topic`
+        # @return [String]
+        attr_accessor :topic
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @expire_time = args[:expire_time] if args.key?(:expire_time)
+          @labels = args[:labels] if args.key?(:labels)
+          @name = args[:name] if args.key?(:name)
+          @topic = args[:topic] if args.key?(:topic)
+        end
+      end
+      
+      # A subscription resource.
+      class Subscription
+        include Google::Apis::Core::Hashable
+      
+        # The approximate amount of time (on a best-effort basis) Pub/Sub waits for the
+        # subscriber to acknowledge receipt before resending the message. In the
+        # interval after the message is delivered and before it is acknowledged, it is
+        # considered to be *outstanding*. During that time period, the message will not
+        # be redelivered (on a best-effort basis). For pull subscriptions, this value is
+        # used as the initial value for the ack deadline. To override this value for a
+        # given message, call `ModifyAckDeadline` with the corresponding `ack_id` if
+        # using non-streaming pull or send the `ack_id` in a `
+        # StreamingModifyAckDeadlineRequest` if using streaming pull. The minimum custom
+        # deadline you can specify is 10 seconds. The maximum custom deadline you can
+        # specify is 600 seconds (10 minutes). If this parameter is 0, a default value
+        # of 10 seconds is used. For push delivery, this value is also used to set the
+        # request timeout for the call to the push endpoint. If the subscriber never
+        # acknowledges the message, the Pub/Sub system will eventually redeliver the
+        # message.
+        # Corresponds to the JSON property `ackDeadlineSeconds`
+        # @return [Fixnum]
+        attr_accessor :ack_deadline_seconds
+      
+        # Dead lettering is done on a best effort basis. The same message might be dead
+        # lettered multiple times. If validation on any of the fields fails at
+        # subscription creation/updation, the create/update subscription request will
+        # fail.
+        # Corresponds to the JSON property `deadLetterPolicy`
+        # @return [Google::Apis::PubsubV1::DeadLetterPolicy]
+        attr_accessor :dead_letter_policy
+      
+        # Indicates whether the subscription is detached from its topic. Detached
+        # subscriptions don't receive messages from their topic and don't retain any
+        # backlog. `Pull` and `StreamingPull` requests will return FAILED_PRECONDITION.
+        # If the subscription is a push subscription, pushes to the endpoint will not be
+        # made.
+        # Corresponds to the JSON property `detached`
+        # @return [Boolean]
+        attr_accessor :detached
+        alias_method :detached?, :detached
+      
+        # If true, messages published with the same `ordering_key` in `PubsubMessage`
+        # will be delivered to the subscribers in the order in which they are received
+        # by the Pub/Sub system. Otherwise, they may be delivered in any order.
+        # Corresponds to the JSON property `enableMessageOrdering`
+        # @return [Boolean]
+        attr_accessor :enable_message_ordering
+        alias_method :enable_message_ordering?, :enable_message_ordering
+      
+        # A policy that specifies the conditions for resource expiration (i.e.,
+        # automatic resource deletion).
+        # Corresponds to the JSON property `expirationPolicy`
+        # @return [Google::Apis::PubsubV1::ExpirationPolicy]
+        attr_accessor :expiration_policy
+      
+        # An expression written in the Pub/Sub [filter language](https://cloud.google.
+        # com/pubsub/docs/filtering). If non-empty, then only `PubsubMessage`s whose `
+        # attributes` field matches the filter are delivered on this subscription. If
+        # empty, then no messages are filtered out.
+        # Corresponds to the JSON property `filter`
+        # @return [String]
+        attr_accessor :filter
+      
+        # See Creating and managing labels.
+        # Corresponds to the JSON property `labels`
+        # @return [Hash<String,String>]
+        attr_accessor :labels
+      
+        # How long to retain unacknowledged messages in the subscription's backlog, from
+        # the moment a message is published. If `retain_acked_messages` is true, then
+        # this also configures the retention of acknowledged messages, and thus
+        # configures how far back in time a `Seek` can be done. Defaults to 7 days.
+        # Cannot be more than 7 days or less than 10 minutes.
+        # Corresponds to the JSON property `messageRetentionDuration`
+        # @return [String]
+        attr_accessor :message_retention_duration
+      
+        # Required. The name of the subscription. It must have the format `"projects/`
+        # project`/subscriptions/`subscription`"`. ``subscription`` 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"`.
+        # Corresponds to the JSON property `name`
+        # @return [String]
+        attr_accessor :name
+      
+        # Configuration for a push delivery endpoint.
+        # Corresponds to the JSON property `pushConfig`
+        # @return [Google::Apis::PubsubV1::PushConfig]
+        attr_accessor :push_config
+      
+        # Indicates whether to retain acknowledged messages. If true, then messages are
+        # not expunged from the subscription's backlog, even if they are acknowledged,
+        # until they fall out of the `message_retention_duration` window. This must be
+        # true if you would like to [Seek to a timestamp] (https://cloud.google.com/
+        # pubsub/docs/replay-overview#seek_to_a_time).
+        # Corresponds to the JSON property `retainAckedMessages`
+        # @return [Boolean]
+        attr_accessor :retain_acked_messages
+        alias_method :retain_acked_messages?, :retain_acked_messages
+      
+        # A policy that specifies how Cloud Pub/Sub retries message delivery. Retry
+        # delay will be exponential based on provided minimum and maximum backoffs.
+        # https://en.wikipedia.org/wiki/Exponential_backoff. RetryPolicy will be
+        # triggered on NACKs or acknowledgement deadline exceeded events for a given
+        # message. Retry Policy is implemented on a best effort basis. At times, the
+        # delay between consecutive deliveries may not match the configuration. That is,
+        # delay can be more or less than configured backoff.
+        # Corresponds to the JSON property `retryPolicy`
+        # @return [Google::Apis::PubsubV1::RetryPolicy]
+        attr_accessor :retry_policy
+      
+        # Required. The name of the topic from which this subscription is receiving
+        # messages. Format is `projects/`project`/topics/`topic``. The value of this
+        # field will be `_deleted-topic_` if the topic has been deleted.
+        # Corresponds to the JSON property `topic`
+        # @return [String]
+        attr_accessor :topic
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @ack_deadline_seconds = args[:ack_deadline_seconds] if args.key?(:ack_deadline_seconds)
+          @dead_letter_policy = args[:dead_letter_policy] if args.key?(:dead_letter_policy)
+          @detached = args[:detached] if args.key?(:detached)
+          @enable_message_ordering = args[:enable_message_ordering] if args.key?(:enable_message_ordering)
+          @expiration_policy = args[:expiration_policy] if args.key?(:expiration_policy)
+          @filter = args[:filter] if args.key?(:filter)
+          @labels = args[:labels] if args.key?(:labels)
+          @message_retention_duration = args[:message_retention_duration] if args.key?(:message_retention_duration)
+          @name = args[:name] if args.key?(:name)
+          @push_config = args[:push_config] if args.key?(:push_config)
+          @retain_acked_messages = args[:retain_acked_messages] if args.key?(:retain_acked_messages)
+          @retry_policy = args[:retry_policy] if args.key?(:retry_policy)
+          @topic = args[:topic] if args.key?(:topic)
+        end
+      end
+      
+      # Request message for `TestIamPermissions` method.
+      class TestIamPermissionsRequest
+        include Google::Apis::Core::Hashable
+      
+        # The set of permissions to check for the `resource`. Permissions with wildcards
+        # (such as '*' or 'storage.*') are not allowed. For more information see [IAM
+        # Overview](https://cloud.google.com/iam/docs/overview#permissions).
+        # Corresponds to the JSON property `permissions`
+        # @return [Array<String>]
+        attr_accessor :permissions
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @permissions = args[:permissions] if args.key?(:permissions)
+        end
+      end
+      
+      # Response message for `TestIamPermissions` method.
+      class TestIamPermissionsResponse
+        include Google::Apis::Core::Hashable
+      
+        # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
+        # Corresponds to the JSON property `permissions`
+        # @return [Array<String>]
+        attr_accessor :permissions
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @permissions = args[:permissions] if args.key?(:permissions)
+        end
+      end
+      
+      # A topic resource.
+      class Topic
+        include Google::Apis::Core::Hashable
+      
+        # The resource name of the Cloud KMS CryptoKey to be used to protect access to
+        # messages published on this topic. The expected format is `projects/*/locations/
+        # */keyRings/*/cryptoKeys/*`.
+        # Corresponds to the JSON property `kmsKeyName`
+        # @return [String]
+        attr_accessor :kms_key_name
+      
+        # See [Creating and managing labels] (https://cloud.google.com/pubsub/docs/
+        # labels).
+        # Corresponds to the JSON property `labels`
+        # @return [Hash<String,String>]
+        attr_accessor :labels
+      
+        # A policy constraining the storage of messages published to the topic.
+        # Corresponds to the JSON property `messageStoragePolicy`
+        # @return [Google::Apis::PubsubV1::MessageStoragePolicy]
+        attr_accessor :message_storage_policy
+      
+        # Required. The name of the topic. It must have the format `"projects/`project`/
+        # topics/`topic`"`. ``topic`` 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"`.
+        # Corresponds to the JSON property `name`
+        # @return [String]
+        attr_accessor :name
+      
+        # Reserved for future use. This field is set only in responses from the server;
+        # it is ignored if it is set in any requests.
+        # Corresponds to the JSON property `satisfiesPzs`
+        # @return [Boolean]
+        attr_accessor :satisfies_pzs
+        alias_method :satisfies_pzs?, :satisfies_pzs
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @kms_key_name = args[:kms_key_name] if args.key?(:kms_key_name)
+          @labels = args[:labels] if args.key?(:labels)
+          @message_storage_policy = args[:message_storage_policy] if args.key?(:message_storage_policy)
+          @name = args[:name] if args.key?(:name)
+          @satisfies_pzs = args[:satisfies_pzs] if args.key?(:satisfies_pzs)
+        end
+      end
+      
+      # Request for the UpdateSnapshot method.
+      class UpdateSnapshotRequest
+        include Google::Apis::Core::Hashable
+      
+        # A snapshot resource. Snapshots are used in [Seek](https://cloud.google.com/
+        # pubsub/docs/replay-overview) operations, which allow you to manage message
+        # acknowledgments in bulk. That is, you can set the acknowledgment state of
+        # messages in an existing subscription to the state captured by a snapshot.
+        # Corresponds to the JSON property `snapshot`
+        # @return [Google::Apis::PubsubV1::Snapshot]
+        attr_accessor :snapshot
+      
+        # Required. Indicates which fields in the provided snapshot to update. Must be
+        # specified and non-empty.
+        # Corresponds to the JSON property `updateMask`
+        # @return [String]
+        attr_accessor :update_mask
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @snapshot = args[:snapshot] if args.key?(:snapshot)
+          @update_mask = args[:update_mask] if args.key?(:update_mask)
+        end
+      end
+      
+      # Request for the UpdateSubscription method.
+      class UpdateSubscriptionRequest
+        include Google::Apis::Core::Hashable
+      
+        # A subscription resource.
+        # Corresponds to the JSON property `subscription`
+        # @return [Google::Apis::PubsubV1::Subscription]
+        attr_accessor :subscription
+      
+        # Required. Indicates which fields in the provided subscription to update. Must
+        # be specified and non-empty.
+        # Corresponds to the JSON property `updateMask`
+        # @return [String]
+        attr_accessor :update_mask
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @subscription = args[:subscription] if args.key?(:subscription)
+          @update_mask = args[:update_mask] if args.key?(:update_mask)
+        end
+      end
+      
+      # Request for the UpdateTopic method.
+      class UpdateTopicRequest
+        include Google::Apis::Core::Hashable
+      
+        # A topic resource.
+        # Corresponds to the JSON property `topic`
+        # @return [Google::Apis::PubsubV1::Topic]
+        attr_accessor :topic
+      
+        # Required. Indicates which fields in the provided topic to update. Must be
+        # specified and non-empty. Note that if `update_mask` contains "
+        # message_storage_policy" but the `message_storage_policy` is not set in the `
+        # topic` provided above, then the updated value is determined by the policy
+        # configured at the project or organization level.
+        # Corresponds to the JSON property `updateMask`
+        # @return [String]
+        attr_accessor :update_mask
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @topic = args[:topic] if args.key?(:topic)
+          @update_mask = args[:update_mask] if args.key?(:update_mask)
+        end
+      end
+    end
+  end
+end