google-apis-pubsub_v1beta1a 0.1.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA256:
3
+ metadata.gz: bb7fec93bafbf08db1d6ed0fbc27b7a2a4df38c99631142bd8df6bf4c0393f09
4
+ data.tar.gz: 41b17476420adddec0aab97d07c702928f3812b025eb72b8cb09a512a279e583
5
+ SHA512:
6
+ metadata.gz: 0f4cbb6c6c051388159b288012283ad1125096fa359b55e85a3a989b6825fce2c0c885c1e090c94d332441900d2eaa4f1e10ae98328bcd56bcd116d8cc94a029
7
+ data.tar.gz: 557eea9e00d09d5e309ad2cd63e2823686cf493706c767d72a30a38b8672c3fdd76279ccb6043cf4240ef4a2e887531f3a9c9908ef1c568418c5d273a0d988cf
@@ -0,0 +1,13 @@
1
+ --hide-void-return
2
+ --no-private
3
+ --verbose
4
+ --title=google-apis-pubsub_v1beta1a
5
+ --markup-provider=redcarpet
6
+ --markup=markdown
7
+ --main OVERVIEW.md
8
+ lib/google/apis/pubsub_v1beta1a/*.rb
9
+ lib/google/apis/pubsub_v1beta1a.rb
10
+ -
11
+ OVERVIEW.md
12
+ CHANGELOG.md
13
+ LICENSE.md
@@ -0,0 +1,7 @@
1
+ # Release history for google-apis-pubsub_v1beta1a
2
+
3
+ ### v0.1.0 (2021-01-07)
4
+
5
+ * Regenerated using generator version 0.1.1
6
+ * Regenerated from discovery document revision 20200807
7
+
@@ -0,0 +1,202 @@
1
+
2
+ Apache License
3
+ Version 2.0, January 2004
4
+ http://www.apache.org/licenses/
5
+
6
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
7
+
8
+ 1. Definitions.
9
+
10
+ "License" shall mean the terms and conditions for use, reproduction,
11
+ and distribution as defined by Sections 1 through 9 of this document.
12
+
13
+ "Licensor" shall mean the copyright owner or entity authorized by
14
+ the copyright owner that is granting the License.
15
+
16
+ "Legal Entity" shall mean the union of the acting entity and all
17
+ other entities that control, are controlled by, or are under common
18
+ control with that entity. For the purposes of this definition,
19
+ "control" means (i) the power, direct or indirect, to cause the
20
+ direction or management of such entity, whether by contract or
21
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
22
+ outstanding shares, or (iii) beneficial ownership of such entity.
23
+
24
+ "You" (or "Your") shall mean an individual or Legal Entity
25
+ exercising permissions granted by this License.
26
+
27
+ "Source" form shall mean the preferred form for making modifications,
28
+ including but not limited to software source code, documentation
29
+ source, and configuration files.
30
+
31
+ "Object" form shall mean any form resulting from mechanical
32
+ transformation or translation of a Source form, including but
33
+ not limited to compiled object code, generated documentation,
34
+ and conversions to other media types.
35
+
36
+ "Work" shall mean the work of authorship, whether in Source or
37
+ Object form, made available under the License, as indicated by a
38
+ copyright notice that is included in or attached to the work
39
+ (an example is provided in the Appendix below).
40
+
41
+ "Derivative Works" shall mean any work, whether in Source or Object
42
+ form, that is based on (or derived from) the Work and for which the
43
+ editorial revisions, annotations, elaborations, or other modifications
44
+ represent, as a whole, an original work of authorship. For the purposes
45
+ of this License, Derivative Works shall not include works that remain
46
+ separable from, or merely link (or bind by name) to the interfaces of,
47
+ the Work and Derivative Works thereof.
48
+
49
+ "Contribution" shall mean any work of authorship, including
50
+ the original version of the Work and any modifications or additions
51
+ to that Work or Derivative Works thereof, that is intentionally
52
+ submitted to Licensor for inclusion in the Work by the copyright owner
53
+ or by an individual or Legal Entity authorized to submit on behalf of
54
+ the copyright owner. For the purposes of this definition, "submitted"
55
+ means any form of electronic, verbal, or written communication sent
56
+ to the Licensor or its representatives, including but not limited to
57
+ communication on electronic mailing lists, source code control systems,
58
+ and issue tracking systems that are managed by, or on behalf of, the
59
+ Licensor for the purpose of discussing and improving the Work, but
60
+ excluding communication that is conspicuously marked or otherwise
61
+ designated in writing by the copyright owner as "Not a Contribution."
62
+
63
+ "Contributor" shall mean Licensor and any individual or Legal Entity
64
+ on behalf of whom a Contribution has been received by Licensor and
65
+ subsequently incorporated within the Work.
66
+
67
+ 2. Grant of Copyright License. Subject to the terms and conditions of
68
+ this License, each Contributor hereby grants to You a perpetual,
69
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
70
+ copyright license to reproduce, prepare Derivative Works of,
71
+ publicly display, publicly perform, sublicense, and distribute the
72
+ Work and such Derivative Works in Source or Object form.
73
+
74
+ 3. Grant of Patent License. Subject to the terms and conditions of
75
+ this License, each Contributor hereby grants to You a perpetual,
76
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
77
+ (except as stated in this section) patent license to make, have made,
78
+ use, offer to sell, sell, import, and otherwise transfer the Work,
79
+ where such license applies only to those patent claims licensable
80
+ by such Contributor that are necessarily infringed by their
81
+ Contribution(s) alone or by combination of their Contribution(s)
82
+ with the Work to which such Contribution(s) was submitted. If You
83
+ institute patent litigation against any entity (including a
84
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
85
+ or a Contribution incorporated within the Work constitutes direct
86
+ or contributory patent infringement, then any patent licenses
87
+ granted to You under this License for that Work shall terminate
88
+ as of the date such litigation is filed.
89
+
90
+ 4. Redistribution. You may reproduce and distribute copies of the
91
+ Work or Derivative Works thereof in any medium, with or without
92
+ modifications, and in Source or Object form, provided that You
93
+ meet the following conditions:
94
+
95
+ (a) You must give any other recipients of the Work or
96
+ Derivative Works a copy of this License; and
97
+
98
+ (b) You must cause any modified files to carry prominent notices
99
+ stating that You changed the files; and
100
+
101
+ (c) You must retain, in the Source form of any Derivative Works
102
+ that You distribute, all copyright, patent, trademark, and
103
+ attribution notices from the Source form of the Work,
104
+ excluding those notices that do not pertain to any part of
105
+ the Derivative Works; and
106
+
107
+ (d) If the Work includes a "NOTICE" text file as part of its
108
+ distribution, then any Derivative Works that You distribute must
109
+ include a readable copy of the attribution notices contained
110
+ within such NOTICE file, excluding those notices that do not
111
+ pertain to any part of the Derivative Works, in at least one
112
+ of the following places: within a NOTICE text file distributed
113
+ as part of the Derivative Works; within the Source form or
114
+ documentation, if provided along with the Derivative Works; or,
115
+ within a display generated by the Derivative Works, if and
116
+ wherever such third-party notices normally appear. The contents
117
+ of the NOTICE file are for informational purposes only and
118
+ do not modify the License. You may add Your own attribution
119
+ notices within Derivative Works that You distribute, alongside
120
+ or as an addendum to the NOTICE text from the Work, provided
121
+ that such additional attribution notices cannot be construed
122
+ as modifying the License.
123
+
124
+ You may add Your own copyright statement to Your modifications and
125
+ may provide additional or different license terms and conditions
126
+ for use, reproduction, or distribution of Your modifications, or
127
+ for any such Derivative Works as a whole, provided Your use,
128
+ reproduction, and distribution of the Work otherwise complies with
129
+ the conditions stated in this License.
130
+
131
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
132
+ any Contribution intentionally submitted for inclusion in the Work
133
+ by You to the Licensor shall be under the terms and conditions of
134
+ this License, without any additional terms or conditions.
135
+ Notwithstanding the above, nothing herein shall supersede or modify
136
+ the terms of any separate license agreement you may have executed
137
+ with Licensor regarding such Contributions.
138
+
139
+ 6. Trademarks. This License does not grant permission to use the trade
140
+ names, trademarks, service marks, or product names of the Licensor,
141
+ except as required for reasonable and customary use in describing the
142
+ origin of the Work and reproducing the content of the NOTICE file.
143
+
144
+ 7. Disclaimer of Warranty. Unless required by applicable law or
145
+ agreed to in writing, Licensor provides the Work (and each
146
+ Contributor provides its Contributions) on an "AS IS" BASIS,
147
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
148
+ implied, including, without limitation, any warranties or conditions
149
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
150
+ PARTICULAR PURPOSE. You are solely responsible for determining the
151
+ appropriateness of using or redistributing the Work and assume any
152
+ risks associated with Your exercise of permissions under this License.
153
+
154
+ 8. Limitation of Liability. In no event and under no legal theory,
155
+ whether in tort (including negligence), contract, or otherwise,
156
+ unless required by applicable law (such as deliberate and grossly
157
+ negligent acts) or agreed to in writing, shall any Contributor be
158
+ liable to You for damages, including any direct, indirect, special,
159
+ incidental, or consequential damages of any character arising as a
160
+ result of this License or out of the use or inability to use the
161
+ Work (including but not limited to damages for loss of goodwill,
162
+ work stoppage, computer failure or malfunction, or any and all
163
+ other commercial damages or losses), even if such Contributor
164
+ has been advised of the possibility of such damages.
165
+
166
+ 9. Accepting Warranty or Additional Liability. While redistributing
167
+ the Work or Derivative Works thereof, You may choose to offer,
168
+ and charge a fee for, acceptance of support, warranty, indemnity,
169
+ or other liability obligations and/or rights consistent with this
170
+ License. However, in accepting such obligations, You may act only
171
+ on Your own behalf and on Your sole responsibility, not on behalf
172
+ of any other Contributor, and only if You agree to indemnify,
173
+ defend, and hold each Contributor harmless for any liability
174
+ incurred by, or claims asserted against, such Contributor by reason
175
+ of your accepting any such warranty or additional liability.
176
+
177
+ END OF TERMS AND CONDITIONS
178
+
179
+ APPENDIX: How to apply the Apache License to your work.
180
+
181
+ To apply the Apache License to your work, attach the following
182
+ boilerplate notice, with the fields enclosed by brackets "[]"
183
+ replaced with your own identifying information. (Don't include
184
+ the brackets!) The text should be enclosed in the appropriate
185
+ comment syntax for the file format. We also recommend that a
186
+ file or class name and description of purpose be included on the
187
+ same "printed page" as the copyright notice for easier
188
+ identification within third-party archives.
189
+
190
+ Copyright [yyyy] [name of copyright owner]
191
+
192
+ Licensed under the Apache License, Version 2.0 (the "License");
193
+ you may not use this file except in compliance with the License.
194
+ You may obtain a copy of the License at
195
+
196
+ http://www.apache.org/licenses/LICENSE-2.0
197
+
198
+ Unless required by applicable law or agreed to in writing, software
199
+ distributed under the License is distributed on an "AS IS" BASIS,
200
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
201
+ See the License for the specific language governing permissions and
202
+ limitations under the License.
@@ -0,0 +1,96 @@
1
+ # Simple REST client for version V1beta1a of the Cloud Pub/Sub API
2
+
3
+ This is a simple client library for version V1beta1a of the Cloud Pub/Sub API. It provides:
4
+
5
+ * A client object that connects to the HTTP/JSON REST endpoint for the service.
6
+ * Ruby objects for data structures related to the service.
7
+ * Integration with the googleauth gem for authentication using OAuth, API keys, and service accounts.
8
+ * Control of retry, pagination, and timeouts.
9
+
10
+ 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.
11
+
12
+ ## Getting started
13
+
14
+ ### Before you begin
15
+
16
+ There are a few setup steps you need to complete before you can use this library:
17
+
18
+ 1. If you don't already have a Google account, [sign up](https://www.google.com/accounts).
19
+ 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/).
20
+ 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.
21
+
22
+ ### Installation
23
+
24
+ Add this line to your application's Gemfile:
25
+
26
+ ```ruby
27
+ gem 'google-apis-pubsub_v1beta1a', '~> 0.1'
28
+ ```
29
+
30
+ And then execute:
31
+
32
+ ```
33
+ $ bundle
34
+ ```
35
+
36
+ Or install it yourself as:
37
+
38
+ ```
39
+ $ gem install google-apis-pubsub_v1beta1a
40
+ ```
41
+
42
+ ### Creating a client object
43
+
44
+ Once the gem is installed, you can load the client code and instantiate a client.
45
+
46
+ ```ruby
47
+ # Load the client
48
+ require "google/apis/pubsub_v1beta1a"
49
+
50
+ # Create a client object
51
+ client = Google::Apis::PubsubV1beta1a::PubsubService.new
52
+
53
+ # Authenticate calls
54
+ client.authentication = # ... use the googleauth gem to create credentials
55
+ ```
56
+
57
+ See the class reference docs for information on the methods you can call from a client.
58
+
59
+ ## Documentation
60
+
61
+ More detailed descriptions of the Google simple REST clients are available in two documents.
62
+
63
+ * 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.
64
+ * 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.
65
+
66
+ (Note: the above documents are written for the simple REST clients in general, and their examples may not reflect the Pubsub service in particular.)
67
+
68
+ For reference information on specific calls in the Cloud Pub/Sub API, see the {Google::Apis::PubsubV1beta1a::PubsubService class reference docs}.
69
+
70
+ ## Which client should I use?
71
+
72
+ Google provides two types of Ruby API client libraries: **simple REST clients** and **modern clients**.
73
+
74
+ This library, `google-apis-pubsub_v1beta1a`, 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.
75
+
76
+ 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.
77
+
78
+ 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.
79
+
80
+ **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.
81
+
82
+ The [product documentation](https://cloud.google.com/pubsub/docs) may provide guidance regarding the preferred client library to use.
83
+
84
+ ## Supported Ruby versions
85
+
86
+ This library is supported on Ruby 2.5+.
87
+
88
+ 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.
89
+
90
+ ## License
91
+
92
+ This library is licensed under Apache 2.0. Full license text is available in the {file:LICENSE.md LICENSE}.
93
+
94
+ ## Support
95
+
96
+ 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).
@@ -0,0 +1,15 @@
1
+ # Copyright 2020 Google LLC
2
+ #
3
+ # Licensed under the Apache License, Version 2.0 (the "License");
4
+ # you may not use this file except in compliance with the License.
5
+ # You may obtain a copy of the License at
6
+ #
7
+ # http://www.apache.org/licenses/LICENSE-2.0
8
+ #
9
+ # Unless required by applicable law or agreed to in writing, software
10
+ # distributed under the License is distributed on an "AS IS" BASIS,
11
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12
+ # See the License for the specific language governing permissions and
13
+ # limitations under the License.
14
+
15
+ require "google/apis/pubsub_v1beta1a"
@@ -0,0 +1,39 @@
1
+ # Copyright 2020 Google LLC
2
+ #
3
+ # Licensed under the Apache License, Version 2.0 (the "License");
4
+ # you may not use this file except in compliance with the License.
5
+ # You may obtain a copy of the License at
6
+ #
7
+ # http://www.apache.org/licenses/LICENSE-2.0
8
+ #
9
+ # Unless required by applicable law or agreed to in writing, software
10
+ # distributed under the License is distributed on an "AS IS" BASIS,
11
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12
+ # See the License for the specific language governing permissions and
13
+ # limitations under the License.
14
+
15
+ require 'google/apis/pubsub_v1beta1a/service.rb'
16
+ require 'google/apis/pubsub_v1beta1a/classes.rb'
17
+ require 'google/apis/pubsub_v1beta1a/representations.rb'
18
+ require 'google/apis/pubsub_v1beta1a/gem_version.rb'
19
+
20
+ module Google
21
+ module Apis
22
+ # Cloud Pub/Sub API
23
+ #
24
+ # Provides reliable, many-to-many, asynchronous messaging between applications.
25
+ #
26
+ # @see https://cloud.google.com/pubsub/docs
27
+ module PubsubV1beta1a
28
+ # Version of the Cloud Pub/Sub API this client connects to.
29
+ # This is NOT the gem version.
30
+ VERSION = 'V1beta1a'
31
+
32
+ # View and manage your data across Google Cloud Platform services
33
+ AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform'
34
+
35
+ # View and manage Pub/Sub topics and subscriptions
36
+ AUTH_PUBSUB = 'https://www.googleapis.com/auth/pubsub'
37
+ end
38
+ end
39
+ end
@@ -0,0 +1,590 @@
1
+ # Copyright 2020 Google LLC
2
+ #
3
+ # Licensed under the Apache License, Version 2.0 (the "License");
4
+ # you may not use this file except in compliance with the License.
5
+ # You may obtain a copy of the License at
6
+ #
7
+ # http://www.apache.org/licenses/LICENSE-2.0
8
+ #
9
+ # Unless required by applicable law or agreed to in writing, software
10
+ # distributed under the License is distributed on an "AS IS" BASIS,
11
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12
+ # See the License for the specific language governing permissions and
13
+ # limitations under the License.
14
+
15
+ require 'date'
16
+ require 'google/apis/core/base_service'
17
+ require 'google/apis/core/json_representation'
18
+ require 'google/apis/core/hashable'
19
+ require 'google/apis/errors'
20
+
21
+ module Google
22
+ module Apis
23
+ module PubsubV1beta1a
24
+
25
+ # Request for the Acknowledge method.
26
+ class AcknowledgeRequest
27
+ include Google::Apis::Core::Hashable
28
+
29
+ # The acknowledgment ID for the message being acknowledged. This was returned by
30
+ # the Pub/Sub system in the Pull response.
31
+ # Corresponds to the JSON property `ackId`
32
+ # @return [Array<String>]
33
+ attr_accessor :ack_id
34
+
35
+ # The subscription whose message is being acknowledged.
36
+ # Corresponds to the JSON property `subscription`
37
+ # @return [String]
38
+ attr_accessor :subscription
39
+
40
+ def initialize(**args)
41
+ update!(**args)
42
+ end
43
+
44
+ # Update properties of this object
45
+ def update!(**args)
46
+ @ack_id = args[:ack_id] if args.key?(:ack_id)
47
+ @subscription = args[:subscription] if args.key?(:subscription)
48
+ end
49
+ end
50
+
51
+ # An empty message that you can re-use to avoid defining duplicated empty
52
+ # messages in your project. A typical example is to use it as argument or the
53
+ # return value of a service API. For instance: service Foo ` rpc Bar (proto2.
54
+ # Empty) returns (proto2.Empty) ` `; `; BEGIN GOOGLE-INTERNAL The difference
55
+ # between this one and net/rpc/empty-message.proto is that 1) The generated
56
+ # message here is in proto2 C++ API. 2) The proto2.Empty has minimum
57
+ # dependencies (no message_set or net/rpc dependencies) END GOOGLE-INTERNAL
58
+ class Empty
59
+ include Google::Apis::Core::Hashable
60
+
61
+ def initialize(**args)
62
+ update!(**args)
63
+ end
64
+
65
+ # Update properties of this object
66
+ def update!(**args)
67
+ end
68
+ end
69
+
70
+ # A key-value pair applied to a given object.
71
+ class Label
72
+ include Google::Apis::Core::Hashable
73
+
74
+ # The key of a label is a syntactically valid URL (as per RFC 1738) with the "
75
+ # scheme" and initial slashes omitted and with the additional restrictions noted
76
+ # below. Each key should be globally unique. The "host" portion is called the "
77
+ # namespace" and is not necessarily resolvable to a network endpoint. Instead,
78
+ # the namespace indicates what system or entity defines the semantics of the
79
+ # label. Namespaces do not restrict the set of objects to which a label may be
80
+ # associated. Keys are defined by the following grammar: key = hostname "/"
81
+ # kpath kpath = ksegment *[ "/" ksegment ] ksegment = alphadigit | *[ alphadigit
82
+ # | "-" | "_" | "." ] where "hostname" and "alphadigit" are defined as in RFC
83
+ # 1738. Example key: spanner.google.com/universe
84
+ # Corresponds to the JSON property `key`
85
+ # @return [String]
86
+ attr_accessor :key
87
+
88
+ # An integer value.
89
+ # Corresponds to the JSON property `numValue`
90
+ # @return [Fixnum]
91
+ attr_accessor :num_value
92
+
93
+ # A string value.
94
+ # Corresponds to the JSON property `strValue`
95
+ # @return [String]
96
+ attr_accessor :str_value
97
+
98
+ def initialize(**args)
99
+ update!(**args)
100
+ end
101
+
102
+ # Update properties of this object
103
+ def update!(**args)
104
+ @key = args[:key] if args.key?(:key)
105
+ @num_value = args[:num_value] if args.key?(:num_value)
106
+ @str_value = args[:str_value] if args.key?(:str_value)
107
+ end
108
+ end
109
+
110
+ # Response for the ListSubscriptions method.
111
+ class ListSubscriptionsResponse
112
+ include Google::Apis::Core::Hashable
113
+
114
+ # If not empty, indicates that there are more subscriptions that match the
115
+ # request and this value should be passed to the next ListSubscriptionsRequest
116
+ # to continue.
117
+ # Corresponds to the JSON property `nextPageToken`
118
+ # @return [String]
119
+ attr_accessor :next_page_token
120
+
121
+ # The subscriptions that match the request.
122
+ # Corresponds to the JSON property `subscription`
123
+ # @return [Array<Google::Apis::PubsubV1beta1a::Subscription>]
124
+ attr_accessor :subscription
125
+
126
+ def initialize(**args)
127
+ update!(**args)
128
+ end
129
+
130
+ # Update properties of this object
131
+ def update!(**args)
132
+ @next_page_token = args[:next_page_token] if args.key?(:next_page_token)
133
+ @subscription = args[:subscription] if args.key?(:subscription)
134
+ end
135
+ end
136
+
137
+ # Response for the ListTopics method.
138
+ class ListTopicsResponse
139
+ include Google::Apis::Core::Hashable
140
+
141
+ # If not empty, indicates that there are more topics that match the request, and
142
+ # this value should be passed to the next ListTopicsRequest to continue.
143
+ # Corresponds to the JSON property `nextPageToken`
144
+ # @return [String]
145
+ attr_accessor :next_page_token
146
+
147
+ # The resulting topics.
148
+ # Corresponds to the JSON property `topic`
149
+ # @return [Array<Google::Apis::PubsubV1beta1a::Topic>]
150
+ attr_accessor :topic
151
+
152
+ def initialize(**args)
153
+ update!(**args)
154
+ end
155
+
156
+ # Update properties of this object
157
+ def update!(**args)
158
+ @next_page_token = args[:next_page_token] if args.key?(:next_page_token)
159
+ @topic = args[:topic] if args.key?(:topic)
160
+ end
161
+ end
162
+
163
+ # Request for the ModifyAckDeadline method.
164
+ class ModifyAckDeadlineRequest
165
+ include Google::Apis::Core::Hashable
166
+
167
+ # The new ack deadline with respect to the time this request was sent to the Pub/
168
+ # Sub system. Must be >= 0. For example, if the value is 10, the new ack
169
+ # deadline will expire 10 seconds after the ModifyAckDeadline call was made.
170
+ # Specifying zero may immediately make the message available for another pull
171
+ # request.
172
+ # Corresponds to the JSON property `ackDeadlineSeconds`
173
+ # @return [Fixnum]
174
+ attr_accessor :ack_deadline_seconds
175
+
176
+ # The acknowledgment ID. Either this or ack_ids must be populated, not both.
177
+ # Corresponds to the JSON property `ackId`
178
+ # @return [String]
179
+ attr_accessor :ack_id
180
+
181
+ # List of acknowledgment IDs. Either this field or ack_id should be populated,
182
+ # not both.
183
+ # Corresponds to the JSON property `ackIds`
184
+ # @return [Array<String>]
185
+ attr_accessor :ack_ids
186
+
187
+ # Next Index: 5 The name of the subscription from which messages are being
188
+ # pulled.
189
+ # Corresponds to the JSON property `subscription`
190
+ # @return [String]
191
+ attr_accessor :subscription
192
+
193
+ def initialize(**args)
194
+ update!(**args)
195
+ end
196
+
197
+ # Update properties of this object
198
+ def update!(**args)
199
+ @ack_deadline_seconds = args[:ack_deadline_seconds] if args.key?(:ack_deadline_seconds)
200
+ @ack_id = args[:ack_id] if args.key?(:ack_id)
201
+ @ack_ids = args[:ack_ids] if args.key?(:ack_ids)
202
+ @subscription = args[:subscription] if args.key?(:subscription)
203
+ end
204
+ end
205
+
206
+ # Request for the ModifyPushConfig method.
207
+ class ModifyPushConfigRequest
208
+ include Google::Apis::Core::Hashable
209
+
210
+ # Configuration for a push delivery endpoint.
211
+ # Corresponds to the JSON property `pushConfig`
212
+ # @return [Google::Apis::PubsubV1beta1a::PushConfig]
213
+ attr_accessor :push_config
214
+
215
+ # The name of the subscription.
216
+ # Corresponds to the JSON property `subscription`
217
+ # @return [String]
218
+ attr_accessor :subscription
219
+
220
+ def initialize(**args)
221
+ update!(**args)
222
+ end
223
+
224
+ # Update properties of this object
225
+ def update!(**args)
226
+ @push_config = args[:push_config] if args.key?(:push_config)
227
+ @subscription = args[:subscription] if args.key?(:subscription)
228
+ end
229
+ end
230
+
231
+ # Request for the PublishBatch method.
232
+ class PublishBatchRequest
233
+ include Google::Apis::Core::Hashable
234
+
235
+ # The messages to publish.
236
+ # Corresponds to the JSON property `messages`
237
+ # @return [Array<Google::Apis::PubsubV1beta1a::PubsubMessage>]
238
+ attr_accessor :messages
239
+
240
+ # The messages in the request will be published on this topic.
241
+ # Corresponds to the JSON property `topic`
242
+ # @return [String]
243
+ attr_accessor :topic
244
+
245
+ def initialize(**args)
246
+ update!(**args)
247
+ end
248
+
249
+ # Update properties of this object
250
+ def update!(**args)
251
+ @messages = args[:messages] if args.key?(:messages)
252
+ @topic = args[:topic] if args.key?(:topic)
253
+ end
254
+ end
255
+
256
+ # Response for the PublishBatch method.
257
+ class PublishBatchResponse
258
+ include Google::Apis::Core::Hashable
259
+
260
+ # The server-assigned ID of each published message, in the same order as the
261
+ # messages in the request. IDs are guaranteed to be unique within the topic.
262
+ # Corresponds to the JSON property `messageIds`
263
+ # @return [Array<String>]
264
+ attr_accessor :message_ids
265
+
266
+ def initialize(**args)
267
+ update!(**args)
268
+ end
269
+
270
+ # Update properties of this object
271
+ def update!(**args)
272
+ @message_ids = args[:message_ids] if args.key?(:message_ids)
273
+ end
274
+ end
275
+
276
+ # Request for the Publish method.
277
+ class PublishRequest
278
+ include Google::Apis::Core::Hashable
279
+
280
+ # A message data and its labels.
281
+ # Corresponds to the JSON property `message`
282
+ # @return [Google::Apis::PubsubV1beta1a::PubsubMessage]
283
+ attr_accessor :message
284
+
285
+ # The message in the request will be published on this topic.
286
+ # Corresponds to the JSON property `topic`
287
+ # @return [String]
288
+ attr_accessor :topic
289
+
290
+ def initialize(**args)
291
+ update!(**args)
292
+ end
293
+
294
+ # Update properties of this object
295
+ def update!(**args)
296
+ @message = args[:message] if args.key?(:message)
297
+ @topic = args[:topic] if args.key?(:topic)
298
+ end
299
+ end
300
+
301
+ # An event indicating a received message or truncation event.
302
+ class PubsubEvent
303
+ include Google::Apis::Core::Hashable
304
+
305
+ # Indicates that this subscription has been deleted. (Note that pull subscribers
306
+ # will always receive NOT_FOUND in response in their pull request on the
307
+ # subscription, rather than seeing this boolean.)
308
+ # Corresponds to the JSON property `deleted`
309
+ # @return [Boolean]
310
+ attr_accessor :deleted
311
+ alias_method :deleted?, :deleted
312
+
313
+ # A message data and its labels.
314
+ # Corresponds to the JSON property `message`
315
+ # @return [Google::Apis::PubsubV1beta1a::PubsubMessage]
316
+ attr_accessor :message
317
+
318
+ # The subscription that received the event.
319
+ # Corresponds to the JSON property `subscription`
320
+ # @return [String]
321
+ attr_accessor :subscription
322
+
323
+ # Indicates that this subscription has been truncated.
324
+ # Corresponds to the JSON property `truncated`
325
+ # @return [Boolean]
326
+ attr_accessor :truncated
327
+ alias_method :truncated?, :truncated
328
+
329
+ def initialize(**args)
330
+ update!(**args)
331
+ end
332
+
333
+ # Update properties of this object
334
+ def update!(**args)
335
+ @deleted = args[:deleted] if args.key?(:deleted)
336
+ @message = args[:message] if args.key?(:message)
337
+ @subscription = args[:subscription] if args.key?(:subscription)
338
+ @truncated = args[:truncated] if args.key?(:truncated)
339
+ end
340
+ end
341
+
342
+ # A message data and its labels.
343
+ class PubsubMessage
344
+ include Google::Apis::Core::Hashable
345
+
346
+ # The message payload.
347
+ # Corresponds to the JSON property `data`
348
+ # NOTE: Values are automatically base64 encoded/decoded in the client library.
349
+ # @return [String]
350
+ attr_accessor :data
351
+
352
+ # Optional list of labels for this message. Keys in this collection must be
353
+ # unique.
354
+ # Corresponds to the JSON property `label`
355
+ # @return [Array<Google::Apis::PubsubV1beta1a::Label>]
356
+ attr_accessor :label
357
+
358
+ # ID of this message assigned by the server at publication time. Guaranteed to
359
+ # be unique within the topic. This value may be read by a subscriber that
360
+ # receives a PubsubMessage via a Pull call or a push delivery. It must not be
361
+ # populated by a publisher in a Publish call.
362
+ # Corresponds to the JSON property `messageId`
363
+ # @return [String]
364
+ attr_accessor :message_id
365
+
366
+ # The time at which the message was published. The time is milliseconds since
367
+ # the UNIX epoch.
368
+ # Corresponds to the JSON property `publishTime`
369
+ # @return [Fixnum]
370
+ attr_accessor :publish_time
371
+
372
+ def initialize(**args)
373
+ update!(**args)
374
+ end
375
+
376
+ # Update properties of this object
377
+ def update!(**args)
378
+ @data = args[:data] if args.key?(:data)
379
+ @label = args[:label] if args.key?(:label)
380
+ @message_id = args[:message_id] if args.key?(:message_id)
381
+ @publish_time = args[:publish_time] if args.key?(:publish_time)
382
+ end
383
+ end
384
+
385
+ # Request for the PullBatch method.
386
+ class PullBatchRequest
387
+ include Google::Apis::Core::Hashable
388
+
389
+ # The maximum number of PubsubEvents returned for this request. The Pub/Sub
390
+ # system may return fewer than the number of events specified.
391
+ # Corresponds to the JSON property `maxEvents`
392
+ # @return [Fixnum]
393
+ attr_accessor :max_events
394
+
395
+ # If this is specified as true the system will respond immediately even if it is
396
+ # not able to return a message in the Pull response. Otherwise the system is
397
+ # allowed to wait until at least one message is available rather than returning
398
+ # no messages. The client may cancel the request if it does not wish to wait any
399
+ # longer for the response.
400
+ # Corresponds to the JSON property `returnImmediately`
401
+ # @return [Boolean]
402
+ attr_accessor :return_immediately
403
+ alias_method :return_immediately?, :return_immediately
404
+
405
+ # The subscription from which messages should be pulled.
406
+ # Corresponds to the JSON property `subscription`
407
+ # @return [String]
408
+ attr_accessor :subscription
409
+
410
+ def initialize(**args)
411
+ update!(**args)
412
+ end
413
+
414
+ # Update properties of this object
415
+ def update!(**args)
416
+ @max_events = args[:max_events] if args.key?(:max_events)
417
+ @return_immediately = args[:return_immediately] if args.key?(:return_immediately)
418
+ @subscription = args[:subscription] if args.key?(:subscription)
419
+ end
420
+ end
421
+
422
+ # Response for the PullBatch method.
423
+ class PullBatchResponse
424
+ include Google::Apis::Core::Hashable
425
+
426
+ # Received Pub/Sub messages or status events. The Pub/Sub system will return
427
+ # zero messages if there are no more messages available in the backlog. The Pub/
428
+ # Sub system may return fewer than the max_events requested even if there are
429
+ # more messages available in the backlog.
430
+ # Corresponds to the JSON property `pullResponses`
431
+ # @return [Array<Google::Apis::PubsubV1beta1a::PullResponse>]
432
+ attr_accessor :pull_responses
433
+
434
+ def initialize(**args)
435
+ update!(**args)
436
+ end
437
+
438
+ # Update properties of this object
439
+ def update!(**args)
440
+ @pull_responses = args[:pull_responses] if args.key?(:pull_responses)
441
+ end
442
+ end
443
+
444
+ # Request for the Pull method.
445
+ class PullRequest
446
+ include Google::Apis::Core::Hashable
447
+
448
+ # If this is specified as true the system will respond immediately even if it is
449
+ # not able to return a message in the Pull response. Otherwise the system is
450
+ # allowed to wait until at least one message is available rather than returning
451
+ # FAILED_PRECONDITION. The client may cancel the request if it does not wish to
452
+ # wait any longer for the response.
453
+ # Corresponds to the JSON property `returnImmediately`
454
+ # @return [Boolean]
455
+ attr_accessor :return_immediately
456
+ alias_method :return_immediately?, :return_immediately
457
+
458
+ # The subscription from which a message should be pulled.
459
+ # Corresponds to the JSON property `subscription`
460
+ # @return [String]
461
+ attr_accessor :subscription
462
+
463
+ def initialize(**args)
464
+ update!(**args)
465
+ end
466
+
467
+ # Update properties of this object
468
+ def update!(**args)
469
+ @return_immediately = args[:return_immediately] if args.key?(:return_immediately)
470
+ @subscription = args[:subscription] if args.key?(:subscription)
471
+ end
472
+ end
473
+
474
+ # Either a PubsubMessage or a truncation event. One of these two must be
475
+ # populated.
476
+ class PullResponse
477
+ include Google::Apis::Core::Hashable
478
+
479
+ # This ID must be used to acknowledge the received event or message.
480
+ # Corresponds to the JSON property `ackId`
481
+ # @return [String]
482
+ attr_accessor :ack_id
483
+
484
+ # An event indicating a received message or truncation event.
485
+ # Corresponds to the JSON property `pubsubEvent`
486
+ # @return [Google::Apis::PubsubV1beta1a::PubsubEvent]
487
+ attr_accessor :pubsub_event
488
+
489
+ def initialize(**args)
490
+ update!(**args)
491
+ end
492
+
493
+ # Update properties of this object
494
+ def update!(**args)
495
+ @ack_id = args[:ack_id] if args.key?(:ack_id)
496
+ @pubsub_event = args[:pubsub_event] if args.key?(:pubsub_event)
497
+ end
498
+ end
499
+
500
+ # Configuration for a push delivery endpoint.
501
+ class PushConfig
502
+ include Google::Apis::Core::Hashable
503
+
504
+ # A URL locating the endpoint to which messages should be pushed. For example, a
505
+ # Webhook endpoint might use "https://example.com/push".
506
+ # Corresponds to the JSON property `pushEndpoint`
507
+ # @return [String]
508
+ attr_accessor :push_endpoint
509
+
510
+ def initialize(**args)
511
+ update!(**args)
512
+ end
513
+
514
+ # Update properties of this object
515
+ def update!(**args)
516
+ @push_endpoint = args[:push_endpoint] if args.key?(:push_endpoint)
517
+ end
518
+ end
519
+
520
+ # A subscription resource.
521
+ class Subscription
522
+ include Google::Apis::Core::Hashable
523
+
524
+ # For either push or pull delivery, the value is the maximum time after a
525
+ # subscriber receives a message before the subscriber should acknowledge or Nack
526
+ # the message. If the Ack deadline for a message passes without an Ack or a Nack,
527
+ # the Pub/Sub system will eventually redeliver the message. If a subscriber
528
+ # acknowledges after the deadline, the Pub/Sub system may accept the Ack, but it
529
+ # is possible that the message has been already delivered again. Multiple Acks
530
+ # to the message are allowed and will succeed. For push delivery, this value is
531
+ # used to set the request timeout for the call to the push endpoint. For pull
532
+ # delivery, this value is used as the initial value for the Ack deadline. It may
533
+ # be overridden for each message using its corresponding ack_id with
534
+ # ModifyAckDeadline. While a message is outstanding (i.e. it has been delivered
535
+ # to a pull subscriber and the subscriber has not yet Acked or Nacked), the Pub/
536
+ # Sub system will not deliver that message to another pull subscriber (on a best-
537
+ # effort basis).
538
+ # Corresponds to the JSON property `ackDeadlineSeconds`
539
+ # @return [Fixnum]
540
+ attr_accessor :ack_deadline_seconds
541
+
542
+ # Name of the subscription.
543
+ # Corresponds to the JSON property `name`
544
+ # @return [String]
545
+ attr_accessor :name
546
+
547
+ # Configuration for a push delivery endpoint.
548
+ # Corresponds to the JSON property `pushConfig`
549
+ # @return [Google::Apis::PubsubV1beta1a::PushConfig]
550
+ attr_accessor :push_config
551
+
552
+ # The name of the topic from which this subscription is receiving messages.
553
+ # Corresponds to the JSON property `topic`
554
+ # @return [String]
555
+ attr_accessor :topic
556
+
557
+ def initialize(**args)
558
+ update!(**args)
559
+ end
560
+
561
+ # Update properties of this object
562
+ def update!(**args)
563
+ @ack_deadline_seconds = args[:ack_deadline_seconds] if args.key?(:ack_deadline_seconds)
564
+ @name = args[:name] if args.key?(:name)
565
+ @push_config = args[:push_config] if args.key?(:push_config)
566
+ @topic = args[:topic] if args.key?(:topic)
567
+ end
568
+ end
569
+
570
+ # A topic resource.
571
+ class Topic
572
+ include Google::Apis::Core::Hashable
573
+
574
+ # Name of the topic.
575
+ # Corresponds to the JSON property `name`
576
+ # @return [String]
577
+ attr_accessor :name
578
+
579
+ def initialize(**args)
580
+ update!(**args)
581
+ end
582
+
583
+ # Update properties of this object
584
+ def update!(**args)
585
+ @name = args[:name] if args.key?(:name)
586
+ end
587
+ end
588
+ end
589
+ end
590
+ end