google-cloud-data_catalog-v1beta1 0.a → 0.2.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (65) hide show
  1. checksums.yaml +4 -4
  2. data/.yardopts +12 -0
  3. data/AUTHENTICATION.md +149 -0
  4. data/README.md +144 -8
  5. data/lib/google/cloud/data_catalog/v1beta1/data_catalog/client.rb +3303 -0
  6. data/lib/google/cloud/data_catalog/v1beta1/data_catalog/credentials.rb +47 -0
  7. data/lib/google/cloud/data_catalog/v1beta1/data_catalog/paths.rb +176 -0
  8. data/lib/google/cloud/data_catalog/v1beta1/data_catalog/rest/client.rb +3093 -0
  9. data/lib/google/cloud/data_catalog/v1beta1/data_catalog/rest/service_stub.rb +1782 -0
  10. data/lib/google/cloud/data_catalog/v1beta1/data_catalog/rest.rb +53 -0
  11. data/lib/google/cloud/data_catalog/v1beta1/data_catalog.rb +56 -0
  12. data/lib/google/cloud/data_catalog/v1beta1/policy_tag_manager/client.rb +1590 -0
  13. data/lib/google/cloud/data_catalog/v1beta1/policy_tag_manager/credentials.rb +47 -0
  14. data/lib/google/cloud/data_catalog/v1beta1/policy_tag_manager/paths.rb +90 -0
  15. data/lib/google/cloud/data_catalog/v1beta1/policy_tag_manager/rest/client.rb +1470 -0
  16. data/lib/google/cloud/data_catalog/v1beta1/policy_tag_manager/rest/service_stub.rb +846 -0
  17. data/lib/google/cloud/data_catalog/v1beta1/policy_tag_manager/rest.rb +53 -0
  18. data/lib/google/cloud/data_catalog/v1beta1/policy_tag_manager.rb +56 -0
  19. data/lib/google/cloud/data_catalog/v1beta1/policy_tag_manager_serialization/client.rb +522 -0
  20. data/lib/google/cloud/data_catalog/v1beta1/policy_tag_manager_serialization/credentials.rb +47 -0
  21. data/lib/google/cloud/data_catalog/v1beta1/policy_tag_manager_serialization/paths.rb +69 -0
  22. data/lib/google/cloud/data_catalog/v1beta1/policy_tag_manager_serialization/rest/client.rb +479 -0
  23. data/lib/google/cloud/data_catalog/v1beta1/policy_tag_manager_serialization/rest/service_stub.rb +167 -0
  24. data/lib/google/cloud/data_catalog/v1beta1/policy_tag_manager_serialization/rest.rb +53 -0
  25. data/lib/google/cloud/data_catalog/v1beta1/policy_tag_manager_serialization.rb +56 -0
  26. data/lib/google/cloud/data_catalog/v1beta1/rest.rb +39 -0
  27. data/lib/google/cloud/data_catalog/v1beta1/version.rb +7 -2
  28. data/lib/google/cloud/data_catalog/v1beta1.rb +47 -0
  29. data/lib/google/cloud/datacatalog/v1beta1/common_pb.rb +43 -0
  30. data/lib/google/cloud/datacatalog/v1beta1/datacatalog_pb.rb +99 -0
  31. data/lib/google/cloud/datacatalog/v1beta1/datacatalog_services_pb.rb +229 -0
  32. data/lib/google/cloud/datacatalog/v1beta1/gcs_fileset_spec_pb.rb +47 -0
  33. data/lib/google/cloud/datacatalog/v1beta1/policytagmanager_pb.rb +70 -0
  34. data/lib/google/cloud/datacatalog/v1beta1/policytagmanager_services_pb.rb +73 -0
  35. data/lib/google/cloud/datacatalog/v1beta1/policytagmanagerserialization_pb.rb +55 -0
  36. data/lib/google/cloud/datacatalog/v1beta1/policytagmanagerserialization_services_pb.rb +55 -0
  37. data/lib/google/cloud/datacatalog/v1beta1/schema_pb.rb +45 -0
  38. data/lib/google/cloud/datacatalog/v1beta1/search_pb.rb +47 -0
  39. data/lib/google/cloud/datacatalog/v1beta1/table_spec_pb.rb +49 -0
  40. data/lib/google/cloud/datacatalog/v1beta1/tags_pb.rb +55 -0
  41. data/lib/google/cloud/datacatalog/v1beta1/timestamps_pb.rb +46 -0
  42. data/lib/google/cloud/datacatalog/v1beta1/usage_pb.rb +46 -0
  43. data/lib/google-cloud-data_catalog-v1beta1.rb +21 -0
  44. data/proto_docs/README.md +4 -0
  45. data/proto_docs/google/api/client.rb +381 -0
  46. data/proto_docs/google/api/field_behavior.rb +85 -0
  47. data/proto_docs/google/api/launch_stage.rb +71 -0
  48. data/proto_docs/google/api/resource.rb +222 -0
  49. data/proto_docs/google/cloud/datacatalog/v1beta1/common.rb +52 -0
  50. data/proto_docs/google/cloud/datacatalog/v1beta1/datacatalog.rb +830 -0
  51. data/proto_docs/google/cloud/datacatalog/v1beta1/gcs_fileset_spec.rb +81 -0
  52. data/proto_docs/google/cloud/datacatalog/v1beta1/policytagmanager.rb +300 -0
  53. data/proto_docs/google/cloud/datacatalog/v1beta1/policytagmanagerserialization.rb +131 -0
  54. data/proto_docs/google/cloud/datacatalog/v1beta1/schema.rb +61 -0
  55. data/proto_docs/google/cloud/datacatalog/v1beta1/search.rb +75 -0
  56. data/proto_docs/google/cloud/datacatalog/v1beta1/table_spec.rb +102 -0
  57. data/proto_docs/google/cloud/datacatalog/v1beta1/tags.rb +242 -0
  58. data/proto_docs/google/cloud/datacatalog/v1beta1/timestamps.rb +42 -0
  59. data/proto_docs/google/cloud/datacatalog/v1beta1/usage.rb +74 -0
  60. data/proto_docs/google/protobuf/duration.rb +98 -0
  61. data/proto_docs/google/protobuf/empty.rb +34 -0
  62. data/proto_docs/google/protobuf/field_mask.rb +229 -0
  63. data/proto_docs/google/protobuf/timestamp.rb +127 -0
  64. data/proto_docs/google/type/expr.rb +75 -0
  65. metadata +242 -13
