File: dataplex_v1.projects.locations.lakes.zones.entities.html

package info (click to toggle)
python-googleapi 2.180.0-1
  • links: PTS
  • area: main
  • in suites: forky, sid
  • size: 527,124 kB
  • sloc: python: 11,076; javascript: 249; sh: 114; makefile: 59
file content (637 lines) | stat: -rw-r--r-- 64,553 bytes parent folder | download
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
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
<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.lakes.html">lakes</a> . <a href="dataplex_v1.projects.locations.lakes.zones.html">zones</a> . <a href="dataplex_v1.projects.locations.lakes.zones.entities.html">entities</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
  <code><a href="dataplex_v1.projects.locations.lakes.zones.entities.partitions.html">partitions()</a></code>
</p>
<p class="firstline">Returns the partitions Resource.</p>

<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, validateOnly=None, x__xgafv=None)</a></code></p>
<p class="firstline">Create a metadata entity.</p>
<p class="toc_element">
  <code><a href="#delete">delete(name, etag=None, x__xgafv=None)</a></code></p>
<p class="firstline">Delete a metadata entity.</p>
<p class="toc_element">
  <code><a href="#get">get(name, view=None, x__xgafv=None)</a></code></p>
<p class="firstline">Get a metadata entity.</p>
<p class="toc_element">
  <code><a href="#list">list(parent, filter=None, pageSize=None, pageToken=None, view=None, x__xgafv=None)</a></code></p>
<p class="firstline">List metadata entities in a zone.</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="#update">update(name, body=None, validateOnly=None, x__xgafv=None)</a></code></p>
<p class="firstline">Update a metadata entity. Only supports full resource update.</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, validateOnly=None, x__xgafv=None)</code>
  <pre>Create a metadata entity.

Args:
  parent: string, Required. The resource name of the parent zone: projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}. (required)
  body: object, The request body.
    The object takes the form of:

