google-cloud-data_catalog-v1 0.7.3 → 0.8.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (30) hide show
  1. checksums.yaml +4 -4
  2. data/lib/google/cloud/data_catalog/v1/data_catalog.rb +2 -2
  3. data/lib/google/cloud/data_catalog/v1/data_catalog/client.rb +303 -291
  4. data/lib/google/cloud/data_catalog/v1/policy_tag_manager.rb +1 -1
  5. data/lib/google/cloud/data_catalog/v1/policy_tag_manager/client.rb +54 -45
  6. data/lib/google/cloud/data_catalog/v1/policy_tag_manager_serialization.rb +4 -3
  7. data/lib/google/cloud/data_catalog/v1/policy_tag_manager_serialization/client.rb +109 -22
  8. data/lib/google/cloud/data_catalog/v1/version.rb +1 -1
  9. data/lib/google/cloud/datacatalog/v1/bigquery_pb.rb +48 -0
  10. data/lib/google/cloud/datacatalog/v1/datacatalog_pb.rb +44 -0
  11. data/lib/google/cloud/datacatalog/v1/datacatalog_services_pb.rb +179 -142
  12. data/lib/google/cloud/datacatalog/v1/policytagmanager_services_pb.rb +15 -14
  13. data/lib/google/cloud/datacatalog/v1/policytagmanagerserialization_pb.rb +5 -0
  14. data/lib/google/cloud/datacatalog/v1/policytagmanagerserialization_services_pb.rb +28 -14
  15. data/lib/google/cloud/datacatalog/v1/tags_pb.rb +3 -0
  16. data/lib/google/cloud/datacatalog/v1/usage_pb.rb +31 -0
  17. data/proto_docs/google/cloud/datacatalog/v1/bigquery.rb +87 -0
  18. data/proto_docs/google/cloud/datacatalog/v1/common.rb +1 -2
  19. data/proto_docs/google/cloud/datacatalog/v1/data_source.rb +6 -5
  20. data/proto_docs/google/cloud/datacatalog/v1/datacatalog.rb +370 -246
  21. data/proto_docs/google/cloud/datacatalog/v1/gcs_fileset_spec.rb +16 -15
  22. data/proto_docs/google/cloud/datacatalog/v1/policytagmanager.rb +87 -71
  23. data/proto_docs/google/cloud/datacatalog/v1/policytagmanagerserialization.rb +34 -19
  24. data/proto_docs/google/cloud/datacatalog/v1/schema.rb +3 -3
  25. data/proto_docs/google/cloud/datacatalog/v1/search.rb +43 -29
  26. data/proto_docs/google/cloud/datacatalog/v1/table_spec.rb +23 -16
  27. data/proto_docs/google/cloud/datacatalog/v1/tags.rb +96 -51
  28. data/proto_docs/google/cloud/datacatalog/v1/timestamps.rb +12 -5
  29. data/proto_docs/google/cloud/datacatalog/v1/usage.rb +79 -0
  30. metadata +6 -2
@@ -0,0 +1,48 @@
1
+ # Generated by the protocol buffer compiler. DO NOT EDIT!
2
+ # source: google/cloud/datacatalog/v1/bigquery.proto
3
+
4
+ require 'google/protobuf'
5
+
6
+ require 'google/api/field_behavior_pb'
7
+ Google::Protobuf::DescriptorPool.generated_pool.build do
8
+ add_file("google/cloud/datacatalog/v1/bigquery.proto", :syntax => :proto3) do
9
+ add_message "google.cloud.datacatalog.v1.BigQueryConnectionSpec" do
10
+ optional :connection_type, :enum, 1, "google.cloud.datacatalog.v1.BigQueryConnectionSpec.ConnectionType"
11
+ optional :has_credential, :bool, 3
12
+ oneof :connection_spec do
13
+ optional :cloud_sql, :message, 2, "google.cloud.datacatalog.v1.CloudSqlBigQueryConnectionSpec"
14
+ end
15
+ end
16
+ add_enum "google.cloud.datacatalog.v1.BigQueryConnectionSpec.ConnectionType" do
17
+ value :CONNECTION_TYPE_UNSPECIFIED, 0
18
+ value :CLOUD_SQL, 1
19
+ end
20
+ add_message "google.cloud.datacatalog.v1.CloudSqlBigQueryConnectionSpec" do
21
+ optional :instance_id, :string, 1
22
+ optional :database, :string, 2
23
+ optional :type, :enum, 3, "google.cloud.datacatalog.v1.CloudSqlBigQueryConnectionSpec.DatabaseType"
24
+ end
25
+ add_enum "google.cloud.datacatalog.v1.CloudSqlBigQueryConnectionSpec.DatabaseType" do
26
+ value :DATABASE_TYPE_UNSPECIFIED, 0
27
+ value :POSTGRES, 1
28
+ value :MYSQL, 2
29
+ end
30
+ add_message "google.cloud.datacatalog.v1.BigQueryRoutineSpec" do
31
+ repeated :imported_libraries, :string, 1
32
+ end
33
+ end
34
+ end
35
+
36
+ module Google
37
+ module Cloud
38
+ module DataCatalog
39
+ module V1
40
+ BigQueryConnectionSpec = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.datacatalog.v1.BigQueryConnectionSpec").msgclass
41
+ BigQueryConnectionSpec::ConnectionType = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.datacatalog.v1.BigQueryConnectionSpec.ConnectionType").enummodule
42
+ CloudSqlBigQueryConnectionSpec = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.datacatalog.v1.CloudSqlBigQueryConnectionSpec").msgclass
43
+ CloudSqlBigQueryConnectionSpec::DatabaseType = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.datacatalog.v1.CloudSqlBigQueryConnectionSpec.DatabaseType").enummodule
44
+ BigQueryRoutineSpec = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.datacatalog.v1.BigQueryRoutineSpec").msgclass
45
+ end
46
+ end
47
+ end
48
+ end
@@ -7,6 +7,7 @@ require 'google/api/annotations_pb'
7
7
  require 'google/api/client_pb'
