google-apis-workspaceevents_v1 0.18.0 → 0.20.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/CHANGELOG.md +8 -0
- data/lib/google/apis/workspaceevents_v1/classes.rb +681 -0
- data/lib/google/apis/workspaceevents_v1/gem_version.rb +2 -2
- data/lib/google/apis/workspaceevents_v1/representations.rb +299 -0
- data/lib/google/apis/workspaceevents_v1/service.rb +270 -0
- metadata +2 -2
|
@@ -16,13 +16,13 @@ module Google
|
|
|
16
16
|
module Apis
|
|
17
17
|
module WorkspaceeventsV1
|
|
18
18
|
# Version of the google-apis-workspaceevents_v1 gem
|
|
19
|
-
GEM_VERSION = "0.
|
|
19
|
+
GEM_VERSION = "0.20.0"
|
|
20
20
|
|
|
21
21
|
# Version of the code generator used to generate this client
|
|
22
22
|
GENERATOR_VERSION = "0.18.0"
|
|
23
23
|
|
|
24
24
|
# Revision of the discovery document this client was generated from
|
|
25
|
-
REVISION = "
|
|
25
|
+
REVISION = "20251118"
|
|
26
26
|
end
|
|
27
27
|
end
|
|
28
28
|
end
|
|
@@ -22,12 +22,60 @@ module Google
|
|
|
22
22
|
module Apis
|
|
23
23
|
module WorkspaceeventsV1
|
|
24
24
|
|
|
25
|
+
class Artifact
|
|
26
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
|
27
|
+
|
|
28
|
+
include Google::Apis::Core::JsonObjectSupport
|
|
29
|
+
end
|
|
30
|
+
|
|
31
|
+
class AuthenticationInfo
|
|
32
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
|
33
|
+
|
|
34
|
+
include Google::Apis::Core::JsonObjectSupport
|
|
35
|
+
end
|
|
36
|
+
|
|
37
|
+
class CancelTaskRequest
|
|
38
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
|
39
|
+
|
|
40
|
+
include Google::Apis::Core::JsonObjectSupport
|
|
41
|
+
end
|
|
42
|
+
|
|
43
|
+
class DataPart
|
|
44
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
|
45
|
+
|
|
46
|
+
include Google::Apis::Core::JsonObjectSupport
|
|
47
|
+
end
|
|
48
|
+
|
|
49
|
+
class Empty
|
|
50
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
|
51
|
+
|
|
52
|
+
include Google::Apis::Core::JsonObjectSupport
|
|
53
|
+
end
|
|
54
|
+
|
|
55
|
+
class FilePart
|
|
56
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
|
57
|
+
|
|
58
|
+
include Google::Apis::Core::JsonObjectSupport
|
|
59
|
+
end
|
|
60
|
+
|
|
25
61
|
class ListSubscriptionsResponse
|
|
26
62
|
class Representation < Google::Apis::Core::JsonRepresentation; end
|
|
27
63
|
|
|
28
64
|
include Google::Apis::Core::JsonObjectSupport
|
|
29
65
|
end
|
|
30
66
|
|
|
67
|
+
class ListTaskPushNotificationConfigResponse
|
|
68
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
|
69
|
+
|
|
70
|
+
include Google::Apis::Core::JsonObjectSupport
|
|
71
|
+
end
|
|
72
|
+
|
|
73
|
+
class Message
|
|
74
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
|
75
|
+
|
|
76
|
+
include Google::Apis::Core::JsonObjectSupport
|
|
77
|
+
end
|
|
78
|
+
|
|
31
79
|
class NotificationEndpoint
|
|
32
80
|
class Representation < Google::Apis::Core::JsonRepresentation; end
|
|
33
81
|
|
|
@@ -40,30 +88,140 @@ module Google
|
|
|
40
88
|
include Google::Apis::Core::JsonObjectSupport
|
|
41
89
|
end
|
|
42
90
|
|
|
91
|
+
class Part
|
|
92
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
|
93
|
+
|
|
94
|
+
include Google::Apis::Core::JsonObjectSupport
|
|
95
|
+
end
|
|
96
|
+
|
|
43
97
|
class PayloadOptions
|
|
44
98
|
class Representation < Google::Apis::Core::JsonRepresentation; end
|
|
45
99
|
|
|
46
100
|
include Google::Apis::Core::JsonObjectSupport
|
|
47
101
|
end
|
|
48
102
|
|
|
103
|
+
class PushNotificationConfig
|
|
104
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
|
105
|
+
|
|
106
|
+
include Google::Apis::Core::JsonObjectSupport
|
|
107
|
+
end
|
|
108
|
+
|
|
49
109
|
class ReactivateSubscriptionRequest
|
|
50
110
|
class Representation < Google::Apis::Core::JsonRepresentation; end
|
|
51
111
|
|
|
52
112
|
include Google::Apis::Core::JsonObjectSupport
|
|
53
113
|
end
|
|
54
114
|
|
|
115
|
+
class SendMessageConfiguration
|
|
116
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
|
117
|
+
|
|
118
|
+
include Google::Apis::Core::JsonObjectSupport
|
|
119
|
+
end
|
|
120
|
+
|
|
121
|
+
class SendMessageRequest
|
|
122
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
|
123
|
+
|
|
124
|
+
include Google::Apis::Core::JsonObjectSupport
|
|
125
|
+
end
|
|
126
|
+
|
|
55
127
|
class Status
|
|
56
128
|
class Representation < Google::Apis::Core::JsonRepresentation; end
|
|
57
129
|
|
|
58
130
|
include Google::Apis::Core::JsonObjectSupport
|
|
59
131
|
end
|
|
60
132
|
|
|
133
|
+
class StreamResponse
|
|
134
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
|
135
|
+
|
|
136
|
+
include Google::Apis::Core::JsonObjectSupport
|
|
137
|
+
end
|
|
138
|
+
|
|
61
139
|
class Subscription
|
|
62
140
|
class Representation < Google::Apis::Core::JsonRepresentation; end
|
|
63
141
|
|
|
64
142
|
include Google::Apis::Core::JsonObjectSupport
|
|
65
143
|
end
|
|
66
144
|
|
|
145
|
+
class Task
|
|
146
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
|
147
|
+
|
|
148
|
+
include Google::Apis::Core::JsonObjectSupport
|
|
149
|
+
end
|
|
150
|
+
|
|
151
|
+
class TaskArtifactUpdateEvent
|
|
152
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
|
153
|
+
|
|
154
|
+
include Google::Apis::Core::JsonObjectSupport
|
|
155
|
+
end
|
|
156
|
+
|
|
157
|
+
class TaskPushNotificationConfig
|
|
158
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
|
159
|
+
|
|
160
|
+
include Google::Apis::Core::JsonObjectSupport
|
|
161
|
+
end
|
|
162
|
+
|
|
163
|
+
class TaskStatus
|
|
164
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
|
165
|
+
|
|
166
|
+
include Google::Apis::Core::JsonObjectSupport
|
|
167
|
+
end
|
|
168
|
+
|
|
169
|
+
class TaskStatusUpdateEvent
|
|
170
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
|
171
|
+
|
|
172
|
+
include Google::Apis::Core::JsonObjectSupport
|
|
173
|
+
end
|
|
174
|
+
|
|
175
|
+
class Artifact
|
|
176
|
+
# @private
|
|
177
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
|
178
|
+
property :artifact_id, as: 'artifactId'
|
|
179
|
+
property :description, as: 'description'
|
|
180
|
+
collection :extensions, as: 'extensions'
|
|
181
|
+
hash :metadata, as: 'metadata'
|
|
182
|
+
property :name, as: 'name'
|
|
183
|
+
collection :parts, as: 'parts', class: Google::Apis::WorkspaceeventsV1::Part, decorator: Google::Apis::WorkspaceeventsV1::Part::Representation
|
|
184
|
+
|
|
185
|
+
end
|
|
186
|
+
end
|
|
187
|
+
|
|
188
|
+
class AuthenticationInfo
|
|
189
|
+
# @private
|
|
190
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
|
191
|
+
property :credentials, as: 'credentials'
|
|
192
|
+
collection :schemes, as: 'schemes'
|
|
193
|
+
end
|
|
194
|
+
end
|
|
195
|
+
|
|
196
|
+
class CancelTaskRequest
|
|
197
|
+
# @private
|
|
198
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
|
199
|
+
end
|
|
200
|
+
end
|
|
201
|
+
|
|
202
|
+
class DataPart
|
|
203
|
+
# @private
|
|
204
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
|
205
|
+
hash :data, as: 'data'
|
|
206
|
+
end
|
|
207
|
+
end
|
|
208
|
+
|
|
209
|
+
class Empty
|
|
210
|
+
# @private
|
|
211
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
|
212
|
+
end
|
|
213
|
+
end
|
|
214
|
+
|
|
215
|
+
class FilePart
|
|
216
|
+
# @private
|
|
217
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
|
218
|
+
property :file_with_bytes, :base64 => true, as: 'fileWithBytes'
|
|
219
|
+
property :file_with_uri, as: 'fileWithUri'
|
|
220
|
+
property :mime_type, as: 'mimeType'
|
|
221
|
+
property :name, as: 'name'
|
|
222
|
+
end
|
|
223
|
+
end
|
|
224
|
+
|
|
67
225
|
class ListSubscriptionsResponse
|
|
68
226
|
# @private
|
|
69
227
|
class Representation < Google::Apis::Core::JsonRepresentation
|
|
@@ -73,6 +231,29 @@ module Google
|
|
|
73
231
|
end
|
|
74
232
|
end
|
|
75
233
|
|
|
234
|
+
class ListTaskPushNotificationConfigResponse
|
|
235
|
+
# @private
|
|
236
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
|
237
|
+
collection :configs, as: 'configs', class: Google::Apis::WorkspaceeventsV1::TaskPushNotificationConfig, decorator: Google::Apis::WorkspaceeventsV1::TaskPushNotificationConfig::Representation
|
|
238
|
+
|
|
239
|
+
property :next_page_token, as: 'nextPageToken'
|
|
240
|
+
end
|
|
241
|
+
end
|
|
242
|
+
|
|
243
|
+
class Message
|
|
244
|
+
# @private
|
|
245
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
|
246
|
+
collection :content, as: 'content', class: Google::Apis::WorkspaceeventsV1::Part, decorator: Google::Apis::WorkspaceeventsV1::Part::Representation
|
|
247
|
+
|
|
248
|
+
property :context_id, as: 'contextId'
|
|
249
|
+
collection :extensions, as: 'extensions'
|
|
250
|
+
property :message_id, as: 'messageId'
|
|
251
|
+
hash :metadata, as: 'metadata'
|
|
252
|
+
property :role, as: 'role'
|
|
253
|
+
property :task_id, as: 'taskId'
|
|
254
|
+
end
|
|
255
|
+
end
|
|
256
|
+
|
|
76
257
|
class NotificationEndpoint
|
|
77
258
|
# @private
|
|
78
259
|
class Representation < Google::Apis::Core::JsonRepresentation
|
|
@@ -92,6 +273,18 @@ module Google
|
|
|
92
273
|
end
|
|
93
274
|
end
|
|
94
275
|
|
|
276
|
+
class Part
|
|
277
|
+
# @private
|
|
278
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
|
279
|
+
property :data, as: 'data', class: Google::Apis::WorkspaceeventsV1::DataPart, decorator: Google::Apis::WorkspaceeventsV1::DataPart::Representation
|
|
280
|
+
|
|
281
|
+
property :file, as: 'file', class: Google::Apis::WorkspaceeventsV1::FilePart, decorator: Google::Apis::WorkspaceeventsV1::FilePart::Representation
|
|
282
|
+
|
|
283
|
+
hash :metadata, as: 'metadata'
|
|
284
|
+
property :text, as: 'text'
|
|
285
|
+
end
|
|
286
|
+
end
|
|
287
|
+
|
|
95
288
|
class PayloadOptions
|
|
96
289
|
# @private
|
|
97
290
|
class Representation < Google::Apis::Core::JsonRepresentation
|
|
@@ -100,12 +293,45 @@ module Google
|
|
|
100
293
|
end
|
|
101
294
|
end
|
|
102
295
|
|
|
296
|
+
class PushNotificationConfig
|
|
297
|
+
# @private
|
|
298
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
|
299
|
+
property :authentication, as: 'authentication', class: Google::Apis::WorkspaceeventsV1::AuthenticationInfo, decorator: Google::Apis::WorkspaceeventsV1::AuthenticationInfo::Representation
|
|
300
|
+
|
|
301
|
+
property :id, as: 'id'
|
|
302
|
+
property :token, as: 'token'
|
|
303
|
+
property :url, as: 'url'
|
|
304
|
+
end
|
|
305
|
+
end
|
|
306
|
+
|
|
103
307
|
class ReactivateSubscriptionRequest
|
|
104
308
|
# @private
|
|
105
309
|
class Representation < Google::Apis::Core::JsonRepresentation
|
|
106
310
|
end
|
|
107
311
|
end
|
|
108
312
|
|
|
313
|
+
class SendMessageConfiguration
|
|
314
|
+
# @private
|
|
315
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
|
316
|
+
collection :accepted_output_modes, as: 'acceptedOutputModes'
|
|
317
|
+
property :blocking, as: 'blocking'
|
|
318
|
+
property :history_length, as: 'historyLength'
|
|
319
|
+
property :push_notification, as: 'pushNotification', class: Google::Apis::WorkspaceeventsV1::PushNotificationConfig, decorator: Google::Apis::WorkspaceeventsV1::PushNotificationConfig::Representation
|
|
320
|
+
|
|
321
|
+
end
|
|
322
|
+
end
|
|
323
|
+
|
|
324
|
+
class SendMessageRequest
|
|
325
|
+
# @private
|
|
326
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
|
327
|
+
property :configuration, as: 'configuration', class: Google::Apis::WorkspaceeventsV1::SendMessageConfiguration, decorator: Google::Apis::WorkspaceeventsV1::SendMessageConfiguration::Representation
|
|
328
|
+
|
|
329
|
+
property :message, as: 'message', class: Google::Apis::WorkspaceeventsV1::Message, decorator: Google::Apis::WorkspaceeventsV1::Message::Representation
|
|
330
|
+
|
|
331
|
+
hash :metadata, as: 'metadata'
|
|
332
|
+
end
|
|
333
|
+
end
|
|
334
|
+
|
|
109
335
|
class Status
|
|
110
336
|
# @private
|
|
111
337
|
class Representation < Google::Apis::Core::JsonRepresentation
|
|
@@ -115,6 +341,20 @@ module Google
|
|
|
115
341
|
end
|
|
116
342
|
end
|
|
117
343
|
|
|
344
|
+
class StreamResponse
|
|
345
|
+
# @private
|
|
346
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
|
347
|
+
property :artifact_update, as: 'artifactUpdate', class: Google::Apis::WorkspaceeventsV1::TaskArtifactUpdateEvent, decorator: Google::Apis::WorkspaceeventsV1::TaskArtifactUpdateEvent::Representation
|
|
348
|
+
|
|
349
|
+
property :message, as: 'message', class: Google::Apis::WorkspaceeventsV1::Message, decorator: Google::Apis::WorkspaceeventsV1::Message::Representation
|
|
350
|
+
|
|
351
|
+
property :status_update, as: 'statusUpdate', class: Google::Apis::WorkspaceeventsV1::TaskStatusUpdateEvent, decorator: Google::Apis::WorkspaceeventsV1::TaskStatusUpdateEvent::Representation
|
|
352
|
+
|
|
353
|
+
property :task, as: 'task', class: Google::Apis::WorkspaceeventsV1::Task, decorator: Google::Apis::WorkspaceeventsV1::Task::Representation
|
|
354
|
+
|
|
355
|
+
end
|
|
356
|
+
end
|
|
357
|
+
|
|
118
358
|
class Subscription
|
|
119
359
|
# @private
|
|
120
360
|
class Representation < Google::Apis::Core::JsonRepresentation
|
|
@@ -137,6 +377,65 @@ module Google
|
|
|
137
377
|
property :update_time, as: 'updateTime'
|
|
138
378
|
end
|
|
139
379
|
end
|
|
380
|
+
|
|
381
|
+
class Task
|
|
382
|
+
# @private
|
|
383
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
|
384
|
+
collection :artifacts, as: 'artifacts', class: Google::Apis::WorkspaceeventsV1::Artifact, decorator: Google::Apis::WorkspaceeventsV1::Artifact::Representation
|
|
385
|
+
|
|
386
|
+
property :context_id, as: 'contextId'
|
|
387
|
+
collection :history, as: 'history', class: Google::Apis::WorkspaceeventsV1::Message, decorator: Google::Apis::WorkspaceeventsV1::Message::Representation
|
|
388
|
+
|
|
389
|
+
property :id, as: 'id'
|
|
390
|
+
hash :metadata, as: 'metadata'
|
|
391
|
+
property :status, as: 'status', class: Google::Apis::WorkspaceeventsV1::TaskStatus, decorator: Google::Apis::WorkspaceeventsV1::TaskStatus::Representation
|
|
392
|
+
|
|
393
|
+
end
|
|
394
|
+
end
|
|
395
|
+
|
|
396
|
+
class TaskArtifactUpdateEvent
|
|
397
|
+
# @private
|
|
398
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
|
399
|
+
property :append, as: 'append'
|
|
400
|
+
property :artifact, as: 'artifact', class: Google::Apis::WorkspaceeventsV1::Artifact, decorator: Google::Apis::WorkspaceeventsV1::Artifact::Representation
|
|
401
|
+
|
|
402
|
+
property :context_id, as: 'contextId'
|
|
403
|
+
property :last_chunk, as: 'lastChunk'
|
|
404
|
+
hash :metadata, as: 'metadata'
|
|
405
|
+
property :task_id, as: 'taskId'
|
|
406
|
+
end
|
|
407
|
+
end
|
|
408
|
+
|
|
409
|
+
class TaskPushNotificationConfig
|
|
410
|
+
# @private
|
|
411
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
|
412
|
+
property :name, as: 'name'
|
|
413
|
+
property :push_notification_config, as: 'pushNotificationConfig', class: Google::Apis::WorkspaceeventsV1::PushNotificationConfig, decorator: Google::Apis::WorkspaceeventsV1::PushNotificationConfig::Representation
|
|
414
|
+
|
|
415
|
+
end
|
|
416
|
+
end
|
|
417
|
+
|
|
418
|
+
class TaskStatus
|
|
419
|
+
# @private
|
|
420
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
|
421
|
+
property :message, as: 'message', class: Google::Apis::WorkspaceeventsV1::Message, decorator: Google::Apis::WorkspaceeventsV1::Message::Representation
|
|
422
|
+
|
|
423
|
+
property :state, as: 'state'
|
|
424
|
+
property :timestamp, as: 'timestamp'
|
|
425
|
+
end
|
|
426
|
+
end
|
|
427
|
+
|
|
428
|
+
class TaskStatusUpdateEvent
|
|
429
|
+
# @private
|
|
430
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
|
431
|
+
property :context_id, as: 'contextId'
|
|
432
|
+
property :final, as: 'final'
|
|
433
|
+
hash :metadata, as: 'metadata'
|
|
434
|
+
property :status, as: 'status', class: Google::Apis::WorkspaceeventsV1::TaskStatus, decorator: Google::Apis::WorkspaceeventsV1::TaskStatus::Representation
|
|
435
|
+
|
|
436
|
+
property :task_id, as: 'taskId'
|
|
437
|
+
end
|
|
438
|
+
end
|
|
140
439
|
end
|
|
141
440
|
end
|
|
142
441
|
end
|
|
@@ -52,6 +52,37 @@ module Google
|
|
|
52
52
|
@batch_path = 'batch'
|
|
53
53
|
end
|
|
54
54
|
|
|
55
|
+
# SendStreamingMessage is a streaming call that will return a stream of task
|
|
56
|
+
# update events until the Task is in an interrupted or terminal state.
|
|
57
|
+
# @param [Google::Apis::WorkspaceeventsV1::SendMessageRequest] send_message_request_object
|
|
58
|
+
# @param [String] fields
|
|
59
|
+
# Selector specifying which fields to include in a partial response.
|
|
60
|
+
# @param [String] quota_user
|
|
61
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
62
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
63
|
+
# @param [Google::Apis::RequestOptions] options
|
|
64
|
+
# Request-specific options
|
|
65
|
+
#
|
|
66
|
+
# @yield [result, err] Result & error if block supplied
|
|
67
|
+
# @yieldparam result [Google::Apis::WorkspaceeventsV1::StreamResponse] parsed result object
|
|
68
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
69
|
+
#
|
|
70
|
+
# @return [Google::Apis::WorkspaceeventsV1::StreamResponse]
|
|
71
|
+
#
|
|
72
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
73
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
74
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
75
|
+
def stream_message(send_message_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
76
|
+
command = make_simple_command(:post, 'v1/message:stream', options)
|
|
77
|
+
command.request_representation = Google::Apis::WorkspaceeventsV1::SendMessageRequest::Representation
|
|
78
|
+
command.request_object = send_message_request_object
|
|
79
|
+
command.response_representation = Google::Apis::WorkspaceeventsV1::StreamResponse::Representation
|
|
80
|
+
command.response_class = Google::Apis::WorkspaceeventsV1::StreamResponse
|
|
81
|
+
command.query['fields'] = fields unless fields.nil?
|
|
82
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
83
|
+
execute_or_queue_command(command, &block)
|
|
84
|
+
end
|
|
85
|
+
|
|
55
86
|
# Gets the latest state of a long-running operation. Clients can use this method
|
|
56
87
|
# to poll the operation result at intervals as recommended by the API service.
|
|
57
88
|
# @param [String] name
|
|
@@ -370,6 +401,245 @@ module Google
|
|
|
370
401
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
371
402
|
execute_or_queue_command(command, &block)
|
|
372
403
|
end
|
|
404
|
+
|
|
405
|
+
# Cancel a task from the agent. If supported one should expect no more task
|
|
406
|
+
# updates for the task.
|
|
407
|
+
# @param [String] name
|
|
408
|
+
# The resource name of the task to cancel. Format: tasks/`task_id`
|
|
409
|
+
# @param [Google::Apis::WorkspaceeventsV1::CancelTaskRequest] cancel_task_request_object
|
|
410
|
+
# @param [String] fields
|
|
411
|
+
# Selector specifying which fields to include in a partial response.
|
|
412
|
+
# @param [String] quota_user
|
|
413
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
414
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
415
|
+
# @param [Google::Apis::RequestOptions] options
|
|
416
|
+
# Request-specific options
|
|
417
|
+
#
|
|
418
|
+
# @yield [result, err] Result & error if block supplied
|
|
419
|
+
# @yieldparam result [Google::Apis::WorkspaceeventsV1::Task] parsed result object
|
|
420
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
421
|
+
#
|
|
422
|
+
# @return [Google::Apis::WorkspaceeventsV1::Task]
|
|
423
|
+
#
|
|
424
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
425
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
426
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
427
|
+
def cancel_task(name, cancel_task_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
428
|
+
command = make_simple_command(:post, 'v1/{+name}:cancel', options)
|
|
429
|
+
command.request_representation = Google::Apis::WorkspaceeventsV1::CancelTaskRequest::Representation
|
|
430
|
+
command.request_object = cancel_task_request_object
|
|
431
|
+
command.response_representation = Google::Apis::WorkspaceeventsV1::Task::Representation
|
|
432
|
+
command.response_class = Google::Apis::WorkspaceeventsV1::Task
|
|
433
|
+
command.params['name'] = name unless name.nil?
|
|
434
|
+
command.query['fields'] = fields unless fields.nil?
|
|
435
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
436
|
+
execute_or_queue_command(command, &block)
|
|
437
|
+
end
|
|
438
|
+
|
|
439
|
+
# Get the current state of a task from the agent.
|
|
440
|
+
# @param [String] name
|
|
441
|
+
# Required. The resource name of the task. Format: tasks/`task_id`
|
|
442
|
+
# @param [Fixnum] history_length
|
|
443
|
+
# The number of most recent messages from the task's history to retrieve.
|
|
444
|
+
# @param [String] fields
|
|
445
|
+
# Selector specifying which fields to include in a partial response.
|
|
446
|
+
# @param [String] quota_user
|
|
447
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
448
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
449
|
+
# @param [Google::Apis::RequestOptions] options
|
|
450
|
+
# Request-specific options
|
|
451
|
+
#
|
|
452
|
+
# @yield [result, err] Result & error if block supplied
|
|
453
|
+
# @yieldparam result [Google::Apis::WorkspaceeventsV1::Task] parsed result object
|
|
454
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
455
|
+
#
|
|
456
|
+
# @return [Google::Apis::WorkspaceeventsV1::Task]
|
|
457
|
+
#
|
|
458
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
459
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
460
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
461
|
+
def get_task(name, history_length: nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
462
|
+
command = make_simple_command(:get, 'v1/{+name}', options)
|
|
463
|
+
command.response_representation = Google::Apis::WorkspaceeventsV1::Task::Representation
|
|
464
|
+
command.response_class = Google::Apis::WorkspaceeventsV1::Task
|
|
465
|
+
command.params['name'] = name unless name.nil?
|
|
466
|
+
command.query['historyLength'] = history_length unless history_length.nil?
|
|
467
|
+
command.query['fields'] = fields unless fields.nil?
|
|
468
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
469
|
+
execute_or_queue_command(command, &block)
|
|
470
|
+
end
|
|
471
|
+
|
|
472
|
+
# TaskSubscription is a streaming call that will return a stream of task update
|
|
473
|
+
# events. This attaches the stream to an existing in process task. If the task
|
|
474
|
+
# is complete the stream will return the completed task (like GetTask) and close
|
|
475
|
+
# the stream.
|
|
476
|
+
# @param [String] name
|
|
477
|
+
# The resource name of the task to subscribe to. Format: tasks/`task_id`
|
|
478
|
+
# @param [String] fields
|
|
479
|
+
# Selector specifying which fields to include in a partial response.
|
|
480
|
+
# @param [String] quota_user
|
|
481
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
482
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
483
|
+
# @param [Google::Apis::RequestOptions] options
|
|
484
|
+
# Request-specific options
|
|
485
|
+
#
|
|
486
|
+
# @yield [result, err] Result & error if block supplied
|
|
487
|
+
# @yieldparam result [Google::Apis::WorkspaceeventsV1::StreamResponse] parsed result object
|
|
488
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
489
|
+
#
|
|
490
|
+
# @return [Google::Apis::WorkspaceeventsV1::StreamResponse]
|
|
491
|
+
#
|
|
492
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
493
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
494
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
495
|
+
def subscribe_task(name, fields: nil, quota_user: nil, options: nil, &block)
|
|
496
|
+
command = make_simple_command(:get, 'v1/{+name}:subscribe', options)
|
|
497
|
+
command.response_representation = Google::Apis::WorkspaceeventsV1::StreamResponse::Representation
|
|
498
|
+
command.response_class = Google::Apis::WorkspaceeventsV1::StreamResponse
|
|
499
|
+
command.params['name'] = name unless name.nil?
|
|
500
|
+
command.query['fields'] = fields unless fields.nil?
|
|
501
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
502
|
+
execute_or_queue_command(command, &block)
|
|
503
|
+
end
|
|
504
|
+
|
|
505
|
+
# Set a push notification config for a task.
|
|
506
|
+
# @param [String] parent
|
|
507
|
+
# Required. The parent task resource for this config. Format: tasks/`task_id`
|
|
508
|
+
# @param [Google::Apis::WorkspaceeventsV1::TaskPushNotificationConfig] task_push_notification_config_object
|
|
509
|
+
# @param [String] config_id
|
|
510
|
+
# Required. The ID for the new config.
|
|
511
|
+
# @param [String] fields
|
|
512
|
+
# Selector specifying which fields to include in a partial response.
|
|
513
|
+
# @param [String] quota_user
|
|
514
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
515
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
516
|
+
# @param [Google::Apis::RequestOptions] options
|
|
517
|
+
# Request-specific options
|
|
518
|
+
#
|
|
519
|
+
# @yield [result, err] Result & error if block supplied
|
|
520
|
+
# @yieldparam result [Google::Apis::WorkspaceeventsV1::TaskPushNotificationConfig] parsed result object
|
|
521
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
522
|
+
#
|
|
523
|
+
# @return [Google::Apis::WorkspaceeventsV1::TaskPushNotificationConfig]
|
|
524
|
+
#
|
|
525
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
526
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
527
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
528
|
+
def create_task_push_notification_config(parent, task_push_notification_config_object = nil, config_id: nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
529
|
+
command = make_simple_command(:post, 'v1/{+parent}', options)
|
|
530
|
+
command.request_representation = Google::Apis::WorkspaceeventsV1::TaskPushNotificationConfig::Representation
|
|
531
|
+
command.request_object = task_push_notification_config_object
|
|
532
|
+
command.response_representation = Google::Apis::WorkspaceeventsV1::TaskPushNotificationConfig::Representation
|
|
533
|
+
command.response_class = Google::Apis::WorkspaceeventsV1::TaskPushNotificationConfig
|
|
534
|
+
command.params['parent'] = parent unless parent.nil?
|
|
535
|
+
command.query['configId'] = config_id unless config_id.nil?
|
|
536
|
+
command.query['fields'] = fields unless fields.nil?
|
|
537
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
538
|
+
execute_or_queue_command(command, &block)
|
|
539
|
+
end
|
|
540
|
+
|
|
541
|
+
# Delete a push notification config for a task.
|
|
542
|
+
# @param [String] name
|
|
543
|
+
# The resource name of the config to delete. Format: tasks/`task_id`/
|
|
544
|
+
# pushNotificationConfigs/`config_id`
|
|
545
|
+
# @param [String] fields
|
|
546
|
+
# Selector specifying which fields to include in a partial response.
|
|
547
|
+
# @param [String] quota_user
|
|
548
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
549
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
550
|
+
# @param [Google::Apis::RequestOptions] options
|
|
551
|
+
# Request-specific options
|
|
552
|
+
#
|
|
553
|
+
# @yield [result, err] Result & error if block supplied
|
|
554
|
+
# @yieldparam result [Google::Apis::WorkspaceeventsV1::Empty] parsed result object
|
|
555
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
556
|
+
#
|
|
557
|
+
# @return [Google::Apis::WorkspaceeventsV1::Empty]
|
|
558
|
+
#
|
|
559
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
560
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
561
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
562
|
+
def delete_task_push_notification_config(name, fields: nil, quota_user: nil, options: nil, &block)
|
|
563
|
+
command = make_simple_command(:delete, 'v1/{+name}', options)
|
|
564
|
+
command.response_representation = Google::Apis::WorkspaceeventsV1::Empty::Representation
|
|
565
|
+
command.response_class = Google::Apis::WorkspaceeventsV1::Empty
|
|
566
|
+
command.params['name'] = name unless name.nil?
|
|
567
|
+
command.query['fields'] = fields unless fields.nil?
|
|
568
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
569
|
+
execute_or_queue_command(command, &block)
|
|
570
|
+
end
|
|
571
|
+
|
|
572
|
+
# Get a push notification config for a task.
|
|
573
|
+
# @param [String] name
|
|
574
|
+
# The resource name of the config to retrieve. Format: tasks/`task_id`/
|
|
575
|
+
# pushNotificationConfigs/`config_id`
|
|
576
|
+
# @param [String] fields
|
|
577
|
+
# Selector specifying which fields to include in a partial response.
|
|
578
|
+
# @param [String] quota_user
|
|
579
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
580
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
581
|
+
# @param [Google::Apis::RequestOptions] options
|
|
582
|
+
# Request-specific options
|
|
583
|
+
#
|
|
584
|
+
# @yield [result, err] Result & error if block supplied
|
|
585
|
+
# @yieldparam result [Google::Apis::WorkspaceeventsV1::TaskPushNotificationConfig] parsed result object
|
|
586
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
587
|
+
#
|
|
588
|
+
# @return [Google::Apis::WorkspaceeventsV1::TaskPushNotificationConfig]
|
|
589
|
+
#
|
|
590
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
591
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
592
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
593
|
+
def get_task_push_notification_config(name, fields: nil, quota_user: nil, options: nil, &block)
|
|
594
|
+
command = make_simple_command(:get, 'v1/{+name}', options)
|
|
595
|
+
command.response_representation = Google::Apis::WorkspaceeventsV1::TaskPushNotificationConfig::Representation
|
|
596
|
+
command.response_class = Google::Apis::WorkspaceeventsV1::TaskPushNotificationConfig
|
|
597
|
+
command.params['name'] = name unless name.nil?
|
|
598
|
+
command.query['fields'] = fields unless fields.nil?
|
|
599
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
600
|
+
execute_or_queue_command(command, &block)
|
|
601
|
+
end
|
|
602
|
+
|
|
603
|
+
# Get a list of push notifications configured for a task.
|
|
604
|
+
# @param [String] parent
|
|
605
|
+
# The parent task resource. Format: tasks/`task_id`
|
|
606
|
+
# @param [Fixnum] page_size
|
|
607
|
+
# For AIP-158 these fields are present. Usually not used/needed. The maximum
|
|
608
|
+
# number of configurations to return. If unspecified, all configs will be
|
|
609
|
+
# returned.
|
|
610
|
+
# @param [String] page_token
|
|
611
|
+
# A page token received from a previous ListTaskPushNotificationConfigRequest
|
|
612
|
+
# call. Provide this to retrieve the subsequent page. When paginating, all other
|
|
613
|
+
# parameters provided to `ListTaskPushNotificationConfigRequest` must match the
|
|
614
|
+
# call that provided the page token.
|
|
615
|
+
# @param [String] fields
|
|
616
|
+
# Selector specifying which fields to include in a partial response.
|
|
617
|
+
# @param [String] quota_user
|
|
618
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
619
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
620
|
+
# @param [Google::Apis::RequestOptions] options
|
|
621
|
+
# Request-specific options
|
|
622
|
+
#
|
|
623
|
+
# @yield [result, err] Result & error if block supplied
|
|
624
|
+
# @yieldparam result [Google::Apis::WorkspaceeventsV1::ListTaskPushNotificationConfigResponse] parsed result object
|
|
625
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
626
|
+
#
|
|
627
|
+
# @return [Google::Apis::WorkspaceeventsV1::ListTaskPushNotificationConfigResponse]
|
|
628
|
+
#
|
|
629
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
630
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
631
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
632
|
+
def list_task_push_notification_configs(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
633
|
+
command = make_simple_command(:get, 'v1/{+parent}/pushNotificationConfigs', options)
|
|
634
|
+
command.response_representation = Google::Apis::WorkspaceeventsV1::ListTaskPushNotificationConfigResponse::Representation
|
|
635
|
+
command.response_class = Google::Apis::WorkspaceeventsV1::ListTaskPushNotificationConfigResponse
|
|
636
|
+
command.params['parent'] = parent unless parent.nil?
|
|
637
|
+
command.query['pageSize'] = page_size unless page_size.nil?
|
|
638
|
+
command.query['pageToken'] = page_token unless page_token.nil?
|
|
639
|
+
command.query['fields'] = fields unless fields.nil?
|
|
640
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
641
|
+
execute_or_queue_command(command, &block)
|
|
642
|
+
end
|
|
373
643
|
|
|
374
644
|
protected
|
|
375
645
|
|