google-cloud-dataplex-v1 0.19.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.
Files changed (30) hide show
  1. checksums.yaml +4 -4
  2. data/AUTHENTICATION.md +4 -4
  3. data/README.md +3 -3
  4. data/lib/google/cloud/dataplex/v1/bindings_override.rb +1 -1
  5. data/lib/google/cloud/dataplex/v1/catalog_pb.rb +101 -0
  6. data/lib/google/cloud/dataplex/v1/catalog_service/client.rb +2795 -0
  7. data/lib/google/cloud/dataplex/v1/catalog_service/credentials.rb +47 -0
  8. data/lib/google/cloud/dataplex/v1/catalog_service/operations.rb +801 -0
  9. data/lib/google/cloud/dataplex/v1/catalog_service/paths.rb +128 -0
  10. data/lib/google/cloud/dataplex/v1/catalog_service/rest/client.rb +2620 -0
  11. data/lib/google/cloud/dataplex/v1/catalog_service/rest/operations.rb +895 -0
  12. data/lib/google/cloud/dataplex/v1/catalog_service/rest/service_stub.rb +1375 -0
  13. data/lib/google/cloud/dataplex/v1/catalog_service/rest.rb +58 -0
  14. data/lib/google/cloud/dataplex/v1/catalog_service.rb +60 -0
  15. data/lib/google/cloud/dataplex/v1/catalog_services_pb.rb +91 -0
  16. data/lib/google/cloud/dataplex/v1/data_quality_pb.rb +6 -1
  17. data/lib/google/cloud/dataplex/v1/data_scan_service/client.rb +95 -0
  18. data/lib/google/cloud/dataplex/v1/data_scan_service/rest/client.rb +88 -0
  19. data/lib/google/cloud/dataplex/v1/data_scan_service/rest/service_stub.rb +68 -0
  20. data/lib/google/cloud/dataplex/v1/datascans_pb.rb +4 -2
  21. data/lib/google/cloud/dataplex/v1/datascans_services_pb.rb +2 -0
  22. data/lib/google/cloud/dataplex/v1/rest.rb +3 -2
  23. data/lib/google/cloud/dataplex/v1/version.rb +1 -1
  24. data/lib/google/cloud/dataplex/v1.rb +4 -3
  25. data/proto_docs/google/api/client.rb +4 -0
  26. data/proto_docs/google/cloud/dataplex/v1/catalog.rb +1115 -0
  27. data/proto_docs/google/cloud/dataplex/v1/data_quality.rb +57 -0
  28. data/proto_docs/google/cloud/dataplex/v1/datascans.rb +21 -0
  29. data/proto_docs/google/protobuf/struct.rb +96 -0
  30. metadata +15 -2