8
8
  require 'google/api/field_behavior_pb'
9
9
  require 'google/api/resource_pb'
10
+ require 'google/cloud/datacatalog/v1/bigquery_pb'
10
11
  require 'google/cloud/datacatalog/v1/common_pb'
11
12
  require 'google/cloud/datacatalog/v1/data_source_pb'
12
13
  require 'google/cloud/datacatalog/v1/gcs_fileset_spec_pb'
@@ -15,6 +16,7 @@ require 'google/cloud/datacatalog/v1/search_pb'
15
16
  require 'google/cloud/datacatalog/v1/table_spec_pb'
16
17
  require 'google/cloud/datacatalog/v1/tags_pb'
17
18
  require 'google/cloud/datacatalog/v1/timestamps_pb'
19
+ require 'google/cloud/datacatalog/v1/usage_pb'
18
20
  require 'google/iam/v1/iam_policy_pb'
19
21
  require 'google/iam/v1/policy_pb'
20
22
  require 'google/protobuf/empty_pb'
@@ -34,6 +36,7 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
34
36
  repeated :include_project_ids, :string, 3
35
37
  optional :include_gcp_public_datasets, :bool, 7
36
38
  repeated :restricted_locations, :string, 16
39
+ optional :include_public_tag_templates, :bool, 19
37
40
  end
38
41
  add_message "google.cloud.datacatalog.v1.SearchCatalogResponse" do
39
42
  repeated :results, :message, 1, "google.cloud.datacatalog.v1.SearchCatalogResult"
@@ -96,6 +99,8 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
96
99
  optional :description, :string, 4
97
100
  optional :schema, :message, 5, "google.cloud.datacatalog.v1.Schema"
98
101
  optional :source_system_timestamps, :message, 7, "google.cloud.datacatalog.v1.SystemTimestamps"
102
+ optional :usage_signal, :message, 13, "google.cloud.datacatalog.v1.UsageSignal"
103
+ map :labels, :string, :string, 14
99
104
  optional :data_source, :message, 20, "google.cloud.datacatalog.v1.DataSource"
100
105
  oneof :entry_type do
101
106
  optional :type, :enum, 2, "google.cloud.datacatalog.v1.EntryType"
@@ -112,6 +117,8 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
112
117
  end
113
118
  oneof :spec do
114
119
  optional :database_table_spec, :message, 24, "google.cloud.datacatalog.v1.DatabaseTableSpec"
120
+ optional :data_source_connection_spec, :message, 27, "google.cloud.datacatalog.v1.DataSourceConnectionSpec"
121
+ optional :routine_spec, :message, 28, "google.cloud.datacatalog.v1.RoutineSpec"
115
122
  end
116
123
  end
117
124
  add_message "google.cloud.datacatalog.v1.DatabaseTableSpec" do
@@ -122,6 +129,35 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
122
129
  value :NATIVE, 1
123
130
  value :EXTERNAL, 2
124
131
  end
