Skip to content

Commit 684dfea

Browse files
Google APIscopybara-github
Google APIs
authored andcommitted
chore: enable gapicv2 for datacatalog/v1beta1 API
Committer: @miraleung PiperOrigin-RevId: 310415142
1 parent 2fc2caa commit 684dfea

File tree

4 files changed

+655
-483
lines changed

4 files changed

+655
-483
lines changed

google/cloud/datacatalog/v1/datacatalog.proto

+65-42
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,8 @@ option ruby_package = "Google::Cloud::DataCatalog::V1";
4444
// their data.
4545
service DataCatalog {
4646
option (google.api.default_host) = "datacatalog.googleapis.com";
47-
option (google.api.oauth_scopes) = "https://www.googleapis.com/auth/cloud-platform";
47+
option (google.api.oauth_scopes) =
48+
"https://www.googleapis.com/auth/cloud-platform";
4849

4950
// Searches Data Catalog for multiple resources like entries, tags that
5051
// match a query.
@@ -125,15 +126,17 @@ service DataCatalog {
125126
// identified by the `name` parameter (see [Data Catalog Resource Project]
126127
// (https://cloud.google.com/data-catalog/docs/concepts/resource-project) for
127128
// more information).
128-
rpc DeleteEntryGroup(DeleteEntryGroupRequest) returns (google.protobuf.Empty) {
129+
rpc DeleteEntryGroup(DeleteEntryGroupRequest)
130+
returns (google.protobuf.Empty) {
129131
option (google.api.http) = {
130132
delete: "/v1/{name=projects/*/locations/*/entryGroups/*}"
131133
};
132134
option (google.api.method_signature) = "name";
133135
}
134136

135137
// Lists entry groups.
136-
rpc ListEntryGroups(ListEntryGroupsRequest) returns (ListEntryGroupsResponse) {
138+
rpc ListEntryGroups(ListEntryGroupsRequest)
139+
returns (ListEntryGroupsResponse) {
137140
option (google.api.http) = {
138141
get: "/v1/{parent=projects/*/locations/*}/entryGroups"
139142
};
@@ -220,7 +223,8 @@ service DataCatalog {
220223
post: "/v1/{parent=projects/*/locations/*}/tagTemplates"
221224
body: "tag_template"
222225
};
223-
option (google.api.method_signature) = "parent,tag_template_id,tag_template";
226+
option (google.api.method_signature) =
227+
"parent,tag_template_id,tag_template";
224228
}
225229

226230
// Gets a tag template.
@@ -252,7 +256,8 @@ service DataCatalog {
252256
// the `name` parameter (see [Data Catalog Resource Project]
253257
// (https://cloud.google.com/data-catalog/docs/concepts/resource-project) for
254258
// more information).
255-
rpc DeleteTagTemplate(DeleteTagTemplateRequest) returns (google.protobuf.Empty) {
259+
rpc DeleteTagTemplate(DeleteTagTemplateRequest)
260+
returns (google.protobuf.Empty) {
256261
option (google.api.http) = {
257262
delete: "/v1/{name=projects/*/locations/*/tagTemplates/*}"
258263
};
@@ -264,34 +269,39 @@ service DataCatalog {
264269
// [Data Catalog Resource
265270
// Project](https://cloud.google.com/data-catalog/docs/concepts/resource-project)
266271
// for more information).
267-
rpc CreateTagTemplateField(CreateTagTemplateFieldRequest) returns (TagTemplateField) {
272+
rpc CreateTagTemplateField(CreateTagTemplateFieldRequest)
273+
returns (TagTemplateField) {
268274
option (google.api.http) = {
269275
post: "/v1/{parent=projects/*/locations/*/tagTemplates/*}/fields"
270276
body: "tag_template_field"
271277
};
272-
option (google.api.method_signature) = "parent,tag_template_field_id,tag_template_field";
278+
option (google.api.method_signature) =
279+
"parent,tag_template_field_id,tag_template_field";
273280
}
274281

275282
// Updates a field in a tag template. This method cannot be used to update the
276283
// field type. Users should enable the Data Catalog API in the project
277284
// identified by the `name` parameter (see [Data Catalog Resource Project]
278285
// (https://cloud.google.com/data-catalog/docs/concepts/resource-project) for
279286
// more information).
280-
rpc UpdateTagTemplateField(UpdateTagTemplateFieldRequest) returns (TagTemplateField) {
287+
rpc UpdateTagTemplateField(UpdateTagTemplateFieldRequest)
288+
returns (TagTemplateField) {
281289
option (google.api.http) = {
282290
patch: "/v1/{name=projects/*/locations/*/tagTemplates/*/fields/*}"
283291
body: "tag_template_field"
284292
};
285293
option (google.api.method_signature) = "name,tag_template_field";
286-
option (google.api.method_signature) = "name,tag_template_field,update_mask";
294+
option (google.api.method_signature) =
295+
"name,tag_template_field,update_mask";
287296
}
288297

289298
// Renames a field in a tag template. The user should enable the Data Catalog
290299
// API in the project identified by the `name` parameter (see [Data Catalog
291300
// Resource
292301
// Project](https://cloud.google.com/data-catalog/docs/concepts/resource-project)
293302
// for more information).
294-
rpc RenameTagTemplateField(RenameTagTemplateFieldRequest) returns (TagTemplateField) {
303+
rpc RenameTagTemplateField(RenameTagTemplateFieldRequest)
304+
returns (TagTemplateField) {
295305
option (google.api.http) = {
296306
post: "/v1/{name=projects/*/locations/*/tagTemplates/*/fields/*}:rename"
297307
body: "*"
@@ -304,7 +314,8 @@ service DataCatalog {
304314
// the `name` parameter (see [Data Catalog Resource Project]
305315
// (https://cloud.google.com/data-catalog/docs/concepts/resource-project) for
306316
// more information).
307-
rpc DeleteTagTemplateField(DeleteTagTemplateFieldRequest) returns (google.protobuf.Empty) {
317+
rpc DeleteTagTemplateField(DeleteTagTemplateFieldRequest)
318+
returns (google.protobuf.Empty) {
308319
option (google.api.http) = {
309320
delete: "/v1/{name=projects/*/locations/*/tagTemplates/*/fields/*}"
310321
};
@@ -380,7 +391,8 @@ service DataCatalog {
380391
// templates.
381392
// - `datacatalog.entries.setIamPolicy` to set policies on entries.
382393
// - `datacatalog.entryGroups.setIamPolicy` to set policies on entry groups.
383-
rpc SetIamPolicy(google.iam.v1.SetIamPolicyRequest) returns (google.iam.v1.Policy) {
394+
rpc SetIamPolicy(google.iam.v1.SetIamPolicyRequest)
395+
returns (google.iam.v1.Policy) {
384396
option (google.api.http) = {
385397
post: "/v1/{resource=projects/*/locations/*/tagTemplates/*}:setIamPolicy"
386398
body: "*"
@@ -389,6 +401,7 @@ service DataCatalog {
389401
body: "*"
390402
}
391403
};
404+
option (google.api.method_signature) = "resource,policy";
392405
}
393406

394407
// Gets the access control policy for a resource. A `NOT_FOUND` error
@@ -407,7 +420,8 @@ service DataCatalog {
407420
// templates.
408421
// - `datacatalog.entries.getIamPolicy` to get policies on entries.
409422
// - `datacatalog.entryGroups.getIamPolicy` to get policies on entry groups.
410-
rpc GetIamPolicy(google.iam.v1.GetIamPolicyRequest) returns (google.iam.v1.Policy) {
423+
rpc GetIamPolicy(google.iam.v1.GetIamPolicyRequest)
424+
returns (google.iam.v1.Policy) {
411425
option (google.api.http) = {
412426
post: "/v1/{resource=projects/*/locations/*/tagTemplates/*}:getIamPolicy"
413427
body: "*"
@@ -420,6 +434,7 @@ service DataCatalog {
420434
body: "*"
421435
}
422436
};
437+
option (google.api.method_signature) = "resource";
423438
}
424439

425440
// Returns the caller's permissions on a resource.
@@ -435,7 +450,8 @@ service DataCatalog {
435450
//
436451
// A caller is not required to have Google IAM permission to make this
437452
// request.
438-
rpc TestIamPermissions(google.iam.v1.TestIamPermissionsRequest) returns (google.iam.v1.TestIamPermissionsResponse) {
453+
rpc TestIamPermissions(google.iam.v1.TestIamPermissionsRequest)
454+
returns (google.iam.v1.TestIamPermissionsResponse) {
439455
option (google.api.http) = {
440456
post: "/v1/{resource=projects/*/locations/*/tagTemplates/*}:testIamPermissions"
441457
body: "*"
@@ -507,7 +523,8 @@ message SearchCatalogRequest {
507523
// * us-east4
508524
// * us-west1
509525
// * us-west2
510-
repeated string restricted_locations = 16 [(google.api.field_behavior) = OPTIONAL];
526+
repeated string restricted_locations = 16
527+
[(google.api.field_behavior) = OPTIONAL];
511528
}
512529

513530
// Required. The scope of this search request. A `scope` that has empty
@@ -516,7 +533,8 @@ message SearchCatalogRequest {
516533
// return an error in such a case.
517534
Scope scope = 6 [(google.api.field_behavior) = REQUIRED];
518535

519-
// Required. The query string in search query syntax. The query must be non-empty.
536+
// Required. The query string in search query syntax. The query must be
537+
// non-empty.
520538
//
521539
// Query strings can be simple as "x" or more qualified as:
522540
//
@@ -535,8 +553,8 @@ message SearchCatalogRequest {
535553
int32 page_size = 2;
536554

537555
// Optional. Pagination token returned in an earlier
538-
// [SearchCatalogResponse.next_page_token][google.cloud.datacatalog.v1.SearchCatalogResponse.next_page_token], which
539-
// indicates that this is a continuation of a prior
556+
// [SearchCatalogResponse.next_page_token][google.cloud.datacatalog.v1.SearchCatalogResponse.next_page_token],
557+
// which indicates that this is a continuation of a prior
540558
// [SearchCatalogRequest][google.cloud.datacatalog.v1.DataCatalog.SearchCatalog]
541559
// call, and that the system should return the next page of data. If empty,
542560
// the first page is returned.
@@ -640,8 +658,8 @@ message DeleteEntryGroupRequest {
640658
// Request message for
641659
// [ListEntryGroups][google.cloud.datacatalog.v1.DataCatalog.ListEntryGroups].
642660
message ListEntryGroupsRequest {
643-
// Required. The name of the location that contains the entry groups, which can be
644-
// provided in URL format. Example:
661+
// Required. The name of the location that contains the entry groups, which
662+
// can be provided in URL format. Example:
645663
//
646664
// * projects/{project_id}/locations/{location}
647665
string parent = 1 [
@@ -651,12 +669,12 @@ message ListEntryGroupsRequest {
651669
}
652670
];
653671

654-
// Optional. The maximum number of items to return. Default is 10. Max limit is 1000.
655-
// Throws an invalid argument for `page_size > 1000`.
672+
// Optional. The maximum number of items to return. Default is 10. Max limit
673+
// is 1000. Throws an invalid argument for `page_size > 1000`.
656674
int32 page_size = 2 [(google.api.field_behavior) = OPTIONAL];
657675

658-
// Optional. Token that specifies which page is requested. If empty, the first page is
659-
// returned.
676+
// Optional. Token that specifies which page is requested. If empty, the first
677+
// page is returned.
660678
string page_token = 3 [(google.api.field_behavior) = OPTIONAL];
661679
}
662680

@@ -807,8 +825,8 @@ message Entry {
807825
// Note that this Entry and its child resources may not actually be stored in
808826
// the location in this name.
809827
string name = 1 [(google.api.resource_reference) = {
810-
type: "datacatalog.googleapis.com/EntryGroup"
811-
}];
828+
type: "datacatalog.googleapis.com/EntryGroup"
829+
}];
812830

813831
// The resource this metadata entry refers to.
814832
//
@@ -845,9 +863,10 @@ message Entry {
845863

846864
// The source system of the entry.
847865
oneof system {
848-
// Output only. This field indicates the entry's source system that Data Catalog
849-
// integrates with, such as BigQuery or Pub/Sub.
850-
IntegratedSystem integrated_system = 17 [(google.api.field_behavior) = OUTPUT_ONLY];
866+
// Output only. This field indicates the entry's source system that Data
867+
// Catalog integrates with, such as BigQuery or Pub/Sub.
868+
IntegratedSystem integrated_system = 17
869+
[(google.api.field_behavior) = OUTPUT_ONLY];
851870

852871
// This field indicates the entry's source system that Data Catalog does not
853872
// integrate with. `user_specified_system` strings must begin with a letter
@@ -918,8 +937,10 @@ message EntryGroup {
918937
// string.
919938
string description = 3;
920939

921-
// Output only. Timestamps about this EntryGroup. Default value is empty timestamps.
922-
SystemTimestamps data_catalog_timestamps = 4 [(google.api.field_behavior) = OUTPUT_ONLY];
940+
// Output only. Timestamps about this EntryGroup. Default value is empty
941+
// timestamps.
942+
SystemTimestamps data_catalog_timestamps = 4
943+
[(google.api.field_behavior) = OUTPUT_ONLY];
923944
}
924945

925946
// Request message for
@@ -997,18 +1018,16 @@ message DeleteTagTemplateRequest {
9971018
// Request message for
9981019
// [CreateTag][google.cloud.datacatalog.v1.DataCatalog.CreateTag].
9991020
message CreateTagRequest {
1000-
// Required. The name of the resource to attach this tag to. Tags can be attached to
1001-
// Entries. Example:
1021+
// Required. The name of the resource to attach this tag to. Tags can be
1022+
// attached to Entries. Example:
10021023
//
10031024
// * projects/{project_id}/locations/{location}/entryGroups/{entry_group_id}/entries/{entry_id}
10041025
//
10051026
// Note that this Tag and its child resources may not actually be stored in
10061027
// the location in this name.
10071028
string parent = 1 [
10081029
(google.api.field_behavior) = REQUIRED,
1009-
(google.api.resource_reference) = {
1010-
type: "datacatalog.googleapis.com/Tag"
1011-
}
1030+
(google.api.resource_reference) = { type: "datacatalog.googleapis.com/Tag" }
10121031
];
10131032

10141033
// Required. The tag to create.
@@ -1064,7 +1083,8 @@ message CreateTagTemplateFieldRequest {
10641083
string tag_template_field_id = 2 [(google.api.field_behavior) = REQUIRED];
10651084

10661085
// Required. The tag template field to create.
1067-
TagTemplateField tag_template_field = 3 [(google.api.field_behavior) = REQUIRED];
1086+
TagTemplateField tag_template_field = 3
1087+
[(google.api.field_behavior) = REQUIRED];
10681088
}
10691089

10701090
// Request message for
@@ -1081,7 +1101,8 @@ message UpdateTagTemplateFieldRequest {
10811101
];
10821102

10831103
// Required. The template to update.
1084-
TagTemplateField tag_template_field = 2 [(google.api.field_behavior) = REQUIRED];
1104+
TagTemplateField tag_template_field = 2
1105+
[(google.api.field_behavior) = REQUIRED];
10851106

10861107
// Optional. The field mask specifies the parts of the template to be updated.
10871108
// Allowed fields:
@@ -1097,7 +1118,8 @@ message UpdateTagTemplateFieldRequest {
10971118
// existing values. Therefore, enum values can only be added, existing enum
10981119
// values cannot be deleted nor renamed. Updating a template field from
10991120
// optional to required is NOT allowed.
1100-
google.protobuf.FieldMask update_mask = 3 [(google.api.field_behavior) = OPTIONAL];
1121+
google.protobuf.FieldMask update_mask = 3
1122+
[(google.api.field_behavior) = OPTIONAL];
11011123
}
11021124

11031125
// Request message for
@@ -1113,7 +1135,8 @@ message RenameTagTemplateFieldRequest {
11131135
}
11141136
];
11151137

1116-
// Required. The new ID of this tag template field. For example, `my_new_field`.
1138+
// Required. The new ID of this tag template field. For example,
1139+
// `my_new_field`.
11171140
string new_tag_template_field_id = 2 [(google.api.field_behavior) = REQUIRED];
11181141
}
11191142

@@ -1139,8 +1162,8 @@ message DeleteTagTemplateFieldRequest {
11391162
// Request message for
11401163
// [ListTags][google.cloud.datacatalog.v1.DataCatalog.ListTags].
11411164
message ListTagsRequest {
1142-
// Required. The name of the Data Catalog resource to list the tags of. The resource
1143-
// could be an [Entry][google.cloud.datacatalog.v1.Entry] or an
1165+
// Required. The name of the Data Catalog resource to list the tags of. The
1166+
// resource could be an [Entry][google.cloud.datacatalog.v1.Entry] or an
11441167
// [EntryGroup][google.cloud.datacatalog.v1.EntryGroup].
11451168
//
11461169
// Examples:

google/cloud/datacatalog/v1beta1/datacatalog.proto

+3
Original file line numberDiff line numberDiff line change
@@ -377,6 +377,8 @@ service DataCatalog {
377377
body: "*"
378378
}
379379
};
380+
381+
option (google.api.method_signature) = "resource,policy";
380382
}
381383

382384
// Gets the access control policy for a resource. A `NOT_FOUND` error
@@ -408,6 +410,7 @@ service DataCatalog {
408410
body: "*"
409411
}
410412
};
413+
option (google.api.method_signature) = "resource";
411414
}
412415

413416
// Returns the caller's permissions on a resource.

0 commit comments

Comments
 (0)