google-cloud-dataplex-v1 0.19.0 → 0.21.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 (46) 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 +2822 -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 +809 -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 +2647 -0
  11. data/lib/google/cloud/dataplex/v1/catalog_service/rest/operations.rb +902 -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/content_service/client.rb +19 -8
  17. data/lib/google/cloud/dataplex/v1/content_service/rest/client.rb +19 -8
  18. data/lib/google/cloud/dataplex/v1/data_quality_pb.rb +7 -1
  19. data/lib/google/cloud/dataplex/v1/data_scan_service/client.rb +115 -8
  20. data/lib/google/cloud/dataplex/v1/data_scan_service/operations.rb +13 -5
  21. data/lib/google/cloud/dataplex/v1/data_scan_service/rest/client.rb +108 -8
  22. data/lib/google/cloud/dataplex/v1/data_scan_service/rest/operations.rb +11 -4
  23. data/lib/google/cloud/dataplex/v1/data_scan_service/rest/service_stub.rb +68 -0
  24. data/lib/google/cloud/dataplex/v1/data_taxonomy_service/client.rb +33 -15
  25. data/lib/google/cloud/dataplex/v1/data_taxonomy_service/operations.rb +13 -5
  26. data/lib/google/cloud/dataplex/v1/data_taxonomy_service/rest/client.rb +33 -15
  27. data/lib/google/cloud/dataplex/v1/data_taxonomy_service/rest/operations.rb +11 -4
  28. data/lib/google/cloud/dataplex/v1/dataplex_service/client.rb +69 -33
  29. data/lib/google/cloud/dataplex/v1/dataplex_service/operations.rb +13 -5
  30. data/lib/google/cloud/dataplex/v1/dataplex_service/rest/client.rb +69 -33
  31. data/lib/google/cloud/dataplex/v1/dataplex_service/rest/operations.rb +11 -4
  32. data/lib/google/cloud/dataplex/v1/datascans_pb.rb +4 -2
  33. data/lib/google/cloud/dataplex/v1/datascans_services_pb.rb +2 -0
  34. data/lib/google/cloud/dataplex/v1/logs_pb.rb +1 -1
  35. data/lib/google/cloud/dataplex/v1/metadata_service/client.rb +21 -9
  36. data/lib/google/cloud/dataplex/v1/metadata_service/rest/client.rb +21 -9
  37. data/lib/google/cloud/dataplex/v1/rest.rb +3 -2
  38. data/lib/google/cloud/dataplex/v1/version.rb +1 -1
  39. data/lib/google/cloud/dataplex/v1.rb +4 -3
  40. data/proto_docs/google/api/client.rb +4 -0
  41. data/proto_docs/google/cloud/dataplex/v1/catalog.rb +1092 -0
  42. data/proto_docs/google/cloud/dataplex/v1/data_quality.rb +86 -0
  43. data/proto_docs/google/cloud/dataplex/v1/datascans.rb +21 -0
  44. data/proto_docs/google/cloud/dataplex/v1/logs.rb +8 -0
  45. data/proto_docs/google/protobuf/struct.rb +96 -0
  46. metadata +15 -2