132
+ add_message "google.cloud.datacatalog.v1.DataSourceConnectionSpec" do
133
+ optional :bigquery_connection_spec, :message, 1, "google.cloud.datacatalog.v1.BigQueryConnectionSpec"
134
+ end
135
+ add_message "google.cloud.datacatalog.v1.RoutineSpec" do
136
+ optional :routine_type, :enum, 1, "google.cloud.datacatalog.v1.RoutineSpec.RoutineType"
137
+ optional :language, :string, 2
138
+ repeated :routine_arguments, :message, 3, "google.cloud.datacatalog.v1.RoutineSpec.Argument"
139
+ optional :return_type, :string, 4
140
+ optional :definition_body, :string, 5
141
+ oneof :system_spec do
142
+ optional :bigquery_routine_spec, :message, 6, "google.cloud.datacatalog.v1.BigQueryRoutineSpec"
143
+ end
144
+ end
145
+ add_message "google.cloud.datacatalog.v1.RoutineSpec.Argument" do
146
+ optional :name, :string, 1
147
+ optional :mode, :enum, 2, "google.cloud.datacatalog.v1.RoutineSpec.Argument.Mode"
148
+ optional :type, :string, 3
149
+ end
150
+ add_enum "google.cloud.datacatalog.v1.RoutineSpec.Argument.Mode" do
151
+ value :MODE_UNSPECIFIED, 0
152
+ value :IN, 1
153
+ value :OUT, 2
154
+ value :INOUT, 3
155
+ end
156
+ add_enum "google.cloud.datacatalog.v1.RoutineSpec.RoutineType" do
157
+ value :ROUTINE_TYPE_UNSPECIFIED, 0
158
+ value :SCALAR_FUNCTION, 1
159
+ value :PROCEDURE, 2
160
+ end
125
161
  add_message "google.cloud.datacatalog.v1.EntryGroup" do
126
162
  optional :name, :string, 1
127
163
  optional :display_name, :string, 2
@@ -202,7 +238,10 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
202
238
  value :MODEL, 5
203
239
  value :DATA_STREAM, 3
204
240
  value :FILESET, 4
241
+ value :CLUSTER, 6
205
242
  value :DATABASE, 7
243
+ value :DATA_SOURCE_CONNECTION, 8
244
+ value :ROUTINE, 9
206
245
  value :SERVICE, 14
207
246
  end
208
247
  end
@@ -229,6 +268,11 @@ module Google
229
268
  Entry = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.datacatalog.v1.Entry").msgclass
230
269
  DatabaseTableSpec = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.datacatalog.v1.DatabaseTableSpec").msgclass
231
270
  DatabaseTableSpec::TableType = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.datacatalog.v1.DatabaseTableSpec.TableType").enummodule
271
+ DataSourceConnectionSpec = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.datacatalog.v1.DataSourceConnectionSpec").msgclass
272
+ RoutineSpec = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.datacatalog.v1.RoutineSpec").msgclass
273
+ RoutineSpec::Argument = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.datacatalog.v1.RoutineSpec.Argument").msgclass
274
+ RoutineSpec::Argument::Mode = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.datacatalog.v1.RoutineSpec.Argument.Mode").enummodule
275
+ RoutineSpec::RoutineType = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.datacatalog.v1.RoutineSpec.RoutineType").enummodule
232
276
  EntryGroup = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.datacatalog.v1.EntryGroup").msgclass
233
277
  CreateTagTemplateRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.datacatalog.v1.CreateTagTemplateRequest").msgclass
234
278
  GetTagTemplateRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.datacatalog.v1.GetTagTemplateRequest").msgclass
@@ -24,8 +24,8 @@ module Google
24
24
  module DataCatalog
25
25
  module V1
26
26
  module DataCatalog
27
- # Data Catalog API service allows clients to discover, understand, and manage
28
- # their data.
27
+ # Data Catalog API service allows you to discover, understand, and manage
28
+ # your data.
29
29
  class Service
30
30
 
31
31
  include GRPC::GenericService
@@ -34,199 +34,236 @@ module Google
34
34
  self.unmarshal_class_method = :decode
35
35
  self.service_name = 'google.cloud.datacatalog.v1.DataCatalog'
36
36
 
37
- # Searches Data Catalog for multiple resources like entries, tags that
37
+ # Searches Data Catalog for multiple resources like entries and tags that
38
38
  # match a query.
39
39
  #
