google-cloud-dataplex-v1 0.1.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 +7 -0
- data/.yardopts +12 -0
- data/AUTHENTICATION.md +149 -0
- data/LICENSE.md +201 -0
- data/README.md +139 -0
- data/lib/google/cloud/dataplex/v1/dataplex_service/client.rb +3133 -0
- data/lib/google/cloud/dataplex/v1/dataplex_service/credentials.rb +47 -0
- data/lib/google/cloud/dataplex/v1/dataplex_service/operations.rb +767 -0
- data/lib/google/cloud/dataplex/v1/dataplex_service/paths.rb +157 -0
- data/lib/google/cloud/dataplex/v1/dataplex_service.rb +54 -0
- data/lib/google/cloud/dataplex/v1/logs_pb.rb +135 -0
- data/lib/google/cloud/dataplex/v1/metadata_pb.rb +214 -0
- data/lib/google/cloud/dataplex/v1/metadata_service/client.rb +729 -0
- data/lib/google/cloud/dataplex/v1/metadata_service/credentials.rb +47 -0
- data/lib/google/cloud/dataplex/v1/metadata_service/paths.rb +102 -0
- data/lib/google/cloud/dataplex/v1/metadata_service.rb +50 -0
- data/lib/google/cloud/dataplex/v1/metadata_services_pb.rb +52 -0
- data/lib/google/cloud/dataplex/v1/resources_pb.rb +298 -0
- data/lib/google/cloud/dataplex/v1/service_pb.rb +218 -0
- data/lib/google/cloud/dataplex/v1/service_services_pb.rb +102 -0
- data/lib/google/cloud/dataplex/v1/tasks_pb.rb +133 -0
- data/lib/google/cloud/dataplex/v1/version.rb +28 -0
- data/lib/google/cloud/dataplex/v1.rb +39 -0
- data/lib/google-cloud-dataplex-v1.rb +21 -0
- data/proto_docs/README.md +4 -0
- data/proto_docs/google/api/field_behavior.rb +71 -0
- data/proto_docs/google/api/resource.rb +222 -0
- data/proto_docs/google/cloud/dataplex/v1/logs.rb +308 -0
- data/proto_docs/google/cloud/dataplex/v1/metadata.rb +533 -0
- data/proto_docs/google/cloud/dataplex/v1/resources.rb +821 -0
- data/proto_docs/google/cloud/dataplex/v1/service.rb +601 -0
- data/proto_docs/google/cloud/dataplex/v1/tasks.rb +349 -0
- data/proto_docs/google/longrunning/operations.rb +164 -0
- data/proto_docs/google/protobuf/any.rb +141 -0
- data/proto_docs/google/protobuf/duration.rb +98 -0
- data/proto_docs/google/protobuf/empty.rb +36 -0
- data/proto_docs/google/protobuf/field_mask.rb +229 -0
- data/proto_docs/google/protobuf/timestamp.rb +129 -0
- data/proto_docs/google/rpc/status.rb +46 -0
- metadata +231 -0
@@ -0,0 +1,533 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
# Copyright 2022 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
|
+
# List metadata entities request.
|
25
|
+
# @!attribute [rw] parent
|
26
|
+
# @return [::String]
|
27
|
+
# Required. The resource name of the parent zone:
|
28
|
+
# `projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}`.
|
29
|
+
# @!attribute [rw] view
|
30
|
+
# @return [::Google::Cloud::Dataplex::V1::ListEntitiesRequest::EntityView]
|
31
|
+
# Required. Specify the entity view to make a partial list request.
|
32
|
+
# @!attribute [rw] page_size
|
33
|
+
# @return [::Integer]
|
34
|
+
# Optional. Maximum number of entities to return. The service may return fewer than
|
35
|
+
# this value. If unspecified, at most 10 entities will be returned. The
|
36
|
+
# maximum value is 1000; values above 1000 are set to 1000.
|
37
|
+
# @!attribute [rw] page_token
|
38
|
+
# @return [::String]
|
39
|
+
# Optional. Page token received from a previous `ListEntities` call. Provide
|
40
|
+
# this to retrieve the subsequent page. When paginating, all other parameters
|
41
|
+
# provided to `ListEntities` must match the call that provided the
|
42
|
+
# page token.
|
43
|
+
# @!attribute [rw] filter
|
44
|
+
# @return [::String]
|
45
|
+
# Optional. Filter request by name prefix.
|
46
|
+
class ListEntitiesRequest
|
47
|
+
include ::Google::Protobuf::MessageExts
|
48
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
49
|
+
|
50
|
+
# Entity views.
|
51
|
+
module EntityView
|
52
|
+
# The default unset value. The API will default to the FULL view.
|
53
|
+
ENTITY_VIEW_UNSPECIFIED = 0
|
54
|
+
|
55
|
+
# Only list table entities.
|
56
|
+
TABLES = 1
|
57
|
+
|
58
|
+
# Only list fileset entities.
|
59
|
+
FILESETS = 2
|
60
|
+
end
|
61
|
+
end
|
62
|
+
|
63
|
+
# List metadata entities response.
|
64
|
+
# @!attribute [rw] entities
|
65
|
+
# @return [::Array<::Google::Cloud::Dataplex::V1::Entity>]
|
66
|
+
# Entities in the specified parent zone.
|
67
|
+
# @!attribute [rw] next_page_token
|
68
|
+
# @return [::String]
|
69
|
+
# Token to retrieve the next page of results, or empty if there are no
|
70
|
+
# remaining results in the list.
|
71
|
+
class ListEntitiesResponse
|
72
|
+
include ::Google::Protobuf::MessageExts
|
73
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
74
|
+
end
|
75
|
+
|
76
|
+
# Get metadata entity request.
|
77
|
+
# @!attribute [rw] name
|
78
|
+
# @return [::String]
|
79
|
+
# Required. The resource name of the entity:
|
80
|
+
# `projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}/entities/{entity_id}.`
|
81
|
+
# @!attribute [rw] view
|
82
|
+
# @return [::Google::Cloud::Dataplex::V1::GetEntityRequest::EntityView]
|
83
|
+
# Optional. Used to select the subset of entity information to return.
|
84
|
+
# Defaults to `BASIC`.
|
85
|
+
class GetEntityRequest
|
86
|
+
include ::Google::Protobuf::MessageExts
|
87
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
88
|
+
|
89
|
+
# Entity views for get entity partial result.
|
90
|
+
module EntityView
|
91
|
+
# The API will default to the `BASIC` view.
|
92
|
+
ENTITY_VIEW_UNSPECIFIED = 0
|
93
|
+
|
94
|
+
# Minimal view that does not include the schema.
|
95
|
+
BASIC = 1
|
96
|
+
|
97
|
+
# Include basic information and schema.
|
98
|
+
SCHEMA = 2
|
99
|
+
|
100
|
+
# Include everything.
|
101
|
+
FULL = 4
|
102
|
+
end
|
103
|
+
end
|
104
|
+
|
105
|
+
# List metadata partitions request.
|
106
|
+
# @!attribute [rw] parent
|
107
|
+
# @return [::String]
|
108
|
+
# Required. The resource name of the parent entity:
|
109
|
+
# `projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}/entities/{entity_id}`.
|
110
|
+
# @!attribute [rw] page_size
|
111
|
+
# @return [::Integer]
|
112
|
+
# Optional. Maximum number of partitions to return. The service may return fewer than
|
113
|
+
# this value. If unspecified, at most 10 partitions will be returned. The
|
114
|
+
# maximum value is 1000; values above 1000 will be coerced to 1000.
|
115
|
+
# @!attribute [rw] page_token
|
116
|
+
# @return [::String]
|
117
|
+
# Optional. Page token received from a previous `ListPartitions` call. Provide
|
118
|
+
# this to retrieve the subsequent page. When paginating, all other parameters
|
119
|
+
# provided to `ListPartitions` must match the call that provided the
|
120
|
+
# page token.
|
121
|
+
# @!attribute [rw] filter
|
122
|
+
# @return [::String]
|
123
|
+
# Optional. Filter request.
|
124
|
+
class ListPartitionsRequest
|
125
|
+
include ::Google::Protobuf::MessageExts
|
126
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
127
|
+
end
|
128
|
+
|
129
|
+
# List metadata partitions response.
|
130
|
+
# @!attribute [rw] partitions
|
131
|
+
# @return [::Array<::Google::Cloud::Dataplex::V1::Partition>]
|
132
|
+
# Partitions under the specified parent entity.
|
133
|
+
# @!attribute [rw] next_page_token
|
134
|
+
# @return [::String]
|
135
|
+
# Token to retrieve the next page of results, or empty if there are no
|
136
|
+
# remaining results in the list.
|
137
|
+
class ListPartitionsResponse
|
138
|
+
include ::Google::Protobuf::MessageExts
|
139
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
140
|
+
end
|
141
|
+
|
142
|
+
# Get metadata partition request.
|
143
|
+
# @!attribute [rw] name
|
144
|
+
# @return [::String]
|
145
|
+
# Required. The resource name of the partition:
|
146
|
+
# `projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}/entities/{entity_id}/partitions/{partition_id}`.
|
147
|
+
class GetPartitionRequest
|
148
|
+
include ::Google::Protobuf::MessageExts
|
149
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
150
|
+
end
|
151
|
+
|
152
|
+
# Represents tables and fileset metadata contained within a zone.
|
153
|
+
# @!attribute [r] name
|
154
|
+
# @return [::String]
|
155
|
+
# Output only. The resource name of the entity, of the form:
|
156
|
+
# `projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}/entities/{id}`.
|
157
|
+
# @!attribute [rw] display_name
|
158
|
+
# @return [::String]
|
159
|
+
# Optional. User friendly display name.
|
160
|
+
# @!attribute [rw] description
|
161
|
+
# @return [::String]
|
162
|
+
# Optional. User friendly longer description text.
|
163
|
+
# @!attribute [r] create_time
|
164
|
+
# @return [::Google::Protobuf::Timestamp]
|
165
|
+
# Output only. The time when the entity was created.
|
166
|
+
# @!attribute [r] update_time
|
167
|
+
# @return [::Google::Protobuf::Timestamp]
|
168
|
+
# Output only. The time when the entity was last updated.
|
169
|
+
# @!attribute [rw] id
|
170
|
+
# @return [::String]
|
171
|
+
# Required. A user-provided entity ID. It is mutable, and will be used as the
|
172
|
+
# published table name. Specifying a new ID in an update entity
|
173
|
+
# request will override the existing value.
|
174
|
+
# @!attribute [rw] etag
|
175
|
+
# @return [::String]
|
176
|
+
# Optional. The etag for this entity.
|
177
|
+
# Required for update requests. It must match the server's etag.
|
178
|
+
# @!attribute [rw] type
|
179
|
+
# @return [::Google::Cloud::Dataplex::V1::Entity::Type]
|
180
|
+
# Required. The type of entity.
|
181
|
+
# @!attribute [rw] asset
|
182
|
+
# @return [::String]
|
183
|
+
# Required. The name of the asset associated with the storage location containing the
|
184
|
+
# entity data.
|
185
|
+
# @!attribute [rw] data_path
|
186
|
+
# @return [::String]
|
187
|
+
# Required. Immutable. The storage path of the entity data.
|
188
|
+
# For Cloud Storage data, this is the fully-qualified path to the entity,
|
189
|
+
# such as `gs://bucket/path/to/data`. For BigQuery data, this is the name of
|
190
|
+
# the table resource, such as
|
191
|
+
# `projects/project_id/datasets/dataset_id/tables/table_id`.
|
192
|
+
# @!attribute [rw] data_path_pattern
|
193
|
+
# @return [::String]
|
194
|
+
# Optional. The set of items within the data path constituting the data in the entity,
|
195
|
+
# represented as a glob path.
|
196
|
+
# Example: `gs://bucket/path/to/data/**/*.csv`.
|
197
|
+
# @!attribute [r] catalog_entry
|
198
|
+
# @return [::String]
|
199
|
+
# Output only. The name of the associated Data Catalog entry.
|
200
|
+
# @!attribute [rw] system
|
201
|
+
# @return [::Google::Cloud::Dataplex::V1::StorageSystem]
|
202
|
+
# Required. Identifies the storage system of the entity data.
|
203
|
+
# @!attribute [rw] format
|
204
|
+
# @return [::Google::Cloud::Dataplex::V1::StorageFormat]
|
205
|
+
# Required. Identifies the storage format of the entity data.
|
206
|
+
# It does not apply to entities with data stored in BigQuery.
|
207
|
+
# @!attribute [r] compatibility
|
208
|
+
# @return [::Google::Cloud::Dataplex::V1::Entity::CompatibilityStatus]
|
209
|
+
# Output only. Metadata stores that the entity is compatible with.
|
210
|
+
# @!attribute [rw] schema
|
211
|
+
# @return [::Google::Cloud::Dataplex::V1::Schema]
|
212
|
+
# Required. The description of the data structure and layout.
|
213
|
+
# The schema is not included in list responses. It is only included in
|
214
|
+
# `SCHEMA` and `FULL` entity views of a `GetEntity` response.
|
215
|
+
class Entity
|
216
|
+
include ::Google::Protobuf::MessageExts
|
217
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
218
|
+
|
219
|
+
# Provides compatibility information for various metadata stores.
|
220
|
+
# @!attribute [r] hive_metastore
|
221
|
+
# @return [::Google::Cloud::Dataplex::V1::Entity::CompatibilityStatus::Compatibility]
|
222
|
+
# Output only. Whether this entity is compatible with Hive Metastore.
|
223
|
+
# @!attribute [r] bigquery
|
224
|
+
# @return [::Google::Cloud::Dataplex::V1::Entity::CompatibilityStatus::Compatibility]
|
225
|
+
# Output only. Whether this entity is compatible with BigQuery.
|
226
|
+
class CompatibilityStatus
|
227
|
+
include ::Google::Protobuf::MessageExts
|
228
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
229
|
+
|
230
|
+
# Provides compatibility information for a specific metadata store.
|
231
|
+
# @!attribute [r] compatible
|
232
|
+
# @return [::Boolean]
|
233
|
+
# Output only. Whether the entity is compatible and can be represented in the metadata
|
234
|
+
# store.
|
235
|
+
# @!attribute [r] reason
|
236
|
+
# @return [::String]
|
237
|
+
# Output only. Provides additional detail if the entity is incompatible with the
|
238
|
+
# metadata store.
|
239
|
+
class Compatibility
|
240
|
+
include ::Google::Protobuf::MessageExts
|
241
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
242
|
+
end
|
243
|
+
end
|
244
|
+
|
245
|
+
# The type of entity.
|
246
|
+
module Type
|
247
|
+
# Type unspecified.
|
248
|
+
TYPE_UNSPECIFIED = 0
|
249
|
+
|
250
|
+
# Structured and semi-structured data.
|
251
|
+
TABLE = 1
|
252
|
+
|
253
|
+
# Unstructured data.
|
254
|
+
FILESET = 2
|
255
|
+
end
|
256
|
+
end
|
257
|
+
|
258
|
+
# Represents partition metadata contained within entity instances.
|
259
|
+
# @!attribute [r] name
|
260
|
+
# @return [::String]
|
261
|
+
# Output only. The resource name of the partition, of the form:
|
262
|
+
# `projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}/entities/{entity_id}/partitions/{partition_id}`.
|
263
|
+
# \\{partition_id} is a generated unique ID.
|
264
|
+
# @!attribute [rw] values
|
265
|
+
# @return [::Array<::String>]
|
266
|
+
# Required. Immutable. The set of values representing the partition, which correspond to the
|
267
|
+
# partition schema defined in the parent entity.
|
268
|
+
# @!attribute [rw] location
|
269
|
+
# @return [::String]
|
270
|
+
# Required. Immutable. The location of the entity data within the partition, for example,
|
271
|
+
# `gs://bucket/path/to/entity/key1=value1/key2=value2`.
|
272
|
+
# @!attribute [rw] etag
|
273
|
+
# @return [::String]
|
274
|
+
# Optional. The etag for this partition.
|
275
|
+
# Required for update requests. It must match the server's etag.
|
276
|
+
class Partition
|
277
|
+
include ::Google::Protobuf::MessageExts
|
278
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
279
|
+
end
|
280
|
+
|
281
|
+
# Schema information describing the structure and layout of the data.
|
282
|
+
# @!attribute [rw] user_managed
|
283
|
+
# @return [::Boolean]
|
284
|
+
# Required. Whether the schema is user-managed or managed by the service. User-managed
|
285
|
+
# schemas are not automatically updated by discovery jobs.
|
286
|
+
# @!attribute [rw] fields
|
287
|
+
# @return [::Array<::Google::Cloud::Dataplex::V1::Schema::SchemaField>]
|
288
|
+
# Optional. The sequence of fields describing data in table entities.
|
289
|
+
# @!attribute [rw] partition_fields
|
290
|
+
# @return [::Array<::Google::Cloud::Dataplex::V1::Schema::PartitionField>]
|
291
|
+
# Optional. The sequence of fields describing the partition structure in entities.
|
292
|
+
# If this field is empty, there are no partitions within the data.
|
293
|
+
# @!attribute [rw] partition_style
|
294
|
+
# @return [::Google::Cloud::Dataplex::V1::Schema::PartitionStyle]
|
295
|
+
# Optional. The structure of paths containing partition data within the entity.
|
296
|
+
class Schema
|
297
|
+
include ::Google::Protobuf::MessageExts
|
298
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
299
|
+
|
300
|
+
# Represents a column field within a table schema.
|
301
|
+
# @!attribute [rw] name
|
302
|
+
# @return [::String]
|
303
|
+
# Required. The name of the field.
|
304
|
+
# @!attribute [rw] description
|
305
|
+
# @return [::String]
|
306
|
+
# Optional. User friendly field description.
|
307
|
+
# @!attribute [rw] type
|
308
|
+
# @return [::Google::Cloud::Dataplex::V1::Schema::Type]
|
309
|
+
# Required. The type of field.
|
310
|
+
# @!attribute [rw] mode
|
311
|
+
# @return [::Google::Cloud::Dataplex::V1::Schema::Mode]
|
312
|
+
# Required. Additional field semantics.
|
313
|
+
# @!attribute [rw] fields
|
314
|
+
# @return [::Array<::Google::Cloud::Dataplex::V1::Schema::SchemaField>]
|
315
|
+
# Optional. Any nested field for complex types.
|
316
|
+
class SchemaField
|
317
|
+
include ::Google::Protobuf::MessageExts
|
318
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
319
|
+
end
|
320
|
+
|
321
|
+
# Represents a key field within the entity's partition structure.
|
322
|
+
# @!attribute [rw] name
|
323
|
+
# @return [::String]
|
324
|
+
# Required. The name of the field.
|
325
|
+
# @!attribute [rw] type
|
326
|
+
# @return [::Google::Cloud::Dataplex::V1::Schema::Type]
|
327
|
+
# Required. The type of field.
|
328
|
+
class PartitionField
|
329
|
+
include ::Google::Protobuf::MessageExts
|
330
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
331
|
+
end
|
332
|
+
|
333
|
+
# Type information for fields in schemas and partition schemas.
|
334
|
+
module Type
|
335
|
+
# SchemaType unspecified.
|
336
|
+
TYPE_UNSPECIFIED = 0
|
337
|
+
|
338
|
+
# Boolean field.
|
339
|
+
BOOLEAN = 1
|
340
|
+
|
341
|
+
# Single byte numeric field.
|
342
|
+
BYTE = 2
|
343
|
+
|
344
|
+
# 16-bit numeric field.
|
345
|
+
INT16 = 3
|
346
|
+
|
347
|
+
# 32-bit numeric field.
|
348
|
+
INT32 = 4
|
349
|
+
|
350
|
+
# 64-bit numeric field.
|
351
|
+
INT64 = 5
|
352
|
+
|
353
|
+
# Floating point numeric field.
|
354
|
+
FLOAT = 6
|
355
|
+
|
356
|
+
# Double precision numeric field.
|
357
|
+
DOUBLE = 7
|
358
|
+
|
359
|
+
# Real value numeric field.
|
360
|
+
DECIMAL = 8
|
361
|
+
|
362
|
+
# Sequence of characters field.
|
363
|
+
STRING = 9
|
364
|
+
|
365
|
+
# Sequence of bytes field.
|
366
|
+
BINARY = 10
|
367
|
+
|
368
|
+
# Date and time field.
|
369
|
+
TIMESTAMP = 11
|
370
|
+
|
371
|
+
# Date field.
|
372
|
+
DATE = 12
|
373
|
+
|
374
|
+
# Time field.
|
375
|
+
TIME = 13
|
376
|
+
|
377
|
+
# Structured field. Nested fields that define the structure of the map.
|
378
|
+
# If all nested fields are nullable, this field represents a union.
|
379
|
+
RECORD = 14
|
380
|
+
|
381
|
+
# Null field that does not have values.
|
382
|
+
NULL = 100
|
383
|
+
end
|
384
|
+
|
385
|
+
# Additional qualifiers to define field semantics.
|
386
|
+
module Mode
|
387
|
+
# Mode unspecified.
|
388
|
+
MODE_UNSPECIFIED = 0
|
389
|
+
|
390
|
+
# The field has required semantics.
|
391
|
+
REQUIRED = 1
|
392
|
+
|
393
|
+
# The field has optional semantics, and may be null.
|
394
|
+
NULLABLE = 2
|
395
|
+
|
396
|
+
# The field has repeated (0 or more) semantics, and is a list of values.
|
397
|
+
REPEATED = 3
|
398
|
+
end
|
399
|
+
|
400
|
+
# The structure of paths within the entity, which represent partitions.
|
401
|
+
module PartitionStyle
|
402
|
+
# PartitionStyle unspecified
|
403
|
+
PARTITION_STYLE_UNSPECIFIED = 0
|
404
|
+
|
405
|
+
# Partitions are hive-compatible.
|
406
|
+
# Examples: `gs://bucket/path/to/table/dt=2019-10-31/lang=en`,
|
407
|
+
# `gs://bucket/path/to/table/dt=2019-10-31/lang=en/late`.
|
408
|
+
HIVE_COMPATIBLE = 1
|
409
|
+
end
|
410
|
+
end
|
411
|
+
|
412
|
+
# Describes the format of the data within its storage location.
|
413
|
+
# @!attribute [r] format
|
414
|
+
# @return [::Google::Cloud::Dataplex::V1::StorageFormat::Format]
|
415
|
+
# Output only. The data format associated with the stored data, which represents
|
416
|
+
# content type values.
|
417
|
+
# @!attribute [rw] compression_format
|
418
|
+
# @return [::Google::Cloud::Dataplex::V1::StorageFormat::CompressionFormat]
|
419
|
+
# Optional. The compression type associated with the stored data.
|
420
|
+
# If unspecified, the data is uncompressed.
|
421
|
+
# @!attribute [rw] mime_type
|
422
|
+
# @return [::String]
|
423
|
+
# Required. The mime type descriptor for the data. This field is valid for formats
|
424
|
+
# other than `UNKNOWN` and `MIXED`.
|
425
|
+
# @!attribute [rw] csv
|
426
|
+
# @return [::Google::Cloud::Dataplex::V1::StorageFormat::CsvOptions]
|
427
|
+
# Optional. Additional information about CSV formatted data.
|
428
|
+
# @!attribute [rw] json
|
429
|
+
# @return [::Google::Cloud::Dataplex::V1::StorageFormat::JsonOptions]
|
430
|
+
# Optional. Additional information about CSV formatted data.
|
431
|
+
class StorageFormat
|
432
|
+
include ::Google::Protobuf::MessageExts
|
433
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
434
|
+
|
435
|
+
# Describes CSV and similar semi-structured data formats.
|
436
|
+
# @!attribute [rw] encoding
|
437
|
+
# @return [::String]
|
438
|
+
# Optional. The character encoding of the data. The default is UTF-8.
|
439
|
+
# @!attribute [rw] header_rows
|
440
|
+
# @return [::Integer]
|
441
|
+
# Optional. The number of rows to interpret as header rows that should be skipped
|
442
|
+
# when reading data rows.
|
443
|
+
# @!attribute [rw] delimiter
|
444
|
+
# @return [::String]
|
445
|
+
# Optional. The delimiter used to separate values. Defaults to ','.
|
446
|
+
# @!attribute [rw] quote
|
447
|
+
# @return [::String]
|
448
|
+
# Optional. The character used to quote column values. Defaults to empty,
|
449
|
+
# implying unquoted data.
|
450
|
+
class CsvOptions
|
451
|
+
include ::Google::Protobuf::MessageExts
|
452
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
453
|
+
end
|
454
|
+
|
455
|
+
# Describes JSON data format.
|
456
|
+
# @!attribute [rw] encoding
|
457
|
+
# @return [::String]
|
458
|
+
# Optional. The character encoding of the data. The default is UTF-8.
|
459
|
+
class JsonOptions
|
460
|
+
include ::Google::Protobuf::MessageExts
|
461
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
462
|
+
end
|
463
|
+
|
464
|
+
# The specific file format of the data.
|
465
|
+
module Format
|
466
|
+
# Format unspecified.
|
467
|
+
FORMAT_UNSPECIFIED = 0
|
468
|
+
|
469
|
+
# Parquet-formatted structured data.
|
470
|
+
PARQUET = 1
|
471
|
+
|
472
|
+
# Avro-formatted structured data.
|
473
|
+
AVRO = 2
|
474
|
+
|
475
|
+
# Orc-formatted structured data.
|
476
|
+
ORC = 3
|
477
|
+
|
478
|
+
# Csv-formatted semi-structured data.
|
479
|
+
CSV = 100
|
480
|
+
|
481
|
+
# Json-formatted semi-structured data.
|
482
|
+
JSON = 101
|
483
|
+
|
484
|
+
# Image data formats (such as jpg and png).
|
485
|
+
IMAGE = 200
|
486
|
+
|
487
|
+
# Audio data formats (such as mp3 and wav).
|
488
|
+
AUDIO = 201
|
489
|
+
|
490
|
+
# Video data formats (such as mp4 and mpg).
|
491
|
+
VIDEO = 202
|
492
|
+
|
493
|
+
# Textual data formats (such as txt and xml).
|
494
|
+
TEXT = 203
|
495
|
+
|
496
|
+
# TensorFlow record format.
|
497
|
+
TFRECORD = 204
|
498
|
+
|
499
|
+
# Data that doesn't match a specific format.
|
500
|
+
OTHER = 1000
|
501
|
+
|
502
|
+
# Data of an unknown format.
|
503
|
+
UNKNOWN = 1001
|
504
|
+
end
|
505
|
+
|
506
|
+
# The specific compressed file format of the data.
|
507
|
+
module CompressionFormat
|
508
|
+
# CompressionFormat unspecified. Implies uncompressed data.
|
509
|
+
COMPRESSION_FORMAT_UNSPECIFIED = 0
|
510
|
+
|
511
|
+
# GZip compressed set of files.
|
512
|
+
GZIP = 2
|
513
|
+
|
514
|
+
# BZip2 compressed set of files.
|
515
|
+
BZIP2 = 3
|
516
|
+
end
|
517
|
+
end
|
518
|
+
|
519
|
+
# Identifies the cloud system that manages the data storage.
|
520
|
+
module StorageSystem
|
521
|
+
# Storage system unspecified.
|
522
|
+
STORAGE_SYSTEM_UNSPECIFIED = 0
|
523
|
+
|
524
|
+
# The entity data is contained within a Cloud Storage bucket.
|
525
|
+
CLOUD_STORAGE = 1
|
526
|
+
|
527
|
+
# The entity data is contained within a BigQuery dataset.
|
528
|
+
BIGQUERY = 2
|
529
|
+
end
|
530
|
+
end
|
531
|
+
end
|
532
|
+
end
|
533
|
+
end
|