google-cloud-dataplex-v1 1.0.1 → 1.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 +4 -4
- data/lib/google/cloud/dataplex/v1/bindings_override.rb +120 -0
- data/lib/google/cloud/dataplex/v1/catalog_pb.rb +17 -1
- data/lib/google/cloud/dataplex/v1/catalog_service/client.rb +585 -121
- data/lib/google/cloud/dataplex/v1/catalog_service/operations.rb +3 -10
- data/lib/google/cloud/dataplex/v1/catalog_service/paths.rb +19 -0
- data/lib/google/cloud/dataplex/v1/catalog_service/rest/client.rb +556 -121
- data/lib/google/cloud/dataplex/v1/catalog_service/rest/operations.rb +32 -10
- data/lib/google/cloud/dataplex/v1/catalog_service/rest/service_stub.rb +238 -0
- data/lib/google/cloud/dataplex/v1/catalog_service/rest.rb +4 -4
- data/lib/google/cloud/dataplex/v1/catalog_service.rb +4 -4
- data/lib/google/cloud/dataplex/v1/catalog_services_pb.rb +44 -20
- data/lib/google/cloud/dataplex/v1/data_discovery_pb.rb +52 -0
- data/lib/google/cloud/dataplex/v1/data_quality_pb.rb +1 -1
- data/lib/google/cloud/dataplex/v1/data_scan_service/operations.rb +3 -10
- data/lib/google/cloud/dataplex/v1/data_scan_service/paths.rb +36 -0
- data/lib/google/cloud/dataplex/v1/data_scan_service/rest/operations.rb +32 -10
- data/lib/google/cloud/dataplex/v1/data_taxonomy_service/operations.rb +3 -10
- data/lib/google/cloud/dataplex/v1/data_taxonomy_service/rest/operations.rb +32 -10
- data/lib/google/cloud/dataplex/v1/dataplex_service/operations.rb +3 -10
- data/lib/google/cloud/dataplex/v1/dataplex_service/rest/operations.rb +32 -10
- data/lib/google/cloud/dataplex/v1/datascans_pb.rb +3 -1
- data/lib/google/cloud/dataplex/v1/logs_pb.rb +3 -1
- data/lib/google/cloud/dataplex/v1/version.rb +1 -1
- data/proto_docs/google/api/client.rb +20 -0
- data/proto_docs/google/api/field_info.rb +88 -0
- data/proto_docs/google/cloud/dataplex/v1/catalog.rb +710 -234
- data/proto_docs/google/cloud/dataplex/v1/data_discovery.rb +156 -0
- data/proto_docs/google/cloud/dataplex/v1/data_profile.rb +4 -4
- data/proto_docs/google/cloud/dataplex/v1/data_quality.rb +7 -2
- data/proto_docs/google/cloud/dataplex/v1/datascans.rb +30 -12
- data/proto_docs/google/cloud/dataplex/v1/logs.rb +51 -1
- data/proto_docs/google/cloud/dataplex/v1/tasks.rb +3 -4
- data/proto_docs/google/longrunning/operations.rb +19 -14
- metadata +6 -3
@@ -21,17 +21,17 @@ module Google
|
|
21
21
|
module Cloud
|
22
22
|
module Dataplex
|
23
23
|
module V1
|
24
|
-
#
|
25
|
-
# JSON-schema for a given Entry,
|
24
|
+
# AspectType is a template for creating Aspects, and represents the
|
25
|
+
# JSON-schema for a given Entry, for example, BigQuery Table Schema.
|
26
26
|
# @!attribute [r] name
|
27
27
|
# @return [::String]
|
28
28
|
# Output only. The relative resource name of the AspectType, of the form:
|
29
29
|
# projects/\\{project_number}/locations/\\{location_id}/aspectTypes/\\{aspect_type_id}.
|
30
30
|
# @!attribute [r] uid
|
31
31
|
# @return [::String]
|
32
|
-
# Output only. System generated globally unique ID for the AspectType.
|
33
|
-
#
|
34
|
-
#
|
32
|
+
# Output only. System generated globally unique ID for the AspectType.
|
33
|
+
# If you delete and recreate the AspectType with the same name, then this ID
|
34
|
+
# will be different.
|
35
35
|
# @!attribute [r] create_time
|
36
36
|
# @return [::Google::Protobuf::Timestamp]
|
37
37
|
# Output only. The time when the AspectType was created.
|
@@ -49,12 +49,11 @@ module Google
|
|
49
49
|
# Optional. User-defined labels for the AspectType.
|
50
50
|
# @!attribute [rw] etag
|
51
51
|
# @return [::String]
|
52
|
-
#
|
53
|
-
#
|
54
|
-
# client has an up-to-date value before proceeding.
|
52
|
+
# The service computes this checksum. The client may send it on update and
|
53
|
+
# delete requests to ensure it has an up-to-date value before proceeding.
|
55
54
|
# @!attribute [rw] authorization
|
56
55
|
# @return [::Google::Cloud::Dataplex::V1::AspectType::Authorization]
|
57
|
-
# Immutable. Authorization
|
56
|
+
# Immutable. Defines the Authorization for this type.
|
58
57
|
# @!attribute [rw] metadata_template
|
59
58
|
# @return [::Google::Cloud::Dataplex::V1::AspectType::MetadataTemplate]
|
60
59
|
# Required. MetadataTemplate of the aspect.
|
@@ -66,18 +65,18 @@ module Google
|
|
66
65
|
include ::Google::Protobuf::MessageExts
|
67
66
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
68
67
|
|
69
|
-
# Autorization for an
|
68
|
+
# Autorization for an AspectType.
|
70
69
|
# @!attribute [rw] alternate_use_permission
|
71
70
|
# @return [::String]
|
72
|
-
# Immutable. The IAM permission grantable on the
|
73
|
-
#
|
74
|
-
#
|
71
|
+
# Immutable. The IAM permission grantable on the EntryGroup to allow access
|
72
|
+
# to instantiate Aspects of Dataplex owned AspectTypes, only settable for
|
73
|
+
# Dataplex owned Types.
|
75
74
|
class Authorization
|
76
75
|
include ::Google::Protobuf::MessageExts
|
77
76
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
78
77
|
end
|
79
78
|
|
80
|
-
# MetadataTemplate definition for AspectType
|
79
|
+
# MetadataTemplate definition for an AspectType.
|
81
80
|
# @!attribute [rw] index
|
82
81
|
# @return [::Integer]
|
83
82
|
# Optional. Index is used to encode Template messages. The value of index
|
@@ -92,42 +91,54 @@ module Google
|
|
92
91
|
# @!attribute [rw] type
|
93
92
|
# @return [::String]
|
94
93
|
# Required. The datatype of this field. The following values are supported:
|
95
|
-
#
|
96
|
-
#
|
97
|
-
#
|
98
|
-
#
|
94
|
+
#
|
95
|
+
# Primitive types:
|
96
|
+
#
|
97
|
+
# * string
|
98
|
+
# * integer
|
99
|
+
# * boolean
|
100
|
+
# * double
|
101
|
+
# * datetime. Must be of the format RFC3339 UTC "Zulu" (Examples:
|
102
|
+
# "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z").
|
103
|
+
#
|
104
|
+
# Complex types:
|
105
|
+
#
|
106
|
+
# * enum
|
107
|
+
# * array
|
108
|
+
# * map
|
109
|
+
# * record
|
99
110
|
# @!attribute [rw] record_fields
|
100
111
|
# @return [::Array<::Google::Cloud::Dataplex::V1::AspectType::MetadataTemplate>]
|
101
|
-
# Optional. Field definition
|
102
|
-
#
|
112
|
+
# Optional. Field definition. You must specify it if the type is record. It
|
113
|
+
# defines the nested fields.
|
103
114
|
# @!attribute [rw] enum_values
|
104
115
|
# @return [::Array<::Google::Cloud::Dataplex::V1::AspectType::MetadataTemplate::EnumValue>]
|
105
|
-
# Optional. The list of values for an enum type.
|
116
|
+
# Optional. The list of values for an enum type. You must define it if the
|
106
117
|
# type is enum.
|
107
118
|
# @!attribute [rw] map_items
|
108
119
|
# @return [::Google::Cloud::Dataplex::V1::AspectType::MetadataTemplate]
|
109
|
-
# Optional.
|
110
|
-
#
|
111
|
-
#
|
120
|
+
# Optional. If the type is map, set map_items. map_items can refer to a
|
121
|
+
# primitive field or a complex (record only) field. To specify a primitive
|
122
|
+
# field, you only need to set name and type in the nested
|
112
123
|
# MetadataTemplate. The recommended value for the name field is item, as
|
113
|
-
# this
|
124
|
+
# this isn't used in the actual payload.
|
114
125
|
# @!attribute [rw] array_items
|
115
126
|
# @return [::Google::Cloud::Dataplex::V1::AspectType::MetadataTemplate]
|
116
|
-
# Optional.
|
117
|
-
#
|
118
|
-
#
|
119
|
-
#
|
120
|
-
#
|
127
|
+
# Optional. If the type is array, set array_items. array_items can refer
|
128
|
+
# to a primitive field or a complex (record only) field. To specify a
|
129
|
+
# primitive field, you only need to set name and type in the nested
|
130
|
+
# MetadataTemplate. The recommended value for the name field is item, as
|
131
|
+
# this isn't used in the actual payload.
|
121
132
|
# @!attribute [rw] type_id
|
122
133
|
# @return [::String]
|
123
|
-
# Optional.
|
124
|
-
# reused later.
|
125
|
-
# only
|
134
|
+
# Optional. You can use type id if this definition of the field needs to be
|
135
|
+
# reused later. The type id must be unique across the entire template. You
|
136
|
+
# can only specify it if the field type is record.
|
126
137
|
# @!attribute [rw] type_ref
|
127
138
|
# @return [::String]
|
128
|
-
# Optional. A reference to another field definition (
|
139
|
+
# Optional. A reference to another field definition (not an inline
|
129
140
|
# definition). The value must be equal to the value of an id field defined
|
130
|
-
# elsewhere in the MetadataTemplate. Only fields with type
|
141
|
+
# elsewhere in the MetadataTemplate. Only fields with record type can
|
131
142
|
# refer to other fields.
|
132
143
|
# @!attribute [rw] constraints
|
133
144
|
# @return [::Google::Cloud::Dataplex::V1::AspectType::MetadataTemplate::Constraints]
|
@@ -139,57 +150,59 @@ module Google
|
|
139
150
|
include ::Google::Protobuf::MessageExts
|
140
151
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
141
152
|
|
142
|
-
# Definition of Enumvalue
|
153
|
+
# Definition of Enumvalue, to be used for enum fields.
|
143
154
|
# @!attribute [rw] index
|
144
155
|
# @return [::Integer]
|
145
|
-
# Required. Index for the enum.
|
156
|
+
# Required. Index for the enum value. It can't be modified.
|
146
157
|
# @!attribute [rw] name
|
147
158
|
# @return [::String]
|
148
159
|
# Required. Name of the enumvalue. This is the actual value that the
|
149
|
-
# aspect
|
160
|
+
# aspect can contain.
|
150
161
|
# @!attribute [rw] deprecated
|
151
162
|
# @return [::String]
|
152
|
-
# Optional.
|
153
|
-
#
|
163
|
+
# Optional. You can set this message if you need to deprecate an enum
|
164
|
+
# value.
|
154
165
|
class EnumValue
|
155
166
|
include ::Google::Protobuf::MessageExts
|
156
167
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
157
168
|
end
|
158
169
|
|
159
|
-
# Definition of the constraints of a field
|
170
|
+
# Definition of the constraints of a field.
|
160
171
|
# @!attribute [rw] required
|
161
172
|
# @return [::Boolean]
|
162
|
-
# Optional. Marks this as
|
173
|
+
# Optional. Marks this field as optional or required.
|
163
174
|
class Constraints
|
164
175
|
include ::Google::Protobuf::MessageExts
|
165
176
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
166
177
|
end
|
167
178
|
|
168
|
-
# Definition of the annotations of a field
|
179
|
+
# Definition of the annotations of a field.
|
169
180
|
# @!attribute [rw] deprecated
|
170
181
|
# @return [::String]
|
171
|
-
# Optional. Marks a field as deprecated
|
172
|
-
#
|
182
|
+
# Optional. Marks a field as deprecated. You can include a deprecation
|
183
|
+
# message.
|
173
184
|
# @!attribute [rw] display_name
|
174
185
|
# @return [::String]
|
175
|
-
# Optional.
|
186
|
+
# Optional. Display name for a field.
|
176
187
|
# @!attribute [rw] description
|
177
188
|
# @return [::String]
|
178
|
-
# Optional.
|
189
|
+
# Optional. Description for a field.
|
179
190
|
# @!attribute [rw] display_order
|
180
191
|
# @return [::Integer]
|
181
|
-
# Optional.
|
182
|
-
#
|
192
|
+
# Optional. Display order for a field. You can use this to reorder where
|
193
|
+
# a field is rendered.
|
183
194
|
# @!attribute [rw] string_type
|
184
195
|
# @return [::String]
|
185
|
-
# Optional. String Type annotations
|
186
|
-
# meaning to string fields. The following values are supported:
|
187
|
-
#
|
188
|
-
#
|
196
|
+
# Optional. You can use String Type annotations to specify special
|
197
|
+
# meaning to string fields. The following values are supported:
|
198
|
+
#
|
199
|
+
# * richText: The field must be interpreted as a rich text field.
|
200
|
+
# * url: A fully qualified URL link.
|
201
|
+
# * resource: A service qualified resource reference.
|
189
202
|
# @!attribute [rw] string_values
|
190
203
|
# @return [::Array<::String>]
|
191
|
-
# Optional. Suggested hints for string fields.
|
192
|
-
# suggest values to users
|
204
|
+
# Optional. Suggested hints for string fields. You can use them to
|
205
|
+
# suggest values to users through console.
|
193
206
|
class Annotations
|
194
207
|
include ::Google::Protobuf::MessageExts
|
195
208
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -209,13 +222,13 @@ module Google
|
|
209
222
|
# An Entry Group represents a logical grouping of one or more Entries.
|
210
223
|
# @!attribute [r] name
|
211
224
|
# @return [::String]
|
212
|
-
# Output only. The relative resource name of the EntryGroup,
|
213
|
-
# projects/\\{
|
225
|
+
# Output only. The relative resource name of the EntryGroup, in the format
|
226
|
+
# projects/\\{project_id_or_number}/locations/\\{location_id}/entryGroups/\\{entry_group_id}.
|
214
227
|
# @!attribute [r] uid
|
215
228
|
# @return [::String]
|
216
|
-
# Output only. System generated globally unique ID for the EntryGroup.
|
217
|
-
#
|
218
|
-
#
|
229
|
+
# Output only. System generated globally unique ID for the EntryGroup. If you
|
230
|
+
# delete and recreate the EntryGroup with the same name, this ID will be
|
231
|
+
# different.
|
219
232
|
# @!attribute [r] create_time
|
220
233
|
# @return [::Google::Protobuf::Timestamp]
|
221
234
|
# Output only. The time when the EntryGroup was created.
|
@@ -233,9 +246,9 @@ module Google
|
|
233
246
|
# Optional. User-defined labels for the EntryGroup.
|
234
247
|
# @!attribute [rw] etag
|
235
248
|
# @return [::String]
|
236
|
-
# This checksum is computed by the
|
237
|
-
#
|
238
|
-
#
|
249
|
+
# This checksum is computed by the service, and might be sent on update and
|
250
|
+
# delete requests to ensure the client has an up-to-date value before
|
251
|
+
# proceeding.
|
239
252
|
# @!attribute [r] transfer_status
|
240
253
|
# @return [::Google::Cloud::Dataplex::V1::TransferStatus]
|
241
254
|
# Output only. Denotes the transfer status of the Entry Group. It is
|
@@ -281,12 +294,12 @@ module Google
|
|
281
294
|
# Optional. User-defined labels for the EntryType.
|
282
295
|
# @!attribute [rw] etag
|
283
296
|
# @return [::String]
|
284
|
-
# Optional. This checksum is computed by the
|
285
|
-
#
|
286
|
-
#
|
297
|
+
# Optional. This checksum is computed by the service, and might be sent on
|
298
|
+
# update and delete requests to ensure the client has an up-to-date value
|
299
|
+
# before proceeding.
|
287
300
|
# @!attribute [rw] type_aliases
|
288
301
|
# @return [::Array<::String>]
|
289
|
-
# Optional. Indicates the
|
302
|
+
# Optional. Indicates the classes this Entry Type belongs to, for example,
|
290
303
|
# TABLE, DATABASE, MODEL.
|
291
304
|
# @!attribute [rw] platform
|
292
305
|
# @return [::String]
|
@@ -350,62 +363,72 @@ module Google
|
|
350
363
|
# @!attribute [rw] data
|
351
364
|
# @return [::Google::Protobuf::Struct]
|
352
365
|
# Required. The content of the aspect, according to its aspect type schema.
|
353
|
-
# This will replace `content`.
|
354
366
|
# The maximum size of the field is 120KB (encoded as UTF-8).
|
355
367
|
# @!attribute [rw] aspect_source
|
356
368
|
# @return [::Google::Cloud::Dataplex::V1::AspectSource]
|
369
|
+
# Optional. Information related to the source system of the aspect.
|
357
370
|
class Aspect
|
358
371
|
include ::Google::Protobuf::MessageExts
|
359
372
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
360
373
|
end
|
361
374
|
|
362
|
-
#
|
363
|
-
# aspect.
|
375
|
+
# Information related to the source system of the aspect.
|
364
376
|
# @!attribute [rw] create_time
|
365
377
|
# @return [::Google::Protobuf::Timestamp]
|
366
|
-
# The
|
378
|
+
# The time the aspect was created in the source system.
|
367
379
|
# @!attribute [rw] update_time
|
368
380
|
# @return [::Google::Protobuf::Timestamp]
|
369
|
-
# The
|
381
|
+
# The time the aspect was last updated in the source system.
|
382
|
+
# @!attribute [rw] data_version
|
383
|
+
# @return [::String]
|
384
|
+
# The version of the data format used to produce this data. This field is
|
385
|
+
# used to indicated when the underlying data format changes (e.g., schema
|
386
|
+
# modifications, changes to the source URL format definition, etc).
|
370
387
|
class AspectSource
|
371
388
|
include ::Google::Protobuf::MessageExts
|
372
389
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
373
390
|
end
|
374
391
|
|
375
|
-
# An entry is a representation of a data
|
392
|
+
# An entry is a representation of a data resource that can be described by
|
376
393
|
# various metadata.
|
377
394
|
# @!attribute [rw] name
|
378
395
|
# @return [::String]
|
379
|
-
# Identifier. The relative resource name of the
|
380
|
-
# projects
|
396
|
+
# Identifier. The relative resource name of the entry, in the format
|
397
|
+
# `projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id}`.
|
381
398
|
# @!attribute [rw] entry_type
|
382
399
|
# @return [::String]
|
383
|
-
# Required. Immutable. The resource name of the
|
384
|
-
#
|
400
|
+
# Required. Immutable. The relative resource name of the entry type that was
|
401
|
+
# used to create this entry, in the format
|
402
|
+
# `projects/{project_id_or_number}/locations/{location_id}/entryTypes/{entry_type_id}`.
|
385
403
|
# @!attribute [r] create_time
|
386
404
|
# @return [::Google::Protobuf::Timestamp]
|
387
|
-
# Output only. The time when the
|
405
|
+
# Output only. The time when the entry was created in Dataplex.
|
388
406
|
# @!attribute [r] update_time
|
389
407
|
# @return [::Google::Protobuf::Timestamp]
|
390
|
-
# Output only. The time when the
|
408
|
+
# Output only. The time when the entry was last updated in Dataplex.
|
391
409
|
# @!attribute [rw] aspects
|
392
410
|
# @return [::Google::Protobuf::Map{::String => ::Google::Cloud::Dataplex::V1::Aspect}]
|
393
|
-
# Optional. The
|
394
|
-
#
|
395
|
-
#
|
396
|
-
#
|
397
|
-
#
|
398
|
-
#
|
411
|
+
# Optional. The aspects that are attached to the entry. Depending on how the
|
412
|
+
# aspect is attached to the entry, the format of the aspect key can be one of
|
413
|
+
# the following:
|
414
|
+
#
|
415
|
+
# * If the aspect is attached directly to the entry:
|
416
|
+
# `{project_id_or_number}.{location_id}.{aspect_type_id}`
|
417
|
+
# * If the aspect is attached to an entry's path:
|
418
|
+
# `{project_id_or_number}.{location_id}.{aspect_type_id}@{path}`
|
399
419
|
# @!attribute [rw] parent_entry
|
400
420
|
# @return [::String]
|
401
421
|
# Optional. Immutable. The resource name of the parent entry.
|
402
422
|
# @!attribute [rw] fully_qualified_name
|
403
423
|
# @return [::String]
|
404
|
-
# Optional. A name for the entry that can
|
424
|
+
# Optional. A name for the entry that can be referenced by an external
|
425
|
+
# system. For more information, see [Fully qualified
|
426
|
+
# names](https://cloud.google.com/data-catalog/docs/fully-qualified-names).
|
405
427
|
# The maximum size of the field is 4000 characters.
|
406
428
|
# @!attribute [rw] entry_source
|
407
429
|
# @return [::Google::Cloud::Dataplex::V1::EntrySource]
|
408
|
-
# Optional.
|
430
|
+
# Optional. Information related to the source system of the data resource
|
431
|
+
# that is represented by the entry.
|
409
432
|
class Entry
|
410
433
|
include ::Google::Protobuf::MessageExts
|
411
434
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -420,53 +443,57 @@ module Google
|
|
420
443
|
end
|
421
444
|
end
|
422
445
|
|
423
|
-
#
|
424
|
-
# entry.
|
446
|
+
# Information related to the source system of the data resource that is
|
447
|
+
# represented by the entry.
|
425
448
|
# @!attribute [rw] resource
|
426
449
|
# @return [::String]
|
427
450
|
# The name of the resource in the source system.
|
428
|
-
#
|
451
|
+
# Maximum length is 4,000 characters.
|
429
452
|
# @!attribute [rw] system
|
430
453
|
# @return [::String]
|
431
454
|
# The name of the source system.
|
432
|
-
#
|
455
|
+
# Maximum length is 64 characters.
|
433
456
|
# @!attribute [rw] platform
|
434
457
|
# @return [::String]
|
435
458
|
# The platform containing the source system.
|
436
|
-
#
|
459
|
+
# Maximum length is 64 characters.
|
437
460
|
# @!attribute [rw] display_name
|
438
461
|
# @return [::String]
|
439
|
-
#
|
440
|
-
#
|
462
|
+
# A user-friendly display name.
|
463
|
+
# Maximum length is 500 characters.
|
441
464
|
# @!attribute [rw] description
|
442
465
|
# @return [::String]
|
443
|
-
#
|
444
|
-
#
|
466
|
+
# A description of the data resource.
|
467
|
+
# Maximum length is 2,000 characters.
|
445
468
|
# @!attribute [rw] labels
|
446
469
|
# @return [::Google::Protobuf::Map{::String => ::String}]
|
447
470
|
# User-defined labels.
|
448
471
|
# The maximum size of keys and values is 128 characters each.
|
449
472
|
# @!attribute [rw] ancestors
|
450
473
|
# @return [::Array<::Google::Cloud::Dataplex::V1::EntrySource::Ancestor>]
|
451
|
-
# Immutable. The
|
474
|
+
# Immutable. The entries representing the ancestors of the data resource in
|
475
|
+
# the source system.
|
452
476
|
# @!attribute [rw] create_time
|
453
477
|
# @return [::Google::Protobuf::Timestamp]
|
454
|
-
# The
|
478
|
+
# The time when the resource was created in the source system.
|
455
479
|
# @!attribute [rw] update_time
|
456
480
|
# @return [::Google::Protobuf::Timestamp]
|
457
|
-
# The
|
481
|
+
# The time when the resource was last updated in the source system. If the
|
482
|
+
# entry exists in the system and its `EntrySource` has `update_time`
|
483
|
+
# populated, further updates to the `EntrySource` of the entry must provide
|
484
|
+
# incremental updates to its `update_time`.
|
458
485
|
# @!attribute [r] location
|
459
486
|
# @return [::String]
|
460
|
-
# Output only. Location of the resource in the source system.
|
461
|
-
#
|
462
|
-
# the
|
463
|
-
# source location for data external to
|
487
|
+
# Output only. Location of the resource in the source system. You can search
|
488
|
+
# the entry by this location. By default, this should match the location of
|
489
|
+
# the entry group containing this entry. A different value allows capturing
|
490
|
+
# the source location for data external to Google Cloud.
|
464
491
|
class EntrySource
|
465
492
|
include ::Google::Protobuf::MessageExts
|
466
493
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
467
494
|
|
468
|
-
#
|
469
|
-
#
|
495
|
+
# Information about individual items in the hierarchy that is associated with
|
496
|
+
# the data resource.
|
470
497
|
# @!attribute [rw] name
|
471
498
|
# @return [::String]
|
472
499
|
# Optional. The name of the ancestor resource.
|
@@ -488,7 +515,7 @@ module Google
|
|
488
515
|
end
|
489
516
|
end
|
490
517
|
|
491
|
-
# Create EntryGroup Request
|
518
|
+
# Create EntryGroup Request.
|
492
519
|
# @!attribute [rw] parent
|
493
520
|
# @return [::String]
|
494
521
|
# Required. The resource name of the entryGroup, of the form:
|
@@ -499,33 +526,33 @@ module Google
|
|
499
526
|
# Required. EntryGroup identifier.
|
500
527
|
# @!attribute [rw] entry_group
|
501
528
|
# @return [::Google::Cloud::Dataplex::V1::EntryGroup]
|
502
|
-
# Required. EntryGroup Resource
|
529
|
+
# Required. EntryGroup Resource.
|
503
530
|
# @!attribute [rw] validate_only
|
504
531
|
# @return [::Boolean]
|
505
|
-
# Optional.
|
506
|
-
# The default is false.
|
532
|
+
# Optional. The service validates the request without performing any
|
533
|
+
# mutations. The default is false.
|
507
534
|
class CreateEntryGroupRequest
|
508
535
|
include ::Google::Protobuf::MessageExts
|
509
536
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
510
537
|
end
|
511
538
|
|
512
|
-
# Update EntryGroup Request
|
539
|
+
# Update EntryGroup Request.
|
513
540
|
# @!attribute [rw] entry_group
|
514
541
|
# @return [::Google::Cloud::Dataplex::V1::EntryGroup]
|
515
|
-
# Required. EntryGroup Resource
|
542
|
+
# Required. EntryGroup Resource.
|
516
543
|
# @!attribute [rw] update_mask
|
517
544
|
# @return [::Google::Protobuf::FieldMask]
|
518
545
|
# Required. Mask of fields to update.
|
519
546
|
# @!attribute [rw] validate_only
|
520
547
|
# @return [::Boolean]
|
521
|
-
# Optional.
|
522
|
-
# The default is false.
|
548
|
+
# Optional. The service validates the request, without performing any
|
549
|
+
# mutations. The default is false.
|
523
550
|
class UpdateEntryGroupRequest
|
524
551
|
include ::Google::Protobuf::MessageExts
|
525
552
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
526
553
|
end
|
527
554
|
|
528
|
-
#
|
555
|
+
# Delete EntryGroup Request.
|
529
556
|
# @!attribute [rw] name
|
530
557
|
# @return [::String]
|
531
558
|
# Required. The resource name of the EntryGroup:
|
@@ -533,7 +560,8 @@ module Google
|
|
533
560
|
# @!attribute [rw] etag
|
534
561
|
# @return [::String]
|
535
562
|
# Optional. If the client provided etag value does not match the current etag
|
536
|
-
# value, the DeleteEntryGroupRequest method returns an ABORTED error
|
563
|
+
# value, the DeleteEntryGroupRequest method returns an ABORTED error
|
564
|
+
# response.
|
537
565
|
class DeleteEntryGroupRequest
|
538
566
|
include ::Google::Protobuf::MessageExts
|
539
567
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -544,19 +572,19 @@ module Google
|
|
544
572
|
# @return [::String]
|
545
573
|
# Required. The resource name of the entryGroup location, of the form:
|
546
574
|
# `projects/{project_number}/locations/{location_id}`
|
547
|
-
# where `location_id` refers to a
|
575
|
+
# where `location_id` refers to a Google Cloud region.
|
548
576
|
# @!attribute [rw] page_size
|
549
577
|
# @return [::Integer]
|
550
578
|
# Optional. Maximum number of EntryGroups to return. The service may return
|
551
|
-
# fewer than this value. If unspecified, at most 10
|
552
|
-
#
|
553
|
-
# 1000.
|
579
|
+
# fewer than this value. If unspecified, the service returns at most 10
|
580
|
+
# EntryGroups. The maximum value is 1000; values above 1000 will be coerced
|
581
|
+
# to 1000.
|
554
582
|
# @!attribute [rw] page_token
|
555
583
|
# @return [::String]
|
556
584
|
# Optional. Page token received from a previous `ListEntryGroups` call.
|
557
585
|
# Provide this to retrieve the subsequent page. When paginating, all other
|
558
|
-
# parameters
|
559
|
-
# the page token.
|
586
|
+
# parameters you provide to `ListEntryGroups` must match the call that
|
587
|
+
# provided the page token.
|
560
588
|
# @!attribute [rw] filter
|
561
589
|
# @return [::String]
|
562
590
|
# Optional. Filter request.
|
@@ -568,17 +596,17 @@ module Google
|
|
568
596
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
569
597
|
end
|
570
598
|
|
571
|
-
# List
|
599
|
+
# List entry groups response.
|
572
600
|
# @!attribute [rw] entry_groups
|
573
601
|
# @return [::Array<::Google::Cloud::Dataplex::V1::EntryGroup>]
|
574
|
-
#
|
602
|
+
# Entry groups under the given parent location.
|
575
603
|
# @!attribute [rw] next_page_token
|
576
604
|
# @return [::String]
|
577
605
|
# Token to retrieve the next page of results, or empty if there are no more
|
578
606
|
# results in the list.
|
579
607
|
# @!attribute [rw] unreachable_locations
|
580
608
|
# @return [::Array<::String>]
|
581
|
-
# Locations that
|
609
|
+
# Locations that the service couldn't reach.
|
582
610
|
class ListEntryGroupsResponse
|
583
611
|
include ::Google::Protobuf::MessageExts
|
584
612
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -594,44 +622,44 @@ module Google
|
|
594
622
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
595
623
|
end
|
596
624
|
|
597
|
-
# Create EntryType Request
|
625
|
+
# Create EntryType Request.
|
598
626
|
# @!attribute [rw] parent
|
599
627
|
# @return [::String]
|
600
628
|
# Required. The resource name of the EntryType, of the form:
|
601
629
|
# projects/\\{project_number}/locations/\\{location_id}
|
602
|
-
# where `location_id` refers to a
|
630
|
+
# where `location_id` refers to a Google Cloud region.
|
603
631
|
# @!attribute [rw] entry_type_id
|
604
632
|
# @return [::String]
|
605
633
|
# Required. EntryType identifier.
|
606
634
|
# @!attribute [rw] entry_type
|
607
635
|
# @return [::Google::Cloud::Dataplex::V1::EntryType]
|
608
|
-
# Required. EntryType Resource
|
636
|
+
# Required. EntryType Resource.
|
609
637
|
# @!attribute [rw] validate_only
|
610
638
|
# @return [::Boolean]
|
611
|
-
# Optional.
|
612
|
-
# The default is false.
|
639
|
+
# Optional. The service validates the request without performing any
|
640
|
+
# mutations. The default is false.
|
613
641
|
class CreateEntryTypeRequest
|
614
642
|
include ::Google::Protobuf::MessageExts
|
615
643
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
616
644
|
end
|
617
645
|
|
618
|
-
# Update EntryType Request
|
646
|
+
# Update EntryType Request.
|
619
647
|
# @!attribute [rw] entry_type
|
620
648
|
# @return [::Google::Cloud::Dataplex::V1::EntryType]
|
621
|
-
# Required. EntryType Resource
|
649
|
+
# Required. EntryType Resource.
|
622
650
|
# @!attribute [rw] update_mask
|
623
651
|
# @return [::Google::Protobuf::FieldMask]
|
624
652
|
# Required. Mask of fields to update.
|
625
653
|
# @!attribute [rw] validate_only
|
626
654
|
# @return [::Boolean]
|
627
|
-
# Optional.
|
628
|
-
# The default is false.
|
655
|
+
# Optional. The service validates the request without performing any
|
656
|
+
# mutations. The default is false.
|
629
657
|
class UpdateEntryTypeRequest
|
630
658
|
include ::Google::Protobuf::MessageExts
|
631
659
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
632
660
|
end
|
633
661
|
|
634
|
-
# Delele EntryType Request
|
662
|
+
# Delele EntryType Request.
|
635
663
|
# @!attribute [rw] name
|
636
664
|
# @return [::String]
|
637
665
|
# Required. The resource name of the EntryType:
|
@@ -639,7 +667,7 @@ module Google
|
|
639
667
|
# @!attribute [rw] etag
|
640
668
|
# @return [::String]
|
641
669
|
# Optional. If the client provided etag value does not match the current etag
|
642
|
-
# value, the DeleteEntryTypeRequest method returns an ABORTED error response
|
670
|
+
# value, the DeleteEntryTypeRequest method returns an ABORTED error response.
|
643
671
|
class DeleteEntryTypeRequest
|
644
672
|
include ::Google::Protobuf::MessageExts
|
645
673
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -650,54 +678,55 @@ module Google
|
|
650
678
|
# @return [::String]
|
651
679
|
# Required. The resource name of the EntryType location, of the form:
|
652
680
|
# `projects/{project_number}/locations/{location_id}`
|
653
|
-
# where `location_id` refers to a
|
681
|
+
# where `location_id` refers to a Google Cloud region.
|
654
682
|
# @!attribute [rw] page_size
|
655
683
|
# @return [::Integer]
|
656
684
|
# Optional. Maximum number of EntryTypes to return. The service may return
|
657
|
-
# fewer than this value. If unspecified, at most 10
|
658
|
-
#
|
685
|
+
# fewer than this value. If unspecified, the service returns at most 10
|
686
|
+
# EntryTypes. The maximum value is 1000; values above 1000 will be coerced to
|
659
687
|
# 1000.
|
660
688
|
# @!attribute [rw] page_token
|
661
689
|
# @return [::String]
|
662
690
|
# Optional. Page token received from a previous `ListEntryTypes` call.
|
663
691
|
# Provide this to retrieve the subsequent page. When paginating, all other
|
664
|
-
# parameters provided to `ListEntryTypes` must match the call that
|
665
|
-
# the page token.
|
692
|
+
# parameters you provided to `ListEntryTypes` must match the call that
|
693
|
+
# provided the page token.
|
666
694
|
# @!attribute [rw] filter
|
667
695
|
# @return [::String]
|
668
696
|
# Optional. Filter request. Filters are case-sensitive.
|
669
|
-
# The following formats
|
697
|
+
# The service supports the following formats:
|
698
|
+
#
|
699
|
+
# * labels.key1 = "value1"
|
700
|
+
# * labels:key1
|
701
|
+
# * name = "value"
|
670
702
|
#
|
671
|
-
#
|
672
|
-
# labels:key1
|
673
|
-
# name = "value"
|
674
|
-
# These restrictions can be coinjoined with AND, OR and NOT conjunctions.
|
703
|
+
# These restrictions can be conjoined with AND, OR, and NOT conjunctions.
|
675
704
|
# @!attribute [rw] order_by
|
676
705
|
# @return [::String]
|
677
|
-
# Optional.
|
706
|
+
# Optional. Orders the result by `name` or `create_time` fields.
|
678
707
|
# If not specified, the ordering is undefined.
|
679
708
|
class ListEntryTypesRequest
|
680
709
|
include ::Google::Protobuf::MessageExts
|
681
710
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
682
711
|
end
|
683
712
|
|
684
|
-
# List EntryTypes response
|
713
|
+
# List EntryTypes response.
|
685
714
|
# @!attribute [rw] entry_types
|
686
715
|
# @return [::Array<::Google::Cloud::Dataplex::V1::EntryType>]
|
687
|
-
#
|
716
|
+
# EntryTypes under the given parent location.
|
688
717
|
# @!attribute [rw] next_page_token
|
689
718
|
# @return [::String]
|
690
719
|
# Token to retrieve the next page of results, or empty if there are no more
|
691
720
|
# results in the list.
|
692
721
|
# @!attribute [rw] unreachable_locations
|
693
722
|
# @return [::Array<::String>]
|
694
|
-
# Locations that
|
723
|
+
# Locations that the service couldn't reach.
|
695
724
|
class ListEntryTypesResponse
|
696
725
|
include ::Google::Protobuf::MessageExts
|
697
726
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
698
727
|
end
|
699
728
|
|
700
|
-
# Get EntryType request
|
729
|
+
# Get EntryType request.
|
701
730
|
# @!attribute [rw] name
|
702
731
|
# @return [::String]
|
703
732
|
# Required. The resource name of the EntryType:
|
@@ -707,22 +736,22 @@ module Google
|
|
707
736
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
708
737
|
end
|
709
738
|
|
710
|
-
# Create AspectType Request
|
739
|
+
# Create AspectType Request.
|
711
740
|
# @!attribute [rw] parent
|
712
741
|
# @return [::String]
|
713
742
|
# Required. The resource name of the AspectType, of the form:
|
714
743
|
# projects/\\{project_number}/locations/\\{location_id}
|
715
|
-
# where `location_id` refers to a
|
744
|
+
# where `location_id` refers to a Google Cloud region.
|
716
745
|
# @!attribute [rw] aspect_type_id
|
717
746
|
# @return [::String]
|
718
747
|
# Required. AspectType identifier.
|
719
748
|
# @!attribute [rw] aspect_type
|
720
749
|
# @return [::Google::Cloud::Dataplex::V1::AspectType]
|
721
|
-
# Required. AspectType Resource
|
750
|
+
# Required. AspectType Resource.
|
722
751
|
# @!attribute [rw] validate_only
|
723
752
|
# @return [::Boolean]
|
724
|
-
# Optional.
|
725
|
-
# The default is false.
|
753
|
+
# Optional. The service validates the request without performing any
|
754
|
+
# mutations. The default is false.
|
726
755
|
class CreateAspectTypeRequest
|
727
756
|
include ::Google::Protobuf::MessageExts
|
728
757
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -744,7 +773,7 @@ module Google
|
|
744
773
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
745
774
|
end
|
746
775
|
|
747
|
-
# Delele AspectType Request
|
776
|
+
# Delele AspectType Request.
|
748
777
|
# @!attribute [rw] name
|
749
778
|
# @return [::String]
|
750
779
|
# Required. The resource name of the AspectType:
|
@@ -752,65 +781,67 @@ module Google
|
|
752
781
|
# @!attribute [rw] etag
|
753
782
|
# @return [::String]
|
754
783
|
# Optional. If the client provided etag value does not match the current etag
|
755
|
-
# value, the DeleteAspectTypeRequest method returns an ABORTED error
|
784
|
+
# value, the DeleteAspectTypeRequest method returns an ABORTED error
|
785
|
+
# response.
|
756
786
|
class DeleteAspectTypeRequest
|
757
787
|
include ::Google::Protobuf::MessageExts
|
758
788
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
759
789
|
end
|
760
790
|
|
761
|
-
# List AspectTypes request
|
791
|
+
# List AspectTypes request.
|
762
792
|
# @!attribute [rw] parent
|
763
793
|
# @return [::String]
|
764
794
|
# Required. The resource name of the AspectType location, of the form:
|
765
795
|
# `projects/{project_number}/locations/{location_id}`
|
766
|
-
# where `location_id` refers to a
|
796
|
+
# where `location_id` refers to a Google Cloud region.
|
767
797
|
# @!attribute [rw] page_size
|
768
798
|
# @return [::Integer]
|
769
799
|
# Optional. Maximum number of AspectTypes to return. The service may return
|
770
|
-
# fewer than this value. If unspecified, at most 10
|
771
|
-
#
|
772
|
-
# 1000.
|
800
|
+
# fewer than this value. If unspecified, the service returns at most 10
|
801
|
+
# AspectTypes. The maximum value is 1000; values above 1000 will be coerced
|
802
|
+
# to 1000.
|
773
803
|
# @!attribute [rw] page_token
|
774
804
|
# @return [::String]
|
775
805
|
# Optional. Page token received from a previous `ListAspectTypes` call.
|
776
806
|
# Provide this to retrieve the subsequent page. When paginating, all other
|
777
|
-
# parameters
|
778
|
-
# the page token.
|
807
|
+
# parameters you provide to `ListAspectTypes` must match the call that
|
808
|
+
# provided the page token.
|
779
809
|
# @!attribute [rw] filter
|
780
810
|
# @return [::String]
|
781
811
|
# Optional. Filter request. Filters are case-sensitive.
|
782
|
-
# The following formats
|
812
|
+
# The service supports the following formats:
|
813
|
+
#
|
814
|
+
# * labels.key1 = "value1"
|
815
|
+
# * labels:key1
|
816
|
+
# * name = "value"
|
783
817
|
#
|
784
|
-
#
|
785
|
-
# labels:key1
|
786
|
-
# name = "value"
|
787
|
-
# These restrictions can be coinjoined with AND, OR and NOT conjunctions.
|
818
|
+
# These restrictions can be conjoined with AND, OR, and NOT conjunctions.
|
788
819
|
# @!attribute [rw] order_by
|
789
820
|
# @return [::String]
|
790
|
-
# Optional.
|
821
|
+
# Optional. Orders the result by `name` or `create_time` fields.
|
791
822
|
# If not specified, the ordering is undefined.
|
792
823
|
class ListAspectTypesRequest
|
793
824
|
include ::Google::Protobuf::MessageExts
|
794
825
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
795
826
|
end
|
796
827
|
|
797
|
-
# List AspectTypes response
|
828
|
+
# List AspectTypes response.
|
798
829
|
# @!attribute [rw] aspect_types
|
799
830
|
# @return [::Array<::Google::Cloud::Dataplex::V1::AspectType>]
|
800
|
-
#
|
831
|
+
# AspectTypes under the given parent location.
|
801
832
|
# @!attribute [rw] next_page_token
|
802
833
|
# @return [::String]
|
803
834
|
# Token to retrieve the next page of results, or empty if there are no more
|
804
835
|
# results in the list.
|
805
836
|
# @!attribute [rw] unreachable_locations
|
806
837
|
# @return [::Array<::String>]
|
807
|
-
# Locations that
|
838
|
+
# Locations that the service couldn't reach.
|
808
839
|
class ListAspectTypesResponse
|
809
840
|
include ::Google::Protobuf::MessageExts
|
810
841
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
811
842
|
end
|
812
843
|
|
813
|
-
# Get AspectType request
|
844
|
+
# Get AspectType request.
|
814
845
|
# @!attribute [rw] name
|
815
846
|
# @return [::String]
|
816
847
|
# Required. The resource name of the AspectType:
|
@@ -820,6 +851,7 @@ module Google
|
|
820
851
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
821
852
|
end
|
822
853
|
|
854
|
+
# Create Entry request.
|
823
855
|
# @!attribute [rw] parent
|
824
856
|
# @return [::String]
|
825
857
|
# Required. The resource name of the parent Entry Group:
|
@@ -828,20 +860,21 @@ module Google
|
|
828
860
|
# @return [::String]
|
829
861
|
# Required. Entry identifier. It has to be unique within an Entry Group.
|
830
862
|
#
|
831
|
-
# Entries corresponding to Google Cloud resources use Entry ID format
|
832
|
-
# on
|
833
|
-
# (https://cloud.google.com/apis/design/resource_names#full_resource_name).
|
834
|
-
# The format is a
|
835
|
-
# prefix double slashes in the API
|
836
|
-
# This allows retrieval of entries using their associated resource
|
863
|
+
# Entries corresponding to Google Cloud resources use an Entry ID format
|
864
|
+
# based on [full resource
|
865
|
+
# names](https://cloud.google.com/apis/design/resource_names#full_resource_name).
|
866
|
+
# The format is a full resource name of the resource without the
|
867
|
+
# prefix double slashes in the API service name part of the full resource
|
868
|
+
# name. This allows retrieval of entries using their associated resource
|
869
|
+
# name.
|
837
870
|
#
|
838
|
-
# For example if the
|
871
|
+
# For example, if the full resource name of a resource is
|
839
872
|
# `//library.googleapis.com/shelves/shelf1/books/book2`,
|
840
873
|
# then the suggested entry_id is
|
841
874
|
# `library.googleapis.com/shelves/shelf1/books/book2`.
|
842
875
|
#
|
843
876
|
# It is also suggested to follow the same convention for entries
|
844
|
-
# corresponding to resources from
|
877
|
+
# corresponding to resources from providers or systems other than Google
|
845
878
|
# Cloud.
|
846
879
|
#
|
847
880
|
# The maximum size of the field is 4000 characters.
|
@@ -853,6 +886,7 @@ module Google
|
|
853
886
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
854
887
|
end
|
855
888
|
|
889
|
+
# Update Entry request.
|
856
890
|
# @!attribute [rw] entry
|
857
891
|
# @return [::Google::Cloud::Dataplex::V1::Entry]
|
858
892
|
# Required. Entry resource.
|
@@ -861,36 +895,43 @@ module Google
|
|
861
895
|
# Optional. Mask of fields to update. To update Aspects, the update_mask must
|
862
896
|
# contain the value "aspects".
|
863
897
|
#
|
864
|
-
# If the update_mask is empty,
|
865
|
-
#
|
898
|
+
# If the update_mask is empty, the service will update all modifiable fields
|
899
|
+
# present in the request.
|
866
900
|
# @!attribute [rw] allow_missing
|
867
901
|
# @return [::Boolean]
|
868
|
-
# Optional. If set to true and the entry
|
902
|
+
# Optional. If set to true and the entry doesn't exist, the service will
|
903
|
+
# create it.
|
869
904
|
# @!attribute [rw] delete_missing_aspects
|
870
905
|
# @return [::Boolean]
|
871
|
-
# Optional. If set to true and the aspect_keys specify aspect ranges,
|
872
|
-
# existing aspects from that range
|
873
|
-
#
|
906
|
+
# Optional. If set to true and the aspect_keys specify aspect ranges, the
|
907
|
+
# service deletes any existing aspects from that range that weren't provided
|
908
|
+
# in the request.
|
874
909
|
# @!attribute [rw] aspect_keys
|
875
910
|
# @return [::Array<::String>]
|
876
|
-
# Optional. The map keys of the Aspects which should
|
877
|
-
# the following syntaxes:
|
878
|
-
# * <aspect_type_reference> - matches aspect on given type and empty path
|
879
|
-
# * <aspect_type_reference>@path - matches aspect on given type and specified
|
880
|
-
# path
|
881
|
-
# * <aspect_type_reference>* - matches aspects on given type for all paths
|
882
|
-
# * *@path - matches aspects of all types on the given path
|
911
|
+
# Optional. The map keys of the Aspects which the service should modify. It
|
912
|
+
# supports the following syntaxes:
|
883
913
|
#
|
884
|
-
#
|
914
|
+
# * `<aspect_type_reference>` - matches an aspect of the given type and empty
|
915
|
+
# path.
|
916
|
+
# * `<aspect_type_reference>@path` - matches an aspect of the given type and
|
917
|
+
# specified path. For example, to attach an aspect to a field that is
|
918
|
+
# specified by the `schema` aspect, the path should have the format
|
919
|
+
# `Schema.<field_name>`.
|
920
|
+
# * `<aspect_type_reference>*` - matches aspects of the given type for all
|
921
|
+
# paths.
|
922
|
+
# * `*@path` - matches aspects of all types on the given path.
|
923
|
+
#
|
924
|
+
# The service will not remove existing aspects matching the syntax unless
|
885
925
|
# `delete_missing_aspects` is set to true.
|
886
926
|
#
|
887
|
-
# If this field is left empty,
|
888
|
-
# Aspects present in the request.
|
927
|
+
# If this field is left empty, the service treats it as specifying
|
928
|
+
# exactly those Aspects present in the request.
|
889
929
|
class UpdateEntryRequest
|
890
930
|
include ::Google::Protobuf::MessageExts
|
891
931
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
892
932
|
end
|
893
933
|
|
934
|
+
# Delete Entry request.
|
894
935
|
# @!attribute [rw] name
|
895
936
|
# @return [::String]
|
896
937
|
# Required. The resource name of the Entry:
|
@@ -900,82 +941,101 @@ module Google
|
|
900
941
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
901
942
|
end
|
902
943
|
|
944
|
+
# List Entries request.
|
903
945
|
# @!attribute [rw] parent
|
904
946
|
# @return [::String]
|
905
947
|
# Required. The resource name of the parent Entry Group:
|
906
948
|
# `projects/{project}/locations/{location}/entryGroups/{entry_group}`.
|
907
949
|
# @!attribute [rw] page_size
|
908
950
|
# @return [::Integer]
|
951
|
+
# Optional. Number of items to return per page. If there are remaining
|
952
|
+
# results, the service returns a next_page_token. If unspecified, the service
|
953
|
+
# returns at most 10 Entries. The maximum value is 100; values above 100 will
|
954
|
+
# be coerced to 100.
|
909
955
|
# @!attribute [rw] page_token
|
910
956
|
# @return [::String]
|
911
|
-
# Optional.
|
957
|
+
# Optional. Page token received from a previous `ListEntries` call. Provide
|
958
|
+
# this to retrieve the subsequent page.
|
912
959
|
# @!attribute [rw] filter
|
913
960
|
# @return [::String]
|
914
|
-
# Optional. A filter on the entries to return.
|
915
|
-
#
|
916
|
-
#
|
917
|
-
# entry_type
|
918
|
-
#
|
919
|
-
#
|
920
|
-
# The
|
921
|
-
#
|
922
|
-
#
|
923
|
-
#
|
924
|
-
#
|
925
|
-
# "
|
926
|
-
#
|
927
|
-
#
|
961
|
+
# Optional. A filter on the entries to return. Filters are case-sensitive.
|
962
|
+
# You can filter the request by the following fields:
|
963
|
+
#
|
964
|
+
# * entry_type
|
965
|
+
# * entry_source.display_name
|
966
|
+
#
|
967
|
+
# The comparison operators are =, !=, <, >, <=, >=. The service compares
|
968
|
+
# strings according to lexical order.
|
969
|
+
#
|
970
|
+
# You can use the logical operators AND, OR, NOT in the filter.
|
971
|
+
#
|
972
|
+
# You can use Wildcard "*", but for entry_type you need to provide the
|
973
|
+
# full project id or number.
|
974
|
+
#
|
975
|
+
# Example filter expressions:
|
976
|
+
#
|
977
|
+
# * "entry_source.display_name=AnExampleDisplayName"
|
978
|
+
# * "entry_type=projects/example-project/locations/global/entryTypes/example-entry_type"
|
979
|
+
# * "entry_type=projects/example-project/locations/us/entryTypes/a* OR
|
980
|
+
# entry_type=projects/another-project/locations/*"
|
981
|
+
# * "NOT entry_source.display_name=AnotherExampleDisplayName"
|
928
982
|
class ListEntriesRequest
|
929
983
|
include ::Google::Protobuf::MessageExts
|
930
984
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
931
985
|
end
|
932
986
|
|
987
|
+
# List Entries response.
|
933
988
|
# @!attribute [rw] entries
|
934
989
|
# @return [::Array<::Google::Cloud::Dataplex::V1::Entry>]
|
935
|
-
# The list of entries.
|
990
|
+
# The list of entries under the given parent location.
|
936
991
|
# @!attribute [rw] next_page_token
|
937
992
|
# @return [::String]
|
938
|
-
#
|
993
|
+
# Token to retrieve the next page of results, or empty if there are no more
|
994
|
+
# results in the list.
|
939
995
|
class ListEntriesResponse
|
940
996
|
include ::Google::Protobuf::MessageExts
|
941
997
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
942
998
|
end
|
943
999
|
|
1000
|
+
# Get Entry request.
|
944
1001
|
# @!attribute [rw] name
|
945
1002
|
# @return [::String]
|
946
1003
|
# Required. The resource name of the Entry:
|
947
1004
|
# `projects/{project}/locations/{location}/entryGroups/{entry_group}/entries/{entry}`.
|
948
1005
|
# @!attribute [rw] view
|
949
1006
|
# @return [::Google::Cloud::Dataplex::V1::EntryView]
|
950
|
-
# Optional. View
|
1007
|
+
# Optional. View to control which parts of an entry the service should
|
1008
|
+
# return.
|
951
1009
|
# @!attribute [rw] aspect_types
|
952
1010
|
# @return [::Array<::String>]
|
953
1011
|
# Optional. Limits the aspects returned to the provided aspect types.
|
954
|
-
#
|
1012
|
+
# It only works for CUSTOM view.
|
955
1013
|
# @!attribute [rw] paths
|
956
1014
|
# @return [::Array<::String>]
|
957
1015
|
# Optional. Limits the aspects returned to those associated with the provided
|
958
|
-
# paths within the Entry.
|
1016
|
+
# paths within the Entry. It only works for CUSTOM view.
|
959
1017
|
class GetEntryRequest
|
960
1018
|
include ::Google::Protobuf::MessageExts
|
961
1019
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
962
1020
|
end
|
963
1021
|
|
1022
|
+
# Lookup Entry request using permissions in the source system.
|
964
1023
|
# @!attribute [rw] name
|
965
1024
|
# @return [::String]
|
966
1025
|
# Required. The project to which the request should be attributed in the
|
967
1026
|
# following form: `projects/{project}/locations/{location}`.
|
968
1027
|
# @!attribute [rw] view
|
969
1028
|
# @return [::Google::Cloud::Dataplex::V1::EntryView]
|
970
|
-
# Optional. View
|
1029
|
+
# Optional. View to control which parts of an entry the service should
|
1030
|
+
# return.
|
971
1031
|
# @!attribute [rw] aspect_types
|
972
1032
|
# @return [::Array<::String>]
|
973
1033
|
# Optional. Limits the aspects returned to the provided aspect types.
|
974
|
-
#
|
1034
|
+
# It only works for CUSTOM view.
|
975
1035
|
# @!attribute [rw] paths
|
976
1036
|
# @return [::Array<::String>]
|
977
1037
|
# Optional. Limits the aspects returned to those associated with the provided
|
978
|
-
# paths within the Entry.
|
1038
|
+
# paths within the Entry. It only works for CUSTOM view.
|
979
1039
|
# @!attribute [rw] entry
|
980
1040
|
# @return [::String]
|
981
1041
|
# Required. The resource name of the Entry:
|
@@ -994,18 +1054,22 @@ module Google
|
|
994
1054
|
# Required. The query against which entries in scope should be matched.
|
995
1055
|
# @!attribute [rw] page_size
|
996
1056
|
# @return [::Integer]
|
997
|
-
# Optional.
|
1057
|
+
# Optional. Number of results in the search page. If <=0, then defaults
|
1058
|
+
# to 10. Max limit for page_size is 1000. Throws an invalid argument for
|
1059
|
+
# page_size > 1000.
|
998
1060
|
# @!attribute [rw] page_token
|
999
1061
|
# @return [::String]
|
1062
|
+
# Optional. Page token received from a previous `SearchEntries` call. Provide
|
1063
|
+
# this to retrieve the subsequent page.
|
1000
1064
|
# @!attribute [rw] order_by
|
1001
1065
|
# @return [::String]
|
1002
|
-
# Optional.
|
1066
|
+
# Optional. Specifies the ordering of results.
|
1003
1067
|
# @!attribute [rw] scope
|
1004
1068
|
# @return [::String]
|
1005
|
-
# Optional. The scope under which the search should be operating.
|
1006
|
-
# either be organizations/<org_id
|
1007
|
-
# unspecified, it
|
1008
|
-
#
|
1069
|
+
# Optional. The scope under which the search should be operating. It must
|
1070
|
+
# either be `organizations/<org_id>` or `projects/<project_ref>`. If it is
|
1071
|
+
# unspecified, it defaults to the organization where the project provided in
|
1072
|
+
# `name` is located.
|
1009
1073
|
class SearchEntriesRequest
|
1010
1074
|
include ::Google::Protobuf::MessageExts
|
1011
1075
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -1044,20 +1108,432 @@ module Google
|
|
1044
1108
|
# The results matching the search query.
|
1045
1109
|
# @!attribute [rw] total_size
|
1046
1110
|
# @return [::Integer]
|
1047
|
-
# The estimated total number of matching entries.
|
1048
|
-
# accurate.
|
1111
|
+
# The estimated total number of matching entries. This number isn't
|
1112
|
+
# guaranteed to be accurate.
|
1049
1113
|
# @!attribute [rw] next_page_token
|
1050
1114
|
# @return [::String]
|
1051
|
-
#
|
1115
|
+
# Token to retrieve the next page of results, or empty if there are no more
|
1116
|
+
# results in the list.
|
1052
1117
|
# @!attribute [rw] unreachable
|
1053
1118
|
# @return [::Array<::String>]
|
1054
|
-
#
|
1055
|
-
# locations.
|
1119
|
+
# Locations that the service couldn't reach. Search results don't include
|
1120
|
+
# data from these locations.
|
1056
1121
|
class SearchEntriesResponse
|
1057
1122
|
include ::Google::Protobuf::MessageExts
|
1058
1123
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
1059
1124
|
end
|
1060
1125
|
|
1126
|
+
# An object that describes the values that you want to set for an entry and its
|
1127
|
+
# attached aspects when you import metadata. Used when you run a metadata
|
1128
|
+
# import job. See
|
1129
|
+
# {::Google::Cloud::Dataplex::V1::CatalogService::Client#create_metadata_job CreateMetadataJob}.
|
1130
|
+
#
|
1131
|
+
# You provide a collection of import items in a metadata import file. For more
|
1132
|
+
# information about how to create a metadata import file, see [Metadata import
|
1133
|
+
# file](https://cloud.google.com/dataplex/docs/import-metadata#metadata-import-file).
|
1134
|
+
# @!attribute [rw] entry
|
1135
|
+
# @return [::Google::Cloud::Dataplex::V1::Entry]
|
1136
|
+
# Information about an entry and its attached aspects.
|
1137
|
+
# @!attribute [rw] update_mask
|
1138
|
+
# @return [::Google::Protobuf::FieldMask]
|
1139
|
+
# The fields to update, in paths that are relative to the `Entry` resource.
|
1140
|
+
# Separate each field with a comma.
|
1141
|
+
#
|
1142
|
+
# In `FULL` entry sync mode, Dataplex includes the paths of all of the fields
|
1143
|
+
# for an entry that can be modified, including aspects. This means that
|
1144
|
+
# Dataplex replaces the existing entry with the entry in the metadata import
|
1145
|
+
# file. All modifiable fields are updated, regardless of the fields that are
|
1146
|
+
# listed in the update mask, and regardless of whether a field is present
|
1147
|
+
# in the `entry` object.
|
1148
|
+
#
|
1149
|
+
#
|
1150
|
+
# The `update_mask` field is ignored when an entry is created or re-created.
|
1151
|
+
#
|
1152
|
+
# Dataplex also determines which entries and aspects to modify by comparing
|
1153
|
+
# the values and timestamps that you provide in the metadata import file with
|
1154
|
+
# the values and timestamps that exist in your project. For more information,
|
1155
|
+
# see [Comparison
|
1156
|
+
# logic](https://cloud.google.com/dataplex/docs/import-metadata#data-modification-logic).
|
1157
|
+
# @!attribute [rw] aspect_keys
|
1158
|
+
# @return [::Array<::String>]
|
1159
|
+
# The aspects to modify. Supports the following syntaxes:
|
1160
|
+
#
|
1161
|
+
# * `{aspect_type_reference}`: matches aspects that belong to the specified
|
1162
|
+
# aspect type and are attached directly to the entry.
|
1163
|
+
# * `{aspect_type_reference}@{path}`: matches aspects that belong to the
|
1164
|
+
# specified aspect type and path.
|
1165
|
+
# * `{aspect_type_reference}@*`: matches aspects that belong to the specified
|
1166
|
+
# aspect type for all paths.
|
1167
|
+
#
|
1168
|
+
# Replace `{aspect_type_reference}` with a reference to the aspect type, in
|
1169
|
+
# the format
|
1170
|
+
# `{project_id_or_number}.{location_id}.{aspect_type_id}`.
|
1171
|
+
#
|
1172
|
+
# If you leave this field empty, it is treated as specifying exactly those
|
1173
|
+
# aspects that are present within the specified entry.
|
1174
|
+
#
|
1175
|
+
# In `FULL` entry sync mode, Dataplex implicitly adds the keys for all of the
|
1176
|
+
# required aspects of an entry.
|
1177
|
+
class ImportItem
|
1178
|
+
include ::Google::Protobuf::MessageExts
|
1179
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
1180
|
+
end
|
1181
|
+
|
1182
|
+
# Create metadata job request.
|
1183
|
+
# @!attribute [rw] parent
|
1184
|
+
# @return [::String]
|
1185
|
+
# Required. The resource name of the parent location, in the format
|
1186
|
+
# `projects/{project_id_or_number}/locations/{location_id}`
|
1187
|
+
# @!attribute [rw] metadata_job
|
1188
|
+
# @return [::Google::Cloud::Dataplex::V1::MetadataJob]
|
1189
|
+
# Required. The metadata job resource.
|
1190
|
+
# @!attribute [rw] metadata_job_id
|
1191
|
+
# @return [::String]
|
1192
|
+
# Optional. The metadata job ID. If not provided, a unique ID is generated
|
1193
|
+
# with the prefix `metadata-job-`.
|
1194
|
+
# @!attribute [rw] validate_only
|
1195
|
+
# @return [::Boolean]
|
1196
|
+
# Optional. The service validates the request without performing any
|
1197
|
+
# mutations. The default is false.
|
1198
|
+
class CreateMetadataJobRequest
|
1199
|
+
include ::Google::Protobuf::MessageExts
|
1200
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
1201
|
+
end
|
1202
|
+
|
1203
|
+
# Get metadata job request.
|
1204
|
+
# @!attribute [rw] name
|
1205
|
+
# @return [::String]
|
1206
|
+
# Required. The resource name of the metadata job, in the format
|
1207
|
+
# `projects/{project_id_or_number}/locations/{location_id}/metadataJobs/{metadata_job_id}`.
|
1208
|
+
class GetMetadataJobRequest
|
1209
|
+
include ::Google::Protobuf::MessageExts
|
1210
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
1211
|
+
end
|
1212
|
+
|
1213
|
+
# List metadata jobs request.
|
1214
|
+
# @!attribute [rw] parent
|
1215
|
+
# @return [::String]
|
1216
|
+
# Required. The resource name of the parent location, in the format
|
1217
|
+
# `projects/{project_id_or_number}/locations/{location_id}`
|
1218
|
+
# @!attribute [rw] page_size
|
1219
|
+
# @return [::Integer]
|
1220
|
+
# Optional. The maximum number of metadata jobs to return. The service might
|
1221
|
+
# return fewer jobs than this value. If unspecified, at most 10 jobs are
|
1222
|
+
# returned. The maximum value is 1,000.
|
1223
|
+
# @!attribute [rw] page_token
|
1224
|
+
# @return [::String]
|
1225
|
+
# Optional. The page token received from a previous `ListMetadataJobs` call.
|
1226
|
+
# Provide this token to retrieve the subsequent page of results. When
|
1227
|
+
# paginating, all other parameters that are provided to the
|
1228
|
+
# `ListMetadataJobs` request must match the call that provided the page
|
1229
|
+
# token.
|
1230
|
+
# @!attribute [rw] filter
|
1231
|
+
# @return [::String]
|
1232
|
+
# Optional. Filter request. Filters are case-sensitive.
|
1233
|
+
# The service supports the following formats:
|
1234
|
+
#
|
1235
|
+
# * `labels.key1 = "value1"`
|
1236
|
+
# * `labels:key1`
|
1237
|
+
# * `name = "value"`
|
1238
|
+
#
|
1239
|
+
# You can combine filters with `AND`, `OR`, and `NOT` operators.
|
1240
|
+
# @!attribute [rw] order_by
|
1241
|
+
# @return [::String]
|
1242
|
+
# Optional. The field to sort the results by, either `name` or `create_time`.
|
1243
|
+
# If not specified, the ordering is undefined.
|
1244
|
+
class ListMetadataJobsRequest
|
1245
|
+
include ::Google::Protobuf::MessageExts
|
1246
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
1247
|
+
end
|
1248
|
+
|
1249
|
+
# List metadata jobs response.
|
1250
|
+
# @!attribute [rw] metadata_jobs
|
1251
|
+
# @return [::Array<::Google::Cloud::Dataplex::V1::MetadataJob>]
|
1252
|
+
# Metadata jobs under the specified parent location.
|
1253
|
+
# @!attribute [rw] next_page_token
|
1254
|
+
# @return [::String]
|
1255
|
+
# A token to retrieve the next page of results. If there are no more results
|
1256
|
+
# in the list, the value is empty.
|
1257
|
+
# @!attribute [rw] unreachable_locations
|
1258
|
+
# @return [::Array<::String>]
|
1259
|
+
# Locations that the service couldn't reach.
|
1260
|
+
class ListMetadataJobsResponse
|
1261
|
+
include ::Google::Protobuf::MessageExts
|
1262
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
1263
|
+
end
|
1264
|
+
|
1265
|
+
# Cancel metadata job request.
|
1266
|
+
# @!attribute [rw] name
|
1267
|
+
# @return [::String]
|
1268
|
+
# Required. The resource name of the job, in the format
|
1269
|
+
# `projects/{project_id_or_number}/locations/{location_id}/metadataJobs/{metadata_job_id}`
|
1270
|
+
class CancelMetadataJobRequest
|
1271
|
+
include ::Google::Protobuf::MessageExts
|
1272
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
1273
|
+
end
|
1274
|
+
|
1275
|
+
# A metadata job resource.
|
1276
|
+
# @!attribute [r] name
|
1277
|
+
# @return [::String]
|
1278
|
+
# Output only. Identifier. The name of the resource that the configuration is
|
1279
|
+
# applied to, in the format
|
1280
|
+
# `projects/{project_number}/locations/{location_id}/metadataJobs/{metadata_job_id}`.
|
1281
|
+
# @!attribute [r] uid
|
1282
|
+
# @return [::String]
|
1283
|
+
# Output only. A system-generated, globally unique ID for the metadata job.
|
1284
|
+
# If the metadata job is deleted and then re-created with the same name, this
|
1285
|
+
# ID is different.
|
1286
|
+
# @!attribute [r] create_time
|
1287
|
+
# @return [::Google::Protobuf::Timestamp]
|
1288
|
+
# Output only. The time when the metadata job was created.
|
1289
|
+
# @!attribute [r] update_time
|
1290
|
+
# @return [::Google::Protobuf::Timestamp]
|
1291
|
+
# Output only. The time when the metadata job was updated.
|
1292
|
+
# @!attribute [rw] labels
|
1293
|
+
# @return [::Google::Protobuf::Map{::String => ::String}]
|
1294
|
+
# Optional. User-defined labels.
|
1295
|
+
# @!attribute [rw] type
|
1296
|
+
# @return [::Google::Cloud::Dataplex::V1::MetadataJob::Type]
|
1297
|
+
# Required. Metadata job type.
|
1298
|
+
# @!attribute [rw] import_spec
|
1299
|
+
# @return [::Google::Cloud::Dataplex::V1::MetadataJob::ImportJobSpec]
|
1300
|
+
# Import job specification.
|
1301
|
+
# @!attribute [r] import_result
|
1302
|
+
# @return [::Google::Cloud::Dataplex::V1::MetadataJob::ImportJobResult]
|
1303
|
+
# Output only. Import job result.
|
1304
|
+
# @!attribute [r] status
|
1305
|
+
# @return [::Google::Cloud::Dataplex::V1::MetadataJob::Status]
|
1306
|
+
# Output only. Metadata job status.
|
1307
|
+
class MetadataJob
|
1308
|
+
include ::Google::Protobuf::MessageExts
|
1309
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
1310
|
+
|
1311
|
+
# Results from a metadata import job.
|
1312
|
+
# @!attribute [r] deleted_entries
|
1313
|
+
# @return [::Integer]
|
1314
|
+
# Output only. The total number of entries that were deleted.
|
1315
|
+
# @!attribute [r] updated_entries
|
1316
|
+
# @return [::Integer]
|
1317
|
+
# Output only. The total number of entries that were updated.
|
1318
|
+
# @!attribute [r] created_entries
|
1319
|
+
# @return [::Integer]
|
1320
|
+
# Output only. The total number of entries that were created.
|
1321
|
+
# @!attribute [r] unchanged_entries
|
1322
|
+
# @return [::Integer]
|
1323
|
+
# Output only. The total number of entries that were unchanged.
|
1324
|
+
# @!attribute [r] recreated_entries
|
1325
|
+
# @return [::Integer]
|
1326
|
+
# Output only. The total number of entries that were recreated.
|
1327
|
+
# @!attribute [r] update_time
|
1328
|
+
# @return [::Google::Protobuf::Timestamp]
|
1329
|
+
# Output only. The time when the status was updated.
|
1330
|
+
class ImportJobResult
|
1331
|
+
include ::Google::Protobuf::MessageExts
|
1332
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
1333
|
+
end
|
1334
|
+
|
1335
|
+
# Job specification for a metadata import job
|
1336
|
+
# @!attribute [rw] source_storage_uri
|
1337
|
+
# @return [::String]
|
1338
|
+
# Optional. The URI of a Cloud Storage bucket or folder (beginning with
|
1339
|
+
# `gs://` and ending with `/`) that contains the metadata import files for
|
1340
|
+
# this job.
|
1341
|
+
#
|
1342
|
+
# A metadata import file defines the values to set for each of the entries
|
1343
|
+
# and aspects in a metadata job. For more information about how to create a
|
1344
|
+
# metadata import file and the file requirements, see [Metadata import
|
1345
|
+
# file](https://cloud.google.com/dataplex/docs/import-metadata#metadata-import-file).
|
1346
|
+
#
|
1347
|
+
# You can provide multiple metadata import files in the same metadata job.
|
1348
|
+
# The bucket or folder must contain at least one metadata import file, in
|
1349
|
+
# JSON Lines format (either `.json` or `.jsonl` file extension).
|
1350
|
+
#
|
1351
|
+
# In `FULL` entry sync mode, don't save the metadata import file in a
|
1352
|
+
# folder named `SOURCE_STORAGE_URI/deletions/`.
|
1353
|
+
#
|
1354
|
+
# **Caution**: If the metadata import file contains no data, all entries
|
1355
|
+
# and aspects that belong to the job's scope are deleted.
|
1356
|
+
# @!attribute [rw] source_create_time
|
1357
|
+
# @return [::Google::Protobuf::Timestamp]
|
1358
|
+
# Optional. The time when the process that created the metadata import
|
1359
|
+
# files began.
|
1360
|
+
# @!attribute [rw] scope
|
1361
|
+
# @return [::Google::Cloud::Dataplex::V1::MetadataJob::ImportJobSpec::ImportJobScope]
|
1362
|
+
# Required. A boundary on the scope of impact that the metadata import job
|
1363
|
+
# can have.
|
1364
|
+
# @!attribute [rw] entry_sync_mode
|
1365
|
+
# @return [::Google::Cloud::Dataplex::V1::MetadataJob::ImportJobSpec::SyncMode]
|
1366
|
+
# Required. The sync mode for entries.
|
1367
|
+
# Only `FULL` mode is supported for entries. All entries in the job's scope
|
1368
|
+
# are modified. If an entry exists in Dataplex but isn't included in the
|
1369
|
+
# metadata import file, the entry is deleted when you run the metadata job.
|
1370
|
+
# @!attribute [rw] aspect_sync_mode
|
1371
|
+
# @return [::Google::Cloud::Dataplex::V1::MetadataJob::ImportJobSpec::SyncMode]
|
1372
|
+
# Required. The sync mode for aspects.
|
1373
|
+
# Only `INCREMENTAL` mode is supported for aspects. An aspect is modified
|
1374
|
+
# only if the metadata import file includes a reference to the aspect in
|
1375
|
+
# the `update_mask` field and the `aspect_keys` field.
|
1376
|
+
# @!attribute [rw] log_level
|
1377
|
+
# @return [::Google::Cloud::Dataplex::V1::MetadataJob::ImportJobSpec::LogLevel]
|
1378
|
+
# Optional. The level of logs to write to Cloud Logging for this job.
|
1379
|
+
#
|
1380
|
+
# Debug-level logs provide highly-detailed information for
|
1381
|
+
# troubleshooting, but their increased verbosity could incur [additional
|
1382
|
+
# costs](https://cloud.google.com/stackdriver/pricing) that might not be
|
1383
|
+
# merited for all jobs.
|
1384
|
+
#
|
1385
|
+
# If unspecified, defaults to `INFO`.
|
1386
|
+
class ImportJobSpec
|
1387
|
+
include ::Google::Protobuf::MessageExts
|
1388
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
1389
|
+
|
1390
|
+
# A boundary on the scope of impact that the metadata import job can have.
|
1391
|
+
# @!attribute [rw] entry_groups
|
1392
|
+
# @return [::Array<::String>]
|
1393
|
+
# Required. The entry group that is in scope for the import job,
|
1394
|
+
# specified as a relative resource name in the format
|
1395
|
+
# `projects/{project_number_or_id}/locations/{location_id}/entryGroups/{entry_group_id}`.
|
1396
|
+
# Only entries that belong to the specified entry group are affected by
|
1397
|
+
# the job.
|
1398
|
+
#
|
1399
|
+
# Must contain exactly one element. The entry group and the job
|
1400
|
+
# must be in the same location.
|
1401
|
+
# @!attribute [rw] entry_types
|
1402
|
+
# @return [::Array<::String>]
|
1403
|
+
# Required. The entry types that are in scope for the import job,
|
1404
|
+
# specified as relative resource names in the format
|
1405
|
+
# `projects/{project_number_or_id}/locations/{location_id}/entryTypes/{entry_type_id}`.
|
1406
|
+
# The job modifies only the entries that belong to these entry types.
|
1407
|
+
#
|
1408
|
+
# If the metadata import file attempts to modify an entry whose type
|
1409
|
+
# isn't included in this list, the import job is halted before modifying
|
1410
|
+
# any entries or aspects.
|
1411
|
+
#
|
1412
|
+
# The location of an entry type must either match the location of the
|
1413
|
+
# job, or the entry type must be global.
|
1414
|
+
# @!attribute [rw] aspect_types
|
1415
|
+
# @return [::Array<::String>]
|
1416
|
+
# Optional. The aspect types that are in scope for the import job,
|
1417
|
+
# specified as relative resource names in the format
|
1418
|
+
# `projects/{project_number_or_id}/locations/{location_id}/aspectTypes/{aspect_type_id}`.
|
1419
|
+
# The job modifies only the aspects that belong to these aspect types.
|
1420
|
+
#
|
1421
|
+
# If the metadata import file attempts to modify an aspect whose type
|
1422
|
+
# isn't included in this list, the import job is halted before modifying
|
1423
|
+
# any entries or aspects.
|
1424
|
+
#
|
1425
|
+
# The location of an aspect type must either match the location of the
|
1426
|
+
# job, or the aspect type must be global.
|
1427
|
+
class ImportJobScope
|
1428
|
+
include ::Google::Protobuf::MessageExts
|
1429
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
1430
|
+
end
|
1431
|
+
|
1432
|
+
# Specifies how the entries and aspects in a metadata job are updated.
|
1433
|
+
module SyncMode
|
1434
|
+
# Sync mode unspecified.
|
1435
|
+
SYNC_MODE_UNSPECIFIED = 0
|
1436
|
+
|
1437
|
+
# All resources in the job's scope are modified. If a resource exists in
|
1438
|
+
# Dataplex but isn't included in the metadata import file, the resource
|
1439
|
+
# is deleted when you run the metadata job. Use this mode to perform a
|
1440
|
+
# full sync of the set of entries in the job scope.
|
1441
|
+
FULL = 1
|
1442
|
+
|
1443
|
+
# Only the entries and aspects that are explicitly included in the
|
1444
|
+
# metadata import file are modified. Use this mode to modify a subset of
|
1445
|
+
# resources while leaving unreferenced resources unchanged.
|
1446
|
+
INCREMENTAL = 2
|
1447
|
+
end
|
1448
|
+
|
1449
|
+
# The level of logs to write to Cloud Logging for this job.
|
1450
|
+
module LogLevel
|
1451
|
+
# Log level unspecified.
|
1452
|
+
LOG_LEVEL_UNSPECIFIED = 0
|
1453
|
+
|
1454
|
+
# Debug-level logging. Captures detailed logs for each import item. Use
|
1455
|
+
# debug-level logging to troubleshoot issues with specific import items.
|
1456
|
+
# For example, use debug-level logging to identify resources that are
|
1457
|
+
# missing from the job scope, entries or aspects that don't conform to
|
1458
|
+
# the associated entry type or aspect type, or other misconfigurations
|
1459
|
+
# with the metadata import file.
|
1460
|
+
#
|
1461
|
+
# Depending on the size of your metadata job and the number of logs that
|
1462
|
+
# are generated, debug-level logging might incur
|
1463
|
+
# [additional costs](https://cloud.google.com/stackdriver/pricing).
|
1464
|
+
DEBUG = 1
|
1465
|
+
|
1466
|
+
# Info-level logging. Captures logs at the overall job level. Includes
|
1467
|
+
# aggregate logs about import items, but doesn't specify which import
|
1468
|
+
# item has an error.
|
1469
|
+
INFO = 2
|
1470
|
+
end
|
1471
|
+
end
|
1472
|
+
|
1473
|
+
# Metadata job status.
|
1474
|
+
# @!attribute [r] state
|
1475
|
+
# @return [::Google::Cloud::Dataplex::V1::MetadataJob::Status::State]
|
1476
|
+
# Output only. State of the metadata job.
|
1477
|
+
# @!attribute [r] message
|
1478
|
+
# @return [::String]
|
1479
|
+
# Output only. Message relating to the progression of a metadata job.
|
1480
|
+
# @!attribute [r] completion_percent
|
1481
|
+
# @return [::Integer]
|
1482
|
+
# Output only. Progress tracking.
|
1483
|
+
# @!attribute [r] update_time
|
1484
|
+
# @return [::Google::Protobuf::Timestamp]
|
1485
|
+
# Output only. The time when the status was updated.
|
1486
|
+
class Status
|
1487
|
+
include ::Google::Protobuf::MessageExts
|
1488
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
1489
|
+
|
1490
|
+
# State of a metadata job.
|
1491
|
+
module State
|
1492
|
+
# State unspecified.
|
1493
|
+
STATE_UNSPECIFIED = 0
|
1494
|
+
|
1495
|
+
# The job is queued.
|
1496
|
+
QUEUED = 1
|
1497
|
+
|
1498
|
+
# The job is running.
|
1499
|
+
RUNNING = 2
|
1500
|
+
|
1501
|
+
# The job is being canceled.
|
1502
|
+
CANCELING = 3
|
1503
|
+
|
1504
|
+
# The job is canceled.
|
1505
|
+
CANCELED = 4
|
1506
|
+
|
1507
|
+
# The job succeeded.
|
1508
|
+
SUCCEEDED = 5
|
1509
|
+
|
1510
|
+
# The job failed.
|
1511
|
+
FAILED = 6
|
1512
|
+
|
1513
|
+
# The job completed with some errors.
|
1514
|
+
SUCCEEDED_WITH_ERRORS = 7
|
1515
|
+
end
|
1516
|
+
end
|
1517
|
+
|
1518
|
+
# @!attribute [rw] key
|
1519
|
+
# @return [::String]
|
1520
|
+
# @!attribute [rw] value
|
1521
|
+
# @return [::String]
|
1522
|
+
class LabelsEntry
|
1523
|
+
include ::Google::Protobuf::MessageExts
|
1524
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
1525
|
+
end
|
1526
|
+
|
1527
|
+
# Metadata job type.
|
1528
|
+
module Type
|
1529
|
+
# Unspecified.
|
1530
|
+
TYPE_UNSPECIFIED = 0
|
1531
|
+
|
1532
|
+
# Import job.
|
1533
|
+
IMPORT = 1
|
1534
|
+
end
|
1535
|
+
end
|
1536
|
+
|
1061
1537
|
# View for controlling which parts of an entry are to be returned.
|
1062
1538
|
module EntryView
|
1063
1539
|
# Unspecified EntryView. Defaults to FULL.
|
@@ -1071,10 +1547,10 @@ module Google
|
|
1071
1547
|
FULL = 2
|
1072
1548
|
|
1073
1549
|
# Returns aspects matching custom fields in GetEntryRequest. If the number of
|
1074
|
-
# aspects
|
1550
|
+
# aspects exceeds 100, the first 100 will be returned.
|
1075
1551
|
CUSTOM = 3
|
1076
1552
|
|
1077
|
-
# Returns all aspects. If the number of aspects
|
1553
|
+
# Returns all aspects. If the number of aspects exceeds 100, the first
|
1078
1554
|
# 100 will be returned.
|
1079
1555
|
ALL = 4
|
1080
1556
|
end
|