google-apps-events-subscriptions-v1beta 0.a → 0.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/.yardopts +12 -0
- data/AUTHENTICATION.md +122 -0
- data/README.md +154 -8
- data/lib/google/apps/events/subscriptions/v1beta/rest.rb +39 -0
- data/lib/google/apps/events/subscriptions/v1beta/subscription_resource_pb.rb +59 -0
- data/lib/google/apps/events/subscriptions/v1beta/subscriptions_service/client.rb +1077 -0
- data/lib/google/apps/events/subscriptions/v1beta/subscriptions_service/credentials.rb +63 -0
- data/lib/google/apps/events/subscriptions/v1beta/subscriptions_service/operations.rb +815 -0
- data/lib/google/apps/events/subscriptions/v1beta/subscriptions_service/paths.rb +80 -0
- data/lib/google/apps/events/subscriptions/v1beta/subscriptions_service/rest/client.rb +1025 -0
- data/lib/google/apps/events/subscriptions/v1beta/subscriptions_service/rest/operations.rb +916 -0
- data/lib/google/apps/events/subscriptions/v1beta/subscriptions_service/rest/service_stub.rb +448 -0
- data/lib/google/apps/events/subscriptions/v1beta/subscriptions_service/rest.rb +55 -0
- data/lib/google/apps/events/subscriptions/v1beta/subscriptions_service.rb +58 -0
- data/lib/google/apps/events/subscriptions/v1beta/subscriptions_service_pb.rb +65 -0
- data/lib/google/apps/events/subscriptions/v1beta/subscriptions_service_services_pb.rb +75 -0
- data/lib/google/apps/events/subscriptions/v1beta/version.rb +7 -2
- data/lib/google/apps/events/subscriptions/v1beta.rb +47 -0
- data/lib/google-apps-events-subscriptions-v1beta.rb +21 -0
- data/proto_docs/README.md +4 -0
- data/proto_docs/google/api/client.rb +473 -0
- data/proto_docs/google/api/field_behavior.rb +85 -0
- data/proto_docs/google/api/field_info.rb +88 -0
- data/proto_docs/google/api/launch_stage.rb +71 -0
- data/proto_docs/google/api/resource.rb +227 -0
- data/proto_docs/google/apps/events/subscriptions/v1beta/subscription_resource.rb +257 -0
- data/proto_docs/google/apps/events/subscriptions/v1beta/subscriptions_service.rb +217 -0
- data/proto_docs/google/longrunning/operations.rb +173 -0
- data/proto_docs/google/protobuf/any.rb +145 -0
- data/proto_docs/google/protobuf/duration.rb +98 -0
- data/proto_docs/google/protobuf/empty.rb +34 -0
- data/proto_docs/google/protobuf/field_mask.rb +229 -0
- data/proto_docs/google/protobuf/timestamp.rb +127 -0
- data/proto_docs/google/rpc/status.rb +48 -0
- metadata +70 -9
@@ -0,0 +1,257 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
# Copyright 2025 Google LLC
|
4
|
+
#
|
5
|
+
# Licensed under the Apache License, Version 2.0 (the "License");
|
6
|
+
# you may not use this file except in compliance with the License.
|
7
|
+
# You may obtain a copy of the License at
|
8
|
+
#
|
9
|
+
# https://www.apache.org/licenses/LICENSE-2.0
|
10
|
+
#
|
11
|
+
# Unless required by applicable law or agreed to in writing, software
|
12
|
+
# distributed under the License is distributed on an "AS IS" BASIS,
|
13
|
+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
14
|
+
# See the License for the specific language governing permissions and
|
15
|
+
# limitations under the License.
|
16
|
+
|
17
|
+
# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
|
18
|
+
|
19
|
+
|
20
|
+
module Google
|
21
|
+
module Apps
|
22
|
+
module Events
|
23
|
+
module Subscriptions
|
24
|
+
module V1beta
|
25
|
+
# A subscription to receive events about a Google Workspace resource. To learn
|
26
|
+
# more about subscriptions, see the [Google Workspace Events API
|
27
|
+
# overview](https://developers.google.com/workspace/events).
|
28
|
+
# @!attribute [rw] drive_options
|
29
|
+
# @return [::Google::Apps::Events::Subscriptions::V1beta::Subscription::DriveOptions]
|
30
|
+
# Optional. Features that are supported only for subscriptions on Drive
|
31
|
+
# resources.
|
32
|
+
# @!attribute [rw] expire_time
|
33
|
+
# @return [::Google::Protobuf::Timestamp]
|
34
|
+
# Non-empty default. The timestamp in UTC when the subscription expires.
|
35
|
+
# Always displayed on output, regardless of what was used on input.
|
36
|
+
#
|
37
|
+
# Note: The following fields are mutually exclusive: `expire_time`, `ttl`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
38
|
+
# @!attribute [rw] ttl
|
39
|
+
# @return [::Google::Protobuf::Duration]
|
40
|
+
# Input only. The time-to-live (TTL) or duration for the subscription. If
|
41
|
+
# unspecified or set to `0`, uses the maximum possible duration.
|
42
|
+
#
|
43
|
+
# Note: The following fields are mutually exclusive: `ttl`, `expire_time`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
44
|
+
# @!attribute [rw] name
|
45
|
+
# @return [::String]
|
46
|
+
# Identifier. Resource name of the subscription.
|
47
|
+
#
|
48
|
+
# Format: `subscriptions/{subscription}`
|
49
|
+
# @!attribute [r] uid
|
50
|
+
# @return [::String]
|
51
|
+
# Output only. System-assigned unique identifier for the subscription.
|
52
|
+
# @!attribute [rw] target_resource
|
53
|
+
# @return [::String]
|
54
|
+
# Required. Immutable. The Google Workspace resource that's monitored for
|
55
|
+
# events, formatted as the [full resource
|
56
|
+
# name](https://google.aip.dev/122#full-resource-names). To learn about
|
57
|
+
# target resources and the events that they support, see [Supported Google
|
58
|
+
# Workspace
|
59
|
+
# events](https://developers.google.com/workspace/events#supported-events).
|
60
|
+
#
|
61
|
+
# A user can only authorize your app to create one subscription for a given
|
62
|
+
# target resource. If your app tries to create another subscription with the
|
63
|
+
# same user credentials, the request returns an `ALREADY_EXISTS` error.
|
64
|
+
# @!attribute [rw] event_types
|
65
|
+
# @return [::Array<::String>]
|
66
|
+
# Required. Unordered list. Input for creating a subscription. Otherwise,
|
67
|
+
# output only. One or more types of events to receive about the target
|
68
|
+
# resource. Formatted according to the CloudEvents specification.
|
69
|
+
#
|
70
|
+
# The supported event types depend on the target resource of your
|
71
|
+
# subscription. For details, see [Supported Google Workspace
|
72
|
+
# events](https://developers.google.com/workspace/events/guides#supported-events).
|
73
|
+
#
|
74
|
+
# By default, you also receive events about the [lifecycle of your
|
75
|
+
# subscription](https://developers.google.com/workspace/events/guides/events-lifecycle).
|
76
|
+
# You don't need to specify lifecycle events for this field.
|
77
|
+
#
|
78
|
+
# If you specify an event type that doesn't exist for the target resource,
|
79
|
+
# the request returns an HTTP `400 Bad Request` status code.
|
80
|
+
# @!attribute [rw] payload_options
|
81
|
+
# @return [::Google::Apps::Events::Subscriptions::V1beta::PayloadOptions]
|
82
|
+
# Optional. Options about what data to include in the event payload. Only
|
83
|
+
# supported for Google Chat events.
|
84
|
+
# @!attribute [rw] notification_endpoint
|
85
|
+
# @return [::Google::Apps::Events::Subscriptions::V1beta::NotificationEndpoint]
|
86
|
+
# Required. Immutable. The endpoint where the subscription delivers events,
|
87
|
+
# such as a Pub/Sub topic.
|
88
|
+
# @!attribute [r] state
|
89
|
+
# @return [::Google::Apps::Events::Subscriptions::V1beta::Subscription::State]
|
90
|
+
# Output only. The state of the subscription. Determines whether the
|
91
|
+
# subscription can receive events and deliver them to the notification
|
92
|
+
# endpoint.
|
93
|
+
# @!attribute [r] suspension_reason
|
94
|
+
# @return [::Google::Apps::Events::Subscriptions::V1beta::Subscription::ErrorType]
|
95
|
+
# Output only. The error that suspended the subscription.
|
96
|
+
#
|
97
|
+
# To reactivate the subscription, resolve the error and call the
|
98
|
+
# {::Google::Apps::Events::Subscriptions::V1beta::SubscriptionsService::Client#reactivate_subscription `ReactivateSubscription`}
|
99
|
+
# method.
|
100
|
+
# @!attribute [r] authority
|
101
|
+
# @return [::String]
|
102
|
+
# Output only. The user who authorized the creation of the subscription.
|
103
|
+
#
|
104
|
+
# Format: `users/{user}`
|
105
|
+
#
|
106
|
+
# For Google Workspace users, the `{user}` value is the
|
107
|
+
# [`user.id`](https://developers.google.com/admin-sdk/directory/reference/rest/v1/users#User.FIELDS.ids)
|
108
|
+
# field from the Directory API.
|
109
|
+
# @!attribute [r] create_time
|
110
|
+
# @return [::Google::Protobuf::Timestamp]
|
111
|
+
# Output only. The time when the subscription is created.
|
112
|
+
# @!attribute [r] update_time
|
113
|
+
# @return [::Google::Protobuf::Timestamp]
|
114
|
+
# Output only. The last time that the subscription is updated.
|
115
|
+
# @!attribute [r] reconciling
|
116
|
+
# @return [::Boolean]
|
117
|
+
# Output only. If `true`, the subscription is in the process of being
|
118
|
+
# updated.
|
119
|
+
# @!attribute [rw] etag
|
120
|
+
# @return [::String]
|
121
|
+
# Optional. This checksum is computed by the server based on the value of
|
122
|
+
# other fields, and might be sent on update requests to ensure the client has
|
123
|
+
# an up-to-date value before proceeding.
|
124
|
+
class Subscription
|
125
|
+
include ::Google::Protobuf::MessageExts
|
126
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
127
|
+
|
128
|
+
# Additional supported options for serving Drive events.
|
129
|
+
# @!attribute [rw] include_descendants
|
130
|
+
# @return [::Boolean]
|
131
|
+
# Optional. Immutable. Whether to include all the descendant Drive files in
|
132
|
+
# the list of events. If false, the subscription will be created for the
|
133
|
+
# single file/drive that is specified as the
|
134
|
+
# {::Google::Apps::Events::Subscriptions::V1beta::Subscription#target_resource `target_resource`}.
|
135
|
+
#
|
136
|
+
# This flag can be used when the
|
137
|
+
# {::Google::Apps::Events::Subscriptions::V1beta::Subscription#target_resource `target_resource`}
|
138
|
+
# is either a
|
139
|
+
# [Drive](https://developers.google.com/drive/api/reference/rest/v3/drives)
|
140
|
+
# or a [Drive
|
141
|
+
# file](https://developers.google.com/drive/api/reference/rest/v3/files)
|
142
|
+
# that has mimeType set to `application/vnd.google-apps.folder`.
|
143
|
+
class DriveOptions
|
144
|
+
include ::Google::Protobuf::MessageExts
|
145
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
146
|
+
end
|
147
|
+
|
148
|
+
# Possible states for the subscription.
|
149
|
+
module State
|
150
|
+
# Default value. This value is unused.
|
151
|
+
STATE_UNSPECIFIED = 0
|
152
|
+
|
153
|
+
# The subscription is active and can receive and deliver events to its
|
154
|
+
# notification endpoint.
|
155
|
+
ACTIVE = 1
|
156
|
+
|
157
|
+
# The subscription is unable to receive events due to an error.
|
158
|
+
# To identify the error, see the
|
159
|
+
# {::Google::Apps::Events::Subscriptions::V1beta::Subscription#suspension_reason `suspension_reason`}
|
160
|
+
# field.
|
161
|
+
SUSPENDED = 2
|
162
|
+
|
163
|
+
# The subscription is deleted.
|
164
|
+
DELETED = 3
|
165
|
+
end
|
166
|
+
|
167
|
+
# Possible errors for a subscription.
|
168
|
+
module ErrorType
|
169
|
+
# Default value. This value is unused.
|
170
|
+
ERROR_TYPE_UNSPECIFIED = 0
|
171
|
+
|
172
|
+
# The authorizing user has revoked the grant of one or more OAuth scopes.
|
173
|
+
# To learn more about authorization for Google Workspace, see [Configure
|
174
|
+
# the OAuth consent
|
175
|
+
# screen](https://developers.google.com/workspace/guides/configure-oauth-consent#choose-scopes).
|
176
|
+
USER_SCOPE_REVOKED = 1
|
177
|
+
|
178
|
+
# The target resource for the subscription no longer exists.
|
179
|
+
RESOURCE_DELETED = 2
|
180
|
+
|
181
|
+
# The user that authorized the creation of the subscription no longer has
|
182
|
+
# access to the subscription's target resource.
|
183
|
+
USER_AUTHORIZATION_FAILURE = 3
|
184
|
+
|
185
|
+
# The Google Workspace application doesn't have access to deliver
|
186
|
+
# events to your subscription's notification endpoint.
|
187
|
+
ENDPOINT_PERMISSION_DENIED = 4
|
188
|
+
|
189
|
+
# The subscription's notification endpoint doesn't exist, or the endpoint
|
190
|
+
# can't be found in the Google Cloud project where you created the
|
191
|
+
# subscription.
|
192
|
+
ENDPOINT_NOT_FOUND = 6
|
193
|
+
|
194
|
+
# The subscription's notification endpoint failed to receive events due to
|
195
|
+
# insufficient quota or reaching rate limiting.
|
196
|
+
ENDPOINT_RESOURCE_EXHAUSTED = 7
|
197
|
+
|
198
|
+
# An unidentified error has occurred.
|
199
|
+
OTHER = 5
|
200
|
+
end
|
201
|
+
end
|
202
|
+
|
203
|
+
# Options about what data to include in the event payload. Only supported for
|
204
|
+
# Google Chat events.
|
205
|
+
# @!attribute [rw] include_resource
|
206
|
+
# @return [::Boolean]
|
207
|
+
# Optional. Whether the event payload includes data about the resource that
|
208
|
+
# changed. For example, for an event where a Google Chat message was created,
|
209
|
+
# whether the payload contains data about the
|
210
|
+
# [`Message`](https://developers.google.com/chat/api/reference/rest/v1/spaces.messages)
|
211
|
+
# resource. If false, the event payload only includes the name of the changed
|
212
|
+
# resource.
|
213
|
+
# @!attribute [rw] field_mask
|
214
|
+
# @return [::Google::Protobuf::FieldMask]
|
215
|
+
# Optional. If `include_resource` is set to `true`, the list of fields to
|
216
|
+
# include in the event payload. Separate fields with a comma. For example, to
|
217
|
+
# include a Google Chat message's sender and create time, enter
|
218
|
+
# `message.sender,message.createTime`. If omitted, the payload includes all
|
219
|
+
# fields for the resource.
|
220
|
+
#
|
221
|
+
# If you specify a field that doesn't exist for the resource, the system
|
222
|
+
# ignores the field.
|
223
|
+
class PayloadOptions
|
224
|
+
include ::Google::Protobuf::MessageExts
|
225
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
226
|
+
end
|
227
|
+
|
228
|
+
# The endpoint where the subscription delivers events.
|
229
|
+
# @!attribute [rw] pubsub_topic
|
230
|
+
# @return [::String]
|
231
|
+
# Immutable. The Pub/Sub topic that receives events for the subscription.
|
232
|
+
#
|
233
|
+
# Format: `projects/{project}/topics/{topic}`
|
234
|
+
#
|
235
|
+
#
|
236
|
+
# You must create the topic in the same Google Cloud project where
|
237
|
+
# you create this subscription.
|
238
|
+
#
|
239
|
+
# Note: The Workspace Events API uses [ordering
|
240
|
+
# keys](https://cloud.google.com/pubsub/docs/ordering) for the benefit of
|
241
|
+
# sequential events. If the Cloud Pub/Sub topic has a [message storage
|
242
|
+
# policy](https://cloud.google.com/pubsub/docs/resource-location-restriction#exceptions)
|
243
|
+
# configured to exclude the nearest Google Cloud region, publishing events
|
244
|
+
# with ordering keys will fail.
|
245
|
+
#
|
246
|
+
# When the topic receives events, the events are encoded as Pub/Sub
|
247
|
+
# messages. For details, see the [Google Cloud Pub/Sub Protocol Binding for
|
248
|
+
# CloudEvents](https://github.com/googleapis/google-cloudevents/blob/main/docs/spec/pubsub.md).
|
249
|
+
class NotificationEndpoint
|
250
|
+
include ::Google::Protobuf::MessageExts
|
251
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
252
|
+
end
|
253
|
+
end
|
254
|
+
end
|
255
|
+
end
|
256
|
+
end
|
257
|
+
end
|
@@ -0,0 +1,217 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
# Copyright 2025 Google LLC
|
4
|
+
#
|
5
|
+
# Licensed under the Apache License, Version 2.0 (the "License");
|
6
|
+
# you may not use this file except in compliance with the License.
|
7
|
+
# You may obtain a copy of the License at
|
8
|
+
#
|
9
|
+
# https://www.apache.org/licenses/LICENSE-2.0
|
10
|
+
#
|
11
|
+
# Unless required by applicable law or agreed to in writing, software
|
12
|
+
# distributed under the License is distributed on an "AS IS" BASIS,
|
13
|
+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
14
|
+
# See the License for the specific language governing permissions and
|
15
|
+
# limitations under the License.
|
16
|
+
|
17
|
+
# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
|
18
|
+
|
19
|
+
|
20
|
+
module Google
|
21
|
+
module Apps
|
22
|
+
module Events
|
23
|
+
module Subscriptions
|
24
|
+
module V1beta
|
25
|
+
# The request message for
|
26
|
+
# {::Google::Apps::Events::Subscriptions::V1beta::SubscriptionsService::Client#create_subscription SubscriptionsService.CreateSubscription}.
|
27
|
+
# @!attribute [rw] subscription
|
28
|
+
# @return [::Google::Apps::Events::Subscriptions::V1beta::Subscription]
|
29
|
+
# Required. The subscription resource to create.
|
30
|
+
# @!attribute [rw] validate_only
|
31
|
+
# @return [::Boolean]
|
32
|
+
# Optional. If set to `true`, validates and previews the request, but doesn't
|
33
|
+
# create the subscription.
|
34
|
+
class CreateSubscriptionRequest
|
35
|
+
include ::Google::Protobuf::MessageExts
|
36
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
37
|
+
end
|
38
|
+
|
39
|
+
# The request message for
|
40
|
+
# {::Google::Apps::Events::Subscriptions::V1beta::SubscriptionsService::Client#delete_subscription SubscriptionsService.DeleteSubscription}.
|
41
|
+
# @!attribute [rw] name
|
42
|
+
# @return [::String]
|
43
|
+
# Required. Resource name of the subscription to delete.
|
44
|
+
#
|
45
|
+
# Format: `subscriptions/{subscription}`
|
46
|
+
# @!attribute [rw] validate_only
|
47
|
+
# @return [::Boolean]
|
48
|
+
# Optional. If set to `true`, validates and previews the request, but doesn't
|
49
|
+
# delete the subscription.
|
50
|
+
# @!attribute [rw] allow_missing
|
51
|
+
# @return [::Boolean]
|
52
|
+
# Optional. If set to `true` and the subscription isn't found, the request
|
53
|
+
# succeeds but doesn't delete the subscription.
|
54
|
+
# @!attribute [rw] etag
|
55
|
+
# @return [::String]
|
56
|
+
# Optional. Etag of the subscription.
|
57
|
+
#
|
58
|
+
# If present, it must match with the server's etag. Otherwise, request
|
59
|
+
# fails with the status `ABORTED`.
|
60
|
+
class DeleteSubscriptionRequest
|
61
|
+
include ::Google::Protobuf::MessageExts
|
62
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
63
|
+
end
|
64
|
+
|
65
|
+
# The request message for
|
66
|
+
# {::Google::Apps::Events::Subscriptions::V1beta::SubscriptionsService::Client#get_subscription SubscriptionsService.GetSubscription}.
|
67
|
+
# @!attribute [rw] name
|
68
|
+
# @return [::String]
|
69
|
+
# Required. Resource name of the subscription.
|
70
|
+
#
|
71
|
+
# Format: `subscriptions/{subscription}`
|
72
|
+
class GetSubscriptionRequest
|
73
|
+
include ::Google::Protobuf::MessageExts
|
74
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
75
|
+
end
|
76
|
+
|
77
|
+
# The request message for
|
78
|
+
# {::Google::Apps::Events::Subscriptions::V1beta::SubscriptionsService::Client#update_subscription SubscriptionsService.UpdateSubscription}.
|
79
|
+
# @!attribute [rw] subscription
|
80
|
+
# @return [::Google::Apps::Events::Subscriptions::V1beta::Subscription]
|
81
|
+
# Required. The subscription to update.
|
82
|
+
#
|
83
|
+
# The subscription's `name` field is used to identify the subscription to
|
84
|
+
# update.
|
85
|
+
# @!attribute [rw] update_mask
|
86
|
+
# @return [::Google::Protobuf::FieldMask]
|
87
|
+
# Optional. The field to update. If omitted, updates any fields included in
|
88
|
+
# the request.
|
89
|
+
#
|
90
|
+
# You can update one of the following fields in a subscription:
|
91
|
+
#
|
92
|
+
# * {::Google::Apps::Events::Subscriptions::V1beta::Subscription#expire_time `expire_time`}: The timestamp when the
|
93
|
+
# subscription expires.
|
94
|
+
# * {::Google::Apps::Events::Subscriptions::V1beta::Subscription#ttl `ttl`}: The
|
95
|
+
# time-to-live (TTL) or duration of the
|
96
|
+
# subscription.
|
97
|
+
# * {::Google::Apps::Events::Subscriptions::V1beta::Subscription#event_types `event_types`}: The list of event types to
|
98
|
+
# receive about the target resource.
|
99
|
+
#
|
100
|
+
# To fully replace the subscription (the equivalent of `PUT`), use `*`. Any
|
101
|
+
# omitted fields are updated with empty values.
|
102
|
+
# @!attribute [rw] validate_only
|
103
|
+
# @return [::Boolean]
|
104
|
+
# Optional. If set to `true`, validates and previews the request, but doesn't
|
105
|
+
# update the subscription.
|
106
|
+
class UpdateSubscriptionRequest
|
107
|
+
include ::Google::Protobuf::MessageExts
|
108
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
109
|
+
end
|
110
|
+
|
111
|
+
# The request message for
|
112
|
+
# {::Google::Apps::Events::Subscriptions::V1beta::SubscriptionsService::Client#reactivate_subscription SubscriptionsService.ReactivateSubscription}.
|
113
|
+
# @!attribute [rw] name
|
114
|
+
# @return [::String]
|
115
|
+
# Required. Resource name of the subscription.
|
116
|
+
#
|
117
|
+
# Format: `subscriptions/{subscription}`
|
118
|
+
class ReactivateSubscriptionRequest
|
119
|
+
include ::Google::Protobuf::MessageExts
|
120
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
121
|
+
end
|
122
|
+
|
123
|
+
# The request message for
|
124
|
+
# {::Google::Apps::Events::Subscriptions::V1beta::SubscriptionsService::Client#list_subscriptions SubscriptionsService.ListSubscriptions}.
|
125
|
+
# @!attribute [rw] page_size
|
126
|
+
# @return [::Integer]
|
127
|
+
# Optional. The maximum number of subscriptions to return. The service might
|
128
|
+
# return fewer than this value.
|
129
|
+
#
|
130
|
+
# If unspecified or set to `0`, up to 50 subscriptions are returned.
|
131
|
+
#
|
132
|
+
# The maximum value is 100. If you specify a value more than 100, the system
|
133
|
+
# only returns 100 subscriptions.
|
134
|
+
# @!attribute [rw] page_token
|
135
|
+
# @return [::String]
|
136
|
+
# Optional. A page token, received from a previous list subscriptions call.
|
137
|
+
# Provide this parameter to retrieve the subsequent page.
|
138
|
+
#
|
139
|
+
# When paginating, the filter value should match the call that provided the
|
140
|
+
# page token. Passing a different value might lead to unexpected results.
|
141
|
+
# @!attribute [rw] filter
|
142
|
+
# @return [::String]
|
143
|
+
# Required. A query filter.
|
144
|
+
#
|
145
|
+
# You can filter subscriptions by event type (`event_types`)
|
146
|
+
# and target resource (`target_resource`).
|
147
|
+
#
|
148
|
+
# You must specify at least one event type in your query. To filter for
|
149
|
+
# multiple event types, use the `OR` operator.
|
150
|
+
#
|
151
|
+
# To filter by both event type and target resource, use the `AND` operator
|
152
|
+
# and specify the full resource name, such as
|
153
|
+
# `//chat.googleapis.com/spaces/{space}`.
|
154
|
+
#
|
155
|
+
# For example, the following queries are valid:
|
156
|
+
#
|
157
|
+
# ```
|
158
|
+
# event_types:"google.workspace.chat.membership.v1.updated" OR
|
159
|
+
# event_types:"google.workspace.chat.message.v1.created"
|
160
|
+
#
|
161
|
+
# event_types:"google.workspace.chat.message.v1.created" AND
|
162
|
+
# target_resource="//chat.googleapis.com/spaces/\\{space}"
|
163
|
+
#
|
164
|
+
# ( event_types:"google.workspace.chat.membership.v1.updated" OR
|
165
|
+
# event_types:"google.workspace.chat.message.v1.created" ) AND
|
166
|
+
# target_resource="//chat.googleapis.com/spaces/\\{space}"
|
167
|
+
# ```
|
168
|
+
#
|
169
|
+
# The server rejects invalid queries with an `INVALID_ARGUMENT`
|
170
|
+
# error.
|
171
|
+
class ListSubscriptionsRequest
|
172
|
+
include ::Google::Protobuf::MessageExts
|
173
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
174
|
+
end
|
175
|
+
|
176
|
+
# The response message for
|
177
|
+
# {::Google::Apps::Events::Subscriptions::V1beta::SubscriptionsService::Client#list_subscriptions SubscriptionsService.ListSubscriptions}.
|
178
|
+
# @!attribute [rw] subscriptions
|
179
|
+
# @return [::Array<::Google::Apps::Events::Subscriptions::V1beta::Subscription>]
|
180
|
+
# List of subscriptions.
|
181
|
+
# @!attribute [rw] next_page_token
|
182
|
+
# @return [::String]
|
183
|
+
# A token, which can be sent as `page_token` to retrieve the next page.
|
184
|
+
# If this field is omitted, there are no subsequent pages.
|
185
|
+
class ListSubscriptionsResponse
|
186
|
+
include ::Google::Protobuf::MessageExts
|
187
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
188
|
+
end
|
189
|
+
|
190
|
+
# Metadata for UpdateSubscription LRO.
|
191
|
+
class UpdateSubscriptionMetadata
|
192
|
+
include ::Google::Protobuf::MessageExts
|
193
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
194
|
+
end
|
195
|
+
|
196
|
+
# Metadata for CreateSubscription LRO.
|
197
|
+
class CreateSubscriptionMetadata
|
198
|
+
include ::Google::Protobuf::MessageExts
|
199
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
200
|
+
end
|
201
|
+
|
202
|
+
# Metadata for DeleteSubscription LRO.
|
203
|
+
class DeleteSubscriptionMetadata
|
204
|
+
include ::Google::Protobuf::MessageExts
|
205
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
206
|
+
end
|
207
|
+
|
208
|
+
# Metadata for ReactivateSubscription LRO.
|
209
|
+
class ReactivateSubscriptionMetadata
|
210
|
+
include ::Google::Protobuf::MessageExts
|
211
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
212
|
+
end
|
213
|
+
end
|
214
|
+
end
|
215
|
+
end
|
216
|
+
end
|
217
|
+
end
|
@@ -0,0 +1,173 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
# Copyright 2025 Google LLC
|
4
|
+
#
|
5
|
+
# Licensed under the Apache License, Version 2.0 (the "License");
|
6
|
+
# you may not use this file except in compliance with the License.
|
7
|
+
# You may obtain a copy of the License at
|
8
|
+
#
|
9
|
+
# https://www.apache.org/licenses/LICENSE-2.0
|
10
|
+
#
|
11
|
+
# Unless required by applicable law or agreed to in writing, software
|
12
|
+
# distributed under the License is distributed on an "AS IS" BASIS,
|
13
|
+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
14
|
+
# See the License for the specific language governing permissions and
|
15
|
+
# limitations under the License.
|
16
|
+
|
17
|
+
# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
|
18
|
+
|
19
|
+
|
20
|
+
module Google
|
21
|
+
module Longrunning
|
22
|
+
# This resource represents a long-running operation that is the result of a
|
23
|
+
# network API call.
|
24
|
+
# @!attribute [rw] name
|
25
|
+
# @return [::String]
|
26
|
+
# The server-assigned name, which is only unique within the same service that
|
27
|
+
# originally returns it. If you use the default HTTP mapping, the
|
28
|
+
# `name` should be a resource name ending with `operations/{unique_id}`.
|
29
|
+
# @!attribute [rw] metadata
|
30
|
+
# @return [::Google::Protobuf::Any]
|
31
|
+
# Service-specific metadata associated with the operation. It typically
|
32
|
+
# contains progress information and common metadata such as create time.
|
33
|
+
# Some services might not provide such metadata. Any method that returns a
|
34
|
+
# long-running operation should document the metadata type, if any.
|
35
|
+
# @!attribute [rw] done
|
36
|
+
# @return [::Boolean]
|
37
|
+
# If the value is `false`, it means the operation is still in progress.
|
38
|
+
# If `true`, the operation is completed, and either `error` or `response` is
|
39
|
+
# available.
|
40
|
+
# @!attribute [rw] error
|
41
|
+
# @return [::Google::Rpc::Status]
|
42
|
+
# The error result of the operation in case of failure or cancellation.
|
43
|
+
#
|
44
|
+
# Note: The following fields are mutually exclusive: `error`, `response`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
45
|
+
# @!attribute [rw] response
|
46
|
+
# @return [::Google::Protobuf::Any]
|
47
|
+
# The normal, successful response of the operation. If the original
|
48
|
+
# method returns no data on success, such as `Delete`, the response is
|
49
|
+
# `google.protobuf.Empty`. If the original method is standard
|
50
|
+
# `Get`/`Create`/`Update`, the response should be the resource. For other
|
51
|
+
# methods, the response should have the type `XxxResponse`, where `Xxx`
|
52
|
+
# is the original method name. For example, if the original method name
|
53
|
+
# is `TakeSnapshot()`, the inferred response type is
|
54
|
+
# `TakeSnapshotResponse`.
|
55
|
+
#
|
56
|
+
# Note: The following fields are mutually exclusive: `response`, `error`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
57
|
+
class Operation
|
58
|
+
include ::Google::Protobuf::MessageExts
|
59
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
60
|
+
end
|
61
|
+
|
62
|
+
# The request message for
|
63
|
+
# Operations.GetOperation.
|
64
|
+
# @!attribute [rw] name
|
65
|
+
# @return [::String]
|
66
|
+
# The name of the operation resource.
|
67
|
+
class GetOperationRequest
|
68
|
+
include ::Google::Protobuf::MessageExts
|
69
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
70
|
+
end
|
71
|
+
|
72
|
+
# The request message for
|
73
|
+
# Operations.ListOperations.
|
74
|
+
# @!attribute [rw] name
|
75
|
+
# @return [::String]
|
76
|
+
# The name of the operation's parent resource.
|
77
|
+
# @!attribute [rw] filter
|
78
|
+
# @return [::String]
|
79
|
+
# The standard list filter.
|
80
|
+
# @!attribute [rw] page_size
|
81
|
+
# @return [::Integer]
|
82
|
+
# The standard list page size.
|
83
|
+
# @!attribute [rw] page_token
|
84
|
+
# @return [::String]
|
85
|
+
# The standard list page token.
|
86
|
+
class ListOperationsRequest
|
87
|
+
include ::Google::Protobuf::MessageExts
|
88
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
89
|
+
end
|
90
|
+
|
91
|
+
# The response message for
|
92
|
+
# Operations.ListOperations.
|
93
|
+
# @!attribute [rw] operations
|
94
|
+
# @return [::Array<::Google::Longrunning::Operation>]
|
95
|
+
# A list of operations that matches the specified filter in the request.
|
96
|
+
# @!attribute [rw] next_page_token
|
97
|
+
# @return [::String]
|
98
|
+
# The standard List next-page token.
|
99
|
+
class ListOperationsResponse
|
100
|
+
include ::Google::Protobuf::MessageExts
|
101
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
102
|
+
end
|
103
|
+
|
104
|
+
# The request message for
|
105
|
+
# Operations.CancelOperation.
|
106
|
+
# @!attribute [rw] name
|
107
|
+
# @return [::String]
|
108
|
+
# The name of the operation resource to be cancelled.
|
109
|
+
class CancelOperationRequest
|
110
|
+
include ::Google::Protobuf::MessageExts
|
111
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
112
|
+
end
|
113
|
+
|
114
|
+
# The request message for
|
115
|
+
# Operations.DeleteOperation.
|
116
|
+
# @!attribute [rw] name
|
117
|
+
# @return [::String]
|
118
|
+
# The name of the operation resource to be deleted.
|
119
|
+
class DeleteOperationRequest
|
120
|
+
include ::Google::Protobuf::MessageExts
|
121
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
122
|
+
end
|
123
|
+
|
124
|
+
# The request message for
|
125
|
+
# Operations.WaitOperation.
|
126
|
+
# @!attribute [rw] name
|
127
|
+
# @return [::String]
|
128
|
+
# The name of the operation resource to wait on.
|
129
|
+
# @!attribute [rw] timeout
|
130
|
+
# @return [::Google::Protobuf::Duration]
|
131
|
+
# The maximum duration to wait before timing out. If left blank, the wait
|
132
|
+
# will be at most the time permitted by the underlying HTTP/RPC protocol.
|
133
|
+
# If RPC context deadline is also specified, the shorter one will be used.
|
134
|
+
class WaitOperationRequest
|
135
|
+
include ::Google::Protobuf::MessageExts
|
136
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
137
|
+
end
|
138
|
+
|
139
|
+
# A message representing the message types used by a long-running operation.
|
140
|
+
#
|
141
|
+
# Example:
|
142
|
+
#
|
143
|
+
# rpc Export(ExportRequest) returns (google.longrunning.Operation) {
|
144
|
+
# option (google.longrunning.operation_info) = {
|
145
|
+
# response_type: "ExportResponse"
|
146
|
+
# metadata_type: "ExportMetadata"
|
147
|
+
# };
|
148
|
+
# }
|
149
|
+
# @!attribute [rw] response_type
|
150
|
+
# @return [::String]
|
151
|
+
# Required. The message name of the primary return type for this
|
152
|
+
# long-running operation.
|
153
|
+
# This type will be used to deserialize the LRO's response.
|
154
|
+
#
|
155
|
+
# If the response is in a different package from the rpc, a fully-qualified
|
156
|
+
# message name must be used (e.g. `google.protobuf.Struct`).
|
157
|
+
#
|
158
|
+
# Note: Altering this value constitutes a breaking change.
|
159
|
+
# @!attribute [rw] metadata_type
|
160
|
+
# @return [::String]
|
161
|
+
# Required. The message name of the metadata type for this long-running
|
162
|
+
# operation.
|
163
|
+
#
|
164
|
+
# If the response is in a different package from the rpc, a fully-qualified
|
165
|
+
# message name must be used (e.g. `google.protobuf.Struct`).
|
166
|
+
#
|
167
|
+
# Note: Altering this value constitutes a breaking change.
|
168
|
+
class OperationInfo
|
169
|
+
include ::Google::Protobuf::MessageExts
|
170
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
171
|
+
end
|
172
|
+
end
|
173
|
+
end
|