google-cloud-data_catalog-v1 0.3.0 → 0.3.1
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 +4 -4
- data/AUTHENTICATION.md +6 -6
- data/README.md +1 -1
- data/lib/google/cloud/data_catalog/v1.rb +1 -1
- data/lib/google/cloud/data_catalog/v1/data_catalog.rb +1 -1
- data/lib/google/cloud/data_catalog/v1/data_catalog/client.rb +514 -514
- data/lib/google/cloud/data_catalog/v1/data_catalog/credentials.rb +1 -1
- data/lib/google/cloud/data_catalog/v1/data_catalog/paths.rb +21 -21
- data/lib/google/cloud/data_catalog/v1/version.rb +1 -1
- data/proto_docs/google/api/resource.rb +12 -12
- data/proto_docs/google/cloud/datacatalog/v1/datacatalog.rb +183 -183
- data/proto_docs/google/cloud/datacatalog/v1/gcs_fileset_spec.rb +9 -9
- data/proto_docs/google/cloud/datacatalog/v1/schema.rb +10 -10
- data/proto_docs/google/cloud/datacatalog/v1/search.rb +11 -11
- data/proto_docs/google/cloud/datacatalog/v1/table_spec.rb +16 -16
- data/proto_docs/google/cloud/datacatalog/v1/tags.rb +51 -51
- data/proto_docs/google/cloud/datacatalog/v1/timestamps.rb +5 -5
- data/proto_docs/google/iam/v1/iam_policy.rb +15 -15
- data/proto_docs/google/iam/v1/options.rb +3 -3
- data/proto_docs/google/iam/v1/policy.rb +26 -26
- data/proto_docs/google/protobuf/empty.rb +2 -2
- data/proto_docs/google/protobuf/field_mask.rb +3 -3
- data/proto_docs/google/protobuf/timestamp.rb +4 -4
- data/proto_docs/google/type/expr.rb +6 -6
- metadata +2 -2
@@ -24,7 +24,7 @@ module Google
|
|
24
24
|
module V1
|
25
25
|
module DataCatalog
|
26
26
|
# Credentials for the DataCatalog API.
|
27
|
-
class Credentials < Google::Auth::Credentials
|
27
|
+
class Credentials < ::Google::Auth::Credentials
|
28
28
|
self.scope = [
|
29
29
|
"https://www.googleapis.com/auth/cloud-platform"
|
30
30
|
]
|
@@ -36,11 +36,11 @@ module Google
|
|
36
36
|
# @param entry_group [String]
|
37
37
|
# @param entry [String]
|
38
38
|
#
|
39
|
-
# @return [String]
|
39
|
+
# @return [::String]
|
40
40
|
def entry_path project:, location:, entry_group:, entry:
|
41
|
-
raise ArgumentError, "project cannot contain /" if project.to_s.include? "/"
|
42
|
-
raise ArgumentError, "location cannot contain /" if location.to_s.include? "/"
|
43
|
-
raise ArgumentError, "entry_group cannot contain /" if entry_group.to_s.include? "/"
|
41
|
+
raise ::ArgumentError, "project cannot contain /" if project.to_s.include? "/"
|
42
|
+
raise ::ArgumentError, "location cannot contain /" if location.to_s.include? "/"
|
43
|
+
raise ::ArgumentError, "entry_group cannot contain /" if entry_group.to_s.include? "/"
|
44
44
|
|
45
45
|
"projects/#{project}/locations/#{location}/entryGroups/#{entry_group}/entries/#{entry}"
|
46
46
|
end
|
@@ -56,10 +56,10 @@ module Google
|
|
56
56
|
# @param location [String]
|
57
57
|
# @param entry_group [String]
|
58
58
|
#
|
59
|
-
# @return [String]
|
59
|
+
# @return [::String]
|
60
60
|
def entry_group_path project:, location:, entry_group:
|
61
|
-
raise ArgumentError, "project cannot contain /" if project.to_s.include? "/"
|
62
|
-
raise ArgumentError, "location cannot contain /" if location.to_s.include? "/"
|
61
|
+
raise ::ArgumentError, "project cannot contain /" if project.to_s.include? "/"
|
62
|
+
raise ::ArgumentError, "location cannot contain /" if location.to_s.include? "/"
|
63
63
|
|
64
64
|
"projects/#{project}/locations/#{location}/entryGroups/#{entry_group}"
|
65
65
|
end
|
@@ -74,9 +74,9 @@ module Google
|
|
74
74
|
# @param project [String]
|
75
75
|
# @param location [String]
|
76
76
|
#
|
77
|
-
# @return [String]
|
77
|
+
# @return [::String]
|
78
78
|
def location_path project:, location:
|
79
|
-
raise ArgumentError, "project cannot contain /" if project.to_s.include? "/"
|
79
|
+
raise ::ArgumentError, "project cannot contain /" if project.to_s.include? "/"
|
80
80
|
|
81
81
|
"projects/#{project}/locations/#{location}"
|
82
82
|
end
|
@@ -94,12 +94,12 @@ module Google
|
|
94
94
|
# @param entry [String]
|
95
95
|
# @param tag [String]
|
96
96
|
#
|
97
|
-
# @return [String]
|
97
|
+
# @return [::String]
|
98
98
|
def tag_path project:, location:, entry_group:, entry:, tag:
|
99
|
-
raise ArgumentError, "project cannot contain /" if project.to_s.include? "/"
|
100
|
-
raise ArgumentError, "location cannot contain /" if location.to_s.include? "/"
|
101
|
-
raise ArgumentError, "entry_group cannot contain /" if entry_group.to_s.include? "/"
|
102
|
-
raise ArgumentError, "entry cannot contain /" if entry.to_s.include? "/"
|
99
|
+
raise ::ArgumentError, "project cannot contain /" if project.to_s.include? "/"
|
100
|
+
raise ::ArgumentError, "location cannot contain /" if location.to_s.include? "/"
|
101
|
+
raise ::ArgumentError, "entry_group cannot contain /" if entry_group.to_s.include? "/"
|
102
|
+
raise ::ArgumentError, "entry cannot contain /" if entry.to_s.include? "/"
|
103
103
|
|
104
104
|
"projects/#{project}/locations/#{location}/entryGroups/#{entry_group}/entries/#{entry}/tags/#{tag}"
|
105
105
|
end
|
@@ -115,10 +115,10 @@ module Google
|
|
115
115
|
# @param location [String]
|
116
116
|
# @param tag_template [String]
|
117
117
|
#
|
118
|
-
# @return [String]
|
118
|
+
# @return [::String]
|
119
119
|
def tag_template_path project:, location:, tag_template:
|
120
|
-
raise ArgumentError, "project cannot contain /" if project.to_s.include? "/"
|
121
|
-
raise ArgumentError, "location cannot contain /" if location.to_s.include? "/"
|
120
|
+
raise ::ArgumentError, "project cannot contain /" if project.to_s.include? "/"
|
121
|
+
raise ::ArgumentError, "location cannot contain /" if location.to_s.include? "/"
|
122
122
|
|
123
123
|
"projects/#{project}/locations/#{location}/tagTemplates/#{tag_template}"
|
124
124
|
end
|
@@ -135,11 +135,11 @@ module Google
|
|
135
135
|
# @param tag_template [String]
|
136
136
|
# @param field [String]
|
137
137
|
#
|
138
|
-
# @return [String]
|
138
|
+
# @return [::String]
|
139
139
|
def tag_template_field_path project:, location:, tag_template:, field:
|
140
|
-
raise ArgumentError, "project cannot contain /" if project.to_s.include? "/"
|
141
|
-
raise ArgumentError, "location cannot contain /" if location.to_s.include? "/"
|
142
|
-
raise ArgumentError, "tag_template cannot contain /" if tag_template.to_s.include? "/"
|
140
|
+
raise ::ArgumentError, "project cannot contain /" if project.to_s.include? "/"
|
141
|
+
raise ::ArgumentError, "location cannot contain /" if location.to_s.include? "/"
|
142
|
+
raise ::ArgumentError, "tag_template cannot contain /" if tag_template.to_s.include? "/"
|
143
143
|
|
144
144
|
"projects/#{project}/locations/#{location}/tagTemplates/#{tag_template}/fields/#{field}"
|
145
145
|
end
|
@@ -128,7 +128,7 @@ module Google
|
|
128
128
|
# - pattern: "shelves/{shelf}"
|
129
129
|
# parent_type: "cloudresourcemanager.googleapis.com/Folder"
|
130
130
|
# @!attribute [rw] type
|
131
|
-
# @return [String]
|
131
|
+
# @return [::String]
|
132
132
|
# The resource type. It must be in the format of
|
133
133
|
# \\{service_name}/\\{resource_type_kind}. The `resource_type_kind` must be
|
134
134
|
# singular and must not include version numbers.
|
@@ -140,7 +140,7 @@ module Google
|
|
140
140
|
# should use PascalCase (UpperCamelCase). The maximum number of
|
141
141
|
# characters allowed for the `resource_type_kind` is 100.
|
142
142
|
# @!attribute [rw] pattern
|
143
|
-
# @return [Array
|
143
|
+
# @return [::Array<::String>]
|
144
144
|
# Optional. The relative resource name pattern associated with this resource
|
145
145
|
# type. The DNS prefix of the full resource name shouldn't be specified here.
|
146
146
|
#
|
@@ -161,11 +161,11 @@ module Google
|
|
161
161
|
# the same component name (e.g. "project") refers to IDs of the same
|
162
162
|
# type of resource.
|
163
163
|
# @!attribute [rw] name_field
|
164
|
-
# @return [String]
|
164
|
+
# @return [::String]
|
165
165
|
# Optional. The field on the resource that designates the resource name
|
166
166
|
# field. If omitted, this is assumed to be "name".
|
167
167
|
# @!attribute [rw] history
|
168
|
-
# @return [Google::Api::ResourceDescriptor::History]
|
168
|
+
# @return [::Google::Api::ResourceDescriptor::History]
|
169
169
|
# Optional. The historical or future-looking state of the resource pattern.
|
170
170
|
#
|
171
171
|
# Example:
|
@@ -182,19 +182,19 @@ module Google
|
|
182
182
|
# };
|
183
183
|
# }
|
184
184
|
# @!attribute [rw] plural
|
185
|
-
# @return [String]
|
185
|
+
# @return [::String]
|
186
186
|
# The plural name used in the resource name, such as 'projects' for
|
187
187
|
# the name of 'projects/\\{project}'. It is the same concept of the `plural`
|
188
188
|
# field in k8s CRD spec
|
189
189
|
# https://kubernetes.io/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions/
|
190
190
|
# @!attribute [rw] singular
|
191
|
-
# @return [String]
|
191
|
+
# @return [::String]
|
192
192
|
# The same concept of the `singular` field in k8s CRD spec
|
193
193
|
# https://kubernetes.io/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions/
|
194
194
|
# Such as "project" for the `resourcemanager.googleapis.com/Project` type.
|
195
195
|
class ResourceDescriptor
|
196
|
-
include Google::Protobuf::MessageExts
|
197
|
-
extend Google::Protobuf::MessageExts::ClassMethods
|
196
|
+
include ::Google::Protobuf::MessageExts
|
197
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
198
198
|
|
199
199
|
# A description of the historical or future-looking state of the
|
200
200
|
# resource pattern.
|
@@ -216,7 +216,7 @@ module Google
|
|
216
216
|
# Defines a proto annotation that describes a string field that refers to
|
217
217
|
# an API resource.
|
218
218
|
# @!attribute [rw] type
|
219
|
-
# @return [String]
|
219
|
+
# @return [::String]
|
220
220
|
# The resource type that the annotated field references.
|
221
221
|
#
|
222
222
|
# Example:
|
@@ -227,7 +227,7 @@ module Google
|
|
227
227
|
# }];
|
228
228
|
# }
|
229
229
|
# @!attribute [rw] child_type
|
230
|
-
# @return [String]
|
230
|
+
# @return [::String]
|
231
231
|
# The resource type of a child collection that the annotated field
|
232
232
|
# references. This is useful for annotating the `parent` field that
|
233
233
|
# doesn't have a fixed resource type.
|
@@ -240,8 +240,8 @@ module Google
|
|
240
240
|
# };
|
241
241
|
# }
|
242
242
|
class ResourceReference
|
243
|
-
include Google::Protobuf::MessageExts
|
244
|
-
extend Google::Protobuf::MessageExts::ClassMethods
|
243
|
+
include ::Google::Protobuf::MessageExts
|
244
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
245
245
|
end
|
246
246
|
end
|
247
247
|
end
|
@@ -22,15 +22,15 @@ module Google
|
|
22
22
|
module DataCatalog
|
23
23
|
module V1
|
24
24
|
# Request message for
|
25
|
-
# {Google::Cloud::DataCatalog::V1::DataCatalog::Client#search_catalog SearchCatalog}.
|
25
|
+
# {::Google::Cloud::DataCatalog::V1::DataCatalog::Client#search_catalog SearchCatalog}.
|
26
26
|
# @!attribute [rw] scope
|
27
|
-
# @return [Google::Cloud::DataCatalog::V1::SearchCatalogRequest::Scope]
|
27
|
+
# @return [::Google::Cloud::DataCatalog::V1::SearchCatalogRequest::Scope]
|
28
28
|
# Required. The scope of this search request. A `scope` that has empty
|
29
29
|
# `include_org_ids`, `include_project_ids` AND false
|
30
30
|
# `include_gcp_public_datasets` is considered invalid. Data Catalog will
|
31
31
|
# return an error in such a case.
|
32
32
|
# @!attribute [rw] query
|
33
|
-
# @return [String]
|
33
|
+
# @return [::String]
|
34
34
|
# Required. The query string in search query syntax. The query must be non-empty.
|
35
35
|
#
|
36
36
|
# Query strings can be simple as "x" or more qualified as:
|
@@ -44,19 +44,19 @@ module Google
|
|
44
44
|
# Syntax](https://cloud.google.com/data-catalog/docs/how-to/search-reference)
|
45
45
|
# for more information.
|
46
46
|
# @!attribute [rw] page_size
|
47
|
-
# @return [Integer]
|
47
|
+
# @return [::Integer]
|
48
48
|
# Number of results in the search page. If <=0 then defaults to 10. Max limit
|
49
49
|
# for page_size is 1000. Throws an invalid argument for page_size > 1000.
|
50
50
|
# @!attribute [rw] page_token
|
51
|
-
# @return [String]
|
51
|
+
# @return [::String]
|
52
52
|
# Optional. Pagination token returned in an earlier
|
53
|
-
# {Google::Cloud::DataCatalog::V1::SearchCatalogResponse#next_page_token SearchCatalogResponse.next_page_token}, which
|
53
|
+
# {::Google::Cloud::DataCatalog::V1::SearchCatalogResponse#next_page_token SearchCatalogResponse.next_page_token}, which
|
54
54
|
# indicates that this is a continuation of a prior
|
55
|
-
# {Google::Cloud::DataCatalog::V1::DataCatalog::Client#search_catalog SearchCatalogRequest}
|
55
|
+
# {::Google::Cloud::DataCatalog::V1::DataCatalog::Client#search_catalog SearchCatalogRequest}
|
56
56
|
# call, and that the system should return the next page of data. If empty,
|
57
57
|
# the first page is returned.
|
58
58
|
# @!attribute [rw] order_by
|
59
|
-
# @return [String]
|
59
|
+
# @return [::String]
|
60
60
|
# Specifies the ordering of results, currently supported case-sensitive
|
61
61
|
# choices are:
|
62
62
|
#
|
@@ -66,28 +66,28 @@ module Google
|
|
66
66
|
#
|
67
67
|
# If not specified, defaults to `relevance` descending.
|
68
68
|
class SearchCatalogRequest
|
69
|
-
include Google::Protobuf::MessageExts
|
70
|
-
extend Google::Protobuf::MessageExts::ClassMethods
|
69
|
+
include ::Google::Protobuf::MessageExts
|
70
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
71
71
|
|
72
72
|
# The criteria that select the subspace used for query matching.
|
73
73
|
# @!attribute [rw] include_org_ids
|
74
|
-
# @return [Array
|
74
|
+
# @return [::Array<::String>]
|
75
75
|
# The list of organization IDs to search within. To find your organization
|
76
76
|
# ID, follow instructions in
|
77
77
|
# https://cloud.google.com/resource-manager/docs/creating-managing-organization.
|
78
78
|
# @!attribute [rw] include_project_ids
|
79
|
-
# @return [Array
|
79
|
+
# @return [::Array<::String>]
|
80
80
|
# The list of project IDs to search within. To learn more about the
|
81
81
|
# distinction between project names/IDs/numbers, go to
|
82
82
|
# https://cloud.google.com/docs/overview/#projects.
|
83
83
|
# @!attribute [rw] include_gcp_public_datasets
|
84
|
-
# @return [Boolean]
|
84
|
+
# @return [::Boolean]
|
85
85
|
# If `true`, include Google Cloud Platform (GCP) public datasets in the
|
86
86
|
# search results. Info on GCP public datasets is available at
|
87
87
|
# https://cloud.google.com/public-datasets/. By default, GCP public
|
88
88
|
# datasets are excluded.
|
89
89
|
# @!attribute [rw] restricted_locations
|
90
|
-
# @return [Array
|
90
|
+
# @return [::Array<::String>]
|
91
91
|
# Optional. The list of locations to search within.
|
92
92
|
# 1. If empty, search will be performed in all locations;
|
93
93
|
# 2. If any of the locations are NOT in the valid locations list, error
|
@@ -124,34 +124,34 @@ module Google
|
|
124
124
|
# * us-west1
|
125
125
|
# * us-west2
|
126
126
|
class Scope
|
127
|
-
include Google::Protobuf::MessageExts
|
128
|
-
extend Google::Protobuf::MessageExts::ClassMethods
|
127
|
+
include ::Google::Protobuf::MessageExts
|
128
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
129
129
|
end
|
130
130
|
end
|
131
131
|
|
132
132
|
# Response message for
|
133
|
-
# {Google::Cloud::DataCatalog::V1::DataCatalog::Client#search_catalog SearchCatalog}.
|
133
|
+
# {::Google::Cloud::DataCatalog::V1::DataCatalog::Client#search_catalog SearchCatalog}.
|
134
134
|
# @!attribute [rw] results
|
135
|
-
# @return [Array
|
135
|
+
# @return [::Array<::Google::Cloud::DataCatalog::V1::SearchCatalogResult>]
|
136
136
|
# Search results.
|
137
137
|
# @!attribute [rw] next_page_token
|
138
|
-
# @return [String]
|
138
|
+
# @return [::String]
|
139
139
|
# The token that can be used to retrieve the next page of results.
|
140
140
|
# @!attribute [rw] unreachable
|
141
|
-
# @return [Array
|
141
|
+
# @return [::Array<::String>]
|
142
142
|
# Unreachable locations. Search result does not include data from those
|
143
143
|
# locations. Users can get additional information on the error by repeating
|
144
144
|
# the search request with a more restrictive parameter -- setting the value
|
145
145
|
# for `SearchDataCatalogRequest.scope.include_locations`.
|
146
146
|
class SearchCatalogResponse
|
147
|
-
include Google::Protobuf::MessageExts
|
148
|
-
extend Google::Protobuf::MessageExts::ClassMethods
|
147
|
+
include ::Google::Protobuf::MessageExts
|
148
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
149
149
|
end
|
150
150
|
|
151
151
|
# Request message for
|
152
|
-
# {Google::Cloud::DataCatalog::V1::DataCatalog::Client#create_entry_group CreateEntryGroup}.
|
152
|
+
# {::Google::Cloud::DataCatalog::V1::DataCatalog::Client#create_entry_group CreateEntryGroup}.
|
153
153
|
# @!attribute [rw] parent
|
154
|
-
# @return [String]
|
154
|
+
# @return [::String]
|
155
155
|
# Required. The name of the project this entry group is in. Example:
|
156
156
|
#
|
157
157
|
# * projects/\\{project_id}/locations/\\{location}
|
@@ -159,99 +159,99 @@ module Google
|
|
159
159
|
# Note that this EntryGroup and its child resources may not actually be
|
160
160
|
# stored in the location in this name.
|
161
161
|
# @!attribute [rw] entry_group_id
|
162
|
-
# @return [String]
|
162
|
+
# @return [::String]
|
163
163
|
# Required. The id of the entry group to create.
|
164
164
|
# The id must begin with a letter or underscore, contain only English
|
165
165
|
# letters, numbers and underscores, and be at most 64 characters.
|
166
166
|
# @!attribute [rw] entry_group
|
167
|
-
# @return [Google::Cloud::DataCatalog::V1::EntryGroup]
|
167
|
+
# @return [::Google::Cloud::DataCatalog::V1::EntryGroup]
|
168
168
|
# The entry group to create. Defaults to an empty entry group.
|
169
169
|
class CreateEntryGroupRequest
|
170
|
-
include Google::Protobuf::MessageExts
|
171
|
-
extend Google::Protobuf::MessageExts::ClassMethods
|
170
|
+
include ::Google::Protobuf::MessageExts
|
171
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
172
172
|
end
|
173
173
|
|
174
174
|
# Request message for
|
175
|
-
# {Google::Cloud::DataCatalog::V1::DataCatalog::Client#update_entry_group UpdateEntryGroup}.
|
175
|
+
# {::Google::Cloud::DataCatalog::V1::DataCatalog::Client#update_entry_group UpdateEntryGroup}.
|
176
176
|
# @!attribute [rw] entry_group
|
177
|
-
# @return [Google::Cloud::DataCatalog::V1::EntryGroup]
|
177
|
+
# @return [::Google::Cloud::DataCatalog::V1::EntryGroup]
|
178
178
|
# Required. The updated entry group. "name" field must be set.
|
179
179
|
# @!attribute [rw] update_mask
|
180
|
-
# @return [Google::Protobuf::FieldMask]
|
180
|
+
# @return [::Google::Protobuf::FieldMask]
|
181
181
|
# The fields to update on the entry group. If absent or empty, all modifiable
|
182
182
|
# fields are updated.
|
183
183
|
class UpdateEntryGroupRequest
|
184
|
-
include Google::Protobuf::MessageExts
|
185
|
-
extend Google::Protobuf::MessageExts::ClassMethods
|
184
|
+
include ::Google::Protobuf::MessageExts
|
185
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
186
186
|
end
|
187
187
|
|
188
188
|
# Request message for
|
189
|
-
# {Google::Cloud::DataCatalog::V1::DataCatalog::Client#get_entry_group GetEntryGroup}.
|
189
|
+
# {::Google::Cloud::DataCatalog::V1::DataCatalog::Client#get_entry_group GetEntryGroup}.
|
190
190
|
# @!attribute [rw] name
|
191
|
-
# @return [String]
|
191
|
+
# @return [::String]
|
192
192
|
# Required. The name of the entry group. For example,
|
193
193
|
# `projects/{project_id}/locations/{location}/entryGroups/{entry_group_id}`.
|
194
194
|
# @!attribute [rw] read_mask
|
195
|
-
# @return [Google::Protobuf::FieldMask]
|
195
|
+
# @return [::Google::Protobuf::FieldMask]
|
196
196
|
# The fields to return. If not set or empty, all fields are returned.
|
197
197
|
class GetEntryGroupRequest
|
198
|
-
include Google::Protobuf::MessageExts
|
199
|
-
extend Google::Protobuf::MessageExts::ClassMethods
|
198
|
+
include ::Google::Protobuf::MessageExts
|
199
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
200
200
|
end
|
201
201
|
|
202
202
|
# Request message for
|
203
|
-
# {Google::Cloud::DataCatalog::V1::DataCatalog::Client#delete_entry_group DeleteEntryGroup}.
|
203
|
+
# {::Google::Cloud::DataCatalog::V1::DataCatalog::Client#delete_entry_group DeleteEntryGroup}.
|
204
204
|
# @!attribute [rw] name
|
205
|
-
# @return [String]
|
205
|
+
# @return [::String]
|
206
206
|
# Required. The name of the entry group. For example,
|
207
207
|
# `projects/{project_id}/locations/{location}/entryGroups/{entry_group_id}`.
|
208
208
|
# @!attribute [rw] force
|
209
|
-
# @return [Boolean]
|
209
|
+
# @return [::Boolean]
|
210
210
|
# Optional. If true, deletes all entries in the entry group.
|
211
211
|
class DeleteEntryGroupRequest
|
212
|
-
include Google::Protobuf::MessageExts
|
213
|
-
extend Google::Protobuf::MessageExts::ClassMethods
|
212
|
+
include ::Google::Protobuf::MessageExts
|
213
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
214
214
|
end
|
215
215
|
|
216
216
|
# Request message for
|
217
|
-
# {Google::Cloud::DataCatalog::V1::DataCatalog::Client#list_entry_groups ListEntryGroups}.
|
217
|
+
# {::Google::Cloud::DataCatalog::V1::DataCatalog::Client#list_entry_groups ListEntryGroups}.
|
218
218
|
# @!attribute [rw] parent
|
219
|
-
# @return [String]
|
219
|
+
# @return [::String]
|
220
220
|
# Required. The name of the location that contains the entry groups, which can be
|
221
221
|
# provided in URL format. Example:
|
222
222
|
#
|
223
223
|
# * projects/\\{project_id}/locations/\\{location}
|
224
224
|
# @!attribute [rw] page_size
|
225
|
-
# @return [Integer]
|
225
|
+
# @return [::Integer]
|
226
226
|
# Optional. The maximum number of items to return. Default is 10. Max limit is 1000.
|
227
227
|
# Throws an invalid argument for `page_size > 1000`.
|
228
228
|
# @!attribute [rw] page_token
|
229
|
-
# @return [String]
|
229
|
+
# @return [::String]
|
230
230
|
# Optional. Token that specifies which page is requested. If empty, the first page is
|
231
231
|
# returned.
|
232
232
|
class ListEntryGroupsRequest
|
233
|
-
include Google::Protobuf::MessageExts
|
234
|
-
extend Google::Protobuf::MessageExts::ClassMethods
|
233
|
+
include ::Google::Protobuf::MessageExts
|
234
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
235
235
|
end
|
236
236
|
|
237
237
|
# Response message for
|
238
|
-
# {Google::Cloud::DataCatalog::V1::DataCatalog::Client#list_entry_groups ListEntryGroups}.
|
238
|
+
# {::Google::Cloud::DataCatalog::V1::DataCatalog::Client#list_entry_groups ListEntryGroups}.
|
239
239
|
# @!attribute [rw] entry_groups
|
240
|
-
# @return [Array
|
240
|
+
# @return [::Array<::Google::Cloud::DataCatalog::V1::EntryGroup>]
|
241
241
|
# EntryGroup details.
|
242
242
|
# @!attribute [rw] next_page_token
|
243
|
-
# @return [String]
|
243
|
+
# @return [::String]
|
244
244
|
# Token to retrieve the next page of results. It is set to empty if no items
|
245
245
|
# remain in results.
|
246
246
|
class ListEntryGroupsResponse
|
247
|
-
include Google::Protobuf::MessageExts
|
248
|
-
extend Google::Protobuf::MessageExts::ClassMethods
|
247
|
+
include ::Google::Protobuf::MessageExts
|
248
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
249
249
|
end
|
250
250
|
|
251
251
|
# Request message for
|
252
|
-
# {Google::Cloud::DataCatalog::V1::DataCatalog::Client#create_entry CreateEntry}.
|
252
|
+
# {::Google::Cloud::DataCatalog::V1::DataCatalog::Client#create_entry CreateEntry}.
|
253
253
|
# @!attribute [rw] parent
|
254
|
-
# @return [String]
|
254
|
+
# @return [::String]
|
255
255
|
# Required. The name of the entry group this entry is in. Example:
|
256
256
|
#
|
257
257
|
# * projects/\\{project_id}/locations/\\{location}/entryGroups/\\{entry_group_id}
|
@@ -259,23 +259,23 @@ module Google
|
|
259
259
|
# Note that this Entry and its child resources may not actually be stored in
|
260
260
|
# the location in this name.
|
261
261
|
# @!attribute [rw] entry_id
|
262
|
-
# @return [String]
|
262
|
+
# @return [::String]
|
263
263
|
# Required. The id of the entry to create.
|
264
264
|
# @!attribute [rw] entry
|
265
|
-
# @return [Google::Cloud::DataCatalog::V1::Entry]
|
265
|
+
# @return [::Google::Cloud::DataCatalog::V1::Entry]
|
266
266
|
# Required. The entry to create.
|
267
267
|
class CreateEntryRequest
|
268
|
-
include Google::Protobuf::MessageExts
|
269
|
-
extend Google::Protobuf::MessageExts::ClassMethods
|
268
|
+
include ::Google::Protobuf::MessageExts
|
269
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
270
270
|
end
|
271
271
|
|
272
272
|
# Request message for
|
273
|
-
# {Google::Cloud::DataCatalog::V1::DataCatalog::Client#update_entry UpdateEntry}.
|
273
|
+
# {::Google::Cloud::DataCatalog::V1::DataCatalog::Client#update_entry UpdateEntry}.
|
274
274
|
# @!attribute [rw] entry
|
275
|
-
# @return [Google::Cloud::DataCatalog::V1::Entry]
|
275
|
+
# @return [::Google::Cloud::DataCatalog::V1::Entry]
|
276
276
|
# Required. The updated entry. The "name" field must be set.
|
277
277
|
# @!attribute [rw] update_mask
|
278
|
-
# @return [Google::Protobuf::FieldMask]
|
278
|
+
# @return [::Google::Protobuf::FieldMask]
|
279
279
|
# The fields to update on the entry. If absent or empty, all modifiable
|
280
280
|
# fields are updated.
|
281
281
|
#
|
@@ -297,38 +297,38 @@ module Google
|
|
297
297
|
# * linked_resource
|
298
298
|
# * source_system_timestamps
|
299
299
|
class UpdateEntryRequest
|
300
|
-
include Google::Protobuf::MessageExts
|
301
|
-
extend Google::Protobuf::MessageExts::ClassMethods
|
300
|
+
include ::Google::Protobuf::MessageExts
|
301
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
302
302
|
end
|
303
303
|
|
304
304
|
# Request message for
|
305
|
-
# {Google::Cloud::DataCatalog::V1::DataCatalog::Client#delete_entry DeleteEntry}.
|
305
|
+
# {::Google::Cloud::DataCatalog::V1::DataCatalog::Client#delete_entry DeleteEntry}.
|
306
306
|
# @!attribute [rw] name
|
307
|
-
# @return [String]
|
307
|
+
# @return [::String]
|
308
308
|
# Required. The name of the entry. Example:
|
309
309
|
#
|
310
310
|
# * projects/\\{project_id}/locations/\\{location}/entryGroups/\\{entry_group_id}/entries/\\{entry_id}
|
311
311
|
class DeleteEntryRequest
|
312
|
-
include Google::Protobuf::MessageExts
|
313
|
-
extend Google::Protobuf::MessageExts::ClassMethods
|
312
|
+
include ::Google::Protobuf::MessageExts
|
313
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
314
314
|
end
|
315
315
|
|
316
316
|
# Request message for
|
317
|
-
# {Google::Cloud::DataCatalog::V1::DataCatalog::Client#get_entry GetEntry}.
|
317
|
+
# {::Google::Cloud::DataCatalog::V1::DataCatalog::Client#get_entry GetEntry}.
|
318
318
|
# @!attribute [rw] name
|
319
|
-
# @return [String]
|
319
|
+
# @return [::String]
|
320
320
|
# Required. The name of the entry. Example:
|
321
321
|
#
|
322
322
|
# * projects/\\{project_id}/locations/\\{location}/entryGroups/\\{entry_group_id}/entries/\\{entry_id}
|
323
323
|
class GetEntryRequest
|
324
|
-
include Google::Protobuf::MessageExts
|
325
|
-
extend Google::Protobuf::MessageExts::ClassMethods
|
324
|
+
include ::Google::Protobuf::MessageExts
|
325
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
326
326
|
end
|
327
327
|
|
328
328
|
# Request message for
|
329
|
-
# {Google::Cloud::DataCatalog::V1::DataCatalog::Client#lookup_entry LookupEntry}.
|
329
|
+
# {::Google::Cloud::DataCatalog::V1::DataCatalog::Client#lookup_entry LookupEntry}.
|
330
330
|
# @!attribute [rw] linked_resource
|
331
|
-
# @return [String]
|
331
|
+
# @return [::String]
|
332
332
|
# The full name of the Google Cloud Platform resource the Data Catalog
|
333
333
|
# entry represents. See:
|
334
334
|
# https://cloud.google.com/apis/design/resource_names#full_resource_name.
|
@@ -339,7 +339,7 @@ module Google
|
|
339
339
|
# * //bigquery.googleapis.com/projects/projectId/datasets/datasetId/tables/tableId
|
340
340
|
# * //pubsub.googleapis.com/projects/projectId/topics/topicId
|
341
341
|
# @!attribute [rw] sql_resource
|
342
|
-
# @return [String]
|
342
|
+
# @return [::String]
|
343
343
|
# The SQL name of the entry. SQL names are case-sensitive.
|
344
344
|
#
|
345
345
|
# Examples:
|
@@ -353,8 +353,8 @@ module Google
|
|
353
353
|
# `*_id`s shoud satisfy the standard SQL rules for identifiers.
|
354
354
|
# https://cloud.google.com/bigquery/docs/reference/standard-sql/lexical.
|
355
355
|
class LookupEntryRequest
|
356
|
-
include Google::Protobuf::MessageExts
|
357
|
-
extend Google::Protobuf::MessageExts::ClassMethods
|
356
|
+
include ::Google::Protobuf::MessageExts
|
357
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
358
358
|
end
|
359
359
|
|
360
360
|
# Entry Metadata.
|
@@ -366,9 +366,9 @@ module Google
|
|
366
366
|
#
|
367
367
|
# An Entry resource contains resource details, such as its schema. An Entry can
|
368
368
|
# also be used to attach flexible metadata, such as a
|
369
|
-
# {Google::Cloud::DataCatalog::V1::Tag Tag}.
|
369
|
+
# {::Google::Cloud::DataCatalog::V1::Tag Tag}.
|
370
370
|
# @!attribute [rw] name
|
371
|
-
# @return [String]
|
371
|
+
# @return [::String]
|
372
372
|
# The Data Catalog resource name of the entry in URL format. Example:
|
373
373
|
#
|
374
374
|
# * projects/\\{project_id}/locations/\\{location}/entryGroups/\\{entry_group_id}/entries/\\{entry_id}
|
@@ -376,7 +376,7 @@ module Google
|
|
376
376
|
# Note that this Entry and its child resources may not actually be stored in
|
377
377
|
# the location in this name.
|
378
378
|
# @!attribute [rw] linked_resource
|
379
|
-
# @return [String]
|
379
|
+
# @return [::String]
|
380
380
|
# The resource this metadata entry refers to.
|
381
381
|
#
|
382
382
|
# For Google Cloud Platform resources, `linked_resource` is the [full name of
|
@@ -390,11 +390,11 @@ module Google
|
|
390
390
|
# user_specified_type, this field is optional and defaults to an empty
|
391
391
|
# string.
|
392
392
|
# @!attribute [rw] type
|
393
|
-
# @return [Google::Cloud::DataCatalog::V1::EntryType]
|
393
|
+
# @return [::Google::Cloud::DataCatalog::V1::EntryType]
|
394
394
|
# The type of the entry.
|
395
395
|
# Only used for Entries with types in the EntryType enum.
|
396
396
|
# @!attribute [rw] user_specified_type
|
397
|
-
# @return [String]
|
397
|
+
# @return [::String]
|
398
398
|
# Entry type if it does not fit any of the input-allowed values listed in
|
399
399
|
# `EntryType` enum above. When creating an entry, users should check the
|
400
400
|
# enum values first, if nothing matches the entry to be created, then
|
@@ -406,57 +406,57 @@ module Google
|
|
406
406
|
# Currently, only FILESET enum value is allowed. All other entries created
|
407
407
|
# through Data Catalog must use `user_specified_type`.
|
408
408
|
# @!attribute [r] integrated_system
|
409
|
-
# @return [Google::Cloud::DataCatalog::V1::IntegratedSystem]
|
409
|
+
# @return [::Google::Cloud::DataCatalog::V1::IntegratedSystem]
|
410
410
|
# Output only. This field indicates the entry's source system that Data Catalog
|
411
411
|
# integrates with, such as BigQuery or Pub/Sub.
|
412
412
|
# @!attribute [rw] user_specified_system
|
413
|
-
# @return [String]
|
413
|
+
# @return [::String]
|
414
414
|
# This field indicates the entry's source system that Data Catalog does not
|
415
415
|
# integrate with. `user_specified_system` strings must begin with a letter
|
416
416
|
# or underscore and can only contain letters, numbers, and underscores; are
|
417
417
|
# case insensitive; must be at least 1 character and at most 64 characters
|
418
418
|
# long.
|
419
419
|
# @!attribute [rw] gcs_fileset_spec
|
420
|
-
# @return [Google::Cloud::DataCatalog::V1::GcsFilesetSpec]
|
420
|
+
# @return [::Google::Cloud::DataCatalog::V1::GcsFilesetSpec]
|
421
421
|
# Specification that applies to a Cloud Storage fileset. This is only valid
|
422
422
|
# on entries of type FILESET.
|
423
423
|
# @!attribute [rw] bigquery_table_spec
|
424
|
-
# @return [Google::Cloud::DataCatalog::V1::BigQueryTableSpec]
|
424
|
+
# @return [::Google::Cloud::DataCatalog::V1::BigQueryTableSpec]
|
425
425
|
# Specification that applies to a BigQuery table. This is only valid on
|
426
426
|
# entries of type `TABLE`.
|
427
427
|
# @!attribute [rw] bigquery_date_sharded_spec
|
428
|
-
# @return [Google::Cloud::DataCatalog::V1::BigQueryDateShardedSpec]
|
428
|
+
# @return [::Google::Cloud::DataCatalog::V1::BigQueryDateShardedSpec]
|
429
429
|
# Specification for a group of BigQuery tables with name pattern
|
430
430
|
# `[prefix]YYYYMMDD`. Context:
|
431
431
|
# https://cloud.google.com/bigquery/docs/partitioned-tables#partitioning_versus_sharding.
|
432
432
|
# @!attribute [rw] display_name
|
433
|
-
# @return [String]
|
433
|
+
# @return [::String]
|
434
434
|
# Display information such as title and description. A short name to identify
|
435
435
|
# the entry, for example, "Analytics Data - Jan 2011". Default value is an
|
436
436
|
# empty string.
|
437
437
|
# @!attribute [rw] description
|
438
|
-
# @return [String]
|
438
|
+
# @return [::String]
|
439
439
|
# Entry description, which can consist of several sentences or paragraphs
|
440
440
|
# that describe entry contents. Default value is an empty string.
|
441
441
|
# @!attribute [rw] schema
|
442
|
-
# @return [Google::Cloud::DataCatalog::V1::Schema]
|
442
|
+
# @return [::Google::Cloud::DataCatalog::V1::Schema]
|
443
443
|
# Schema of the entry. An entry might not have any schema attached to it.
|
444
444
|
# @!attribute [rw] source_system_timestamps
|
445
|
-
# @return [Google::Cloud::DataCatalog::V1::SystemTimestamps]
|
445
|
+
# @return [::Google::Cloud::DataCatalog::V1::SystemTimestamps]
|
446
446
|
# Timestamps about the underlying resource, not about this Data Catalog
|
447
447
|
# entry. Output only when Entry is of type in the EntryType enum. For entries
|
448
448
|
# with user_specified_type, this field is optional and defaults to an empty
|
449
449
|
# timestamp.
|
450
450
|
class Entry
|
451
|
-
include Google::Protobuf::MessageExts
|
452
|
-
extend Google::Protobuf::MessageExts::ClassMethods
|
451
|
+
include ::Google::Protobuf::MessageExts
|
452
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
453
453
|
end
|
454
454
|
|
455
455
|
# EntryGroup Metadata.
|
456
456
|
# An EntryGroup resource represents a logical grouping of zero or more
|
457
|
-
# Data Catalog {Google::Cloud::DataCatalog::V1::Entry Entry} resources.
|
457
|
+
# Data Catalog {::Google::Cloud::DataCatalog::V1::Entry Entry} resources.
|
458
458
|
# @!attribute [rw] name
|
459
|
-
# @return [String]
|
459
|
+
# @return [::String]
|
460
460
|
# The resource name of the entry group in URL format. Example:
|
461
461
|
#
|
462
462
|
# * projects/\\{project_id}/locations/\\{location}/entryGroups/\\{entry_group_id}
|
@@ -464,26 +464,26 @@ module Google
|
|
464
464
|
# Note that this EntryGroup and its child resources may not actually be
|
465
465
|
# stored in the location in this name.
|
466
466
|
# @!attribute [rw] display_name
|
467
|
-
# @return [String]
|
467
|
+
# @return [::String]
|
468
468
|
# A short name to identify the entry group, for example,
|
469
469
|
# "analytics data - jan 2011". Default value is an empty string.
|
470
470
|
# @!attribute [rw] description
|
471
|
-
# @return [String]
|
471
|
+
# @return [::String]
|
472
472
|
# Entry group description, which can consist of several sentences or
|
473
473
|
# paragraphs that describe entry group contents. Default value is an empty
|
474
474
|
# string.
|
475
475
|
# @!attribute [r] data_catalog_timestamps
|
476
|
-
# @return [Google::Cloud::DataCatalog::V1::SystemTimestamps]
|
476
|
+
# @return [::Google::Cloud::DataCatalog::V1::SystemTimestamps]
|
477
477
|
# Output only. Timestamps about this EntryGroup. Default value is empty timestamps.
|
478
478
|
class EntryGroup
|
479
|
-
include Google::Protobuf::MessageExts
|
480
|
-
extend Google::Protobuf::MessageExts::ClassMethods
|
479
|
+
include ::Google::Protobuf::MessageExts
|
480
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
481
481
|
end
|
482
482
|
|
483
483
|
# Request message for
|
484
|
-
# {Google::Cloud::DataCatalog::V1::DataCatalog::Client#create_tag_template CreateTagTemplate}.
|
484
|
+
# {::Google::Cloud::DataCatalog::V1::DataCatalog::Client#create_tag_template CreateTagTemplate}.
|
485
485
|
# @!attribute [rw] parent
|
486
|
-
# @return [String]
|
486
|
+
# @return [::String]
|
487
487
|
# Required. The name of the project and the template location
|
488
488
|
# [region](https://cloud.google.com/data-catalog/docs/concepts/regions).
|
489
489
|
#
|
@@ -491,35 +491,35 @@ module Google
|
|
491
491
|
#
|
492
492
|
# * projects/\\{project_id}/locations/us-central1
|
493
493
|
# @!attribute [rw] tag_template_id
|
494
|
-
# @return [String]
|
494
|
+
# @return [::String]
|
495
495
|
# Required. The id of the tag template to create.
|
496
496
|
# @!attribute [rw] tag_template
|
497
|
-
# @return [Google::Cloud::DataCatalog::V1::TagTemplate]
|
497
|
+
# @return [::Google::Cloud::DataCatalog::V1::TagTemplate]
|
498
498
|
# Required. The tag template to create.
|
499
499
|
class CreateTagTemplateRequest
|
500
|
-
include Google::Protobuf::MessageExts
|
501
|
-
extend Google::Protobuf::MessageExts::ClassMethods
|
500
|
+
include ::Google::Protobuf::MessageExts
|
501
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
502
502
|
end
|
503
503
|
|
504
504
|
# Request message for
|
505
|
-
# {Google::Cloud::DataCatalog::V1::DataCatalog::Client#get_tag_template GetTagTemplate}.
|
505
|
+
# {::Google::Cloud::DataCatalog::V1::DataCatalog::Client#get_tag_template GetTagTemplate}.
|
506
506
|
# @!attribute [rw] name
|
507
|
-
# @return [String]
|
507
|
+
# @return [::String]
|
508
508
|
# Required. The name of the tag template. Example:
|
509
509
|
#
|
510
510
|
# * projects/\\{project_id}/locations/\\{location}/tagTemplates/\\{tag_template_id}
|
511
511
|
class GetTagTemplateRequest
|
512
|
-
include Google::Protobuf::MessageExts
|
513
|
-
extend Google::Protobuf::MessageExts::ClassMethods
|
512
|
+
include ::Google::Protobuf::MessageExts
|
513
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
514
514
|
end
|
515
515
|
|
516
516
|
# Request message for
|
517
|
-
# {Google::Cloud::DataCatalog::V1::DataCatalog::Client#update_tag_template UpdateTagTemplate}.
|
517
|
+
# {::Google::Cloud::DataCatalog::V1::DataCatalog::Client#update_tag_template UpdateTagTemplate}.
|
518
518
|
# @!attribute [rw] tag_template
|
519
|
-
# @return [Google::Cloud::DataCatalog::V1::TagTemplate]
|
519
|
+
# @return [::Google::Cloud::DataCatalog::V1::TagTemplate]
|
520
520
|
# Required. The template to update. The "name" field must be set.
|
521
521
|
# @!attribute [rw] update_mask
|
522
|
-
# @return [Google::Protobuf::FieldMask]
|
522
|
+
# @return [::Google::Protobuf::FieldMask]
|
523
523
|
# The field mask specifies the parts of the template to overwrite.
|
524
524
|
#
|
525
525
|
# Allowed fields:
|
@@ -528,31 +528,31 @@ module Google
|
|
528
528
|
#
|
529
529
|
# If absent or empty, all of the allowed fields above will be updated.
|
530
530
|
class UpdateTagTemplateRequest
|
531
|
-
include Google::Protobuf::MessageExts
|
532
|
-
extend Google::Protobuf::MessageExts::ClassMethods
|
531
|
+
include ::Google::Protobuf::MessageExts
|
532
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
533
533
|
end
|
534
534
|
|
535
535
|
# Request message for
|
536
|
-
# {Google::Cloud::DataCatalog::V1::DataCatalog::Client#delete_tag_template DeleteTagTemplate}.
|
536
|
+
# {::Google::Cloud::DataCatalog::V1::DataCatalog::Client#delete_tag_template DeleteTagTemplate}.
|
537
537
|
# @!attribute [rw] name
|
538
|
-
# @return [String]
|
538
|
+
# @return [::String]
|
539
539
|
# Required. The name of the tag template to delete. Example:
|
540
540
|
#
|
541
541
|
# * projects/\\{project_id}/locations/\\{location}/tagTemplates/\\{tag_template_id}
|
542
542
|
# @!attribute [rw] force
|
543
|
-
# @return [Boolean]
|
543
|
+
# @return [::Boolean]
|
544
544
|
# Required. Currently, this field must always be set to `true`.
|
545
545
|
# This confirms the deletion of any possible tags using this template.
|
546
546
|
# `force = false` will be supported in the future.
|
547
547
|
class DeleteTagTemplateRequest
|
548
|
-
include Google::Protobuf::MessageExts
|
549
|
-
extend Google::Protobuf::MessageExts::ClassMethods
|
548
|
+
include ::Google::Protobuf::MessageExts
|
549
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
550
550
|
end
|
551
551
|
|
552
552
|
# Request message for
|
553
|
-
# {Google::Cloud::DataCatalog::V1::DataCatalog::Client#create_tag CreateTag}.
|
553
|
+
# {::Google::Cloud::DataCatalog::V1::DataCatalog::Client#create_tag CreateTag}.
|
554
554
|
# @!attribute [rw] parent
|
555
|
-
# @return [String]
|
555
|
+
# @return [::String]
|
556
556
|
# Required. The name of the resource to attach this tag to. Tags can be attached to
|
557
557
|
# Entries. Example:
|
558
558
|
#
|
@@ -561,43 +561,43 @@ module Google
|
|
561
561
|
# Note that this Tag and its child resources may not actually be stored in
|
562
562
|
# the location in this name.
|
563
563
|
# @!attribute [rw] tag
|
564
|
-
# @return [Google::Cloud::DataCatalog::V1::Tag]
|
564
|
+
# @return [::Google::Cloud::DataCatalog::V1::Tag]
|
565
565
|
# Required. The tag to create.
|
566
566
|
class CreateTagRequest
|
567
|
-
include Google::Protobuf::MessageExts
|
568
|
-
extend Google::Protobuf::MessageExts::ClassMethods
|
567
|
+
include ::Google::Protobuf::MessageExts
|
568
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
569
569
|
end
|
570
570
|
|
571
571
|
# Request message for
|
572
|
-
# {Google::Cloud::DataCatalog::V1::DataCatalog::Client#update_tag UpdateTag}.
|
572
|
+
# {::Google::Cloud::DataCatalog::V1::DataCatalog::Client#update_tag UpdateTag}.
|
573
573
|
# @!attribute [rw] tag
|
574
|
-
# @return [Google::Cloud::DataCatalog::V1::Tag]
|
574
|
+
# @return [::Google::Cloud::DataCatalog::V1::Tag]
|
575
575
|
# Required. The updated tag. The "name" field must be set.
|
576
576
|
# @!attribute [rw] update_mask
|
577
|
-
# @return [Google::Protobuf::FieldMask]
|
577
|
+
# @return [::Google::Protobuf::FieldMask]
|
578
578
|
# The fields to update on the Tag. If absent or empty, all modifiable fields
|
579
579
|
# are updated. Currently the only modifiable field is the field `fields`.
|
580
580
|
class UpdateTagRequest
|
581
|
-
include Google::Protobuf::MessageExts
|
582
|
-
extend Google::Protobuf::MessageExts::ClassMethods
|
581
|
+
include ::Google::Protobuf::MessageExts
|
582
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
583
583
|
end
|
584
584
|
|
585
585
|
# Request message for
|
586
|
-
# {Google::Cloud::DataCatalog::V1::DataCatalog::Client#delete_tag DeleteTag}.
|
586
|
+
# {::Google::Cloud::DataCatalog::V1::DataCatalog::Client#delete_tag DeleteTag}.
|
587
587
|
# @!attribute [rw] name
|
588
|
-
# @return [String]
|
588
|
+
# @return [::String]
|
589
589
|
# Required. The name of the tag to delete. Example:
|
590
590
|
#
|
591
591
|
# * projects/\\{project_id}/locations/\\{location}/entryGroups/\\{entry_group_id}/entries/\\{entry_id}/tags/\\{tag_id}
|
592
592
|
class DeleteTagRequest
|
593
|
-
include Google::Protobuf::MessageExts
|
594
|
-
extend Google::Protobuf::MessageExts::ClassMethods
|
593
|
+
include ::Google::Protobuf::MessageExts
|
594
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
595
595
|
end
|
596
596
|
|
597
597
|
# Request message for
|
598
|
-
# {Google::Cloud::DataCatalog::V1::DataCatalog::Client#create_tag_template_field CreateTagTemplateField}.
|
598
|
+
# {::Google::Cloud::DataCatalog::V1::DataCatalog::Client#create_tag_template_field CreateTagTemplateField}.
|
599
599
|
# @!attribute [rw] parent
|
600
|
-
# @return [String]
|
600
|
+
# @return [::String]
|
601
601
|
# Required. The name of the project and the template location
|
602
602
|
# [region](https://cloud.google.com/data-catalog/docs/concepts/regions).
|
603
603
|
#
|
@@ -605,32 +605,32 @@ module Google
|
|
605
605
|
#
|
606
606
|
# * projects/\\{project_id}/locations/us-central1/tagTemplates/\\{tag_template_id}
|
607
607
|
# @!attribute [rw] tag_template_field_id
|
608
|
-
# @return [String]
|
608
|
+
# @return [::String]
|
609
609
|
# Required. The ID of the tag template field to create.
|
610
610
|
# Field ids can contain letters (both uppercase and lowercase), numbers
|
611
611
|
# (0-9), underscores (_) and dashes (-). Field IDs must be at least 1
|
612
612
|
# character long and at most 128 characters long. Field IDs must also be
|
613
613
|
# unique within their template.
|
614
614
|
# @!attribute [rw] tag_template_field
|
615
|
-
# @return [Google::Cloud::DataCatalog::V1::TagTemplateField]
|
615
|
+
# @return [::Google::Cloud::DataCatalog::V1::TagTemplateField]
|
616
616
|
# Required. The tag template field to create.
|
617
617
|
class CreateTagTemplateFieldRequest
|
618
|
-
include Google::Protobuf::MessageExts
|
619
|
-
extend Google::Protobuf::MessageExts::ClassMethods
|
618
|
+
include ::Google::Protobuf::MessageExts
|
619
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
620
620
|
end
|
621
621
|
|
622
622
|
# Request message for
|
623
|
-
# {Google::Cloud::DataCatalog::V1::DataCatalog::Client#update_tag_template_field UpdateTagTemplateField}.
|
623
|
+
# {::Google::Cloud::DataCatalog::V1::DataCatalog::Client#update_tag_template_field UpdateTagTemplateField}.
|
624
624
|
# @!attribute [rw] name
|
625
|
-
# @return [String]
|
625
|
+
# @return [::String]
|
626
626
|
# Required. The name of the tag template field. Example:
|
627
627
|
#
|
628
628
|
# * projects/\\{project_id}/locations/\\{location}/tagTemplates/\\{tag_template_id}/fields/\\{tag_template_field_id}
|
629
629
|
# @!attribute [rw] tag_template_field
|
630
|
-
# @return [Google::Cloud::DataCatalog::V1::TagTemplateField]
|
630
|
+
# @return [::Google::Cloud::DataCatalog::V1::TagTemplateField]
|
631
631
|
# Required. The template to update.
|
632
632
|
# @!attribute [rw] update_mask
|
633
|
-
# @return [Google::Protobuf::FieldMask]
|
633
|
+
# @return [::Google::Protobuf::FieldMask]
|
634
634
|
# Optional. The field mask specifies the parts of the template to be updated.
|
635
635
|
# Allowed fields:
|
636
636
|
#
|
@@ -646,119 +646,119 @@ module Google
|
|
646
646
|
# values cannot be deleted nor renamed. Updating a template field from
|
647
647
|
# optional to required is NOT allowed.
|
648
648
|
class UpdateTagTemplateFieldRequest
|
649
|
-
include Google::Protobuf::MessageExts
|
650
|
-
extend Google::Protobuf::MessageExts::ClassMethods
|
649
|
+
include ::Google::Protobuf::MessageExts
|
650
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
651
651
|
end
|
652
652
|
|
653
653
|
# Request message for
|
654
|
-
# {Google::Cloud::DataCatalog::V1::DataCatalog::Client#rename_tag_template_field RenameTagTemplateField}.
|
654
|
+
# {::Google::Cloud::DataCatalog::V1::DataCatalog::Client#rename_tag_template_field RenameTagTemplateField}.
|
655
655
|
# @!attribute [rw] name
|
656
|
-
# @return [String]
|
656
|
+
# @return [::String]
|
657
657
|
# Required. The name of the tag template. Example:
|
658
658
|
#
|
659
659
|
# * projects/\\{project_id}/locations/\\{location}/tagTemplates/\\{tag_template_id}/fields/\\{tag_template_field_id}
|
660
660
|
# @!attribute [rw] new_tag_template_field_id
|
661
|
-
# @return [String]
|
661
|
+
# @return [::String]
|
662
662
|
# Required. The new ID of this tag template field. For example, `my_new_field`.
|
663
663
|
class RenameTagTemplateFieldRequest
|
664
|
-
include Google::Protobuf::MessageExts
|
665
|
-
extend Google::Protobuf::MessageExts::ClassMethods
|
664
|
+
include ::Google::Protobuf::MessageExts
|
665
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
666
666
|
end
|
667
667
|
|
668
668
|
# Request message for
|
669
|
-
# {Google::Cloud::DataCatalog::V1::DataCatalog::Client#delete_tag_template_field DeleteTagTemplateField}.
|
669
|
+
# {::Google::Cloud::DataCatalog::V1::DataCatalog::Client#delete_tag_template_field DeleteTagTemplateField}.
|
670
670
|
# @!attribute [rw] name
|
671
|
-
# @return [String]
|
671
|
+
# @return [::String]
|
672
672
|
# Required. The name of the tag template field to delete. Example:
|
673
673
|
#
|
674
674
|
# * projects/\\{project_id}/locations/\\{location}/tagTemplates/\\{tag_template_id}/fields/\\{tag_template_field_id}
|
675
675
|
# @!attribute [rw] force
|
676
|
-
# @return [Boolean]
|
676
|
+
# @return [::Boolean]
|
677
677
|
# Required. Currently, this field must always be set to `true`.
|
678
678
|
# This confirms the deletion of this field from any tags using this field.
|
679
679
|
# `force = false` will be supported in the future.
|
680
680
|
class DeleteTagTemplateFieldRequest
|
681
|
-
include Google::Protobuf::MessageExts
|
682
|
-
extend Google::Protobuf::MessageExts::ClassMethods
|
681
|
+
include ::Google::Protobuf::MessageExts
|
682
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
683
683
|
end
|
684
684
|
|
685
685
|
# Request message for
|
686
|
-
# {Google::Cloud::DataCatalog::V1::DataCatalog::Client#list_tags ListTags}.
|
686
|
+
# {::Google::Cloud::DataCatalog::V1::DataCatalog::Client#list_tags ListTags}.
|
687
687
|
# @!attribute [rw] parent
|
688
|
-
# @return [String]
|
688
|
+
# @return [::String]
|
689
689
|
# Required. The name of the Data Catalog resource to list the tags of. The resource
|
690
|
-
# could be an {Google::Cloud::DataCatalog::V1::Entry Entry} or an
|
691
|
-
# {Google::Cloud::DataCatalog::V1::EntryGroup EntryGroup}.
|
690
|
+
# could be an {::Google::Cloud::DataCatalog::V1::Entry Entry} or an
|
691
|
+
# {::Google::Cloud::DataCatalog::V1::EntryGroup EntryGroup}.
|
692
692
|
#
|
693
693
|
# Examples:
|
694
694
|
#
|
695
695
|
# * projects/\\{project_id}/locations/\\{location}/entryGroups/\\{entry_group_id}
|
696
696
|
# * projects/\\{project_id}/locations/\\{location}/entryGroups/\\{entry_group_id}/entries/\\{entry_id}
|
697
697
|
# @!attribute [rw] page_size
|
698
|
-
# @return [Integer]
|
698
|
+
# @return [::Integer]
|
699
699
|
# The maximum number of tags to return. Default is 10. Max limit is 1000.
|
700
700
|
# @!attribute [rw] page_token
|
701
|
-
# @return [String]
|
701
|
+
# @return [::String]
|
702
702
|
# Token that specifies which page is requested. If empty, the first page is
|
703
703
|
# returned.
|
704
704
|
class ListTagsRequest
|
705
|
-
include Google::Protobuf::MessageExts
|
706
|
-
extend Google::Protobuf::MessageExts::ClassMethods
|
705
|
+
include ::Google::Protobuf::MessageExts
|
706
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
707
707
|
end
|
708
708
|
|
709
709
|
# Response message for
|
710
|
-
# {Google::Cloud::DataCatalog::V1::DataCatalog::Client#list_tags ListTags}.
|
710
|
+
# {::Google::Cloud::DataCatalog::V1::DataCatalog::Client#list_tags ListTags}.
|
711
711
|
# @!attribute [rw] tags
|
712
|
-
# @return [Array
|
713
|
-
# {Google::Cloud::DataCatalog::V1::Tag Tag} details.
|
712
|
+
# @return [::Array<::Google::Cloud::DataCatalog::V1::Tag>]
|
713
|
+
# {::Google::Cloud::DataCatalog::V1::Tag Tag} details.
|
714
714
|
# @!attribute [rw] next_page_token
|
715
|
-
# @return [String]
|
715
|
+
# @return [::String]
|
716
716
|
# Token to retrieve the next page of results. It is set to empty if no items
|
717
717
|
# remain in results.
|
718
718
|
class ListTagsResponse
|
719
|
-
include Google::Protobuf::MessageExts
|
720
|
-
extend Google::Protobuf::MessageExts::ClassMethods
|
719
|
+
include ::Google::Protobuf::MessageExts
|
720
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
721
721
|
end
|
722
722
|
|
723
723
|
# Request message for
|
724
|
-
# {Google::Cloud::DataCatalog::V1::DataCatalog::Client#list_entries ListEntries}.
|
724
|
+
# {::Google::Cloud::DataCatalog::V1::DataCatalog::Client#list_entries ListEntries}.
|
725
725
|
# @!attribute [rw] parent
|
726
|
-
# @return [String]
|
726
|
+
# @return [::String]
|
727
727
|
# Required. The name of the entry group that contains the entries, which can
|
728
728
|
# be provided in URL format. Example:
|
729
729
|
#
|
730
730
|
# * projects/\\{project_id}/locations/\\{location}/entryGroups/\\{entry_group_id}
|
731
731
|
# @!attribute [rw] page_size
|
732
|
-
# @return [Integer]
|
732
|
+
# @return [::Integer]
|
733
733
|
# The maximum number of items to return. Default is 10. Max limit is 1000.
|
734
734
|
# Throws an invalid argument for `page_size > 1000`.
|
735
735
|
# @!attribute [rw] page_token
|
736
|
-
# @return [String]
|
736
|
+
# @return [::String]
|
737
737
|
# Token that specifies which page is requested. If empty, the first page is
|
738
738
|
# returned.
|
739
739
|
# @!attribute [rw] read_mask
|
740
|
-
# @return [Google::Protobuf::FieldMask]
|
740
|
+
# @return [::Google::Protobuf::FieldMask]
|
741
741
|
# The fields to return for each Entry. If not set or empty, all
|
742
742
|
# fields are returned.
|
743
743
|
# For example, setting read_mask to contain only one path "name" will cause
|
744
744
|
# ListEntries to return a list of Entries with only "name" field.
|
745
745
|
class ListEntriesRequest
|
746
|
-
include Google::Protobuf::MessageExts
|
747
|
-
extend Google::Protobuf::MessageExts::ClassMethods
|
746
|
+
include ::Google::Protobuf::MessageExts
|
747
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
748
748
|
end
|
749
749
|
|
750
750
|
# Response message for
|
751
|
-
# {Google::Cloud::DataCatalog::V1::DataCatalog::Client#list_entries ListEntries}.
|
751
|
+
# {::Google::Cloud::DataCatalog::V1::DataCatalog::Client#list_entries ListEntries}.
|
752
752
|
# @!attribute [rw] entries
|
753
|
-
# @return [Array
|
753
|
+
# @return [::Array<::Google::Cloud::DataCatalog::V1::Entry>]
|
754
754
|
# Entry details.
|
755
755
|
# @!attribute [rw] next_page_token
|
756
|
-
# @return [String]
|
756
|
+
# @return [::String]
|
757
757
|
# Token to retrieve the next page of results. It is set to empty if no items
|
758
758
|
# remain in results.
|
759
759
|
class ListEntriesResponse
|
760
|
-
include Google::Protobuf::MessageExts
|
761
|
-
extend Google::Protobuf::MessageExts::ClassMethods
|
760
|
+
include ::Google::Protobuf::MessageExts
|
761
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
762
762
|
end
|
763
763
|
|
764
764
|
# Entry resources in Data Catalog can be of different types e.g. a BigQuery
|