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

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 +3294 -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 +2629 -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 +1581 -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 +1254 -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 +513 -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 +447 -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 +71 -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 +240 -11
@@ -0,0 +1,81 @@
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
+ # Describes a Cloud Storage fileset entry.
25
+ # @!attribute [rw] file_patterns
26
+ # @return [::Array<::String>]
27
+ # Required. Patterns to identify a set of files in Google Cloud Storage.
28
+ # See [Cloud Storage
29
+ # documentation](https://cloud.google.com/storage/docs/gsutil/addlhelp/WildcardNames)
30
+ # for more information. Note that bucket wildcards are currently not
31
+ # supported.
32
+ #
33
+ # Examples of valid file_patterns:
34
+ #
35
+ # * `gs://bucket_name/dir/*`: matches all files within `bucket_name/dir`
36
+ # directory.
37
+ # * `gs://bucket_name/dir/**`: matches all files in `bucket_name/dir`
38
+ # spanning all subdirectories.
39
+ # * `gs://bucket_name/file*`: matches files prefixed by `file` in
40
+ # `bucket_name`
41
+ # * `gs://bucket_name/??.txt`: matches files with two characters followed by
42
+ # `.txt` in `bucket_name`
43
+ # * `gs://bucket_name/[aeiou].txt`: matches files that contain a single
44
+ # vowel character followed by `.txt` in
45
+ # `bucket_name`
46
+ # * `gs://bucket_name/[a-m].txt`: matches files that contain `a`, `b`, ...
47
+ # or `m` followed by `.txt` in `bucket_name`
48
+ # * `gs://bucket_name/a/*/b`: matches all files in `bucket_name` that match
49
+ # `a/*/b` pattern, such as `a/c/b`, `a/d/b`
50
+ # * `gs://another_bucket/a.txt`: matches `gs://another_bucket/a.txt`
51
+ #
52
+ # You can combine wildcards to provide more powerful matches, for example:
53
+ #
54
+ # * `gs://bucket_name/[a-m]??.j*g`
55
+ # @!attribute [r] sample_gcs_file_specs
56
+ # @return [::Array<::Google::Cloud::DataCatalog::V1beta1::GcsFileSpec>]
57
+ # Output only. Sample files contained in this fileset, not all files
58
+ # contained in this fileset are represented here.
59
+ class GcsFilesetSpec
60
+ include ::Google::Protobuf::MessageExts
61
+ extend ::Google::Protobuf::MessageExts::ClassMethods
62
+ end
63
+
64
+ # Specifications of a single file in Cloud Storage.
65
+ # @!attribute [rw] file_path
66
+ # @return [::String]
67
+ # Required. The full file path. Example: `gs://bucket_name/a/b.txt`.
68
+ # @!attribute [r] gcs_timestamps
69
+ # @return [::Google::Cloud::DataCatalog::V1beta1::SystemTimestamps]
70
+ # Output only. Timestamps about the Cloud Storage file.
71
+ # @!attribute [r] size_bytes
72
+ # @return [::Integer]
73
+ # Output only. The size of the file, in bytes.
74
+ class GcsFileSpec
75
+ include ::Google::Protobuf::MessageExts
76
+ extend ::Google::Protobuf::MessageExts::ClassMethods
77
+ end
78
+ end
79
+ end
80
+ end
81
+ end
@@ -0,0 +1,300 @@
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
+ # A taxonomy is a collection of policy tags that classify data along a common
25
+ # axis. For instance a data *sensitivity* taxonomy could contain policy tags
26
+ # denoting PII such as age, zipcode, and SSN. A data *origin* taxonomy could
27
+ # contain policy tags to distinguish user data, employee data, partner data,
28
+ # public data.
29
+ # @!attribute [r] name
30
+ # @return [::String]
31
+ # Output only. Resource name of this taxonomy, whose format is:
32
+ # "projects/\\{project_number}/locations/\\{location_id}/taxonomies/\\{id}".
33
+ # @!attribute [rw] display_name
34
+ # @return [::String]
35
+ # Required. User defined name of this taxonomy. It must: contain only unicode
36
+ # letters, numbers, underscores, dashes and spaces; not start or end with
37
+ # spaces; and be at most 200 bytes long when encoded in UTF-8.
38
+ #
39
+ # The taxonomy display name must be unique within an organization.
40
+ # @!attribute [rw] description
41
+ # @return [::String]
42
+ # Optional. Description of this taxonomy. It must: contain only unicode
43
+ # characters, tabs, newlines, carriage returns and page breaks; and be at
44
+ # most 2000 bytes long when encoded in UTF-8. If not set, defaults to an
45
+ # empty description.
46
+ # @!attribute [r] policy_tag_count
47
+ # @return [::Integer]
48
+ # Output only. Number of policy tags contained in this taxonomy.
49
+ # @!attribute [r] taxonomy_timestamps
50
+ # @return [::Google::Cloud::DataCatalog::V1beta1::SystemTimestamps]
51
+ # Output only. Timestamps about this taxonomy. Only create_time and
52
+ # update_time are used.
53
+ # @!attribute [rw] activated_policy_types
54
+ # @return [::Array<::Google::Cloud::DataCatalog::V1beta1::Taxonomy::PolicyType>]
55
+ # Optional. A list of policy types that are activated for this taxonomy. If
56
+ # not set, defaults to an empty list.
57
+ # @!attribute [r] service
58
+ # @return [::Google::Cloud::DataCatalog::V1beta1::Taxonomy::Service]
59
+ # Output only. Identity of the service which owns the Taxonomy. This field is
60
+ # only populated when the taxonomy is created by a Google Cloud service.
61
+ # Currently only 'DATAPLEX' is supported.
62
+ class Taxonomy
63
+ include ::Google::Protobuf::MessageExts
64
+ extend ::Google::Protobuf::MessageExts::ClassMethods
65
+
66
+ # The source system of the Taxonomy.
67
+ # @!attribute [rw] name
68
+ # @return [::Google::Cloud::DataCatalog::V1beta1::ManagingSystem]
69
+ # The Google Cloud service name.
70
+ # @!attribute [rw] identity
71
+ # @return [::String]
72
+ # The service agent for the service.
73
+ class Service
74
+ include ::Google::Protobuf::MessageExts
75
+ extend ::Google::Protobuf::MessageExts::ClassMethods
76
+ end
77
+
78
+ # Defines policy types where policy tag can be used for.
79
+ module PolicyType
80
+ # Unspecified policy type.
81
+ POLICY_TYPE_UNSPECIFIED = 0
82
+
83
+ # Fine grained access control policy, which enables access control on
84
+ # tagged resources.
85
+ FINE_GRAINED_ACCESS_CONTROL = 1
86
+ end
87
+ end
88
+
89
+ # Denotes one policy tag in a taxonomy (e.g. ssn). Policy Tags can be defined
90
+ # in a hierarchy. For example, consider the following hierarchy:
91
+ # Geolocation -&gt; (LatLong, City, ZipCode). PolicyTag "Geolocation"
92
+ # contains three child policy tags: "LatLong", "City", and "ZipCode".
93
+ # @!attribute [r] name
94
+ # @return [::String]
95
+ # Output only. Resource name of this policy tag, whose format is:
96
+ # "projects/\\{project_number}/locations/\\{location_id}/taxonomies/\\{taxonomy_id}/policyTags/\\{id}".
97
+ # @!attribute [rw] display_name
98
+ # @return [::String]
99
+ # Required. User defined name of this policy tag. It must: be unique within
100
+ # the parent taxonomy; contain only unicode letters, numbers, underscores,
101
+ # dashes and spaces; not start or end with spaces; and be at most 200 bytes
102
+ # long when encoded in UTF-8.
103
+ # @!attribute [rw] description
104
+ # @return [::String]
105
+ # Description of this policy tag. It must: contain only unicode characters,
106
+ # tabs, newlines, carriage returns and page breaks; and be at most 2000 bytes
107
+ # long when encoded in UTF-8. If not set, defaults to an empty description.
108
+ # If not set, defaults to an empty description.
109
+ # @!attribute [rw] parent_policy_tag
110
+ # @return [::String]
111
+ # Resource name of this policy tag's parent policy tag (e.g. for the
112
+ # "LatLong" policy tag in the example above, this field contains the
113
+ # resource name of the "Geolocation" policy tag). If empty, it means this
114
+ # policy tag is a top level policy tag (e.g. this field is empty for the
115
+ # "Geolocation" policy tag in the example above). If not set, defaults to an
116
+ # empty string.
117
+ # @!attribute [r] child_policy_tags
118
+ # @return [::Array<::String>]
119
+ # Output only. Resource names of child policy tags of this policy tag.
120
+ class PolicyTag
121
+ include ::Google::Protobuf::MessageExts
122
+ extend ::Google::Protobuf::MessageExts::ClassMethods
123
+ end
124
+
125
+ # Request message for
126
+ # {::Google::Cloud::DataCatalog::V1beta1::PolicyTagManager::Client#create_taxonomy CreateTaxonomy}.
127
+ # @!attribute [rw] parent
128
+ # @return [::String]
129
+ # Required. Resource name of the project that the taxonomy will belong to.
130
+ # @!attribute [rw] taxonomy
131
+ # @return [::Google::Cloud::DataCatalog::V1beta1::Taxonomy]
132
+ # The taxonomy to be created.
133
+ class CreateTaxonomyRequest
134
+ include ::Google::Protobuf::MessageExts
135
+ extend ::Google::Protobuf::MessageExts::ClassMethods
136
+ end
137
+
138
+ # Request message for
139
+ # {::Google::Cloud::DataCatalog::V1beta1::PolicyTagManager::Client#delete_taxonomy DeleteTaxonomy}.
140
+ # @!attribute [rw] name
141
+ # @return [::String]
142
+ # Required. Resource name of the taxonomy to be deleted. All policy tags in
143
+ # this taxonomy will also be deleted.
144
+ class DeleteTaxonomyRequest
145
+ include ::Google::Protobuf::MessageExts
146
+ extend ::Google::Protobuf::MessageExts::ClassMethods
147
+ end
148
+
149
+ # Request message for
150
+ # {::Google::Cloud::DataCatalog::V1beta1::PolicyTagManager::Client#update_taxonomy UpdateTaxonomy}.
151
+ # @!attribute [rw] taxonomy
152
+ # @return [::Google::Cloud::DataCatalog::V1beta1::Taxonomy]
153
+ # The taxonomy to update. Only description, display_name, and activated
154
+ # policy types can be updated.
155
+ # @!attribute [rw] update_mask
156
+ # @return [::Google::Protobuf::FieldMask]
157
+ # The update mask applies to the resource. For the `FieldMask` definition,
158
+ # see
159
+ # https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask
160
+ # If not set, defaults to all of the fields that are allowed to update.
161
+ class UpdateTaxonomyRequest
162
+ include ::Google::Protobuf::MessageExts
163
+ extend ::Google::Protobuf::MessageExts::ClassMethods
164
+ end
165
+
166
+ # Request message for
167
+ # {::Google::Cloud::DataCatalog::V1beta1::PolicyTagManager::Client#list_taxonomies ListTaxonomies}.
168
+ # @!attribute [rw] parent
169
+ # @return [::String]
170
+ # Required. Resource name of the project to list the taxonomies of.
171
+ # @!attribute [rw] page_size
172
+ # @return [::Integer]
173
+ # The maximum number of items to return. Must be a value between 1 and 1000.
174
+ # If not set, defaults to 50.
175
+ # @!attribute [rw] page_token
176
+ # @return [::String]
177
+ # The next_page_token value returned from a previous list request, if any. If
178
+ # not set, defaults to an empty string.
179
+ # @!attribute [rw] filter
180
+ # @return [::String]
181
+ # Supported field for filter is 'service' and value is 'dataplex'.
182
+ # Eg: service=dataplex.
183
+ class ListTaxonomiesRequest
184
+ include ::Google::Protobuf::MessageExts
185
+ extend ::Google::Protobuf::MessageExts::ClassMethods
186
+ end
187
+
188
+ # Response message for
189
+ # {::Google::Cloud::DataCatalog::V1beta1::PolicyTagManager::Client#list_taxonomies ListTaxonomies}.
190
+ # @!attribute [rw] taxonomies
191
+ # @return [::Array<::Google::Cloud::DataCatalog::V1beta1::Taxonomy>]
192
+ # Taxonomies that the project contains.
193
+ # @!attribute [rw] next_page_token
194
+ # @return [::String]
195
+ # Token used to retrieve the next page of results, or empty if there are no
196
+ # more results in the list.
197
+ class ListTaxonomiesResponse
198
+ include ::Google::Protobuf::MessageExts
199
+ extend ::Google::Protobuf::MessageExts::ClassMethods
200
+ end
201
+
202
+ # Request message for
203
+ # {::Google::Cloud::DataCatalog::V1beta1::PolicyTagManager::Client#get_taxonomy GetTaxonomy}.
204
+ # @!attribute [rw] name
205
+ # @return [::String]
206
+ # Required. Resource name of the requested taxonomy.
207
+ class GetTaxonomyRequest
208
+ include ::Google::Protobuf::MessageExts
209
+ extend ::Google::Protobuf::MessageExts::ClassMethods
210
+ end
211
+
212
+ # Request message for
213
+ # {::Google::Cloud::DataCatalog::V1beta1::PolicyTagManager::Client#create_policy_tag CreatePolicyTag}.
214
+ # @!attribute [rw] parent
215
+ # @return [::String]
216
+ # Required. Resource name of the taxonomy that the policy tag will belong to.
217
+ # @!attribute [rw] policy_tag
218
+ # @return [::Google::Cloud::DataCatalog::V1beta1::PolicyTag]
219
+ # The policy tag to be created.
220
+ class CreatePolicyTagRequest
221
+ include ::Google::Protobuf::MessageExts
222
+ extend ::Google::Protobuf::MessageExts::ClassMethods
223
+ end
224
+
225
+ # Request message for
226
+ # {::Google::Cloud::DataCatalog::V1beta1::PolicyTagManager::Client#delete_policy_tag DeletePolicyTag}.
227
+ # @!attribute [rw] name
228
+ # @return [::String]
229
+ # Required. Resource name of the policy tag to be deleted. All of its
230
+ # descendant policy tags will also be deleted.
231
+ class DeletePolicyTagRequest
232
+ include ::Google::Protobuf::MessageExts
233
+ extend ::Google::Protobuf::MessageExts::ClassMethods
234
+ end
235
+
236
+ # Request message for
237
+ # {::Google::Cloud::DataCatalog::V1beta1::PolicyTagManager::Client#update_policy_tag UpdatePolicyTag}.
238
+ # @!attribute [rw] policy_tag
239
+ # @return [::Google::Cloud::DataCatalog::V1beta1::PolicyTag]
240
+ # The policy tag to update. Only the description, display_name, and
241
+ # parent_policy_tag fields can be updated.
242
+ # @!attribute [rw] update_mask
243
+ # @return [::Google::Protobuf::FieldMask]
244
+ # The update mask applies to the resource. Only display_name, description and
245
+ # parent_policy_tag can be updated and thus can be listed in the mask. If
246
+ # update_mask is not provided, all allowed fields (i.e. display_name,
247
+ # description and parent) will be updated. For more information including the
248
+ # `FieldMask` definition, see
249
+ # https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask
250
+ # If not set, defaults to all of the fields that are allowed to update.
251
+ class UpdatePolicyTagRequest
252
+ include ::Google::Protobuf::MessageExts
253
+ extend ::Google::Protobuf::MessageExts::ClassMethods
254
+ end
255
+
256
+ # Request message for
257
+ # {::Google::Cloud::DataCatalog::V1beta1::PolicyTagManager::Client#list_policy_tags ListPolicyTags}.
258
+ # @!attribute [rw] parent
259
+ # @return [::String]
260
+ # Required. Resource name of the taxonomy to list the policy tags of.
261
+ # @!attribute [rw] page_size
262
+ # @return [::Integer]
263
+ # The maximum number of items to return. Must be a value between 1 and 1000.
264
+ # If not set, defaults to 50.
265
+ # @!attribute [rw] page_token
266
+ # @return [::String]
267
+ # The next_page_token value returned from a previous List request, if any. If
268
+ # not set, defaults to an empty string.
269
+ class ListPolicyTagsRequest
270
+ include ::Google::Protobuf::MessageExts
271
+ extend ::Google::Protobuf::MessageExts::ClassMethods
272
+ end
273
+
274
+ # Response message for
275
+ # {::Google::Cloud::DataCatalog::V1beta1::PolicyTagManager::Client#list_policy_tags ListPolicyTags}.
276
+ # @!attribute [rw] policy_tags
277
+ # @return [::Array<::Google::Cloud::DataCatalog::V1beta1::PolicyTag>]
278
+ # The policy tags that are in the requested taxonomy.
279
+ # @!attribute [rw] next_page_token
280
+ # @return [::String]
281
+ # Token used to retrieve the next page of results, or empty if there are no
282
+ # more results in the list.
283
+ class ListPolicyTagsResponse
284
+ include ::Google::Protobuf::MessageExts
285
+ extend ::Google::Protobuf::MessageExts::ClassMethods
286
+ end
287
+
288
+ # Request message for
289
+ # {::Google::Cloud::DataCatalog::V1beta1::PolicyTagManager::Client#get_policy_tag GetPolicyTag}.
290
+ # @!attribute [rw] name
291
+ # @return [::String]
292
+ # Required. Resource name of the requested policy tag.
293
+ class GetPolicyTagRequest
294
+ include ::Google::Protobuf::MessageExts
295
+ extend ::Google::Protobuf::MessageExts::ClassMethods
296
+ end
297
+ end
298
+ end
299
+ end
300
+ end
@@ -0,0 +1,131 @@
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
+ # Message capturing a taxonomy and its policy tag hierarchy as a nested proto.
25
+ # Used for taxonomy import/export and mutation.
26
+ # @!attribute [rw] display_name
27
+ # @return [::String]
28
+ # Required. Display name of the taxonomy. Max 200 bytes when encoded in
29
+ # UTF-8.
30
+ # @!attribute [rw] description
31
+ # @return [::String]
32
+ # Description of the serialized taxonomy. The length of the
33
+ # description is limited to 2000 bytes when encoded in UTF-8. If not set,
34
+ # defaults to an empty description.
35
+ # @!attribute [rw] policy_tags
36
+ # @return [::Array<::Google::Cloud::DataCatalog::V1beta1::SerializedPolicyTag>]
37
+ # Top level policy tags associated with the taxonomy if any.
38
+ # @!attribute [rw] activated_policy_types
39
+ # @return [::Array<::Google::Cloud::DataCatalog::V1beta1::Taxonomy::PolicyType>]
40
+ # A list of policy types that are activated for a taxonomy.
41
+ class SerializedTaxonomy
42
+ include ::Google::Protobuf::MessageExts
43
+ extend ::Google::Protobuf::MessageExts::ClassMethods
44
+ end
45
+
46
+ # Message representing one policy tag when exported as a nested proto.
47
+ # @!attribute [rw] policy_tag
48
+ # @return [::String]
49
+ # Resource name of the policy tag.
50
+ #
51
+ # This field will be ignored when calling ImportTaxonomies.
52
+ # @!attribute [rw] display_name
53
+ # @return [::String]
54
+ # Required. Display name of the policy tag. Max 200 bytes when encoded in
55
+ # UTF-8.
56
+ # @!attribute [rw] description
57
+ # @return [::String]
58
+ # Description of the serialized policy tag. The length of the
59
+ # description is limited to 2000 bytes when encoded in UTF-8. If not set,
60
+ # defaults to an empty description.
61
+ # @!attribute [rw] child_policy_tags
62
+ # @return [::Array<::Google::Cloud::DataCatalog::V1beta1::SerializedPolicyTag>]
63
+ # Children of the policy tag if any.
64
+ class SerializedPolicyTag
65
+ include ::Google::Protobuf::MessageExts
66
+ extend ::Google::Protobuf::MessageExts::ClassMethods
67
+ end
68
+
69
+ # Request message for
70
+ # {::Google::Cloud::DataCatalog::V1beta1::PolicyTagManagerSerialization::Client#import_taxonomies ImportTaxonomies}.
71
+ # @!attribute [rw] parent
72
+ # @return [::String]
73
+ # Required. Resource name of project that the imported taxonomies will belong
74
+ # to.
75
+ # @!attribute [rw] inline_source
76
+ # @return [::Google::Cloud::DataCatalog::V1beta1::InlineSource]
77
+ # Inline source used for taxonomies to be imported.
78
+ class ImportTaxonomiesRequest
79
+ include ::Google::Protobuf::MessageExts
80
+ extend ::Google::Protobuf::MessageExts::ClassMethods
81
+ end
82
+
83
+ # Inline source used for taxonomies import.
84
+ # @!attribute [rw] taxonomies
85
+ # @return [::Array<::Google::Cloud::DataCatalog::V1beta1::SerializedTaxonomy>]
86
+ # Required. Taxonomies to be imported.
87
+ class InlineSource
88
+ include ::Google::Protobuf::MessageExts
89
+ extend ::Google::Protobuf::MessageExts::ClassMethods
90
+ end
91
+
92
+ # Response message for
93
+ # {::Google::Cloud::DataCatalog::V1beta1::PolicyTagManagerSerialization::Client#import_taxonomies ImportTaxonomies}.
94
+ # @!attribute [rw] taxonomies
95
+ # @return [::Array<::Google::Cloud::DataCatalog::V1beta1::Taxonomy>]
96
+ # Taxonomies that were imported.
97
+ class ImportTaxonomiesResponse
98
+ include ::Google::Protobuf::MessageExts
99
+ extend ::Google::Protobuf::MessageExts::ClassMethods
100
+ end
101
+
102
+ # Request message for
103
+ # {::Google::Cloud::DataCatalog::V1beta1::PolicyTagManagerSerialization::Client#export_taxonomies ExportTaxonomies}.
104
+ # @!attribute [rw] parent
105
+ # @return [::String]
106
+ # Required. Resource name of the project that taxonomies to be exported
107
+ # will share.
108
+ # @!attribute [rw] taxonomies
109
+ # @return [::Array<::String>]
110
+ # Required. Resource names of the taxonomies to be exported.
111
+ # @!attribute [rw] serialized_taxonomies
112
+ # @return [::Boolean]
113
+ # Export taxonomies as serialized taxonomies.
114
+ class ExportTaxonomiesRequest
115
+ include ::Google::Protobuf::MessageExts
116
+ extend ::Google::Protobuf::MessageExts::ClassMethods
117
+ end
118
+
119
+ # Response message for
120
+ # {::Google::Cloud::DataCatalog::V1beta1::PolicyTagManagerSerialization::Client#export_taxonomies ExportTaxonomies}.
121
+ # @!attribute [rw] taxonomies
122
+ # @return [::Array<::Google::Cloud::DataCatalog::V1beta1::SerializedTaxonomy>]
123
+ # List of taxonomies and policy tags in a tree structure.
124
+ class ExportTaxonomiesResponse
125
+ include ::Google::Protobuf::MessageExts
126
+ extend ::Google::Protobuf::MessageExts::ClassMethods
127
+ end
128
+ end
129
+ end
130
+ end
131
+ end
@@ -0,0 +1,61 @@
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
+ # Represents a schema (e.g. BigQuery, GoogleSQL, Avro schema).
25
+ # @!attribute [rw] columns
26
+ # @return [::Array<::Google::Cloud::DataCatalog::V1beta1::ColumnSchema>]
27
+ # Required. Schema of columns. A maximum of 10,000 columns and sub-columns
28
+ # can be specified.
29
+ class Schema
30
+ include ::Google::Protobuf::MessageExts
31
+ extend ::Google::Protobuf::MessageExts::ClassMethods
32
+ end
33
+
34
+ # Representation of a column within a schema. Columns could be nested inside
35
+ # other columns.
36
+ # @!attribute [rw] column
37
+ # @return [::String]
38
+ # Required. Name of the column.
39
+ # @!attribute [rw] type
40
+ # @return [::String]
41
+ # Required. Type of the column.
42
+ # @!attribute [rw] description
43
+ # @return [::String]
44
+ # Optional. Description of the column. Default value is an empty string.
45
+ # @!attribute [rw] mode
46
+ # @return [::String]
47
+ # Optional. A column's mode indicates whether the values in this column are
48
+ # required, nullable, etc. Only `NULLABLE`, `REQUIRED` and `REPEATED` are
49
+ # supported. Default mode is `NULLABLE`.
50
+ # @!attribute [rw] subcolumns
51
+ # @return [::Array<::Google::Cloud::DataCatalog::V1beta1::ColumnSchema>]
52
+ # Optional. Schema of sub-columns. A column can have zero or more
53
+ # sub-columns.
54
+ class ColumnSchema
55
+ include ::Google::Protobuf::MessageExts
56
+ extend ::Google::Protobuf::MessageExts::ClassMethods
57
+ end
58
+ end
59
+ end
60
+ end
61
+ end
@@ -0,0 +1,75 @@
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
+ # A result that appears in the response of a search request. Each result
25
+ # captures details of one entry that matches the search.
26
+ # @!attribute [rw] search_result_type
27
+ # @return [::Google::Cloud::DataCatalog::V1beta1::SearchResultType]
28
+ # Type of the search result. This field can be used to determine which Get
29
+ # method to call to fetch the full resource.
30
+ # @!attribute [rw] search_result_subtype
31
+ # @return [::String]
32
+ # Sub-type of the search result. This is a dot-delimited description of the
33
+ # resource's full type, and is the same as the value callers would provide in
34
+ # the "type" search facet. Examples: `entry.table`, `entry.dataStream`,
35
+ # `tagTemplate`.
36
+ # @!attribute [rw] relative_resource_name
37
+ # @return [::String]
38
+ # The relative resource name of the resource in URL format.
39
+ # Examples:
40
+ #
41
+ # * `projects/{project_id}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id}`
42
+ # * `projects/{project_id}/tagTemplates/{tag_template_id}`
43
+ # @!attribute [rw] linked_resource
44
+ # @return [::String]
45
+ # The full name of the cloud resource the entry belongs to. See:
46
+ # https://cloud.google.com/apis/design/resource_names#full_resource_name.
47
+ # Example:
48
+ #
49
+ # * `//bigquery.googleapis.com/projects/projectId/datasets/datasetId/tables/tableId`
50
+ # @!attribute [rw] modify_time
51
+ # @return [::Google::Protobuf::Timestamp]
52
+ # Last-modified timestamp of the entry from the managing system.
53
+ class SearchCatalogResult
54
+ include ::Google::Protobuf::MessageExts
55
+ extend ::Google::Protobuf::MessageExts::ClassMethods
56
+ end
57
+
58
+ # The different types of resources that can be returned in search.
59
+ module SearchResultType
60
+ # Default unknown type.
61
+ SEARCH_RESULT_TYPE_UNSPECIFIED = 0
62
+
63
+ # An {::Google::Cloud::DataCatalog::V1beta1::Entry Entry}.
64
+ ENTRY = 1
65
+
66
+ # A {::Google::Cloud::DataCatalog::V1beta1::TagTemplate TagTemplate}.
67
+ TAG_TEMPLATE = 2
68
+
69
+ # An {::Google::Cloud::DataCatalog::V1beta1::EntryGroup EntryGroup}.
70
+ ENTRY_GROUP = 3
71
+ end
72
+ end
73
+ end
74
+ end
75
+ end