{ # Represents tables and fileset metadata contained within a zone.
  &quot;access&quot;: { # Describes the access mechanism of the data within its storage location. # Output only. Identifies the access mechanism to the entity. Not user settable.
    &quot;read&quot;: &quot;A String&quot;, # Output only. Describes the read access mechanism of the data. Not user settable.
  },
  &quot;asset&quot;: &quot;A String&quot;, # Required. Immutable. The ID of the asset associated with the storage location containing the entity data. The entity must be with in the same zone with the asset.
  &quot;catalogEntry&quot;: &quot;A String&quot;, # Output only. The name of the associated Data Catalog entry.
  &quot;compatibility&quot;: { # Provides compatibility information for various metadata stores. # Output only. Metadata stores that the entity is compatible with.
    &quot;bigquery&quot;: { # Provides compatibility information for a specific metadata store. # Output only. Whether this entity is compatible with BigQuery.
      &quot;compatible&quot;: True or False, # Output only. Whether the entity is compatible and can be represented in the metadata store.
      &quot;reason&quot;: &quot;A String&quot;, # Output only. Provides additional detail if the entity is incompatible with the metadata store.
    },
    &quot;hiveMetastore&quot;: { # Provides compatibility information for a specific metadata store. # Output only. Whether this entity is compatible with Hive Metastore.
      &quot;compatible&quot;: True or False, # Output only. Whether the entity is compatible and can be represented in the metadata store.
      &quot;reason&quot;: &quot;A String&quot;, # Output only. Provides additional detail if the entity is incompatible with the metadata store.
    },
  },
  &quot;createTime&quot;: &quot;A String&quot;, # Output only. The time when the entity was created.
  &quot;dataPath&quot;: &quot;A String&quot;, # Required. Immutable. The storage path of the entity data. For Cloud Storage data, this is the fully-qualified path to the entity, such as gs://bucket/path/to/data. For BigQuery data, this is the name of the table resource, such as projects/project_id/datasets/dataset_id/tables/table_id.
  &quot;dataPathPattern&quot;: &quot;A String&quot;, # Optional. The set of items within the data path constituting the data in the entity, represented as a glob path. Example: gs://bucket/path/to/data/**/*.csv.
  &quot;description&quot;: &quot;A String&quot;, # Optional. User friendly longer description text. Must be shorter than or equal to 1024 characters.
  &quot;displayName&quot;: &quot;A String&quot;, # Optional. Display name must be shorter than or equal to 256 characters.
  &quot;etag&quot;: &quot;A String&quot;, # Optional. The etag associated with the entity, which can be retrieved with a GetEntity request. Required for update and delete requests.
  &quot;format&quot;: { # Describes the format of the data within its storage location. # Required. Identifies the storage format of the entity data. It does not apply to entities with data stored in BigQuery.
    &quot;compressionFormat&quot;: &quot;A String&quot;, # Optional. The compression type associated with the stored data. If unspecified, the data is uncompressed.
    &quot;csv&quot;: { # Describes CSV and similar semi-structured data formats. # Optional. Additional information about CSV formatted data.
      &quot;delimiter&quot;: &quot;A String&quot;, # Optional. The delimiter used to separate values. Defaults to &#x27;,&#x27;.
      &quot;encoding&quot;: &quot;A String&quot;, # Optional. The character encoding of the data. Accepts &quot;US-ASCII&quot;, &quot;UTF-8&quot;, and &quot;ISO-8859-1&quot;. Defaults to UTF-8 if unspecified.
      &quot;headerRows&quot;: 42, # Optional. The number of rows to interpret as header rows that should be skipped when reading data rows. Defaults to 0.
      &quot;quote&quot;: &quot;A String&quot;, # Optional. The character used to quote column values. Accepts &#x27;&quot;&#x27; (double quotation mark) or &#x27;&#x27;&#x27; (single quotation mark). Defaults to &#x27;&quot;&#x27; (double quotation mark) if unspecified.
    },
    &quot;format&quot;: &quot;A String&quot;, # Output only. The data format associated with the stored data, which represents content type values. The value is inferred from mime type.
    &quot;iceberg&quot;: { # Describes Iceberg data format. # Optional. Additional information about iceberg tables.
      &quot;metadataLocation&quot;: &quot;A String&quot;, # Optional. The location of where the iceberg metadata is present, must be within the table path
    },
    &quot;json&quot;: { # Describes JSON data format. # Optional. Additional information about CSV formatted data.
      &quot;encoding&quot;: &quot;A String&quot;, # Optional. The character encoding of the data. Accepts &quot;US-ASCII&quot;, &quot;UTF-8&quot; and &quot;ISO-8859-1&quot;. Defaults to UTF-8 if not specified.
    },
    &quot;mimeType&quot;: &quot;A String&quot;, # Required. The mime type descriptor for the data. Must match the pattern {type}/{subtype}. Supported values: application/x-parquet application/x-avro application/x-orc application/x-tfrecord application/x-parquet+iceberg application/x-avro+iceberg application/x-orc+iceberg application/json application/{subtypes} text/csv text/ image/{image subtype} video/{video subtype} audio/{audio subtype}
  },
  &quot;id&quot;: &quot;A String&quot;, # Required. A user-provided entity ID. It is mutable, and will be used as the published table name. Specifying a new ID in an update entity request will override the existing value. The ID must contain only letters (a-z, A-Z), numbers (0-9), and underscores, and consist of 256 or fewer characters.
  &quot;name&quot;: &quot;A String&quot;, # Output only. The resource name of the entity, of the form: projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}/entities/{id}.
  &quot;schema&quot;: { # Schema information describing the structure and layout of the data. # Required. The description of the data structure and layout. The schema is not included in list responses. It is only included in SCHEMA and FULL entity views of a GetEntity response.
    &quot;fields&quot;: [ # Optional. The sequence of fields describing data in table entities. Note: BigQuery SchemaFields are immutable.
      { # Represents a column field within a table schema.
        &quot;description&quot;: &quot;A String&quot;, # Optional. User friendly field description. Must be less than or equal to 1024 characters.
        &quot;fields&quot;: [ # Optional. Any nested field for complex types.
          # Object with schema name: GoogleCloudDataplexV1SchemaSchemaField
        ],
        &quot;mode&quot;: &quot;A String&quot;, # Required. Additional field semantics.
        &quot;name&quot;: &quot;A String&quot;, # Required. The name of the field. Must contain only letters, numbers and underscores, with a maximum length of 767 characters, and must begin with a letter or underscore.
        &quot;type&quot;: &quot;A String&quot;, # Required. The type of field.
      },
    ],
    &quot;partitionFields&quot;: [ # Optional. The sequence of fields describing the partition structure in entities. If this field is empty, there are no partitions within the data.
      { # Represents a key field within the entity&#x27;s partition structure. You could have up to 20 partition fields, but only the first 10 partitions have the filtering ability due to performance consideration. Note: Partition fields are immutable.
        &quot;name&quot;: &quot;A String&quot;, # Required. Partition field name must consist of letters, numbers, and underscores only, with a maximum of length of 256 characters, and must begin with a letter or underscore..
        &quot;type&quot;: &quot;A String&quot;, # Required. Immutable. The type of field.
      },
    ],
    &quot;partitionStyle&quot;: &quot;A String&quot;, # Optional. The structure of paths containing partition data within the entity.
    &quot;userManaged&quot;: True or False, # Required. Set to true if user-managed or false if managed by Dataplex Universal Catalog. The default is false (managed by Dataplex Universal Catalog). Set to falseto enable Dataplex Universal Catalog discovery to update the schema. including new data discovery, schema inference, and schema evolution. Users retain the ability to input and edit the schema. Dataplex Universal Catalog treats schema input by the user as though produced by a previous Dataplex Universal Catalog discovery operation, and it will evolve the schema and take action based on that treatment. Set to true to fully manage the entity schema. This setting guarantees that Dataplex Universal Catalog will not change schema fields.
  },
  &quot;system&quot;: &quot;A String&quot;, # Required. Immutable. Identifies the storage system of the entity data.
  &quot;type&quot;: &quot;A String&quot;, # Required. Immutable. The type of entity.
  &quot;uid&quot;: &quot;A String&quot;, # Output only. System generated unique ID for the Entity. This ID will be different if the Entity is deleted and re-created with the same name.
  &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The time when the entity was last updated.
}

  validateOnly: boolean, Optional. Only validate the request, but do not perform mutations. The default is false.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Represents tables and fileset metadata contained within a zone.
  &quot;access&quot;: { # Describes the access mechanism of the data within its storage location. # Output only. Identifies the access mechanism to the entity. Not user settable.
    &quot;read&quot;: &quot;A String&quot;, # Output only. Describes the read access mechanism of the data. Not user settable.
  },
  &quot;asset&quot;: &quot;A String&quot;, # Required. Immutable. The ID of the asset associated with the storage location containing the entity data. The entity must be with in the same zone with the asset.
  &quot;catalogEntry&quot;: &quot;A String&quot;, # Output only. The name of the associated Data Catalog entry.
  &quot;compatibility&quot;: { # Provides compatibility information for various metadata stores. # Output only. Metadata stores that the entity is compatible with.
    &quot;bigquery&quot;: { # Provides compatibility information for a specific metadata store. # Output only. Whether this entity is compatible with BigQuery.
      &quot;compatible&quot;: True or False, # Output only. Whether the entity is compatible and can be represented in the metadata store.
      &quot;reason&quot;: &quot;A String&quot;, # Output only. Provides additional detail if the entity is incompatible with the metadata store.
    },
    &quot;hiveMetastore&quot;: { # Provides compatibility information for a specific metadata store. # Output only. Whether this entity is compatible with Hive Metastore.
      &quot;compatible&quot;: True or False, # Output only. Whether the entity is compatible and can be represented in the metadata store.
      &quot;reason&quot;: &quot;A String&quot;, # Output only. Provides additional detail if the entity is incompatible with the metadata store.
    },
  },
  &quot;createTime&quot;: &quot;A String&quot;, # Output only. The time when the entity was created.
  &quot;dataPath&quot;: &quot;A String&quot;, # Required. Immutable. The storage path of the entity data. For Cloud Storage data, this is the fully-qualified path to the entity, such as gs://bucket/path/to/data. For BigQuery data, this is the name of the table resource, such as projects/project_id/datasets/dataset_id/tables/table_id.
  &quot;dataPathPattern&quot;: &quot;A String&quot;, # Optional. The set of items within the data path constituting the data in the entity, represented as a glob path. Example: gs://bucket/path/to/data/**/*.csv.
  &quot;description&quot;: &quot;A String&quot;, # Optional. User friendly longer description text. Must be shorter than or equal to 1024 characters.
  &quot;displayName&quot;: &quot;A String&quot;, # Optional. Display name must be shorter than or equal to 256 characters.
  &quot;etag&quot;: &quot;A String&quot;, # Optional. The etag associated with the entity, which can be retrieved with a GetEntity request. Required for update and delete requests.
  &quot;format&quot;: { # Describes the format of the data within its storage location. # Required. Identifies the storage format of the entity data. It does not apply to entities with data stored in BigQuery.
    &quot;compressionFormat&quot;: &quot;A String&quot;, # Optional. The compression type associated with the stored data. If unspecified, the data is uncompressed.
    &quot;csv&quot;: { # Describes CSV and similar semi-structured data formats. # Optional. Additional information about CSV formatted data.
      &quot;delimiter&quot;: &quot;A String&quot;, # Optional. The delimiter used to separate values. Defaults to &#x27;,&#x27;.
      &quot;encoding&quot;: &quot;A String&quot;, # Optional. The character encoding of the data. Accepts &quot;US-ASCII&quot;, &quot;UTF-8&quot;, and &quot;ISO-8859-1&quot;. Defaults to UTF-8 if unspecified.
      &quot;headerRows&quot;: 42, # Optional. The number of rows to interpret as header rows that should be skipped when reading data rows. Defaults to 0.
      &quot;quote&quot;: &quot;A String&quot;, # Optional. The character used to quote column values. Accepts &#x27;&quot;&#x27; (double quotation mark) or &#x27;&#x27;&#x27; (single quotation mark). Defaults to &#x27;&quot;&#x27; (double quotation mark) if unspecified.
    },
    &quot;format&quot;: &quot;A String&quot;, # Output only. The data format associated with the stored data, which represents content type values. The value is inferred from mime type.
    &quot;iceberg&quot;: { # Describes Iceberg data format. # Optional. Additional information about iceberg tables.
      &quot;metadataLocation&quot;: &quot;A String&quot;, # Optional. The location of where the iceberg metadata is present, must be within the table path
    },
    &quot;json&quot;: { # Describes JSON data format. # Optional. Additional information about CSV formatted data.
      &quot;encoding&quot;: &quot;A String&quot;, # Optional. The character encoding of the data. Accepts &quot;US-ASCII&quot;, &quot;UTF-8&quot; and &quot;ISO-8859-1&quot;. Defaults to UTF-8 if not specified.
    },
    &quot;mimeType&quot;: &quot;A String&quot;, # Required. The mime type descriptor for the data. Must match the pattern {type}/{subtype}. Supported values: application/x-parquet application/x-avro application/x-orc application/x-tfrecord application/x-parquet+iceberg application/x-avro+iceberg application/x-orc+iceberg application/json application/{subtypes} text/csv text/ image/{image subtype} video/{video subtype} audio/{audio subtype}
  },
  &quot;id&quot;: &quot;A String&quot;, # Required. A user-provided entity ID. It is mutable, and will be used as the published table name. Specifying a new ID in an update entity request will override the existing value. The ID must contain only letters (a-z, A-Z), numbers (0-9), and underscores, and consist of 256 or fewer characters.
  &quot;name&quot;: &quot;A String&quot;, # Output only. The resource name of the entity, of the form: projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}/entities/{id}.
  &quot;schema&quot;: { # Schema information describing the structure and layout of the data. # Required. The description of the data structure and layout. The schema is not included in list responses. It is only included in SCHEMA and FULL entity views of a GetEntity response.
    &quot;fields&quot;: [ # Optional. The sequence of fields describing data in table entities. Note: BigQuery SchemaFields are immutable.
      { # Represents a column field within a table schema.
        &quot;description&quot;: &quot;A String&quot;, # Optional. User friendly field description. Must be less than or equal to 1024 characters.
        &quot;fields&quot;: [ # Optional. Any nested field for complex types.
          # Object with schema name: GoogleCloudDataplexV1SchemaSchemaField
        ],
        &quot;mode&quot;: &quot;A String&quot;, # Required. Additional field semantics.
        &quot;name&quot;: &quot;A String&quot;, # Required. The name of the field. Must contain only letters, numbers and underscores, with a maximum length of 767 characters, and must begin with a letter or underscore.
        &quot;type&quot;: &quot;A String&quot;, # Required. The type of field.
      },
    ],
    &quot;partitionFields&quot;: [ # Optional. The sequence of fields describing the partition structure in entities. If this field is empty, there are no partitions within the data.
      { # Represents a key field within the entity&#x27;s partition structure. You could have up to 20 partition fields, but only the first 10 partitions have the filtering ability due to performance consideration. Note: Partition fields are immutable.
        &quot;name&quot;: &quot;A String&quot;, # Required. Partition field name must consist of letters, numbers, and underscores only, with a maximum of length of 256 characters, and must begin with a letter or underscore..
        &quot;type&quot;: &quot;A String&quot;, # Required. Immutable. The type of field.
      },
    ],
    &quot;partitionStyle&quot;: &quot;A String&quot;, # Optional. The structure of paths containing partition data within the entity.
    &quot;userManaged&quot;: True or False, # Required. Set to true if user-managed or false if managed by Dataplex Universal Catalog. The default is false (managed by Dataplex Universal Catalog). Set to falseto enable Dataplex Universal Catalog discovery to update the schema. including new data discovery, schema inference, and schema evolution. Users retain the ability to input and edit the schema. Dataplex Universal Catalog treats schema input by the user as though produced by a previous Dataplex Universal Catalog discovery operation, and it will evolve the schema and take action based on that treatment. Set to true to fully manage the entity schema. This setting guarantees that Dataplex Universal Catalog will not change schema fields.
  },
  &quot;system&quot;: &quot;A String&quot;, # Required. Immutable. Identifies the storage system of the entity data.
  &quot;type&quot;: &quot;A String&quot;, # Required. Immutable. The type of entity.
  &quot;uid&quot;: &quot;A String&quot;, # Output only. System generated unique ID for the Entity. This ID will be different if the Entity is deleted and re-created with the same name.
  &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The time when the entity was last updated.
}</pre>
</div>