40
- # This is a custom method
41
- # (https://cloud.google.com/apis/design/custom_methods) and does not return
42
- # the complete resource, only the resource identifier and high level
43
- # fields. Clients can subsequently call `Get` methods.
40
+ # This is a [Custom Method]
41
+ # (https://cloud.google.com/apis/design/custom_methods) that doesn't return
42
+ # all information on a resource, only its ID and high level fields. To get
43
+ # more information, you can subsequently call specific get methods.
44
44
  #
45
- # Note that Data Catalog search queries do not guarantee full recall. Query
46
- # results that match your query may not be returned, even in subsequent
47
- # result pages. Also note that results returned (and not returned) can vary
48
- # across repeated search queries.
45
+ # Note: Data Catalog search queries don't guarantee full recall. Results
46
+ # that match your query might not be returned, even in subsequent
47
+ # result pages. Additionally, returned (and not returned) results can vary
48
+ # if you repeat search queries.
49
49
  #
50
- # See [Data Catalog Search
51
- # Syntax](https://cloud.google.com/data-catalog/docs/how-to/search-reference)
52
- # for more information.
50
+ # For more information, see [Data Catalog search syntax]
51
+ # (https://cloud.google.com/data-catalog/docs/how-to/search-reference).
53
52
  rpc :SearchCatalog, ::Google::Cloud::DataCatalog::V1::SearchCatalogRequest, ::Google::Cloud::DataCatalog::V1::SearchCatalogResponse
54
- # Creates an EntryGroup.
53
+ # Creates an entry group.
55
54
  #
56
- # An entry group contains logically related entries together with Cloud
57
- # Identity and Access Management policies that specify the users who can
58
- # create, edit, and view entries within the entry group.
55
+ # An entry group contains logically related entries together with [Cloud
56
+ # Identity and Access Management](/data-catalog/docs/concepts/iam) policies.
57
+ # These policies specify users who can create, edit, and view entries
58
+ # within entry groups.
59
59
  #
60
- # Data Catalog automatically creates an entry group for BigQuery entries
61
- # ("@bigquery") and Pub/Sub topics ("@pubsub"). Users create their own entry
62
- # group to contain Cloud Storage fileset entries or custom type entries,
63
- # and the IAM policies associated with those entries. Entry groups, like
64
- # entries, can be searched.
60
+ # Data Catalog automatically creates entry groups with names that start with
61
+ # the `@` symbol for the following resources:
62
+ #
63
+ # * BigQuery entries (`@bigquery`)
64
+ # * Pub/Sub topics (`@pubsub`)
65
+ # * Dataproc Metastore services (`@dataproc_metastore_{SERVICE_NAME_HASH}`)
66
+ #
67
+ # You can create your own entry groups for Cloud Storage fileset entries
68
+ # and custom entries together with the corresponding IAM policies.
69
+ # User-created entry groups can't contain the `@` symbol, it is reserved
70
+ # for automatically created groups.
71
+ #
72
+ # Entry groups, like entries, can be searched.
65
73
  #
66
74
  # A maximum of 10,000 entry groups may be created per organization across all
67
75
  # locations.
68
76
  #
69
- # Users should enable the Data Catalog API in the project identified by
70
- # the `parent` parameter (see [Data Catalog Resource Project]
71
- # (https://cloud.google.com/data-catalog/docs/concepts/resource-project) for
72
- # more information).
77
+ # You must enable the Data Catalog API in the project identified by
78
+ # the `parent` parameter. For more information, see [Data Catalog resource
79
+ # project](https://cloud.google.com/data-catalog/docs/concepts/resource-project).
73
80
  rpc :CreateEntryGroup, ::Google::Cloud::DataCatalog::V1::CreateEntryGroupRequest, ::Google::Cloud::DataCatalog::V1::EntryGroup
74
- # Gets an EntryGroup.
81
+ # Gets an entry group.
75
82
  rpc :GetEntryGroup, ::Google::Cloud::DataCatalog::V1::GetEntryGroupRequest, ::Google::Cloud::DataCatalog::V1::EntryGroup
76
- # Updates an EntryGroup. The user should enable the Data Catalog API in the
77
- # project identified by the `entry_group.name` parameter (see [Data Catalog
78
- # Resource Project]
79
- # (https://cloud.google.com/data-catalog/docs/concepts/resource-project) for
80
- # more information).
83
+ # Updates an entry group.
84
+ #
85
+ # You must enable the Data Catalog API in the project identified by
86
+ # the `entry_group.name` parameter. For more information, see [Data Catalog
87
+ # resource
88
+ # project](https://cloud.google.com/data-catalog/docs/concepts/resource-project).
81
89
  rpc :UpdateEntryGroup, ::Google::Cloud::DataCatalog::V1::UpdateEntryGroupRequest, ::Google::Cloud::DataCatalog::V1::EntryGroup