@@ -0,0 +1,830 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Copyright 2023 Google LLC
4
+ #
5
+ # Licensed under the Apache License, Version 2.0 (the "License");
6
+ # you may not use this file except in compliance with the License.
7
+ # You may obtain a copy of the License at
8
+ #
9
+ # https://www.apache.org/licenses/LICENSE-2.0
10
+ #
11
+ # Unless required by applicable law or agreed to in writing, software
12
+ # distributed under the License is distributed on an "AS IS" BASIS,
13
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14
+ # See the License for the specific language governing permissions and
15
+ # limitations under the License.
16
+
17
+ # Auto-generated by gapic-generator-ruby. DO NOT EDIT!
18
+
19
+
20
+ module Google
21
+ module Cloud
22
+ module DataCatalog
23
+ module V1beta1
24
+ # Request message for
25
+ # {::Google::Cloud::DataCatalog::V1beta1::DataCatalog::Client#search_catalog SearchCatalog}.
26
+ # @!attribute [rw] scope
27
+ # @return [::Google::Cloud::DataCatalog::V1beta1::SearchCatalogRequest::Scope]
28
+ # Required. The scope of this search request. A `scope` that has empty
29
+ # `include_org_ids`, `include_project_ids` AND false
30
+ # `include_gcp_public_datasets` is considered invalid. Data Catalog will
31
+ # return an error in such a case.
32
+ # @!attribute [rw] query
33
+ # @return [::String]
34
+ # Optional. The query string in search query syntax. An empty query string
35
+ # will result in all data assets (in the specified scope) that the user has
36
+ # access to. Query strings can be simple as "x" or more qualified as:
37
+ #
38
+ # * name:x
39
+ # * column:x
40
+ # * description:y
41
+ #
42
+ # Note: Query tokens need to have a minimum of 3 characters for substring
43
+ # matching to work correctly. See [Data Catalog Search
44
+ # Syntax](https://cloud.google.com/data-catalog/docs/how-to/search-reference)
45
+ # for more information.
46
+ # @!attribute [rw] page_size
47
+ # @return [::Integer]
48
+ # Number of results in the search page. If <=0 then defaults to 10. Max limit
49
+ # for page_size is 1000. Throws an invalid argument for page_size > 1000.
50
+ # @!attribute [rw] page_token
51
+ # @return [::String]
52
+ # Optional. Pagination token returned in an earlier
53
+ # {::Google::Cloud::DataCatalog::V1beta1::SearchCatalogResponse#next_page_token SearchCatalogResponse.next_page_token},
54
+ # which indicates that this is a continuation of a prior
55
+ # {::Google::Cloud::DataCatalog::V1beta1::DataCatalog::Client#search_catalog SearchCatalogRequest}
56
+ # call, and that the system should return the next page of data. If empty,
57
+ # the first page is returned.
58
+ # @!attribute [rw] order_by
59
+ # @return [::String]
60
+ # Specifies the ordering of results, currently supported case-sensitive
61
+ # choices are:
62
+ #
63
+ # * `relevance`, only supports descending
64
+ # * `last_modified_timestamp [asc|desc]`, defaults to descending if not
65
+ # specified
66
+ # * `default` that can only be descending
67
+ #
68
+ # If not specified, defaults to `relevance` descending.
69
+ class SearchCatalogRequest
70
+ include ::Google::Protobuf::MessageExts
71
+ extend ::Google::Protobuf::MessageExts::ClassMethods
72
+
73
+ # The criteria that select the subspace used for query matching.
74
+ # @!attribute [rw] include_org_ids
75
+ # @return [::Array<::String>]
76
+ # The list of organization IDs to search within. To find your organization
77
+ # ID, follow instructions in
78
+ # https://cloud.google.com/resource-manager/docs/creating-managing-organization.
79
+ # @!attribute [rw] include_project_ids
80
+ # @return [::Array<::String>]
81
+ # The list of project IDs to search within. To learn more about the
82
+ # distinction between project names/IDs/numbers, go to
83
+ # https://cloud.google.com/docs/overview/#projects.
84
+ # @!attribute [rw] include_gcp_public_datasets
85
+ # @return [::Boolean]
86
+ # If `true`, include Google Cloud public datasets in the
87
+ # search results. Info on Google Cloud public datasets is available at
88
+ # https://cloud.google.com/public-datasets/. By default, Google Cloud
89
+ # public datasets are excluded.
90
+ # @!attribute [rw] restricted_locations
91
+ # @return [::Array<::String>]
92
+ # Optional. The list of locations to search within.
93
+ # 1. If empty, search will be performed in all locations;
94
+ # 2. If any of the locations are NOT in the valid locations list, error
95
+ # will be returned;
96
+ # 3. Otherwise, search only the given locations for matching results.
97
+ # Typical usage is to leave this field empty. When a location is
98
+ # unreachable as returned in the `SearchCatalogResponse.unreachable` field,
99
+ # users can repeat the search request with this parameter set to get
100
+ # additional information on the error.
101
+ #
102
+ # Valid locations:
103
+ # * asia-east1
104
+ # * asia-east2
105
+ # * asia-northeast1
106
+ # * asia-northeast2
107
+ # * asia-northeast3
108
+ # * asia-south1
109
+ # * asia-southeast1
110
+ # * australia-southeast1
111
+ # * eu
112
+ # * europe-north1
113
+ # * europe-west1
114
+ # * europe-west2
115
+ # * europe-west3
116
+ # * europe-west4
117
+ # * europe-west6
118
+ # * global
119
+ # * northamerica-northeast1
120
+ # * southamerica-east1
121
+ # * us
122
+ # * us-central1
123
+ # * us-east1
124
+ # * us-east4
125
+ # * us-west1
126
+ # * us-west2
127
+ class Scope
128
+ include ::Google::Protobuf::MessageExts
129
+ extend ::Google::Protobuf::MessageExts::ClassMethods
130
+ end
131
+ end
132
+
133
+ # Response message for
134
+ # {::Google::Cloud::DataCatalog::V1beta1::DataCatalog::Client#search_catalog SearchCatalog}.
135
+ # @!attribute [rw] results
136
+ # @return [::Array<::Google::Cloud::DataCatalog::V1beta1::SearchCatalogResult>]
137
+ # Search results.
138
+ # @!attribute [rw] total_size
139
+ # @return [::Integer]
140
+ # The approximate total number of entries matched by the query.
141
+ # @!attribute [rw] next_page_token
142
+ # @return [::String]
143
+ # The token that can be used to retrieve the next page of results.
144
+ # @!attribute [rw] unreachable
145
+ # @return [::Array<::String>]
146
+ # Unreachable locations. Search result does not include data from those
147
+ # locations. Users can get additional information on the error by repeating
148
+ # the search request with a more restrictive parameter -- setting the value
149
+ # for `SearchDataCatalogRequest.scope.restricted_locations`.
150
+ class SearchCatalogResponse
151
+ include ::Google::Protobuf::MessageExts
152
+ extend ::Google::Protobuf::MessageExts::ClassMethods
153
+ end
154
+
155
+ # Request message for
156
+ # {::Google::Cloud::DataCatalog::V1beta1::DataCatalog::Client#create_entry_group CreateEntryGroup}.
157
+ # @!attribute [rw] parent
158
+ # @return [::String]
159
+ # Required. The name of the project this entry group is in. Example:
160
+ #
161
+ # * projects/\\{project_id}/locations/\\{location}
162
+ #
163
+ # Note that this EntryGroup and its child resources may not actually be
164
+ # stored in the location in this name.
165
+ # @!attribute [rw] entry_group_id
166
+ # @return [::String]
167
+ # Required. The id of the entry group to create.
168
+ # The id must begin with a letter or underscore, contain only English
169
+ # letters, numbers and underscores, and be at most 64 characters.
170
+ # @!attribute [rw] entry_group
171
+ # @return [::Google::Cloud::DataCatalog::V1beta1::EntryGroup]
172
+ # The entry group to create. Defaults to an empty entry group.
173
+ class CreateEntryGroupRequest
174
+ include ::Google::Protobuf::MessageExts
175
+ extend ::Google::Protobuf::MessageExts::ClassMethods
176
+ end
177
+
178
+ # Request message for
179
+ # {::Google::Cloud::DataCatalog::V1beta1::DataCatalog::Client#update_entry_group UpdateEntryGroup}.
180
+ # @!attribute [rw] entry_group
181
+ # @return [::Google::Cloud::DataCatalog::V1beta1::EntryGroup]
182
+ # Required. The updated entry group. "name" field must be set.
183
+ # @!attribute [rw] update_mask
184
+ # @return [::Google::Protobuf::FieldMask]
185
+ # Names of fields whose values to overwrite on an entry group.
186
+ #
187
+ # If this parameter is absent or empty, all modifiable fields
188
+ # are overwritten. If such fields are non-required and omitted in the
189
+ # request body, their values are emptied.
190
+ class UpdateEntryGroupRequest
191
+ include ::Google::Protobuf::MessageExts
192
+ extend ::Google::Protobuf::MessageExts::ClassMethods
193
+ end
194
+
195
+ # Request message for
196
+ # {::Google::Cloud::DataCatalog::V1beta1::DataCatalog::Client#get_entry_group GetEntryGroup}.
197
+ # @!attribute [rw] name
198
+ # @return [::String]
199
+ # Required. The name of the entry group. For example,
200
+ # `projects/{project_id}/locations/{location}/entryGroups/{entry_group_id}`.
201
+ # @!attribute [rw] read_mask
202
+ # @return [::Google::Protobuf::FieldMask]
203
+ # The fields to return. If not set or empty, all fields are returned.
204
+ class GetEntryGroupRequest
205
+ include ::Google::Protobuf::MessageExts
206
+ extend ::Google::Protobuf::MessageExts::ClassMethods
207
+ end
208
+
209
+ # Request message for
210
+ # {::Google::Cloud::DataCatalog::V1beta1::DataCatalog::Client#delete_entry_group DeleteEntryGroup}.
211
+ # @!attribute [rw] name
212
+ # @return [::String]
213
+ # Required. The name of the entry group. For example,
214
+ # `projects/{project_id}/locations/{location}/entryGroups/{entry_group_id}`.
215
+ # @!attribute [rw] force
216
+ # @return [::Boolean]
217
+ # Optional. If true, deletes all entries in the entry group.
218
+ class DeleteEntryGroupRequest
219
+ include ::Google::Protobuf::MessageExts
220
+ extend ::Google::Protobuf::MessageExts::ClassMethods
221
+ end
222
+
223
+ # Request message for
224
+ # {::Google::Cloud::DataCatalog::V1beta1::DataCatalog::Client#list_entry_groups ListEntryGroups}.
225
+ # @!attribute [rw] parent
226
+ # @return [::String]
227
+ # Required. The name of the location that contains the entry groups, which
228
+ # can be provided in URL format. Example:
229
+ #
230
+ # * projects/\\{project_id}/locations/\\{location}
231
+ # @!attribute [rw] page_size
232
+ # @return [::Integer]
233
+ # Optional. The maximum number of items to return. Default is 10. Max limit
234
+ # is 1000. Throws an invalid argument for `page_size > 1000`.
235
+ # @!attribute [rw] page_token
236
+ # @return [::String]
237
+ # Optional. Token that specifies which page is requested. If empty, the first
238
+ # page is returned.
239
+ class ListEntryGroupsRequest
240
+ include ::Google::Protobuf::MessageExts
241
+ extend ::Google::Protobuf::MessageExts::ClassMethods
242
+ end
243
+
244
+ # Response message for
245
+ # {::Google::Cloud::DataCatalog::V1beta1::DataCatalog::Client#list_entry_groups ListEntryGroups}.
246
+ # @!attribute [rw] entry_groups
247
+ # @return [::Array<::Google::Cloud::DataCatalog::V1beta1::EntryGroup>]
248
+ # EntryGroup details.
249
+ # @!attribute [rw] next_page_token
250
+ # @return [::String]
251
+ # Token to retrieve the next page of results. It is set to empty if no items
252
+ # remain in results.
253
+ class ListEntryGroupsResponse
254
+ include ::Google::Protobuf::MessageExts
255
+ extend ::Google::Protobuf::MessageExts::ClassMethods
256
+ end
257
+
258
+ # Request message for
259
+ # {::Google::Cloud::DataCatalog::V1beta1::DataCatalog::Client#create_entry CreateEntry}.
260
+ # @!attribute [rw] parent
261
+ # @return [::String]
262
+ # Required. The name of the entry group this entry is in. Example:
263
+ #
264
+ # * projects/\\{project_id}/locations/\\{location}/entryGroups/\\{entry_group_id}
265
+ #
266
+ # Note that this Entry and its child resources may not actually be stored in
267
+ # the location in this name.
268
+ # @!attribute [rw] entry_id
269
+ # @return [::String]
270
+ # Required. The id of the entry to create.
271
+ # @!attribute [rw] entry
272
+ # @return [::Google::Cloud::DataCatalog::V1beta1::Entry]
273
+ # Required. The entry to create.
274
+ class CreateEntryRequest
275
+ include ::Google::Protobuf::MessageExts
276
+ extend ::Google::Protobuf::MessageExts::ClassMethods
277
+ end
278
+
279
+ # Request message for
280
+ # {::Google::Cloud::DataCatalog::V1beta1::DataCatalog::Client#update_entry UpdateEntry}.
281
+ # @!attribute [rw] entry
282
+ # @return [::Google::Cloud::DataCatalog::V1beta1::Entry]
283
+ # Required. The updated entry. The "name" field must be set.
284
+ # @!attribute [rw] update_mask
285
+ # @return [::Google::Protobuf::FieldMask]
286
+ # Names of fields whose values to overwrite on an entry.
287
+ #
288
+ # If this parameter is absent or empty, all modifiable fields
289
+ # are overwritten. If such fields are non-required and omitted in the
290
+ # request body, their values are emptied.
291
+ #
292
+ # The following fields are modifiable:
293
+ #
294
+ # * For entries with type `DATA_STREAM`:
295
+ # * `schema`
296
+ # * For entries with type `FILESET`:
297
+ # * `schema`
298
+ # * `display_name`
299
+ # * `description`
300
+ # * `gcs_fileset_spec`
301
+ # * `gcs_fileset_spec.file_patterns`
302
+ # * For entries with `user_specified_type`:
303
+ # * `schema`
304
+ # * `display_name`
305
+ # * `description`
306
+ # * `user_specified_type`
307
+ # * `user_specified_system`
308
+ # * `linked_resource`
309
+ # * `source_system_timestamps`
310
+ class UpdateEntryRequest
311
+ include ::Google::Protobuf::MessageExts
312
+ extend ::Google::Protobuf::MessageExts::ClassMethods
313
+ end
314
+
315
+ # Request message for
316
+ # {::Google::Cloud::DataCatalog::V1beta1::DataCatalog::Client#delete_entry DeleteEntry}.
317
+ # @!attribute [rw] name
318
+ # @return [::String]
319
+ # Required. The name of the entry. Example:
320
+ #
321
+ # * projects/\\{project_id}/locations/\\{location}/entryGroups/\\{entry_group_id}/entries/\\{entry_id}
322
+ class DeleteEntryRequest
323
+ include ::Google::Protobuf::MessageExts
324
+ extend ::Google::Protobuf::MessageExts::ClassMethods
325
+ end
326
+
327
+ # Request message for
328
+ # {::Google::Cloud::DataCatalog::V1beta1::DataCatalog::Client#get_entry GetEntry}.
329
+ # @!attribute [rw] name
330
+ # @return [::String]
331
+ # Required. The name of the entry. Example:
332
+ #
333
+ # * projects/\\{project_id}/locations/\\{location}/entryGroups/\\{entry_group_id}/entries/\\{entry_id}
334
+ class GetEntryRequest
335
+ include ::Google::Protobuf::MessageExts
336
+ extend ::Google::Protobuf::MessageExts::ClassMethods
337
+ end
338
+
339
+ # Request message for
340
+ # {::Google::Cloud::DataCatalog::V1beta1::DataCatalog::Client#lookup_entry LookupEntry}.
341
+ # @!attribute [rw] linked_resource
342
+ # @return [::String]
343
+ # The full name of the Google Cloud Platform resource the Data Catalog
344
+ # entry represents. See:
345
+ # https://cloud.google.com/apis/design/resource_names#full_resource_name.
346
+ # Full names are case-sensitive.
347
+ #
348
+ # Examples:
349
+ #
350
+ # * //bigquery.googleapis.com/projects/projectId/datasets/datasetId/tables/tableId
351
+ # * //pubsub.googleapis.com/projects/projectId/topics/topicId
352
+ # @!attribute [rw] sql_resource
353
+ # @return [::String]
354
+ # The SQL name of the entry. SQL names are case-sensitive.
355
+ #
356
+ # Examples:
357
+ #
358
+ # * `pubsub.project_id.topic_id`
359
+ # * ``pubsub.project_id.`topic.id.with.dots` ``
360
+ # * `bigquery.table.project_id.dataset_id.table_id`
361
+ # * `bigquery.dataset.project_id.dataset_id`
362
+ # * `datacatalog.entry.project_id.location_id.entry_group_id.entry_id`
363
+ #
364
+ # `*_id`s should satisfy the standard SQL rules for identifiers.
365
+ # https://cloud.google.com/bigquery/docs/reference/standard-sql/lexical.
366
+ class LookupEntryRequest
367
+ include ::Google::Protobuf::MessageExts
368
+ extend ::Google::Protobuf::MessageExts::ClassMethods
369
+ end
370
+
371
+ # Entry Metadata.
372
+ # A Data Catalog Entry resource represents another resource in Google
373
+ # Cloud Platform (such as a BigQuery dataset or a Pub/Sub topic), or
374
+ # outside of Google Cloud Platform. Clients can use the `linked_resource` field
375
+ # in the Entry resource to refer to the original resource ID of the source
376
+ # system.
377
+ #
378
+ # An Entry resource contains resource details, such as its schema. An Entry can
379
+ # also be used to attach flexible metadata, such as a
380
+ # {::Google::Cloud::DataCatalog::V1beta1::Tag Tag}.
381
+ # @!attribute [r] name
382
+ # @return [::String]
383
+ # Output only. The Data Catalog resource name of the entry in URL format.
384
+ # Example:
385
+ #
386
+ # * projects/\\{project_id}/locations/\\{location}/entryGroups/\\{entry_group_id}/entries/\\{entry_id}
387
+ #
388
+ # Note that this Entry and its child resources may not actually be stored in
389
+ # the location in this name.
390
+ # @!attribute [rw] linked_resource
391
+ # @return [::String]
392
+ # The resource this metadata entry refers to.
393
+ #
394
+ # For Google Cloud Platform resources, `linked_resource` is the [full name of
395
+ # the
396
+ # resource](https://cloud.google.com/apis/design/resource_names#full_resource_name).
397
+ # For example, the `linked_resource` for a table resource from BigQuery is:
398
+ #
399
+ # * //bigquery.googleapis.com/projects/projectId/datasets/datasetId/tables/tableId
400
+ #
401
+ # Output only when Entry is of type in the EntryType enum. For entries with
402
+ # user_specified_type, this field is optional and defaults to an empty
403
+ # string.
404
+ # @!attribute [rw] type
405
+ # @return [::Google::Cloud::DataCatalog::V1beta1::EntryType]
406
+ # The type of the entry.
407
+ # Only used for Entries with types in the EntryType enum.
408
+ # @!attribute [rw] user_specified_type
409
+ # @return [::String]
410
+ # Entry type if it does not fit any of the input-allowed values listed in
411
+ # `EntryType` enum above. When creating an entry, users should check the
412
+ # enum values first, if nothing matches the entry to be created, then
413
+ # provide a custom value, for example "my_special_type".
414
+ # `user_specified_type` strings must begin with a letter or underscore and
415
+ # can only contain letters, numbers, and underscores; are case insensitive;
416
+ # must be at least 1 character and at most 64 characters long.
417
+ #
418
+ # Currently, only FILESET enum value is allowed. All other entries created
419
+ # through Data Catalog must use `user_specified_type`.
420
+ # @!attribute [r] integrated_system
421
+ # @return [::Google::Cloud::DataCatalog::V1beta1::IntegratedSystem]
422
+ # Output only. This field indicates the entry's source system that Data
423
+ # Catalog integrates with, such as BigQuery or Pub/Sub.
424
+ # @!attribute [rw] user_specified_system
425
+ # @return [::String]
426
+ # This field indicates the entry's source system that Data Catalog does not
427
+ # integrate with. `user_specified_system` strings must begin with a letter
428
+ # or underscore and can only contain letters, numbers, and underscores; are
429
+ # case insensitive; must be at least 1 character and at most 64 characters
430
+ # long.
431
+ # @!attribute [rw] gcs_fileset_spec
432
+ # @return [::Google::Cloud::DataCatalog::V1beta1::GcsFilesetSpec]
433
+ # Specification that applies to a Cloud Storage fileset. This is only valid
434
+ # on entries of type FILESET.
435
+ # @!attribute [rw] bigquery_table_spec
436
+ # @return [::Google::Cloud::DataCatalog::V1beta1::BigQueryTableSpec]
437
+ # Specification that applies to a BigQuery table. This is only valid on
438
+ # entries of type `TABLE`.
439
+ # @!attribute [rw] bigquery_date_sharded_spec
440
+ # @return [::Google::Cloud::DataCatalog::V1beta1::BigQueryDateShardedSpec]
441
+ # Specification for a group of BigQuery tables with name pattern
442
+ # `[prefix]YYYYMMDD`. Context:
443
+ # https://cloud.google.com/bigquery/docs/partitioned-tables#partitioning_versus_sharding.
444
+ # @!attribute [rw] display_name
445
+ # @return [::String]
446
+ # Display information such as title and description. A short name to identify
447
+ # the entry, for example, "Analytics Data - Jan 2011". Default value is an
448
+ # empty string.
449
+ # @!attribute [rw] description
450
+ # @return [::String]
451
+ # Entry description, which can consist of several sentences or paragraphs
452
+ # that describe entry contents. Default value is an empty string.
453
+ # @!attribute [rw] schema
454
+ # @return [::Google::Cloud::DataCatalog::V1beta1::Schema]
455
+ # Schema of the entry. An entry might not have any schema attached to it.
456
+ # @!attribute [r] source_system_timestamps
457
+ # @return [::Google::Cloud::DataCatalog::V1beta1::SystemTimestamps]
458
+ # Output only. Timestamps about the underlying resource, not about this Data
459
+ # Catalog entry. Output only when Entry is of type in the EntryType enum. For
460
+ # entries with user_specified_type, this field is optional and defaults to an
461
+ # empty timestamp.
462
+ # @!attribute [r] usage_signal
463
+ # @return [::Google::Cloud::DataCatalog::V1beta1::UsageSignal]
464
+ # Output only. Statistics on the usage level of the resource.
465
+ class Entry
466
+ include ::Google::Protobuf::MessageExts
467
+ extend ::Google::Protobuf::MessageExts::ClassMethods
468
+ end
469
+
470
+ # EntryGroup Metadata.
471
+ # An EntryGroup resource represents a logical grouping of zero or more
472
+ # Data Catalog {::Google::Cloud::DataCatalog::V1beta1::Entry Entry} resources.
473
+ # @!attribute [rw] name
474
+ # @return [::String]
475
+ # The resource name of the entry group in URL format. Example:
476
+ #
477
+ # * projects/\\{project_id}/locations/\\{location}/entryGroups/\\{entry_group_id}
478
+ #
479
+ # Note that this EntryGroup and its child resources may not actually be
480
+ # stored in the location in this name.
481
+ # @!attribute [rw] display_name
482
+ # @return [::String]
483
+ # A short name to identify the entry group, for example,
484
+ # "analytics data - jan 2011". Default value is an empty string.
485
+ # @!attribute [rw] description
486
+ # @return [::String]
487
+ # Entry group description, which can consist of several sentences or
488
+ # paragraphs that describe entry group contents. Default value is an empty
489
+ # string.
490
+ # @!attribute [r] data_catalog_timestamps
491
+ # @return [::Google::Cloud::DataCatalog::V1beta1::SystemTimestamps]
492
+ # Output only. Timestamps about this EntryGroup. Default value is empty
493
+ # timestamps.
494
+ class EntryGroup
495
+ include ::Google::Protobuf::MessageExts
496
+ extend ::Google::Protobuf::MessageExts::ClassMethods
497
+ end
498
+
499
+ # Request message for
500
+ # {::Google::Cloud::DataCatalog::V1beta1::DataCatalog::Client#create_tag_template CreateTagTemplate}.
501
+ # @!attribute [rw] parent
502
+ # @return [::String]
503
+ # Required. The name of the project and the template location
504
+ # [region](https://cloud.google.com/data-catalog/docs/concepts/regions.
505
+ #
506
+ # Example:
507
+ #
508
+ # * projects/\\{project_id}/locations/us-central1
509
+ # @!attribute [rw] tag_template_id
510
+ # @return [::String]
511
+ # Required. The id of the tag template to create.
512
+ # @!attribute [rw] tag_template
513
+ # @return [::Google::Cloud::DataCatalog::V1beta1::TagTemplate]
514
+ # Required. The tag template to create.
515
+ class CreateTagTemplateRequest
516
+ include ::Google::Protobuf::MessageExts
517
+ extend ::Google::Protobuf::MessageExts::ClassMethods
518
+ end
519
+
520
+ # Request message for
521
+ # {::Google::Cloud::DataCatalog::V1beta1::DataCatalog::Client#get_tag_template GetTagTemplate}.
522
+ # @!attribute [rw] name
523
+ # @return [::String]
524
+ # Required. The name of the tag template. Example:
525
+ #
526
+ # * projects/\\{project_id}/locations/\\{location}/tagTemplates/\\{tag_template_id}
527
+ class GetTagTemplateRequest
528
+ include ::Google::Protobuf::MessageExts
529
+ extend ::Google::Protobuf::MessageExts::ClassMethods
530
+ end
531
+
532
+ # Request message for
533
+ # {::Google::Cloud::DataCatalog::V1beta1::DataCatalog::Client#update_tag_template UpdateTagTemplate}.
534
+ # @!attribute [rw] tag_template
535
+ # @return [::Google::Cloud::DataCatalog::V1beta1::TagTemplate]
536
+ # Required. The template to update. The "name" field must be set.
537
+ # @!attribute [rw] update_mask
538
+ # @return [::Google::Protobuf::FieldMask]
539
+ # Names of fields whose values to overwrite on a tag template. Currently,
540
+ # only `display_name` can be overwritten.
541
+ #
542
+ # In general, if this parameter is absent or empty, all modifiable fields
543
+ # are overwritten. If such fields are non-required and omitted in the
544
+ # request body, their values are emptied.
545
+ class UpdateTagTemplateRequest
546
+ include ::Google::Protobuf::MessageExts
547
+ extend ::Google::Protobuf::MessageExts::ClassMethods
548
+ end
549
+
550
+ # Request message for
551
+ # {::Google::Cloud::DataCatalog::V1beta1::DataCatalog::Client#delete_tag_template DeleteTagTemplate}.
552
+ # @!attribute [rw] name
553
+ # @return [::String]
554
+ # Required. The name of the tag template to delete. Example:
555
+ #
556
+ # * projects/\\{project_id}/locations/\\{location}/tagTemplates/\\{tag_template_id}
557
+ # @!attribute [rw] force
558
+ # @return [::Boolean]
559
+ # Required. Currently, this field must always be set to `true`.
560
+ # This confirms the deletion of any possible tags using this template.
561
+ # `force = false` will be supported in the future.
562
+ class DeleteTagTemplateRequest
563
+ include ::Google::Protobuf::MessageExts
564
+ extend ::Google::Protobuf::MessageExts::ClassMethods
565
+ end
566
+
567
+ # Request message for
568
+ # {::Google::Cloud::DataCatalog::V1beta1::DataCatalog::Client#create_tag CreateTag}.
569
+ # @!attribute [rw] parent
570
+ # @return [::String]
571
+ # Required. The name of the resource to attach this tag to. Tags can be
572
+ # attached to Entries. Example:
573
+ #
574
+ # * projects/\\{project_id}/locations/\\{location}/entryGroups/\\{entry_group_id}/entries/\\{entry_id}
575
+ #
576
+ # Note that this Tag and its child resources may not actually be stored in
577
+ # the location in this name.
578
+ # @!attribute [rw] tag
579
+ # @return [::Google::Cloud::DataCatalog::V1beta1::Tag]
580
+ # Required. The tag to create.
581
+ class CreateTagRequest
582
+ include ::Google::Protobuf::MessageExts
583
+ extend ::Google::Protobuf::MessageExts::ClassMethods
584
+ end
585
+
586
+ # Request message for
587
+ # {::Google::Cloud::DataCatalog::V1beta1::DataCatalog::Client#update_tag UpdateTag}.
588
+ # @!attribute [rw] tag
589
+ # @return [::Google::Cloud::DataCatalog::V1beta1::Tag]
590
+ # Required. The updated tag. The "name" field must be set.
591
+ # @!attribute [rw] update_mask
592
+ # @return [::Google::Protobuf::FieldMask]
593
+ # Note: Currently, this parameter can only take `"fields"` as value.
594
+ #
595
+ # Names of fields whose values to overwrite on a tag. Currently, a tag has
596
+ # the only modifiable field with the name `fields`.
597
+ #
598
+ # In general, if this parameter is absent or empty, all modifiable fields
599
+ # are overwritten. If such fields are non-required and omitted in the
600
+ # request body, their values are emptied.
601
+ class UpdateTagRequest
602
+ include ::Google::Protobuf::MessageExts
603
+ extend ::Google::Protobuf::MessageExts::ClassMethods
604
+ end
605
+
606
+ # Request message for
607
+ # {::Google::Cloud::DataCatalog::V1beta1::DataCatalog::Client#delete_tag DeleteTag}.
608
+ # @!attribute [rw] name
609
+ # @return [::String]
610
+ # Required. The name of the tag to delete. Example:
611
+ #
612
+ # * projects/\\{project_id}/locations/\\{location}/entryGroups/\\{entry_group_id}/entries/\\{entry_id}/tags/\\{tag_id}
613
+ class DeleteTagRequest
614
+ include ::Google::Protobuf::MessageExts
615
+ extend ::Google::Protobuf::MessageExts::ClassMethods
616
+ end
617
+
618
+ # Request message for
619
+ # {::Google::Cloud::DataCatalog::V1beta1::DataCatalog::Client#create_tag_template_field CreateTagTemplateField}.
620
+ # @!attribute [rw] parent
621
+ # @return [::String]
622
+ # Required. The name of the project and the template location
623
+ # [region](https://cloud.google.com/data-catalog/docs/concepts/regions).
624
+ #
625
+ # Example:
626
+ #
627
+ # * projects/\\{project_id}/locations/us-central1/tagTemplates/\\{tag_template_id}
628
+ # @!attribute [rw] tag_template_field_id
629
+ # @return [::String]
630
+ # Required. The ID of the tag template field to create.
631
+ # Field ids can contain letters (both uppercase and lowercase), numbers
632
+ # (0-9), underscores (_) and dashes (-). Field IDs must be at least 1
633
+ # character long and at most 128 characters long. Field IDs must also be
634
+ # unique within their template.
635
+ # @!attribute [rw] tag_template_field
636
+ # @return [::Google::Cloud::DataCatalog::V1beta1::TagTemplateField]
637
+ # Required. The tag template field to create.
638
+ class CreateTagTemplateFieldRequest
639
+ include ::Google::Protobuf::MessageExts
640
+ extend ::Google::Protobuf::MessageExts::ClassMethods
641
+ end
642
+
643
+ # Request message for
644
+ # {::Google::Cloud::DataCatalog::V1beta1::DataCatalog::Client#update_tag_template_field UpdateTagTemplateField}.
645
+ # @!attribute [rw] name
646
+ # @return [::String]
647
+ # Required. The name of the tag template field. Example:
648
+ #
649
+ # * projects/\\{project_id}/locations/\\{location}/tagTemplates/\\{tag_template_id}/fields/\\{tag_template_field_id}
650
+ # @!attribute [rw] tag_template_field
651
+ # @return [::Google::Cloud::DataCatalog::V1beta1::TagTemplateField]
652
+ # Required. The template to update.
653
+ # @!attribute [rw] update_mask
654
+ # @return [::Google::Protobuf::FieldMask]
655
+ # Optional. Names of fields whose values to overwrite on an individual field
656
+ # of a tag template. The following fields are modifiable:
657
+ #
658
+ # * `display_name`
659
+ # * `type.enum_type`
660
+ # * `is_required`
661
+ #
662
+ # If this parameter is absent or empty, all modifiable fields
663
+ # are overwritten. If such fields are non-required and omitted in the request
664
+ # body, their values are emptied with one exception: when updating an enum
665
+ # type, the provided values are merged with the existing values. Therefore,
666
+ # enum values can only be added, existing enum values cannot be deleted or
667
+ # renamed.
668
+ #
669
+ # Additionally, updating a template field from optional to required is
670
+ # *not* allowed.
671
+ class UpdateTagTemplateFieldRequest
672
+ include ::Google::Protobuf::MessageExts
673
+ extend ::Google::Protobuf::MessageExts::ClassMethods
674
+ end
675
+
676
+ # Request message for
677
+ # {::Google::Cloud::DataCatalog::V1beta1::DataCatalog::Client#rename_tag_template_field RenameTagTemplateField}.
678
+ # @!attribute [rw] name
679
+ # @return [::String]
680
+ # Required. The name of the tag template. Example:
681
+ #
682
+ # * projects/\\{project_id}/locations/\\{location}/tagTemplates/\\{tag_template_id}/fields/\\{tag_template_field_id}
683
+ # @!attribute [rw] new_tag_template_field_id
684
+ # @return [::String]
685
+ # Required. The new ID of this tag template field. For example,
686
+ # `my_new_field`.
687
+ class RenameTagTemplateFieldRequest
688
+ include ::Google::Protobuf::MessageExts
689
+ extend ::Google::Protobuf::MessageExts::ClassMethods
690
+ end
691
+
692
+ # Request message for
693
+ # [RenameTagTemplateFieldEnumValue][google.cloud.datacatalog.v1.DataCatalog.RenameTagTemplateFieldEnumValue].
694
+ # @!attribute [rw] name
695
+ # @return [::String]
696
+ # Required. The name of the enum field value. Example:
697
+ #
698
+ # * projects/\\{project_id}/locations/\\{location}/tagTemplates/\\{tag_template_id}/fields/\\{tag_template_field_id}/enumValues/\\{enum_value_display_name}
699
+ # @!attribute [rw] new_enum_value_display_name
700
+ # @return [::String]
701
+ # Required. The new display name of the enum value. For example,
702
+ # `my_new_enum_value`.
703
+ class RenameTagTemplateFieldEnumValueRequest
704
+ include ::Google::Protobuf::MessageExts
705
+ extend ::Google::Protobuf::MessageExts::ClassMethods
706
+ end
707
+
708
+ # Request message for
709
+ # {::Google::Cloud::DataCatalog::V1beta1::DataCatalog::Client#delete_tag_template_field DeleteTagTemplateField}.
710
+ # @!attribute [rw] name
711
+ # @return [::String]
712
+ # Required. The name of the tag template field to delete. Example:
713
+ #
714
+ # * projects/\\{project_id}/locations/\\{location}/tagTemplates/\\{tag_template_id}/fields/\\{tag_template_field_id}
715
+ # @!attribute [rw] force
716
+ # @return [::Boolean]
717
+ # Required. Currently, this field must always be set to `true`.
718
+ # This confirms the deletion of this field from any tags using this field.
719
+ # `force = false` will be supported in the future.
720
+ class DeleteTagTemplateFieldRequest
721
+ include ::Google::Protobuf::MessageExts
722
+ extend ::Google::Protobuf::MessageExts::ClassMethods
723
+ end
724
+
725
+ # Request message for
726
+ # {::Google::Cloud::DataCatalog::V1beta1::DataCatalog::Client#list_tags ListTags}.
727
+ # @!attribute [rw] parent
728
+ # @return [::String]
729
+ # Required. The name of the Data Catalog resource to list the tags of. The
730
+ # resource could be an {::Google::Cloud::DataCatalog::V1beta1::Entry Entry} or an
731
+ # {::Google::Cloud::DataCatalog::V1beta1::EntryGroup EntryGroup}.
732
+ #
733
+ # Examples:
734
+ #
735
+ # * projects/\\{project_id}/locations/\\{location}/entryGroups/\\{entry_group_id}
736
+ # * projects/\\{project_id}/locations/\\{location}/entryGroups/\\{entry_group_id}/entries/\\{entry_id}
737
+ # @!attribute [rw] page_size
738
+ # @return [::Integer]
739
+ # The maximum number of tags to return. Default is 10. Max limit is 1000.
740
+ # @!attribute [rw] page_token
741
+ # @return [::String]
742
+ # Token that specifies which page is requested. If empty, the first page is
743
+ # returned.
744
+ class ListTagsRequest
745
+ include ::Google::Protobuf::MessageExts
746
+ extend ::Google::Protobuf::MessageExts::ClassMethods
747
+ end
748
+
749
+ # Response message for
750
+ # {::Google::Cloud::DataCatalog::V1beta1::DataCatalog::Client#list_tags ListTags}.
751
+ # @!attribute [rw] tags
752
+ # @return [::Array<::Google::Cloud::DataCatalog::V1beta1::Tag>]
753
+ # {::Google::Cloud::DataCatalog::V1beta1::Tag Tag} details.
754
+ # @!attribute [rw] next_page_token
755
+ # @return [::String]
756
+ # Token to retrieve the next page of results. It is set to empty if no items
757
+ # remain in results.
758
+ class ListTagsResponse
759
+ include ::Google::Protobuf::MessageExts
760
+ extend ::Google::Protobuf::MessageExts::ClassMethods
761
+ end
762
+
763
+ # Request message for
764
+ # {::Google::Cloud::DataCatalog::V1beta1::DataCatalog::Client#list_entries ListEntries}.
765
+ # @!attribute [rw] parent
766
+ # @return [::String]
767
+ # Required. The name of the entry group that contains the entries, which can
768
+ # be provided in URL format. Example:
769
+ #
770
+ # * projects/\\{project_id}/locations/\\{location}/entryGroups/\\{entry_group_id}
771
+ # @!attribute [rw] page_size
772
+ # @return [::Integer]
773
+ # The maximum number of items to return. Default is 10. Max limit is 1000.
774
+ # Throws an invalid argument for `page_size > 1000`.
775
+ # @!attribute [rw] page_token
776
+ # @return [::String]
777
+ # Token that specifies which page is requested. If empty, the first page is
778
+ # returned.
779
+ # @!attribute [rw] read_mask
780
+ # @return [::Google::Protobuf::FieldMask]
781
+ # The fields to return for each Entry. If not set or empty, all
782
+ # fields are returned.
783
+ # For example, setting read_mask to contain only one path "name" will cause
784
+ # ListEntries to return a list of Entries with only "name" field.
785
+ class ListEntriesRequest
786
+ include ::Google::Protobuf::MessageExts
787
+ extend ::Google::Protobuf::MessageExts::ClassMethods
788
+ end
789
+
790
+ # Response message for
791
+ # {::Google::Cloud::DataCatalog::V1beta1::DataCatalog::Client#list_entries ListEntries}.
792
+ # @!attribute [rw] entries
793
+ # @return [::Array<::Google::Cloud::DataCatalog::V1beta1::Entry>]
794
+ # Entry details.
795
+ # @!attribute [rw] next_page_token
796
+ # @return [::String]
797
+ # Token to retrieve the next page of results. It is set to empty if no items
798
+ # remain in results.
799
+ class ListEntriesResponse
800
+ include ::Google::Protobuf::MessageExts
801
+ extend ::Google::Protobuf::MessageExts::ClassMethods
802
+ end
803
+
804
+ # Entry resources in Data Catalog can be of different types e.g. a BigQuery
805
+ # Table entry is of type `TABLE`. This enum describes all the possible types
806
+ # Data Catalog contains.
807
+ module EntryType
808
+ # Default unknown type.
809
+ ENTRY_TYPE_UNSPECIFIED = 0
810
+
811
+ # Output only. The type of entry that has a GoogleSQL schema, including
812
+ # logical views.
813
+ TABLE = 2
814
+
815
+ # Output only. The type of models.
816
+ # https://cloud.google.com/bigquery-ml/docs/bigqueryml-intro
817
+ MODEL = 5
818
+
819
+ # Output only. An entry type which is used for streaming entries. Example:
820
+ # Pub/Sub topic.
821
+ DATA_STREAM = 3
822
+
823
+ # An entry type which is a set of files or objects. Example:
824
+ # Cloud Storage fileset.
825
+ FILESET = 4
826
+ end
827
+ end
828
+ end
829
+ end
830
+ end