<div class="method">
    <code class="details" id="delete">delete(name, etag=None, x__xgafv=None)</code>
  <pre>Delete a metadata entity.

Args:
  name: string, Required. The resource name of the entity: projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}/entities/{entity_id}. (required)
  etag: string, Required. The etag associated with the entity, which can be retrieved with a GetEntity request.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
}</pre>
</div>

<div class="method">
    <code class="details" id="get">get(name, view=None, x__xgafv=None)</code>
  <pre>Get a metadata entity.

Args:
  name: string, Required. The resource name of the entity: projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}/entities/{entity_id}. (required)
  view: string, Optional. Used to select the subset of entity information to return. Defaults to BASIC.
    Allowed values
      ENTITY_VIEW_UNSPECIFIED - The API will default to the BASIC view.
      BASIC - Minimal view that does not include the schema.
      SCHEMA - Include basic information and schema.
      FULL - Include everything. Currently, this is the same as the SCHEMA view.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Represents tables and fileset metadata contained within a zone.
  &quot;access&quot;: { # Describes the access mechanism of the data within its storage location. # Output only. Identifies the access mechanism to the entity. Not user settable.
    &quot;read&quot;: &quot;A String&quot;, # Output only. Describes the read access mechanism of the data. Not user settable.
  },
  &quot;asset&quot;: &quot;A String&quot;, # Required. Immutable. The ID of the asset associated with the storage location containing the entity data. The entity must be with in the same zone with the asset.
  &quot;catalogEntry&quot;: &quot;A String&quot;, # Output only. The name of the associated Data Catalog entry.
  &quot;compatibility&quot;: { # Provides compatibility information for various metadata stores. # Output only. Metadata stores that the entity is compatible with.
    &quot;bigquery&quot;: { # Provides compatibility information for a specific metadata store. # Output only. Whether this entity is compatible with BigQuery.
      &quot;compatible&quot;: True or False, # Output only. Whether the entity is compatible and can be represented in the metadata store.
      &quot;reason&quot;: &quot;A String&quot;, # Output only. Provides additional detail if the entity is incompatible with the metadata store.
    },
    &quot;hiveMetastore&quot;: { # Provides compatibility information for a specific metadata store. # Output only. Whether this entity is compatible with Hive Metastore.
      &quot;compatible&quot;: True or False, # Output only. Whether the entity is compatible and can be represented in the metadata store.
      &quot;reason&quot;: &quot;A String&quot;, # Output only. Provides additional detail if the entity is incompatible with the metadata store.
    },
  },
  &quot;createTime&quot;: &quot;A String&quot;, # Output only. The time when the entity was created.
  &quot;dataPath&quot;: &quot;A String&quot;, # Required. Immutable. The storage path of the entity data. For Cloud Storage data, this is the fully-qualified path to the entity, such as gs://bucket/path/to/data. For BigQuery data, this is the name of the table resource, such as projects/project_id/datasets/dataset_id/tables/table_id.
  &quot;dataPathPattern&quot;: &quot;A String&quot;, # Optional. The set of items within the data path constituting the data in the entity, represented as a glob path. Example: gs://bucket/path/to/data/**/*.csv.
  &quot;description&quot;: &quot;A String&quot;, # Optional. User friendly longer description text. Must be shorter than or equal to 1024 characters.
  &quot;displayName&quot;: &quot;A String&quot;, # Optional. Display name must be shorter than or equal to 256 characters.
  &quot;etag&quot;: &quot;A String&quot;, # Optional. The etag associated with the entity, which can be retrieved with a GetEntity request. Required for update and delete requests.
  &quot;format&quot;: { # Describes the format of the data within its storage location. # Required. Identifies the storage format of the entity data. It does not apply to entities with data stored in BigQuery.
    &quot;compressionFormat&quot;: &quot;A String&quot;, # Optional. The compression type associated with the stored data. If unspecified, the data is uncompressed.
    &quot;csv&quot;: { # Describes CSV and similar semi-structured data formats. # Optional. Additional information about CSV formatted data.
      &quot;delimiter&quot;: &quot;A String&quot;, # Optional. The delimiter used to separate values. Defaults to &#x27;,&#x27;.
      &quot;encoding&quot;: &quot;A String&quot;, # Optional. The character encoding of the data. Accepts &quot;US-ASCII&quot;, &quot;UTF-8&quot;, and &quot;ISO-8859-1&quot;. Defaults to UTF-8 if unspecified.
      &quot;headerRows&quot;: 42, # Optional. The number of rows to interpret as header rows that should be skipped when reading data rows. Defaults to 0.
      &quot;quote&quot;: &quot;A String&quot;, # Optional. The character used to quote column values. Accepts &#x27;&quot;&#x27; (double quotation mark) or &#x27;&#x27;&#x27; (single quotation mark). Defaults to &#x27;&quot;&#x27; (double quotation mark) if unspecified.
    },
    &quot;format&quot;: &quot;A String&quot;, # Output only. The data format associated with the stored data, which represents content type values. The value is inferred from mime type.
    &quot;iceberg&quot;: { # Describes Iceberg data format. # Optional. Additional information about iceberg tables.
      &quot;metadataLocation&quot;: &quot;A String&quot;, # Optional. The location of where the iceberg metadata is present, must be within the table path
    },
    &quot;json&quot;: { # Describes JSON data format. # Optional. Additional information about CSV formatted data.
      &quot;encoding&quot;: &quot;A String&quot;, # Optional. The character encoding of the data. Accepts &quot;US-ASCII&quot;, &quot;UTF-8&quot; and &quot;ISO-8859-1&quot;. Defaults to UTF-8 if not specified.
    },
    &quot;mimeType&quot;: &quot;A String&quot;, # Required. The mime type descriptor for the data. Must match the pattern {type}/{subtype}. Supported values: application/x-parquet application/x-avro application/x-orc application/x-tfrecord application/x-parquet+iceberg application/x-avro+iceberg application/x-orc+iceberg application/json application/{subtypes} text/csv text/ image/{image subtype} video/{video subtype} audio/{audio subtype}
  },
  &quot;id&quot;: &quot;A String&quot;, # Required. A user-provided entity ID. It is mutable, and will be used as the published table name. Specifying a new ID in an update entity request will override the existing value. The ID must contain only letters (a-z, A-Z), numbers (0-9), and underscores, and consist of 256 or fewer characters.
  &quot;name&quot;: &quot;A String&quot;, # Output only. The resource name of the entity, of the form: projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}/entities/{id}.
  &quot;schema&quot;: { # Schema information describing the structure and layout of the data. # Required. The description of the data structure and layout. The schema is not included in list responses. It is only included in SCHEMA and FULL entity views of a GetEntity response.
    &quot;fields&quot;: [ # Optional. The sequence of fields describing data in table entities. Note: BigQuery SchemaFields are immutable.
      { # Represents a column field within a table schema.
        &quot;description&quot;: &quot;A String&quot;, # Optional. User friendly field description. Must be less than or equal to 1024 characters.
        &quot;fields&quot;: [ # Optional. Any nested field for complex types.
          # Object with schema name: GoogleCloudDataplexV1SchemaSchemaField
        ],
        &quot;mode&quot;: &quot;A String&quot;, # Required. Additional field semantics.
        &quot;name&quot;: &quot;A String&quot;, # Required. The name of the field. Must contain only letters, numbers and underscores, with a maximum length of 767 characters, and must begin with a letter or underscore.
        &quot;type&quot;: &quot;A String&quot;, # Required. The type of field.
      },
    ],
    &quot;partitionFields&quot;: [ # Optional. The sequence of fields describing the partition structure in entities. If this field is empty, there are no partitions within the data.
      { # Represents a key field within the entity&#x27;s partition structure. You could have up to 20 partition fields, but only the first 10 partitions have the filtering ability due to performance consideration. Note: Partition fields are immutable.
        &quot;name&quot;: &quot;A String&quot;, # Required. Partition field name must consist of letters, numbers, and underscores only, with a maximum of length of 256 characters, and must begin with a letter or underscore..
        &quot;type&quot;: &quot;A String&quot;, # Required. Immutable. The type of field.
      },
    ],
    &quot;partitionStyle&quot;: &quot;A String&quot;, # Optional. The structure of paths containing partition data within the entity.
    &quot;userManaged&quot;: True or False, # Required. Set to true if user-managed or false if managed by Dataplex Universal Catalog. The default is false (managed by Dataplex Universal Catalog). Set to falseto enable Dataplex Universal Catalog discovery to update the schema. including new data discovery, schema inference, and schema evolution. Users retain the ability to input and edit the schema. Dataplex Universal Catalog treats schema input by the user as though produced by a previous Dataplex Universal Catalog discovery operation, and it will evolve the schema and take action based on that treatment. Set to true to fully manage the entity schema. This setting guarantees that Dataplex Universal Catalog will not change schema fields.
  },
  &quot;system&quot;: &quot;A String&quot;, # Required. Immutable. Identifies the storage system of the entity data.
  &quot;type&quot;: &quot;A String&quot;, # Required. Immutable. The type of entity.
  &quot;uid&quot;: &quot;A String&quot;, # Output only. System generated unique ID for the Entity. This ID will be different if the Entity is deleted and re-created with the same name.
  &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The time when the entity was last updated.
}</pre>
</div>

