google-cloud-datastream-v1 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.
@@ -0,0 +1,744 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Copyright 2022 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 Cloud
22
+ module Datastream
23
+ module V1
24
+ # Request message for 'discover' ConnectionProfile request.
25
+ # @!attribute [rw] parent
26
+ # @return [::String]
27
+ # Required. The parent resource of the connection profile type. Must be in the
28
+ # format `projects/*/locations/*`.
29
+ # @!attribute [rw] connection_profile
30
+ # @return [::Google::Cloud::Datastream::V1::ConnectionProfile]
31
+ # An ad-hoc connection profile configuration.
32
+ # @!attribute [rw] connection_profile_name
33
+ # @return [::String]
34
+ # A reference to an existing connection profile.
35
+ # @!attribute [rw] full_hierarchy
36
+ # @return [::Boolean]
37
+ # Whether to retrieve the full hierarchy of data objects (TRUE) or only the
38
+ # current level (FALSE).
39
+ # @!attribute [rw] hierarchy_depth
40
+ # @return [::Integer]
41
+ # The number of hierarchy levels below the current level to be retrieved.
42
+ # @!attribute [rw] oracle_rdbms
43
+ # @return [::Google::Cloud::Datastream::V1::OracleRdbms]
44
+ # Oracle RDBMS to enrich with child data objects and metadata.
45
+ # @!attribute [rw] mysql_rdbms
46
+ # @return [::Google::Cloud::Datastream::V1::MysqlRdbms]
47
+ # MySQL RDBMS to enrich with child data objects and metadata.
48
+ class DiscoverConnectionProfileRequest
49
+ include ::Google::Protobuf::MessageExts
50
+ extend ::Google::Protobuf::MessageExts::ClassMethods
51
+ end
52
+
53
+ # Response from a discover request.
54
+ # @!attribute [rw] oracle_rdbms
55
+ # @return [::Google::Cloud::Datastream::V1::OracleRdbms]
56
+ # Enriched Oracle RDBMS object.
57
+ # @!attribute [rw] mysql_rdbms
58
+ # @return [::Google::Cloud::Datastream::V1::MysqlRdbms]
59
+ # Enriched MySQL RDBMS object.
60
+ class DiscoverConnectionProfileResponse
61
+ include ::Google::Protobuf::MessageExts
62
+ extend ::Google::Protobuf::MessageExts::ClassMethods
63
+ end
64
+
65
+ # Request message for 'FetchStaticIps' request.
66
+ # @!attribute [rw] name
67
+ # @return [::String]
68
+ # Required. The resource name for the location for which static IPs should be returned.
69
+ # Must be in the format `projects/*/locations/*`.
70
+ # @!attribute [rw] page_size
71
+ # @return [::Integer]
72
+ # Maximum number of Ips to return, will likely not be specified.
73
+ # @!attribute [rw] page_token
74
+ # @return [::String]
75
+ # A page token, received from a previous `ListStaticIps` call.
76
+ # will likely not be specified.
77
+ class FetchStaticIpsRequest
78
+ include ::Google::Protobuf::MessageExts
79
+ extend ::Google::Protobuf::MessageExts::ClassMethods
80
+ end
81
+
82
+ # Response message for a 'FetchStaticIps' response.
83
+ # @!attribute [rw] static_ips
84
+ # @return [::Array<::String>]
85
+ # list of static ips by account
86
+ # @!attribute [rw] next_page_token
87
+ # @return [::String]
88
+ # A token that can be sent as `page_token` to retrieve the next page.
89
+ # If this field is omitted, there are no subsequent pages.
90
+ class FetchStaticIpsResponse
91
+ include ::Google::Protobuf::MessageExts
92
+ extend ::Google::Protobuf::MessageExts::ClassMethods
93
+ end
94
+
95
+ # Request message for listing connection profiles.
96
+ # @!attribute [rw] parent
97
+ # @return [::String]
98
+ # Required. The parent that owns the collection of connection profiles.
99
+ # @!attribute [rw] page_size
100
+ # @return [::Integer]
101
+ # Maximum number of connection profiles to return.
102
+ # If unspecified, at most 50 connection profiles will be returned.
103
+ # The maximum value is 1000; values above 1000 will be coerced to 1000.
104
+ # @!attribute [rw] page_token
105
+ # @return [::String]
106
+ # Page token received from a previous `ListConnectionProfiles` call.
107
+ # Provide this to retrieve the subsequent page.
108
+ #
109
+ # When paginating, all other parameters provided to `ListConnectionProfiles`
110
+ # must match the call that provided the page token.
111
+ # @!attribute [rw] filter
112
+ # @return [::String]
113
+ # Filter request.
114
+ # @!attribute [rw] order_by
115
+ # @return [::String]
116
+ # Order by fields for the result.
117
+ class ListConnectionProfilesRequest
118
+ include ::Google::Protobuf::MessageExts
119
+ extend ::Google::Protobuf::MessageExts::ClassMethods
120
+ end
121
+
122
+ # Response message for listing connection profiles.
123
+ # @!attribute [rw] connection_profiles
124
+ # @return [::Array<::Google::Cloud::Datastream::V1::ConnectionProfile>]
125
+ # List of connection profiles.
126
+ # @!attribute [rw] next_page_token
127
+ # @return [::String]
128
+ # A token, which can be sent as `page_token` to retrieve the next page.
129
+ # If this field is omitted, there are no subsequent pages.
130
+ # @!attribute [rw] unreachable
131
+ # @return [::Array<::String>]
132
+ # Locations that could not be reached.
133
+ class ListConnectionProfilesResponse
134
+ include ::Google::Protobuf::MessageExts
135
+ extend ::Google::Protobuf::MessageExts::ClassMethods
136
+ end
137
+
138
+ # Request message for getting a connection profile.
139
+ # @!attribute [rw] name
140
+ # @return [::String]
141
+ # Required. The name of the connection profile resource to get.
142
+ class GetConnectionProfileRequest
143
+ include ::Google::Protobuf::MessageExts
144
+ extend ::Google::Protobuf::MessageExts::ClassMethods
145
+ end
146
+
147
+ # Request message for creating a connection profile.
148
+ # @!attribute [rw] parent
149
+ # @return [::String]
150
+ # Required. The parent that owns the collection of ConnectionProfiles.
151
+ # @!attribute [rw] connection_profile_id
152
+ # @return [::String]
153
+ # Required. The connection profile identifier.
154
+ # @!attribute [rw] connection_profile
155
+ # @return [::Google::Cloud::Datastream::V1::ConnectionProfile]
156
+ # Required. The connection profile resource to create.
157
+ # @!attribute [rw] request_id
158
+ # @return [::String]
159
+ # Optional. A request ID to identify requests. Specify a unique request ID
160
+ # so that if you must retry your request, the server will know to ignore
161
+ # the request if it has already been completed. The server will guarantee
162
+ # that for at least 60 minutes since the first request.
163
+ #
164
+ # For example, consider a situation where you make an initial request and the
165
+ # request times out. If you make the request again with the same request ID,
166
+ # the server can check if original operation with the same request ID was
167
+ # received, and if so, will ignore the second request. This prevents clients
168
+ # from accidentally creating duplicate commitments.
169
+ #
170
+ # The request ID must be a valid UUID with the exception that zero UUID is
171
+ # not supported (00000000-0000-0000-0000-000000000000).
172
+ # @!attribute [rw] validate_only
173
+ # @return [::Boolean]
174
+ # Optional. Only validate the connection profile, but don't create any resources.
175
+ # The default is false.
176
+ # @!attribute [rw] force
177
+ # @return [::Boolean]
178
+ # Optional. Create the connection profile without validating it.
179
+ class CreateConnectionProfileRequest
180
+ include ::Google::Protobuf::MessageExts
181
+ extend ::Google::Protobuf::MessageExts::ClassMethods
182
+ end
183
+
184
+ # Connection profile update message.
185
+ # @!attribute [rw] update_mask
186
+ # @return [::Google::Protobuf::FieldMask]
187
+ # Optional. Field mask is used to specify the fields to be overwritten in the
188
+ # ConnectionProfile resource by the update.
189
+ # The fields specified in the update_mask are relative to the resource, not
190
+ # the full request. A field will be overwritten if it is in the mask. If the
191
+ # user does not provide a mask then all fields will be overwritten.
192
+ # @!attribute [rw] connection_profile
193
+ # @return [::Google::Cloud::Datastream::V1::ConnectionProfile]
194
+ # Required. The connection profile to update.
195
+ # @!attribute [rw] request_id
196
+ # @return [::String]
197
+ # Optional. A request ID to identify requests. Specify a unique request ID
198
+ # so that if you must retry your request, the server will know to ignore
199
+ # the request if it has already been completed. The server will guarantee
200
+ # that for at least 60 minutes since the first request.
201
+ #
202
+ # For example, consider a situation where you make an initial request and the
203
+ # request times out. If you make the request again with the same request ID,
204
+ # the server can check if original operation with the same request ID was
205
+ # received, and if so, will ignore the second request. This prevents clients
206
+ # from accidentally creating duplicate commitments.
207
+ #
208
+ # The request ID must be a valid UUID with the exception that zero UUID is
209
+ # not supported (00000000-0000-0000-0000-000000000000).
210
+ # @!attribute [rw] validate_only
211
+ # @return [::Boolean]
212
+ # Optional. Only validate the connection profile, but don't update any resources.
213
+ # The default is false.
214
+ # @!attribute [rw] force
215
+ # @return [::Boolean]
216
+ # Optional. Update the connection profile without validating it.
217
+ class UpdateConnectionProfileRequest
218
+ include ::Google::Protobuf::MessageExts
219
+ extend ::Google::Protobuf::MessageExts::ClassMethods
220
+ end
221
+
222
+ # Request message for deleting a connection profile.
223
+ # @!attribute [rw] name
224
+ # @return [::String]
225
+ # Required. The name of the connection profile resource to delete.
226
+ # @!attribute [rw] request_id
227
+ # @return [::String]
228
+ # Optional. A request ID to identify requests. Specify a unique request ID
229
+ # so that if you must retry your request, the server will know to ignore
230
+ # the request if it has already been completed. The server will guarantee
231
+ # that for at least 60 minutes after the first request.
232
+ #
233
+ # For example, consider a situation where you make an initial request and the
234
+ # request times out. If you make the request again with the same request ID,
235
+ # the server can check if original operation with the same request ID was
236
+ # received, and if so, will ignore the second request. This prevents clients
237
+ # from accidentally creating duplicate commitments.
238
+ #
239
+ # The request ID must be a valid UUID with the exception that zero UUID is
240
+ # not supported (00000000-0000-0000-0000-000000000000).
241
+ class DeleteConnectionProfileRequest
242
+ include ::Google::Protobuf::MessageExts
243
+ extend ::Google::Protobuf::MessageExts::ClassMethods
244
+ end
245
+
246
+ # Request message for listing streams.
247
+ # @!attribute [rw] parent
248
+ # @return [::String]
249
+ # Required. The parent that owns the collection of streams.
250
+ # @!attribute [rw] page_size
251
+ # @return [::Integer]
252
+ # Maximum number of streams to return.
253
+ # If unspecified, at most 50 streams will be returned. The maximum
254
+ # value is 1000; values above 1000 will be coerced to 1000.
255
+ # @!attribute [rw] page_token
256
+ # @return [::String]
257
+ # Page token received from a previous `ListStreams` call.
258
+ # Provide this to retrieve the subsequent page.
259
+ #
260
+ # When paginating, all other parameters provided to `ListStreams`
261
+ # must match the call that provided the page token.
262
+ # @!attribute [rw] filter
263
+ # @return [::String]
264
+ # Filter request.
265
+ # @!attribute [rw] order_by
266
+ # @return [::String]
267
+ # Order by fields for the result.
268
+ class ListStreamsRequest
269
+ include ::Google::Protobuf::MessageExts
270
+ extend ::Google::Protobuf::MessageExts::ClassMethods
271
+ end
272
+
273
+ # Response message for listing streams.
274
+ # @!attribute [rw] streams
275
+ # @return [::Array<::Google::Cloud::Datastream::V1::Stream>]
276
+ # List of streams
277
+ # @!attribute [rw] next_page_token
278
+ # @return [::String]
279
+ # A token, which can be sent as `page_token` to retrieve the next page.
280
+ # If this field is omitted, there are no subsequent pages.
281
+ # @!attribute [rw] unreachable
282
+ # @return [::Array<::String>]
283
+ # Locations that could not be reached.
284
+ class ListStreamsResponse
285
+ include ::Google::Protobuf::MessageExts
286
+ extend ::Google::Protobuf::MessageExts::ClassMethods
287
+ end
288
+
289
+ # Request message for getting a stream.
290
+ # @!attribute [rw] name
291
+ # @return [::String]
292
+ # Required. The name of the stream resource to get.
293
+ class GetStreamRequest
294
+ include ::Google::Protobuf::MessageExts
295
+ extend ::Google::Protobuf::MessageExts::ClassMethods
296
+ end
297
+
298
+ # Request message for creating a stream.
299
+ # @!attribute [rw] parent
300
+ # @return [::String]
301
+ # Required. The parent that owns the collection of streams.
302
+ # @!attribute [rw] stream_id
303
+ # @return [::String]
304
+ # Required. The stream identifier.
305
+ # @!attribute [rw] stream
306
+ # @return [::Google::Cloud::Datastream::V1::Stream]
307
+ # Required. The stream resource to create.
308
+ # @!attribute [rw] request_id
309
+ # @return [::String]
310
+ # Optional. A request ID to identify requests. Specify a unique request ID
311
+ # so that if you must retry your request, the server will know to ignore
312
+ # the request if it has already been completed. The server will guarantee
313
+ # that for at least 60 minutes since the first request.
314
+ #
315
+ # For example, consider a situation where you make an initial request and the
316
+ # request times out. If you make the request again with the same request ID,
317
+ # the server can check if original operation with the same request ID was
318
+ # received, and if so, will ignore the second request. This prevents clients
319
+ # from accidentally creating duplicate commitments.
320
+ #
321
+ # The request ID must be a valid UUID with the exception that zero UUID is
322
+ # not supported (00000000-0000-0000-0000-000000000000).
323
+ # @!attribute [rw] validate_only
324
+ # @return [::Boolean]
325
+ # Optional. Only validate the stream, but don't create any resources.
326
+ # The default is false.
327
+ # @!attribute [rw] force
328
+ # @return [::Boolean]
329
+ # Optional. Create the stream without validating it.
330
+ class CreateStreamRequest
331
+ include ::Google::Protobuf::MessageExts
332
+ extend ::Google::Protobuf::MessageExts::ClassMethods
333
+ end
334
+
335
+ # Request message for updating a stream.
336
+ # @!attribute [rw] update_mask
337
+ # @return [::Google::Protobuf::FieldMask]
338
+ # Optional. Field mask is used to specify the fields to be overwritten in the
339
+ # stream resource by the update.
340
+ # The fields specified in the update_mask are relative to the resource, not
341
+ # the full request. A field will be overwritten if it is in the mask. If the
342
+ # user does not provide a mask then all fields will be overwritten.
343
+ # @!attribute [rw] stream
344
+ # @return [::Google::Cloud::Datastream::V1::Stream]
345
+ # Required. The stream resource to update.
346
+ # @!attribute [rw] request_id
347
+ # @return [::String]
348
+ # Optional. A request ID to identify requests. Specify a unique request ID
349
+ # so that if you must retry your request, the server will know to ignore
350
+ # the request if it has already been completed. The server will guarantee
351
+ # that for at least 60 minutes since the first request.
352
+ #
353
+ # For example, consider a situation where you make an initial request and the
354
+ # request times out. If you make the request again with the same request ID,
355
+ # the server can check if original operation with the same request ID was
356
+ # received, and if so, will ignore the second request. This prevents clients
357
+ # from accidentally creating duplicate commitments.
358
+ #
359
+ # The request ID must be a valid UUID with the exception that zero UUID is
360
+ # not supported (00000000-0000-0000-0000-000000000000).
361
+ # @!attribute [rw] validate_only
362
+ # @return [::Boolean]
363
+ # Optional. Only validate the stream with the changes, without actually updating it.
364
+ # The default is false.
365
+ # @!attribute [rw] force
366
+ # @return [::Boolean]
367
+ # Optional. Update the stream without validating it.
368
+ class UpdateStreamRequest
369
+ include ::Google::Protobuf::MessageExts
370
+ extend ::Google::Protobuf::MessageExts::ClassMethods
371
+ end
372
+
373
+ # Request message for deleting a stream.
374
+ # @!attribute [rw] name
375
+ # @return [::String]
376
+ # Required. The name of the stream resource to delete.
377
+ # @!attribute [rw] request_id
378
+ # @return [::String]
379
+ # Optional. A request ID to identify requests. Specify a unique request ID
380
+ # so that if you must retry your request, the server will know to ignore
381
+ # the request if it has already been completed. The server will guarantee
382
+ # that for at least 60 minutes after the first request.
383
+ #
384
+ # For example, consider a situation where you make an initial request and the
385
+ # request times out. If you make the request again with the same request ID,
386
+ # the server can check if original operation with the same request ID was
387
+ # received, and if so, will ignore the second request. This prevents clients
388
+ # from accidentally creating duplicate commitments.
389
+ #
390
+ # The request ID must be a valid UUID with the exception that zero UUID is
391
+ # not supported (00000000-0000-0000-0000-000000000000).
392
+ class DeleteStreamRequest
393
+ include ::Google::Protobuf::MessageExts
394
+ extend ::Google::Protobuf::MessageExts::ClassMethods
395
+ end
396
+
397
+ # Request for fetching a specific stream object.
398
+ # @!attribute [rw] name
399
+ # @return [::String]
400
+ # Required. The name of the stream object resource to get.
401
+ class GetStreamObjectRequest
402
+ include ::Google::Protobuf::MessageExts
403
+ extend ::Google::Protobuf::MessageExts::ClassMethods
404
+ end
405
+
406
+ # Request for looking up a specific stream object by its source object
407
+ # identifier.
408
+ # @!attribute [rw] parent
409
+ # @return [::String]
410
+ # Required. The parent stream that owns the collection of objects.
411
+ # @!attribute [rw] source_object_identifier
412
+ # @return [::Google::Cloud::Datastream::V1::SourceObjectIdentifier]
413
+ # Required. The source object identifier which maps to the stream object.
414
+ class LookupStreamObjectRequest
415
+ include ::Google::Protobuf::MessageExts
416
+ extend ::Google::Protobuf::MessageExts::ClassMethods
417
+ end
418
+
419
+ # Request for manually initiating a backfill job for a specific stream object.
420
+ # @!attribute [rw] object
421
+ # @return [::String]
422
+ # Required. The name of the stream object resource to start a backfill job for.
423
+ class StartBackfillJobRequest
424
+ include ::Google::Protobuf::MessageExts
425
+ extend ::Google::Protobuf::MessageExts::ClassMethods
426
+ end
427
+
428
+ # Response for manually initiating a backfill job for a specific stream object.
429
+ # @!attribute [rw] object
430
+ # @return [::Google::Cloud::Datastream::V1::StreamObject]
431
+ # The stream object resource a backfill job was started for.
432
+ class StartBackfillJobResponse
433
+ include ::Google::Protobuf::MessageExts
434
+ extend ::Google::Protobuf::MessageExts::ClassMethods
435
+ end
436
+
437
+ # Request for manually stopping a running backfill job for a specific stream
438
+ # object.
439
+ # @!attribute [rw] object
440
+ # @return [::String]
441
+ # Required. The name of the stream object resource to stop the backfill job for.
442
+ class StopBackfillJobRequest
443
+ include ::Google::Protobuf::MessageExts
444
+ extend ::Google::Protobuf::MessageExts::ClassMethods
445
+ end
446
+
447
+ # Response for manually stop a backfill job for a specific stream object.
448
+ # @!attribute [rw] object
449
+ # @return [::Google::Cloud::Datastream::V1::StreamObject]
450
+ # The stream object resource the backfill job was stopped for.
451
+ class StopBackfillJobResponse
452
+ include ::Google::Protobuf::MessageExts
453
+ extend ::Google::Protobuf::MessageExts::ClassMethods
454
+ end
455
+
456
+ # Request for listing all objects for a specific stream.
457
+ # @!attribute [rw] parent
458
+ # @return [::String]
459
+ # Required. The parent stream that owns the collection of objects.
460
+ # @!attribute [rw] page_size
461
+ # @return [::Integer]
462
+ # Maximum number of objects to return. Default is 50.
463
+ # The maximum value is 1000; values above 1000 will be coerced to 1000.
464
+ # @!attribute [rw] page_token
465
+ # @return [::String]
466
+ # Page token received from a previous `ListStreamObjectsRequest` call.
467
+ # Provide this to retrieve the subsequent page.
468
+ #
469
+ # When paginating, all other parameters provided to
470
+ # `ListStreamObjectsRequest` must match the call that provided the page
471
+ # token.
472
+ class ListStreamObjectsRequest
473
+ include ::Google::Protobuf::MessageExts
474
+ extend ::Google::Protobuf::MessageExts::ClassMethods
475
+ end
476
+
477
+ # Response containing the objects for a stream.
478
+ # @!attribute [rw] stream_objects
479
+ # @return [::Array<::Google::Cloud::Datastream::V1::StreamObject>]
480
+ # List of stream objects.
481
+ # @!attribute [rw] next_page_token
482
+ # @return [::String]
483
+ # A token, which can be sent as `page_token` to retrieve the next page.
484
+ class ListStreamObjectsResponse
485
+ include ::Google::Protobuf::MessageExts
486
+ extend ::Google::Protobuf::MessageExts::ClassMethods
487
+ end
488
+
489
+ # Represents the metadata of the long-running operation.
490
+ # @!attribute [r] create_time
491
+ # @return [::Google::Protobuf::Timestamp]
492
+ # Output only. The time the operation was created.
493
+ # @!attribute [r] end_time
494
+ # @return [::Google::Protobuf::Timestamp]
495
+ # Output only. The time the operation finished running.
496
+ # @!attribute [r] target
497
+ # @return [::String]
498
+ # Output only. Server-defined resource path for the target of the operation.
499
+ # @!attribute [r] verb
500
+ # @return [::String]
501
+ # Output only. Name of the verb executed by the operation.
502
+ # @!attribute [r] status_message
503
+ # @return [::String]
504
+ # Output only. Human-readable status of the operation, if any.
505
+ # @!attribute [r] requested_cancellation
506
+ # @return [::Boolean]
507
+ # Output only. Identifies whether the user has requested cancellation
508
+ # of the operation. Operations that have successfully been cancelled
509
+ # have [Operation.error][] value with a {::Google::Rpc::Status#code google.rpc.Status.code} of 1,
510
+ # corresponding to `Code.CANCELLED`.
511
+ # @!attribute [r] api_version
512
+ # @return [::String]
513
+ # Output only. API version used to start the operation.
514
+ # @!attribute [r] validation_result
515
+ # @return [::Google::Cloud::Datastream::V1::ValidationResult]
516
+ # Output only. Results of executed validations if there are any.
517
+ class OperationMetadata
518
+ include ::Google::Protobuf::MessageExts
519
+ extend ::Google::Protobuf::MessageExts::ClassMethods
520
+ end
521
+
522
+ # Request for creating a private connection.
523
+ # @!attribute [rw] parent
524
+ # @return [::String]
525
+ # Required. The parent that owns the collection of PrivateConnections.
526
+ # @!attribute [rw] private_connection_id
527
+ # @return [::String]
528
+ # Required. The private connectivity identifier.
529
+ # @!attribute [rw] private_connection
530
+ # @return [::Google::Cloud::Datastream::V1::PrivateConnection]
531
+ # Required. The Private Connectivity resource to create.
532
+ # @!attribute [rw] request_id
533
+ # @return [::String]
534
+ # Optional. A request ID to identify requests. Specify a unique request ID
535
+ # so that if you must retry your request, the server will know to ignore
536
+ # the request if it has already been completed. The server will guarantee
537
+ # that for at least 60 minutes since the first request.
538
+ #
539
+ # For example, consider a situation where you make an initial request and the
540
+ # request times out. If you make the request again with the same request ID,
541
+ # the server can check if original operation with the same request ID was
542
+ # received, and if so, will ignore the second request. This prevents clients
543
+ # from accidentally creating duplicate commitments.
544
+ #
545
+ # The request ID must be a valid UUID with the exception that zero UUID is
546
+ # not supported (00000000-0000-0000-0000-000000000000).
547
+ class CreatePrivateConnectionRequest
548
+ include ::Google::Protobuf::MessageExts
549
+ extend ::Google::Protobuf::MessageExts::ClassMethods
550
+ end
551
+
552
+ # Request for listing private connections.
553
+ # @!attribute [rw] parent
554
+ # @return [::String]
555
+ # Required. The parent that owns the collection of private connectivity configurations.
556
+ # @!attribute [rw] page_size
557
+ # @return [::Integer]
558
+ # Maximum number of private connectivity configurations to return.
559
+ # If unspecified, at most 50 private connectivity configurations that will be
560
+ # returned. The maximum value is 1000; values above 1000 will be coerced to
561
+ # 1000.
562
+ # @!attribute [rw] page_token
563
+ # @return [::String]
564
+ # Page token received from a previous `ListPrivateConnections` call.
565
+ # Provide this to retrieve the subsequent page.
566
+ #
567
+ # When paginating, all other parameters provided to
568
+ # `ListPrivateConnections` must match the call that provided the page
569
+ # token.
570
+ # @!attribute [rw] filter
571
+ # @return [::String]
572
+ # Filter request.
573
+ # @!attribute [rw] order_by
574
+ # @return [::String]
575
+ # Order by fields for the result.
576
+ class ListPrivateConnectionsRequest
577
+ include ::Google::Protobuf::MessageExts
578
+ extend ::Google::Protobuf::MessageExts::ClassMethods
579
+ end
580
+
581
+ # Response containing a list of private connection configurations.
582
+ # @!attribute [rw] private_connections
583
+ # @return [::Array<::Google::Cloud::Datastream::V1::PrivateConnection>]
584
+ # List of private connectivity configurations.
585
+ # @!attribute [rw] next_page_token
586
+ # @return [::String]
587
+ # A token, which can be sent as `page_token` to retrieve the next page.
588
+ # If this field is omitted, there are no subsequent pages.
589
+ # @!attribute [rw] unreachable
590
+ # @return [::Array<::String>]
591
+ # Locations that could not be reached.
592
+ class ListPrivateConnectionsResponse
593
+ include ::Google::Protobuf::MessageExts
594
+ extend ::Google::Protobuf::MessageExts::ClassMethods
595
+ end
596
+
597
+ # Request to delete a private connection.
598
+ # @!attribute [rw] name
599
+ # @return [::String]
600
+ # Required. The name of the private connectivity configuration to delete.
601
+ # @!attribute [rw] request_id
602
+ # @return [::String]
603
+ # Optional. A request ID to identify requests. Specify a unique request ID
604
+ # so that if you must retry your request, the server will know to ignore
605
+ # the request if it has already been completed. The server will guarantee
606
+ # that for at least 60 minutes after the first request.
607
+ #
608
+ # For example, consider a situation where you make an initial request and the
609
+ # request times out. If you make the request again with the same request ID,
610
+ # the server can check if original operation with the same request ID was
611
+ # received, and if so, will ignore the second request. This prevents clients
612
+ # from accidentally creating duplicate commitments.
613
+ #
614
+ # The request ID must be a valid UUID with the exception that zero UUID is
615
+ # not supported (00000000-0000-0000-0000-000000000000).
616
+ # @!attribute [rw] force
617
+ # @return [::Boolean]
618
+ # Optional. If set to true, any child routes that belong to this PrivateConnection will
619
+ # also be deleted.
620
+ class DeletePrivateConnectionRequest
621
+ include ::Google::Protobuf::MessageExts
622
+ extend ::Google::Protobuf::MessageExts::ClassMethods
623
+ end
624
+
625
+ # Request to get a private connection configuration.
626
+ # @!attribute [rw] name
627
+ # @return [::String]
628
+ # Required. The name of the private connectivity configuration to get.
629
+ class GetPrivateConnectionRequest
630
+ include ::Google::Protobuf::MessageExts
631
+ extend ::Google::Protobuf::MessageExts::ClassMethods
632
+ end
633
+
634
+ # Route creation request.
635
+ # @!attribute [rw] parent
636
+ # @return [::String]
637
+ # Required. The parent that owns the collection of Routes.
638
+ # @!attribute [rw] route_id
639
+ # @return [::String]
640
+ # Required. The Route identifier.
641
+ # @!attribute [rw] route
642
+ # @return [::Google::Cloud::Datastream::V1::Route]
643
+ # Required. The Route resource to create.
644
+ # @!attribute [rw] request_id
645
+ # @return [::String]
646
+ # Optional. A request ID to identify requests. Specify a unique request ID
647
+ # so that if you must retry your request, the server will know to ignore
648
+ # the request if it has already been completed. The server will guarantee
649
+ # that for at least 60 minutes since the first request.
650
+ #
651
+ # For example, consider a situation where you make an initial request and the
652
+ # request times out. If you make the request again with the same request ID,
653
+ # the server can check if original operation with the same request ID was
654
+ # received, and if so, will ignore the second request. This prevents clients
655
+ # from accidentally creating duplicate commitments.
656
+ #
657
+ # The request ID must be a valid UUID with the exception that zero UUID is
658
+ # not supported (00000000-0000-0000-0000-000000000000).
659
+ class CreateRouteRequest
660
+ include ::Google::Protobuf::MessageExts
661
+ extend ::Google::Protobuf::MessageExts::ClassMethods
662
+ end
663
+
664
+ # Route list request.
665
+ # @!attribute [rw] parent
666
+ # @return [::String]
667
+ # Required. The parent that owns the collection of Routess.
668
+ # @!attribute [rw] page_size
669
+ # @return [::Integer]
670
+ # Maximum number of Routes to return. The service may return
671
+ # fewer than this value. If unspecified, at most 50 Routes
672
+ # will be returned. The maximum value is 1000; values above 1000 will be
673
+ # coerced to 1000.
674
+ # @!attribute [rw] page_token
675
+ # @return [::String]
676
+ # Page token received from a previous `ListRoutes` call.
677
+ # Provide this to retrieve the subsequent page.
678
+ #
679
+ # When paginating, all other parameters provided to
680
+ # `ListRoutes` must match the call that provided the page
681
+ # token.
682
+ # @!attribute [rw] filter
683
+ # @return [::String]
684
+ # Filter request.
685
+ # @!attribute [rw] order_by
686
+ # @return [::String]
687
+ # Order by fields for the result.
688
+ class ListRoutesRequest
689
+ include ::Google::Protobuf::MessageExts
690
+ extend ::Google::Protobuf::MessageExts::ClassMethods
691
+ end
692
+
693
+ # Route list response.
694
+ # @!attribute [rw] routes
695
+ # @return [::Array<::Google::Cloud::Datastream::V1::Route>]
696
+ # List of Routes.
697
+ # @!attribute [rw] next_page_token
698
+ # @return [::String]
699
+ # A token, which can be sent as `page_token` to retrieve the next page.
700
+ # If this field is omitted, there are no subsequent pages.
701
+ # @!attribute [rw] unreachable
702
+ # @return [::Array<::String>]
703
+ # Locations that could not be reached.
704
+ class ListRoutesResponse
705
+ include ::Google::Protobuf::MessageExts
706
+ extend ::Google::Protobuf::MessageExts::ClassMethods
707
+ end
708
+
709
+ # Route deletion request.
710
+ # @!attribute [rw] name
711
+ # @return [::String]
712
+ # Required. The name of the Route resource to delete.
713
+ # @!attribute [rw] request_id
714
+ # @return [::String]
715
+ # Optional. A request ID to identify requests. Specify a unique request ID
716
+ # so that if you must retry your request, the server will know to ignore
717
+ # the request if it has already been completed. The server will guarantee
718
+ # that for at least 60 minutes after the first request.
719
+ #
720
+ # For example, consider a situation where you make an initial request and the
721
+ # request times out. If you make the request again with the same request ID,
722
+ # the server can check if original operation with the same request ID was
723
+ # received, and if so, will ignore the second request. This prevents clients
724
+ # from accidentally creating duplicate commitments.
725
+ #
726
+ # The request ID must be a valid UUID with the exception that zero UUID is
727
+ # not supported (00000000-0000-0000-0000-000000000000).
728
+ class DeleteRouteRequest
729
+ include ::Google::Protobuf::MessageExts
730
+ extend ::Google::Protobuf::MessageExts::ClassMethods
731
+ end
732
+
733
+ # Route get request.
734
+ # @!attribute [rw] name
735
+ # @return [::String]
736
+ # Required. The name of the Route resource to get.
737
+ class GetRouteRequest
738
+ include ::Google::Protobuf::MessageExts
739
+ extend ::Google::Protobuf::MessageExts::ClassMethods
740
+ end
741
+ end
742
+ end
743
+ end
744
+ end