@@ -0,0 +1,1092 @@
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.
394
+ # The format for the key can be one of the following:
395
+ # 1. \\{projectId}.\\{locationId}.\\{aspectTypeId} (if the aspect is attached
396
+ # directly to the entry)
397
+ # 2. \\{projectId}.\\{locationId}.\\{aspectTypeId}@\\{path} (if the aspect is
398
+ # attached to an entry's path)
399
+ # @!attribute [rw] parent_entry
400
+ # @return [::String]
401
+ # Optional. Immutable. The resource name of the parent entry.
402
+ # @!attribute [rw] fully_qualified_name
403
+ # @return [::String]
404
+ # Optional. A name for the entry that can reference it in an external system.
405
+ # The maximum size of the field is 4000 characters.
406
+ # @!attribute [rw] entry_source
407
+ # @return [::Google::Cloud::Dataplex::V1::EntrySource]
408
+ # Optional. Source system related information for an entry.
409
+ class Entry
410
+ include ::Google::Protobuf::MessageExts
411
+ extend ::Google::Protobuf::MessageExts::ClassMethods
412
+
413
+ # @!attribute [rw] key
414
+ # @return [::String]
415
+ # @!attribute [rw] value
416
+ # @return [::Google::Cloud::Dataplex::V1::Aspect]
417
+ class AspectsEntry
418
+ include ::Google::Protobuf::MessageExts
419
+ extend ::Google::Protobuf::MessageExts::ClassMethods
420
+ end
421
+ end
422
+
423
+ # EntrySource contains source system related information for the
424
+ # entry.
425
+ # @!attribute [rw] resource
426
+ # @return [::String]
427
+ # The name of the resource in the source system.
428
+ # The maximum size of the field is 4000 characters.
429
+ # @!attribute [rw] system
430
+ # @return [::String]
431
+ # The name of the source system.
432
+ # The maximum size of the field is 64 characters.
433
+ # @!attribute [rw] platform
434
+ # @return [::String]
435
+ # The platform containing the source system.
436
+ # The maximum size of the field is 64 characters.
437
+ # @!attribute [rw] display_name
438
+ # @return [::String]
439
+ # User friendly display name.
440
+ # The maximum size of the field is 500 characters.
441
+ # @!attribute [rw] description
442
+ # @return [::String]
443
+ # Description of the Entry.
444
+ # The maximum size of the field is 2000 characters.
445
+ # @!attribute [rw] labels
446
+ # @return [::Google::Protobuf::Map{::String => ::String}]
447
+ # User-defined labels.
448
+ # The maximum size of keys and values is 128 characters each.
449
+ # @!attribute [rw] ancestors
450
+ # @return [::Array<::Google::Cloud::Dataplex::V1::EntrySource::Ancestor>]
451
+ # Immutable. The ancestors of the Entry in the source system.
452
+ # @!attribute [rw] create_time
453
+ # @return [::Google::Protobuf::Timestamp]
454
+ # The create time of the resource in the source system.
455
+ # @!attribute [rw] update_time
456
+ # @return [::Google::Protobuf::Timestamp]
457
+ # The update time of the resource in the source system.
458
+ class EntrySource
459
+ include ::Google::Protobuf::MessageExts
460
+ extend ::Google::Protobuf::MessageExts::ClassMethods
461
+
462
+ # Ancestor contains information about individual items in the hierarchy of
463
+ # an Entry.
464
+ # @!attribute [rw] name
465
+ # @return [::String]
466
+ # Optional. The name of the ancestor resource.
467
+ # @!attribute [rw] type
468
+ # @return [::String]
469
+ # Optional. The type of the ancestor resource.
470
+ class Ancestor
471
+ include ::Google::Protobuf::MessageExts
472
+ extend ::Google::Protobuf::MessageExts::ClassMethods
473
+ end
474
+
475
+ # @!attribute [rw] key
476
+ # @return [::String]
477
+ # @!attribute [rw] value
478
+ # @return [::String]
479
+ class LabelsEntry
480
+ include ::Google::Protobuf::MessageExts
481
+ extend ::Google::Protobuf::MessageExts::ClassMethods
482
+ end
483
+ end
484
+
485
+ # Create EntryGroup Request
486
+ # @!attribute [rw] parent
487
+ # @return [::String]
488
+ # Required. The resource name of the entryGroup, of the form:
489
+ # projects/\\{project_number}/locations/\\{location_id}
490
+ # where `location_id` refers to a GCP region.
491
+ # @!attribute [rw] entry_group_id
492
+ # @return [::String]
493
+ # Required. EntryGroup identifier.
494
+ # @!attribute [rw] entry_group
495
+ # @return [::Google::Cloud::Dataplex::V1::EntryGroup]
496
+ # Required. EntryGroup Resource
497
+ # @!attribute [rw] validate_only
498
+ # @return [::Boolean]
499
+ # Optional. Only validate the request, but do not perform mutations.
500
+ # The default is false.
501
+ class CreateEntryGroupRequest
502
+ include ::Google::Protobuf::MessageExts
503
+ extend ::Google::Protobuf::MessageExts::ClassMethods
504
+ end
505
+
506
+ # Update EntryGroup Request
507
+ # @!attribute [rw] entry_group
508
+ # @return [::Google::Cloud::Dataplex::V1::EntryGroup]
509
+ # Required. EntryGroup Resource
510
+ # @!attribute [rw] update_mask
511
+ # @return [::Google::Protobuf::FieldMask]
512
+ # Required. Mask of fields to update.
513
+ # @!attribute [rw] validate_only
514
+ # @return [::Boolean]
515
+ # Optional. Only validate the request, but do not perform mutations.
516
+ # The default is false.
517
+ class UpdateEntryGroupRequest
518
+ include ::Google::Protobuf::MessageExts
519
+ extend ::Google::Protobuf::MessageExts::ClassMethods
520
+ end
521
+
522
+ # Delele EntryGroup Request
523
+ # @!attribute [rw] name
524
+ # @return [::String]
525
+ # Required. The resource name of the EntryGroup:
526
+ # `projects/{project_number}/locations/{location_id}/entryGroups/{entry_group_id}`.
527
+ # @!attribute [rw] etag
528
+ # @return [::String]
529
+ # Optional. If the client provided etag value does not match the current etag
530
+ # value, the DeleteEntryGroupRequest method returns an ABORTED error response
531
+ class DeleteEntryGroupRequest
532
+ include ::Google::Protobuf::MessageExts
533
+ extend ::Google::Protobuf::MessageExts::ClassMethods
534
+ end
535
+
536
+ # List entryGroups request.
537
+ # @!attribute [rw] parent
538
+ # @return [::String]
539
+ # Required. The resource name of the entryGroup location, of the form:
540
+ # `projects/{project_number}/locations/{location_id}`
541
+ # where `location_id` refers to a GCP region.
542
+ # @!attribute [rw] page_size
543
+ # @return [::Integer]
544
+ # Optional. Maximum number of EntryGroups to return. The service may return
545
+ # fewer than this value. If unspecified, at most 10 EntryGroups will be
546
+ # returned. The maximum value is 1000; values above 1000 will be coerced to
547
+ # 1000.
548
+ # @!attribute [rw] page_token
549
+ # @return [::String]
550
+ # Optional. Page token received from a previous `ListEntryGroups` call.
551
+ # Provide this to retrieve the subsequent page. When paginating, all other
552
+ # parameters provided to `ListEntryGroups` must match the call that provided
553
+ # the page token.
554
+ # @!attribute [rw] filter
555
+ # @return [::String]
556
+ # Optional. Filter request.
557
+ # @!attribute [rw] order_by
558
+ # @return [::String]
559
+ # Optional. Order by fields for the result.
560
+ class ListEntryGroupsRequest
561
+ include ::Google::Protobuf::MessageExts
562
+ extend ::Google::Protobuf::MessageExts::ClassMethods
563
+ end
564
+
565
+ # List ListEntryGroups response.
566
+ # @!attribute [rw] entry_groups
567
+ # @return [::Array<::Google::Cloud::Dataplex::V1::EntryGroup>]
568
+ # ListEntryGroups under the given parent location.
569
+ # @!attribute [rw] next_page_token
570
+ # @return [::String]
571
+ # Token to retrieve the next page of results, or empty if there are no more
572
+ # results in the list.
573
+ # @!attribute [rw] unreachable_locations
574
+ # @return [::Array<::String>]
575
+ # Locations that could not be reached.
576
+ class ListEntryGroupsResponse
577
+ include ::Google::Protobuf::MessageExts
578
+ extend ::Google::Protobuf::MessageExts::ClassMethods
579
+ end
580
+
581
+ # Get EntryGroup request.
582
+ # @!attribute [rw] name
583
+ # @return [::String]
584
+ # Required. The resource name of the EntryGroup:
585
+ # `projects/{project_number}/locations/{location_id}/entryGroups/{entry_group_id}`.
586
+ class GetEntryGroupRequest
587
+ include ::Google::Protobuf::MessageExts
588
+ extend ::Google::Protobuf::MessageExts::ClassMethods
589
+ end
590
+
591
+ # Create EntryType Request
592
+ # @!attribute [rw] parent
593
+ # @return [::String]
594
+ # Required. The resource name of the EntryType, of the form:
595
+ # projects/\\{project_number}/locations/\\{location_id}
596
+ # where `location_id` refers to a GCP region.
597
+ # @!attribute [rw] entry_type_id
598
+ # @return [::String]
599
+ # Required. EntryType identifier.
600
+ # @!attribute [rw] entry_type
601
+ # @return [::Google::Cloud::Dataplex::V1::EntryType]
602
+ # Required. EntryType Resource
603
+ # @!attribute [rw] validate_only
604
+ # @return [::Boolean]
605
+ # Optional. Only validate the request, but do not perform mutations.
606
+ # The default is false.
607
+ class CreateEntryTypeRequest
608
+ include ::Google::Protobuf::MessageExts
609
+ extend ::Google::Protobuf::MessageExts::ClassMethods
610
+ end
611
+
612
+ # Update EntryType Request
613
+ # @!attribute [rw] entry_type
614
+ # @return [::Google::Cloud::Dataplex::V1::EntryType]
615
+ # Required. EntryType Resource
616
+ # @!attribute [rw] update_mask
617
+ # @return [::Google::Protobuf::FieldMask]
618
+ # Required. Mask of fields to update.
619
+ # @!attribute [rw] validate_only
620
+ # @return [::Boolean]
621
+ # Optional. Only validate the request, but do not perform mutations.
622
+ # The default is false.
623
+ class UpdateEntryTypeRequest
624
+ include ::Google::Protobuf::MessageExts
625
+ extend ::Google::Protobuf::MessageExts::ClassMethods
626
+ end
627
+
628
+ # Delele EntryType Request
629
+ # @!attribute [rw] name
630
+ # @return [::String]
631
+ # Required. The resource name of the EntryType:
632
+ # `projects/{project_number}/locations/{location_id}/entryTypes/{entry_type_id}`.
633
+ # @!attribute [rw] etag
634
+ # @return [::String]
635
+ # Optional. If the client provided etag value does not match the current etag
636
+ # value, the DeleteEntryTypeRequest method returns an ABORTED error response
637
+ class DeleteEntryTypeRequest
638
+ include ::Google::Protobuf::MessageExts
639
+ extend ::Google::Protobuf::MessageExts::ClassMethods
640
+ end
641
+
642
+ # List EntryTypes request
643
+ # @!attribute [rw] parent
644
+ # @return [::String]
645
+ # Required. The resource name of the EntryType location, of the form:
646
+ # `projects/{project_number}/locations/{location_id}`
647
+ # where `location_id` refers to a GCP region.
648
+ # @!attribute [rw] page_size
649
+ # @return [::Integer]
650
+ # Optional. Maximum number of EntryTypes to return. The service may return
651
+ # fewer than this value. If unspecified, at most 10 EntryTypes will be
652
+ # returned. The maximum value is 1000; values above 1000 will be coerced to
653
+ # 1000.
654
+ # @!attribute [rw] page_token
655
+ # @return [::String]
656
+ # Optional. Page token received from a previous `ListEntryTypes` call.
657
+ # Provide this to retrieve the subsequent page. When paginating, all other
658
+ # parameters provided to `ListEntryTypes` must match the call that provided
659
+ # the page token.
660
+ # @!attribute [rw] filter
661
+ # @return [::String]
662
+ # Optional. Filter request. Filters are case-sensitive.
663
+ # The following formats are supported:
664
+ #
665
+ # labels.key1 = "value1"
666
+ # labels:key1
667
+ # name = "value"
668
+ # These restrictions can be coinjoined with AND, OR and NOT conjunctions.
669
+ # @!attribute [rw] order_by
670
+ # @return [::String]
671
+ # Optional. Order by fields (`name` or `create_time`) for the result.
672
+ # If not specified, the ordering is undefined.
673
+ class ListEntryTypesRequest
674
+ include ::Google::Protobuf::MessageExts
675
+ extend ::Google::Protobuf::MessageExts::ClassMethods
676
+ end
677
+
678
+ # List EntryTypes response
679
+ # @!attribute [rw] entry_types
680
+ # @return [::Array<::Google::Cloud::Dataplex::V1::EntryType>]
681
+ # ListEntryTypes under the given parent location.
682
+ # @!attribute [rw] next_page_token
683
+ # @return [::String]
684
+ # Token to retrieve the next page of results, or empty if there are no more
685
+ # results in the list.
686
+ # @!attribute [rw] unreachable_locations
687
+ # @return [::Array<::String>]
688
+ # Locations that could not be reached.
689
+ class ListEntryTypesResponse
690
+ include ::Google::Protobuf::MessageExts
691
+ extend ::Google::Protobuf::MessageExts::ClassMethods
692
+ end
693
+
694
+ # Get EntryType request
695
+ # @!attribute [rw] name
696
+ # @return [::String]
697
+ # Required. The resource name of the EntryType:
698
+ # `projects/{project_number}/locations/{location_id}/entryTypes/{entry_type_id}`.
699
+ class GetEntryTypeRequest
700
+ include ::Google::Protobuf::MessageExts
701
+ extend ::Google::Protobuf::MessageExts::ClassMethods
702
+ end
703
+
704
+ # Create AspectType Request
705
+ # @!attribute [rw] parent
706
+ # @return [::String]
707
+ # Required. The resource name of the AspectType, of the form:
708
+ # projects/\\{project_number}/locations/\\{location_id}
709
+ # where `location_id` refers to a GCP region.
710
+ # @!attribute [rw] aspect_type_id
711
+ # @return [::String]
712
+ # Required. AspectType identifier.
713
+ # @!attribute [rw] aspect_type
714
+ # @return [::Google::Cloud::Dataplex::V1::AspectType]
715
+ # Required. AspectType Resource
716
+ # @!attribute [rw] validate_only
717
+ # @return [::Boolean]
718
+ # Optional. Only validate the request, but do not perform mutations.
719
+ # The default is false.
720
+ class CreateAspectTypeRequest
721
+ include ::Google::Protobuf::MessageExts
722
+ extend ::Google::Protobuf::MessageExts::ClassMethods
723
+ end
724
+
725
+ # Update AspectType Request
726
+ # @!attribute [rw] aspect_type
727
+ # @return [::Google::Cloud::Dataplex::V1::AspectType]
728
+ # Required. AspectType Resource
729
+ # @!attribute [rw] update_mask
730
+ # @return [::Google::Protobuf::FieldMask]
731
+ # Required. Mask of fields to update.
732
+ # @!attribute [rw] validate_only
733
+ # @return [::Boolean]
734
+ # Optional. Only validate the request, but do not perform mutations.
735
+ # The default is false.
736
+ class UpdateAspectTypeRequest
737
+ include ::Google::Protobuf::MessageExts
738
+ extend ::Google::Protobuf::MessageExts::ClassMethods
739
+ end
740
+
741
+ # Delele AspectType Request
742
+ # @!attribute [rw] name
743
+ # @return [::String]
744
+ # Required. The resource name of the AspectType:
745
+ # `projects/{project_number}/locations/{location_id}/aspectTypes/{aspect_type_id}`.
746
+ # @!attribute [rw] etag
747
+ # @return [::String]
748
+ # Optional. If the client provided etag value does not match the current etag
749
+ # value, the DeleteAspectTypeRequest method returns an ABORTED error response
750
+ class DeleteAspectTypeRequest
751
+ include ::Google::Protobuf::MessageExts
752
+ extend ::Google::Protobuf::MessageExts::ClassMethods
753
+ end
754
+
755
+ # List AspectTypes request
756
+ # @!attribute [rw] parent
757
+ # @return [::String]
758
+ # Required. The resource name of the AspectType location, of the form:
759
+ # `projects/{project_number}/locations/{location_id}`
760
+ # where `location_id` refers to a GCP region.
761
+ # @!attribute [rw] page_size
762
+ # @return [::Integer]
763
+ # Optional. Maximum number of AspectTypes to return. The service may return
764
+ # fewer than this value. If unspecified, at most 10 AspectTypes will be
765
+ # returned. The maximum value is 1000; values above 1000 will be coerced to
766
+ # 1000.
767
+ # @!attribute [rw] page_token
768
+ # @return [::String]
769
+ # Optional. Page token received from a previous `ListAspectTypes` call.
770
+ # Provide this to retrieve the subsequent page. When paginating, all other
771
+ # parameters provided to `ListAspectTypes` must match the call that provided
772
+ # the page token.
773
+ # @!attribute [rw] filter
774
+ # @return [::String]
775
+ # Optional. Filter request. Filters are case-sensitive.
776
+ # The following formats are supported:
777
+ #
778
+ # labels.key1 = "value1"
779
+ # labels:key1
780
+ # name = "value"
781
+ # These restrictions can be coinjoined with AND, OR and NOT conjunctions.
782
+ # @!attribute [rw] order_by
783
+ # @return [::String]
784
+ # Optional. Order by fields (`name` or `create_time`) for the result.
785
+ # If not specified, the ordering is undefined.
786
+ class ListAspectTypesRequest
787
+ include ::Google::Protobuf::MessageExts
788
+ extend ::Google::Protobuf::MessageExts::ClassMethods
789
+ end
790
+
791
+ # List AspectTypes response
792
+ # @!attribute [rw] aspect_types
793
+ # @return [::Array<::Google::Cloud::Dataplex::V1::AspectType>]
794
+ # ListAspectTypes under the given parent location.
795
+ # @!attribute [rw] next_page_token
796
+ # @return [::String]
797
+ # Token to retrieve the next page of results, or empty if there are no more
798
+ # results in the list.
799
+ # @!attribute [rw] unreachable_locations
800
+ # @return [::Array<::String>]
801
+ # Locations that could not be reached.
802
+ class ListAspectTypesResponse
803
+ include ::Google::Protobuf::MessageExts
804
+ extend ::Google::Protobuf::MessageExts::ClassMethods
805
+ end
806
+
807
+ # Get AspectType request
808
+ # @!attribute [rw] name
809
+ # @return [::String]
810
+ # Required. The resource name of the AspectType:
811
+ # `projects/{project_number}/locations/{location_id}/aspectTypes/{aspect_type_id}`.
812
+ class GetAspectTypeRequest
813
+ include ::Google::Protobuf::MessageExts
814
+ extend ::Google::Protobuf::MessageExts::ClassMethods
815
+ end
816
+
817
+ # @!attribute [rw] parent
818
+ # @return [::String]
819
+ # Required. The resource name of the parent Entry Group:
820
+ # `projects/{project}/locations/{location}/entryGroups/{entry_group}`.
821
+ # @!attribute [rw] entry_id
822
+ # @return [::String]
823
+ # Required. Entry identifier. It has to be unique within an Entry Group.
824
+ #
825
+ # Entries corresponding to Google Cloud resources use Entry ID format based
826
+ # on Full Resource Names
827
+ # (https://cloud.google.com/apis/design/resource_names#full_resource_name).
828
+ # The format is a Full Resource Name of the resource without the
829
+ # prefix double slashes in the API Service Name part of Full Resource Name.
830
+ # This allows retrieval of entries using their associated resource name.
831
+ #
832
+ # For example if the Full Resource Name of a resource is
833
+ # `//library.googleapis.com/shelves/shelf1/books/book2`,
834
+ # then the suggested entry_id is
835
+ # `library.googleapis.com/shelves/shelf1/books/book2`.
836
+ #
837
+ # It is also suggested to follow the same convention for entries
838
+ # corresponding to resources from other providers or systems than Google
839
+ # Cloud.
840
+ #
841
+ # The maximum size of the field is 4000 characters.
842
+ # @!attribute [rw] entry
843
+ # @return [::Google::Cloud::Dataplex::V1::Entry]
844
+ # Required. Entry resource.
845
+ class CreateEntryRequest
846
+ include ::Google::Protobuf::MessageExts
847
+ extend ::Google::Protobuf::MessageExts::ClassMethods
848
+ end
849
+
850
+ # @!attribute [rw] entry
851
+ # @return [::Google::Cloud::Dataplex::V1::Entry]
852
+ # Required. Entry resource.
853
+ # @!attribute [rw] update_mask
854
+ # @return [::Google::Protobuf::FieldMask]
855
+ # Optional. Mask of fields to update. To update Aspects, the update_mask must
856
+ # contain the value "aspects".
857
+ #
858
+ # If the update_mask is empty, all modifiable fields present in the request
859
+ # will be updated.
860
+ # @!attribute [rw] allow_missing
861
+ # @return [::Boolean]
862
+ # Optional. If set to true and the entry does not exist, it will be created.
863
+ # @!attribute [rw] delete_missing_aspects
864
+ # @return [::Boolean]
865
+ # Optional. If set to true and the aspect_keys specify aspect ranges, any
866
+ # existing aspects from that range not provided in the request will be
867
+ # deleted.
868
+ # @!attribute [rw] aspect_keys
869
+ # @return [::Array<::String>]
870
+ # Optional. The map keys of the Aspects which should be modified. Supports
871
+ # the following syntaxes:
872
+ # * <aspect_type_reference> - matches aspect on given type and empty path
873
+ # * <aspect_type_reference>@path - matches aspect on given type and specified
874
+ # path
875
+ # * <aspect_type_reference>* - matches aspects on given type for all paths
876
+ # * *@path - matches aspects of all types on the given path
877
+ #
878
+ # Existing aspects matching the syntax will not be removed unless
879
+ # `delete_missing_aspects` is set to true.
880
+ #
881
+ # If this field is left empty, it will be treated as specifying exactly those
882
+ # Aspects present in the request.
883
+ class UpdateEntryRequest
884
+ include ::Google::Protobuf::MessageExts
885
+ extend ::Google::Protobuf::MessageExts::ClassMethods
886
+ end
887
+
888
+ # @!attribute [rw] name
889
+ # @return [::String]
890
+ # Required. The resource name of the Entry:
891
+ # `projects/{project}/locations/{location}/entryGroups/{entry_group}/entries/{entry}`.
892
+ class DeleteEntryRequest
893
+ include ::Google::Protobuf::MessageExts
894
+ extend ::Google::Protobuf::MessageExts::ClassMethods
895
+ end
896
+
897
+ # @!attribute [rw] parent
898
+ # @return [::String]
899
+ # Required. The resource name of the parent Entry Group:
900
+ # `projects/{project}/locations/{location}/entryGroups/{entry_group}`.
901
+ # @!attribute [rw] page_size
902
+ # @return [::Integer]
903
+ # @!attribute [rw] page_token
904
+ # @return [::String]
905
+ # Optional. The pagination token returned by a previous request.
906
+ # @!attribute [rw] filter
907
+ # @return [::String]
908
+ # Optional. A filter on the entries to return.
909
+ # Filters are case-sensitive.
910
+ # The request can be filtered by the following fields:
911
+ # entry_type, entry_source.display_name.
912
+ # The comparison operators are =, !=, <, >, <=, >= (strings are compared
913
+ # according to lexical order)
914
+ # The logical operators AND, OR, NOT can be used
915
+ # in the filter. Wildcard "*" can be used, but for entry_type the full
916
+ # project id or number needs to be provided. Example filter expressions:
917
+ # "entry_source.display_name=AnExampleDisplayName"
918
+ # "entry_type=projects/example-project/locations/global/entryTypes/example-entry_type"
919
+ # "entry_type=projects/example-project/locations/us/entryTypes/a* OR
920
+ # entry_type=projects/another-project/locations/*"
921
+ # "NOT entry_source.display_name=AnotherExampleDisplayName"
922
+ class ListEntriesRequest
923
+ include ::Google::Protobuf::MessageExts
924
+ extend ::Google::Protobuf::MessageExts::ClassMethods
925
+ end
926
+
927
+ # @!attribute [rw] entries
928
+ # @return [::Array<::Google::Cloud::Dataplex::V1::Entry>]
929
+ # The list of entries.
930
+ # @!attribute [rw] next_page_token
931
+ # @return [::String]
932
+ # Pagination token.
933
+ class ListEntriesResponse
934
+ include ::Google::Protobuf::MessageExts
935
+ extend ::Google::Protobuf::MessageExts::ClassMethods
936
+ end
937
+
938
+ # @!attribute [rw] name
939
+ # @return [::String]
940
+ # Required. The resource name of the Entry:
941
+ # `projects/{project}/locations/{location}/entryGroups/{entry_group}/entries/{entry}`.
942
+ # @!attribute [rw] view
943
+ # @return [::Google::Cloud::Dataplex::V1::EntryView]
944
+ # Optional. View for controlling which parts of an entry are to be returned.
945
+ # @!attribute [rw] aspect_types
946
+ # @return [::Array<::String>]
947
+ # Optional. Limits the aspects returned to the provided aspect types.
948
+ # Only works if the CUSTOM view is selected.
949
+ # @!attribute [rw] paths
950
+ # @return [::Array<::String>]
951
+ # Optional. Limits the aspects returned to those associated with the provided
952
+ # paths within the Entry. Only works if the CUSTOM view is selected.
953
+ class GetEntryRequest
954
+ include ::Google::Protobuf::MessageExts
955
+ extend ::Google::Protobuf::MessageExts::ClassMethods
956
+ end
957
+
958
+ # @!attribute [rw] name
959
+ # @return [::String]
960
+ # Required. The project to which the request should be attributed in the
961
+ # following form: `projects/{project}/locations/{location}`.
962
+ # @!attribute [rw] view
963
+ # @return [::Google::Cloud::Dataplex::V1::EntryView]
964
+ # Optional. View for controlling which parts of an entry are to be returned.
965
+ # @!attribute [rw] aspect_types
966
+ # @return [::Array<::String>]
967
+ # Optional. Limits the aspects returned to the provided aspect types.
968
+ # Only works if the CUSTOM view is selected.
969
+ # @!attribute [rw] paths
970
+ # @return [::Array<::String>]
971
+ # Optional. Limits the aspects returned to those associated with the provided
972
+ # paths within the Entry. Only works if the CUSTOM view is selected.
973
+ # @!attribute [rw] entry
974
+ # @return [::String]
975
+ # Required. The resource name of the Entry:
976
+ # `projects/{project}/locations/{location}/entryGroups/{entry_group}/entries/{entry}`.
977
+ class LookupEntryRequest
978
+ include ::Google::Protobuf::MessageExts
979
+ extend ::Google::Protobuf::MessageExts::ClassMethods
980
+ end
981
+
982
+ # @!attribute [rw] name
983
+ # @return [::String]
984
+ # Required. The project to which the request should be attributed in the
985
+ # following form: `projects/{project}/locations/{location}`.
986
+ # @!attribute [rw] query
987
+ # @return [::String]
988
+ # Required. The query against which entries in scope should be matched.
989
+ # @!attribute [rw] page_size
990
+ # @return [::Integer]
991
+ # Optional. Pagination.
992
+ # @!attribute [rw] page_token
993
+ # @return [::String]
994
+ # @!attribute [rw] order_by
995
+ # @return [::String]
996
+ # Optional. Ordering of the results. Supported options to be added later.
997
+ # @!attribute [rw] scope
998
+ # @return [::String]
999
+ # Optional. The scope under which the search should be operating. Should
1000
+ # either be organizations/<org_id> or projects/<project_ref>. If left
1001
+ # unspecified, it will default to the organization where the project provided
1002
+ # in `name` is located.
1003
+ class SearchEntriesRequest
1004
+ include ::Google::Protobuf::MessageExts
1005
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1006
+ end
1007
+
1008
+ # A single result of a SearchEntries request.
1009
+ # @!attribute [rw] linked_resource
1010
+ # @return [::String]
1011
+ # Linked resource name.
1012
+ # @!attribute [rw] dataplex_entry
1013
+ # @return [::Google::Cloud::Dataplex::V1::Entry]
1014
+ # Entry format of the result.
1015
+ # @!attribute [rw] snippets
1016
+ # @return [::Google::Cloud::Dataplex::V1::SearchEntriesResult::Snippets]
1017
+ # Snippets.
1018
+ class SearchEntriesResult
1019
+ include ::Google::Protobuf::MessageExts
1020
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1021
+
1022
+ # Snippets for the entry, contains HTML-style highlighting for
1023
+ # matched tokens, will be used in UI.
1024
+ # @!attribute [rw] dataplex_entry
1025
+ # @return [::Google::Cloud::Dataplex::V1::Entry]
1026
+ # Entry
1027
+ class Snippets
1028
+ include ::Google::Protobuf::MessageExts
1029
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1030
+ end
1031
+ end
1032
+
1033
+ # @!attribute [rw] results
1034
+ # @return [::Array<::Google::Cloud::Dataplex::V1::SearchEntriesResult>]
1035
+ # The results matching the search query.
1036
+ # @!attribute [rw] total_size
1037
+ # @return [::Integer]
1038
+ # The estimated total number of matching entries. Not guaranteed to be
1039
+ # accurate.
1040
+ # @!attribute [rw] next_page_token
1041
+ # @return [::String]
1042
+ # Pagination token.
1043
+ # @!attribute [rw] unreachable
1044
+ # @return [::Array<::String>]
1045
+ # Unreachable locations. Search results don't include data from those
1046
+ # locations.
1047
+ class SearchEntriesResponse
1048
+ include ::Google::Protobuf::MessageExts
1049
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1050
+ end
1051
+
1052
+ # View for controlling which parts of an entry are to be returned.
1053
+ module EntryView
1054
+ # Unspecified EntryView. Defaults to FULL.
1055
+ ENTRY_VIEW_UNSPECIFIED = 0
1056
+
1057
+ # Returns entry only, without aspects.
1058
+ BASIC = 1
1059
+
1060
+ # Returns all required aspects as well as the keys of all non-required
1061
+ # aspects.
1062
+ FULL = 2
1063
+
1064
+ # Returns aspects matching custom fields in GetEntryRequest. If the number of
1065
+ # aspects would exceed 100, the first 100 will be returned.
1066
+ CUSTOM = 3
1067
+
1068
+ # Returns all aspects. If the number of aspects would exceed 100, the first
1069
+ # 100 will be returned.
1070
+ ALL = 4
1071
+ end
1072
+
1073
+ # Denotes the transfer status of a resource. It is unspecified for resources
1074
+ # created from Dataplex API.
1075
+ module TransferStatus
1076
+ # The default value. It is set for resources that were not subject for
1077
+ # migration from Data Catalog service.
1078
+ TRANSFER_STATUS_UNSPECIFIED = 0
1079
+
1080
+ # Indicates that a resource was migrated from Data Catalog service but it
1081
+ # hasn't been transferred yet. In particular the resource cannot be updated
1082
+ # from Dataplex API.
1083
+ TRANSFER_STATUS_MIGRATED = 1
1084
+
1085
+ # Indicates that a resource was transferred from Data Catalog service. The
1086
+ # resource can only be updated from Dataplex API.
1087
+ TRANSFER_STATUS_TRANSFERRED = 2
1088
+ end
1089
+ end
1090
+ end
1091
+ end
1092
+ end