1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
|
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="dataplex_v1.html">Cloud Dataplex API</a> . <a href="dataplex_v1.projects.html">projects</a> . <a href="dataplex_v1.projects.locations.html">locations</a> . <a href="dataplex_v1.projects.locations.entryGroups.html">entryGroups</a> . <a href="dataplex_v1.projects.locations.entryGroups.entries.html">entries</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
<code><a href="#create">create(parent, body=None, entryId=None, x__xgafv=None)</a></code></p>
<p class="firstline">Creates an Entry.</p>
<p class="toc_element">
<code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
<p class="firstline">Deletes an Entry.</p>
<p class="toc_element">
<code><a href="#get">get(name, aspectTypes=None, paths=None, view=None, x__xgafv=None)</a></code></p>
<p class="firstline">Gets an Entry.</p>
<p class="toc_element">
<code><a href="#list">list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists Entries within an EntryGroup.</p>
<p class="toc_element">
<code><a href="#list_next">list_next()</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
<code><a href="#patch">patch(name, allowMissing=None, aspectKeys=None, body=None, deleteMissingAspects=None, updateMask=None, x__xgafv=None)</a></code></p>
<p class="firstline">Updates an Entry.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="close">close()</code>
<pre>Close httplib2 connections.</pre>
</div>
<div class="method">
<code class="details" id="create">create(parent, body=None, entryId=None, x__xgafv=None)</code>
<pre>Creates an Entry.
Args:
parent: string, Required. The resource name of the parent Entry Group: projects/{project}/locations/{location}/entryGroups/{entry_group}. (required)
body: object, The request body.
The object takes the form of:
{ # An entry is a representation of a data resource that can be described by various metadata.
"aspects": { # Optional. The aspects that are attached to the entry. Depending on how the aspect is attached to the entry, the format of the aspect key can be one of the following: If the aspect is attached directly to the entry: {project_id_or_number}.{location_id}.{aspect_type_id} If the aspect is attached to an entry's path: {project_id_or_number}.{location_id}.{aspect_type_id}@{path}
"a_key": { # An aspect is a single piece of metadata describing an entry.
"aspectSource": { # Information related to the source system of the aspect. # Optional. Information related to the source system of the aspect.
"createTime": "A String", # The time the aspect was created in the source system.
"dataVersion": "A String", # The version of the data format used to produce this data. This field is used to indicated when the underlying data format changes (e.g., schema modifications, changes to the source URL format definition, etc).
"updateTime": "A String", # The time the aspect was last updated in the source system.
},
"aspectType": "A String", # Output only. The resource name of the type used to create this Aspect.
"createTime": "A String", # Output only. The time when the Aspect was created.
"data": { # Required. The content of the aspect, according to its aspect type schema. The maximum size of the field is 120KB (encoded as UTF-8).
"a_key": "", # Properties of the object.
},
"path": "A String", # Output only. The path in the entry under which the aspect is attached.
"updateTime": "A String", # Output only. The time when the Aspect was last updated.
},
},
"createTime": "A String", # Output only. The time when the entry was created in Dataplex Universal Catalog.
"entrySource": { # Information related to the source system of the data resource that is represented by the entry. # Optional. Information related to the source system of the data resource that is represented by the entry.
"ancestors": [ # Immutable. The entries representing the ancestors of the data resource in the source system.
{ # Information about individual items in the hierarchy that is associated with the data resource.
"name": "A String", # Optional. The name of the ancestor resource.
"type": "A String", # Optional. The type of the ancestor resource.
},
],
"createTime": "A String", # The time when the resource was created in the source system.
"description": "A String", # A description of the data resource. Maximum length is 2,000 characters.
"displayName": "A String", # A user-friendly display name. Maximum length is 500 characters.
"labels": { # User-defined labels. The maximum size of keys and values is 128 characters each.
"a_key": "A String",
},
"location": "A String", # Output only. Location of the resource in the source system. You can search the entry by this location. By default, this should match the location of the entry group containing this entry. A different value allows capturing the source location for data external to Google Cloud.
"platform": "A String", # The platform containing the source system. Maximum length is 64 characters.
"resource": "A String", # The name of the resource in the source system. Maximum length is 4,000 characters.
"system": "A String", # The name of the source system. Maximum length is 64 characters.
"updateTime": "A String", # The time when the resource was last updated in the source system. If the entry exists in the system and its EntrySource has update_time populated, further updates to the EntrySource of the entry must provide incremental updates to its update_time.
},
"entryType": "A String", # Required. Immutable. The relative resource name of the entry type that was used to create this entry, in the format projects/{project_id_or_number}/locations/{location_id}/entryTypes/{entry_type_id}.
"fullyQualifiedName": "A String", # Optional. A name for the entry that can be referenced by an external system. For more information, see Fully qualified names (https://cloud.google.com/data-catalog/docs/fully-qualified-names). The maximum size of the field is 4000 characters.
"name": "A String", # Identifier. The relative resource name of the entry, in the format projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id}.
"parentEntry": "A String", # Optional. Immutable. The resource name of the parent entry, in the format projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id}.
"updateTime": "A String", # Output only. The time when the entry was last updated in Dataplex Universal Catalog.
}
entryId: string, Required. Entry identifier. It has to be unique within an Entry Group.Entries corresponding to Google Cloud resources use an Entry ID format based on full resource names (https://cloud.google.com/apis/design/resource_names#full_resource_name). The format is a full resource name of the resource without the prefix double slashes in the API service name part of the full resource name. This allows retrieval of entries using their associated resource name.For example, if the full resource name of a resource is //library.googleapis.com/shelves/shelf1/books/book2, then the suggested entry_id is library.googleapis.com/shelves/shelf1/books/book2.It is also suggested to follow the same convention for entries corresponding to resources from providers or systems other than Google Cloud.The maximum size of the field is 4000 characters.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # An entry is a representation of a data resource that can be described by various metadata.
"aspects": { # Optional. The aspects that are attached to the entry. Depending on how the aspect is attached to the entry, the format of the aspect key can be one of the following: If the aspect is attached directly to the entry: {project_id_or_number}.{location_id}.{aspect_type_id} If the aspect is attached to an entry's path: {project_id_or_number}.{location_id}.{aspect_type_id}@{path}
"a_key": { # An aspect is a single piece of metadata describing an entry.
"aspectSource": { # Information related to the source system of the aspect. # Optional. Information related to the source system of the aspect.
"createTime": "A String", # The time the aspect was created in the source system.
"dataVersion": "A String", # The version of the data format used to produce this data. This field is used to indicated when the underlying data format changes (e.g., schema modifications, changes to the source URL format definition, etc).
"updateTime": "A String", # The time the aspect was last updated in the source system.
},
"aspectType": "A String", # Output only. The resource name of the type used to create this Aspect.
"createTime": "A String", # Output only. The time when the Aspect was created.
"data": { # Required. The content of the aspect, according to its aspect type schema. The maximum size of the field is 120KB (encoded as UTF-8).
"a_key": "", # Properties of the object.
},
"path": "A String", # Output only. The path in the entry under which the aspect is attached.
"updateTime": "A String", # Output only. The time when the Aspect was last updated.
},
},
"createTime": "A String", # Output only. The time when the entry was created in Dataplex Universal Catalog.
"entrySource": { # Information related to the source system of the data resource that is represented by the entry. # Optional. Information related to the source system of the data resource that is represented by the entry.
"ancestors": [ # Immutable. The entries representing the ancestors of the data resource in the source system.
{ # Information about individual items in the hierarchy that is associated with the data resource.
"name": "A String", # Optional. The name of the ancestor resource.
"type": "A String", # Optional. The type of the ancestor resource.
},
],
"createTime": "A String", # The time when the resource was created in the source system.
"description": "A String", # A description of the data resource. Maximum length is 2,000 characters.
"displayName": "A String", # A user-friendly display name. Maximum length is 500 characters.
"labels": { # User-defined labels. The maximum size of keys and values is 128 characters each.
"a_key": "A String",
},
"location": "A String", # Output only. Location of the resource in the source system. You can search the entry by this location. By default, this should match the location of the entry group containing this entry. A different value allows capturing the source location for data external to Google Cloud.
"platform": "A String", # The platform containing the source system. Maximum length is 64 characters.
"resource": "A String", # The name of the resource in the source system. Maximum length is 4,000 characters.
"system": "A String", # The name of the source system. Maximum length is 64 characters.
"updateTime": "A String", # The time when the resource was last updated in the source system. If the entry exists in the system and its EntrySource has update_time populated, further updates to the EntrySource of the entry must provide incremental updates to its update_time.
},
"entryType": "A String", # Required. Immutable. The relative resource name of the entry type that was used to create this entry, in the format projects/{project_id_or_number}/locations/{location_id}/entryTypes/{entry_type_id}.
"fullyQualifiedName": "A String", # Optional. A name for the entry that can be referenced by an external system. For more information, see Fully qualified names (https://cloud.google.com/data-catalog/docs/fully-qualified-names). The maximum size of the field is 4000 characters.
"name": "A String", # Identifier. The relative resource name of the entry, in the format projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id}.
"parentEntry": "A String", # Optional. Immutable. The resource name of the parent entry, in the format projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id}.
"updateTime": "A String", # Output only. The time when the entry was last updated in Dataplex Universal Catalog.
}</pre>
</div>
<div class="method">
<code class="details" id="delete">delete(name, x__xgafv=None)</code>
<pre>Deletes an Entry.
Args:
name: string, Required. The resource name of the Entry: projects/{project}/locations/{location}/entryGroups/{entry_group}/entries/{entry}. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # An entry is a representation of a data resource that can be described by various metadata.
"aspects": { # Optional. The aspects that are attached to the entry. Depending on how the aspect is attached to the entry, the format of the aspect key can be one of the following: If the aspect is attached directly to the entry: {project_id_or_number}.{location_id}.{aspect_type_id} If the aspect is attached to an entry's path: {project_id_or_number}.{location_id}.{aspect_type_id}@{path}
"a_key": { # An aspect is a single piece of metadata describing an entry.
"aspectSource": { # Information related to the source system of the aspect. # Optional. Information related to the source system of the aspect.
"createTime": "A String", # The time the aspect was created in the source system.
"dataVersion": "A String", # The version of the data format used to produce this data. This field is used to indicated when the underlying data format changes (e.g., schema modifications, changes to the source URL format definition, etc).
"updateTime": "A String", # The time the aspect was last updated in the source system.
},
"aspectType": "A String", # Output only. The resource name of the type used to create this Aspect.
"createTime": "A String", # Output only. The time when the Aspect was created.
"data": { # Required. The content of the aspect, according to its aspect type schema. The maximum size of the field is 120KB (encoded as UTF-8).
"a_key": "", # Properties of the object.
},
"path": "A String", # Output only. The path in the entry under which the aspect is attached.
"updateTime": "A String", # Output only. The time when the Aspect was last updated.
},
},
"createTime": "A String", # Output only. The time when the entry was created in Dataplex Universal Catalog.
"entrySource": { # Information related to the source system of the data resource that is represented by the entry. # Optional. Information related to the source system of the data resource that is represented by the entry.
"ancestors": [ # Immutable. The entries representing the ancestors of the data resource in the source system.
{ # Information about individual items in the hierarchy that is associated with the data resource.
"name": "A String", # Optional. The name of the ancestor resource.
"type": "A String", # Optional. The type of the ancestor resource.
},
],
"createTime": "A String", # The time when the resource was created in the source system.
"description": "A String", # A description of the data resource. Maximum length is 2,000 characters.
"displayName": "A String", # A user-friendly display name. Maximum length is 500 characters.
"labels": { # User-defined labels. The maximum size of keys and values is 128 characters each.
"a_key": "A String",
},
"location": "A String", # Output only. Location of the resource in the source system. You can search the entry by this location. By default, this should match the location of the entry group containing this entry. A different value allows capturing the source location for data external to Google Cloud.
"platform": "A String", # The platform containing the source system. Maximum length is 64 characters.
"resource": "A String", # The name of the resource in the source system. Maximum length is 4,000 characters.
"system": "A String", # The name of the source system. Maximum length is 64 characters.
"updateTime": "A String", # The time when the resource was last updated in the source system. If the entry exists in the system and its EntrySource has update_time populated, further updates to the EntrySource of the entry must provide incremental updates to its update_time.
},
"entryType": "A String", # Required. Immutable. The relative resource name of the entry type that was used to create this entry, in the format projects/{project_id_or_number}/locations/{location_id}/entryTypes/{entry_type_id}.
"fullyQualifiedName": "A String", # Optional. A name for the entry that can be referenced by an external system. For more information, see Fully qualified names (https://cloud.google.com/data-catalog/docs/fully-qualified-names). The maximum size of the field is 4000 characters.
"name": "A String", # Identifier. The relative resource name of the entry, in the format projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id}.
"parentEntry": "A String", # Optional. Immutable. The resource name of the parent entry, in the format projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id}.
"updateTime": "A String", # Output only. The time when the entry was last updated in Dataplex Universal Catalog.
}</pre>
</div>
<div class="method">
<code class="details" id="get">get(name, aspectTypes=None, paths=None, view=None, x__xgafv=None)</code>
<pre>Gets an Entry.
Args:
name: string, Required. The resource name of the Entry: projects/{project}/locations/{location}/entryGroups/{entry_group}/entries/{entry}. (required)
aspectTypes: string, Optional. Limits the aspects returned to the provided aspect types. It only works for CUSTOM view. (repeated)
paths: string, Optional. Limits the aspects returned to those associated with the provided paths within the Entry. It only works for CUSTOM view. (repeated)
view: string, Optional. View to control which parts of an entry the service should return.
Allowed values
ENTRY_VIEW_UNSPECIFIED - Unspecified EntryView. Defaults to FULL.
BASIC - Returns entry only, without aspects.
FULL - Returns all required aspects as well as the keys of all non-required aspects.
CUSTOM - Returns aspects matching custom fields in GetEntryRequest. If the number of aspects exceeds 100, the first 100 will be returned.
ALL - Returns all aspects. If the number of aspects exceeds 100, the first 100 will be returned.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # An entry is a representation of a data resource that can be described by various metadata.
"aspects": { # Optional. The aspects that are attached to the entry. Depending on how the aspect is attached to the entry, the format of the aspect key can be one of the following: If the aspect is attached directly to the entry: {project_id_or_number}.{location_id}.{aspect_type_id} If the aspect is attached to an entry's path: {project_id_or_number}.{location_id}.{aspect_type_id}@{path}
"a_key": { # An aspect is a single piece of metadata describing an entry.
"aspectSource": { # Information related to the source system of the aspect. # Optional. Information related to the source system of the aspect.
"createTime": "A String", # The time the aspect was created in the source system.
"dataVersion": "A String", # The version of the data format used to produce this data. This field is used to indicated when the underlying data format changes (e.g., schema modifications, changes to the source URL format definition, etc).
"updateTime": "A String", # The time the aspect was last updated in the source system.
},
"aspectType": "A String", # Output only. The resource name of the type used to create this Aspect.
"createTime": "A String", # Output only. The time when the Aspect was created.
"data": { # Required. The content of the aspect, according to its aspect type schema. The maximum size of the field is 120KB (encoded as UTF-8).
"a_key": "", # Properties of the object.
},
"path": "A String", # Output only. The path in the entry under which the aspect is attached.
"updateTime": "A String", # Output only. The time when the Aspect was last updated.
},
},
"createTime": "A String", # Output only. The time when the entry was created in Dataplex Universal Catalog.
"entrySource": { # Information related to the source system of the data resource that is represented by the entry. # Optional. Information related to the source system of the data resource that is represented by the entry.
"ancestors": [ # Immutable. The entries representing the ancestors of the data resource in the source system.
{ # Information about individual items in the hierarchy that is associated with the data resource.
"name": "A String", # Optional. The name of the ancestor resource.
"type": "A String", # Optional. The type of the ancestor resource.
},
],
"createTime": "A String", # The time when the resource was created in the source system.
"description": "A String", # A description of the data resource. Maximum length is 2,000 characters.
"displayName": "A String", # A user-friendly display name. Maximum length is 500 characters.
"labels": { # User-defined labels. The maximum size of keys and values is 128 characters each.
"a_key": "A String",
},
"location": "A String", # Output only. Location of the resource in the source system. You can search the entry by this location. By default, this should match the location of the entry group containing this entry. A different value allows capturing the source location for data external to Google Cloud.
"platform": "A String", # The platform containing the source system. Maximum length is 64 characters.
"resource": "A String", # The name of the resource in the source system. Maximum length is 4,000 characters.
"system": "A String", # The name of the source system. Maximum length is 64 characters.
"updateTime": "A String", # The time when the resource was last updated in the source system. If the entry exists in the system and its EntrySource has update_time populated, further updates to the EntrySource of the entry must provide incremental updates to its update_time.
},
"entryType": "A String", # Required. Immutable. The relative resource name of the entry type that was used to create this entry, in the format projects/{project_id_or_number}/locations/{location_id}/entryTypes/{entry_type_id}.
"fullyQualifiedName": "A String", # Optional. A name for the entry that can be referenced by an external system. For more information, see Fully qualified names (https://cloud.google.com/data-catalog/docs/fully-qualified-names). The maximum size of the field is 4000 characters.
"name": "A String", # Identifier. The relative resource name of the entry, in the format projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id}.
"parentEntry": "A String", # Optional. Immutable. The resource name of the parent entry, in the format projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id}.
"updateTime": "A String", # Output only. The time when the entry was last updated in Dataplex Universal Catalog.
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
<pre>Lists Entries within an EntryGroup.
Args:
parent: string, Required. The resource name of the parent Entry Group: projects/{project}/locations/{location}/entryGroups/{entry_group}. (required)
filter: string, Optional. A filter on the entries to return. Filters are case-sensitive. You can filter the request by the following fields: entry_type entry_source.display_nameThe comparison operators are =, !=, <, >, <=, >=. The service compares strings according to lexical order.You can use the logical operators AND, OR, NOT in the filter.You can use Wildcard "*", but for entry_type you need to provide the full project id or number.Example filter expressions: "entry_source.display_name=AnExampleDisplayName" "entry_type=projects/example-project/locations/global/entryTypes/example-entry_type" "entry_type=projects/example-project/locations/us/entryTypes/a* OR entry_type=projects/another-project/locations/*" "NOT entry_source.display_name=AnotherExampleDisplayName"
pageSize: integer, Optional. Number of items to return per page. If there are remaining results, the service returns a next_page_token. If unspecified, the service returns at most 10 Entries. The maximum value is 100; values above 100 will be coerced to 100.
pageToken: string, Optional. Page token received from a previous ListEntries call. Provide this to retrieve the subsequent page.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # List Entries response.
"entries": [ # The list of entries under the given parent location.
{ # An entry is a representation of a data resource that can be described by various metadata.
"aspects": { # Optional. The aspects that are attached to the entry. Depending on how the aspect is attached to the entry, the format of the aspect key can be one of the following: If the aspect is attached directly to the entry: {project_id_or_number}.{location_id}.{aspect_type_id} If the aspect is attached to an entry's path: {project_id_or_number}.{location_id}.{aspect_type_id}@{path}
"a_key": { # An aspect is a single piece of metadata describing an entry.
"aspectSource": { # Information related to the source system of the aspect. # Optional. Information related to the source system of the aspect.
"createTime": "A String", # The time the aspect was created in the source system.
"dataVersion": "A String", # The version of the data format used to produce this data. This field is used to indicated when the underlying data format changes (e.g., schema modifications, changes to the source URL format definition, etc).
"updateTime": "A String", # The time the aspect was last updated in the source system.
},
"aspectType": "A String", # Output only. The resource name of the type used to create this Aspect.
"createTime": "A String", # Output only. The time when the Aspect was created.
"data": { # Required. The content of the aspect, according to its aspect type schema. The maximum size of the field is 120KB (encoded as UTF-8).
"a_key": "", # Properties of the object.
},
"path": "A String", # Output only. The path in the entry under which the aspect is attached.
"updateTime": "A String", # Output only. The time when the Aspect was last updated.
},
},
"createTime": "A String", # Output only. The time when the entry was created in Dataplex Universal Catalog.
"entrySource": { # Information related to the source system of the data resource that is represented by the entry. # Optional. Information related to the source system of the data resource that is represented by the entry.
"ancestors": [ # Immutable. The entries representing the ancestors of the data resource in the source system.
{ # Information about individual items in the hierarchy that is associated with the data resource.
"name": "A String", # Optional. The name of the ancestor resource.
"type": "A String", # Optional. The type of the ancestor resource.
},
],
"createTime": "A String", # The time when the resource was created in the source system.
"description": "A String", # A description of the data resource. Maximum length is 2,000 characters.
"displayName": "A String", # A user-friendly display name. Maximum length is 500 characters.
"labels": { # User-defined labels. The maximum size of keys and values is 128 characters each.
"a_key": "A String",
},
"location": "A String", # Output only. Location of the resource in the source system. You can search the entry by this location. By default, this should match the location of the entry group containing this entry. A different value allows capturing the source location for data external to Google Cloud.
"platform": "A String", # The platform containing the source system. Maximum length is 64 characters.
"resource": "A String", # The name of the resource in the source system. Maximum length is 4,000 characters.
"system": "A String", # The name of the source system. Maximum length is 64 characters.
"updateTime": "A String", # The time when the resource was last updated in the source system. If the entry exists in the system and its EntrySource has update_time populated, further updates to the EntrySource of the entry must provide incremental updates to its update_time.
},
"entryType": "A String", # Required. Immutable. The relative resource name of the entry type that was used to create this entry, in the format projects/{project_id_or_number}/locations/{location_id}/entryTypes/{entry_type_id}.
"fullyQualifiedName": "A String", # Optional. A name for the entry that can be referenced by an external system. For more information, see Fully qualified names (https://cloud.google.com/data-catalog/docs/fully-qualified-names). The maximum size of the field is 4000 characters.
"name": "A String", # Identifier. The relative resource name of the entry, in the format projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id}.
"parentEntry": "A String", # Optional. Immutable. The resource name of the parent entry, in the format projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id}.
"updateTime": "A String", # Output only. The time when the entry was last updated in Dataplex Universal Catalog.
},
],
"nextPageToken": "A String", # Token to retrieve the next page of results, or empty if there are no more results in the list.
}</pre>
</div>
<div class="method">
<code class="details" id="list_next">list_next()</code>
<pre>Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
<div class="method">
<code class="details" id="patch">patch(name, allowMissing=None, aspectKeys=None, body=None, deleteMissingAspects=None, updateMask=None, x__xgafv=None)</code>
<pre>Updates an Entry.
Args:
name: string, Identifier. The relative resource name of the entry, in the format projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id}. (required)
body: object, The request body.
The object takes the form of:
{ # An entry is a representation of a data resource that can be described by various metadata.
"aspects": { # Optional. The aspects that are attached to the entry. Depending on how the aspect is attached to the entry, the format of the aspect key can be one of the following: If the aspect is attached directly to the entry: {project_id_or_number}.{location_id}.{aspect_type_id} If the aspect is attached to an entry's path: {project_id_or_number}.{location_id}.{aspect_type_id}@{path}
"a_key": { # An aspect is a single piece of metadata describing an entry.
"aspectSource": { # Information related to the source system of the aspect. # Optional. Information related to the source system of the aspect.
"createTime": "A String", # The time the aspect was created in the source system.
"dataVersion": "A String", # The version of the data format used to produce this data. This field is used to indicated when the underlying data format changes (e.g., schema modifications, changes to the source URL format definition, etc).
"updateTime": "A String", # The time the aspect was last updated in the source system.
},
"aspectType": "A String", # Output only. The resource name of the type used to create this Aspect.
"createTime": "A String", # Output only. The time when the Aspect was created.
"data": { # Required. The content of the aspect, according to its aspect type schema. The maximum size of the field is 120KB (encoded as UTF-8).
"a_key": "", # Properties of the object.
},
"path": "A String", # Output only. The path in the entry under which the aspect is attached.
"updateTime": "A String", # Output only. The time when the Aspect was last updated.
},
},
"createTime": "A String", # Output only. The time when the entry was created in Dataplex Universal Catalog.
"entrySource": { # Information related to the source system of the data resource that is represented by the entry. # Optional. Information related to the source system of the data resource that is represented by the entry.
"ancestors": [ # Immutable. The entries representing the ancestors of the data resource in the source system.
{ # Information about individual items in the hierarchy that is associated with the data resource.
"name": "A String", # Optional. The name of the ancestor resource.
"type": "A String", # Optional. The type of the ancestor resource.
},
],
"createTime": "A String", # The time when the resource was created in the source system.
"description": "A String", # A description of the data resource. Maximum length is 2,000 characters.
"displayName": "A String", # A user-friendly display name. Maximum length is 500 characters.
"labels": { # User-defined labels. The maximum size of keys and values is 128 characters each.
"a_key": "A String",
},
"location": "A String", # Output only. Location of the resource in the source system. You can search the entry by this location. By default, this should match the location of the entry group containing this entry. A different value allows capturing the source location for data external to Google Cloud.
"platform": "A String", # The platform containing the source system. Maximum length is 64 characters.
"resource": "A String", # The name of the resource in the source system. Maximum length is 4,000 characters.
"system": "A String", # The name of the source system. Maximum length is 64 characters.
"updateTime": "A String", # The time when the resource was last updated in the source system. If the entry exists in the system and its EntrySource has update_time populated, further updates to the EntrySource of the entry must provide incremental updates to its update_time.
},
"entryType": "A String", # Required. Immutable. The relative resource name of the entry type that was used to create this entry, in the format projects/{project_id_or_number}/locations/{location_id}/entryTypes/{entry_type_id}.
"fullyQualifiedName": "A String", # Optional. A name for the entry that can be referenced by an external system. For more information, see Fully qualified names (https://cloud.google.com/data-catalog/docs/fully-qualified-names). The maximum size of the field is 4000 characters.
"name": "A String", # Identifier. The relative resource name of the entry, in the format projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id}.
"parentEntry": "A String", # Optional. Immutable. The resource name of the parent entry, in the format projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id}.
"updateTime": "A String", # Output only. The time when the entry was last updated in Dataplex Universal Catalog.
}
allowMissing: boolean, Optional. If set to true and the entry doesn't exist, the service will create it.
aspectKeys: string, Optional. The map keys of the Aspects which the service should modify. It supports the following syntaxes: - matches an aspect of the given type and empty path. @path - matches an aspect of the given type and specified path. For example, to attach an aspect to a field that is specified by the schema aspect, the path should have the format Schema.. @* - matches aspects of the given type for all paths. *@path - matches aspects of all types on the given path.The service will not remove existing aspects matching the syntax unless delete_missing_aspects is set to true.If this field is left empty, the service treats it as specifying exactly those Aspects present in the request. (repeated)
deleteMissingAspects: boolean, Optional. If set to true and the aspect_keys specify aspect ranges, the service deletes any existing aspects from that range that weren't provided in the request.
updateMask: string, Optional. Mask of fields to update. To update Aspects, the update_mask must contain the value "aspects".If the update_mask is empty, the service will update all modifiable fields present in the request.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # An entry is a representation of a data resource that can be described by various metadata.
"aspects": { # Optional. The aspects that are attached to the entry. Depending on how the aspect is attached to the entry, the format of the aspect key can be one of the following: If the aspect is attached directly to the entry: {project_id_or_number}.{location_id}.{aspect_type_id} If the aspect is attached to an entry's path: {project_id_or_number}.{location_id}.{aspect_type_id}@{path}
"a_key": { # An aspect is a single piece of metadata describing an entry.
"aspectSource": { # Information related to the source system of the aspect. # Optional. Information related to the source system of the aspect.
"createTime": "A String", # The time the aspect was created in the source system.
"dataVersion": "A String", # The version of the data format used to produce this data. This field is used to indicated when the underlying data format changes (e.g., schema modifications, changes to the source URL format definition, etc).
"updateTime": "A String", # The time the aspect was last updated in the source system.
},
"aspectType": "A String", # Output only. The resource name of the type used to create this Aspect.
"createTime": "A String", # Output only. The time when the Aspect was created.
"data": { # Required. The content of the aspect, according to its aspect type schema. The maximum size of the field is 120KB (encoded as UTF-8).
"a_key": "", # Properties of the object.
},
"path": "A String", # Output only. The path in the entry under which the aspect is attached.
"updateTime": "A String", # Output only. The time when the Aspect was last updated.
},
},
"createTime": "A String", # Output only. The time when the entry was created in Dataplex Universal Catalog.
"entrySource": { # Information related to the source system of the data resource that is represented by the entry. # Optional. Information related to the source system of the data resource that is represented by the entry.
"ancestors": [ # Immutable. The entries representing the ancestors of the data resource in the source system.
{ # Information about individual items in the hierarchy that is associated with the data resource.
"name": "A String", # Optional. The name of the ancestor resource.
"type": "A String", # Optional. The type of the ancestor resource.
},
],
"createTime": "A String", # The time when the resource was created in the source system.
"description": "A String", # A description of the data resource. Maximum length is 2,000 characters.
"displayName": "A String", # A user-friendly display name. Maximum length is 500 characters.
"labels": { # User-defined labels. The maximum size of keys and values is 128 characters each.
"a_key": "A String",
},
"location": "A String", # Output only. Location of the resource in the source system. You can search the entry by this location. By default, this should match the location of the entry group containing this entry. A different value allows capturing the source location for data external to Google Cloud.
"platform": "A String", # The platform containing the source system. Maximum length is 64 characters.
"resource": "A String", # The name of the resource in the source system. Maximum length is 4,000 characters.
"system": "A String", # The name of the source system. Maximum length is 64 characters.
"updateTime": "A String", # The time when the resource was last updated in the source system. If the entry exists in the system and its EntrySource has update_time populated, further updates to the EntrySource of the entry must provide incremental updates to its update_time.
},
"entryType": "A String", # Required. Immutable. The relative resource name of the entry type that was used to create this entry, in the format projects/{project_id_or_number}/locations/{location_id}/entryTypes/{entry_type_id}.
"fullyQualifiedName": "A String", # Optional. A name for the entry that can be referenced by an external system. For more information, see Fully qualified names (https://cloud.google.com/data-catalog/docs/fully-qualified-names). The maximum size of the field is 4000 characters.
"name": "A String", # Identifier. The relative resource name of the entry, in the format projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id}.
"parentEntry": "A String", # Optional. Immutable. The resource name of the parent entry, in the format projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id}.
"updateTime": "A String", # Output only. The time when the entry was last updated in Dataplex Universal Catalog.
}</pre>
</div>
</body></html>
|