@@ -0,0 +1,1115 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Copyright 2024 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 Dataplex
23
+ module V1
24
+ # Aspect Type is a template for creating Aspects, and represents the
25
+ # JSON-schema for a given Entry, e.g., BigQuery Table Schema.
26
+ # @!attribute [r] name
27
+ # @return [::String]
28
+ # Output only. The relative resource name of the AspectType, of the form:
29
+ # projects/\\{project_number}/locations/\\{location_id}/aspectTypes/\\{aspect_type_id}.
30
+ # @!attribute [r] uid
31
+ # @return [::String]
32
+ # Output only. System generated globally unique ID for the AspectType. This
33
+ # ID will be different if the AspectType is deleted and re-created with the
34
+ # same name.
35
+ # @!attribute [r] create_time
36
+ # @return [::Google::Protobuf::Timestamp]
37
+ # Output only. The time when the AspectType was created.
38
+ # @!attribute [r] update_time
39
+ # @return [::Google::Protobuf::Timestamp]
40
+ # Output only. The time when the AspectType was last updated.
41
+ # @!attribute [rw] description
42
+ # @return [::String]
43
+ # Optional. Description of the AspectType.
44
+ # @!attribute [rw] display_name
45
+ # @return [::String]
46
+ # Optional. User friendly display name.
47
+ # @!attribute [rw] labels
48
+ # @return [::Google::Protobuf::Map{::String => ::String}]
49
+ # Optional. User-defined labels for the AspectType.
50
+ # @!attribute [rw] etag
51
+ # @return [::String]
52
+ # This checksum is computed by the server based on the value of other
53
+ # fields, and may be sent on update and delete requests to ensure the
54
+ # client has an up-to-date value before proceeding.
55
+ # @!attribute [rw] authorization
56
+ # @return [::Google::Cloud::Dataplex::V1::AspectType::Authorization]
57
+ # Immutable. Authorization defined for this type.
58
+ # @!attribute [rw] metadata_template
59
+ # @return [::Google::Cloud::Dataplex::V1::AspectType::MetadataTemplate]
60
+ # Required. MetadataTemplate of the aspect.
61
+ # @!attribute [r] transfer_status
62
+ # @return [::Google::Cloud::Dataplex::V1::TransferStatus]
63
+ # Output only. Denotes the transfer status of the Aspect Type. It is
64
+ # unspecified for Aspect Types created from Dataplex API.
65
+ class AspectType
66
+ include ::Google::Protobuf::MessageExts
67
+ extend ::Google::Protobuf::MessageExts::ClassMethods
68
+
69
+ # Autorization for an Aspect Type.
70
+ # @!attribute [rw] alternate_use_permission
71
+ # @return [::String]
72
+ # Immutable. The IAM permission grantable on the Entry Group to allow
73
+ # access to instantiate Aspects of Dataplex owned Aspect Types, only
74
+ # settable for Dataplex owned Types.
75
+ class Authorization
76
+ include ::Google::Protobuf::MessageExts
77
+ extend ::Google::Protobuf::MessageExts::ClassMethods
78
+ end
79
+
80
+ # MetadataTemplate definition for AspectType
81
+ # @!attribute [rw] index
82
+ # @return [::Integer]
83
+ # Optional. Index is used to encode Template messages. The value of index
84
+ # can range between 1 and 2,147,483,647. Index must be unique within all
85
+ # fields in a Template. (Nested Templates can reuse indexes). Once a
86
+ # Template is defined, the index cannot be changed, because it identifies
87
+ # the field in the actual storage format. Index is a mandatory field, but
88
+ # it is optional for top level fields, and map/array "values" definitions.
89
+ # @!attribute [rw] name
90
+ # @return [::String]
91
+ # Required. The name of the field.
92
+ # @!attribute [rw] type
93
+ # @return [::String]
94
+ # Required. The datatype of this field. The following values are supported:
95
+ # Primitive types (string, integer, boolean, double, datetime); datetime
96
+ # must be of the format RFC3339 UTC "Zulu" (Examples:
97
+ # "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z"). Complex
98
+ # types (enum, array, map, record).
99
+ # @!attribute [rw] record_fields
100
+ # @return [::Array<::Google::Cloud::Dataplex::V1::AspectType::MetadataTemplate>]
101
+ # Optional. Field definition, needs to be specified if the type is record.
102
+ # Defines the nested fields.
103
+ # @!attribute [rw] enum_values
104
+ # @return [::Array<::Google::Cloud::Dataplex::V1::AspectType::MetadataTemplate::EnumValue>]
105
+ # Optional. The list of values for an enum type. Needs to be defined if the
106
+ # type is enum.
107
+ # @!attribute [rw] map_items
108
+ # @return [::Google::Cloud::Dataplex::V1::AspectType::MetadataTemplate]
109
+ # Optional. map_items needs to be set if the type is map. map_items can
110
+ # refer to a primitive field or a complex (record only) field. To specify a
111
+ # primitive field, just name and type needs to be set in the nested
112
+ # MetadataTemplate. The recommended value for the name field is item, as
113
+ # this is not used in the actual payload.
114
+ # @!attribute [rw] array_items
115
+ # @return [::Google::Cloud::Dataplex::V1::AspectType::MetadataTemplate]
116
+ # Optional. array_items needs to be set if the type is array. array_items
117
+ # can refer to a primitive field or a complex (record only) field. To
118
+ # specify a primitive field, just name and type needs to be set in the
119
+ # nested MetadataTemplate. The recommended value for the name field is
120
+ # item, as this is not used in the actual payload.
121
+ # @!attribute [rw] type_id
122
+ # @return [::String]
123
+ # Optional. Id can be used if this definition of the field needs to be
124
+ # reused later. Id needs to be unique across the entire template. Id can
125
+ # only be specified if the field type is record.
126
+ # @!attribute [rw] type_ref
127
+ # @return [::String]
128
+ # Optional. A reference to another field definition (instead of an inline
129
+ # definition). The value must be equal to the value of an id field defined
130
+ # elsewhere in the MetadataTemplate. Only fields with type as record can
131
+ # refer to other fields.
132
+ # @!attribute [rw] constraints
133
+ # @return [::Google::Cloud::Dataplex::V1::AspectType::MetadataTemplate::Constraints]
134
+ # Optional. Specifies the constraints on this field.
135
+ # @!attribute [rw] annotations
136
+ # @return [::Google::Cloud::Dataplex::V1::AspectType::MetadataTemplate::Annotations]
137
+ # Optional. Specifies annotations on this field.
138
+ class MetadataTemplate
139
+ include ::Google::Protobuf::MessageExts
140
+ extend ::Google::Protobuf::MessageExts::ClassMethods
141
+
142
+ # Definition of Enumvalue (to be used by enum fields)
143
+ # @!attribute [rw] index
144
+ # @return [::Integer]
145
+ # Required. Index for the enum. Cannot be modified.
146
+ # @!attribute [rw] name
147
+ # @return [::String]
148
+ # Required. Name of the enumvalue. This is the actual value that the
149
+ # aspect will contain.
150
+ # @!attribute [rw] deprecated
151
+ # @return [::String]
152
+ # Optional. Optional deprecation message to be set if an enum value needs
153
+ # to be deprecated.
154
+ class EnumValue
155
+ include ::Google::Protobuf::MessageExts
156
+ extend ::Google::Protobuf::MessageExts::ClassMethods
157
+ end
158
+
159
+ # Definition of the constraints of a field
160
+ # @!attribute [rw] required
161
+ # @return [::Boolean]
162
+ # Optional. Marks this as an optional/required field.
163
+ class Constraints
164
+ include ::Google::Protobuf::MessageExts
165
+ extend ::Google::Protobuf::MessageExts::ClassMethods
166
+ end
167
+
168
+ # Definition of the annotations of a field
169
+ # @!attribute [rw] deprecated
170
+ # @return [::String]
171
+ # Optional. Marks a field as deprecated, a deprecation message can be
172
+ # included.
173
+ # @!attribute [rw] display_name
174
+ # @return [::String]
175
+ # Optional. Specify a displayname for a field.
176
+ # @!attribute [rw] description
177
+ # @return [::String]
178
+ # Optional. Specify a description for a field
179
+ # @!attribute [rw] display_order
180
+ # @return [::Integer]
181
+ # Optional. Specify a display order for a field. Display order can be
182
+ # used to reorder where a field is rendered
183
+ # @!attribute [rw] string_type
184
+ # @return [::String]
185
+ # Optional. String Type annotations can be used to specify special
186
+ # meaning to string fields. The following values are supported: richText:
187
+ # The field must be interpreted as a rich text field. url: A fully
188
+ # qualified url link. resource: A service qualified resource reference.
189
+ # @!attribute [rw] string_values
190
+ # @return [::Array<::String>]
191
+ # Optional. Suggested hints for string fields. These can be used to
192
+ # suggest values to users, through an UI for example.
193
+ class Annotations
194
+ include ::Google::Protobuf::MessageExts
195
+ extend ::Google::Protobuf::MessageExts::ClassMethods
196
+ end
197
+ end
198
+
199
+ # @!attribute [rw] key
200
+ # @return [::String]
201
+ # @!attribute [rw] value
202
+ # @return [::String]
203
+ class LabelsEntry
204
+ include ::Google::Protobuf::MessageExts
205
+ extend ::Google::Protobuf::MessageExts::ClassMethods
206
+ end
207
+ end
208
+
209
+ # An Entry Group represents a logical grouping of one or more Entries.
210
+ # @!attribute [r] name
211
+ # @return [::String]
212
+ # Output only. The relative resource name of the EntryGroup, of the form:
213
+ # projects/\\{project_number}/locations/\\{location_id}/entryGroups/\\{entry_group_id}.
214
+ # @!attribute [r] uid
215
+ # @return [::String]
216
+ # Output only. System generated globally unique ID for the EntryGroup. This
217
+ # ID will be different if the EntryGroup is deleted and re-created with the
218
+ # same name.
219
+ # @!attribute [r] create_time
220
+ # @return [::Google::Protobuf::Timestamp]
221
+ # Output only. The time when the EntryGroup was created.
222
+ # @!attribute [r] update_time
223
+ # @return [::Google::Protobuf::Timestamp]
224
+ # Output only. The time when the EntryGroup was last updated.
225
+ # @!attribute [rw] description
226
+ # @return [::String]
227
+ # Optional. Description of the EntryGroup.
228
+ # @!attribute [rw] display_name
229
+ # @return [::String]
230
+ # Optional. User friendly display name.
231
+ # @!attribute [rw] labels
232
+ # @return [::Google::Protobuf::Map{::String => ::String}]
233
+ # Optional. User-defined labels for the EntryGroup.
234
+ # @!attribute [rw] etag
235
+ # @return [::String]
236
+ # This checksum is computed by the server based on the value of other
237
+ # fields, and may be sent on update and delete requests to ensure the
238
+ # client has an up-to-date value before proceeding.
239
+ # @!attribute [r] transfer_status
240
+ # @return [::Google::Cloud::Dataplex::V1::TransferStatus]
241
+ # Output only. Denotes the transfer status of the Entry Group. It is
242
+ # unspecified for Entry Group created from Dataplex API.
243
+ class EntryGroup
244
+ include ::Google::Protobuf::MessageExts
245
+ extend ::Google::Protobuf::MessageExts::ClassMethods
246
+
247
+ # @!attribute [rw] key
248
+ # @return [::String]
249
+ # @!attribute [rw] value
250
+ # @return [::String]
251
+ class LabelsEntry
252
+ include ::Google::Protobuf::MessageExts
253
+ extend ::Google::Protobuf::MessageExts::ClassMethods
254
+ end
255
+ end
256
+
257
+ # Entry Type is a template for creating Entries.
258
+ # @!attribute [r] name
259
+ # @return [::String]
260
+ # Output only. The relative resource name of the EntryType, of the form:
261
+ # projects/\\{project_number}/locations/\\{location_id}/entryTypes/\\{entry_type_id}.
262
+ # @!attribute [r] uid
263
+ # @return [::String]
264
+ # Output only. System generated globally unique ID for the EntryType. This ID
265
+ # will be different if the EntryType is deleted and re-created with the same
266
+ # name.
267
+ # @!attribute [r] create_time
268
+ # @return [::Google::Protobuf::Timestamp]
269
+ # Output only. The time when the EntryType was created.
270
+ # @!attribute [r] update_time
271
+ # @return [::Google::Protobuf::Timestamp]
272
+ # Output only. The time when the EntryType was last updated.
273
+ # @!attribute [rw] description
274
+ # @return [::String]
275
+ # Optional. Description of the EntryType.
276
+ # @!attribute [rw] display_name
277
+ # @return [::String]
278
+ # Optional. User friendly display name.
279
+ # @!attribute [rw] labels
280
+ # @return [::Google::Protobuf::Map{::String => ::String}]
281
+ # Optional. User-defined labels for the EntryType.
282
+ # @!attribute [rw] etag
283
+ # @return [::String]
284
+ # Optional. This checksum is computed by the server based on the value of
285
+ # other fields, and may be sent on update and delete requests to ensure the
286
+ # client has an up-to-date value before proceeding.
287
+ # @!attribute [rw] type_aliases
288
+ # @return [::Array<::String>]
289
+ # Optional. Indicates the class this Entry Type belongs to, for example,
290
+ # TABLE, DATABASE, MODEL.
291
+ # @!attribute [rw] platform
292
+ # @return [::String]
293
+ # Optional. The platform that Entries of this type belongs to.
294
+ # @!attribute [rw] system
295
+ # @return [::String]
296
+ # Optional. The system that Entries of this type belongs to. Examples include
297
+ # CloudSQL, MariaDB etc
298
+ # @!attribute [rw] required_aspects
299
+ # @return [::Array<::Google::Cloud::Dataplex::V1::EntryType::AspectInfo>]
300
+ # AspectInfo for the entry type.
301
+ # @!attribute [rw] authorization
302
+ # @return [::Google::Cloud::Dataplex::V1::EntryType::Authorization]
303
+ # Immutable. Authorization defined for this type.
304
+ class EntryType
305
+ include ::Google::Protobuf::MessageExts
306
+ extend ::Google::Protobuf::MessageExts::ClassMethods
307
+
308
+ # @!attribute [rw] type
309
+ # @return [::String]
310
+ # Required aspect type for the entry type.
311
+ class AspectInfo
312
+ include ::Google::Protobuf::MessageExts
313
+ extend ::Google::Protobuf::MessageExts::ClassMethods
314
+ end
315
+
316
+ # Authorization for an Entry Type.
317
+ # @!attribute [rw] alternate_use_permission
318
+ # @return [::String]
319
+ # Immutable. The IAM permission grantable on the Entry Group to allow
320
+ # access to instantiate Entries of Dataplex owned Entry Types, only
321
+ # settable for Dataplex owned Types.
322
+ class Authorization
323
+ include ::Google::Protobuf::MessageExts
324
+ extend ::Google::Protobuf::MessageExts::ClassMethods
325
+ end
326
+
327
+ # @!attribute [rw] key
328
+ # @return [::String]
329
+ # @!attribute [rw] value
330
+ # @return [::String]
331
+ class LabelsEntry
332
+ include ::Google::Protobuf::MessageExts
333
+ extend ::Google::Protobuf::MessageExts::ClassMethods
334
+ end
335
+ end
336
+
337
+ # An aspect is a single piece of metadata describing an entry.
338
+ # @!attribute [r] aspect_type
339
+ # @return [::String]
340
+ # Output only. The resource name of the type used to create this Aspect.
341
+ # @!attribute [r] path
342
+ # @return [::String]
343
+ # Output only. The path in the entry under which the aspect is attached.
344
+ # @!attribute [r] create_time
345
+ # @return [::Google::Protobuf::Timestamp]
346
+ # Output only. The time when the Aspect was created.
347
+ # @!attribute [r] update_time
348
+ # @return [::Google::Protobuf::Timestamp]
349
+ # Output only. The time when the Aspect was last updated.
350
+ # @!attribute [rw] data
351
+ # @return [::Google::Protobuf::Struct]
352
+ # Required. The content of the aspect, according to its aspect type schema.
353
+ # This will replace `content`.
354
+ # The maximum size of the field is 120KB (encoded as UTF-8).
355
+ # @!attribute [rw] aspect_source
356
+ # @return [::Google::Cloud::Dataplex::V1::AspectSource]
357
+ class Aspect
358
+ include ::Google::Protobuf::MessageExts
359
+ extend ::Google::Protobuf::MessageExts::ClassMethods
360
+ end
361
+
362
+ # AspectSource contains source system related information for the
363
+ # aspect.
364
+ # @!attribute [rw] create_time
365
+ # @return [::Google::Protobuf::Timestamp]
366
+ # The create time of the aspect in the source system.
367
+ # @!attribute [rw] update_time
368
+ # @return [::Google::Protobuf::Timestamp]
369
+ # The update time of the aspect in the source system.
370
+ class AspectSource
371
+ include ::Google::Protobuf::MessageExts
372
+ extend ::Google::Protobuf::MessageExts::ClassMethods
373
+ end
374
+
375
+ # An entry is a representation of a data asset which can be described by
376
+ # various metadata.
377
+ # @!attribute [rw] name
378
+ # @return [::String]
379
+ # Identifier. The relative resource name of the Entry, of the form:
380
+ # projects/\\{project}/locations/\\{location}/entryGroups/\\{entry_group}/entries/\\{entry}.
381
+ # @!attribute [rw] entry_type
382
+ # @return [::String]
383
+ # Required. Immutable. The resource name of the EntryType used to create this
384
+ # Entry.
385
+ # @!attribute [r] create_time
386
+ # @return [::Google::Protobuf::Timestamp]
387
+ # Output only. The time when the Entry was created.
388
+ # @!attribute [r] update_time
389
+ # @return [::Google::Protobuf::Timestamp]
390
+ # Output only. The time when the Entry was last updated.
391
+ # @!attribute [rw] aspects
392
+ # @return [::Google::Protobuf::Map{::String => ::Google::Cloud::Dataplex::V1::Aspect}]
393
+ # Optional. The Aspects attached to the Entry. The key is either the resource
394
+ # name of the aspect type (if the aspect is attached directly to the entry)
395
+ # or "aspectType@path" if the aspect is attached to an entry's path.
396
+ # @!attribute [rw] parent_entry
397
+ # @return [::String]
398
+ # Optional. Immutable. The resource name of the parent entry.
399
+ # @!attribute [rw] fully_qualified_name
400
+ # @return [::String]
401
+ # Optional. A name for the entry that can reference it in an external system.
402
+ # The maximum size of the field is 4000 characters.
403
+ # @!attribute [rw] entry_source
404
+ # @return [::Google::Cloud::Dataplex::V1::EntrySource]
405
+ # Optional. Source system related information for an entry.
406
+ class Entry
407
+ include ::Google::Protobuf::MessageExts
408
+ extend ::Google::Protobuf::MessageExts::ClassMethods
409
+
410
+ # @!attribute [rw] key
411
+ # @return [::String]
412
+ # @!attribute [rw] value
413
+ # @return [::Google::Cloud::Dataplex::V1::Aspect]
414
+ class AspectsEntry
415
+ include ::Google::Protobuf::MessageExts
416
+ extend ::Google::Protobuf::MessageExts::ClassMethods
417
+ end
418
+ end
419
+
420
+ # EntrySource contains source system related information for the
421
+ # entry.
422
+ # @!attribute [rw] resource
423
+ # @return [::String]
424
+ # The name of the resource in the source system.
425
+ # The maximum size of the field is 4000 characters.
426
+ # @!attribute [rw] system
427
+ # @return [::String]
428
+ # The name of the source system.
429
+ # The maximum size of the field is 64 characters.
430
+ # @!attribute [rw] platform
431
+ # @return [::String]
432
+ # The platform containing the source system.
433
+ # The maximum size of the field is 64 characters.
434
+ # @!attribute [rw] display_name
435
+ # @return [::String]
436
+ # User friendly display name.
437
+ # The maximum size of the field is 500 characters.
438
+ # @!attribute [rw] description
439
+ # @return [::String]
440
+ # Description of the Entry.
441
+ # The maximum size of the field is 2000 characters.
442
+ # @!attribute [rw] labels
443
+ # @return [::Google::Protobuf::Map{::String => ::String}]
444
+ # User-defined labels.
445
+ # The maximum size of keys and values is 128 characters each.
446
+ # @!attribute [rw] ancestors
447
+ # @return [::Array<::Google::Cloud::Dataplex::V1::EntrySource::Ancestor>]
448
+ # Immutable. The ancestors of the Entry in the source system.
449
+ # @!attribute [rw] create_time
450
+ # @return [::Google::Protobuf::Timestamp]
451
+ # The create time of the resource in the source system.
452
+ # @!attribute [rw] update_time
453
+ # @return [::Google::Protobuf::Timestamp]
454
+ # The update time of the resource in the source system.
455
+ class EntrySource
456
+ include ::Google::Protobuf::MessageExts
457
+ extend ::Google::Protobuf::MessageExts::ClassMethods
458
+
459
+ # Ancestor contains information about individual items in the hierarchy of
460
+ # an Entry.
461
+ # @!attribute [rw] name
462
+ # @return [::String]
463
+ # Optional. The name of the ancestor resource.
464
+ # @!attribute [rw] type
465
+ # @return [::String]
466
+ # Optional. The type of the ancestor resource.
467
+ class Ancestor
468
+ include ::Google::Protobuf::MessageExts
469
+ extend ::Google::Protobuf::MessageExts::ClassMethods
470
+ end
471
+
472
+ # @!attribute [rw] key
473
+ # @return [::String]
474
+ # @!attribute [rw] value
475
+ # @return [::String]
476
+ class LabelsEntry
477
+ include ::Google::Protobuf::MessageExts
478
+ extend ::Google::Protobuf::MessageExts::ClassMethods
479
+ end
480
+ end
481
+
482
+ # Create EntryGroup Request
483
+ # @!attribute [rw] parent
484
+ # @return [::String]
485
+ # Required. The resource name of the entryGroup, of the form:
486
+ # projects/\\{project_number}/locations/\\{location_id}
487
+ # where `location_id` refers to a GCP region.
488
+ # @!attribute [rw] entry_group_id
489
+ # @return [::String]
490
+ # Required. EntryGroup identifier.
491
+ # @!attribute [rw] entry_group
492
+ # @return [::Google::Cloud::Dataplex::V1::EntryGroup]
493
+ # Required. EntryGroup Resource
494
+ # @!attribute [rw] validate_only
495
+ # @return [::Boolean]
496
+ # Optional. Only validate the request, but do not perform mutations.
497
+ # The default is false.
498
+ class CreateEntryGroupRequest
499
+ include ::Google::Protobuf::MessageExts
500
+ extend ::Google::Protobuf::MessageExts::ClassMethods
501
+ end
502
+
503
+ # Update EntryGroup Request
504
+ # @!attribute [rw] entry_group
505
+ # @return [::Google::Cloud::Dataplex::V1::EntryGroup]
506
+ # Required. EntryGroup Resource
507
+ # @!attribute [rw] update_mask
508
+ # @return [::Google::Protobuf::FieldMask]
509
+ # Required. Mask of fields to update.
510
+ # @!attribute [rw] validate_only
511
+ # @return [::Boolean]
512
+ # Optional. Only validate the request, but do not perform mutations.
513
+ # The default is false.
514
+ class UpdateEntryGroupRequest
515
+ include ::Google::Protobuf::MessageExts
516
+ extend ::Google::Protobuf::MessageExts::ClassMethods
517
+ end
518
+
519
+ # Delele EntryGroup Request
520
+ # @!attribute [rw] name
521
+ # @return [::String]
522
+ # Required. The resource name of the EntryGroup:
523
+ # `projects/{project_number}/locations/{location_id}/entryGroups/{entry_group_id}`.
524
+ # @!attribute [rw] etag
525
+ # @return [::String]
526
+ # Optional. If the client provided etag value does not match the current etag
527
+ # value, the DeleteEntryGroupRequest method returns an ABORTED error response
528
+ class DeleteEntryGroupRequest
529
+ include ::Google::Protobuf::MessageExts
530
+ extend ::Google::Protobuf::MessageExts::ClassMethods
531
+ end
532
+
533
+ # List entryGroups request.
534
+ # @!attribute [rw] parent
535
+ # @return [::String]
536
+ # Required. The resource name of the entryGroup location, of the form:
537
+ # `projects/{project_number}/locations/{location_id}`
538
+ # where `location_id` refers to a GCP region.
539
+ # @!attribute [rw] page_size
540
+ # @return [::Integer]
541
+ # Optional. Maximum number of EntryGroups to return. The service may return
542
+ # fewer than this value. If unspecified, at most 10 EntryGroups will be
543
+ # returned. The maximum value is 1000; values above 1000 will be coerced to
544
+ # 1000.
545
+ # @!attribute [rw] page_token
546
+ # @return [::String]
547
+ # Optional. Page token received from a previous `ListEntryGroups` call.
548
+ # Provide this to retrieve the subsequent page. When paginating, all other
549
+ # parameters provided to `ListEntryGroups` must match the call that provided
550
+ # the page token.
551
+ # @!attribute [rw] filter
552
+ # @return [::String]
553
+ # Optional. Filter request.
554
+ # @!attribute [rw] order_by
555
+ # @return [::String]
556
+ # Optional. Order by fields for the result.
557
+ class ListEntryGroupsRequest
558
+ include ::Google::Protobuf::MessageExts
559
+ extend ::Google::Protobuf::MessageExts::ClassMethods
560
+ end
561
+
562
+ # List ListEntryGroups response.
563
+ # @!attribute [rw] entry_groups
564
+ # @return [::Array<::Google::Cloud::Dataplex::V1::EntryGroup>]
565
+ # ListEntryGroups under the given parent location.
566
+ # @!attribute [rw] next_page_token
567
+ # @return [::String]
568
+ # Token to retrieve the next page of results, or empty if there are no more
569
+ # results in the list.
570
+ # @!attribute [rw] unreachable_locations
571
+ # @return [::Array<::String>]
572
+ # Locations that could not be reached.
573
+ class ListEntryGroupsResponse
574
+ include ::Google::Protobuf::MessageExts
575
+ extend ::Google::Protobuf::MessageExts::ClassMethods
576
+ end
577
+
578
+ # Get EntryGroup request.
579
+ # @!attribute [rw] name
580
+ # @return [::String]
581
+ # Required. The resource name of the EntryGroup:
582
+ # `projects/{project_number}/locations/{location_id}/entryGroups/{entry_group_id}`.
583
+ class GetEntryGroupRequest
584
+ include ::Google::Protobuf::MessageExts
585
+ extend ::Google::Protobuf::MessageExts::ClassMethods
586
+ end
587
+
588
+ # Create EntryType Request
589
+ # @!attribute [rw] parent
590
+ # @return [::String]
591
+ # Required. The resource name of the EntryType, of the form:
592
+ # projects/\\{project_number}/locations/\\{location_id}
593
+ # where `location_id` refers to a GCP region.
594
+ # @!attribute [rw] entry_type_id
595
+ # @return [::String]
596
+ # Required. EntryType identifier.
597
+ # @!attribute [rw] entry_type
598
+ # @return [::Google::Cloud::Dataplex::V1::EntryType]
599
+ # Required. EntryType Resource
600
+ # @!attribute [rw] validate_only
601
+ # @return [::Boolean]
602
+ # Optional. Only validate the request, but do not perform mutations.
603
+ # The default is false.
604
+ class CreateEntryTypeRequest
605
+ include ::Google::Protobuf::MessageExts
606
+ extend ::Google::Protobuf::MessageExts::ClassMethods
607
+ end
608
+
609
+ # Update EntryType Request
610
+ # @!attribute [rw] entry_type
611
+ # @return [::Google::Cloud::Dataplex::V1::EntryType]
612
+ # Required. EntryType Resource
613
+ # @!attribute [rw] update_mask
614
+ # @return [::Google::Protobuf::FieldMask]
615
+ # Required. Mask of fields to update.
616
+ # @!attribute [rw] validate_only
617
+ # @return [::Boolean]
618
+ # Optional. Only validate the request, but do not perform mutations.
619
+ # The default is false.
620
+ class UpdateEntryTypeRequest
621
+ include ::Google::Protobuf::MessageExts
622
+ extend ::Google::Protobuf::MessageExts::ClassMethods
623
+ end
624
+
625
+ # Delele EntryType Request
626
+ # @!attribute [rw] name
627
+ # @return [::String]
628
+ # Required. The resource name of the EntryType:
629
+ # `projects/{project_number}/locations/{location_id}/entryTypes/{entry_type_id}`.
630
+ # @!attribute [rw] etag
631
+ # @return [::String]
632
+ # Optional. If the client provided etag value does not match the current etag
633
+ # value, the DeleteEntryTypeRequest method returns an ABORTED error response
634
+ class DeleteEntryTypeRequest
635
+ include ::Google::Protobuf::MessageExts
636
+ extend ::Google::Protobuf::MessageExts::ClassMethods
637
+ end
638
+
639
+ # List EntryTypes request
640
+ # @!attribute [rw] parent
641
+ # @return [::String]
642
+ # Required. The resource name of the EntryType location, of the form:
643
+ # `projects/{project_number}/locations/{location_id}`
644
+ # where `location_id` refers to a GCP region.
645
+ # @!attribute [rw] page_size
646
+ # @return [::Integer]
647
+ # Optional. Maximum number of EntryTypes to return. The service may return
648
+ # fewer than this value. If unspecified, at most 10 EntryTypes will be
649
+ # returned. The maximum value is 1000; values above 1000 will be coerced to
650
+ # 1000.
651
+ # @!attribute [rw] page_token
652
+ # @return [::String]
653
+ # Optional. Page token received from a previous `ListEntryTypes` call.
654
+ # Provide this to retrieve the subsequent page. When paginating, all other
655
+ # parameters provided to `ListEntryTypes` must match the call that provided
656
+ # the page token.
657
+ # @!attribute [rw] filter
658
+ # @return [::String]
659
+ # Optional. Filter request. Filters are case-sensitive.
660
+ # The following formats are supported:
661
+ #
662
+ # labels.key1 = "value1"
663
+ # labels:key1
664
+ # name = "value"
665
+ # These restrictions can be coinjoined with AND, OR and NOT conjunctions.
666
+ # @!attribute [rw] order_by
667
+ # @return [::String]
668
+ # Optional. Order by fields (`name` or `create_time`) for the result.
669
+ # If not specified, the ordering is undefined.
670
+ class ListEntryTypesRequest
671
+ include ::Google::Protobuf::MessageExts
672
+ extend ::Google::Protobuf::MessageExts::ClassMethods
673
+ end
674
+
675
+ # List EntryTypes response
676
+ # @!attribute [rw] entry_types
677
+ # @return [::Array<::Google::Cloud::Dataplex::V1::EntryType>]
678
+ # ListEntryTypes under the given parent location.
679
+ # @!attribute [rw] next_page_token
680
+ # @return [::String]
681
+ # Token to retrieve the next page of results, or empty if there are no more
682
+ # results in the list.
683
+ # @!attribute [rw] unreachable_locations
684
+ # @return [::Array<::String>]
685
+ # Locations that could not be reached.
686
+ class ListEntryTypesResponse
687
+ include ::Google::Protobuf::MessageExts
688
+ extend ::Google::Protobuf::MessageExts::ClassMethods
689
+ end
690
+
691
+ # Get EntryType request
692
+ # @!attribute [rw] name
693
+ # @return [::String]
694
+ # Required. The resource name of the EntryType:
695
+ # `projects/{project_number}/locations/{location_id}/entryTypes/{entry_type_id}`.
696
+ class GetEntryTypeRequest
697
+ include ::Google::Protobuf::MessageExts
698
+ extend ::Google::Protobuf::MessageExts::ClassMethods
699
+ end
700
+
701
+ # Create AspectType Request
702
+ # @!attribute [rw] parent
703
+ # @return [::String]
704
+ # Required. The resource name of the AspectType, of the form:
705
+ # projects/\\{project_number}/locations/\\{location_id}
706
+ # where `location_id` refers to a GCP region.
707
+ # @!attribute [rw] aspect_type_id
708
+ # @return [::String]
709
+ # Required. AspectType identifier.
710
+ # @!attribute [rw] aspect_type
711
+ # @return [::Google::Cloud::Dataplex::V1::AspectType]
712
+ # Required. AspectType Resource
713
+ # @!attribute [rw] validate_only
714
+ # @return [::Boolean]
715
+ # Optional. Only validate the request, but do not perform mutations.
716
+ # The default is false.
717
+ class CreateAspectTypeRequest
718
+ include ::Google::Protobuf::MessageExts
719
+ extend ::Google::Protobuf::MessageExts::ClassMethods
720
+ end
721
+
722
+ # Update AspectType Request
723
+ # @!attribute [rw] aspect_type
724
+ # @return [::Google::Cloud::Dataplex::V1::AspectType]
725
+ # Required. AspectType Resource
726
+ # @!attribute [rw] update_mask
727
+ # @return [::Google::Protobuf::FieldMask]
728
+ # Required. Mask of fields to update.
729
+ # @!attribute [rw] validate_only
730
+ # @return [::Boolean]
731
+ # Optional. Only validate the request, but do not perform mutations.
732
+ # The default is false.
733
+ class UpdateAspectTypeRequest
734
+ include ::Google::Protobuf::MessageExts
735
+ extend ::Google::Protobuf::MessageExts::ClassMethods
736
+ end
737
+
738
+ # Delele AspectType Request
739
+ # @!attribute [rw] name
740
+ # @return [::String]
741
+ # Required. The resource name of the AspectType:
742
+ # `projects/{project_number}/locations/{location_id}/aspectTypes/{aspect_type_id}`.
743
+ # @!attribute [rw] etag
744
+ # @return [::String]
745
+ # Optional. If the client provided etag value does not match the current etag
746
+ # value, the DeleteAspectTypeRequest method returns an ABORTED error response
747
+ class DeleteAspectTypeRequest
748
+ include ::Google::Protobuf::MessageExts
749
+ extend ::Google::Protobuf::MessageExts::ClassMethods
750
+ end
751
+
752
+ # List AspectTypes request
753
+ # @!attribute [rw] parent
754
+ # @return [::String]
755
+ # Required. The resource name of the AspectType location, of the form:
756
+ # `projects/{project_number}/locations/{location_id}`
757
+ # where `location_id` refers to a GCP region.
758
+ # @!attribute [rw] page_size
759
+ # @return [::Integer]
760
+ # Optional. Maximum number of AspectTypes to return. The service may return
761
+ # fewer than this value. If unspecified, at most 10 AspectTypes will be
762
+ # returned. The maximum value is 1000; values above 1000 will be coerced to
763
+ # 1000.
764
+ # @!attribute [rw] page_token
765
+ # @return [::String]
766
+ # Optional. Page token received from a previous `ListAspectTypes` call.
767
+ # Provide this to retrieve the subsequent page. When paginating, all other
768
+ # parameters provided to `ListAspectTypes` must match the call that provided
769
+ # the page token.
770
+ # @!attribute [rw] filter
771
+ # @return [::String]
772
+ # Optional. Filter request. Filters are case-sensitive.
773
+ # The following formats are supported:
774
+ #
775
+ # labels.key1 = "value1"
776
+ # labels:key1
777
+ # name = "value"
778
+ # These restrictions can be coinjoined with AND, OR and NOT conjunctions.
779
+ # @!attribute [rw] order_by
780
+ # @return [::String]
781
+ # Optional. Order by fields (`name` or `create_time`) for the result.
782
+ # If not specified, the ordering is undefined.
783
+ class ListAspectTypesRequest
784
+ include ::Google::Protobuf::MessageExts
785
+ extend ::Google::Protobuf::MessageExts::ClassMethods
786
+ end
787
+
788
+ # List AspectTypes response
789
+ # @!attribute [rw] aspect_types
790
+ # @return [::Array<::Google::Cloud::Dataplex::V1::AspectType>]
791
+ # ListAspectTypes under the given parent location.
792
+ # @!attribute [rw] next_page_token
793
+ # @return [::String]
794
+ # Token to retrieve the next page of results, or empty if there are no more
795
+ # results in the list.
796
+ # @!attribute [rw] unreachable_locations
797
+ # @return [::Array<::String>]
798
+ # Locations that could not be reached.
799
+ class ListAspectTypesResponse
800
+ include ::Google::Protobuf::MessageExts
801
+ extend ::Google::Protobuf::MessageExts::ClassMethods
802
+ end
803
+
804
+ # Get AspectType request
805
+ # @!attribute [rw] name
806
+ # @return [::String]
807
+ # Required. The resource name of the AspectType:
808
+ # `projects/{project_number}/locations/{location_id}/aspectTypes/{aspect_type_id}`.
809
+ class GetAspectTypeRequest
810
+ include ::Google::Protobuf::MessageExts
811
+ extend ::Google::Protobuf::MessageExts::ClassMethods
812
+ end
813
+
814
+ # @!attribute [rw] parent
815
+ # @return [::String]
816
+ # Required. The resource name of the parent Entry Group:
817
+ # `projects/{project}/locations/{location}/entryGroups/{entry_group}`.
818
+ # @!attribute [rw] entry_id
819
+ # @return [::String]
820
+ # Required. Entry identifier. It has to be unique within an Entry Group.
821
+ #
822
+ # Entries corresponding to Google Cloud resources use Entry ID format based
823
+ # on Full Resource Names
824
+ # (https://cloud.google.com/apis/design/resource_names#full_resource_name).
825
+ # The format is a Full Resource Name of the resource without the
826
+ # prefix double slashes in the API Service Name part of Full Resource Name.
827
+ # This allows retrieval of entries using their associated resource name.
828
+ #
829
+ # For example if the Full Resource Name of a resource is
830
+ # `//library.googleapis.com/shelves/shelf1/books/book2`,
831
+ # then the suggested entry_id is
832
+ # `library.googleapis.com/shelves/shelf1/books/book2`.
833
+ #
834
+ # It is also suggested to follow the same convention for entries
835
+ # corresponding to resources from other providers or systems than Google
836
+ # Cloud.
837
+ #
838
+ # The maximum size of the field is 4000 characters.
839
+ # @!attribute [rw] entry
840
+ # @return [::Google::Cloud::Dataplex::V1::Entry]
841
+ # Required. Entry resource.
842
+ class CreateEntryRequest
843
+ include ::Google::Protobuf::MessageExts
844
+ extend ::Google::Protobuf::MessageExts::ClassMethods
845
+ end
846
+
847
+ # @!attribute [rw] entry
848
+ # @return [::Google::Cloud::Dataplex::V1::Entry]
849
+ # Required. Entry resource.
850
+ # @!attribute [rw] update_mask
851
+ # @return [::Google::Protobuf::FieldMask]
852
+ # Optional. Mask of fields to update. To update Aspects, the update_mask must
853
+ # contain the value "aspects".
854
+ #
855
+ # If the update_mask is empty, all modifiable fields present in the request
856
+ # will be updated.
857
+ # @!attribute [rw] allow_missing
858
+ # @return [::Boolean]
859
+ # Optional. If set to true and the entry does not exist, it will be created.
860
+ # @!attribute [rw] delete_missing_aspects
861
+ # @return [::Boolean]
862
+ # Optional. If set to true and the aspect_keys specify aspect ranges, any
863
+ # existing aspects from that range not provided in the request will be
864
+ # deleted.
865
+ # @!attribute [rw] aspect_keys
866
+ # @return [::Array<::String>]
867
+ # Optional. The map keys of the Aspects which should be modified. Supports
868
+ # the following syntaxes:
869
+ # * <aspect_type_reference> - matches aspect on given type and empty path
870
+ # * <aspect_type_reference>@path - matches aspect on given type and specified
871
+ # path
872
+ # * <aspect_type_reference>* - matches aspects on given type for all paths
873
+ # * *@path - matches aspects of all types on the given path
874
+ #
875
+ # Existing aspects matching the syntax will not be removed unless
876
+ # `delete_missing_aspects` is set to true.
877
+ #
878
+ # If this field is left empty, it will be treated as specifying exactly those
879
+ # Aspects present in the request.
880
+ class UpdateEntryRequest
881
+ include ::Google::Protobuf::MessageExts
882
+ extend ::Google::Protobuf::MessageExts::ClassMethods
883
+ end
884
+
885
+ # @!attribute [rw] name
886
+ # @return [::String]
887
+ # Required. The resource name of the Entry:
888
+ # `projects/{project}/locations/{location}/entryGroups/{entry_group}/entries/{entry}`.
889
+ class DeleteEntryRequest
890
+ include ::Google::Protobuf::MessageExts
891
+ extend ::Google::Protobuf::MessageExts::ClassMethods
892
+ end
893
+
894
+ # @!attribute [rw] parent
895
+ # @return [::String]
896
+ # Required. The resource name of the parent Entry Group:
897
+ # `projects/{project}/locations/{location}/entryGroups/{entry_group}`.
898
+ # @!attribute [rw] page_size
899
+ # @return [::Integer]
900
+ # @!attribute [rw] page_token
901
+ # @return [::String]
902
+ # Optional. The pagination token returned by a previous request.
903
+ # @!attribute [rw] filter
904
+ # @return [::String]
905
+ # Optional. A filter on the entries to return.
906
+ # Filters are case-sensitive.
907
+ # The request can be filtered by the following fields:
908
+ # entry_type, display_name.
909
+ # The comparison operators are =, !=, <, >, <=, >= (strings are compared
910
+ # according to lexical order)
911
+ # The logical operators AND, OR, NOT can be used
912
+ # in the filter. Example filter expressions:
913
+ # "display_name=AnExampleDisplayName"
914
+ # "entry_type=projects/example-project/locations/global/entryTypes/example-entry_type"
915
+ # "entry_type=projects/a* OR "entry_type=projects/k*"
916
+ # "NOT display_name=AnotherExampleDisplayName"
917
+ class ListEntriesRequest
918
+ include ::Google::Protobuf::MessageExts
919
+ extend ::Google::Protobuf::MessageExts::ClassMethods
920
+ end
921
+
922
+ # @!attribute [rw] entries
923
+ # @return [::Array<::Google::Cloud::Dataplex::V1::Entry>]
924
+ # The list of entries.
925
+ # @!attribute [rw] next_page_token
926
+ # @return [::String]
927
+ # Pagination token.
928
+ class ListEntriesResponse
929
+ include ::Google::Protobuf::MessageExts
930
+ extend ::Google::Protobuf::MessageExts::ClassMethods
931
+ end
932
+
933
+ # @!attribute [rw] name
934
+ # @return [::String]
935
+ # Required. The resource name of the Entry:
936
+ # `projects/{project}/locations/{location}/entryGroups/{entry_group}/entries/{entry}`.
937
+ # @!attribute [rw] view
938
+ # @return [::Google::Cloud::Dataplex::V1::EntryView]
939
+ # Optional. View for controlling which parts of an entry are to be returned.
940
+ # @!attribute [rw] aspect_types
941
+ # @return [::Array<::String>]
942
+ # Optional. Limits the aspects returned to the provided aspect types.
943
+ # Only works if the CUSTOM view is selected.
944
+ # @!attribute [rw] paths
945
+ # @return [::Array<::String>]
946
+ # Optional. Limits the aspects returned to those associated with the provided
947
+ # paths within the Entry. Only works if the CUSTOM view is selected.
948
+ class GetEntryRequest
949
+ include ::Google::Protobuf::MessageExts
950
+ extend ::Google::Protobuf::MessageExts::ClassMethods
951
+ end
952
+
953
+ # @!attribute [rw] name
954
+ # @return [::String]
955
+ # Required. The project to which the request should be attributed in the
956
+ # following form: `projects/{project}/locations/{location}`.
957
+ # @!attribute [rw] view
958
+ # @return [::Google::Cloud::Dataplex::V1::EntryView]
959
+ # Optional. View for controlling which parts of an entry are to be returned.
960
+ # @!attribute [rw] aspect_types
961
+ # @return [::Array<::String>]
962
+ # Optional. Limits the aspects returned to the provided aspect types.
963
+ # Only works if the CUSTOM view is selected.
964
+ # @!attribute [rw] paths
965
+ # @return [::Array<::String>]
966
+ # Optional. Limits the aspects returned to those associated with the provided
967
+ # paths within the Entry. Only works if the CUSTOM view is selected.
968
+ # @!attribute [rw] entry
969
+ # @return [::String]
970
+ # Required. The resource name of the Entry:
971
+ # `projects/{project}/locations/{location}/entryGroups/{entry_group}/entries/{entry}`.
972
+ class LookupEntryRequest
973
+ include ::Google::Protobuf::MessageExts
974
+ extend ::Google::Protobuf::MessageExts::ClassMethods
975
+ end
976
+
977
+ # @!attribute [rw] name
978
+ # @return [::String]
979
+ # Required. The project to which the request should be attributed in the
980
+ # following form: `projects/{project}/locations/{location}`.
981
+ # @!attribute [rw] query
982
+ # @return [::String]
983
+ # Required. The query against which entries in scope should be matched.
984
+ # @!attribute [rw] page_size
985
+ # @return [::Integer]
986
+ # Optional. Pagination.
987
+ # @!attribute [rw] page_token
988
+ # @return [::String]
989
+ # @!attribute [rw] order_by
990
+ # @return [::String]
991
+ # Optional. Ordering of the results. Supported options to be added later.
992
+ # @!attribute [rw] scope
993
+ # @return [::String]
994
+ # Optional. The scope under which the search should be operating. Should
995
+ # either be organizations/<org_id> or projects/<project_ref>. If left
996
+ # unspecified, it will default to the organization where the project provided
997
+ # in `name` is located.
998
+ class SearchEntriesRequest
999
+ include ::Google::Protobuf::MessageExts
1000
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1001
+ end
1002
+
1003
+ # A single result of a SearchEntries request.
1004
+ # @!attribute [rw] entry
1005
+ # @deprecated This field is deprecated and may be removed in the next major version update.
1006
+ # @return [::String]
1007
+ # Resource name of the entry.
1008
+ # @!attribute [rw] display_name
1009
+ # @deprecated This field is deprecated and may be removed in the next major version update.
1010
+ # @return [::String]
1011
+ # Display name.
1012
+ # @!attribute [rw] entry_type
1013
+ # @deprecated This field is deprecated and may be removed in the next major version update.
1014
+ # @return [::String]
1015
+ # The entry type.
1016
+ # @!attribute [rw] modify_time
1017
+ # @deprecated This field is deprecated and may be removed in the next major version update.
1018
+ # @return [::Google::Protobuf::Timestamp]
1019
+ # The last modification timestamp.
1020
+ # @!attribute [rw] fully_qualified_name
1021
+ # @deprecated This field is deprecated and may be removed in the next major version update.
1022
+ # @return [::String]
1023
+ # Fully qualified name.
1024
+ # @!attribute [rw] description
1025
+ # @deprecated This field is deprecated and may be removed in the next major version update.
1026
+ # @return [::String]
1027
+ # Entry description.
1028
+ # @!attribute [rw] relative_resource
1029
+ # @deprecated This field is deprecated and may be removed in the next major version update.
1030
+ # @return [::String]
1031
+ # Relative resource name.
1032
+ # @!attribute [rw] linked_resource
1033
+ # @return [::String]
1034
+ # Linked resource name.
1035
+ # @!attribute [rw] dataplex_entry
1036
+ # @return [::Google::Cloud::Dataplex::V1::Entry]
1037
+ # Entry format of the result.
1038
+ # @!attribute [rw] snippets
1039
+ # @return [::Google::Cloud::Dataplex::V1::SearchEntriesResult::Snippets]
1040
+ # Snippets.
1041
+ class SearchEntriesResult
1042
+ include ::Google::Protobuf::MessageExts
1043
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1044
+
1045
+ # Snippets for the entry, contains HTML-style highlighting for
1046
+ # matched tokens, will be used in UI.
1047
+ # @!attribute [rw] dataplex_entry
1048
+ # @return [::Google::Cloud::Dataplex::V1::Entry]
1049
+ # Entry
1050
+ class Snippets
1051
+ include ::Google::Protobuf::MessageExts
1052
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1053
+ end
1054
+ end
1055
+
1056
+ # @!attribute [rw] results
1057
+ # @return [::Array<::Google::Cloud::Dataplex::V1::SearchEntriesResult>]
1058
+ # The results matching the search query.
1059
+ # @!attribute [rw] total_size
1060
+ # @return [::Integer]
1061
+ # The estimated total number of matching entries. Not guaranteed to be
1062
+ # accurate.
1063
+ # @!attribute [rw] next_page_token
1064
+ # @return [::String]
1065
+ # Pagination token.
1066
+ # @!attribute [rw] unreachable
1067
+ # @return [::Array<::String>]
1068
+ # Unreachable locations. Search results don't include data from those
1069
+ # locations.
1070
+ class SearchEntriesResponse
1071
+ include ::Google::Protobuf::MessageExts
1072
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1073
+ end
1074
+
1075
+ # View for controlling which parts of an entry are to be returned.
1076
+ module EntryView
1077
+ # Unspecified EntryView. Defaults to FULL.
1078
+ ENTRY_VIEW_UNSPECIFIED = 0
1079
+
1080
+ # Returns entry only, without aspects.
1081
+ BASIC = 1
1082
+
1083
+ # Returns all required aspects as well as the keys of all non-required
1084
+ # aspects.
1085
+ FULL = 2
1086
+
1087
+ # Returns aspects matching custom fields in GetEntryRequest. If the number of
1088
+ # aspects would exceed 100, the first 100 will be returned.
1089
+ CUSTOM = 3
1090
+
1091
+ # Returns all aspects. If the number of aspects would exceed 100, the first
1092
+ # 100 will be returned.
1093
+ ALL = 4
1094
+ end
1095
+
1096
+ # Denotes the transfer status of a resource. It is unspecified for resources
1097
+ # created from Dataplex API.
1098
+ module TransferStatus
1099
+ # The default value. It is set for resources that were not subject for
1100
+ # migration from Data Catalog service.
1101
+ TRANSFER_STATUS_UNSPECIFIED = 0
1102
+
1103
+ # Indicates that a resource was migrated from Data Catalog service but it
1104
+ # hasn't been transferred yet. In particular the resource cannot be updated
1105
+ # from Dataplex API.
1106
+ TRANSFER_STATUS_MIGRATED = 1
1107
+
1108
+ # Indicates that a resource was transferred from Data Catalog service. The
1109
+ # resource can only be updated from Dataplex API.
1110
+ TRANSFER_STATUS_TRANSFERRED = 2
1111
+ end
1112
+ end
1113
+ end
1114
+ end
1115
+ end