google-cloud-data_catalog-v1 0.8.2 → 0.10.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/.yardopts +1 -1
- data/AUTHENTICATION.md +7 -25
- data/README.md +1 -1
- data/lib/google/cloud/data_catalog/v1/data_catalog/client.rb +972 -83
- data/lib/google/cloud/data_catalog/v1/policy_tag_manager/client.rb +273 -41
- data/lib/google/cloud/data_catalog/v1/policy_tag_manager_serialization/client.rb +60 -9
- data/lib/google/cloud/data_catalog/v1/version.rb +1 -1
- data/lib/google/cloud/datacatalog/v1/bigquery_pb.rb +1 -1
- data/lib/google/cloud/datacatalog/v1/common_pb.rb +6 -0
- data/lib/google/cloud/datacatalog/v1/data_source_pb.rb +1 -1
- data/lib/google/cloud/datacatalog/v1/datacatalog_pb.rb +47 -2
- data/lib/google/cloud/datacatalog/v1/datacatalog_services_pb.rb +27 -3
- data/lib/google/cloud/datacatalog/v1/gcs_fileset_spec_pb.rb +2 -2
- data/lib/google/cloud/datacatalog/v1/policytagmanager_pb.rb +2 -2
- data/lib/google/cloud/datacatalog/v1/policytagmanager_services_pb.rb +1 -1
- data/lib/google/cloud/datacatalog/v1/policytagmanagerserialization_pb.rb +3 -3
- data/lib/google/cloud/datacatalog/v1/policytagmanagerserialization_services_pb.rb +1 -1
- data/lib/google/cloud/datacatalog/v1/schema_pb.rb +1 -1
- data/lib/google/cloud/datacatalog/v1/search_pb.rb +4 -2
- data/lib/google/cloud/datacatalog/v1/table_spec_pb.rb +3 -2
- data/lib/google/cloud/datacatalog/v1/tags_pb.rb +2 -2
- data/lib/google/cloud/datacatalog/v1/timestamps_pb.rb +2 -2
- data/lib/google/cloud/datacatalog/v1/usage_pb.rb +1 -1
- data/proto_docs/google/api/resource.rb +10 -71
- data/proto_docs/google/cloud/datacatalog/v1/common.rb +12 -0
- data/proto_docs/google/cloud/datacatalog/v1/datacatalog.rb +133 -12
- data/proto_docs/google/cloud/datacatalog/v1/policytagmanager.rb +2 -4
- data/proto_docs/google/cloud/datacatalog/v1/search.rb +7 -0
- data/proto_docs/google/cloud/datacatalog/v1/table_spec.rb +3 -0
- data/proto_docs/google/cloud/datacatalog/v1/tags.rb +4 -25
- metadata +3 -3
@@ -34,7 +34,8 @@ module Google
|
|
34
34
|
# @return [::String]
|
35
35
|
# Optional. The query string with a minimum of 3 characters and specific syntax.
|
36
36
|
# For more information, see
|
37
|
-
# [Data Catalog search
|
37
|
+
# [Data Catalog search
|
38
|
+
# syntax](https://cloud.google.com/data-catalog/docs/how-to/search-reference).
|
38
39
|
#
|
39
40
|
# An empty query string returns all data assets (in the specified scope)
|
40
41
|
# that you have access to.
|
@@ -68,6 +69,7 @@ module Google
|
|
68
69
|
#
|
69
70
|
# * `relevance` that can only be descending
|
70
71
|
# * `last_modified_timestamp [asc|desc]` with descending (`desc`) as default
|
72
|
+
# * `default` that can only be descending
|
71
73
|
#
|
72
74
|
# If this parameter is omitted, it defaults to the descending `relevance`.
|
73
75
|
class SearchCatalogRequest
|
@@ -107,17 +109,15 @@ module Google
|
|
107
109
|
# `SearchCatalogResponse.unreachable` field. To get additional information
|
108
110
|
# on the error, repeat the search request and set the location name as the
|
109
111
|
# value of this parameter.
|
110
|
-
# @!attribute [rw]
|
112
|
+
# @!attribute [rw] starred_only
|
111
113
|
# @return [::Boolean]
|
112
|
-
# Optional. If `true`,
|
113
|
-
# templates][google.cloud.datacatalog.v1.TagTemplate.is_publicly_readable]
|
114
|
-
# in the search results. By default, they are included only if you have
|
115
|
-
# explicit permissions on them to view them. For example, if you are the
|
116
|
-
# owner.
|
114
|
+
# Optional. If `true`, search only among starred entries.
|
117
115
|
#
|
118
|
-
#
|
119
|
-
#
|
120
|
-
#
|
116
|
+
# By default, all results are returned, starred or not.
|
117
|
+
# @!attribute [rw] include_public_tag_templates
|
118
|
+
# @return [::Boolean]
|
119
|
+
# Optional. This field is deprecated. The search mechanism for public and private tag
|
120
|
+
# templates is the same.
|
121
121
|
class Scope
|
122
122
|
include ::Google::Protobuf::MessageExts
|
123
123
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -424,6 +424,7 @@ module Google
|
|
424
424
|
# and read-only afterwards. Can be used for search and lookup of the entries.
|
425
425
|
#
|
426
426
|
#
|
427
|
+
#
|
427
428
|
# FQNs take two forms:
|
428
429
|
#
|
429
430
|
# * For non-regionalized resources:
|
@@ -519,6 +520,9 @@ module Google
|
|
519
520
|
# (CR), and page breaks (FF).
|
520
521
|
# The maximum size is 2000 bytes when encoded in UTF-8.
|
521
522
|
# Default value is an empty string.
|
523
|
+
# @!attribute [rw] business_context
|
524
|
+
# @return [::Google::Cloud::DataCatalog::V1::BusinessContext]
|
525
|
+
# Business Context of the entry. Not supported for BigQuery datasets.
|
522
526
|
# @!attribute [rw] schema
|
523
527
|
# @return [::Google::Cloud::DataCatalog::V1::Schema]
|
524
528
|
# Schema of the entry. An entry might not have any schema attached to it.
|
@@ -543,6 +547,9 @@ module Google
|
|
543
547
|
# @!attribute [r] data_source
|
544
548
|
# @return [::Google::Cloud::DataCatalog::V1::DataSource]
|
545
549
|
# Output only. Physical location of the entry.
|
550
|
+
# @!attribute [r] personal_details
|
551
|
+
# @return [::Google::Cloud::DataCatalog::V1::PersonalDetails]
|
552
|
+
# Output only. Additional information related to the entry. Private to the current user.
|
546
553
|
class Entry
|
547
554
|
include ::Google::Protobuf::MessageExts
|
548
555
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -663,6 +670,55 @@ module Google
|
|
663
670
|
end
|
664
671
|
end
|
665
672
|
|
673
|
+
# Business Context of the entry.
|
674
|
+
# @!attribute [rw] entry_overview
|
675
|
+
# @return [::Google::Cloud::DataCatalog::V1::EntryOverview]
|
676
|
+
# Entry overview fields for rich text descriptions of entries.
|
677
|
+
# @!attribute [rw] contacts
|
678
|
+
# @return [::Google::Cloud::DataCatalog::V1::Contacts]
|
679
|
+
# Contact people for the entry.
|
680
|
+
class BusinessContext
|
681
|
+
include ::Google::Protobuf::MessageExts
|
682
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
683
|
+
end
|
684
|
+
|
685
|
+
# Entry overview fields for rich text descriptions of entries.
|
686
|
+
# @!attribute [rw] overview
|
687
|
+
# @return [::String]
|
688
|
+
# Entry overview with support for rich text.
|
689
|
+
#
|
690
|
+
# The overview must only contain Unicode characters, and should be
|
691
|
+
# formatted using HTML.
|
692
|
+
# The maximum length is 10 MiB as this value holds HTML descriptions
|
693
|
+
# including encoded images. The maximum length of the text without images
|
694
|
+
# is 100 KiB.
|
695
|
+
class EntryOverview
|
696
|
+
include ::Google::Protobuf::MessageExts
|
697
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
698
|
+
end
|
699
|
+
|
700
|
+
# Contact people for the entry.
|
701
|
+
# @!attribute [rw] people
|
702
|
+
# @return [::Array<::Google::Cloud::DataCatalog::V1::Contacts::Person>]
|
703
|
+
# The list of contact people for the entry.
|
704
|
+
class Contacts
|
705
|
+
include ::Google::Protobuf::MessageExts
|
706
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
707
|
+
|
708
|
+
# A contact person for the entry.
|
709
|
+
# @!attribute [rw] designation
|
710
|
+
# @return [::String]
|
711
|
+
# Designation of the person, for example, Data Steward.
|
712
|
+
# @!attribute [rw] email
|
713
|
+
# @return [::String]
|
714
|
+
# Email of the person in the format of `john.doe@example.com`,
|
715
|
+
# `<john.doe@example.com>`, or `John Doe<john.doe@example.com>`.
|
716
|
+
class Person
|
717
|
+
include ::Google::Protobuf::MessageExts
|
718
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
719
|
+
end
|
720
|
+
end
|
721
|
+
|
666
722
|
# Entry group metadata.
|
667
723
|
#
|
668
724
|
# An `EntryGroup` resource represents a logical grouping of zero or more
|
@@ -729,11 +785,14 @@ module Google
|
|
729
785
|
# @!attribute [rw] update_mask
|
730
786
|
# @return [::Google::Protobuf::FieldMask]
|
731
787
|
# Names of fields whose values to overwrite on a tag template. Currently,
|
732
|
-
# only `display_name` can be overwritten.
|
788
|
+
# only `display_name` and `is_publicly_readable` can be overwritten.
|
733
789
|
#
|
734
790
|
# If this parameter is absent or empty, all modifiable fields
|
735
791
|
# are overwritten. If such fields are non-required and omitted in the
|
736
792
|
# request body, their values are emptied.
|
793
|
+
#
|
794
|
+
# Note: Updating the `is_publicly_readable` field may require up to 12
|
795
|
+
# hours to take effect in search results.
|
737
796
|
class UpdateTagTemplateRequest
|
738
797
|
include ::Google::Protobuf::MessageExts
|
739
798
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -860,7 +919,7 @@ module Google
|
|
860
919
|
# {::Google::Cloud::DataCatalog::V1::DataCatalog::Client#rename_tag_template_field RenameTagTemplateField}.
|
861
920
|
# @!attribute [rw] name
|
862
921
|
# @return [::String]
|
863
|
-
# Required. The name of the tag template.
|
922
|
+
# Required. The name of the tag template field.
|
864
923
|
# @!attribute [rw] new_tag_template_field_id
|
865
924
|
# @return [::String]
|
866
925
|
# Required. The new ID of this tag template field. For example, `my_new_field`.
|
@@ -973,6 +1032,68 @@ module Google
|
|
973
1032
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
974
1033
|
end
|
975
1034
|
|
1035
|
+
# Request message for
|
1036
|
+
# {::Google::Cloud::DataCatalog::V1::DataCatalog::Client#star_entry StarEntry}.
|
1037
|
+
# @!attribute [rw] name
|
1038
|
+
# @return [::String]
|
1039
|
+
# Required. The name of the entry to mark as starred.
|
1040
|
+
class StarEntryRequest
|
1041
|
+
include ::Google::Protobuf::MessageExts
|
1042
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
1043
|
+
end
|
1044
|
+
|
1045
|
+
# Response message for
|
1046
|
+
# {::Google::Cloud::DataCatalog::V1::DataCatalog::Client#star_entry StarEntry}.
|
1047
|
+
# Empty for now
|
1048
|
+
class StarEntryResponse
|
1049
|
+
include ::Google::Protobuf::MessageExts
|
1050
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
1051
|
+
end
|
1052
|
+
|
1053
|
+
# Request message for
|
1054
|
+
# {::Google::Cloud::DataCatalog::V1::DataCatalog::Client#unstar_entry UnstarEntry}.
|
1055
|
+
# @!attribute [rw] name
|
1056
|
+
# @return [::String]
|
1057
|
+
# Required. The name of the entry to mark as **not** starred.
|
1058
|
+
class UnstarEntryRequest
|
1059
|
+
include ::Google::Protobuf::MessageExts
|
1060
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
1061
|
+
end
|
1062
|
+
|
1063
|
+
# Response message for
|
1064
|
+
# {::Google::Cloud::DataCatalog::V1::DataCatalog::Client#unstar_entry UnstarEntry}.
|
1065
|
+
# Empty for now
|
1066
|
+
class UnstarEntryResponse
|
1067
|
+
include ::Google::Protobuf::MessageExts
|
1068
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
1069
|
+
end
|
1070
|
+
|
1071
|
+
# Request message for
|
1072
|
+
# {::Google::Cloud::DataCatalog::V1::DataCatalog::Client#modify_entry_overview ModifyEntryOverview}.
|
1073
|
+
# @!attribute [rw] name
|
1074
|
+
# @return [::String]
|
1075
|
+
# Required. The full resource name of the entry.
|
1076
|
+
# @!attribute [rw] entry_overview
|
1077
|
+
# @return [::Google::Cloud::DataCatalog::V1::EntryOverview]
|
1078
|
+
# Required. The new value for the Entry Overview.
|
1079
|
+
class ModifyEntryOverviewRequest
|
1080
|
+
include ::Google::Protobuf::MessageExts
|
1081
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
1082
|
+
end
|
1083
|
+
|
1084
|
+
# Request message for
|
1085
|
+
# {::Google::Cloud::DataCatalog::V1::DataCatalog::Client#modify_entry_contacts ModifyEntryContacts}.
|
1086
|
+
# @!attribute [rw] name
|
1087
|
+
# @return [::String]
|
1088
|
+
# Required. The full resource name of the entry.
|
1089
|
+
# @!attribute [rw] contacts
|
1090
|
+
# @return [::Google::Cloud::DataCatalog::V1::Contacts]
|
1091
|
+
# Required. The new value for the Contacts.
|
1092
|
+
class ModifyEntryContactsRequest
|
1093
|
+
include ::Google::Protobuf::MessageExts
|
1094
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
1095
|
+
end
|
1096
|
+
|
976
1097
|
# The enum field that lists all the types of entry resources in Data
|
977
1098
|
# Catalog. For example, a BigQuery table entry has the `TABLE` type.
|
978
1099
|
module EntryType
|
@@ -105,8 +105,7 @@ module Google
|
|
105
105
|
# @return [::String]
|
106
106
|
# Output only. Resource name of this policy tag in the URL format.
|
107
107
|
#
|
108
|
-
# The policy tag manager generates unique taxonomy IDs and policy tag IDs
|
109
|
-
# /><br />
|
108
|
+
# The policy tag manager generates unique taxonomy IDs and policy tag IDs.
|
110
109
|
# @!attribute [rw] display_name
|
111
110
|
# @return [::String]
|
112
111
|
# Required. User-defined name of this policy tag.
|
@@ -228,8 +227,7 @@ module Google
|
|
228
227
|
# {::Google::Cloud::DataCatalog::V1::PolicyTagManager::Client#create_policy_tag CreatePolicyTag}.
|
229
228
|
# @!attribute [rw] parent
|
230
229
|
# @return [::String]
|
231
|
-
# Required. Resource name of the taxonomy that the policy tag will belong to
|
232
|
-
# />
|
230
|
+
# Required. Resource name of the taxonomy that the policy tag will belong to.
|
233
231
|
# @!attribute [rw] policy_tag
|
234
232
|
# @return [::Google::Cloud::DataCatalog::V1::PolicyTag]
|
235
233
|
# The policy tag to create.
|
@@ -83,6 +83,13 @@ module Google
|
|
83
83
|
# Example for a DPMS table:
|
84
84
|
#
|
85
85
|
# `dataproc_metastore:PROJECT_ID.LOCATION_ID.INSTANCE_ID.DATABASE_ID.TABLE_ID`
|
86
|
+
# @!attribute [rw] display_name
|
87
|
+
# @return [::String]
|
88
|
+
# The display name of the result.
|
89
|
+
# @!attribute [rw] description
|
90
|
+
# @return [::String]
|
91
|
+
# Entry description that can consist of several sentences or paragraphs that
|
92
|
+
# describe entry contents.
|
86
93
|
class SearchCatalogResult
|
87
94
|
include ::Google::Protobuf::MessageExts
|
88
95
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -83,6 +83,9 @@ module Google
|
|
83
83
|
# @!attribute [r] shard_count
|
84
84
|
# @return [::Integer]
|
85
85
|
# Output only. Total number of shards.
|
86
|
+
# @!attribute [r] latest_shard_resource
|
87
|
+
# @return [::String]
|
88
|
+
# Output only. BigQuery resource name of the latest shard.
|
86
89
|
class BigQueryDateShardedSpec
|
87
90
|
include ::Google::Protobuf::MessageExts
|
88
91
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -149,33 +149,12 @@ module Google
|
|
149
149
|
# The maximum length is 200 characters.
|
150
150
|
# @!attribute [rw] is_publicly_readable
|
151
151
|
# @return [::Boolean]
|
152
|
-
# Indicates whether this
|
152
|
+
# Indicates whether tags created with this template are public. Public tags
|
153
|
+
# do not require tag template access to appear in
|
154
|
+
# [ListTags][google.cloud.datacatalog.v1.ListTags] API response.
|
153
155
|
#
|
154
|
-
#
|
155
|
-
# This means that:
|
156
|
-
#
|
157
|
-
# * Every user can use this tag template to tag an entry.
|
158
|
-
# * If an entry is tagged using the tag template, the tag is always
|
159
|
-
# shown in the response to ``ListTags`` called on the entry.
|
160
|
-
# * To get the template using the GetTagTemplate method, you
|
161
|
-
# need view access either on the project or the organization the tag
|
162
|
-
# template resides in but no other permission is needed.
|
163
|
-
# * Operations on the tag template other than viewing (for example,
|
164
|
-
# editing IAM policies) follow standard IAM structures.
|
165
|
-
#
|
166
|
-
# Tags created with a public tag template are referred to as public tags.
|
167
|
-
#
|
168
|
-
# You can search for a public tag by value with a
|
156
|
+
# Additionally, you can search for a public tag by value with a
|
169
157
|
# simple search query instead of using a ``tag:`` predicate.
|
170
|
-
#
|
171
|
-
# Public tag templates may not appear in search results depending on scope,
|
172
|
-
# see:
|
173
|
-
# {::Google::Cloud::DataCatalog::V1::SearchCatalogRequest::Scope#include_public_tag_templates include_public_tag_templates}
|
174
|
-
#
|
175
|
-
# Note: If an [IAM domain
|
176
|
-
# restriction](https://cloud.google.com/resource-manager/docs/organization-policy/restricting-domains)
|
177
|
-
# is configured in the tag template's location, the public access will not be
|
178
|
-
# enabled but the simple search for tag values will still work.
|
179
158
|
# @!attribute [rw] fields
|
180
159
|
# @return [::Google::Protobuf::Map{::String => ::Google::Cloud::DataCatalog::V1::TagTemplateField}]
|
181
160
|
# Required. Map of tag template field IDs to the settings for the field.
|
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: google-cloud-data_catalog-v1
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 0.
|
4
|
+
version: 0.10.0
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Google LLC
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date:
|
11
|
+
date: 2022-02-16 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: gapic-common
|
@@ -264,7 +264,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
|
|
264
264
|
- !ruby/object:Gem::Version
|
265
265
|
version: '0'
|
266
266
|
requirements: []
|
267
|
-
rubygems_version: 3.
|
267
|
+
rubygems_version: 3.3.5
|
268
268
|
signing_key:
|
269
269
|
specification_version: 4
|
270
270
|
summary: API Client library for the Data Catalog V1 API
|