<div class="method">
    <code class="details" id="list">list(parent, filter=None, pageSize=None, pageToken=None, view=None, x__xgafv=None)</code>
  <pre>List metadata entities in a zone.

Args:
  parent: string, Required. The resource name of the parent zone: projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}. (required)
  filter: string, Optional. The following filter parameters can be added to the URL to limit the entities returned by the API: Entity ID: ?filter=&quot;id=entityID&quot; Asset ID: ?filter=&quot;asset=assetID&quot; Data path ?filter=&quot;data_path=gs://my-bucket&quot; Is HIVE compatible: ?filter=&quot;hive_compatible=true&quot; Is BigQuery compatible: ?filter=&quot;bigquery_compatible=true&quot;
  pageSize: integer, Optional. Maximum number of entities to return. The service may return fewer than this value. If unspecified, 100 entities will be returned by default. The maximum value is 500; larger values will will be truncated to 500.
  pageToken: string, Optional. Page token received from a previous ListEntities call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListEntities must match the call that provided the page token.
  view: string, Required. Specify the entity view to make a partial list request.
    Allowed values
      ENTITY_VIEW_UNSPECIFIED - The default unset value. Return both table and fileset entities if unspecified.
      TABLES - Only list table entities.
      FILESETS - Only list fileset entities.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # List metadata entities response.
  &quot;entities&quot;: [ # Entities in the specified parent zone.
    { # Represents tables and fileset metadata contained within a zone.
      &quot;access&quot;: { # Describes the access mechanism of the data within its storage location. # Output only. Identifies the access mechanism to the entity. Not user settable.
        &quot;read&quot;: &quot;A String&quot;, # Output only. Describes the read access mechanism of the data. Not user settable.
      },
      &quot;asset&quot;: &quot;A String&quot;, # Required. Immutable. The ID of the asset associated with the storage location containing the entity data. The entity must be with in the same zone with the asset.
      &quot;catalogEntry&quot;: &quot;A String&quot;, # Output only. The name of the associated Data Catalog entry.
      &quot;compatibility&quot;: { # Provides compatibility information for various metadata stores. # Output only. Metadata stores that the entity is compatible with.
        &quot;bigquery&quot;: { # Provides compatibility information for a specific metadata store. # Output only. Whether this entity is compatible with BigQuery.
          &quot;compatible&quot;: True or False, # Output only. Whether the entity is compatible and can be represented in the metadata store.
          &quot;reason&quot;: &quot;A String&quot;, # Output only. Provides additional detail if the entity is incompatible with the metadata store.
        },
        &quot;hiveMetastore&quot;: { # Provides compatibility information for a specific metadata store. # Output only. Whether this entity is compatible with Hive Metastore.
          &quot;compatible&quot;: True or False, # Output only. Whether the entity is compatible and can be represented in the metadata store.
          &quot;reason&quot;: &quot;A String&quot;, # Output only. Provides additional detail if the entity is incompatible with the metadata store.
        },
      },
      &quot;createTime&quot;: &quot;A String&quot;, # Output only. The time when the entity was created.
      &quot;dataPath&quot;: &quot;A String&quot;, # Required. Immutable. The storage path of the entity data. For Cloud Storage data, this is the fully-qualified path to the entity, such as gs://bucket/path/to/data. For BigQuery data, this is the name of the table resource, such as projects/project_id/datasets/dataset_id/tables/table_id.
      &quot;dataPathPattern&quot;: &quot;A String&quot;, # Optional. The set of items within the data path constituting the data in the entity, represented as a glob path. Example: gs://bucket/path/to/data/**/*.csv.
      &quot;description&quot;: &quot;A String&quot;, # Optional. User friendly longer description text. Must be shorter than or equal to 1024 characters.
      &quot;displayName&quot;: &quot;A String&quot;, # Optional. Display name must be shorter than or equal to 256 characters.
      &quot;etag&quot;: &quot;A String&quot;, # Optional. The etag associated with the entity, which can be retrieved with a GetEntity request. Required for update and delete requests.
      &quot;format&quot;: { # Describes the format of the data within its storage location. # Required. Identifies the storage format of the entity data. It does not apply to entities with data stored in BigQuery.
        &quot;compressionFormat&quot;: &quot;A String&quot;, # Optional. The compression type associated with the stored data. If unspecified, the data is uncompressed.
        &quot;csv&quot;: { # Describes CSV and similar semi-structured data formats. # Optional. Additional information about CSV formatted data.
          &quot;delimiter&quot;: &quot;A String&quot;, # Optional. The delimiter used to separate values. Defaults to &#x27;,&#x27;.
          &quot;encoding&quot;: &quot;A String&quot;, # Optional. The character encoding of the data. Accepts &quot;US-ASCII&quot;, &quot;UTF-8&quot;, and &quot;ISO-8859-1&quot;. Defaults to UTF-8 if unspecified.
          &quot;headerRows&quot;: 42, # Optional. The number of rows to interpret as header rows that should be skipped when reading data rows. Defaults to 0.
          &quot;quote&quot;: &quot;A String&quot;, # Optional. The character used to quote column values. Accepts &#x27;&quot;&#x27; (double quotation mark) or &#x27;&#x27;&#x27; (single quotation mark). Defaults to &#x27;&quot;&#x27; (double quotation mark) if unspecified.
        },
        &quot;format&quot;: &quot;A String&quot;, # Output only. The data format associated with the stored data, which represents content type values. The value is inferred from mime type.
        &quot;iceberg&quot;: { # Describes Iceberg data format. # Optional. Additional information about iceberg tables.
          &quot;metadataLocation&quot;: &quot;A String&quot;, # Optional. The location of where the iceberg metadata is present, must be within the table path
        },
        &quot;json&quot;: { # Describes JSON data format. # Optional. Additional information about CSV formatted data.
          &quot;encoding&quot;: &quot;A String&quot;, # Optional. The character encoding of the data. Accepts &quot;US-ASCII&quot;, &quot;UTF-8&quot; and &quot;ISO-8859-1&quot;. Defaults to UTF-8 if not specified.
        },
        &quot;mimeType&quot;: &quot;A String&quot;, # Required. The mime type descriptor for the data. Must match the pattern {type}/{subtype}. Supported values: application/x-parquet application/x-avro application/x-orc application/x-tfrecord application/x-parquet+iceberg application/x-avro+iceberg application/x-orc+iceberg application/json application/{subtypes} text/csv text/ image/{image subtype} video/{video subtype} audio/{audio subtype}
      },
      &quot;id&quot;: &quot;A String&quot;, # Required. A user-provided entity ID. It is mutable, and will be used as the published table name. Specifying a new ID in an update entity request will override the existing value. The ID must contain only letters (a-z, A-Z), numbers (0-9), and underscores, and consist of 256 or fewer characters.
      &quot;name&quot;: &quot;A String&quot;, # Output only. The resource name of the entity, of the form: projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}/entities/{id}.
      &quot;schema&quot;: { # Schema information describing the structure and layout of the data. # Required. The description of the data structure and layout. The schema is not included in list responses. It is only included in SCHEMA and FULL entity views of a GetEntity response.
        &quot;fields&quot;: [ # Optional. The sequence of fields describing data in table entities. Note: BigQuery SchemaFields are immutable.
          { # Represents a column field within a table schema.
            &quot;description&quot;: &quot;A String&quot;, # Optional. User friendly field description. Must be less than or equal to 1024 characters.
            &quot;fields&quot;: [ # Optional. Any nested field for complex types.
              # Object with schema name: GoogleCloudDataplexV1SchemaSchemaField
            ],
            &quot;mode&quot;: &quot;A String&quot;, # Required. Additional field semantics.
            &quot;name&quot;: &quot;A String&quot;, # Required. The name of the field. Must contain only letters, numbers and underscores, with a maximum length of 767 characters, and must begin with a letter or underscore.
            &quot;type&quot;: &quot;A String&quot;, # Required. The type of field.
          },
        ],
        &quot;partitionFields&quot;: [ # Optional. The sequence of fields describing the partition structure in entities. If this field is empty, there are no partitions within the data.
          { # Represents a key field within the entity&#x27;s partition structure. You could have up to 20 partition fields, but only the first 10 partitions have the filtering ability due to performance consideration. Note: Partition fields are immutable.
            &quot;name&quot;: &quot;A String&quot;, # Required. Partition field name must consist of letters, numbers, and underscores only, with a maximum of length of 256 characters, and must begin with a letter or underscore..
            &quot;type&quot;: &quot;A String&quot;, # Required. Immutable. The type of field.
          },
        ],
        &quot;partitionStyle&quot;: &quot;A String&quot;, # Optional. The structure of paths containing partition data within the entity.
        &quot;userManaged&quot;: True or False, # Required. Set to true if user-managed or false if managed by Dataplex Universal Catalog. The default is false (managed by Dataplex Universal Catalog). Set to falseto enable Dataplex Universal Catalog discovery to update the schema. including new data discovery, schema inference, and schema evolution. Users retain the ability to input and edit the schema. Dataplex Universal Catalog treats schema input by the user as though produced by a previous Dataplex Universal Catalog discovery operation, and it will evolve the schema and take action based on that treatment. Set to true to fully manage the entity schema. This setting guarantees that Dataplex Universal Catalog will not change schema fields.
      },
      &quot;system&quot;: &quot;A String&quot;, # Required. Immutable. Identifies the storage system of the entity data.
      &quot;type&quot;: &quot;A String&quot;, # Required. Immutable. The type of entity.
      &quot;uid&quot;: &quot;A String&quot;, # Output only. System generated unique ID for the Entity. This ID will be different if the Entity is deleted and re-created with the same name.
      &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The time when the entity was last updated.
    },
  ],
  &quot;nextPageToken&quot;: &quot;A String&quot;, # Token to retrieve the next page of results, or empty if there are no remaining 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 &#x27;execute()&#x27; 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="update">update(name, body=None, validateOnly=None, x__xgafv=None)</code>
  <pre>Update a metadata entity. Only supports full resource update.

