@@ -44,7 +44,8 @@ option ruby_package = "Google::Cloud::DataCatalog::V1";
44
44
// their data.
45
45
service DataCatalog {
46
46
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" ;
48
49
49
50
// Searches Data Catalog for multiple resources like entries, tags that
50
51
// match a query.
@@ -125,15 +126,17 @@ service DataCatalog {
125
126
// identified by the `name` parameter (see [Data Catalog Resource Project]
126
127
// (https://cloud.google.com/data-catalog/docs/concepts/resource-project) for
127
128
// more information).
128
- rpc DeleteEntryGroup (DeleteEntryGroupRequest ) returns (google .protobuf .Empty ) {
129
+ rpc DeleteEntryGroup (DeleteEntryGroupRequest )
130
+ returns (google .protobuf .Empty ) {
129
131
option (google.api.http ) = {
130
132
delete : "/v1/{name=projects/*/locations/*/entryGroups/*}"
131
133
};
132
134
option (google.api.method_signature ) = "name" ;
133
135
}
134
136
135
137
// Lists entry groups.
136
- rpc ListEntryGroups (ListEntryGroupsRequest ) returns (ListEntryGroupsResponse ) {
138
+ rpc ListEntryGroups (ListEntryGroupsRequest )
139
+ returns (ListEntryGroupsResponse ) {
137
140
option (google.api.http ) = {
138
141
get : "/v1/{parent=projects/*/locations/*}/entryGroups"
139
142
};
@@ -220,7 +223,8 @@ service DataCatalog {
220
223
post : "/v1/{parent=projects/*/locations/*}/tagTemplates"
221
224
body : "tag_template"
222
225
};
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" ;
224
228
}
225
229
226
230
// Gets a tag template.
@@ -252,7 +256,8 @@ service DataCatalog {
252
256
// the `name` parameter (see [Data Catalog Resource Project]
253
257
// (https://cloud.google.com/data-catalog/docs/concepts/resource-project) for
254
258
// more information).
255
- rpc DeleteTagTemplate (DeleteTagTemplateRequest ) returns (google .protobuf .Empty ) {
259
+ rpc DeleteTagTemplate (DeleteTagTemplateRequest )
260
+ returns (google .protobuf .Empty ) {
256
261
option (google.api.http ) = {
257
262
delete : "/v1/{name=projects/*/locations/*/tagTemplates/*}"
258
263
};
@@ -264,34 +269,39 @@ service DataCatalog {
264
269
// [Data Catalog Resource
265
270
// Project](https://cloud.google.com/data-catalog/docs/concepts/resource-project)
266
271
// for more information).
267
- rpc CreateTagTemplateField (CreateTagTemplateFieldRequest ) returns (TagTemplateField ) {
272
+ rpc CreateTagTemplateField (CreateTagTemplateFieldRequest )
273
+ returns (TagTemplateField ) {
268
274
option (google.api.http ) = {
269
275
post : "/v1/{parent=projects/*/locations/*/tagTemplates/*}/fields"
270
276
body : "tag_template_field"
271
277
};
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" ;
273
280
}
274
281
275
282
// Updates a field in a tag template. This method cannot be used to update the
276
283
// field type. Users should enable the Data Catalog API in the project
277
284
// identified by the `name` parameter (see [Data Catalog Resource Project]
278
285
// (https://cloud.google.com/data-catalog/docs/concepts/resource-project) for
279
286
// more information).
280
- rpc UpdateTagTemplateField (UpdateTagTemplateFieldRequest ) returns (TagTemplateField ) {
287
+ rpc UpdateTagTemplateField (UpdateTagTemplateFieldRequest )
288
+ returns (TagTemplateField ) {
281
289
option (google.api.http ) = {
282
290
patch : "/v1/{name=projects/*/locations/*/tagTemplates/*/fields/*}"
283
291
body : "tag_template_field"
284
292
};
285
293
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" ;
287
296
}
288
297
289
298
// Renames a field in a tag template. The user should enable the Data Catalog
290
299
// API in the project identified by the `name` parameter (see [Data Catalog
291
300
// Resource
292
301
// Project](https://cloud.google.com/data-catalog/docs/concepts/resource-project)
293
302
// for more information).
294
- rpc RenameTagTemplateField (RenameTagTemplateFieldRequest ) returns (TagTemplateField ) {
303
+ rpc RenameTagTemplateField (RenameTagTemplateFieldRequest )
304
+ returns (TagTemplateField ) {
295
305
option (google.api.http ) = {
296
306
post : "/v1/{name=projects/*/locations/*/tagTemplates/*/fields/*}:rename"
297
307
body : "*"
@@ -304,7 +314,8 @@ service DataCatalog {
304
314
// the `name` parameter (see [Data Catalog Resource Project]
305
315
// (https://cloud.google.com/data-catalog/docs/concepts/resource-project) for
306
316
// more information).
307
- rpc DeleteTagTemplateField (DeleteTagTemplateFieldRequest ) returns (google .protobuf .Empty ) {
317
+ rpc DeleteTagTemplateField (DeleteTagTemplateFieldRequest )
318
+ returns (google .protobuf .Empty ) {
308
319
option (google.api.http ) = {
309
320
delete : "/v1/{name=projects/*/locations/*/tagTemplates/*/fields/*}"
310
321
};
@@ -380,7 +391,8 @@ service DataCatalog {
380
391
// templates.
381
392
// - `datacatalog.entries.setIamPolicy` to set policies on entries.
382
393
// - `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 ) {
384
396
option (google.api.http ) = {
385
397
post : "/v1/{resource=projects/*/locations/*/tagTemplates/*}:setIamPolicy"
386
398
body : "*"
@@ -389,6 +401,7 @@ service DataCatalog {
389
401
body : "*"
390
402
}
391
403
};
404
+ option (google.api.method_signature ) = "resource,policy" ;
392
405
}
393
406
394
407
// Gets the access control policy for a resource. A `NOT_FOUND` error
@@ -407,7 +420,8 @@ service DataCatalog {
407
420
// templates.
408
421
// - `datacatalog.entries.getIamPolicy` to get policies on entries.
409
422
// - `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 ) {
411
425
option (google.api.http ) = {
412
426
post : "/v1/{resource=projects/*/locations/*/tagTemplates/*}:getIamPolicy"
413
427
body : "*"
@@ -420,6 +434,7 @@ service DataCatalog {
420
434
body : "*"
421
435
}
422
436
};
437
+ option (google.api.method_signature ) = "resource" ;
423
438
}
424
439
425
440
// Returns the caller's permissions on a resource.
@@ -435,7 +450,8 @@ service DataCatalog {
435
450
//
436
451
// A caller is not required to have Google IAM permission to make this
437
452
// 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 ) {
439
455
option (google.api.http ) = {
440
456
post : "/v1/{resource=projects/*/locations/*/tagTemplates/*}:testIamPermissions"
441
457
body : "*"
@@ -507,7 +523,8 @@ message SearchCatalogRequest {
507
523
// * us-east4
508
524
// * us-west1
509
525
// * 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 ];
511
528
}
512
529
513
530
// Required. The scope of this search request. A `scope` that has empty
@@ -516,7 +533,8 @@ message SearchCatalogRequest {
516
533
// return an error in such a case.
517
534
Scope scope = 6 [(google.api.field_behavior ) = REQUIRED ];
518
535
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.
520
538
//
521
539
// Query strings can be simple as "x" or more qualified as:
522
540
//
@@ -535,8 +553,8 @@ message SearchCatalogRequest {
535
553
int32 page_size = 2 ;
536
554
537
555
// 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
540
558
// [SearchCatalogRequest][google.cloud.datacatalog.v1.DataCatalog.SearchCatalog]
541
559
// call, and that the system should return the next page of data. If empty,
542
560
// the first page is returned.
@@ -640,8 +658,8 @@ message DeleteEntryGroupRequest {
640
658
// Request message for
641
659
// [ListEntryGroups][google.cloud.datacatalog.v1.DataCatalog.ListEntryGroups].
642
660
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:
645
663
//
646
664
// * projects/{project_id}/locations/{location}
647
665
string parent = 1 [
@@ -651,12 +669,12 @@ message ListEntryGroupsRequest {
651
669
}
652
670
];
653
671
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`.
656
674
int32 page_size = 2 [(google.api.field_behavior ) = OPTIONAL ];
657
675
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.
660
678
string page_token = 3 [(google.api.field_behavior ) = OPTIONAL ];
661
679
}
662
680
@@ -807,8 +825,8 @@ message Entry {
807
825
// Note that this Entry and its child resources may not actually be stored in
808
826
// the location in this name.
809
827
string name = 1 [(google.api.resource_reference ) = {
810
- type : "datacatalog.googleapis.com/EntryGroup"
811
- }];
828
+ type : "datacatalog.googleapis.com/EntryGroup"
829
+ }];
812
830
813
831
// The resource this metadata entry refers to.
814
832
//
@@ -845,9 +863,10 @@ message Entry {
845
863
846
864
// The source system of the entry.
847
865
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 ];
851
870
852
871
// This field indicates the entry's source system that Data Catalog does not
853
872
// integrate with. `user_specified_system` strings must begin with a letter
@@ -918,8 +937,10 @@ message EntryGroup {
918
937
// string.
919
938
string description = 3 ;
920
939
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 ];
923
944
}
924
945
925
946
// Request message for
@@ -997,18 +1018,16 @@ message DeleteTagTemplateRequest {
997
1018
// Request message for
998
1019
// [CreateTag][google.cloud.datacatalog.v1.DataCatalog.CreateTag].
999
1020
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:
1002
1023
//
1003
1024
// * projects/{project_id}/locations/{location}/entryGroups/{entry_group_id}/entries/{entry_id}
1004
1025
//
1005
1026
// Note that this Tag and its child resources may not actually be stored in
1006
1027
// the location in this name.
1007
1028
string parent = 1 [
1008
1029
(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" }
1012
1031
];
1013
1032
1014
1033
// Required. The tag to create.
@@ -1064,7 +1083,8 @@ message CreateTagTemplateFieldRequest {
1064
1083
string tag_template_field_id = 2 [(google.api.field_behavior ) = REQUIRED ];
1065
1084
1066
1085
// 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 ];
1068
1088
}
1069
1089
1070
1090
// Request message for
@@ -1081,7 +1101,8 @@ message UpdateTagTemplateFieldRequest {
1081
1101
];
1082
1102
1083
1103
// 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 ];
1085
1106
1086
1107
// Optional. The field mask specifies the parts of the template to be updated.
1087
1108
// Allowed fields:
@@ -1097,7 +1118,8 @@ message UpdateTagTemplateFieldRequest {
1097
1118
// existing values. Therefore, enum values can only be added, existing enum
1098
1119
// values cannot be deleted nor renamed. Updating a template field from
1099
1120
// 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 ];
1101
1123
}
1102
1124
1103
1125
// Request message for
@@ -1113,7 +1135,8 @@ message RenameTagTemplateFieldRequest {
1113
1135
}
1114
1136
];
1115
1137
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`.
1117
1140
string new_tag_template_field_id = 2 [(google.api.field_behavior ) = REQUIRED ];
1118
1141
}
1119
1142
@@ -1139,8 +1162,8 @@ message DeleteTagTemplateFieldRequest {
1139
1162
// Request message for
1140
1163
// [ListTags][google.cloud.datacatalog.v1.DataCatalog.ListTags].
1141
1164
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
1144
1167
// [EntryGroup][google.cloud.datacatalog.v1.EntryGroup].
1145
1168
//
1146
1169
// Examples:
0 commit comments