Skip to content

Commit c18eb9f

Browse files
Google APIscopybara-github
Google APIs
authored and
copybara-github
committed
feat: mark DataCatalog service deprecated, use Dataplex Catalog instead
docs: fix a few typos PiperOrigin-RevId: 736573278
1 parent 2753fe1 commit c18eb9f

1 file changed

Lines changed: 44 additions & 4 deletions

File tree

‎google/cloud/datacatalog/v1/datacatalog.proto‎

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

52+
// Deprecated: Please use Dataplex Catalog instead.
53+
//
5254
// Data Catalog API service allows you to discover, understand, and manage
5355
// your data.
5456
service DataCatalog {
57+
option deprecated = true;
5558
option (google.api.default_host) = "datacatalog.googleapis.com";
5659
option (google.api.oauth_scopes) =
5760
"https://www.googleapis.com/auth/cloud-platform";
@@ -72,6 +75,7 @@ service DataCatalog {
7275
// For more information, see [Data Catalog search syntax]
7376
// (https://cloud.google.com/data-catalog/docs/how-to/search-reference).
7477
rpc SearchCatalog(SearchCatalogRequest) returns (SearchCatalogResponse) {
78+
option deprecated = true;
7579
option (google.api.http) = {
7680
post: "/v1/catalog:search"
7781
body: "*"
@@ -107,6 +111,7 @@ service DataCatalog {
107111
// the `parent` parameter. For more information, see [Data Catalog resource
108112
// project](https://cloud.google.com/data-catalog/docs/concepts/resource-project).
109113
rpc CreateEntryGroup(CreateEntryGroupRequest) returns (EntryGroup) {
114+
option deprecated = true;
110115
option (google.api.http) = {
111116
post: "/v1/{parent=projects/*/locations/*}/entryGroups"
112117
body: "entry_group"
@@ -116,6 +121,7 @@ service DataCatalog {
116121

117122
// Gets an entry group.
118123
rpc GetEntryGroup(GetEntryGroupRequest) returns (EntryGroup) {
124+
option deprecated = true;
119125
option (google.api.http) = {
120126
get: "/v1/{name=projects/*/locations/*/entryGroups/*}"
121127
};
@@ -130,6 +136,7 @@ service DataCatalog {
130136
// resource
131137
// project](https://cloud.google.com/data-catalog/docs/concepts/resource-project).
132138
rpc UpdateEntryGroup(UpdateEntryGroupRequest) returns (EntryGroup) {
139+
option deprecated = true;
133140
option (google.api.http) = {
134141
patch: "/v1/{entry_group.name=projects/*/locations/*/entryGroups/*}"
135142
body: "entry_group"
@@ -146,6 +153,7 @@ service DataCatalog {
146153
// project](https://cloud.google.com/data-catalog/docs/concepts/resource-project).
147154
rpc DeleteEntryGroup(DeleteEntryGroupRequest)
148155
returns (google.protobuf.Empty) {
156+
option deprecated = true;
149157
option (google.api.http) = {
150158
delete: "/v1/{name=projects/*/locations/*/entryGroups/*}"
151159
};
@@ -155,6 +163,7 @@ service DataCatalog {
155163
// Lists entry groups.
156164
rpc ListEntryGroups(ListEntryGroupsRequest)
157165
returns (ListEntryGroupsResponse) {
166+
option deprecated = true;
158167
option (google.api.http) = {
159168
get: "/v1/{parent=projects/*/locations/*}/entryGroups"
160169
};
@@ -173,6 +182,7 @@ service DataCatalog {
173182
//
174183
// An entry group can have a maximum of 100,000 entries.
175184
rpc CreateEntry(CreateEntryRequest) returns (Entry) {
185+
option deprecated = true;
176186
option (google.api.http) = {
177187
post: "/v1/{parent=projects/*/locations/*/entryGroups/*}/entries"
178188
body: "entry"
@@ -187,6 +197,7 @@ service DataCatalog {
187197
// resource
188198
// project](https://cloud.google.com/data-catalog/docs/concepts/resource-project).
189199
rpc UpdateEntry(UpdateEntryRequest) returns (Entry) {
200+
option deprecated = true;
190201
option (google.api.http) = {
191202
patch: "/v1/{entry.name=projects/*/locations/*/entryGroups/*/entries/*}"
192203
body: "entry"
@@ -206,6 +217,7 @@ service DataCatalog {
206217
// resource
207218
// project](https://cloud.google.com/data-catalog/docs/concepts/resource-project).
208219
rpc DeleteEntry(DeleteEntryRequest) returns (google.protobuf.Empty) {
220+
option deprecated = true;
209221
option (google.api.http) = {
210222
delete: "/v1/{name=projects/*/locations/*/entryGroups/*/entries/*}"
211223
};
@@ -214,6 +226,7 @@ service DataCatalog {
214226

215227
// Gets an entry.
216228
rpc GetEntry(GetEntryRequest) returns (Entry) {
229+
option deprecated = true;
217230
option (google.api.http) = {
218231
get: "/v1/{name=projects/*/locations/*/entryGroups/*/entries/*}"
219232
};
@@ -224,6 +237,7 @@ service DataCatalog {
224237
//
225238
// The resource name comes from the source Google Cloud Platform service.
226239
rpc LookupEntry(LookupEntryRequest) returns (Entry) {
240+
option deprecated = true;
227241
option (google.api.http) = {
228242
get: "/v1/entries:lookup"
229243
};
@@ -235,6 +249,7 @@ service DataCatalog {
235249
// To get a list of both custom and automatically created entries, use
236250
// [SearchCatalog][google.cloud.datacatalog.v1.DataCatalog.SearchCatalog].
237251
rpc ListEntries(ListEntriesRequest) returns (ListEntriesResponse) {
252+
option deprecated = true;
238253
option (google.api.http) = {
239254
get: "/v1/{parent=projects/*/locations/*/entryGroups/*}/entries"
240255
};
@@ -247,6 +262,7 @@ service DataCatalog {
247262
// To call this method, you must have the `datacatalog.entries.updateOverview`
248263
// IAM permission on the corresponding project.
249264
rpc ModifyEntryOverview(ModifyEntryOverviewRequest) returns (EntryOverview) {
265+
option deprecated = true;
250266
option (google.api.http) = {
251267
post: "/v1/{name=projects/*/locations/*/entryGroups/*/entries/*}:modifyEntryOverview"
252268
body: "*"
@@ -259,6 +275,7 @@ service DataCatalog {
259275
// To call this method, you must have the `datacatalog.entries.updateContacts`
260276
// IAM permission on the corresponding project.
261277
rpc ModifyEntryContacts(ModifyEntryContactsRequest) returns (Contacts) {
278+
option deprecated = true;
262279
option (google.api.http) = {
263280
post: "/v1/{name=projects/*/locations/*/entryGroups/*/entries/*}:modifyEntryContacts"
264281
body: "*"
@@ -272,6 +289,7 @@ service DataCatalog {
272289
// For more information, see [Data Catalog resource project]
273290
// (https://cloud.google.com/data-catalog/docs/concepts/resource-project).
274291
rpc CreateTagTemplate(CreateTagTemplateRequest) returns (TagTemplate) {
292+
option deprecated = true;
275293
option (google.api.http) = {
276294
post: "/v1/{parent=projects/*/locations/*}/tagTemplates"
277295
body: "tag_template"
@@ -282,6 +300,7 @@ service DataCatalog {
282300

283301
// Gets a tag template.
284302
rpc GetTagTemplate(GetTagTemplateRequest) returns (TagTemplate) {
303+
option deprecated = true;
285304
option (google.api.http) = {
286305
get: "/v1/{name=projects/*/locations/*/tagTemplates/*}"
287306
};
@@ -298,6 +317,7 @@ service DataCatalog {
298317
// resource
299318
// project](https://cloud.google.com/data-catalog/docs/concepts/resource-project).
300319
rpc UpdateTagTemplate(UpdateTagTemplateRequest) returns (TagTemplate) {
320+
option deprecated = true;
301321
option (google.api.http) = {
302322
patch: "/v1/{tag_template.name=projects/*/locations/*/tagTemplates/*}"
303323
body: "tag_template"
@@ -313,6 +333,7 @@ service DataCatalog {
313333
// project](https://cloud.google.com/data-catalog/docs/concepts/resource-project).
314334
rpc DeleteTagTemplate(DeleteTagTemplateRequest)
315335
returns (google.protobuf.Empty) {
336+
option deprecated = true;
316337
option (google.api.http) = {
317338
delete: "/v1/{name=projects/*/locations/*/tagTemplates/*}"
318339
};
@@ -326,6 +347,7 @@ service DataCatalog {
326347
// project](https://cloud.google.com/data-catalog/docs/concepts/resource-project).
327348
rpc CreateTagTemplateField(CreateTagTemplateFieldRequest)
328349
returns (TagTemplateField) {
350+
option deprecated = true;
329351
option (google.api.http) = {
330352
post: "/v1/{parent=projects/*/locations/*/tagTemplates/*}/fields"
331353
body: "tag_template_field"
@@ -344,6 +366,7 @@ service DataCatalog {
344366
// project](https://cloud.google.com/data-catalog/docs/concepts/resource-project).
345367
rpc UpdateTagTemplateField(UpdateTagTemplateFieldRequest)
346368
returns (TagTemplateField) {
369+
option deprecated = true;
347370
option (google.api.http) = {
348371
patch: "/v1/{name=projects/*/locations/*/tagTemplates/*/fields/*}"
349372
body: "tag_template_field"
@@ -360,6 +383,7 @@ service DataCatalog {
360383
// (https://cloud.google.com/data-catalog/docs/concepts/resource-project).
361384
rpc RenameTagTemplateField(RenameTagTemplateFieldRequest)
362385
returns (TagTemplateField) {
386+
option deprecated = true;
363387
option (google.api.http) = {
364388
post: "/v1/{name=projects/*/locations/*/tagTemplates/*/fields/*}:rename"
365389
body: "*"
@@ -372,6 +396,7 @@ service DataCatalog {
372396
// Within a single enum field, enum values must be unique.
373397
rpc RenameTagTemplateFieldEnumValue(RenameTagTemplateFieldEnumValueRequest)
374398
returns (TagTemplateField) {
399+
option deprecated = true;
375400
option (google.api.http) = {
376401
post: "/v1/{name=projects/*/locations/*/tagTemplates/*/fields/*/enumValues/*}:rename"
377402
body: "*"
@@ -387,6 +412,7 @@ service DataCatalog {
387412
// project](https://cloud.google.com/data-catalog/docs/concepts/resource-project).
388413
rpc DeleteTagTemplateField(DeleteTagTemplateFieldRequest)
389414
returns (google.protobuf.Empty) {
415+
option deprecated = true;
390416
option (google.api.http) = {
391417
delete: "/v1/{name=projects/*/locations/*/tagTemplates/*/fields/*}"
392418
};
@@ -406,6 +432,7 @@ service DataCatalog {
406432
// (https://cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.tagTemplates/create#path-parameters)
407433
// used to create the tag must be in the same organization.
408434
rpc CreateTag(CreateTagRequest) returns (Tag) {
435+
option deprecated = true;
409436
option (google.api.http) = {
410437
post: "/v1/{parent=projects/*/locations/*/entryGroups/*/entries/*}/tags"
411438
body: "tag"
@@ -419,6 +446,7 @@ service DataCatalog {
419446

420447
// Updates an existing tag.
421448
rpc UpdateTag(UpdateTagRequest) returns (Tag) {
449+
option deprecated = true;
422450
option (google.api.http) = {
423451
patch: "/v1/{tag.name=projects/*/locations/*/entryGroups/*/entries/*/tags/*}"
424452
body: "tag"
@@ -433,6 +461,7 @@ service DataCatalog {
433461

434462
// Deletes a tag.
435463
rpc DeleteTag(DeleteTagRequest) returns (google.protobuf.Empty) {
464+
option deprecated = true;
436465
option (google.api.http) = {
437466
delete: "/v1/{name=projects/*/locations/*/entryGroups/*/entries/*/tags/*}"
438467
additional_bindings {
@@ -446,6 +475,7 @@ service DataCatalog {
446475
// The [columns][google.cloud.datacatalog.v1.Tag.column] in the response are
447476
// lowercased.
448477
rpc ListTags(ListTagsRequest) returns (ListTagsResponse) {
478+
option deprecated = true;
449479
option (google.api.http) = {
450480
get: "/v1/{parent=projects/*/locations/*/entryGroups/*/entries/*}/tags"
451481
additional_bindings {
@@ -470,6 +500,7 @@ service DataCatalog {
470500
// [google.cloud.datacatalog.v1.ReconcileTagsResponse] message.
471501
rpc ReconcileTags(ReconcileTagsRequest)
472502
returns (google.longrunning.Operation) {
503+
option deprecated = true;
473504
option (google.api.http) = {
474505
post: "/v1/{parent=projects/*/locations/*/entryGroups/*/entries/*}/tags:reconcile"
475506
body: "*"
@@ -483,6 +514,7 @@ service DataCatalog {
483514
// Marks an [Entry][google.cloud.datacatalog.v1.Entry] as starred by
484515
// the current user. Starring information is private to each user.
485516
rpc StarEntry(StarEntryRequest) returns (StarEntryResponse) {
517+
option deprecated = true;
486518
option (google.api.http) = {
487519
post: "/v1/{name=projects/*/locations/*/entryGroups/*/entries/*}:star"
488520
body: "*"
@@ -493,6 +525,7 @@ service DataCatalog {
493525
// Marks an [Entry][google.cloud.datacatalog.v1.Entry] as NOT starred by
494526
// the current user. Starring information is private to each user.
495527
rpc UnstarEntry(UnstarEntryRequest) returns (UnstarEntryResponse) {
528+
option deprecated = true;
496529
option (google.api.http) = {
497530
post: "/v1/{name=projects/*/locations/*/entryGroups/*/entries/*}:unstar"
498531
body: "*"
@@ -519,6 +552,7 @@ service DataCatalog {
519552
// - `datacatalog.entryGroups.setIamPolicy` to set policies on entry groups.
520553
rpc SetIamPolicy(google.iam.v1.SetIamPolicyRequest)
521554
returns (google.iam.v1.Policy) {
555+
option deprecated = true;
522556
option (google.api.http) = {
523557
post: "/v1/{resource=projects/*/locations/*/tagTemplates/*}:setIamPolicy"
524558
body: "*"
@@ -553,6 +587,7 @@ service DataCatalog {
553587
// - `datacatalog.entryGroups.getIamPolicy` to get policies on entry groups.
554588
rpc GetIamPolicy(google.iam.v1.GetIamPolicyRequest)
555589
returns (google.iam.v1.Policy) {
590+
option deprecated = true;
556591
option (google.api.http) = {
557592
post: "/v1/{resource=projects/*/locations/*/tagTemplates/*}:getIamPolicy"
558593
body: "*"
@@ -584,6 +619,7 @@ service DataCatalog {
584619
// No Google IAM permissions are required to call this method.
585620
rpc TestIamPermissions(google.iam.v1.TestIamPermissionsRequest)
586621
returns (google.iam.v1.TestIamPermissionsResponse) {
622+
option deprecated = true;
587623
option (google.api.http) = {
588624
post: "/v1/{resource=projects/*/locations/*/tagTemplates/*}:testIamPermissions"
589625
body: "*"
@@ -618,6 +654,7 @@ service DataCatalog {
618654
// message.
619655
rpc ImportEntries(ImportEntriesRequest)
620656
returns (google.longrunning.Operation) {
657+
option deprecated = true;
621658
option (google.api.http) = {
622659
post: "/v1/{parent=projects/*/locations/*/entryGroups/*}/entries:import"
623660
body: "*"
@@ -631,6 +668,7 @@ service DataCatalog {
631668
// Sets the configuration related to the migration to Dataplex for an
632669
// organization or project.
633670
rpc SetConfig(SetConfigRequest) returns (MigrationConfig) {
671+
option deprecated = true;
634672
option (google.api.http) = {
635673
post: "/v1/{name=organizations/*/locations/*}:setConfig"
636674
body: "*"
@@ -645,6 +683,7 @@ service DataCatalog {
645683
// Dataplex for a specific organization, including all the projects under it
646684
// which have a separate configuration set.
647685
rpc RetrieveConfig(RetrieveConfigRequest) returns (OrganizationConfig) {
686+
option deprecated = true;
648687
option (google.api.http) = {
649688
get: "/v1/{name=organizations/*/locations/*}:retrieveConfig"
650689
};
@@ -657,6 +696,7 @@ service DataCatalog {
657696
// resource itself.
658697
rpc RetrieveEffectiveConfig(RetrieveEffectiveConfigRequest)
659698
returns (MigrationConfig) {
699+
option deprecated = true;
660700
option (google.api.http) = {
661701
get: "/v1/{name=organizations/*/locations/*}:retrieveEffectiveConfig"
662702
additional_bindings {
@@ -1325,7 +1365,7 @@ message DatabaseTableSpec {
13251365
DataplexTableSpec dataplex_table = 2
13261366
[(google.api.field_behavior) = OUTPUT_ONLY];
13271367

1328-
// Spec what aplies to tables that are actually views.
1368+
// Spec what applies to tables that are actually views.
13291369
// Not set for "real" tables.
13301370
DatabaseViewSpec database_view_spec = 3;
13311371
}
@@ -1651,19 +1691,19 @@ message ModelSpec {
16511691
// Detail description of the source information of a Vertex Feature Online
16521692
// Store.
16531693
message FeatureOnlineStoreSpec {
1654-
// Type of underlaying storage type.
1694+
// Type of underlying storage type.
16551695
enum StorageType {
16561696
// Should not be used.
16571697
STORAGE_TYPE_UNSPECIFIED = 0;
16581698

16591699
// Underlsying storgae is Bigtable.
16601700
BIGTABLE = 1;
16611701

1662-
// Underlaying is optimized online server (Lightning).
1702+
// Underlying is optimized online server (Lightning).
16631703
OPTIMIZED = 2;
16641704
}
16651705

1666-
// Output only. Type of underelaying storage for the FeatureOnlineStore.
1706+
// Output only. Type of underlying storage for the FeatureOnlineStore.
16671707
StorageType storage_type = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
16681708
}
16691709

0 commit comments

Comments
 (0)