google-cloud-data_catalog-v1 0.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +7 -0
- data/.yardopts +12 -0
- data/AUTHENTICATION.md +169 -0
- data/LICENSE.md +203 -0
- data/README.md +24 -0
- data/lib/google-cloud-data_catalog-v1.rb +1 -0
- data/lib/google/cloud/common_resources_pb.rb +15 -0
- data/lib/google/cloud/data_catalog/v1.rb +19 -0
- data/lib/google/cloud/data_catalog/v1/data_catalog.rb +20 -0
- data/lib/google/cloud/data_catalog/v1/data_catalog/client.rb +2639 -0
- data/lib/google/cloud/data_catalog/v1/data_catalog/credentials.rb +51 -0
- data/lib/google/cloud/data_catalog/v1/data_catalog/paths.rb +136 -0
- data/lib/google/cloud/data_catalog/v1/version.rb +28 -0
- data/lib/google/cloud/datacatalog/v1/common_pb.rb +24 -0
- data/lib/google/cloud/datacatalog/v1/datacatalog_pb.rb +226 -0
- data/lib/google/cloud/datacatalog/v1/datacatalog_services_pb.rb +222 -0
- data/lib/google/cloud/datacatalog/v1/gcs_fileset_spec_pb.rb +31 -0
- data/lib/google/cloud/datacatalog/v1/schema_pb.rb +31 -0
- data/lib/google/cloud/datacatalog/v1/search_pb.rb +39 -0
- data/lib/google/cloud/datacatalog/v1/table_spec_pb.rb +48 -0
- data/lib/google/cloud/datacatalog/v1/tags_pb.rb +84 -0
- data/lib/google/cloud/datacatalog/v1/timestamps_pb.rb +26 -0
- data/proto_docs/README.md +4 -0
- data/proto_docs/google/api/field_behavior.rb +59 -0
- data/proto_docs/google/api/resource.rb +247 -0
- data/proto_docs/google/cloud/datacatalog/v1/common.rb +39 -0
- data/proto_docs/google/cloud/datacatalog/v1/datacatalog.rb +748 -0
- data/proto_docs/google/cloud/datacatalog/v1/gcs_fileset_spec.rb +79 -0
- data/proto_docs/google/cloud/datacatalog/v1/schema.rb +60 -0
- data/proto_docs/google/cloud/datacatalog/v1/search.rb +80 -0
- data/proto_docs/google/cloud/datacatalog/v1/table_spec.rb +98 -0
- data/proto_docs/google/cloud/datacatalog/v1/tags.rb +238 -0
- data/proto_docs/google/cloud/datacatalog/v1/timestamps.rb +42 -0
- data/proto_docs/google/iam/v1/iam_policy.rb +79 -0
- data/proto_docs/google/iam/v1/policy.rb +156 -0
- data/proto_docs/google/protobuf/empty.rb +36 -0
- data/proto_docs/google/protobuf/field_mask.rb +229 -0
- data/proto_docs/google/protobuf/timestamp.rb +120 -0
- metadata +207 -0
@@ -0,0 +1,26 @@
|
|
1
|
+
# Generated by the protocol buffer compiler. DO NOT EDIT!
|
2
|
+
# source: google/cloud/datacatalog/v1/timestamps.proto
|
3
|
+
|
4
|
+
require 'google/protobuf'
|
5
|
+
|
6
|
+
require 'google/api/field_behavior_pb'
|
7
|
+
require 'google/protobuf/timestamp_pb'
|
8
|
+
Google::Protobuf::DescriptorPool.generated_pool.build do
|
9
|
+
add_file("google/cloud/datacatalog/v1/timestamps.proto", :syntax => :proto3) do
|
10
|
+
add_message "google.cloud.datacatalog.v1.SystemTimestamps" do
|
11
|
+
optional :create_time, :message, 1, "google.protobuf.Timestamp"
|
12
|
+
optional :update_time, :message, 2, "google.protobuf.Timestamp"
|
13
|
+
optional :expire_time, :message, 3, "google.protobuf.Timestamp"
|
14
|
+
end
|
15
|
+
end
|
16
|
+
end
|
17
|
+
|
18
|
+
module Google
|
19
|
+
module Cloud
|
20
|
+
module DataCatalog
|
21
|
+
module V1
|
22
|
+
SystemTimestamps = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.datacatalog.v1.SystemTimestamps").msgclass
|
23
|
+
end
|
24
|
+
end
|
25
|
+
end
|
26
|
+
end
|
@@ -0,0 +1,59 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
# Copyright 2020 Google LLC
|
4
|
+
#
|
5
|
+
# Licensed under the Apache License, Version 2.0 (the "License");
|
6
|
+
# you may not use this file except in compliance with the License.
|
7
|
+
# You may obtain a copy of the License at
|
8
|
+
#
|
9
|
+
# https://www.apache.org/licenses/LICENSE-2.0
|
10
|
+
#
|
11
|
+
# Unless required by applicable law or agreed to in writing, software
|
12
|
+
# distributed under the License is distributed on an "AS IS" BASIS,
|
13
|
+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
14
|
+
# See the License for the specific language governing permissions and
|
15
|
+
# limitations under the License.
|
16
|
+
|
17
|
+
# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
|
18
|
+
|
19
|
+
|
20
|
+
module Google
|
21
|
+
module Api
|
22
|
+
# An indicator of the behavior of a given field (for example, that a field
|
23
|
+
# is required in requests, or given as output but ignored as input).
|
24
|
+
# This **does not** change the behavior in protocol buffers itself; it only
|
25
|
+
# denotes the behavior and may affect how API tooling handles the field.
|
26
|
+
#
|
27
|
+
# Note: This enum **may** receive new values in the future.
|
28
|
+
module FieldBehavior
|
29
|
+
# Conventional default for enums. Do not use this.
|
30
|
+
FIELD_BEHAVIOR_UNSPECIFIED = 0
|
31
|
+
|
32
|
+
# Specifically denotes a field as optional.
|
33
|
+
# While all fields in protocol buffers are optional, this may be specified
|
34
|
+
# for emphasis if appropriate.
|
35
|
+
OPTIONAL = 1
|
36
|
+
|
37
|
+
# Denotes a field as required.
|
38
|
+
# This indicates that the field **must** be provided as part of the request,
|
39
|
+
# and failure to do so will cause an error (usually `INVALID_ARGUMENT`).
|
40
|
+
REQUIRED = 2
|
41
|
+
|
42
|
+
# Denotes a field as output only.
|
43
|
+
# This indicates that the field is provided in responses, but including the
|
44
|
+
# field in a request does nothing (the server *must* ignore it and
|
45
|
+
# *must not* throw an error as a result of the field's presence).
|
46
|
+
OUTPUT_ONLY = 3
|
47
|
+
|
48
|
+
# Denotes a field as input only.
|
49
|
+
# This indicates that the field is provided in requests, and the
|
50
|
+
# corresponding field is not included in output.
|
51
|
+
INPUT_ONLY = 4
|
52
|
+
|
53
|
+
# Denotes a field as immutable.
|
54
|
+
# This indicates that the field may be set once in a request to create a
|
55
|
+
# resource, but may not be changed thereafter.
|
56
|
+
IMMUTABLE = 5
|
57
|
+
end
|
58
|
+
end
|
59
|
+
end
|
@@ -0,0 +1,247 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
# Copyright 2020 Google LLC
|
4
|
+
#
|
5
|
+
# Licensed under the Apache License, Version 2.0 (the "License");
|
6
|
+
# you may not use this file except in compliance with the License.
|
7
|
+
# You may obtain a copy of the License at
|
8
|
+
#
|
9
|
+
# https://www.apache.org/licenses/LICENSE-2.0
|
10
|
+
#
|
11
|
+
# Unless required by applicable law or agreed to in writing, software
|
12
|
+
# distributed under the License is distributed on an "AS IS" BASIS,
|
13
|
+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
14
|
+
# See the License for the specific language governing permissions and
|
15
|
+
# limitations under the License.
|
16
|
+
|
17
|
+
# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
|
18
|
+
|
19
|
+
|
20
|
+
module Google
|
21
|
+
module Api
|
22
|
+
# A simple descriptor of a resource type.
|
23
|
+
#
|
24
|
+
# ResourceDescriptor annotates a resource message (either by means of a
|
25
|
+
# protobuf annotation or use in the service config), and associates the
|
26
|
+
# resource's schema, the resource type, and the pattern of the resource name.
|
27
|
+
#
|
28
|
+
# Example:
|
29
|
+
#
|
30
|
+
# message Topic {
|
31
|
+
# // Indicates this message defines a resource schema.
|
32
|
+
# // Declares the resource type in the format of {service}/{kind}.
|
33
|
+
# // For Kubernetes resources, the format is {api group}/{kind}.
|
34
|
+
# option (google.api.resource) = {
|
35
|
+
# type: "pubsub.googleapis.com/Topic"
|
36
|
+
# name_descriptor: {
|
37
|
+
# pattern: "projects/{project}/topics/{topic}"
|
38
|
+
# parent_type: "cloudresourcemanager.googleapis.com/Project"
|
39
|
+
# parent_name_extractor: "projects/{project}"
|
40
|
+
# }
|
41
|
+
# };
|
42
|
+
# }
|
43
|
+
#
|
44
|
+
# The ResourceDescriptor Yaml config will look like:
|
45
|
+
#
|
46
|
+
# resources:
|
47
|
+
# - type: "pubsub.googleapis.com/Topic"
|
48
|
+
# name_descriptor:
|
49
|
+
# - pattern: "projects/\\{project}/topics/\\{topic}"
|
50
|
+
# parent_type: "cloudresourcemanager.googleapis.com/Project"
|
51
|
+
# parent_name_extractor: "projects/\\{project}"
|
52
|
+
#
|
53
|
+
# Sometimes, resources have multiple patterns, typically because they can
|
54
|
+
# live under multiple parents.
|
55
|
+
#
|
56
|
+
# Example:
|
57
|
+
#
|
58
|
+
# message LogEntry {
|
59
|
+
# option (google.api.resource) = {
|
60
|
+
# type: "logging.googleapis.com/LogEntry"
|
61
|
+
# name_descriptor: {
|
62
|
+
# pattern: "projects/{project}/logs/{log}"
|
63
|
+
# parent_type: "cloudresourcemanager.googleapis.com/Project"
|
64
|
+
# parent_name_extractor: "projects/{project}"
|
65
|
+
# }
|
66
|
+
# name_descriptor: {
|
67
|
+
# pattern: "folders/{folder}/logs/{log}"
|
68
|
+
# parent_type: "cloudresourcemanager.googleapis.com/Folder"
|
69
|
+
# parent_name_extractor: "folders/{folder}"
|
70
|
+
# }
|
71
|
+
# name_descriptor: {
|
72
|
+
# pattern: "organizations/{organization}/logs/{log}"
|
73
|
+
# parent_type: "cloudresourcemanager.googleapis.com/Organization"
|
74
|
+
# parent_name_extractor: "organizations/{organization}"
|
75
|
+
# }
|
76
|
+
# name_descriptor: {
|
77
|
+
# pattern: "billingAccounts/{billing_account}/logs/{log}"
|
78
|
+
# parent_type: "billing.googleapis.com/BillingAccount"
|
79
|
+
# parent_name_extractor: "billingAccounts/{billing_account}"
|
80
|
+
# }
|
81
|
+
# };
|
82
|
+
# }
|
83
|
+
#
|
84
|
+
# The ResourceDescriptor Yaml config will look like:
|
85
|
+
#
|
86
|
+
# resources:
|
87
|
+
# - type: 'logging.googleapis.com/LogEntry'
|
88
|
+
# name_descriptor:
|
89
|
+
# - pattern: "projects/{project}/logs/{log}"
|
90
|
+
# parent_type: "cloudresourcemanager.googleapis.com/Project"
|
91
|
+
# parent_name_extractor: "projects/{project}"
|
92
|
+
# - pattern: "folders/{folder}/logs/{log}"
|
93
|
+
# parent_type: "cloudresourcemanager.googleapis.com/Folder"
|
94
|
+
# parent_name_extractor: "folders/{folder}"
|
95
|
+
# - pattern: "organizations/{organization}/logs/{log}"
|
96
|
+
# parent_type: "cloudresourcemanager.googleapis.com/Organization"
|
97
|
+
# parent_name_extractor: "organizations/{organization}"
|
98
|
+
# - pattern: "billingAccounts/{billing_account}/logs/{log}"
|
99
|
+
# parent_type: "billing.googleapis.com/BillingAccount"
|
100
|
+
# parent_name_extractor: "billingAccounts/{billing_account}"
|
101
|
+
#
|
102
|
+
# For flexible resources, the resource name doesn't contain parent names, but
|
103
|
+
# the resource itself has parents for policy evaluation.
|
104
|
+
#
|
105
|
+
# Example:
|
106
|
+
#
|
107
|
+
# message Shelf {
|
108
|
+
# option (google.api.resource) = {
|
109
|
+
# type: "library.googleapis.com/Shelf"
|
110
|
+
# name_descriptor: {
|
111
|
+
# pattern: "shelves/{shelf}"
|
112
|
+
# parent_type: "cloudresourcemanager.googleapis.com/Project"
|
113
|
+
# }
|
114
|
+
# name_descriptor: {
|
115
|
+
# pattern: "shelves/{shelf}"
|
116
|
+
# parent_type: "cloudresourcemanager.googleapis.com/Folder"
|
117
|
+
# }
|
118
|
+
# };
|
119
|
+
# }
|
120
|
+
#
|
121
|
+
# The ResourceDescriptor Yaml config will look like:
|
122
|
+
#
|
123
|
+
# resources:
|
124
|
+
# - type: 'library.googleapis.com/Shelf'
|
125
|
+
# name_descriptor:
|
126
|
+
# - pattern: "shelves/{shelf}"
|
127
|
+
# parent_type: "cloudresourcemanager.googleapis.com/Project"
|
128
|
+
# - pattern: "shelves/{shelf}"
|
129
|
+
# parent_type: "cloudresourcemanager.googleapis.com/Folder"
|
130
|
+
# @!attribute [rw] type
|
131
|
+
# @return [String]
|
132
|
+
# The resource type. It must be in the format of
|
133
|
+
# \\{service_name}/\\{resource_type_kind}. The `resource_type_kind` must be
|
134
|
+
# singular and must not include version numbers.
|
135
|
+
#
|
136
|
+
# Example: `storage.googleapis.com/Bucket`
|
137
|
+
#
|
138
|
+
# The value of the resource_type_kind must follow the regular expression
|
139
|
+
# /[A-Za-z][a-zA-Z0-9]+/. It should start with an upper case character and
|
140
|
+
# should use PascalCase (UpperCamelCase). The maximum number of
|
141
|
+
# characters allowed for the `resource_type_kind` is 100.
|
142
|
+
# @!attribute [rw] pattern
|
143
|
+
# @return [Array<String>]
|
144
|
+
# Optional. The relative resource name pattern associated with this resource
|
145
|
+
# type. The DNS prefix of the full resource name shouldn't be specified here.
|
146
|
+
#
|
147
|
+
# The path pattern must follow the syntax, which aligns with HTTP binding
|
148
|
+
# syntax:
|
149
|
+
#
|
150
|
+
# Template = Segment { "/" Segment } ;
|
151
|
+
# Segment = LITERAL | Variable ;
|
152
|
+
# Variable = "{" LITERAL "}" ;
|
153
|
+
#
|
154
|
+
# Examples:
|
155
|
+
#
|
156
|
+
# - "projects/\\{project}/topics/\\{topic}"
|
157
|
+
# - "projects/\\{project}/knowledgeBases/\\{knowledge_base}"
|
158
|
+
#
|
159
|
+
# The components in braces correspond to the IDs for each resource in the
|
160
|
+
# hierarchy. It is expected that, if multiple patterns are provided,
|
161
|
+
# the same component name (e.g. "project") refers to IDs of the same
|
162
|
+
# type of resource.
|
163
|
+
# @!attribute [rw] name_field
|
164
|
+
# @return [String]
|
165
|
+
# Optional. The field on the resource that designates the resource name
|
166
|
+
# field. If omitted, this is assumed to be "name".
|
167
|
+
# @!attribute [rw] history
|
168
|
+
# @return [Google::Api::ResourceDescriptor::History]
|
169
|
+
# Optional. The historical or future-looking state of the resource pattern.
|
170
|
+
#
|
171
|
+
# Example:
|
172
|
+
#
|
173
|
+
# // The InspectTemplate message originally only supported resource
|
174
|
+
# // names with organization, and project was added later.
|
175
|
+
# message InspectTemplate {
|
176
|
+
# option (google.api.resource) = {
|
177
|
+
# type: "dlp.googleapis.com/InspectTemplate"
|
178
|
+
# pattern:
|
179
|
+
# "organizations/{organization}/inspectTemplates/{inspect_template}"
|
180
|
+
# pattern: "projects/{project}/inspectTemplates/{inspect_template}"
|
181
|
+
# history: ORIGINALLY_SINGLE_PATTERN
|
182
|
+
# };
|
183
|
+
# }
|
184
|
+
# @!attribute [rw] plural
|
185
|
+
# @return [String]
|
186
|
+
# The plural name used in the resource name, such as 'projects' for
|
187
|
+
# the name of 'projects/\\{project}'. It is the same concept of the `plural`
|
188
|
+
# field in k8s CRD spec
|
189
|
+
# https://kubernetes.io/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions/
|
190
|
+
# @!attribute [rw] singular
|
191
|
+
# @return [String]
|
192
|
+
# The same concept of the `singular` field in k8s CRD spec
|
193
|
+
# https://kubernetes.io/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions/
|
194
|
+
# Such as "project" for the `resourcemanager.googleapis.com/Project` type.
|
195
|
+
class ResourceDescriptor
|
196
|
+
include Google::Protobuf::MessageExts
|
197
|
+
extend Google::Protobuf::MessageExts::ClassMethods
|
198
|
+
|
199
|
+
# A description of the historical or future-looking state of the
|
200
|
+
# resource pattern.
|
201
|
+
module History
|
202
|
+
# The "unset" value.
|
203
|
+
HISTORY_UNSPECIFIED = 0
|
204
|
+
|
205
|
+
# The resource originally had one pattern and launched as such, and
|
206
|
+
# additional patterns were added later.
|
207
|
+
ORIGINALLY_SINGLE_PATTERN = 1
|
208
|
+
|
209
|
+
# The resource has one pattern, but the API owner expects to add more
|
210
|
+
# later. (This is the inverse of ORIGINALLY_SINGLE_PATTERN, and prevents
|
211
|
+
# that from being necessary once there are multiple patterns.)
|
212
|
+
FUTURE_MULTI_PATTERN = 2
|
213
|
+
end
|
214
|
+
end
|
215
|
+
|
216
|
+
# Defines a proto annotation that describes a string field that refers to
|
217
|
+
# an API resource.
|
218
|
+
# @!attribute [rw] type
|
219
|
+
# @return [String]
|
220
|
+
# The resource type that the annotated field references.
|
221
|
+
#
|
222
|
+
# Example:
|
223
|
+
#
|
224
|
+
# message Subscription {
|
225
|
+
# string topic = 2 [(google.api.resource_reference) = {
|
226
|
+
# type: "pubsub.googleapis.com/Topic"
|
227
|
+
# }];
|
228
|
+
# }
|
229
|
+
# @!attribute [rw] child_type
|
230
|
+
# @return [String]
|
231
|
+
# The resource type of a child collection that the annotated field
|
232
|
+
# references. This is useful for annotating the `parent` field that
|
233
|
+
# doesn't have a fixed resource type.
|
234
|
+
#
|
235
|
+
# Example:
|
236
|
+
#
|
237
|
+
# message ListLogEntriesRequest {
|
238
|
+
# string parent = 1 [(google.api.resource_reference) = {
|
239
|
+
# child_type: "logging.googleapis.com/LogEntry"
|
240
|
+
# };
|
241
|
+
# }
|
242
|
+
class ResourceReference
|
243
|
+
include Google::Protobuf::MessageExts
|
244
|
+
extend Google::Protobuf::MessageExts::ClassMethods
|
245
|
+
end
|
246
|
+
end
|
247
|
+
end
|
@@ -0,0 +1,39 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
# Copyright 2020 Google LLC
|
4
|
+
#
|
5
|
+
# Licensed under the Apache License, Version 2.0 (the "License");
|
6
|
+
# you may not use this file except in compliance with the License.
|
7
|
+
# You may obtain a copy of the License at
|
8
|
+
#
|
9
|
+
# https://www.apache.org/licenses/LICENSE-2.0
|
10
|
+
#
|
11
|
+
# Unless required by applicable law or agreed to in writing, software
|
12
|
+
# distributed under the License is distributed on an "AS IS" BASIS,
|
13
|
+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
14
|
+
# See the License for the specific language governing permissions and
|
15
|
+
# limitations under the License.
|
16
|
+
|
17
|
+
# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
|
18
|
+
|
19
|
+
|
20
|
+
module Google
|
21
|
+
module Cloud
|
22
|
+
module DataCatalog
|
23
|
+
module V1
|
24
|
+
# This enum describes all the possible systems that Data Catalog integrates
|
25
|
+
# with.
|
26
|
+
module IntegratedSystem
|
27
|
+
# Default unknown system.
|
28
|
+
INTEGRATED_SYSTEM_UNSPECIFIED = 0
|
29
|
+
|
30
|
+
# BigQuery.
|
31
|
+
BIGQUERY = 1
|
32
|
+
|
33
|
+
# Cloud Pub/Sub.
|
34
|
+
CLOUD_PUBSUB = 2
|
35
|
+
end
|
36
|
+
end
|
37
|
+
end
|
38
|
+
end
|
39
|
+
end
|
@@ -0,0 +1,748 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
# Copyright 2020 Google LLC
|
4
|
+
#
|
5
|
+
# Licensed under the Apache License, Version 2.0 (the "License");
|
6
|
+
# you may not use this file except in compliance with the License.
|
7
|
+
# You may obtain a copy of the License at
|
8
|
+
#
|
9
|
+
# https://www.apache.org/licenses/LICENSE-2.0
|
10
|
+
#
|
11
|
+
# Unless required by applicable law or agreed to in writing, software
|
12
|
+
# distributed under the License is distributed on an "AS IS" BASIS,
|
13
|
+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
14
|
+
# See the License for the specific language governing permissions and
|
15
|
+
# limitations under the License.
|
16
|
+
|
17
|
+
# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
|
18
|
+
|
19
|
+
|
20
|
+
module Google
|
21
|
+
module Cloud
|
22
|
+
module DataCatalog
|
23
|
+
module V1
|
24
|
+
# Request message for
|
25
|
+
# {Google::Cloud::DataCatalog::V1::DataCatalog::Client#search_catalog SearchCatalog}.
|
26
|
+
# @!attribute [rw] scope
|
27
|
+
# @return [Google::Cloud::DataCatalog::V1::SearchCatalogRequest::Scope]
|
28
|
+
# Required. The scope of this search request. A `scope` that has empty
|
29
|
+
# `include_org_ids`, `include_project_ids` AND false
|
30
|
+
# `include_gcp_public_datasets` is considered invalid. Data Catalog will
|
31
|
+
# return an error in such a case.
|
32
|
+
# @!attribute [rw] query
|
33
|
+
# @return [String]
|
34
|
+
# Required. The query string in search query syntax. The query must be non-empty.
|
35
|
+
#
|
36
|
+
# Query strings can be simple as "x" or more qualified as:
|
37
|
+
#
|
38
|
+
# * name:x
|
39
|
+
# * column:x
|
40
|
+
# * description:y
|
41
|
+
#
|
42
|
+
# Note: Query tokens need to have a minimum of 3 characters for substring
|
43
|
+
# matching to work correctly. See [Data Catalog Search
|
44
|
+
# Syntax](/data-catalog/docs/how-to/search-reference) for more information.
|
45
|
+
# @!attribute [rw] page_size
|
46
|
+
# @return [Integer]
|
47
|
+
# Number of results in the search page. If <=0 then defaults to 10. Max limit
|
48
|
+
# for page_size is 1000. Throws an invalid argument for page_size > 1000.
|
49
|
+
# @!attribute [rw] page_token
|
50
|
+
# @return [String]
|
51
|
+
# Optional. Pagination token returned in an earlier
|
52
|
+
# {Google::Cloud::DataCatalog::V1::SearchCatalogResponse#next_page_token SearchCatalogResponse.next_page_token}, which
|
53
|
+
# indicates that this is a continuation of a prior
|
54
|
+
# {Google::Cloud::DataCatalog::V1::DataCatalog::Client#search_catalog SearchCatalogRequest}
|
55
|
+
# call, and that the system should return the next page of data. If empty,
|
56
|
+
# the first page is returned.
|
57
|
+
# @!attribute [rw] order_by
|
58
|
+
# @return [String]
|
59
|
+
# Specifies the ordering of results, currently supported case-sensitive
|
60
|
+
# choices are:
|
61
|
+
#
|
62
|
+
# * `relevance`, only supports descending
|
63
|
+
# * `last_modified_timestamp [asc|desc]`, defaults to descending if not
|
64
|
+
# specified
|
65
|
+
#
|
66
|
+
# If not specified, defaults to `relevance` descending.
|
67
|
+
class SearchCatalogRequest
|
68
|
+
include Google::Protobuf::MessageExts
|
69
|
+
extend Google::Protobuf::MessageExts::ClassMethods
|
70
|
+
|
71
|
+
# The criteria that select the subspace used for query matching.
|
72
|
+
# @!attribute [rw] include_org_ids
|
73
|
+
# @return [Array<String>]
|
74
|
+
# The list of organization IDs to search within. To find your organization
|
75
|
+
# ID, follow instructions in
|
76
|
+
# https://cloud.google.com/resource-manager/docs/creating-managing-organization.
|
77
|
+
# @!attribute [rw] include_project_ids
|
78
|
+
# @return [Array<String>]
|
79
|
+
# The list of project IDs to search within. To learn more about the
|
80
|
+
# distinction between project names/IDs/numbers, go to
|
81
|
+
# https://cloud.google.com/docs/overview/#projects.
|
82
|
+
# @!attribute [rw] include_gcp_public_datasets
|
83
|
+
# @return [Boolean]
|
84
|
+
# If `true`, include Google Cloud Platform (GCP) public datasets in the
|
85
|
+
# search results. Info on GCP public datasets is available at
|
86
|
+
# https://cloud.google.com/public-datasets/. By default, GCP public
|
87
|
+
# datasets are excluded.
|
88
|
+
class Scope
|
89
|
+
include Google::Protobuf::MessageExts
|
90
|
+
extend Google::Protobuf::MessageExts::ClassMethods
|
91
|
+
end
|
92
|
+
end
|
93
|
+
|
94
|
+
# Response message for
|
95
|
+
# {Google::Cloud::DataCatalog::V1::DataCatalog::Client#search_catalog SearchCatalog}.
|
96
|
+
# @!attribute [rw] results
|
97
|
+
# @return [Array<Google::Cloud::DataCatalog::V1::SearchCatalogResult>]
|
98
|
+
# Search results.
|
99
|
+
# @!attribute [rw] next_page_token
|
100
|
+
# @return [String]
|
101
|
+
# The token that can be used to retrieve the next page of results.
|
102
|
+
class SearchCatalogResponse
|
103
|
+
include Google::Protobuf::MessageExts
|
104
|
+
extend Google::Protobuf::MessageExts::ClassMethods
|
105
|
+
end
|
106
|
+
|
107
|
+
# Request message for
|
108
|
+
# {Google::Cloud::DataCatalog::V1::DataCatalog::Client#create_entry_group CreateEntryGroup}.
|
109
|
+
# @!attribute [rw] parent
|
110
|
+
# @return [String]
|
111
|
+
# Required. The name of the project this entry group is in. Example:
|
112
|
+
#
|
113
|
+
# * projects/\\{project_id}/locations/\\{location}
|
114
|
+
#
|
115
|
+
# Note that this EntryGroup and its child resources may not actually be
|
116
|
+
# stored in the location in this name.
|
117
|
+
# @!attribute [rw] entry_group_id
|
118
|
+
# @return [String]
|
119
|
+
# Required. The id of the entry group to create.
|
120
|
+
# The id must begin with a letter or underscore, contain only English
|
121
|
+
# letters, numbers and underscores, and be at most 64 characters.
|
122
|
+
# @!attribute [rw] entry_group
|
123
|
+
# @return [Google::Cloud::DataCatalog::V1::EntryGroup]
|
124
|
+
# The entry group to create. Defaults to an empty entry group.
|
125
|
+
class CreateEntryGroupRequest
|
126
|
+
include Google::Protobuf::MessageExts
|
127
|
+
extend Google::Protobuf::MessageExts::ClassMethods
|
128
|
+
end
|
129
|
+
|
130
|
+
# Request message for
|
131
|
+
# {Google::Cloud::DataCatalog::V1::DataCatalog::Client#update_entry_group UpdateEntryGroup}.
|
132
|
+
# @!attribute [rw] entry_group
|
133
|
+
# @return [Google::Cloud::DataCatalog::V1::EntryGroup]
|
134
|
+
# Required. The updated entry group. "name" field must be set.
|
135
|
+
# @!attribute [rw] update_mask
|
136
|
+
# @return [Google::Protobuf::FieldMask]
|
137
|
+
# The fields to update on the entry group. If absent or empty, all modifiable
|
138
|
+
# fields are updated.
|
139
|
+
class UpdateEntryGroupRequest
|
140
|
+
include Google::Protobuf::MessageExts
|
141
|
+
extend Google::Protobuf::MessageExts::ClassMethods
|
142
|
+
end
|
143
|
+
|
144
|
+
# Request message for
|
145
|
+
# {Google::Cloud::DataCatalog::V1::DataCatalog::Client#get_entry_group GetEntryGroup}.
|
146
|
+
# @!attribute [rw] name
|
147
|
+
# @return [String]
|
148
|
+
# Required. The name of the entry group. For example,
|
149
|
+
# `projects/{project_id}/locations/{location}/entryGroups/{entry_group_id}`.
|
150
|
+
# @!attribute [rw] read_mask
|
151
|
+
# @return [Google::Protobuf::FieldMask]
|
152
|
+
# The fields to return. If not set or empty, all fields are returned.
|
153
|
+
class GetEntryGroupRequest
|
154
|
+
include Google::Protobuf::MessageExts
|
155
|
+
extend Google::Protobuf::MessageExts::ClassMethods
|
156
|
+
end
|
157
|
+
|
158
|
+
# Request message for
|
159
|
+
# {Google::Cloud::DataCatalog::V1::DataCatalog::Client#delete_entry_group DeleteEntryGroup}.
|
160
|
+
# @!attribute [rw] name
|
161
|
+
# @return [String]
|
162
|
+
# Required. The name of the entry group. For example,
|
163
|
+
# `projects/{project_id}/locations/{location}/entryGroups/{entry_group_id}`.
|
164
|
+
# @!attribute [rw] force
|
165
|
+
# @return [Boolean]
|
166
|
+
# Optional. If true, deletes all entries in the entry group.
|
167
|
+
class DeleteEntryGroupRequest
|
168
|
+
include Google::Protobuf::MessageExts
|
169
|
+
extend Google::Protobuf::MessageExts::ClassMethods
|
170
|
+
end
|
171
|
+
|
172
|
+
# Request message for
|
173
|
+
# {Google::Cloud::DataCatalog::V1::DataCatalog::Client#list_entry_groups ListEntryGroups}.
|
174
|
+
# @!attribute [rw] parent
|
175
|
+
# @return [String]
|
176
|
+
# Required. The name of the location that contains the entry groups, which can be
|
177
|
+
# provided in URL format. Example:
|
178
|
+
#
|
179
|
+
# * projects/\\{project_id}/locations/\\{location}
|
180
|
+
# @!attribute [rw] page_size
|
181
|
+
# @return [Integer]
|
182
|
+
# Optional. The maximum number of items to return. Default is 10. Max limit is 1000.
|
183
|
+
# Throws an invalid argument for `page_size > 1000`.
|
184
|
+
# @!attribute [rw] page_token
|
185
|
+
# @return [String]
|
186
|
+
# Optional. Token that specifies which page is requested. If empty, the first page is
|
187
|
+
# returned.
|
188
|
+
class ListEntryGroupsRequest
|
189
|
+
include Google::Protobuf::MessageExts
|
190
|
+
extend Google::Protobuf::MessageExts::ClassMethods
|
191
|
+
end
|
192
|
+
|
193
|
+
# Response message for
|
194
|
+
# {Google::Cloud::DataCatalog::V1::DataCatalog::Client#list_entry_groups ListEntryGroups}.
|
195
|
+
# @!attribute [rw] entry_groups
|
196
|
+
# @return [Array<Google::Cloud::DataCatalog::V1::EntryGroup>]
|
197
|
+
# EntryGroup details.
|
198
|
+
# @!attribute [rw] next_page_token
|
199
|
+
# @return [String]
|
200
|
+
# Token to retrieve the next page of results. It is set to empty if no items
|
201
|
+
# remain in results.
|
202
|
+
class ListEntryGroupsResponse
|
203
|
+
include Google::Protobuf::MessageExts
|
204
|
+
extend Google::Protobuf::MessageExts::ClassMethods
|
205
|
+
end
|
206
|
+
|
207
|
+
# Request message for
|
208
|
+
# {Google::Cloud::DataCatalog::V1::DataCatalog::Client#create_entry CreateEntry}.
|
209
|
+
# @!attribute [rw] parent
|
210
|
+
# @return [String]
|
211
|
+
# Required. The name of the entry group this entry is in. Example:
|
212
|
+
#
|
213
|
+
# * projects/\\{project_id}/locations/\\{location}/entryGroups/\\{entry_group_id}
|
214
|
+
#
|
215
|
+
# Note that this Entry and its child resources may not actually be stored in
|
216
|
+
# the location in this name.
|
217
|
+
# @!attribute [rw] entry_id
|
218
|
+
# @return [String]
|
219
|
+
# Required. The id of the entry to create.
|
220
|
+
# @!attribute [rw] entry
|
221
|
+
# @return [Google::Cloud::DataCatalog::V1::Entry]
|
222
|
+
# Required. The entry to create.
|
223
|
+
class CreateEntryRequest
|
224
|
+
include Google::Protobuf::MessageExts
|
225
|
+
extend Google::Protobuf::MessageExts::ClassMethods
|
226
|
+
end
|
227
|
+
|
228
|
+
# Request message for
|
229
|
+
# {Google::Cloud::DataCatalog::V1::DataCatalog::Client#update_entry UpdateEntry}.
|
230
|
+
# @!attribute [rw] entry
|
231
|
+
# @return [Google::Cloud::DataCatalog::V1::Entry]
|
232
|
+
# Required. The updated entry. The "name" field must be set.
|
233
|
+
# @!attribute [rw] update_mask
|
234
|
+
# @return [Google::Protobuf::FieldMask]
|
235
|
+
# The fields to update on the entry. If absent or empty, all modifiable
|
236
|
+
# fields are updated.
|
237
|
+
#
|
238
|
+
# The following fields are modifiable:
|
239
|
+
# * For entries with type `DATA_STREAM`:
|
240
|
+
# * `schema`
|
241
|
+
# * For entries with type `FILESET`
|
242
|
+
# * `schema`
|
243
|
+
# * `display_name`
|
244
|
+
# * `description`
|
245
|
+
# * `gcs_fileset_spec`
|
246
|
+
# * `gcs_fileset_spec.file_patterns`
|
247
|
+
# * For entries with `user_specified_type`
|
248
|
+
# * `schema`
|
249
|
+
# * `display_name`
|
250
|
+
# * `description`
|
251
|
+
# * user_specified_type
|
252
|
+
# * user_specified_system
|
253
|
+
# * linked_resource
|
254
|
+
# * source_system_timestamps
|
255
|
+
class UpdateEntryRequest
|
256
|
+
include Google::Protobuf::MessageExts
|
257
|
+
extend Google::Protobuf::MessageExts::ClassMethods
|
258
|
+
end
|
259
|
+
|
260
|
+
# Request message for
|
261
|
+
# {Google::Cloud::DataCatalog::V1::DataCatalog::Client#delete_entry DeleteEntry}.
|
262
|
+
# @!attribute [rw] name
|
263
|
+
# @return [String]
|
264
|
+
# Required. The name of the entry. Example:
|
265
|
+
#
|
266
|
+
# * projects/\\{project_id}/locations/\\{location}/entryGroups/\\{entry_group_id}/entries/\\{entry_id}
|
267
|
+
class DeleteEntryRequest
|
268
|
+
include Google::Protobuf::MessageExts
|
269
|
+
extend Google::Protobuf::MessageExts::ClassMethods
|
270
|
+
end
|
271
|
+
|
272
|
+
# Request message for
|
273
|
+
# {Google::Cloud::DataCatalog::V1::DataCatalog::Client#get_entry GetEntry}.
|
274
|
+
# @!attribute [rw] name
|
275
|
+
# @return [String]
|
276
|
+
# Required. The name of the entry. Example:
|
277
|
+
#
|
278
|
+
# * projects/\\{project_id}/locations/\\{location}/entryGroups/\\{entry_group_id}/entries/\\{entry_id}
|
279
|
+
class GetEntryRequest
|
280
|
+
include Google::Protobuf::MessageExts
|
281
|
+
extend Google::Protobuf::MessageExts::ClassMethods
|
282
|
+
end
|
283
|
+
|
284
|
+
# Request message for
|
285
|
+
# {Google::Cloud::DataCatalog::V1::DataCatalog::Client#lookup_entry LookupEntry}.
|
286
|
+
# @!attribute [rw] linked_resource
|
287
|
+
# @return [String]
|
288
|
+
# The full name of the Google Cloud Platform resource the Data Catalog
|
289
|
+
# entry represents. See:
|
290
|
+
# https://cloud.google.com/apis/design/resource_names#full_resource_name.
|
291
|
+
# Full names are case-sensitive.
|
292
|
+
#
|
293
|
+
# Examples:
|
294
|
+
#
|
295
|
+
# * //bigquery.googleapis.com/projects/projectId/datasets/datasetId/tables/tableId
|
296
|
+
# * //pubsub.googleapis.com/projects/projectId/topics/topicId
|
297
|
+
# @!attribute [rw] sql_resource
|
298
|
+
# @return [String]
|
299
|
+
# The SQL name of the entry. SQL names are case-sensitive.
|
300
|
+
#
|
301
|
+
# Examples:
|
302
|
+
#
|
303
|
+
# * `cloud_pubsub.project_id.topic_id`
|
304
|
+
# * ``pubsub.project_id.`topic.id.with.dots` ``
|
305
|
+
# * `bigquery.table.project_id.dataset_id.table_id`
|
306
|
+
# * `bigquery.dataset.project_id.dataset_id`
|
307
|
+
# * `datacatalog.entry.project_id.location_id.entry_group_id.entry_id`
|
308
|
+
#
|
309
|
+
# `*_id`s shoud satisfy the standard SQL rules for identifiers.
|
310
|
+
# https://cloud.google.com/bigquery/docs/reference/standard-sql/lexical.
|
311
|
+
class LookupEntryRequest
|
312
|
+
include Google::Protobuf::MessageExts
|
313
|
+
extend Google::Protobuf::MessageExts::ClassMethods
|
314
|
+
end
|
315
|
+
|
316
|
+
# Entry Metadata.
|
317
|
+
# A Data Catalog Entry resource represents another resource in Google
|
318
|
+
# Cloud Platform (such as a BigQuery dataset or a Pub/Sub topic) or
|
319
|
+
# outside of Google Cloud Platform. Clients can use the `linked_resource` field
|
320
|
+
# in the Entry resource to refer to the original resource ID of the source
|
321
|
+
# system.
|
322
|
+
#
|
323
|
+
# An Entry resource contains resource details, such as its schema. An Entry can
|
324
|
+
# also be used to attach flexible metadata, such as a
|
325
|
+
# {Google::Cloud::DataCatalog::V1::Tag Tag}.
|
326
|
+
# @!attribute [rw] name
|
327
|
+
# @return [String]
|
328
|
+
# The Data Catalog resource name of the entry in URL format. Example:
|
329
|
+
#
|
330
|
+
# * projects/\\{project_id}/locations/\\{location}/entryGroups/\\{entry_group_id}/entries/\\{entry_id}
|
331
|
+
#
|
332
|
+
# Note that this Entry and its child resources may not actually be stored in
|
333
|
+
# the location in this name.
|
334
|
+
# @!attribute [rw] linked_resource
|
335
|
+
# @return [String]
|
336
|
+
# The resource this metadata entry refers to.
|
337
|
+
#
|
338
|
+
# For Google Cloud Platform resources, `linked_resource` is the [full name of
|
339
|
+
# the
|
340
|
+
# resource](https://cloud.google.com/apis/design/resource_names#full_resource_name).
|
341
|
+
# For example, the `linked_resource` for a table resource from BigQuery is:
|
342
|
+
#
|
343
|
+
# * //bigquery.googleapis.com/projects/projectId/datasets/datasetId/tables/tableId
|
344
|
+
#
|
345
|
+
# Output only when Entry is of type in the EntryType enum. For entries with
|
346
|
+
# user_specified_type, this field is optional and defaults to an empty
|
347
|
+
# string.
|
348
|
+
# @!attribute [rw] type
|
349
|
+
# @return [Google::Cloud::DataCatalog::V1::EntryType]
|
350
|
+
# The type of the entry.
|
351
|
+
# Only used for Entries with types in the EntryType enum.
|
352
|
+
# @!attribute [rw] user_specified_type
|
353
|
+
# @return [String]
|
354
|
+
# Entry type if it does not fit any of the input-allowed values listed in
|
355
|
+
# `EntryType` enum above. When creating an entry, users should check the
|
356
|
+
# enum values first, if nothing matches the entry to be created, then
|
357
|
+
# provide a custom value, for example "my_special_type".
|
358
|
+
# `user_specified_type` strings must begin with a letter or underscore and
|
359
|
+
# can only contain letters, numbers, and underscores; are case insensitive;
|
360
|
+
# must be at least 1 character and at most 64 characters long.
|
361
|
+
#
|
362
|
+
# Currently, only FILESET enum value is allowed. All other entries created
|
363
|
+
# through Data Catalog must use `user_specified_type`.
|
364
|
+
# @!attribute [r] integrated_system
|
365
|
+
# @return [Google::Cloud::DataCatalog::V1::IntegratedSystem]
|
366
|
+
# Output only. This field indicates the entry's source system that Data Catalog
|
367
|
+
# integrates with, such as BigQuery or Pub/Sub.
|
368
|
+
# @!attribute [rw] user_specified_system
|
369
|
+
# @return [String]
|
370
|
+
# This field indicates the entry's source system that Data Catalog does not
|
371
|
+
# integrate with. `user_specified_system` strings must begin with a letter
|
372
|
+
# or underscore and can only contain letters, numbers, and underscores; are
|
373
|
+
# case insensitive; must be at least 1 character and at most 64 characters
|
374
|
+
# long.
|
375
|
+
# @!attribute [rw] gcs_fileset_spec
|
376
|
+
# @return [Google::Cloud::DataCatalog::V1::GcsFilesetSpec]
|
377
|
+
# Specification that applies to a Cloud Storage fileset. This is only valid
|
378
|
+
# on entries of type FILESET.
|
379
|
+
# @!attribute [rw] bigquery_table_spec
|
380
|
+
# @return [Google::Cloud::DataCatalog::V1::BigQueryTableSpec]
|
381
|
+
# Specification that applies to a BigQuery table. This is only valid on
|
382
|
+
# entries of type `TABLE`.
|
383
|
+
# @!attribute [rw] bigquery_date_sharded_spec
|
384
|
+
# @return [Google::Cloud::DataCatalog::V1::BigQueryDateShardedSpec]
|
385
|
+
# Specification for a group of BigQuery tables with name pattern
|
386
|
+
# `[prefix]YYYYMMDD`. Context:
|
387
|
+
# https://cloud.google.com/bigquery/docs/partitioned-tables#partitioning_versus_sharding.
|
388
|
+
# @!attribute [rw] display_name
|
389
|
+
# @return [String]
|
390
|
+
# Display information such as title and description. A short name to identify
|
391
|
+
# the entry, for example, "Analytics Data - Jan 2011". Default value is an
|
392
|
+
# empty string.
|
393
|
+
# @!attribute [rw] description
|
394
|
+
# @return [String]
|
395
|
+
# Entry description, which can consist of several sentences or paragraphs
|
396
|
+
# that describe entry contents. Default value is an empty string.
|
397
|
+
# @!attribute [rw] schema
|
398
|
+
# @return [Google::Cloud::DataCatalog::V1::Schema]
|
399
|
+
# Schema of the entry. An entry might not have any schema attached to it.
|
400
|
+
# @!attribute [rw] source_system_timestamps
|
401
|
+
# @return [Google::Cloud::DataCatalog::V1::SystemTimestamps]
|
402
|
+
# Timestamps about the underlying resource, not about this Data Catalog
|
403
|
+
# entry. Output only when Entry is of type in the EntryType enum. For entries
|
404
|
+
# with user_specified_type, this field is optional and defaults to an empty
|
405
|
+
# timestamp.
|
406
|
+
class Entry
|
407
|
+
include Google::Protobuf::MessageExts
|
408
|
+
extend Google::Protobuf::MessageExts::ClassMethods
|
409
|
+
end
|
410
|
+
|
411
|
+
# EntryGroup Metadata.
|
412
|
+
# An EntryGroup resource represents a logical grouping of zero or more
|
413
|
+
# Data Catalog {Google::Cloud::DataCatalog::V1::Entry Entry} resources.
|
414
|
+
# @!attribute [rw] name
|
415
|
+
# @return [String]
|
416
|
+
# The resource name of the entry group in URL format. Example:
|
417
|
+
#
|
418
|
+
# * projects/\\{project_id}/locations/\\{location}/entryGroups/\\{entry_group_id}
|
419
|
+
#
|
420
|
+
# Note that this EntryGroup and its child resources may not actually be
|
421
|
+
# stored in the location in this name.
|
422
|
+
# @!attribute [rw] display_name
|
423
|
+
# @return [String]
|
424
|
+
# A short name to identify the entry group, for example,
|
425
|
+
# "analytics data - jan 2011". Default value is an empty string.
|
426
|
+
# @!attribute [rw] description
|
427
|
+
# @return [String]
|
428
|
+
# Entry group description, which can consist of several sentences or
|
429
|
+
# paragraphs that describe entry group contents. Default value is an empty
|
430
|
+
# string.
|
431
|
+
# @!attribute [r] data_catalog_timestamps
|
432
|
+
# @return [Google::Cloud::DataCatalog::V1::SystemTimestamps]
|
433
|
+
# Output only. Timestamps about this EntryGroup. Default value is empty timestamps.
|
434
|
+
class EntryGroup
|
435
|
+
include Google::Protobuf::MessageExts
|
436
|
+
extend Google::Protobuf::MessageExts::ClassMethods
|
437
|
+
end
|
438
|
+
|
439
|
+
# Request message for
|
440
|
+
# {Google::Cloud::DataCatalog::V1::DataCatalog::Client#create_tag_template CreateTagTemplate}.
|
441
|
+
# @!attribute [rw] parent
|
442
|
+
# @return [String]
|
443
|
+
# Required. The name of the project and the template location
|
444
|
+
# [region](/compute/docs/regions-zones/#available).
|
445
|
+
# NOTE: Currently, only the `us-central1 region` is supported.
|
446
|
+
#
|
447
|
+
# Example:
|
448
|
+
#
|
449
|
+
# * projects/\\{project_id}/locations/us-central1
|
450
|
+
# @!attribute [rw] tag_template_id
|
451
|
+
# @return [String]
|
452
|
+
# Required. The id of the tag template to create.
|
453
|
+
# @!attribute [rw] tag_template
|
454
|
+
# @return [Google::Cloud::DataCatalog::V1::TagTemplate]
|
455
|
+
# Required. The tag template to create.
|
456
|
+
class CreateTagTemplateRequest
|
457
|
+
include Google::Protobuf::MessageExts
|
458
|
+
extend Google::Protobuf::MessageExts::ClassMethods
|
459
|
+
end
|
460
|
+
|
461
|
+
# Request message for
|
462
|
+
# {Google::Cloud::DataCatalog::V1::DataCatalog::Client#get_tag_template GetTagTemplate}.
|
463
|
+
# @!attribute [rw] name
|
464
|
+
# @return [String]
|
465
|
+
# Required. The name of the tag template. Example:
|
466
|
+
#
|
467
|
+
# * projects/\\{project_id}/locations/\\{location}/tagTemplates/\\{tag_template_id}
|
468
|
+
class GetTagTemplateRequest
|
469
|
+
include Google::Protobuf::MessageExts
|
470
|
+
extend Google::Protobuf::MessageExts::ClassMethods
|
471
|
+
end
|
472
|
+
|
473
|
+
# Request message for
|
474
|
+
# {Google::Cloud::DataCatalog::V1::DataCatalog::Client#update_tag_template UpdateTagTemplate}.
|
475
|
+
# @!attribute [rw] tag_template
|
476
|
+
# @return [Google::Cloud::DataCatalog::V1::TagTemplate]
|
477
|
+
# Required. The template to update. The "name" field must be set.
|
478
|
+
# @!attribute [rw] update_mask
|
479
|
+
# @return [Google::Protobuf::FieldMask]
|
480
|
+
# The field mask specifies the parts of the template to overwrite.
|
481
|
+
#
|
482
|
+
# Allowed fields:
|
483
|
+
#
|
484
|
+
# * `display_name`
|
485
|
+
#
|
486
|
+
# If absent or empty, all of the allowed fields above will be updated.
|
487
|
+
class UpdateTagTemplateRequest
|
488
|
+
include Google::Protobuf::MessageExts
|
489
|
+
extend Google::Protobuf::MessageExts::ClassMethods
|
490
|
+
end
|
491
|
+
|
492
|
+
# Request message for
|
493
|
+
# {Google::Cloud::DataCatalog::V1::DataCatalog::Client#delete_tag_template DeleteTagTemplate}.
|
494
|
+
# @!attribute [rw] name
|
495
|
+
# @return [String]
|
496
|
+
# Required. The name of the tag template to delete. Example:
|
497
|
+
#
|
498
|
+
# * projects/\\{project_id}/locations/\\{location}/tagTemplates/\\{tag_template_id}
|
499
|
+
# @!attribute [rw] force
|
500
|
+
# @return [Boolean]
|
501
|
+
# Required. Currently, this field must always be set to `true`.
|
502
|
+
# This confirms the deletion of any possible tags using this template.
|
503
|
+
# `force = false` will be supported in the future.
|
504
|
+
class DeleteTagTemplateRequest
|
505
|
+
include Google::Protobuf::MessageExts
|
506
|
+
extend Google::Protobuf::MessageExts::ClassMethods
|
507
|
+
end
|
508
|
+
|
509
|
+
# Request message for
|
510
|
+
# {Google::Cloud::DataCatalog::V1::DataCatalog::Client#create_tag CreateTag}.
|
511
|
+
# @!attribute [rw] parent
|
512
|
+
# @return [String]
|
513
|
+
# Required. The name of the resource to attach this tag to. Tags can be attached to
|
514
|
+
# Entries. Example:
|
515
|
+
#
|
516
|
+
# * projects/\\{project_id}/locations/\\{location}/entryGroups/\\{entry_group_id}/entries/\\{entry_id}
|
517
|
+
#
|
518
|
+
# Note that this Tag and its child resources may not actually be stored in
|
519
|
+
# the location in this name.
|
520
|
+
# @!attribute [rw] tag
|
521
|
+
# @return [Google::Cloud::DataCatalog::V1::Tag]
|
522
|
+
# Required. The tag to create.
|
523
|
+
class CreateTagRequest
|
524
|
+
include Google::Protobuf::MessageExts
|
525
|
+
extend Google::Protobuf::MessageExts::ClassMethods
|
526
|
+
end
|
527
|
+
|
528
|
+
# Request message for
|
529
|
+
# {Google::Cloud::DataCatalog::V1::DataCatalog::Client#update_tag UpdateTag}.
|
530
|
+
# @!attribute [rw] tag
|
531
|
+
# @return [Google::Cloud::DataCatalog::V1::Tag]
|
532
|
+
# Required. The updated tag. The "name" field must be set.
|
533
|
+
# @!attribute [rw] update_mask
|
534
|
+
# @return [Google::Protobuf::FieldMask]
|
535
|
+
# The fields to update on the Tag. If absent or empty, all modifiable fields
|
536
|
+
# are updated. Currently the only modifiable field is the field `fields`.
|
537
|
+
class UpdateTagRequest
|
538
|
+
include Google::Protobuf::MessageExts
|
539
|
+
extend Google::Protobuf::MessageExts::ClassMethods
|
540
|
+
end
|
541
|
+
|
542
|
+
# Request message for
|
543
|
+
# {Google::Cloud::DataCatalog::V1::DataCatalog::Client#delete_tag DeleteTag}.
|
544
|
+
# @!attribute [rw] name
|
545
|
+
# @return [String]
|
546
|
+
# Required. The name of the tag to delete. Example:
|
547
|
+
#
|
548
|
+
# * projects/\\{project_id}/locations/\\{location}/entryGroups/\\{entry_group_id}/entries/\\{entry_id}/tags/\\{tag_id}
|
549
|
+
class DeleteTagRequest
|
550
|
+
include Google::Protobuf::MessageExts
|
551
|
+
extend Google::Protobuf::MessageExts::ClassMethods
|
552
|
+
end
|
553
|
+
|
554
|
+
# Request message for
|
555
|
+
# {Google::Cloud::DataCatalog::V1::DataCatalog::Client#create_tag_template_field CreateTagTemplateField}.
|
556
|
+
# @!attribute [rw] parent
|
557
|
+
# @return [String]
|
558
|
+
# Required. The name of the project and the template location
|
559
|
+
# [region](/compute/docs/regions-zones/#available).
|
560
|
+
# NOTE: Currently, only the `us-central1 region` is supported.
|
561
|
+
#
|
562
|
+
# Example:
|
563
|
+
#
|
564
|
+
# * projects/\\{project_id}/locations/us-central1/tagTemplates/\\{tag_template_id}
|
565
|
+
# @!attribute [rw] tag_template_field_id
|
566
|
+
# @return [String]
|
567
|
+
# Required. The ID of the tag template field to create.
|
568
|
+
# Field ids can contain letters (both uppercase and lowercase), numbers
|
569
|
+
# (0-9), underscores (_) and dashes (-). Field IDs must be at least 1
|
570
|
+
# character long and at most 128 characters long. Field IDs must also be
|
571
|
+
# unique within their template.
|
572
|
+
# @!attribute [rw] tag_template_field
|
573
|
+
# @return [Google::Cloud::DataCatalog::V1::TagTemplateField]
|
574
|
+
# Required. The tag template field to create.
|
575
|
+
class CreateTagTemplateFieldRequest
|
576
|
+
include Google::Protobuf::MessageExts
|
577
|
+
extend Google::Protobuf::MessageExts::ClassMethods
|
578
|
+
end
|
579
|
+
|
580
|
+
# Request message for
|
581
|
+
# {Google::Cloud::DataCatalog::V1::DataCatalog::Client#update_tag_template_field UpdateTagTemplateField}.
|
582
|
+
# @!attribute [rw] name
|
583
|
+
# @return [String]
|
584
|
+
# Required. The name of the tag template field. Example:
|
585
|
+
#
|
586
|
+
# * projects/\\{project_id}/locations/\\{location}/tagTemplates/\\{tag_template_id}/fields/\\{tag_template_field_id}
|
587
|
+
# @!attribute [rw] tag_template_field
|
588
|
+
# @return [Google::Cloud::DataCatalog::V1::TagTemplateField]
|
589
|
+
# Required. The template to update.
|
590
|
+
# @!attribute [rw] update_mask
|
591
|
+
# @return [Google::Protobuf::FieldMask]
|
592
|
+
# Optional. The field mask specifies the parts of the template to be updated.
|
593
|
+
# Allowed fields:
|
594
|
+
#
|
595
|
+
# * `display_name`
|
596
|
+
# * `type.enum_type`
|
597
|
+
# * `is_required`
|
598
|
+
#
|
599
|
+
# If `update_mask` is not set or empty, all of the allowed fields above will
|
600
|
+
# be updated.
|
601
|
+
#
|
602
|
+
# When updating an enum type, the provided values will be merged with the
|
603
|
+
# existing values. Therefore, enum values can only be added, existing enum
|
604
|
+
# values cannot be deleted nor renamed. Updating a template field from
|
605
|
+
# optional to required is NOT allowed.
|
606
|
+
class UpdateTagTemplateFieldRequest
|
607
|
+
include Google::Protobuf::MessageExts
|
608
|
+
extend Google::Protobuf::MessageExts::ClassMethods
|
609
|
+
end
|
610
|
+
|
611
|
+
# Request message for
|
612
|
+
# {Google::Cloud::DataCatalog::V1::DataCatalog::Client#rename_tag_template_field RenameTagTemplateField}.
|
613
|
+
# @!attribute [rw] name
|
614
|
+
# @return [String]
|
615
|
+
# Required. The name of the tag template. Example:
|
616
|
+
#
|
617
|
+
# * projects/\\{project_id}/locations/\\{location}/tagTemplates/\\{tag_template_id}/fields/\\{tag_template_field_id}
|
618
|
+
# @!attribute [rw] new_tag_template_field_id
|
619
|
+
# @return [String]
|
620
|
+
# Required. The new ID of this tag template field. For example, `my_new_field`.
|
621
|
+
class RenameTagTemplateFieldRequest
|
622
|
+
include Google::Protobuf::MessageExts
|
623
|
+
extend Google::Protobuf::MessageExts::ClassMethods
|
624
|
+
end
|
625
|
+
|
626
|
+
# Request message for
|
627
|
+
# {Google::Cloud::DataCatalog::V1::DataCatalog::Client#delete_tag_template_field DeleteTagTemplateField}.
|
628
|
+
# @!attribute [rw] name
|
629
|
+
# @return [String]
|
630
|
+
# Required. The name of the tag template field to delete. Example:
|
631
|
+
#
|
632
|
+
# * projects/\\{project_id}/locations/\\{location}/tagTemplates/\\{tag_template_id}/fields/\\{tag_template_field_id}
|
633
|
+
# @!attribute [rw] force
|
634
|
+
# @return [Boolean]
|
635
|
+
# Required. Currently, this field must always be set to `true`.
|
636
|
+
# This confirms the deletion of this field from any tags using this field.
|
637
|
+
# `force = false` will be supported in the future.
|
638
|
+
class DeleteTagTemplateFieldRequest
|
639
|
+
include Google::Protobuf::MessageExts
|
640
|
+
extend Google::Protobuf::MessageExts::ClassMethods
|
641
|
+
end
|
642
|
+
|
643
|
+
# Request message for
|
644
|
+
# {Google::Cloud::DataCatalog::V1::DataCatalog::Client#list_tags ListTags}.
|
645
|
+
# @!attribute [rw] parent
|
646
|
+
# @return [String]
|
647
|
+
# Required. The name of the Data Catalog resource to list the tags of. The resource
|
648
|
+
# could be an {Google::Cloud::DataCatalog::V1::Entry Entry} or an
|
649
|
+
# {Google::Cloud::DataCatalog::V1::EntryGroup EntryGroup}.
|
650
|
+
#
|
651
|
+
# Examples:
|
652
|
+
#
|
653
|
+
# * projects/\\{project_id}/locations/\\{location}/entryGroups/\\{entry_group_id}
|
654
|
+
# * projects/\\{project_id}/locations/\\{location}/entryGroups/\\{entry_group_id}/entries/\\{entry_id}
|
655
|
+
# @!attribute [rw] page_size
|
656
|
+
# @return [Integer]
|
657
|
+
# The maximum number of tags to return. Default is 10. Max limit is 1000.
|
658
|
+
# @!attribute [rw] page_token
|
659
|
+
# @return [String]
|
660
|
+
# Token that specifies which page is requested. If empty, the first page is
|
661
|
+
# returned.
|
662
|
+
class ListTagsRequest
|
663
|
+
include Google::Protobuf::MessageExts
|
664
|
+
extend Google::Protobuf::MessageExts::ClassMethods
|
665
|
+
end
|
666
|
+
|
667
|
+
# Response message for
|
668
|
+
# {Google::Cloud::DataCatalog::V1::DataCatalog::Client#list_tags ListTags}.
|
669
|
+
# @!attribute [rw] tags
|
670
|
+
# @return [Array<Google::Cloud::DataCatalog::V1::Tag>]
|
671
|
+
# {Google::Cloud::DataCatalog::V1::Tag Tag} details.
|
672
|
+
# @!attribute [rw] next_page_token
|
673
|
+
# @return [String]
|
674
|
+
# Token to retrieve the next page of results. It is set to empty if no items
|
675
|
+
# remain in results.
|
676
|
+
class ListTagsResponse
|
677
|
+
include Google::Protobuf::MessageExts
|
678
|
+
extend Google::Protobuf::MessageExts::ClassMethods
|
679
|
+
end
|
680
|
+
|
681
|
+
# Request message for
|
682
|
+
# {Google::Cloud::DataCatalog::V1::DataCatalog::Client#list_entries ListEntries}.
|
683
|
+
# @!attribute [rw] parent
|
684
|
+
# @return [String]
|
685
|
+
# Required. The name of the entry group that contains the entries, which can
|
686
|
+
# be provided in URL format. Example:
|
687
|
+
#
|
688
|
+
# * projects/\\{project_id}/locations/\\{location}/entryGroups/\\{entry_group_id}
|
689
|
+
# @!attribute [rw] page_size
|
690
|
+
# @return [Integer]
|
691
|
+
# The maximum number of items to return. Default is 10. Max limit is 1000.
|
692
|
+
# Throws an invalid argument for `page_size > 1000`.
|
693
|
+
# @!attribute [rw] page_token
|
694
|
+
# @return [String]
|
695
|
+
# Token that specifies which page is requested. If empty, the first page is
|
696
|
+
# returned.
|
697
|
+
# @!attribute [rw] read_mask
|
698
|
+
# @return [Google::Protobuf::FieldMask]
|
699
|
+
# The fields to return for each Entry. If not set or empty, all
|
700
|
+
# fields are returned.
|
701
|
+
# For example, setting read_mask to contain only one path "name" will cause
|
702
|
+
# ListEntries to return a list of Entries with only "name" field.
|
703
|
+
class ListEntriesRequest
|
704
|
+
include Google::Protobuf::MessageExts
|
705
|
+
extend Google::Protobuf::MessageExts::ClassMethods
|
706
|
+
end
|
707
|
+
|
708
|
+
# Response message for
|
709
|
+
# {Google::Cloud::DataCatalog::V1::DataCatalog::Client#list_entries ListEntries}.
|
710
|
+
# @!attribute [rw] entries
|
711
|
+
# @return [Array<Google::Cloud::DataCatalog::V1::Entry>]
|
712
|
+
# Entry details.
|
713
|
+
# @!attribute [rw] next_page_token
|
714
|
+
# @return [String]
|
715
|
+
# Token to retrieve the next page of results. It is set to empty if no items
|
716
|
+
# remain in results.
|
717
|
+
class ListEntriesResponse
|
718
|
+
include Google::Protobuf::MessageExts
|
719
|
+
extend Google::Protobuf::MessageExts::ClassMethods
|
720
|
+
end
|
721
|
+
|
722
|
+
# Entry resources in Data Catalog can be of different types e.g. a BigQuery
|
723
|
+
# Table entry is of type `TABLE`. This enum describes all the possible types
|
724
|
+
# Data Catalog contains.
|
725
|
+
module EntryType
|
726
|
+
# Default unknown type.
|
727
|
+
ENTRY_TYPE_UNSPECIFIED = 0
|
728
|
+
|
729
|
+
# Output only. The type of entry that has a GoogleSQL schema, including
|
730
|
+
# logical views.
|
731
|
+
TABLE = 2
|
732
|
+
|
733
|
+
# Output only. The type of models, examples include
|
734
|
+
# https://cloud.google.com/bigquery-ml/docs/bigqueryml-intro
|
735
|
+
MODEL = 5
|
736
|
+
|
737
|
+
# Output only. An entry type which is used for streaming entries. Example:
|
738
|
+
# Pub/Sub topic.
|
739
|
+
DATA_STREAM = 3
|
740
|
+
|
741
|
+
# An entry type which is a set of files or objects. Example:
|
742
|
+
# Cloud Storage fileset.
|
743
|
+
FILESET = 4
|
744
|
+
end
|
745
|
+
end
|
746
|
+
end
|
747
|
+
end
|
748
|
+
end
|