82
- # Deletes an EntryGroup. Only entry groups that do not contain entries can be
83
- # deleted. Users should enable the Data Catalog API in the project
84
- # identified by the `name` parameter (see [Data Catalog Resource Project]
85
- # (https://cloud.google.com/data-catalog/docs/concepts/resource-project) for
86
- # more information).
90
+ # Deletes an entry group.
91
+ #
92
+ # You must enable the Data Catalog API in the project
93
+ # identified by the `name` parameter. For more information, see [Data Catalog
94
+ # resource
95
+ # project](https://cloud.google.com/data-catalog/docs/concepts/resource-project).
87
96
  rpc :DeleteEntryGroup, ::Google::Cloud::DataCatalog::V1::DeleteEntryGroupRequest, ::Google::Protobuf::Empty
88
97
  # Lists entry groups.
89
98
  rpc :ListEntryGroups, ::Google::Cloud::DataCatalog::V1::ListEntryGroupsRequest, ::Google::Cloud::DataCatalog::V1::ListEntryGroupsResponse
90
- # Creates an entry. Only entries of types 'FILESET', 'CLUSTER', 'DATA_STREAM'
91
- # or with a user-specified type can be created.
99
+ # Creates an entry.
92
100
  #
93
- # Users should enable the Data Catalog API in the project identified by
94
- # the `parent` parameter (see [Data Catalog Resource Project]
95
- # (https://cloud.google.com/data-catalog/docs/concepts/resource-project) for
96
- # more information).
101
+ # You can create entries only with 'FILESET', 'CLUSTER', 'DATA_STREAM',
102
+ # or custom types. Data Catalog automatically creates entries with other
103
+ # types during metadata ingestion from integrated systems.
97
104
  #
98
- # A maximum of 100,000 entries may be created per entry group.
105
+ # You must enable the Data Catalog API in the project identified by
106
+ # the `parent` parameter. For more information, see [Data Catalog resource
107
+ # project](https://cloud.google.com/data-catalog/docs/concepts/resource-project).
108
+ #
109
+ # An entry group can have a maximum of 100,000 entries.
99
110
  rpc :CreateEntry, ::Google::Cloud::DataCatalog::V1::CreateEntryRequest, ::Google::Cloud::DataCatalog::V1::Entry
100
111
  # Updates an existing entry.
101
- # Users should enable the Data Catalog API in the project identified by
102
- # the `entry.name` parameter (see [Data Catalog Resource Project]
103
- # (https://cloud.google.com/data-catalog/docs/concepts/resource-project) for
104
- # more information).
112
+ #
113
+ # You must enable the Data Catalog API in the project identified by
114
+ # the `entry.name` parameter. For more information, see [Data Catalog
115
+ # resource
116
+ # project](https://cloud.google.com/data-catalog/docs/concepts/resource-project).
105
117
  rpc :UpdateEntry, ::Google::Cloud::DataCatalog::V1::UpdateEntryRequest, ::Google::Cloud::DataCatalog::V1::Entry
106
- # Deletes an existing entry. Only entries created through
118
+ # Deletes an existing entry.
119
+ #
120
+ # You can delete only the entries created by the
107
121
  # [CreateEntry][google.cloud.datacatalog.v1.DataCatalog.CreateEntry]
108
- # method can be deleted.
109
- # Users should enable the Data Catalog API in the project identified by
110
- # the `name` parameter (see [Data Catalog Resource Project]
111
- # (https://cloud.google.com/data-catalog/docs/concepts/resource-project) for
112
- # more information).
122
+ # method.
123
+ #
124
+ # You must enable the Data Catalog API in the project identified by
125
+ # the `name` parameter. For more information, see [Data Catalog
126
+ # resource
127
+ # project](https://cloud.google.com/data-catalog/docs/concepts/resource-project).
113
128
  rpc :DeleteEntry, ::Google::Cloud::DataCatalog::V1::DeleteEntryRequest, ::Google::Protobuf::Empty
114
129
  # Gets an entry.
115
130
  rpc :GetEntry, ::Google::Cloud::DataCatalog::V1::GetEntryRequest, ::Google::Cloud::DataCatalog::V1::Entry
116
- # Get an entry by target resource name. This method allows clients to use
117
- # the resource name from the source Google Cloud Platform service to get the
118
- # Data Catalog Entry.
131
+ # Gets an entry by its target resource name.
132
+ #
133
+ # The resource name comes from the source Google Cloud Platform service.
119
134
  rpc :LookupEntry, ::Google::Cloud::DataCatalog::V1::LookupEntryRequest, ::Google::Cloud::DataCatalog::V1::Entry