Args:
  name: string, Output only. The resource name of the entity, of the form: projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}/entities/{id}. (required)
  body: object, The request body.
    The object takes the form of:

{ # Represents tables and fileset metadata contained within a zone.
  &quot;access&quot;: { # Describes the access mechanism of the data within its storage location. # Output only. Identifies the access mechanism to the entity. Not user settable.
    &quot;read&quot;: &quot;A String&quot;, # Output only. Describes the read access mechanism of the data. Not user settable.
  },
  &quot;asset&quot;: &quot;A String&quot;, # Required. Immutable. The ID of the asset associated with the storage location containing the entity data. The entity must be with in the same zone with the asset.
  &quot;catalogEntry&quot;: &quot;A String&quot;, # Output only. The name of the associated Data Catalog entry.
  &quot;compatibility&quot;: { # Provides compatibility information for various metadata stores. # Output only. Metadata stores that the entity is compatible with.
    &quot;bigquery&quot;: { # Provides compatibility information for a specific metadata store. # Output only. Whether this entity is compatible with BigQuery.
      &quot;compatible&quot;: True or False, # Output only. Whether the entity is compatible and can be represented in the metadata store.
      &quot;reason&quot;: &quot;A String&quot;, # Output only. Provides additional detail if the entity is incompatible with the metadata store.
    },
    &quot;hiveMetastore&quot;: { # Provides compatibility information for a specific metadata store. # Output only. Whether this entity is compatible with Hive Metastore.
      &quot;compatible&quot;: True or False, # Output only. Whether the entity is compatible and can be represented in the metadata store.
      &quot;reason&quot;: &quot;A String&quot;, # Output only. Provides additional detail if the entity is incompatible with the metadata store.
    },
  },
  &quot;createTime&quot;: &quot;A String&quot;, # Output only. The time when the entity was created.
  &quot;dataPath&quot;: &quot;A String&quot;, # Required. Immutable. The storage path of the entity data. For Cloud Storage data, this is the fully-qualified path to the entity, such as gs://bucket/path/to/data. For BigQuery data, this is the name of the table resource, such as projects/project_id/datasets/dataset_id/tables/table_id.
  &quot;dataPathPattern&quot;: &quot;A String&quot;, # Optional. The set of items within the data path constituting the data in the entity, represented as a glob path. Example: gs://bucket/path/to/data/**/*.csv.
  &quot;description&quot;: &quot;A String&quot;, # Optional. User friendly longer description text. Must be shorter than or equal to 1024 characters.
  &quot;displayName&quot;: &quot;A String&quot;, # Optional. Display name must be shorter than or equal to 256 characters.
  &quot;etag&quot;: &quot;A String&quot;, # Optional. The etag associated with the entity, which can be retrieved with a GetEntity request. Required for update and delete requests.
  &quot;format&quot;: { # Describes the format of the data within its storage location. # Required. Identifies the storage format of the entity data. It does not apply to entities with data stored in BigQuery.
    &quot;compressionFormat&quot;: &quot;A String&quot;, # Optional. The compression type associated with the stored data. If unspecified, the data is uncompressed.
    &quot;csv&quot;: { # Describes CSV and similar semi-structured data formats. # Optional. Additional information about CSV formatted data.
      &quot;delimiter&quot;: &quot;A String&quot;, # Optional. The delimiter used to separate values. Defaults to &#x27;,&#x27;.
      &quot;encoding&quot;: &quot;A String&quot;, # Optional. The character encoding of the data. Accepts &quot;US-ASCII&quot;, &quot;UTF-8&quot;, and &quot;ISO-8859-1&quot;. Defaults to UTF-8 if unspecified.
      &quot;headerRows&quot;: 42, # Optional. The number of rows to interpret as header rows that should be skipped when reading data rows. Defaults to 0.
      &quot;quote&quot;: &quot;A String&quot;, # Optional. The character used to quote column values. Accepts &#x27;&quot;&#x27; (double quotation mark) or &#x27;&#x27;&#x27; (single quotation mark). Defaults to &#x27;&quot;&#x27; (double quotation mark) if unspecified.
    },
    &quot;format&quot;: &quot;A String&quot;, # Output only. The data format associated with the stored data, which represents content type values. The value is inferred from mime type.
    &quot;iceberg&quot;: { # Describes Iceberg data format. # Optional. Additional information about iceberg tables.
      &quot;metadataLocation&quot;: &quot;A String&quot;, # Optional. The location of where the iceberg metadata is present, must be within the table path
    },
    &quot;json&quot;: { # Describes JSON data format. # Optional. Additional information about CSV formatted data.
      &quot;encoding&quot;: &quot;A String&quot;, # Optional. The character encoding of the data. Accepts &quot;US-ASCII&quot;, &quot;UTF-8&quot; and &quot;ISO-8859-1&quot;. Defaults to UTF-8 if not specified.
    },
    &quot;mimeType&quot;: &quot;A String&quot;, # Required. The mime type descriptor for the data. Must match the pattern {type}/{subtype}. Supported values: application/x-parquet application/x-avro application/x-orc application/x-tfrecord application/x-parquet+iceberg application/x-avro+iceberg application/x-orc+iceberg application/json application/{subtypes} text/csv text/ image/{image subtype} video/{video subtype} audio/{audio subtype}
  },
  &quot;id&quot;: &quot;A String&quot;, # Required. A user-provided entity ID. It is mutable, and will be used as the published table name. Specifying a new ID in an update entity request will override the existing value. The ID must contain only letters (a-z, A-Z), numbers (0-9), and underscores, and consist of 256 or fewer characters.
  &quot;name&quot;: &quot;A String&quot;, # Output only. The resource name of the entity, of the form: projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}/entities/{id}.
  &quot;schema&quot;: { # Schema information describing the structure and layout of the data. # Required. The description of the data structure and layout. The schema is not included in list responses. It is only included in SCHEMA and FULL entity views of a GetEntity response.
    &quot;fields&quot;: [ # Optional. The sequence of fields describing data in table entities. Note: BigQuery SchemaFields are immutable.
      { # Represents a column field within a table schema.
        &quot;description&quot;: &quot;A String&quot;, # Optional. User friendly field description. Must be less than or equal to 1024 characters.
        &quot;fields&quot;: [ # Optional. Any nested field for complex types.
          # Object with schema name: GoogleCloudDataplexV1SchemaSchemaField
        ],
        &quot;mode&quot;: &quot;A String&quot;, # Required. Additional field semantics.
        &quot;name&quot;: &quot;A String&quot;, # Required. The name of the field. Must contain only letters, numbers and underscores, with a maximum length of 767 characters, and must begin with a letter or underscore.
        &quot;type&quot;: &quot;A String&quot;, # Required. The type of field.
      },
    ],
    &quot;partitionFields&quot;: [ # Optional. The sequence of fields describing the partition structure in entities. If this field is empty, there are no partitions within the data.
      { # Represents a key field within the entity&#x27;s partition structure. You could have up to 20 partition fields, but only the first 10 partitions have the filtering ability due to performance consideration. Note: Partition fields are immutable.
        &quot;name&quot;: &quot;A String&quot;, # Required. Partition field name must consist of letters, numbers, and underscores only, with a maximum of length of 256 characters, and must begin with a letter or underscore..
        &quot;type&quot;: &quot;A String&quot;, # Required. Immutable. The type of field.
      },
    ],
    &quot;partitionStyle&quot;: &quot;A String&quot;, # Optional. The structure of paths containing partition data within the entity.
    &quot;userManaged&quot;: True or False, # Required. Set to true if user-managed or false if managed by Dataplex Universal Catalog. The default is false (managed by Dataplex Universal Catalog). Set to falseto enable Dataplex Universal Catalog discovery to update the schema. including new data discovery, schema inference, and schema evolution. Users retain the ability to input and edit the schema. Dataplex Universal Catalog treats schema input by the user as though produced by a previous Dataplex Universal Catalog discovery operation, and it will evolve the schema and take action based on that treatment. Set to true to fully manage the entity schema. This setting guarantees that Dataplex Universal Catalog will not change schema fields.
  },
  &quot;system&quot;: &quot;A String&quot;, # Required. Immutable. Identifies the storage system of the entity data.
  &quot;type&quot;: &quot;A String&quot;, # Required. Immutable. The type of entity.
  &quot;uid&quot;: &quot;A String&quot;, # Output only. System generated unique ID for the Entity. This ID will be different if the Entity is deleted and re-created with the same name.
  &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The time when the entity was last updated.
}

  validateOnly: boolean, Optional. Only validate the request, but do not perform mutations. The default is false.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Represents tables and fileset metadata contained within a zone.
  &quot;access&quot;: { # Describes the access mechanism of the data within its storage location. # Output only. Identifies the access mechanism to the entity. Not user settable.
    &quot;read&quot;: &quot;A String&quot;, # Output only. Describes the read access mechanism of the data. Not user settable.
  },
  &quot;asset&quot;: &quot;A String&quot;, # Required. Immutable. The ID of the asset associated with the storage location containing the entity data. The entity must be with in the same zone with the asset.
  &quot;catalogEntry&quot;: &quot;A String&quot;, # Output only. The name of the associated Data Catalog entry.
  &quot;compatibility&quot;: { # Provides compatibility information for various metadata stores. # Output only. Metadata stores that the entity is compatible with.
    &quot;bigquery&quot;: { # Provides compatibility information for a specific metadata store. # Output only. Whether this entity is compatible with BigQuery.
      &quot;compatible&quot;: True or False, # Output only. Whether the entity is compatible and can be represented in the metadata store.
      &quot;reason&quot;: &quot;A String&quot;, # Output only. Provides additional detail if the entity is incompatible with the metadata store.
    },
    &quot;hiveMetastore&quot;: { # Provides compatibility information for a specific metadata store. # Output only. Whether this entity is compatible with Hive Metastore.
      &quot;compatible&quot;: True or False, # Output only. Whether the entity is compatible and can be represented in the metadata store.
      &quot;reason&quot;: &quot;A String&quot;, # Output only. Provides additional detail if the entity is incompatible with the metadata store.
    },
  },
  &quot;createTime&quot;: &quot;A String&quot;, # Output only. The time when the entity was created.
  &quot;dataPath&quot;: &quot;A String&quot;, # Required. Immutable. The storage path of the entity data. For Cloud Storage data, this is the fully-qualified path to the entity, such as gs://bucket/path/to/data. For BigQuery data, this is the name of the table resource, such as projects/project_id/datasets/dataset_id/tables/table_id.
  &quot;dataPathPattern&quot;: &quot;A String&quot;, # Optional. The set of items within the data path constituting the data in the entity, represented as a glob path. Example: gs://bucket/path/to/data/**/*.csv.
  &quot;description&quot;: &quot;A String&quot;, # Optional. User friendly longer description text. Must be shorter than or equal to 1024 characters.
  &quot;displayName&quot;: &quot;A String&quot;, # Optional. Display name must be shorter than or equal to 256 characters.
  &quot;etag&quot;: &quot;A String&quot;, # Optional. The etag associated with the entity, which can be retrieved with a GetEntity request. Required for update and delete requests.
  &quot;format&quot;: { # Describes the format of the data within its storage location. # Required. Identifies the storage format of the entity data. It does not apply to entities with data stored in BigQuery.
    &quot;compressionFormat&quot;: &quot;A String&quot;, # Optional. The compression type associated with the stored data. If unspecified, the data is uncompressed.
    &quot;csv&quot;: { # Describes CSV and similar semi-structured data formats. # Optional. Additional information about CSV formatted data.
      &quot;delimiter&quot;: &quot;A String&quot;, # Optional. The delimiter used to separate values. Defaults to &#x27;,&#x27;.
      &quot;encoding&quot;: &quot;A String&quot;, # Optional. The character encoding of the data. Accepts &quot;US-ASCII&quot;, &quot;UTF-8&quot;, and &quot;ISO-8859-1&quot;. Defaults to UTF-8 if unspecified.
      &quot;headerRows&quot;: 42, # Optional. The number of rows to interpret as header rows that should be skipped when reading data rows. Defaults to 0.
      &quot;quote&quot;: &quot;A String&quot;, # Optional. The character used to quote column values. Accepts &#x27;&quot;&#x27; (double quotation mark) or &#x27;&#x27;&#x27; (single quotation mark). Defaults to &#x27;&quot;&#x27; (double quotation mark) if unspecified.
    },
    &quot;format&quot;: &quot;A String&quot;, # Output only. The data format associated with the stored data, which represents content type values. The value is inferred from mime type.
    &quot;iceberg&quot;: { # Describes Iceberg data format. # Optional. Additional information about iceberg tables.
      &quot;metadataLocation&quot;: &quot;A String&quot;, # Optional. The location of where the iceberg metadata is present, must be within the table path
    },
    &quot;json&quot;: { # Describes JSON data format. # Optional. Additional information about CSV formatted data.
      &quot;encoding&quot;: &quot;A String&quot;, # Optional. The character encoding of the data. Accepts &quot;US-ASCII&quot;, &quot;UTF-8&quot; and &quot;ISO-8859-1&quot;. Defaults to UTF-8 if not specified.
    },
    &quot;mimeType&quot;: &quot;A String&quot;, # Required. The mime type descriptor for the data. Must match the pattern {type}/{subtype}. Supported values: application/x-parquet application/x-avro application/x-orc application/x-tfrecord application/x-parquet+iceberg application/x-avro+iceberg application/x-orc+iceberg application/json application/{subtypes} text/csv text/ image/{image subtype} video/{video subtype} audio/{audio subtype}
  },
  &quot;id&quot;: &quot;A String&quot;, # Required. A user-provided entity ID. It is mutable, and will be used as the published table name. Specifying a new ID in an update entity request will override the existing value. The ID must contain only letters (a-z, A-Z), numbers (0-9), and underscores, and consist of 256 or fewer characters.
  &quot;name&quot;: &quot;A String&quot;, # Output only. The resource name of the entity, of the form: projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}/entities/{id}.
  &quot;schema&quot;: { # Schema information describing the structure and layout of the data. # Required. The description of the data structure and layout. The schema is not included in list responses. It is only included in SCHEMA and FULL entity views of a GetEntity response.
    &quot;fields&quot;: [ # Optional. The sequence of fields describing data in table entities. Note: BigQuery SchemaFields are immutable.
      { # Represents a column field within a table schema.
        &quot;description&quot;: &quot;A String&quot;, # Optional. User friendly field description. Must be less than or equal to 1024 characters.
        &quot;fields&quot;: [ # Optional. Any nested field for complex types.
          # Object with schema name: GoogleCloudDataplexV1SchemaSchemaField
        ],
        &quot;mode&quot;: &quot;A String&quot;, # Required. Additional field semantics.
        &quot;name&quot;: &quot;A String&quot;, # Required. The name of the field. Must contain only letters, numbers and underscores, with a maximum length of 767 characters, and must begin with a letter or underscore.
        &quot;type&quot;: &quot;A String&quot;, # Required. The type of field.
      },
    ],
    &quot;partitionFields&quot;: [ # Optional. The sequence of fields describing the partition structure in entities. If this field is empty, there are no partitions within the data.
      { # Represents a key field within the entity&#x27;s partition structure. You could have up to 20 partition fields, but only the first 10 partitions have the filtering ability due to performance consideration. Note: Partition fields are immutable.
        &quot;name&quot;: &quot;A String&quot;, # Required. Partition field name must consist of letters, numbers, and underscores only, with a maximum of length of 256 characters, and must begin with a letter or underscore..
        &quot;type&quot;: &quot;A String&quot;, # Required. Immutable. The type of field.
      },
    ],
    &quot;partitionStyle&quot;: &quot;A String&quot;, # Optional. The structure of paths containing partition data within the entity.
    &quot;userManaged&quot;: True or False, # Required. Set to true if user-managed or false if managed by Dataplex Universal Catalog. The default is false (managed by Dataplex Universal Catalog). Set to falseto enable Dataplex Universal Catalog discovery to update the schema. including new data discovery, schema inference, and schema evolution. Users retain the ability to input and edit the schema. Dataplex Universal Catalog treats schema input by the user as though produced by a previous Dataplex Universal Catalog discovery operation, and it will evolve the schema and take action based on that treatment. Set to true to fully manage the entity schema. This setting guarantees that Dataplex Universal Catalog will not change schema fields.
  },
  &quot;system&quot;: &quot;A String&quot;, # Required. Immutable. Identifies the storage system of the entity data.
  &quot;type&quot;: &quot;A String&quot;, # Required. Immutable. The type of entity.
  &quot;uid&quot;: &quot;A String&quot;, # Output only. System generated unique ID for the Entity. This ID will be different if the Entity is deleted and re-created with the same name.
  &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The time when the entity was last updated.
}</pre>
</div>

</body></html>