Skip to content

Commit 8c2b9c9

Browse files
Google APIscopybara-github
authored andcommitted
docs: Mark DataCatalog v1beta1 service and corresponding methods as deprecated
Please use Dataplex Catalog instead. PiperOrigin-RevId: 735695315
1 parent 2415cfc commit 8c2b9c9

1 file changed

Lines changed: 31 additions & 0 deletions

File tree

google/cloud/datacatalog/v1beta1/datacatalog.proto

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -44,9 +44,12 @@ option (google.api.resource_definition) = {
4444
pattern: "projects/{project}/locations/{location}/tagTemplates/{tag_template}/fields/{tag_template_field_id}/enumValues/{enum_value_display_name}"
4545
};
4646

47+
// Deprecated: Please use Dataplex Catalog instead.
48+
//
4749
// Data Catalog API service allows clients to discover, understand, and manage
4850
// their data.
4951
service DataCatalog {
52+
option deprecated = true;
5053
option (google.api.default_host) = "datacatalog.googleapis.com";
5154
option (google.api.oauth_scopes) =
5255
"https://www.googleapis.com/auth/cloud-platform";
@@ -68,6 +71,7 @@ service DataCatalog {
6871
// Syntax](https://cloud.google.com/data-catalog/docs/how-to/search-reference)
6972
// for more information.
7073
rpc SearchCatalog(SearchCatalogRequest) returns (SearchCatalogResponse) {
74+
option deprecated = true;
7175
option (google.api.http) = {
7276
post: "/v1beta1/catalog:search"
7377
body: "*"
@@ -83,6 +87,7 @@ service DataCatalog {
8387
// (https://cloud.google.com/data-catalog/docs/concepts/resource-project) for
8488
// more information).
8589
rpc CreateEntryGroup(CreateEntryGroupRequest) returns (EntryGroup) {
90+
option deprecated = true;
8691
option (google.api.http) = {
8792
post: "/v1beta1/{parent=projects/*/locations/*}/entryGroups"
8893
body: "entry_group"
@@ -96,6 +101,7 @@ service DataCatalog {
96101
// (https://cloud.google.com/data-catalog/docs/concepts/resource-project) for
97102
// more information).
98103
rpc UpdateEntryGroup(UpdateEntryGroupRequest) returns (EntryGroup) {
104+
option deprecated = true;
99105
option (google.api.http) = {
100106
patch: "/v1beta1/{entry_group.name=projects/*/locations/*/entryGroups/*}"
101107
body: "entry_group"
@@ -106,6 +112,7 @@ service DataCatalog {
106112

107113
// Gets an EntryGroup.
108114
rpc GetEntryGroup(GetEntryGroupRequest) returns (EntryGroup) {
115+
option deprecated = true;
109116
option (google.api.http) = {
110117
get: "/v1beta1/{name=projects/*/locations/*/entryGroups/*}"
111118
};
@@ -120,6 +127,7 @@ service DataCatalog {
120127
// more information).
121128
rpc DeleteEntryGroup(DeleteEntryGroupRequest)
122129
returns (google.protobuf.Empty) {
130+
option deprecated = true;
123131
option (google.api.http) = {
124132
delete: "/v1beta1/{name=projects/*/locations/*/entryGroups/*}"
125133
};
@@ -129,6 +137,7 @@ service DataCatalog {
129137
// Lists entry groups.
130138
rpc ListEntryGroups(ListEntryGroupsRequest)
131139
returns (ListEntryGroupsResponse) {
140+
option deprecated = true;
132141
option (google.api.http) = {
133142
get: "/v1beta1/{parent=projects/*/locations/*}/entryGroups"
134143
};
@@ -145,6 +154,7 @@ service DataCatalog {
145154
//
146155
// A maximum of 100,000 entries may be created per entry group.
147156
rpc CreateEntry(CreateEntryRequest) returns (Entry) {
157+
option deprecated = true;
148158
option (google.api.http) = {
149159
post: "/v1beta1/{parent=projects/*/locations/*/entryGroups/*}/entries"
150160
body: "entry"
@@ -158,6 +168,7 @@ service DataCatalog {
158168
// (https://cloud.google.com/data-catalog/docs/concepts/resource-project) for
159169
// more information).
160170
rpc UpdateEntry(UpdateEntryRequest) returns (Entry) {
171+
option deprecated = true;
161172
option (google.api.http) = {
162173
patch: "/v1beta1/{entry.name=projects/*/locations/*/entryGroups/*/entries/*}"
163174
body: "entry"
@@ -174,6 +185,7 @@ service DataCatalog {
174185
// (https://cloud.google.com/data-catalog/docs/concepts/resource-project) for
175186
// more information).
176187
rpc DeleteEntry(DeleteEntryRequest) returns (google.protobuf.Empty) {
188+
option deprecated = true;
177189
option (google.api.http) = {
178190
delete: "/v1beta1/{name=projects/*/locations/*/entryGroups/*/entries/*}"
179191
};
@@ -182,6 +194,7 @@ service DataCatalog {
182194

183195
// Gets an entry.
184196
rpc GetEntry(GetEntryRequest) returns (Entry) {
197+
option deprecated = true;
185198
option (google.api.http) = {
186199
get: "/v1beta1/{name=projects/*/locations/*/entryGroups/*/entries/*}"
187200
};
@@ -192,13 +205,15 @@ service DataCatalog {
192205
// the resource name from the source Google Cloud Platform service to get the
193206
// Data Catalog Entry.
194207
rpc LookupEntry(LookupEntryRequest) returns (Entry) {
208+
option deprecated = true;
195209
option (google.api.http) = {
196210
get: "/v1beta1/entries:lookup"
197211
};
198212
}
199213

200214
// Lists entries.
201215
rpc ListEntries(ListEntriesRequest) returns (ListEntriesResponse) {
216+
option deprecated = true;
202217
option (google.api.http) = {
203218
get: "/v1beta1/{parent=projects/*/locations/*/entryGroups/*}/entries"
204219
};
@@ -211,6 +226,7 @@ service DataCatalog {
211226
// Project](https://cloud.google.com/data-catalog/docs/concepts/resource-project)
212227
// for more information).
213228
rpc CreateTagTemplate(CreateTagTemplateRequest) returns (TagTemplate) {
229+
option deprecated = true;
214230
option (google.api.http) = {
215231
post: "/v1beta1/{parent=projects/*/locations/*}/tagTemplates"
216232
body: "tag_template"
@@ -221,6 +237,7 @@ service DataCatalog {
221237

222238
// Gets a tag template.
223239
rpc GetTagTemplate(GetTagTemplateRequest) returns (TagTemplate) {
240+
option deprecated = true;
224241
option (google.api.http) = {
225242
get: "/v1beta1/{name=projects/*/locations/*/tagTemplates/*}"
226243
};
@@ -235,6 +252,7 @@ service DataCatalog {
235252
// (https://cloud.google.com/data-catalog/docs/concepts/resource-project) for
236253
// more information).
237254
rpc UpdateTagTemplate(UpdateTagTemplateRequest) returns (TagTemplate) {
255+
option deprecated = true;
238256
option (google.api.http) = {
239257
patch: "/v1beta1/{tag_template.name=projects/*/locations/*/tagTemplates/*}"
240258
body: "tag_template"
@@ -250,6 +268,7 @@ service DataCatalog {
250268
// more information).
251269
rpc DeleteTagTemplate(DeleteTagTemplateRequest)
252270
returns (google.protobuf.Empty) {
271+
option deprecated = true;
253272
option (google.api.http) = {
254273
delete: "/v1beta1/{name=projects/*/locations/*/tagTemplates/*}"
255274
};
@@ -263,6 +282,7 @@ service DataCatalog {
263282
// for more information).
264283
rpc CreateTagTemplateField(CreateTagTemplateFieldRequest)
265284
returns (TagTemplateField) {
285+
option deprecated = true;
266286
option (google.api.http) = {
267287
post: "/v1beta1/{parent=projects/*/locations/*/tagTemplates/*}/fields"
268288
body: "tag_template_field"
@@ -278,6 +298,7 @@ service DataCatalog {
278298
// more information).
279299
rpc UpdateTagTemplateField(UpdateTagTemplateFieldRequest)
280300
returns (TagTemplateField) {
301+
option deprecated = true;
281302
option (google.api.http) = {
282303
patch: "/v1beta1/{name=projects/*/locations/*/tagTemplates/*/fields/*}"
283304
body: "tag_template_field"
@@ -294,6 +315,7 @@ service DataCatalog {
294315
// for more information).
295316
rpc RenameTagTemplateField(RenameTagTemplateFieldRequest)
296317
returns (TagTemplateField) {
318+
option deprecated = true;
297319
option (google.api.http) = {
298320
post: "/v1beta1/{name=projects/*/locations/*/tagTemplates/*/fields/*}:rename"
299321
body: "*"
@@ -306,6 +328,7 @@ service DataCatalog {
306328
// used in any other enum value within the same enum field.
307329
rpc RenameTagTemplateFieldEnumValue(RenameTagTemplateFieldEnumValueRequest)
308330
returns (TagTemplateField) {
331+
option deprecated = true;
309332
option (google.api.http) = {
310333
post: "/v1beta1/{name=projects/*/locations/*/tagTemplates/*/fields/*/enumValues/*}:rename"
311334
body: "*"
@@ -320,6 +343,7 @@ service DataCatalog {
320343
// more information).
321344
rpc DeleteTagTemplateField(DeleteTagTemplateFieldRequest)
322345
returns (google.protobuf.Empty) {
346+
option deprecated = true;
323347
option (google.api.http) = {
324348
delete: "/v1beta1/{name=projects/*/locations/*/tagTemplates/*/fields/*}"
325349
};
@@ -334,6 +358,7 @@ service DataCatalog {
334358
// template](https://cloud.google.com/data-catalog/docs/reference/rest/v1beta1/projects.locations.tagTemplates/create#path-parameters)
335359
// used to create the tag must be from the same organization.
336360
rpc CreateTag(CreateTagRequest) returns (Tag) {
361+
option deprecated = true;
337362
option (google.api.http) = {
338363
post: "/v1beta1/{parent=projects/*/locations/*/entryGroups/*/entries/*}/tags"
339364
body: "tag"
@@ -347,6 +372,7 @@ service DataCatalog {
347372

348373
// Updates an existing tag.
349374
rpc UpdateTag(UpdateTagRequest) returns (Tag) {
375+
option deprecated = true;
350376
option (google.api.http) = {
351377
patch: "/v1beta1/{tag.name=projects/*/locations/*/entryGroups/*/entries/*/tags/*}"
352378
body: "tag"
@@ -361,6 +387,7 @@ service DataCatalog {
361387

362388
// Deletes a tag.
363389
rpc DeleteTag(DeleteTagRequest) returns (google.protobuf.Empty) {
390+
option deprecated = true;
364391
option (google.api.http) = {
365392
delete: "/v1beta1/{name=projects/*/locations/*/entryGroups/*/entries/*/tags/*}"
366393
additional_bindings {
@@ -374,6 +401,7 @@ service DataCatalog {
374401
// The [columns][google.cloud.datacatalog.v1beta1.Tag.column] in the response
375402
// are lowercased.
376403
rpc ListTags(ListTagsRequest) returns (ListTagsResponse) {
404+
option deprecated = true;
377405
option (google.api.http) = {
378406
get: "/v1beta1/{parent=projects/*/locations/*/entryGroups/*/entries/*}/tags"
379407
additional_bindings {
@@ -399,6 +427,7 @@ service DataCatalog {
399427
// - `datacatalog.entryGroups.setIamPolicy` to set policies on entry groups.
400428
rpc SetIamPolicy(google.iam.v1.SetIamPolicyRequest)
401429
returns (google.iam.v1.Policy) {
430+
option deprecated = true;
402431
option (google.api.http) = {
403432
post: "/v1beta1/{resource=projects/*/locations/*/tagTemplates/*}:setIamPolicy"
404433
body: "*"
@@ -428,6 +457,7 @@ service DataCatalog {
428457
// - `datacatalog.entryGroups.getIamPolicy` to get policies on entry groups.
429458
rpc GetIamPolicy(google.iam.v1.GetIamPolicyRequest)
430459
returns (google.iam.v1.Policy) {
460+
option deprecated = true;
431461
option (google.api.http) = {
432462
post: "/v1beta1/{resource=projects/*/locations/*/tagTemplates/*}:getIamPolicy"
433463
body: "*"
@@ -458,6 +488,7 @@ service DataCatalog {
458488
// request.
459489
rpc TestIamPermissions(google.iam.v1.TestIamPermissionsRequest)
460490
returns (google.iam.v1.TestIamPermissionsResponse) {
491+
option deprecated = true;
461492
option (google.api.http) = {
462493
post: "/v1beta1/{resource=projects/*/locations/*/tagTemplates/*}:testIamPermissions"
463494
body: "*"

0 commit comments

Comments
 (0)