120
135
  # Lists entries.
121
136
  rpc :ListEntries, ::Google::Cloud::DataCatalog::V1::ListEntriesRequest, ::Google::Cloud::DataCatalog::V1::ListEntriesResponse
122
- # Creates a tag template. The user should enable the Data Catalog API in
123
- # the project identified by the `parent` parameter (see [Data Catalog
124
- # Resource
125
- # Project](https://cloud.google.com/data-catalog/docs/concepts/resource-project)
126
- # for more information).
137
+ # Creates a tag template.
138
+ #
139
+ # You must enable the Data Catalog API in the project identified by the
140
+ # `parent` parameter.
141
+ # For more information, see [Data Catalog resource project]
142
+ # (https://cloud.google.com/data-catalog/docs/concepts/resource-project).
127
143
  rpc :CreateTagTemplate, ::Google::Cloud::DataCatalog::V1::CreateTagTemplateRequest, ::Google::Cloud::DataCatalog::V1::TagTemplate
128
144
  # Gets a tag template.
129
145
  rpc :GetTagTemplate, ::Google::Cloud::DataCatalog::V1::GetTagTemplateRequest, ::Google::Cloud::DataCatalog::V1::TagTemplate
130
- # Updates a tag template. This method cannot be used to update the fields of
131
- # a template. The tag template fields are represented as separate resources
132
- # and should be updated using their own create/update/delete methods.
133
- # Users should enable the Data Catalog API in the project identified by
134
- # the `tag_template.name` parameter (see [Data Catalog Resource Project]
135
- # (https://cloud.google.com/data-catalog/docs/concepts/resource-project) for
136
- # more information).
146
+ # Updates a tag template.
147
+ #
148
+ # You can't update template fields with this method. These fields are
149
+ # separate resources with their own create, update, and delete methods.
150
+ #
151
+ # You must enable the Data Catalog API in the project identified by
152
+ # the `tag_template.name` parameter. For more information, see [Data Catalog
153
+ # resource
154
+ # project](https://cloud.google.com/data-catalog/docs/concepts/resource-project).
137
155
  rpc :UpdateTagTemplate, ::Google::Cloud::DataCatalog::V1::UpdateTagTemplateRequest, ::Google::Cloud::DataCatalog::V1::TagTemplate
138
- # Deletes a tag template and all tags using the template.
139
- # Users should enable the Data Catalog API in the project identified by
140
- # the `name` parameter (see [Data Catalog Resource Project]
141
- # (https://cloud.google.com/data-catalog/docs/concepts/resource-project) for
142
- # more information).
156
+ # Deletes a tag template and all tags that use it.
157
+ #
158
+ # You must enable the Data Catalog API in the project identified by
159
+ # the `name` parameter. For more information, see [Data Catalog resource
160
+ # project](https://cloud.google.com/data-catalog/docs/concepts/resource-project).
143
161
  rpc :DeleteTagTemplate, ::Google::Cloud::DataCatalog::V1::DeleteTagTemplateRequest, ::Google::Protobuf::Empty
144
- # Creates a field in a tag template. The user should enable the Data Catalog
145
- # API in the project identified by the `parent` parameter (see
146
- # [Data Catalog Resource
147
- # Project](https://cloud.google.com/data-catalog/docs/concepts/resource-project)
148
- # for more information).
162
+ # Creates a field in a tag template.
163
+ #
164
+ # You must enable the Data Catalog API in the project identified by
165
+ # the `parent` parameter. For more information, see [Data Catalog resource
166
+ # project](https://cloud.google.com/data-catalog/docs/concepts/resource-project).
149
167
  rpc :CreateTagTemplateField, ::Google::Cloud::DataCatalog::V1::CreateTagTemplateFieldRequest, ::Google::Cloud::DataCatalog::V1::TagTemplateField
150
- # Updates a field in a tag template. This method cannot be used to update the
151
- # field type. Users should enable the Data Catalog API in the project
152
- # identified by the `name` parameter (see [Data Catalog Resource Project]
153
- # (https://cloud.google.com/data-catalog/docs/concepts/resource-project) for
154
- # more information).
168
+ # Updates a field in a tag template.
169
+ #
170
+ # You can't update the field type with this method.
171
+ #
172
+ # You must enable the Data Catalog API in the project
173
+ # identified by the `name` parameter. For more information, see [Data Catalog
174
+ # resource
175
+ # project](https://cloud.google.com/data-catalog/docs/concepts/resource-project).
155
176
  rpc :UpdateTagTemplateField, ::Google::Cloud::DataCatalog::V1::UpdateTagTemplateFieldRequest, ::Google::Cloud::DataCatalog::V1::TagTemplateField
