google-cloud-dataplex-v1 0.5.0 → 0.5.1

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.
@@ -0,0 +1,71 @@
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 Api
22
+ # The launch stage as defined by [Google Cloud Platform
23
+ # Launch Stages](https://cloud.google.com/terms/launch-stages).
24
+ module LaunchStage
25
+ # Do not use this default value.
26
+ LAUNCH_STAGE_UNSPECIFIED = 0
27
+
28
+ # The feature is not yet implemented. Users can not use it.
29
+ UNIMPLEMENTED = 6
30
+
31
+ # Prelaunch features are hidden from users and are only visible internally.
32
+ PRELAUNCH = 7
33
+
34
+ # Early Access features are limited to a closed group of testers. To use
35
+ # these features, you must sign up in advance and sign a Trusted Tester
36
+ # agreement (which includes confidentiality provisions). These features may
37
+ # be unstable, changed in backward-incompatible ways, and are not
38
+ # guaranteed to be released.
39
+ EARLY_ACCESS = 1
40
+
41
+ # Alpha is a limited availability test for releases before they are cleared
42
+ # for widespread use. By Alpha, all significant design issues are resolved
43
+ # and we are in the process of verifying functionality. Alpha customers
44
+ # need to apply for access, agree to applicable terms, and have their
45
+ # projects allowlisted. Alpha releases don't have to be feature complete,
46
+ # no SLAs are provided, and there are no technical support obligations, but
47
+ # they will be far enough along that customers can actually use them in
48
+ # test environments or for limited-use tests -- just like they would in
49
+ # normal production cases.
50
+ ALPHA = 2
51
+
52
+ # Beta is the point at which we are ready to open a release for any
53
+ # customer to use. There are no SLA or technical support obligations in a
54
+ # Beta release. Products will be complete from a feature perspective, but
55
+ # may have some open outstanding issues. Beta releases are suitable for
56
+ # limited production use cases.
57
+ BETA = 3
58
+
59
+ # GA features are open to all developers and are considered stable and
60
+ # fully qualified for production use.
61
+ GA = 4
62
+
63
+ # Deprecated features are scheduled to be shut down and removed. For more
64
+ # information, see the "Deprecation Policy" section of our [Terms of
65
+ # Service](https://cloud.google.com/terms/)
66
+ # and the [Google Cloud Platform Subject to the Deprecation
67
+ # Policy](https://cloud.google.com/terms/deprecation) documentation.
68
+ DEPRECATED = 5
69
+ end
70
+ end
71
+ end
@@ -32,8 +32,9 @@ module Google
32
32
  # Optional. User friendly display name.
33
33
  # @!attribute [r] uid
34
34
  # @return [::String]
35
- # Output only. System generated globally unique ID for the environment. This ID will be
36
- # different if the environment is deleted and re-created with the same name.
35
+ # Output only. System generated globally unique ID for the environment. This
36
+ # ID will be different if the environment is deleted and re-created with the
37
+ # same name.
37
38
  # @!attribute [r] create_time
38
39
  # @return [::Google::Protobuf::Timestamp]
39
40
  # Output only. Environment creation time.
@@ -60,7 +61,8 @@ module Google
60
61
  # Output only. Status of sessions created for this environment.
61
62
  # @!attribute [r] endpoints
62
63
  # @return [::Google::Cloud::Dataplex::V1::Environment::Endpoints]
63
- # Output only. URI Endpoints to access sessions associated with the Environment.
64
+ # Output only. URI Endpoints to access sessions associated with the
65
+ # Environment.
64
66
  class Environment
65
67
  include ::Google::Protobuf::MessageExts
66
68
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -71,7 +73,8 @@ module Google
71
73
  # Optional. Compute resources needed for analyze interactive workloads.
72
74
  # @!attribute [rw] os_image
73
75
  # @return [::Google::Cloud::Dataplex::V1::Environment::InfrastructureSpec::OsImageRuntime]
