google-cloud-dataplex-v1 2.4.1 → 2.6.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/README.md +1 -1
- data/lib/google/cloud/dataplex/v1/bindings_override.rb +34 -29
- data/lib/google/cloud/dataplex/v1/business_glossary_pb.rb +75 -0
- data/lib/google/cloud/dataplex/v1/business_glossary_service/client.rb +1985 -0
- data/lib/google/cloud/dataplex/v1/business_glossary_service/credentials.rb +47 -0
- data/lib/google/cloud/dataplex/v1/business_glossary_service/operations.rb +813 -0
- data/lib/google/cloud/dataplex/v1/business_glossary_service/paths.rb +111 -0
- data/lib/google/cloud/dataplex/v1/business_glossary_service/rest/client.rb +1863 -0
- data/lib/google/cloud/dataplex/v1/business_glossary_service/rest/operations.rb +943 -0
- data/lib/google/cloud/dataplex/v1/business_glossary_service/rest/service_stub.rb +1002 -0
- data/lib/google/cloud/dataplex/v1/business_glossary_service/rest.rb +59 -0
- data/lib/google/cloud/dataplex/v1/business_glossary_service.rb +61 -0
- data/lib/google/cloud/dataplex/v1/business_glossary_services_pb.rb +81 -0
- data/lib/google/cloud/dataplex/v1/catalog_pb.rb +7 -1
- data/lib/google/cloud/dataplex/v1/catalog_service/client.rb +302 -11
- data/lib/google/cloud/dataplex/v1/catalog_service/paths.rb +40 -0
- data/lib/google/cloud/dataplex/v1/catalog_service/rest/client.rb +281 -11
- data/lib/google/cloud/dataplex/v1/catalog_service/rest/operations.rb +2 -2
- data/lib/google/cloud/dataplex/v1/catalog_service/rest/service_stub.rb +184 -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 +14 -6
- data/lib/google/cloud/dataplex/v1/cmek_service/client.rb +1 -1
- data/lib/google/cloud/dataplex/v1/cmek_service/rest/client.rb +1 -1
- data/lib/google/cloud/dataplex/v1/cmek_service/rest/operations.rb +2 -2
- data/lib/google/cloud/dataplex/v1/cmek_service/rest.rb +1 -1
- data/lib/google/cloud/dataplex/v1/cmek_service.rb +1 -1
- data/lib/google/cloud/dataplex/v1/cmek_services_pb.rb +1 -1
- data/lib/google/cloud/dataplex/v1/content_service/client.rb +2 -1
- data/lib/google/cloud/dataplex/v1/content_service/rest/client.rb +2 -1
- data/lib/google/cloud/dataplex/v1/content_service/rest.rb +2 -1
- data/lib/google/cloud/dataplex/v1/content_service.rb +2 -1
- data/lib/google/cloud/dataplex/v1/content_services_pb.rb +2 -1
- data/lib/google/cloud/dataplex/v1/data_discovery_pb.rb +1 -1
- data/lib/google/cloud/dataplex/v1/data_profile_pb.rb +1 -1
- data/lib/google/cloud/dataplex/v1/data_quality_pb.rb +3 -1
- data/lib/google/cloud/dataplex/v1/data_scan_service/client.rb +7 -7
- data/lib/google/cloud/dataplex/v1/data_scan_service/paths.rb +14 -0
- data/lib/google/cloud/dataplex/v1/data_scan_service/rest/client.rb +7 -7
- data/lib/google/cloud/dataplex/v1/data_scan_service/rest/operations.rb +2 -2
- data/lib/google/cloud/dataplex/v1/data_taxonomy_service/client.rb +1 -1
- data/lib/google/cloud/dataplex/v1/data_taxonomy_service/rest/client.rb +1 -1
- data/lib/google/cloud/dataplex/v1/data_taxonomy_service/rest/operations.rb +2 -2
- data/lib/google/cloud/dataplex/v1/dataplex_service/client.rb +2 -2
- data/lib/google/cloud/dataplex/v1/dataplex_service/rest/client.rb +2 -2
- data/lib/google/cloud/dataplex/v1/dataplex_service/rest/operations.rb +2 -2
- data/lib/google/cloud/dataplex/v1/datascans_common_pb.rb +45 -0
- data/lib/google/cloud/dataplex/v1/logs_pb.rb +3 -1
- data/lib/google/cloud/dataplex/v1/processing_pb.rb +1 -1
- data/lib/google/cloud/dataplex/v1/rest.rb +1 -0
- data/lib/google/cloud/dataplex/v1/version.rb +1 -1
- data/lib/google/cloud/dataplex/v1.rb +1 -0
- data/proto_docs/google/cloud/dataplex/v1/analyze.rb +1 -1
- data/proto_docs/google/cloud/dataplex/v1/business_glossary.rb +531 -0
- data/proto_docs/google/cloud/dataplex/v1/catalog.rb +196 -33
- data/proto_docs/google/cloud/dataplex/v1/data_discovery.rb +6 -0
- data/proto_docs/google/cloud/dataplex/v1/data_profile.rb +99 -98
- data/proto_docs/google/cloud/dataplex/v1/data_quality.rb +18 -5
- data/proto_docs/google/cloud/dataplex/v1/data_taxonomy.rb +1 -1
- data/proto_docs/google/cloud/dataplex/v1/datascans.rb +11 -11
- data/proto_docs/google/cloud/dataplex/v1/datascans_common.rb +48 -0
- data/proto_docs/google/cloud/dataplex/v1/logs.rb +7 -3
- data/proto_docs/google/cloud/dataplex/v1/metadata.rb +10 -8
- data/proto_docs/google/cloud/dataplex/v1/processing.rb +15 -11
- data/proto_docs/google/cloud/dataplex/v1/service.rb +2 -2
- data/proto_docs/google/cloud/dataplex/v1/tasks.rb +3 -3
- metadata +19 -5
@@ -17,6 +17,7 @@
|
|
17
17
|
# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
|
18
18
|
|
19
19
|
require "google/cloud/dataplex/v1/dataplex_service/rest"
|
20
|
+
require "google/cloud/dataplex/v1/business_glossary_service/rest"
|
20
21
|
require "google/cloud/dataplex/v1/catalog_service/rest"
|
21
22
|
require "google/cloud/dataplex/v1/cmek_service/rest"
|
22
23
|
require "google/cloud/dataplex/v1/content_service/rest"
|
@@ -17,6 +17,7 @@
|
|
17
17
|
# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
|
18
18
|
|
19
19
|
require "google/cloud/dataplex/v1/dataplex_service"
|
20
|
+
require "google/cloud/dataplex/v1/business_glossary_service"
|
20
21
|
require "google/cloud/dataplex/v1/catalog_service"
|
21
22
|
require "google/cloud/dataplex/v1/cmek_service"
|
22
23
|
require "google/cloud/dataplex/v1/content_service"
|
@@ -99,7 +99,7 @@ module Google
|
|
99
99
|
# Software Runtime Configuration to run Analyze.
|
100
100
|
# @!attribute [rw] image_version
|
101
101
|
# @return [::String]
|
102
|
-
# Required. Dataplex Image version.
|
102
|
+
# Required. Dataplex Universal Catalog Image version.
|
103
103
|
# @!attribute [rw] java_libraries
|
104
104
|
# @return [::Array<::String>]
|
105
105
|
# Optional. List of Java jars to be included in the runtime environment.
|
@@ -0,0 +1,531 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
# Copyright 2025 Google LLC
|
4
|
+
#
|
5
|
+
# Licensed under the Apache License, Version 2.0 (the "License");
|
6
|
+
# you may not use this file except in compliance with the License.
|
7
|
+
# You may obtain a copy of the License at
|
8
|
+
#
|
9
|
+
# https://www.apache.org/licenses/LICENSE-2.0
|
10
|
+
#
|
11
|
+
# Unless required by applicable law or agreed to in writing, software
|
12
|
+
# distributed under the License is distributed on an "AS IS" BASIS,
|
13
|
+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
14
|
+
# See the License for the specific language governing permissions and
|
15
|
+
# limitations under the License.
|
16
|
+
|
17
|
+
# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
|
18
|
+
|
19
|
+
|
20
|
+
module Google
|
21
|
+
module Cloud
|
22
|
+
module Dataplex
|
23
|
+
module V1
|
24
|
+
# A Glossary represents a collection of GlossaryCategories and GlossaryTerms
|
25
|
+
# defined by the user. Glossary is a top level resource and is the Google Cloud
|
26
|
+
# parent resource of all the GlossaryCategories and GlossaryTerms within it.
|
27
|
+
# @!attribute [r] name
|
28
|
+
# @return [::String]
|
29
|
+
# Output only. Identifier. The resource name of the Glossary.
|
30
|
+
# Format:
|
31
|
+
# projects/\\{project_id_or_number}/locations/\\{location_id}/glossaries/\\{glossary_id}
|
32
|
+
# @!attribute [r] uid
|
33
|
+
# @return [::String]
|
34
|
+
# Output only. System generated unique id for the Glossary. This ID will be
|
35
|
+
# different if the Glossary is deleted and re-created with the
|
36
|
+
# same name.
|
37
|
+
# @!attribute [rw] display_name
|
38
|
+
# @return [::String]
|
39
|
+
# Optional. User friendly display name of the Glossary. This is user-mutable.
|
40
|
+
# This will be same as the GlossaryId, if not specified.
|
41
|
+
# @!attribute [rw] description
|
42
|
+
# @return [::String]
|
43
|
+
# Optional. The user-mutable description of the Glossary.
|
44
|
+
# @!attribute [r] create_time
|
45
|
+
# @return [::Google::Protobuf::Timestamp]
|
46
|
+
# Output only. The time at which the Glossary was created.
|
47
|
+
# @!attribute [r] update_time
|
48
|
+
# @return [::Google::Protobuf::Timestamp]
|
49
|
+
# Output only. The time at which the Glossary was last updated.
|
50
|
+
# @!attribute [rw] labels
|
51
|
+
# @return [::Google::Protobuf::Map{::String => ::String}]
|
52
|
+
# Optional. User-defined labels for the Glossary.
|
53
|
+
# @!attribute [r] term_count
|
54
|
+
# @return [::Integer]
|
55
|
+
# Output only. The number of GlossaryTerms in the Glossary.
|
56
|
+
# @!attribute [r] category_count
|
57
|
+
# @return [::Integer]
|
58
|
+
# Output only. The number of GlossaryCategories in the Glossary.
|
59
|
+
# @!attribute [rw] etag
|
60
|
+
# @return [::String]
|
61
|
+
# Optional. Needed for resource freshness validation.
|
62
|
+
# This checksum is computed by the server based on the value of other
|
63
|
+
# fields, and may be sent on update and delete requests to ensure the
|
64
|
+
# client has an up-to-date value before proceeding.
|
65
|
+
class Glossary
|
66
|
+
include ::Google::Protobuf::MessageExts
|
67
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
68
|
+
|
69
|
+
# @!attribute [rw] key
|
70
|
+
# @return [::String]
|
71
|
+
# @!attribute [rw] value
|
72
|
+
# @return [::String]
|
73
|
+
class LabelsEntry
|
74
|
+
include ::Google::Protobuf::MessageExts
|
75
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
76
|
+
end
|
77
|
+
end
|
78
|
+
|
79
|
+
# A GlossaryCategory represents a collection of GlossaryCategories and
|
80
|
+
# GlossaryTerms within a Glossary that are related to each other.
|
81
|
+
# @!attribute [r] name
|
82
|
+
# @return [::String]
|
83
|
+
# Output only. Identifier. The resource name of the GlossaryCategory.
|
84
|
+
# Format:
|
85
|
+
# projects/\\{project_id_or_number}/locations/\\{location_id}/glossaries/\\{glossary_id}/categories/\\{category_id}
|
86
|
+
# @!attribute [r] uid
|
87
|
+
# @return [::String]
|
88
|
+
# Output only. System generated unique id for the GlossaryCategory. This ID
|
89
|
+
# will be different if the GlossaryCategory is deleted and re-created with
|
90
|
+
# the same name.
|
91
|
+
# @!attribute [rw] display_name
|
92
|
+
# @return [::String]
|
93
|
+
# Optional. User friendly display name of the GlossaryCategory. This is
|
94
|
+
# user-mutable. This will be same as the GlossaryCategoryId, if not
|
95
|
+
# specified.
|
96
|
+
# @!attribute [rw] description
|
97
|
+
# @return [::String]
|
98
|
+
# Optional. The user-mutable description of the GlossaryCategory.
|
99
|
+
# @!attribute [r] create_time
|
100
|
+
# @return [::Google::Protobuf::Timestamp]
|
101
|
+
# Output only. The time at which the GlossaryCategory was created.
|
102
|
+
# @!attribute [r] update_time
|
103
|
+
# @return [::Google::Protobuf::Timestamp]
|
104
|
+
# Output only. The time at which the GlossaryCategory was last updated.
|
105
|
+
# @!attribute [rw] labels
|
106
|
+
# @return [::Google::Protobuf::Map{::String => ::String}]
|
107
|
+
# Optional. User-defined labels for the GlossaryCategory.
|
108
|
+
# @!attribute [rw] parent
|
109
|
+
# @return [::String]
|
110
|
+
# Required. The immediate parent of the GlossaryCategory in the
|
111
|
+
# resource-hierarchy. It can either be a Glossary or a GlossaryCategory.
|
112
|
+
# Format:
|
113
|
+
# projects/\\{project_id_or_number}/locations/\\{location_id}/glossaries/\\{glossary_id}
|
114
|
+
# OR
|
115
|
+
# projects/\\{project_id_or_number}/locations/\\{location_id}/glossaries/\\{glossary_id}/categories/\\{category_id}
|
116
|
+
class GlossaryCategory
|
117
|
+
include ::Google::Protobuf::MessageExts
|
118
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
119
|
+
|
120
|
+
# @!attribute [rw] key
|
121
|
+
# @return [::String]
|
122
|
+
# @!attribute [rw] value
|
123
|
+
# @return [::String]
|
124
|
+
class LabelsEntry
|
125
|
+
include ::Google::Protobuf::MessageExts
|
126
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
127
|
+
end
|
128
|
+
end
|
129
|
+
|
130
|
+
# GlossaryTerms are the core of Glossary.
|
131
|
+
# A GlossaryTerm holds a rich text description that can be attached to Entries
|
132
|
+
# or specific columns to enrich them.
|
133
|
+
# @!attribute [r] name
|
134
|
+
# @return [::String]
|
135
|
+
# Output only. Identifier. The resource name of the GlossaryTerm.
|
136
|
+
# Format:
|
137
|
+
# projects/\\{project_id_or_number}/locations/\\{location_id}/glossaries/\\{glossary_id}/terms/\\{term_id}
|
138
|
+
# @!attribute [r] uid
|
139
|
+
# @return [::String]
|
140
|
+
# Output only. System generated unique id for the GlossaryTerm. This ID will
|
141
|
+
# be different if the GlossaryTerm is deleted and re-created with the same
|
142
|
+
# name.
|
143
|
+
# @!attribute [rw] display_name
|
144
|
+
# @return [::String]
|
145
|
+
# Optional. User friendly display name of the GlossaryTerm. This is
|
146
|
+
# user-mutable. This will be same as the GlossaryTermId, if not specified.
|
147
|
+
# @!attribute [rw] description
|
148
|
+
# @return [::String]
|
149
|
+
# Optional. The user-mutable description of the GlossaryTerm.
|
150
|
+
# @!attribute [r] create_time
|
151
|
+
# @return [::Google::Protobuf::Timestamp]
|
152
|
+
# Output only. The time at which the GlossaryTerm was created.
|
153
|
+
# @!attribute [r] update_time
|
154
|
+
# @return [::Google::Protobuf::Timestamp]
|
155
|
+
# Output only. The time at which the GlossaryTerm was last updated.
|
156
|
+
# @!attribute [rw] labels
|
157
|
+
# @return [::Google::Protobuf::Map{::String => ::String}]
|
158
|
+
# Optional. User-defined labels for the GlossaryTerm.
|
159
|
+
# @!attribute [rw] parent
|
160
|
+
# @return [::String]
|
161
|
+
# Required. The immediate parent of the GlossaryTerm in the
|
162
|
+
# resource-hierarchy. It can either be a Glossary or a GlossaryCategory.
|
163
|
+
# Format:
|
164
|
+
# projects/\\{project_id_or_number}/locations/\\{location_id}/glossaries/\\{glossary_id}
|
165
|
+
# OR
|
166
|
+
# projects/\\{project_id_or_number}/locations/\\{location_id}/glossaries/\\{glossary_id}/categories/\\{category_id}
|
167
|
+
class GlossaryTerm
|
168
|
+
include ::Google::Protobuf::MessageExts
|
169
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
170
|
+
|
171
|
+
# @!attribute [rw] key
|
172
|
+
# @return [::String]
|
173
|
+
# @!attribute [rw] value
|
174
|
+
# @return [::String]
|
175
|
+
class LabelsEntry
|
176
|
+
include ::Google::Protobuf::MessageExts
|
177
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
178
|
+
end
|
179
|
+
end
|
180
|
+
|
181
|
+
# Create Glossary Request
|
182
|
+
# @!attribute [rw] parent
|
183
|
+
# @return [::String]
|
184
|
+
# Required. The parent resource where this Glossary will be created.
|
185
|
+
# Format: projects/\\{project_id_or_number}/locations/\\{location_id}
|
186
|
+
# where `location_id` refers to a Google Cloud region.
|
187
|
+
# @!attribute [rw] glossary_id
|
188
|
+
# @return [::String]
|
189
|
+
# Required. Glossary ID: Glossary identifier.
|
190
|
+
# @!attribute [rw] glossary
|
191
|
+
# @return [::Google::Cloud::Dataplex::V1::Glossary]
|
192
|
+
# Required. The Glossary to create.
|
193
|
+
# @!attribute [rw] validate_only
|
194
|
+
# @return [::Boolean]
|
195
|
+
# Optional. Validates the request without actually creating the Glossary.
|
196
|
+
# Default: false.
|
197
|
+
class CreateGlossaryRequest
|
198
|
+
include ::Google::Protobuf::MessageExts
|
199
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
200
|
+
end
|
201
|
+
|
202
|
+
# Update Glossary Request
|
203
|
+
# @!attribute [rw] glossary
|
204
|
+
# @return [::Google::Cloud::Dataplex::V1::Glossary]
|
205
|
+
# Required. The Glossary to update.
|
206
|
+
# The Glossary's `name` field is used to identify the Glossary to update.
|
207
|
+
# Format:
|
208
|
+
# projects/\\{project_id_or_number}/locations/\\{location_id}/glossaries/\\{glossary_id}
|
209
|
+
# @!attribute [rw] update_mask
|
210
|
+
# @return [::Google::Protobuf::FieldMask]
|
211
|
+
# Required. The list of fields to update.
|
212
|
+
# @!attribute [rw] validate_only
|
213
|
+
# @return [::Boolean]
|
214
|
+
# Optional. Validates the request without actually updating the Glossary.
|
215
|
+
# Default: false.
|
216
|
+
class UpdateGlossaryRequest
|
217
|
+
include ::Google::Protobuf::MessageExts
|
218
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
219
|
+
end
|
220
|
+
|
221
|
+
# Delete Glossary Request
|
222
|
+
# @!attribute [rw] name
|
223
|
+
# @return [::String]
|
224
|
+
# Required. The name of the Glossary to delete.
|
225
|
+
# Format:
|
226
|
+
# projects/\\{project_id_or_number}/locations/\\{location_id}/glossaries/\\{glossary_id}
|
227
|
+
# @!attribute [rw] etag
|
228
|
+
# @return [::String]
|
229
|
+
# Optional. The etag of the Glossary.
|
230
|
+
# If this is provided, it must match the server's etag.
|
231
|
+
# If the etag is provided and does not match the server-computed etag,
|
232
|
+
# the request must fail with a ABORTED error code.
|
233
|
+
class DeleteGlossaryRequest
|
234
|
+
include ::Google::Protobuf::MessageExts
|
235
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
236
|
+
end
|
237
|
+
|
238
|
+
# Get Glossary Request
|
239
|
+
# @!attribute [rw] name
|
240
|
+
# @return [::String]
|
241
|
+
# Required. The name of the Glossary to retrieve.
|
242
|
+
# Format:
|
243
|
+
# projects/\\{project_id_or_number}/locations/\\{location_id}/glossaries/\\{glossary_id}
|
244
|
+
class GetGlossaryRequest
|
245
|
+
include ::Google::Protobuf::MessageExts
|
246
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
247
|
+
end
|
248
|
+
|
249
|
+
# List Glossaries Request
|
250
|
+
# @!attribute [rw] parent
|
251
|
+
# @return [::String]
|
252
|
+
# Required. The parent, which has this collection of Glossaries.
|
253
|
+
# Format: projects/\\{project_id_or_number}/locations/\\{location_id}
|
254
|
+
# where `location_id` refers to a Google Cloud region.
|
255
|
+
# @!attribute [rw] page_size
|
256
|
+
# @return [::Integer]
|
257
|
+
# Optional. The maximum number of Glossaries to return. The service may
|
258
|
+
# return fewer than this value. If unspecified, at most 50 Glossaries will be
|
259
|
+
# returned. The maximum value is 1000; values above 1000 will be coerced to
|
260
|
+
# 1000.
|
261
|
+
# @!attribute [rw] page_token
|
262
|
+
# @return [::String]
|
263
|
+
# Optional. A page token, received from a previous `ListGlossaries` call.
|
264
|
+
# Provide this to retrieve the subsequent page.
|
265
|
+
# When paginating, all other parameters provided to `ListGlossaries` must
|
266
|
+
# match the call that provided the page token.
|
267
|
+
# @!attribute [rw] filter
|
268
|
+
# @return [::String]
|
269
|
+
# Optional. Filter expression that filters Glossaries listed in the response.
|
270
|
+
# Filters on proto fields of Glossary are supported.
|
271
|
+
# Examples of using a filter are:
|
272
|
+
# - `display_name="my-glossary"`
|
273
|
+
# - `categoryCount=1`
|
274
|
+
# - `termCount=0`
|
275
|
+
# @!attribute [rw] order_by
|
276
|
+
# @return [::String]
|
277
|
+
# Optional. Order by expression that orders Glossaries listed in the
|
278
|
+
# response. Order by fields are: `name` or `create_time` for the result. If
|
279
|
+
# not specified, the ordering is undefined.
|
280
|
+
class ListGlossariesRequest
|
281
|
+
include ::Google::Protobuf::MessageExts
|
282
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
283
|
+
end
|
284
|
+
|
285
|
+
# List Glossaries Response
|
286
|
+
# @!attribute [rw] glossaries
|
287
|
+
# @return [::Array<::Google::Cloud::Dataplex::V1::Glossary>]
|
288
|
+
# Lists the Glossaries in the specified parent.
|
289
|
+
# @!attribute [rw] next_page_token
|
290
|
+
# @return [::String]
|
291
|
+
# A token, which can be sent as `page_token` to retrieve the next page.
|
292
|
+
# If this field is omitted, there are no subsequent pages.
|
293
|
+
# @!attribute [rw] unreachable_locations
|
294
|
+
# @return [::Array<::String>]
|
295
|
+
# Locations that the service couldn't reach.
|
296
|
+
class ListGlossariesResponse
|
297
|
+
include ::Google::Protobuf::MessageExts
|
298
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
299
|
+
end
|
300
|
+
|
301
|
+
# Creates a new GlossaryCategory under the specified Glossary.
|
302
|
+
# @!attribute [rw] parent
|
303
|
+
# @return [::String]
|
304
|
+
# Required. The parent resource where this GlossaryCategory will be created.
|
305
|
+
# Format:
|
306
|
+
# projects/\\{project_id_or_number}/locations/\\{location_id}/glossaries/\\{glossary_id}
|
307
|
+
# where `locationId` refers to a Google Cloud region.
|
308
|
+
# @!attribute [rw] category_id
|
309
|
+
# @return [::String]
|
310
|
+
# Required. GlossaryCategory identifier.
|
311
|
+
# @!attribute [rw] category
|
312
|
+
# @return [::Google::Cloud::Dataplex::V1::GlossaryCategory]
|
313
|
+
# Required. The GlossaryCategory to create.
|
314
|
+
class CreateGlossaryCategoryRequest
|
315
|
+
include ::Google::Protobuf::MessageExts
|
316
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
317
|
+
end
|
318
|
+
|
319
|
+
# Update GlossaryCategory Request
|
320
|
+
# @!attribute [rw] category
|
321
|
+
# @return [::Google::Cloud::Dataplex::V1::GlossaryCategory]
|
322
|
+
# Required. The GlossaryCategory to update.
|
323
|
+
# The GlossaryCategory's `name` field is used to identify the
|
324
|
+
# GlossaryCategory to update. Format:
|
325
|
+
# projects/\\{project_id_or_number}/locations/\\{location_id}/glossaries/\\{glossary_id}/categories/\\{category_id}
|
326
|
+
# @!attribute [rw] update_mask
|
327
|
+
# @return [::Google::Protobuf::FieldMask]
|
328
|
+
# Required. The list of fields to update.
|
329
|
+
class UpdateGlossaryCategoryRequest
|
330
|
+
include ::Google::Protobuf::MessageExts
|
331
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
332
|
+
end
|
333
|
+
|
334
|
+
# Delete GlossaryCategory Request
|
335
|
+
# @!attribute [rw] name
|
336
|
+
# @return [::String]
|
337
|
+
# Required. The name of the GlossaryCategory to delete.
|
338
|
+
# Format:
|
339
|
+
# projects/\\{project_id_or_number}/locations/\\{location_id}/glossaries/\\{glossary_id}/categories/\\{category_id}
|
340
|
+
class DeleteGlossaryCategoryRequest
|
341
|
+
include ::Google::Protobuf::MessageExts
|
342
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
343
|
+
end
|
344
|
+
|
345
|
+
# Get GlossaryCategory Request
|
346
|
+
# @!attribute [rw] name
|
347
|
+
# @return [::String]
|
348
|
+
# Required. The name of the GlossaryCategory to retrieve.
|
349
|
+
# Format:
|
350
|
+
# projects/\\{project_id_or_number}/locations/\\{location_id}/glossaries/\\{glossary_id}/categories/\\{category_id}
|
351
|
+
class GetGlossaryCategoryRequest
|
352
|
+
include ::Google::Protobuf::MessageExts
|
353
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
354
|
+
end
|
355
|
+
|
356
|
+
# List GlossaryCategories Request
|
357
|
+
# @!attribute [rw] parent
|
358
|
+
# @return [::String]
|
359
|
+
# Required. The parent, which has this collection of GlossaryCategories.
|
360
|
+
# Format:
|
361
|
+
# projects/\\{project_id_or_number}/locations/\\{location_id}/glossaries/\\{glossary_id}
|
362
|
+
# Location is the Google Cloud region.
|
363
|
+
# @!attribute [rw] page_size
|
364
|
+
# @return [::Integer]
|
365
|
+
# Optional. The maximum number of GlossaryCategories to return. The service
|
366
|
+
# may return fewer than this value. If unspecified, at most 50
|
367
|
+
# GlossaryCategories will be returned. The maximum value is 1000; values
|
368
|
+
# above 1000 will be coerced to 1000.
|
369
|
+
# @!attribute [rw] page_token
|
370
|
+
# @return [::String]
|
371
|
+
# Optional. A page token, received from a previous `ListGlossaryCategories`
|
372
|
+
# call. Provide this to retrieve the subsequent page. When paginating, all
|
373
|
+
# other parameters provided to `ListGlossaryCategories` must match the call
|
374
|
+
# that provided the page token.
|
375
|
+
# @!attribute [rw] filter
|
376
|
+
# @return [::String]
|
377
|
+
# Optional. Filter expression that filters GlossaryCategories listed in the
|
378
|
+
# response. Filters are supported on the following fields:
|
379
|
+
# - immediate_parent
|
380
|
+
#
|
381
|
+
# Examples of using a filter are:
|
382
|
+
# -
|
383
|
+
# `immediate_parent="projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}"`
|
384
|
+
# -
|
385
|
+
# `immediate_parent="projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}/categories/{category_id}"`
|
386
|
+
#
|
387
|
+
# This will only return the GlossaryCategories that are directly nested
|
388
|
+
# under the specified parent.
|
389
|
+
# @!attribute [rw] order_by
|
390
|
+
# @return [::String]
|
391
|
+
# Optional. Order by expression that orders GlossaryCategories listed in the
|
392
|
+
# response. Order by fields are: `name` or `create_time` for the result. If
|
393
|
+
# not specified, the ordering is undefined.
|
394
|
+
class ListGlossaryCategoriesRequest
|
395
|
+
include ::Google::Protobuf::MessageExts
|
396
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
397
|
+
end
|
398
|
+
|
399
|
+
# List GlossaryCategories Response
|
400
|
+
# @!attribute [rw] categories
|
401
|
+
# @return [::Array<::Google::Cloud::Dataplex::V1::GlossaryCategory>]
|
402
|
+
# Lists the GlossaryCategories in the specified parent.
|
403
|
+
# @!attribute [rw] next_page_token
|
404
|
+
# @return [::String]
|
405
|
+
# A token, which can be sent as `page_token` to retrieve the next page.
|
406
|
+
# If this field is omitted, there are no subsequent pages.
|
407
|
+
# @!attribute [rw] unreachable_locations
|
408
|
+
# @return [::Array<::String>]
|
409
|
+
# Locations that the service couldn't reach.
|
410
|
+
class ListGlossaryCategoriesResponse
|
411
|
+
include ::Google::Protobuf::MessageExts
|
412
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
413
|
+
end
|
414
|
+
|
415
|
+
# Creates a new GlossaryTerm under the specified Glossary.
|
416
|
+
# @!attribute [rw] parent
|
417
|
+
# @return [::String]
|
418
|
+
# Required. The parent resource where the GlossaryTerm will be created.
|
419
|
+
# Format:
|
420
|
+
# projects/\\{project_id_or_number}/locations/\\{location_id}/glossaries/\\{glossary_id}
|
421
|
+
# where `location_id` refers to a Google Cloud region.
|
422
|
+
# @!attribute [rw] term_id
|
423
|
+
# @return [::String]
|
424
|
+
# Required. GlossaryTerm identifier.
|
425
|
+
# @!attribute [rw] term
|
426
|
+
# @return [::Google::Cloud::Dataplex::V1::GlossaryTerm]
|
427
|
+
# Required. The GlossaryTerm to create.
|
428
|
+
class CreateGlossaryTermRequest
|
429
|
+
include ::Google::Protobuf::MessageExts
|
430
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
431
|
+
end
|
432
|
+
|
433
|
+
# Update GlossaryTerm Request
|
434
|
+
# @!attribute [rw] term
|
435
|
+
# @return [::Google::Cloud::Dataplex::V1::GlossaryTerm]
|
436
|
+
# Required. The GlossaryTerm to update.
|
437
|
+
# The GlossaryTerm's `name` field is used to identify the GlossaryTerm to
|
438
|
+
# update. Format:
|
439
|
+
# projects/\\{project_id_or_number}/locations/\\{location_id}/glossaries/\\{glossary_id}/terms/\\{term_id}
|
440
|
+
# @!attribute [rw] update_mask
|
441
|
+
# @return [::Google::Protobuf::FieldMask]
|
442
|
+
# Required. The list of fields to update.
|
443
|
+
class UpdateGlossaryTermRequest
|
444
|
+
include ::Google::Protobuf::MessageExts
|
445
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
446
|
+
end
|
447
|
+
|
448
|
+
# Delete GlossaryTerm Request
|
449
|
+
# @!attribute [rw] name
|
450
|
+
# @return [::String]
|
451
|
+
# Required. The name of the GlossaryTerm to delete.
|
452
|
+
# Format:
|
453
|
+
# projects/\\{project_id_or_number}/locations/\\{location_id}/glossaries/\\{glossary_id}/terms/\\{term_id}
|
454
|
+
class DeleteGlossaryTermRequest
|
455
|
+
include ::Google::Protobuf::MessageExts
|
456
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
457
|
+
end
|
458
|
+
|
459
|
+
# Get GlossaryTerm Request
|
460
|
+
# @!attribute [rw] name
|
461
|
+
# @return [::String]
|
462
|
+
# Required. The name of the GlossaryTerm to retrieve.
|
463
|
+
# Format:
|
464
|
+
# projects/\\{project_id_or_number}/locations/\\{location_id}/glossaries/\\{glossary_id}/terms/\\{term_id}
|
465
|
+
class GetGlossaryTermRequest
|
466
|
+
include ::Google::Protobuf::MessageExts
|
467
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
468
|
+
end
|
469
|
+
|
470
|
+
# List GlossaryTerms Request
|
471
|
+
# @!attribute [rw] parent
|
472
|
+
# @return [::String]
|
473
|
+
# Required. The parent, which has this collection of GlossaryTerms.
|
474
|
+
# Format:
|
475
|
+
# projects/\\{project_id_or_number}/locations/\\{location_id}/glossaries/\\{glossary_id}
|
476
|
+
# where `location_id` refers to a Google Cloud region.
|
477
|
+
# @!attribute [rw] page_size
|
478
|
+
# @return [::Integer]
|
479
|
+
# Optional. The maximum number of GlossaryTerms to return. The service may
|
480
|
+
# return fewer than this value. If unspecified, at most 50 GlossaryTerms will
|
481
|
+
# be returned. The maximum value is 1000; values above 1000 will be coerced
|
482
|
+
# to 1000.
|
483
|
+
# @!attribute [rw] page_token
|
484
|
+
# @return [::String]
|
485
|
+
# Optional. A page token, received from a previous `ListGlossaryTerms` call.
|
486
|
+
# Provide this to retrieve the subsequent page.
|
487
|
+
# When paginating, all other parameters provided to `ListGlossaryTerms` must
|
488
|
+
# match the call that provided the page token.
|
489
|
+
# @!attribute [rw] filter
|
490
|
+
# @return [::String]
|
491
|
+
# Optional. Filter expression that filters GlossaryTerms listed in the
|
492
|
+
# response. Filters are supported on the following fields:
|
493
|
+
# - immediate_parent
|
494
|
+
#
|
495
|
+
# Examples of using a filter are:
|
496
|
+
# -
|
497
|
+
# `immediate_parent="projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}"`
|
498
|
+
# -
|
499
|
+
# `immediate_parent="projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}/categories/{category_id}"`
|
500
|
+
#
|
501
|
+
# This will only return the GlossaryTerms that are directly nested under the
|
502
|
+
# specified parent.
|
503
|
+
# @!attribute [rw] order_by
|
504
|
+
# @return [::String]
|
505
|
+
# Optional. Order by expression that orders GlossaryTerms listed in the
|
506
|
+
# response. Order by fields are: `name` or `create_time` for the result. If
|
507
|
+
# not specified, the ordering is undefined.
|
508
|
+
class ListGlossaryTermsRequest
|
509
|
+
include ::Google::Protobuf::MessageExts
|
510
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
511
|
+
end
|
512
|
+
|
513
|
+
# List GlossaryTerms Response
|
514
|
+
# @!attribute [rw] terms
|
515
|
+
# @return [::Array<::Google::Cloud::Dataplex::V1::GlossaryTerm>]
|
516
|
+
# Lists the GlossaryTerms in the specified parent.
|
517
|
+
# @!attribute [rw] next_page_token
|
518
|
+
# @return [::String]
|
519
|
+
# A token, which can be sent as `page_token` to retrieve the next page.
|
520
|
+
# If this field is omitted, there are no subsequent pages.
|
521
|
+
# @!attribute [rw] unreachable_locations
|
522
|
+
# @return [::Array<::String>]
|
523
|
+
# Locations that the service couldn't reach.
|
524
|
+
class ListGlossaryTermsResponse
|
525
|
+
include ::Google::Protobuf::MessageExts
|
526
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
527
|
+
end
|
528
|
+
end
|
529
|
+
end
|
530
|
+
end
|
531
|
+
end
|