156
- # Renames a field in a tag template. The user should enable the Data Catalog
157
- # API in the project identified by the `name` parameter (see [Data Catalog
158
- # Resource
159
- # Project](https://cloud.google.com/data-catalog/docs/concepts/resource-project)
160
- # for more information).
177
+ # Renames a field in a tag template.
178
+ #
179
+ # You must enable the Data Catalog API in the project identified by the
180
+ # `name` parameter. For more information, see [Data Catalog resource project]
181
+ # (https://cloud.google.com/data-catalog/docs/concepts/resource-project).
161
182
  rpc :RenameTagTemplateField, ::Google::Cloud::DataCatalog::V1::RenameTagTemplateFieldRequest, ::Google::Cloud::DataCatalog::V1::TagTemplateField
162
- # Renames an enum value in a tag template. The enum values have to be unique
163
- # within one enum field.
183
+ # Renames an enum value in a tag template.
184
+ #
185
+ # Within a single enum field, enum values must be unique.
164
186
  rpc :RenameTagTemplateFieldEnumValue, ::Google::Cloud::DataCatalog::V1::RenameTagTemplateFieldEnumValueRequest, ::Google::Cloud::DataCatalog::V1::TagTemplateField
165
- # Deletes a field in a tag template and all uses of that field.
166
- # Users should enable the Data Catalog API in the project identified by
167
- # the `name` parameter (see [Data Catalog Resource Project]
168
- # (https://cloud.google.com/data-catalog/docs/concepts/resource-project) for
169
- # more information).
187
+ # Deletes a field in a tag template and all uses of this field from the tags
188
+ # based on this template.
189
+ #
190
+ # You must enable the Data Catalog API in the project identified by
191
+ # the `name` parameter. For more information, see [Data Catalog resource
192
+ # project](https://cloud.google.com/data-catalog/docs/concepts/resource-project).
170
193
  rpc :DeleteTagTemplateField, ::Google::Cloud::DataCatalog::V1::DeleteTagTemplateFieldRequest, ::Google::Protobuf::Empty
171
- # Creates a tag on an [Entry][google.cloud.datacatalog.v1.Entry].
172
- # Note: The project identified by the `parent` parameter for the
173
- # [tag](https://cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries.tags/create#path-parameters)
174
- # and the
175
- # [tag
176
- # template](https://cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.tagTemplates/create#path-parameters)
177
- # used to create the tag must be from the same organization.
194
+ # Creates a tag and assigns it to:
195
+ #
196
+ # * An [Entry][google.cloud.datacatalog.v1.Entry] if the method name is
197
+ # ``projects.locations.entryGroups.entries.tags.create``.
198
+ # * Or [EntryGroup][google.cloud.datacatalog.v1.EntryGroup]if the method
199
+ # name is ``projects.locations.entryGroups.tags.create``.
200
+ #
201
+ # Note: The project identified by the `parent` parameter for the [tag]
202
+ # (https://cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries.tags/create#path-parameters)
203
+ # and the [tag template]
204
+ # (https://cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.tagTemplates/create#path-parameters)
205
+ # used to create the tag must be in the same organization.
178
206
  rpc :CreateTag, ::Google::Cloud::DataCatalog::V1::CreateTagRequest, ::Google::Cloud::DataCatalog::V1::Tag
179
207
  # Updates an existing tag.
180
208
  rpc :UpdateTag, ::Google::Cloud::DataCatalog::V1::UpdateTagRequest, ::Google::Cloud::DataCatalog::V1::Tag
181
209
  # Deletes a tag.
182
210
  rpc :DeleteTag, ::Google::Cloud::DataCatalog::V1::DeleteTagRequest, ::Google::Protobuf::Empty
183
- # Lists the tags on an [Entry][google.cloud.datacatalog.v1.Entry].
211
+ # Lists tags assigned to an [Entry][google.cloud.datacatalog.v1.Entry].
184
212
  rpc :ListTags, ::Google::Cloud::DataCatalog::V1::ListTagsRequest, ::Google::Cloud::DataCatalog::V1::ListTagsResponse
185
- # Sets the access control policy for a resource. Replaces any existing
213
+ # Sets an access control policy for a resource. Replaces any existing
186
214
  # policy.