74
- # Required. Software Runtime Configuration for analyze interactive workloads.
76
+ # Required. Software Runtime Configuration for analyze interactive
77
+ # workloads.
75
78
  class InfrastructureSpec
76
79
  include ::Google::Protobuf::MessageExts
77
80
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -82,7 +85,8 @@ module Google
82
85
  # Optional. Size in GB of the disk. Default is 100 GB.
83
86
  # @!attribute [rw] node_count
84
87
  # @return [::Integer]
85
- # Optional. Total number of nodes in the sessions created for this environment.
88
+ # Optional. Total number of nodes in the sessions created for this
89
+ # environment.
86
90
  # @!attribute [rw] max_node_count
87
91
  # @return [::Integer]
88
92
  # Optional. Max configurable nodes.
@@ -108,10 +112,10 @@ module Google
108
112
  # For example, gs://bucket-name/my/path/to/lib.tar.gz
109
113
  # @!attribute [rw] properties
110
114
  # @return [::Google::Protobuf::Map{::String => ::String}]
111
- # Optional. Spark properties to provide configuration for use in sessions created
112
- # for this environment. The properties to set on daemon config files.
113
- # Property keys are specified in `prefix:property` format.
114
- # The prefix must be "spark".
115
+ # Optional. Spark properties to provide configuration for use in sessions
116
+ # created for this environment. The properties to set on daemon config
117
+ # files. Property keys are specified in `prefix:property` format. The
118
+ # prefix must be "spark".
115
119
  class OsImageRuntime
116
120
  include ::Google::Protobuf::MessageExts
117
121
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -133,11 +137,11 @@ module Google
133
137
  # auto-terminated at the end of this period.
134
138
  # @!attribute [rw] enable_fast_startup
135
139
  # @return [::Boolean]
136
- # Optional. If True, this causes sessions to be pre-created and available for faster
137
- # startup to enable interactive exploration use-cases. This defaults to
138
- # False to avoid additional billed charges.
139
- # These can only be set to True for the environment with name set to
140
- # "default", and with default configuration.
140
+ # Optional. If True, this causes sessions to be pre-created and available
141
+ # for faster startup to enable interactive exploration use-cases. This
142
+ # defaults to False to avoid additional billed charges. These can only be
143
+ # set to True for the environment with name set to "default", and with
144
+ # default configuration.
141
145
  class SessionSpec
142
146
  include ::Google::Protobuf::MessageExts
143
147
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -145,8 +149,8 @@ module Google
145
149
 
146
150
  # @!attribute [r] active
147
151
  # @return [::Boolean]
148
- # Output only. Queries over sessions to mark whether the environment is currently
149
- # active or not
152
+ # Output only. Queries over sessions to mark whether the environment is
153
+ # currently active or not
150
154
  class SessionStatus
151
155
  include ::Google::Protobuf::MessageExts
152
156
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -180,13 +184,14 @@ module Google
180
184
  # projects/\\{project_id}/locations/\\{location_id}/lakes/\\{lake_id}/content/\\{content_id}
181
185
  # @!attribute [r] uid
182
186
  # @return [::String]
183
- # Output only. System generated globally unique ID for the content. This ID will be
184
- # different if the content is deleted and re-created with the same name.
187
+ # Output only. System generated globally unique ID for the content. This ID
188
+ # will be different if the content is deleted and re-created with the same
189
+ # name.
185
190
  # @!attribute [rw] path
186
191
  # @return [::String]
187
- # Required. The path for the Content file, represented as directory structure.
188
- # Unique within a lake.
189
- # Limited to alphanumerics, hyphens, underscores, dots and slashes.
192
+ # Required. The path for the Content file, represented as directory
193
+ # structure. Unique within a lake. Limited to alphanumerics, hyphens,
194
+ # underscores, dots and slashes.
190
195
  # @!attribute [r] create_time
191
196
  # @return [::Google::Protobuf::Timestamp]
192
197
  # Output only. Content creation time.
