google-cloud-dataplex-v1 0.5.0 → 0.6.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/README.md +1 -1
- data/lib/google/cloud/dataplex/v1/content_service/client.rb +4 -4
- data/lib/google/cloud/dataplex/v1/content_service.rb +1 -1
- data/lib/google/cloud/dataplex/v1/data_profile_pb.rb +78 -0
- data/lib/google/cloud/dataplex/v1/data_quality_pb.rb +108 -0
- data/lib/google/cloud/dataplex/v1/data_scan_service/client.rb +1171 -0
- data/lib/google/cloud/dataplex/v1/data_scan_service/credentials.rb +47 -0
- data/lib/google/cloud/dataplex/v1/data_scan_service/operations.rb +770 -0
- data/lib/google/cloud/dataplex/v1/data_scan_service/paths.rb +113 -0
- data/lib/google/cloud/dataplex/v1/data_scan_service.rb +48 -0
- data/lib/google/cloud/dataplex/v1/dataplex_service/client.rb +64 -63
- data/lib/google/cloud/dataplex/v1/dataplex_service.rb +1 -1
- data/lib/google/cloud/dataplex/v1/datascans_pb.rb +169 -0
- data/lib/google/cloud/dataplex/v1/datascans_services_pb.rb +58 -0
- data/lib/google/cloud/dataplex/v1/logs_pb.rb +53 -0
- data/lib/google/cloud/dataplex/v1/metadata_pb.rb +5 -0
- data/lib/google/cloud/dataplex/v1/metadata_service/client.rb +18 -16
- data/lib/google/cloud/dataplex/v1/metadata_service.rb +1 -1
- data/lib/google/cloud/dataplex/v1/processing_pb.rb +53 -0
- data/lib/google/cloud/dataplex/v1/version.rb +1 -1
- data/lib/google/cloud/dataplex/v1.rb +3 -2
- data/proto_docs/google/api/client.rb +318 -0
- data/proto_docs/google/api/launch_stage.rb +71 -0
- data/proto_docs/google/cloud/dataplex/v1/analyze.rb +26 -21
- data/proto_docs/google/cloud/dataplex/v1/content.rb +4 -4
- data/proto_docs/google/cloud/dataplex/v1/data_profile.rb +232 -0
- data/proto_docs/google/cloud/dataplex/v1/data_quality.rb +274 -0
- data/proto_docs/google/cloud/dataplex/v1/datascans.rb +418 -0
- data/proto_docs/google/cloud/dataplex/v1/logs.rb +135 -2
- data/proto_docs/google/cloud/dataplex/v1/metadata.rb +72 -52
- data/proto_docs/google/cloud/dataplex/v1/processing.rb +96 -0
- data/proto_docs/google/cloud/dataplex/v1/resources.rb +67 -61
- data/proto_docs/google/cloud/dataplex/v1/service.rb +67 -65
- data/proto_docs/google/cloud/dataplex/v1/tasks.rb +34 -34
- data/proto_docs/google/rpc/status.rb +4 -2
- metadata +20 -4
@@ -61,8 +61,8 @@ module Google
|
|
61
61
|
# `projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}/entities/{entity_id}`.
|
62
62
|
# @!attribute [rw] etag
|
63
63
|
# @return [::String]
|
64
|
-
# Required. The etag associated with the entity, which can be retrieved with
|
65
|
-
# [GetEntity][] request.
|
64
|
+
# Required. The etag associated with the entity, which can be retrieved with
|
65
|
+
# a [GetEntity][] request.
|
66
66
|
class DeleteEntityRequest
|
67
67
|
include ::Google::Protobuf::MessageExts
|
68
68
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -78,9 +78,10 @@ module Google
|
|
78
78
|
# Required. Specify the entity view to make a partial list request.
|
79
79
|
# @!attribute [rw] page_size
|
80
80
|
# @return [::Integer]
|
81
|
-
# Optional. Maximum number of entities to return. The service may return
|
82
|
-
# this value. If unspecified, 100 entities will be returned by
|
83
|
-
# maximum value is 500; larger values will will be truncated to
|
81
|
+
# Optional. Maximum number of entities to return. The service may return
|
82
|
+
# fewer than this value. If unspecified, 100 entities will be returned by
|
83
|
+
# default. The maximum value is 500; larger values will will be truncated to
|
84
|
+
# 500.
|
84
85
|
# @!attribute [rw] page_token
|
85
86
|
# @return [::String]
|
86
87
|
# Optional. Page token received from a previous `ListEntities` call. Provide
|
@@ -89,8 +90,8 @@ module Google
|
|
89
90
|
# page token.
|
90
91
|
# @!attribute [rw] filter
|
91
92
|
# @return [::String]
|
92
|
-
# Optional. The following filter parameters can be added to the URL to limit
|
93
|
-
# entities returned by the API:
|
93
|
+
# Optional. The following filter parameters can be added to the URL to limit
|
94
|
+
# the entities returned by the API:
|
94
95
|
#
|
95
96
|
# - Entity ID: ?filter="id=entityID"
|
96
97
|
# - Asset ID: ?filter="asset=assetID"
|
@@ -164,19 +165,20 @@ module Google
|
|
164
165
|
# `projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}/entities/{entity_id}`.
|
165
166
|
# @!attribute [rw] page_size
|
166
167
|
# @return [::Integer]
|
167
|
-
# Optional. Maximum number of partitions to return. The service may return
|
168
|
-
# this value. If unspecified, 100 partitions will be returned by
|
169
|
-
# maximum page size is 500; larger values will will be truncated
|
168
|
+
# Optional. Maximum number of partitions to return. The service may return
|
169
|
+
# fewer than this value. If unspecified, 100 partitions will be returned by
|
170
|
+
# default. The maximum page size is 500; larger values will will be truncated
|
171
|
+
# to 500.
|
170
172
|
# @!attribute [rw] page_token
|
171
173
|
# @return [::String]
|
172
|
-
# Optional. Page token received from a previous `ListPartitions` call.
|
173
|
-
# this to retrieve the subsequent page. When paginating, all other
|
174
|
-
# provided to `ListPartitions` must match the call that provided
|
175
|
-
# page token.
|
174
|
+
# Optional. Page token received from a previous `ListPartitions` call.
|
175
|
+
# Provide this to retrieve the subsequent page. When paginating, all other
|
176
|
+
# parameters provided to `ListPartitions` must match the call that provided
|
177
|
+
# the page token.
|
176
178
|
# @!attribute [rw] filter
|
177
179
|
# @return [::String]
|
178
|
-
# Optional. Filter the partitions returned to the caller using a key value
|
179
|
-
# expression. Supported operators and syntax:
|
180
|
+
# Optional. Filter the partitions returned to the caller using a key value
|
181
|
+
# pair expression. Supported operators and syntax:
|
180
182
|
#
|
181
183
|
# - logic operators: AND, OR
|
182
184
|
# - comparison operators: <, >, >=, <= ,=, !=
|
@@ -267,8 +269,8 @@ module Google
|
|
267
269
|
# Optional. Display name must be shorter than or equal to 256 characters.
|
268
270
|
# @!attribute [rw] description
|
269
271
|
# @return [::String]
|
270
|
-
# Optional. User friendly longer description text. Must be shorter than or
|
271
|
-
# 1024 characters.
|
272
|
+
# Optional. User friendly longer description text. Must be shorter than or
|
273
|
+
# equal to 1024 characters.
|
272
274
|
# @!attribute [r] create_time
|
273
275
|
# @return [::Google::Protobuf::Timestamp]
|
274
276
|
# Output only. The time when the entity was created.
|
@@ -285,15 +287,16 @@ module Google
|
|
285
287
|
# characters.
|
286
288
|
# @!attribute [rw] etag
|
287
289
|
# @return [::String]
|
288
|
-
# Optional. The etag associated with the entity, which can be retrieved with
|
289
|
-
# [GetEntity][] request. Required for update and delete requests.
|
290
|
+
# Optional. The etag associated with the entity, which can be retrieved with
|
291
|
+
# a [GetEntity][] request. Required for update and delete requests.
|
290
292
|
# @!attribute [rw] type
|
291
293
|
# @return [::Google::Cloud::Dataplex::V1::Entity::Type]
|
292
294
|
# Required. Immutable. The type of entity.
|
293
295
|
# @!attribute [rw] asset
|
294
296
|
# @return [::String]
|
295
|
-
# Required. Immutable. The ID of the asset associated with the storage
|
296
|
-
# entity data. The entity must be with in the same
|
297
|
+
# Required. Immutable. The ID of the asset associated with the storage
|
298
|
+
# location containing the entity data. The entity must be with in the same
|
299
|
+
# zone with the asset.
|
297
300
|
# @!attribute [rw] data_path
|
298
301
|
# @return [::String]
|
299
302
|
# Required. Immutable. The storage path of the entity data.
|
@@ -303,9 +306,9 @@ module Google
|
|
303
306
|
# `projects/project_id/datasets/dataset_id/tables/table_id`.
|
304
307
|
# @!attribute [rw] data_path_pattern
|
305
308
|
# @return [::String]
|
306
|
-
# Optional. The set of items within the data path constituting the data in
|
307
|
-
# represented as a glob path.
|
308
|
-
#
|
309
|
+
# Optional. The set of items within the data path constituting the data in
|
310
|
+
# the entity, represented as a glob path. Example:
|
311
|
+
# `gs://bucket/path/to/data/**/*.csv`.
|
309
312
|
# @!attribute [r] catalog_entry
|
310
313
|
# @return [::String]
|
311
314
|
# Output only. The name of the associated Data Catalog entry.
|
@@ -342,12 +345,12 @@ module Google
|
|
342
345
|
# Provides compatibility information for a specific metadata store.
|
343
346
|
# @!attribute [r] compatible
|
344
347
|
# @return [::Boolean]
|
345
|
-
# Output only. Whether the entity is compatible and can be represented in
|
346
|
-
# store.
|
348
|
+
# Output only. Whether the entity is compatible and can be represented in
|
349
|
+
# the metadata store.
|
347
350
|
# @!attribute [r] reason
|
348
351
|
# @return [::String]
|
349
|
-
# Output only. Provides additional detail if the entity is incompatible
|
350
|
-
# metadata store.
|
352
|
+
# Output only. Provides additional detail if the entity is incompatible
|
353
|
+
# with the metadata store.
|
351
354
|
class Compatibility
|
352
355
|
include ::Google::Protobuf::MessageExts
|
353
356
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -377,13 +380,13 @@ module Google
|
|
377
380
|
# The name field in the response retains the encoded format.
|
378
381
|
# @!attribute [rw] values
|
379
382
|
# @return [::Array<::String>]
|
380
|
-
# Required. Immutable. The set of values representing the partition, which
|
381
|
-
# partition schema defined in the parent entity.
|
383
|
+
# Required. Immutable. The set of values representing the partition, which
|
384
|
+
# correspond to the partition schema defined in the parent entity.
|
382
385
|
# @!attribute [rw] location
|
383
386
|
# @return [::String]
|
384
|
-
# Required. Immutable. The location of the entity data within the partition,
|
385
|
-
# `gs://bucket/path/to/entity/key1=value1/key2=value2`.
|
386
|
-
#
|
387
|
+
# Required. Immutable. The location of the entity data within the partition,
|
388
|
+
# for example, `gs://bucket/path/to/entity/key1=value1/key2=value2`. Or
|
389
|
+
# `projects/<project_id>/datasets/<dataset_id>/tables/<table_id>`
|
387
390
|
# @!attribute [rw] etag
|
388
391
|
# @return [::String]
|
389
392
|
# Optional. The etag for this partition.
|
@@ -395,8 +398,8 @@ module Google
|
|
395
398
|
# Schema information describing the structure and layout of the data.
|
396
399
|
# @!attribute [rw] user_managed
|
397
400
|
# @return [::Boolean]
|
398
|
-
# Required. Set to `true` if user-managed or `false` if managed by Dataplex.
|
399
|
-
# default is `false` (managed by Dataplex).
|
401
|
+
# Required. Set to `true` if user-managed or `false` if managed by Dataplex.
|
402
|
+
# The default is `false` (managed by Dataplex).
|
400
403
|
#
|
401
404
|
# - Set to `false`to enable Dataplex discovery to update the schema.
|
402
405
|
# including new data discovery, schema inference, and schema evolution.
|
@@ -414,11 +417,12 @@ module Google
|
|
414
417
|
# **Note:** BigQuery SchemaFields are immutable.
|
415
418
|
# @!attribute [rw] partition_fields
|
416
419
|
# @return [::Array<::Google::Cloud::Dataplex::V1::Schema::PartitionField>]
|
417
|
-
# Optional. The sequence of fields describing the partition structure in
|
418
|
-
# If this field is empty, there are no partitions within the data.
|
420
|
+
# Optional. The sequence of fields describing the partition structure in
|
421
|
+
# entities. If this field is empty, there are no partitions within the data.
|
419
422
|
# @!attribute [rw] partition_style
|
420
423
|
# @return [::Google::Cloud::Dataplex::V1::Schema::PartitionStyle]
|
421
|
-
# Optional. The structure of paths containing partition data within the
|
424
|
+
# Optional. The structure of paths containing partition data within the
|
425
|
+
# entity.
|
422
426
|
class Schema
|
423
427
|
include ::Google::Protobuf::MessageExts
|
424
428
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -431,8 +435,8 @@ module Google
|
|
431
435
|
# and must begin with a letter or underscore.
|
432
436
|
# @!attribute [rw] description
|
433
437
|
# @return [::String]
|
434
|
-
# Optional. User friendly field description. Must be less than or equal to
|
435
|
-
# characters.
|
438
|
+
# Optional. User friendly field description. Must be less than or equal to
|
439
|
+
# 1024 characters.
|
436
440
|
# @!attribute [rw] type
|
437
441
|
# @return [::Google::Cloud::Dataplex::V1::Schema::Type]
|
438
442
|
# Required. The type of field.
|
@@ -453,9 +457,9 @@ module Google
|
|
453
457
|
# Partition fields are immutable.
|
454
458
|
# @!attribute [rw] name
|
455
459
|
# @return [::String]
|
456
|
-
# Required. Partition field name must consist of letters, numbers, and
|
457
|
-
# only, with a maximum of length of 256 characters,
|
458
|
-
#
|
460
|
+
# Required. Partition field name must consist of letters, numbers, and
|
461
|
+
# underscores only, with a maximum of length of 256 characters, and must
|
462
|
+
# begin with a letter or underscore..
|
459
463
|
# @!attribute [rw] type
|
460
464
|
# @return [::Google::Cloud::Dataplex::V1::Schema::Type]
|
461
465
|
# Required. Immutable. The type of field.
|
@@ -546,8 +550,8 @@ module Google
|
|
546
550
|
# Describes the format of the data within its storage location.
|
547
551
|
# @!attribute [r] format
|
548
552
|
# @return [::Google::Cloud::Dataplex::V1::StorageFormat::Format]
|
549
|
-
# Output only. The data format associated with the stored data, which
|
550
|
-
# content type values. The value is inferred from mime type.
|
553
|
+
# Output only. The data format associated with the stored data, which
|
554
|
+
# represents content type values. The value is inferred from mime type.
|
551
555
|
# @!attribute [rw] compression_format
|
552
556
|
# @return [::Google::Cloud::Dataplex::V1::StorageFormat::CompressionFormat]
|
553
557
|
# Optional. The compression type associated with the stored data.
|
@@ -561,6 +565,9 @@ module Google
|
|
561
565
|
# - application/x-avro
|
562
566
|
# - application/x-orc
|
563
567
|
# - application/x-tfrecord
|
568
|
+
# - application/x-parquet+iceberg
|
569
|
+
# - application/x-avro+iceberg
|
570
|
+
# - application/x-orc+iceberg
|
564
571
|
# - application/json
|
565
572
|
# - application/\\{subtypes}
|
566
573
|
# - text/csv
|
@@ -574,6 +581,9 @@ module Google
|
|
574
581
|
# @!attribute [rw] json
|
575
582
|
# @return [::Google::Cloud::Dataplex::V1::StorageFormat::JsonOptions]
|
576
583
|
# Optional. Additional information about CSV formatted data.
|
584
|
+
# @!attribute [rw] iceberg
|
585
|
+
# @return [::Google::Cloud::Dataplex::V1::StorageFormat::IcebergOptions]
|
586
|
+
# Optional. Additional information about iceberg tables.
|
577
587
|
class StorageFormat
|
578
588
|
include ::Google::Protobuf::MessageExts
|
579
589
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -581,12 +591,12 @@ module Google
|
|
581
591
|
# Describes CSV and similar semi-structured data formats.
|
582
592
|
# @!attribute [rw] encoding
|
583
593
|
# @return [::String]
|
584
|
-
# Optional. The character encoding of the data. Accepts "US-ASCII",
|
585
|
-
# "ISO-8859-1". Defaults to UTF-8 if unspecified.
|
594
|
+
# Optional. The character encoding of the data. Accepts "US-ASCII",
|
595
|
+
# "UTF-8", and "ISO-8859-1". Defaults to UTF-8 if unspecified.
|
586
596
|
# @!attribute [rw] header_rows
|
587
597
|
# @return [::Integer]
|
588
|
-
# Optional. The number of rows to interpret as header rows that should be
|
589
|
-
# when reading data rows. Defaults to 0.
|
598
|
+
# Optional. The number of rows to interpret as header rows that should be
|
599
|
+
# skipped when reading data rows. Defaults to 0.
|
590
600
|
# @!attribute [rw] delimiter
|
591
601
|
# @return [::String]
|
592
602
|
# Optional. The delimiter used to separate values. Defaults to ','.
|
@@ -603,13 +613,23 @@ module Google
|
|
603
613
|
# Describes JSON data format.
|
604
614
|
# @!attribute [rw] encoding
|
605
615
|
# @return [::String]
|
606
|
-
# Optional. The character encoding of the data. Accepts "US-ASCII", "UTF-8"
|
607
|
-
# "ISO-8859-1". Defaults to UTF-8 if not specified.
|
616
|
+
# Optional. The character encoding of the data. Accepts "US-ASCII", "UTF-8"
|
617
|
+
# and "ISO-8859-1". Defaults to UTF-8 if not specified.
|
608
618
|
class JsonOptions
|
609
619
|
include ::Google::Protobuf::MessageExts
|
610
620
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
611
621
|
end
|
612
622
|
|
623
|
+
# Describes Iceberg data format.
|
624
|
+
# @!attribute [rw] metadata_location
|
625
|
+
# @return [::String]
|
626
|
+
# Optional. The location of where the iceberg metadata is present, must be
|
627
|
+
# within the table path
|
628
|
+
class IcebergOptions
|
629
|
+
include ::Google::Protobuf::MessageExts
|
630
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
631
|
+
end
|
632
|
+
|
613
633
|
# The specific file format of the data.
|
614
634
|
module Format
|
615
635
|
# Format unspecified.
|
@@ -0,0 +1,96 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
# Copyright 2023 Google LLC
|
4
|
+
#
|
5
|
+
# Licensed under the Apache License, Version 2.0 (the "License");
|
6
|
+
# you may not use this file except in compliance with the License.
|
7
|
+
# You may obtain a copy of the License at
|
8
|
+
#
|
9
|
+
# https://www.apache.org/licenses/LICENSE-2.0
|
10
|
+
#
|
11
|
+
# Unless required by applicable law or agreed to in writing, software
|
12
|
+
# distributed under the License is distributed on an "AS IS" BASIS,
|
13
|
+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
14
|
+
# See the License for the specific language governing permissions and
|
15
|
+
# limitations under the License.
|
16
|
+
|
17
|
+
# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
|
18
|
+
|
19
|
+
|
20
|
+
module Google
|
21
|
+
module Cloud
|
22
|
+
module Dataplex
|
23
|
+
module V1
|
24
|
+
# DataScan scheduling and trigger settings.
|
25
|
+
# @!attribute [rw] on_demand
|
26
|
+
# @return [::Google::Cloud::Dataplex::V1::Trigger::OnDemand]
|
27
|
+
# The scan runs one-time shortly after DataScan Creation.
|
28
|
+
# @!attribute [rw] schedule
|
29
|
+
# @return [::Google::Cloud::Dataplex::V1::Trigger::Schedule]
|
30
|
+
# The scan is scheduled to run periodically.
|
31
|
+
class Trigger
|
32
|
+
include ::Google::Protobuf::MessageExts
|
33
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
34
|
+
|
35
|
+
# The scan runs one-time via RunDataScan API.
|
36
|
+
class OnDemand
|
37
|
+
include ::Google::Protobuf::MessageExts
|
38
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
39
|
+
end
|
40
|
+
|
41
|
+
# The scan is scheduled to run periodically.
|
42
|
+
# @!attribute [rw] cron
|
43
|
+
# @return [::String]
|
44
|
+
# Required. Cron schedule (https://en.wikipedia.org/wiki/Cron) for running
|
45
|
+
# scans periodically.
|
46
|
+
# To explicitly set a timezone to the cron tab, apply a prefix in the
|
47
|
+
# cron tab: "CRON_TZ=$\\{IANA_TIME_ZONE}" or "TZ=$\\{IANA_TIME_ZONE}".
|
48
|
+
# The $\\{IANA_TIME_ZONE} may only be a valid string from IANA time zone
|
49
|
+
# database. For example, "CRON_TZ=America/New_York 1 * * * *", or
|
50
|
+
# "TZ=America/New_York 1 * * * *".
|
51
|
+
# This field is required for Schedule scans.
|
52
|
+
class Schedule
|
53
|
+
include ::Google::Protobuf::MessageExts
|
54
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
55
|
+
end
|
56
|
+
end
|
57
|
+
|
58
|
+
# The data source for DataScan.
|
59
|
+
# @!attribute [rw] entity
|
60
|
+
# @return [::String]
|
61
|
+
# Immutable. The dataplex entity that contains the data for DataScan, of
|
62
|
+
# the form:
|
63
|
+
# `projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}/entities/{entity_id}`.
|
64
|
+
class DataSource
|
65
|
+
include ::Google::Protobuf::MessageExts
|
66
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
67
|
+
end
|
68
|
+
|
69
|
+
# The data scanned during processing (e.g. in incremental DataScan)
|
70
|
+
# @!attribute [rw] incremental_field
|
71
|
+
# @return [::Google::Cloud::Dataplex::V1::ScannedData::IncrementalField]
|
72
|
+
# The range denoted by values of an incremental field
|
73
|
+
class ScannedData
|
74
|
+
include ::Google::Protobuf::MessageExts
|
75
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
76
|
+
|
77
|
+
# A data range denoted by a pair of start/end values of a field.
|
78
|
+
# @!attribute [rw] field
|
79
|
+
# @return [::String]
|
80
|
+
# The field that contains values which monotonically increases over time
|
81
|
+
# (e.g. timestamp).
|
82
|
+
# @!attribute [rw] start
|
83
|
+
# @return [::String]
|
84
|
+
# Value that marks the start of the range
|
85
|
+
# @!attribute [rw] end
|
86
|
+
# @return [::String]
|
87
|
+
# Value that marks the end of the range
|
88
|
+
class IncrementalField
|
89
|
+
include ::Google::Protobuf::MessageExts
|
90
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
91
|
+
end
|
92
|
+
end
|
93
|
+
end
|
94
|
+
end
|
95
|
+
end
|
96
|
+
end
|
@@ -38,8 +38,8 @@ module Google
|
|
38
38
|
# Optional. User friendly display name.
|
39
39
|
# @!attribute [r] uid
|
40
40
|
# @return [::String]
|
41
|
-
# Output only. System generated globally unique ID for the lake. This ID will
|
42
|
-
# different if the lake is deleted and re-created with the same name.
|
41
|
+
# Output only. System generated globally unique ID for the lake. This ID will
|
42
|
+
# be different if the lake is deleted and re-created with the same name.
|
43
43
|
# @!attribute [r] create_time
|
44
44
|
# @return [::Google::Protobuf::Timestamp]
|
45
45
|
# Output only. The time when the lake was created.
|
@@ -57,8 +57,9 @@ module Google
|
|
57
57
|
# Output only. Current state of the lake.
|
58
58
|
# @!attribute [r] service_account
|
59
59
|
# @return [::String]
|
60
|
-
# Output only. Service account associated with this lake. This service
|
61
|
-
# authorized to access or operate on resources managed by the
|
60
|
+
# Output only. Service account associated with this lake. This service
|
61
|
+
# account must be authorized to access or operate on resources managed by the
|
62
|
+
# lake.
|
62
63
|
# @!attribute [rw] metastore
|
63
64
|
# @return [::Google::Cloud::Dataplex::V1::Lake::Metastore]
|
64
65
|
# Optional. Settings to manage lake and Dataproc Metastore service instance
|
@@ -160,8 +161,8 @@ module Google
|
|
160
161
|
# Optional. User friendly display name.
|
161
162
|
# @!attribute [r] uid
|
162
163
|
# @return [::String]
|
163
|
-
# Output only. System generated globally unique ID for the zone. This ID will
|
164
|
-
# different if the zone is deleted and re-created with the same name.
|
164
|
+
# Output only. System generated globally unique ID for the zone. This ID will
|
165
|
+
# be different if the zone is deleted and re-created with the same name.
|
165
166
|
# @!attribute [r] create_time
|
166
167
|
# @return [::Google::Protobuf::Timestamp]
|
167
168
|
# Output only. The time when the zone was created.
|
@@ -182,11 +183,12 @@ module Google
|
|
182
183
|
# Required. Immutable. The type of the zone.
|
183
184
|
# @!attribute [rw] discovery_spec
|
184
185
|
# @return [::Google::Cloud::Dataplex::V1::Zone::DiscoverySpec]
|
185
|
-
# Optional. Specification of the discovery feature applied to data in this
|
186
|
+
# Optional. Specification of the discovery feature applied to data in this
|
187
|
+
# zone.
|
186
188
|
# @!attribute [rw] resource_spec
|
187
189
|
# @return [::Google::Cloud::Dataplex::V1::Zone::ResourceSpec]
|
188
|
-
# Required. Specification of the resources that are referenced by the assets
|
189
|
-
# this zone.
|
190
|
+
# Required. Specification of the resources that are referenced by the assets
|
191
|
+
# within this zone.
|
190
192
|
# @!attribute [r] asset_status
|
191
193
|
# @return [::Google::Cloud::Dataplex::V1::AssetStatus]
|
192
194
|
# Output only. Aggregated status of the underlying assets of the zone.
|
@@ -197,8 +199,8 @@ module Google
|
|
197
199
|
# Settings for resources attached as assets within a zone.
|
198
200
|
# @!attribute [rw] location_type
|
199
201
|
# @return [::Google::Cloud::Dataplex::V1::Zone::ResourceSpec::LocationType]
|
200
|
-
# Required. Immutable. The location type of the resources that are allowed
|
201
|
-
# assets within this zone.
|
202
|
+
# Required. Immutable. The location type of the resources that are allowed
|
203
|
+
# to be attached to the assets within this zone.
|
202
204
|
class ResourceSpec
|
203
205
|
include ::Google::Protobuf::MessageExts
|
204
206
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -222,16 +224,16 @@ module Google
|
|
222
224
|
# Required. Whether discovery is enabled.
|
223
225
|
# @!attribute [rw] include_patterns
|
224
226
|
# @return [::Array<::String>]
|
225
|
-
# Optional. The list of patterns to apply for selecting data to include
|
226
|
-
# discovery if only a subset of the data should considered. For
|
227
|
-
# Storage bucket assets, these are interpreted as glob patterns used
|
228
|
-
# match object names. For BigQuery dataset assets, these are
|
229
|
-
#
|
227
|
+
# Optional. The list of patterns to apply for selecting data to include
|
228
|
+
# during discovery if only a subset of the data should considered. For
|
229
|
+
# Cloud Storage bucket assets, these are interpreted as glob patterns used
|
230
|
+
# to match object names. For BigQuery dataset assets, these are interpreted
|
231
|
+
# as patterns to match table names.
|
230
232
|
# @!attribute [rw] exclude_patterns
|
231
233
|
# @return [::Array<::String>]
|
232
|
-
# Optional. The list of patterns to apply for selecting data to exclude
|
233
|
-
# discovery. For Cloud Storage bucket assets, these are interpreted
|
234
|
-
# glob patterns used to match object names. For BigQuery dataset assets,
|
234
|
+
# Optional. The list of patterns to apply for selecting data to exclude
|
235
|
+
# during discovery. For Cloud Storage bucket assets, these are interpreted
|
236
|
+
# as glob patterns used to match object names. For BigQuery dataset assets,
|
235
237
|
# these are interpreted as patterns to match table names.
|
236
238
|
# @!attribute [rw] csv_options
|
237
239
|
# @return [::Google::Cloud::Dataplex::V1::Zone::DiscoverySpec::CsvOptions]
|
@@ -241,15 +243,15 @@ module Google
|
|
241
243
|
# Optional. Configuration for Json data.
|
242
244
|
# @!attribute [rw] schedule
|
243
245
|
# @return [::String]
|
244
|
-
# Optional. Cron schedule (https://en.wikipedia.org/wiki/Cron) for
|
245
|
-
# discovery periodically. Successive discovery runs must be
|
246
|
-
# least 60 minutes apart.
|
247
|
-
#
|
248
|
-
#
|
249
|
-
#
|
250
|
-
#
|
251
|
-
#
|
252
|
-
#
|
246
|
+
# Optional. Cron schedule (https://en.wikipedia.org/wiki/Cron) for
|
247
|
+
# running discovery periodically. Successive discovery runs must be
|
248
|
+
# scheduled at least 60 minutes apart. The default value is to run
|
249
|
+
# discovery every 60 minutes. To explicitly set a timezone to the cron
|
250
|
+
# tab, apply a prefix in the cron tab: "CRON_TZ=$\\{IANA_TIME_ZONE}" or
|
251
|
+
# TZ=$\\{IANA_TIME_ZONE}". The $\\{IANA_TIME_ZONE} may only be a valid string
|
252
|
+
# from IANA time zone database. For example,
|
253
|
+
# `CRON_TZ=America/New_York 1 * * * *`,
|
254
|
+
# or `TZ=America/New_York 1 * * * *`.
|
253
255
|
class DiscoverySpec
|
254
256
|
include ::Google::Protobuf::MessageExts
|
255
257
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -257,11 +259,12 @@ module Google
|
|
257
259
|
# Describe CSV and similar semi-structured data formats.
|
258
260
|
# @!attribute [rw] header_rows
|
259
261
|
# @return [::Integer]
|
260
|
-
# Optional. The number of rows to interpret as header rows that should be
|
261
|
-
# when reading data rows.
|
262
|
+
# Optional. The number of rows to interpret as header rows that should be
|
263
|
+
# skipped when reading data rows.
|
262
264
|
# @!attribute [rw] delimiter
|
263
265
|
# @return [::String]
|
264
|
-
# Optional. The delimiter being used to separate values. This defaults to
|
266
|
+
# Optional. The delimiter being used to separate values. This defaults to
|
267
|
+
# ','.
|
265
268
|
# @!attribute [rw] encoding
|
266
269
|
# @return [::String]
|
267
270
|
# Optional. The character encoding of the data. The default is UTF-8.
|
@@ -520,8 +523,9 @@ module Google
|
|
520
523
|
# Optional. User friendly display name.
|
521
524
|
# @!attribute [r] uid
|
522
525
|
# @return [::String]
|
523
|
-
# Output only. System generated globally unique ID for the asset. This ID
|
524
|
-
# different if the asset is deleted and re-created with the same
|
526
|
+
# Output only. System generated globally unique ID for the asset. This ID
|
527
|
+
# will be different if the asset is deleted and re-created with the same
|
528
|
+
# name.
|
525
529
|
# @!attribute [r] create_time
|
526
530
|
# @return [::Google::Protobuf::Timestamp]
|
527
531
|
# Output only. The time when the asset was created.
|
@@ -545,16 +549,17 @@ module Google
|
|
545
549
|
# Output only. Status of the resource referenced by this asset.
|
546
550
|
# @!attribute [r] security_status
|
547
551
|
# @return [::Google::Cloud::Dataplex::V1::Asset::SecurityStatus]
|
548
|
-
# Output only. Status of the security policy applied to resource referenced
|
552
|
+
# Output only. Status of the security policy applied to resource referenced
|
553
|
+
# by this asset.
|
549
554
|
# @!attribute [rw] discovery_spec
|
550
555
|
# @return [::Google::Cloud::Dataplex::V1::Asset::DiscoverySpec]
|
551
|
-
# Optional. Specification of the discovery feature applied to data referenced
|
552
|
-
# asset.
|
553
|
-
#
|
554
|
-
# zone.
|
556
|
+
# Optional. Specification of the discovery feature applied to data referenced
|
557
|
+
# by this asset. When this spec is left unset, the asset will use the spec
|
558
|
+
# set on the parent zone.
|
555
559
|
# @!attribute [r] discovery_status
|
556
560
|
# @return [::Google::Cloud::Dataplex::V1::Asset::DiscoveryStatus]
|
557
|
-
# Output only. Status of the discovery feature applied to data referenced by
|
561
|
+
# Output only. Status of the discovery feature applied to data referenced by
|
562
|
+
# this asset.
|
558
563
|
class Asset
|
559
564
|
include ::Google::Protobuf::MessageExts
|
560
565
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -599,16 +604,16 @@ module Google
|
|
599
604
|
# Optional. Whether discovery is enabled.
|
600
605
|
# @!attribute [rw] include_patterns
|
601
606
|
# @return [::Array<::String>]
|
602
|
-
# Optional. The list of patterns to apply for selecting data to include
|
603
|
-
# discovery if only a subset of the data should considered. For
|
604
|
-
# Storage bucket assets, these are interpreted as glob patterns used
|
605
|
-
# match object names. For BigQuery dataset assets, these are interpreted
|
606
|
-
# patterns to match table names.
|
607
|
+
# Optional. The list of patterns to apply for selecting data to include
|
608
|
+
# during discovery if only a subset of the data should considered. For
|
609
|
+
# Cloud Storage bucket assets, these are interpreted as glob patterns used
|
610
|
+
# to match object names. For BigQuery dataset assets, these are interpreted
|
611
|
+
# as patterns to match table names.
|
607
612
|
# @!attribute [rw] exclude_patterns
|
608
613
|
# @return [::Array<::String>]
|
609
|
-
# Optional. The list of patterns to apply for selecting data to exclude
|
610
|
-
# discovery. For Cloud Storage bucket assets, these are interpreted
|
611
|
-
# glob patterns used to match object names. For BigQuery dataset assets,
|
614
|
+
# Optional. The list of patterns to apply for selecting data to exclude
|
615
|
+
# during discovery. For Cloud Storage bucket assets, these are interpreted
|
616
|
+
# as glob patterns used to match object names. For BigQuery dataset assets,
|
612
617
|
# these are interpreted as patterns to match table names.
|
613
618
|
# @!attribute [rw] csv_options
|
614
619
|
# @return [::Google::Cloud::Dataplex::V1::Asset::DiscoverySpec::CsvOptions]
|
@@ -618,15 +623,15 @@ module Google
|
|
618
623
|
# Optional. Configuration for Json data.
|
619
624
|
# @!attribute [rw] schedule
|
620
625
|
# @return [::String]
|
621
|
-
# Optional. Cron schedule (https://en.wikipedia.org/wiki/Cron) for
|
622
|
-
# discovery periodically. Successive discovery runs must be
|
623
|
-
# least 60 minutes apart.
|
624
|
-
#
|
625
|
-
#
|
626
|
-
#
|
627
|
-
#
|
628
|
-
#
|
629
|
-
#
|
626
|
+
# Optional. Cron schedule (https://en.wikipedia.org/wiki/Cron) for
|
627
|
+
# running discovery periodically. Successive discovery runs must be
|
628
|
+
# scheduled at least 60 minutes apart. The default value is to run
|
629
|
+
# discovery every 60 minutes. To explicitly set a timezone to the cron
|
630
|
+
# tab, apply a prefix in the cron tab: "CRON_TZ=$\\{IANA_TIME_ZONE}" or
|
631
|
+
# TZ=$\\{IANA_TIME_ZONE}". The $\\{IANA_TIME_ZONE} may only be a valid string
|
632
|
+
# from IANA time zone database. For example,
|
633
|
+
# `CRON_TZ=America/New_York 1 * * * *`,
|
634
|
+
# or `TZ=America/New_York 1 * * * *`.
|
630
635
|
class DiscoverySpec
|
631
636
|
include ::Google::Protobuf::MessageExts
|
632
637
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -634,11 +639,12 @@ module Google
|
|
634
639
|
# Describe CSV and similar semi-structured data formats.
|
635
640
|
# @!attribute [rw] header_rows
|
636
641
|
# @return [::Integer]
|
637
|
-
# Optional. The number of rows to interpret as header rows that should be
|
638
|
-
# when reading data rows.
|
642
|
+
# Optional. The number of rows to interpret as header rows that should be
|
643
|
+
# skipped when reading data rows.
|
639
644
|
# @!attribute [rw] delimiter
|
640
645
|
# @return [::String]
|
641
|
-
# Optional. The delimiter being used to separate values. This defaults to
|
646
|
+
# Optional. The delimiter being used to separate values. This defaults to
|
647
|
+
# ','.
|
642
648
|
# @!attribute [rw] encoding
|
643
649
|
# @return [::String]
|
644
650
|
# Optional. The character encoding of the data. The default is UTF-8.
|
@@ -669,8 +675,8 @@ module Google
|
|
669
675
|
# Identifies the cloud resource that is referenced by this asset.
|
670
676
|
# @!attribute [rw] name
|
671
677
|
# @return [::String]
|
672
|
-
# Immutable. Relative name of the cloud resource that contains the data
|
673
|
-
# being managed within a lake. For example:
|
678
|
+
# Immutable. Relative name of the cloud resource that contains the data
|
679
|
+
# that is being managed within a lake. For example:
|
674
680
|
# `projects/{project_number}/buckets/{bucket_id}`
|
675
681
|
# `projects/{project_number}/datasets/{dataset_id}`
|
676
682
|
# @!attribute [rw] type
|