215
+ #
187
216
  # Supported resources are:
188
- # - Tag templates.
189
- # - Entries.
190
- # - Entry groups.
191
- # Note, this method cannot be used to manage policies for BigQuery, Pub/Sub
192
- # and any external Google Cloud Platform resources synced to Data Catalog.
193
- #
194
- # Callers must have following Google IAM permission
195
- # - `datacatalog.tagTemplates.setIamPolicy` to set policies on tag
196
- # templates.
197
- # - `datacatalog.entries.setIamPolicy` to set policies on entries.
198
- # - `datacatalog.entryGroups.setIamPolicy` to set policies on entry groups.
217
+ #
218
+ # - Tag templates
219
+ # - Entry groups
220
+ #
221
+ # Note: This method sets policies only within Data Catalog and can't be
222
+ # used to manage policies in BigQuery, Pub/Sub, Dataproc Metastore, and any
223
+ # external Google Cloud Platform resources synced with the Data Catalog.
224
+ #
225
+ # To call this method, you must have the following Google IAM permissions:
226
+ #
227
+ # - `datacatalog.tagTemplates.setIamPolicy` to set policies on tag
228
+ # templates.
229
+ # - `datacatalog.entryGroups.setIamPolicy` to set policies on entry groups.
199
230
  rpc :SetIamPolicy, ::Google::Iam::V1::SetIamPolicyRequest, ::Google::Iam::V1::Policy
200
- # Gets the access control policy for a resource. A `NOT_FOUND` error
201
- # is returned if the resource does not exist. An empty policy is returned
202
- # if the resource exists but does not have a policy set on it.
231
+ # Gets the access control policy for a resource.
232
+ #
233
+ # May return:
234
+ #
235
+ # * A`NOT_FOUND` error if the resource doesn't exist or you don't have the
236
+ # permission to view it.
237
+ # * An empty policy if the resource exists but doesn't have a set policy.
203
238
  #
204
239
  # Supported resources are:
205
- # - Tag templates.
206
- # - Entries.
207
- # - Entry groups.
208
- # Note, this method cannot be used to manage policies for BigQuery, Pub/Sub
209
- # and any external Google Cloud Platform resources synced to Data Catalog.
210
- #
211
- # Callers must have following Google IAM permission
212
- # - `datacatalog.tagTemplates.getIamPolicy` to get policies on tag
213
- # templates.
214
- # - `datacatalog.entries.getIamPolicy` to get policies on entries.
215
- # - `datacatalog.entryGroups.getIamPolicy` to get policies on entry groups.
240
+ #
241
+ # - Tag templates
242
+ # - Entry groups
243
+ #
244
+ # Note: This method doesn't get policies from Google Cloud Platform
245
+ # resources ingested into Data Catalog.
246
+ #
247
+ # To call this method, you must have the following Google IAM permissions:
248
+ #
249
+ # - `datacatalog.tagTemplates.getIamPolicy` to get policies on tag
250
+ # templates.
251
+ # - `datacatalog.entryGroups.getIamPolicy` to get policies on entry groups.
216
252
  rpc :GetIamPolicy, ::Google::Iam::V1::GetIamPolicyRequest, ::Google::Iam::V1::Policy
217
- # Returns the caller's permissions on a resource.
218
- # If the resource does not exist, an empty set of permissions is returned
219
- # (We don't return a `NOT_FOUND` error).
253
+ # Gets your permissions on a resource.
254
+ #
255
+ # Returns an empty set of permissions if the resource doesn't exist.
220
256
  #
221
257
  # Supported resources are:
222
- # - Tag templates.
223
- # - Entries.
224
- # - Entry groups.
225
- # Note, this method cannot be used to manage policies for BigQuery, Pub/Sub
226
- # and any external Google Cloud Platform resources synced to Data Catalog.
227
- #
228
- # A caller is not required to have Google IAM permission to make this
229
- # request.
258
+ #
259
+ # - Tag templates
260
+ # - Entry groups
261
+ #
262
+ # Note: This method gets policies only within Data Catalog and can't be
263
+ # used to get policies from BigQuery, Pub/Sub, Dataproc Metastore, and any
264
+ # external Google Cloud Platform resources ingested into Data Catalog.
265
+ #
266
+ # No Google IAM permissions are required to call this method.
230
267
  rpc :TestIamPermissions, ::Google::Iam::V1::TestIamPermissionsRequest, ::Google::Iam::V1::TestIamPermissionsResponse
231
268
  end
232
269