@@ -72,13 +72,13 @@ module Google
72
72
  # projects/\\{project_id}/locations/\\{location_id}/lakes/\\{lake_id}
73
73
  # @!attribute [rw] page_size
74
74
  # @return [::Integer]
75
- # Optional. Maximum number of content to return. The service may return fewer than
76
- # this value. If unspecified, at most 10 content will be returned. The
75
+ # Optional. Maximum number of content to return. The service may return fewer
76
+ # than this value. If unspecified, at most 10 content will be returned. The
77
77
  # maximum value is 1000; values above 1000 will be coerced to 1000.
78
78
  # @!attribute [rw] page_token
79
79
  # @return [::String]
80
- # Optional. Page token received from a previous `ListContent` call. Provide this
81
- # to retrieve the subsequent page. When paginating, all other parameters
80
+ # Optional. Page token received from a previous `ListContent` call. Provide
81
+ # this to retrieve the subsequent page. When paginating, all other parameters
82
82
  # provided to `ListContent` must match the call that provided the page
83
83
  # token.
84
84
  # @!attribute [rw] filter
@@ -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 a
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 fewer than
82
- # this value. If unspecified, 100 entities will be returned by default. The
83
- # maximum value is 500; larger values will will be truncated to 500.
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 the
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 fewer than
168
- # this value. If unspecified, 100 partitions will be returned by default. The
169
- # maximum page size is 500; larger values will will be truncated to 500.
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. Provide
173
- # this to retrieve the subsequent page. When paginating, all other parameters
174
- # provided to `ListPartitions` must match the call that provided the
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 pair
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 equal to
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 a
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 location containing the
296
- # entity data. The entity must be with in the same zone with the asset.
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 the entity,
307
- # represented as a glob path.
308
- # Example: `gs://bucket/path/to/data/**/*.csv`.
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 the metadata
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 with the
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 correspond to the
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, for example,
385
- # `gs://bucket/path/to/entity/key1=value1/key2=value2`.
386
- # Or `projects/<project_id>/datasets/<dataset_id>/tables/<table_id>`
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. The
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 entities.
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 entity.
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 1024
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 underscores
457
- # only, with a maximum of length of 256 characters,
458
- # and must begin with a letter or underscore..
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 represents
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.
@@ -581,12 +585,12 @@ module Google
581
585
  # Describes CSV and similar semi-structured data formats.
582
586
  # @!attribute [rw] encoding
583
587
  # @return [::String]
584
- # Optional. The character encoding of the data. Accepts "US-ASCII", "UTF-8", and
585
- # "ISO-8859-1". Defaults to UTF-8 if unspecified.
588
+ # Optional. The character encoding of the data. Accepts "US-ASCII",
589
+ # "UTF-8", and "ISO-8859-1". Defaults to UTF-8 if unspecified.
586
590
  # @!attribute [rw] header_rows
587
591
  # @return [::Integer]
588
- # Optional. The number of rows to interpret as header rows that should be skipped
589
- # when reading data rows. Defaults to 0.
592
+ # Optional. The number of rows to interpret as header rows that should be
593
+ # skipped when reading data rows. Defaults to 0.
590
594
  # @!attribute [rw] delimiter
591
595
  # @return [::String]
592
596
  # Optional. The delimiter used to separate values. Defaults to ','.
@@ -603,8 +607,8 @@ module Google
603
607
  # Describes JSON data format.
604
608
  # @!attribute [rw] encoding
605
609
  # @return [::String]
606
- # Optional. The character encoding of the data. Accepts "US-ASCII", "UTF-8" and
607
- # "ISO-8859-1". Defaults to UTF-8 if not specified.
610
+ # Optional. The character encoding of the data. Accepts "US-ASCII", "UTF-8"
611
+ # and "ISO-8859-1". Defaults to UTF-8 if not specified.
608
612
  class JsonOptions
609
613
  include ::Google::Protobuf::MessageExts
610
614
  extend ::Google::Protobuf::MessageExts::ClassMethods