google-cloud-data_catalog-v1 0.3.0 → 0.3.1

Sign up to get free protection for your applications and to get access to all the features.
@@ -23,7 +23,7 @@ module Google
23
23
  module V1
24
24
  # Describes a Cloud Storage fileset entry.
25
25
  # @!attribute [rw] file_patterns
26
- # @return [Array<String>]
26
+ # @return [::Array<::String>]
27
27
  # Required. Patterns to identify a set of files in Google Cloud Storage. See [Cloud
28
28
  # Storage documentation](/storage/docs/gsutil/addlhelp/WildcardNames) for
29
29
  # more information. Note that bucket wildcards are currently not supported.
@@ -51,27 +51,27 @@ module Google
51
51
  #
52
52
  # * `gs://bucket_name/[a-m]??.j*g`
53
53
  # @!attribute [r] sample_gcs_file_specs
54
- # @return [Array<Google::Cloud::DataCatalog::V1::GcsFileSpec>]
54
+ # @return [::Array<::Google::Cloud::DataCatalog::V1::GcsFileSpec>]
55
55
  # Output only. Sample files contained in this fileset, not all files
56
56
  # contained in this fileset are represented here.
57
57
  class GcsFilesetSpec
58
- include Google::Protobuf::MessageExts
59
- extend Google::Protobuf::MessageExts::ClassMethods
58
+ include ::Google::Protobuf::MessageExts
59
+ extend ::Google::Protobuf::MessageExts::ClassMethods
60
60
  end
61
61
 
62
62
  # Specifications of a single file in Cloud Storage.
63
63
  # @!attribute [rw] file_path
64
- # @return [String]
64
+ # @return [::String]
65
65
  # Required. The full file path. Example: `gs://bucket_name/a/b.txt`.
66
66
  # @!attribute [r] gcs_timestamps
67
- # @return [Google::Cloud::DataCatalog::V1::SystemTimestamps]
67
+ # @return [::Google::Cloud::DataCatalog::V1::SystemTimestamps]
68
68
  # Output only. Timestamps about the Cloud Storage file.
69
69
  # @!attribute [r] size_bytes
70
- # @return [Integer]
70
+ # @return [::Integer]
71
71
  # Output only. The size of the file, in bytes.
72
72
  class GcsFileSpec
73
- include Google::Protobuf::MessageExts
74
- extend Google::Protobuf::MessageExts::ClassMethods
73
+ include ::Google::Protobuf::MessageExts
74
+ extend ::Google::Protobuf::MessageExts::ClassMethods
75
75
  end
76
76
  end
77
77
  end
@@ -23,36 +23,36 @@ module Google
23
23
  module V1
24
24
  # Represents a schema (e.g. BigQuery, GoogleSQL, Avro schema).
25
25
  # @!attribute [rw] columns
26
- # @return [Array<Google::Cloud::DataCatalog::V1::ColumnSchema>]
26
+ # @return [::Array<::Google::Cloud::DataCatalog::V1::ColumnSchema>]
27
27
  # Required. Schema of columns. A maximum of 10,000 columns and sub-columns can be
28
28
  # specified.
29
29
  class Schema
30
- include Google::Protobuf::MessageExts
31
- extend Google::Protobuf::MessageExts::ClassMethods
30
+ include ::Google::Protobuf::MessageExts
31
+ extend ::Google::Protobuf::MessageExts::ClassMethods
32
32
  end
33
33
 
34
34
  # Representation of a column within a schema. Columns could be nested inside
35
35
  # other columns.
36
36
  # @!attribute [rw] column
37
- # @return [String]
37
+ # @return [::String]
38
38
  # Required. Name of the column.
39
39
  # @!attribute [rw] type
40
- # @return [String]
40
+ # @return [::String]
41
41
  # Required. Type of the column.
42
42
  # @!attribute [rw] description
43
- # @return [String]
43
+ # @return [::String]
44
44
  # Optional. Description of the column. Default value is an empty string.
45
45
  # @!attribute [rw] mode
46
- # @return [String]
46
+ # @return [::String]
47
47
  # Optional. A column's mode indicates whether the values in this column are required,
48
48
  # nullable, etc. Only `NULLABLE`, `REQUIRED` and `REPEATED` are supported.
49
49
  # Default mode is `NULLABLE`.
50
50
  # @!attribute [rw] subcolumns
51
- # @return [Array<Google::Cloud::DataCatalog::V1::ColumnSchema>]
51
+ # @return [::Array<::Google::Cloud::DataCatalog::V1::ColumnSchema>]
52
52
  # Optional. Schema of sub-columns. A column can have zero or more sub-columns.
53
53
  class ColumnSchema
54
- include Google::Protobuf::MessageExts
55
- extend Google::Protobuf::MessageExts::ClassMethods
54
+ include ::Google::Protobuf::MessageExts
55
+ extend ::Google::Protobuf::MessageExts::ClassMethods
56
56
  end
57
57
  end
58
58
  end
@@ -24,40 +24,40 @@ module Google
24
24
  # A result that appears in the response of a search request. Each result
25
25
  # captures details of one entry that matches the search.
26
26
  # @!attribute [rw] search_result_type
27
- # @return [Google::Cloud::DataCatalog::V1::SearchResultType]
27
+ # @return [::Google::Cloud::DataCatalog::V1::SearchResultType]
28
28
  # Type of the search result. This field can be used to determine which Get
29
29
  # method to call to fetch the full resource.
30
30
  # @!attribute [rw] search_result_subtype
31
- # @return [String]
31
+ # @return [::String]
32
32
  # Sub-type of the search result. This is a dot-delimited description of the
33
33
  # resource's full type, and is the same as the value callers would provide in
34
34
  # the "type" search facet. Examples: `entry.table`, `entry.dataStream`,
35
35
  # `tagTemplate`.
36
36
  # @!attribute [rw] relative_resource_name
37
- # @return [String]
37
+ # @return [::String]
38
38
  # The relative resource name of the resource in URL format.
39
39
  # Examples:
40
40
  #
41
41
  # * `projects/{project_id}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id}`
42
42
  # * `projects/{project_id}/tagTemplates/{tag_template_id}`
43
43
  # @!attribute [rw] linked_resource
44
- # @return [String]
44
+ # @return [::String]
45
45
  # The full name of the cloud resource the entry belongs to. See:
46
46
  # https://cloud.google.com/apis/design/resource_names#full_resource_name.
47
47
  # Example:
48
48
  #
49
49
  # * `//bigquery.googleapis.com/projects/projectId/datasets/datasetId/tables/tableId`
50
50
  # @!attribute [r] integrated_system
51
- # @return [Google::Cloud::DataCatalog::V1::IntegratedSystem]
51
+ # @return [::Google::Cloud::DataCatalog::V1::IntegratedSystem]
52
52
  # Output only. This field indicates the entry's source system that Data Catalog
53
53
  # integrates with, such as BigQuery or Cloud Pub/Sub.
54
54
  # @!attribute [rw] user_specified_system
55
- # @return [String]
55
+ # @return [::String]
56
56
  # This field indicates the entry's source system that Data Catalog does not
57
57
  # integrate with.
58
58
  class SearchCatalogResult
59
- include Google::Protobuf::MessageExts
60
- extend Google::Protobuf::MessageExts::ClassMethods
59
+ include ::Google::Protobuf::MessageExts
60
+ extend ::Google::Protobuf::MessageExts::ClassMethods
61
61
  end
62
62
 
63
63
  # The different types of resources that can be returned in search.
@@ -65,13 +65,13 @@ module Google
65
65
  # Default unknown type.
66
66
  SEARCH_RESULT_TYPE_UNSPECIFIED = 0
67
67
 
68
- # An {Google::Cloud::DataCatalog::V1::Entry Entry}.
68
+ # An {::Google::Cloud::DataCatalog::V1::Entry Entry}.
69
69
  ENTRY = 1
70
70
 
71
- # A {Google::Cloud::DataCatalog::V1::TagTemplate TagTemplate}.
71
+ # A {::Google::Cloud::DataCatalog::V1::TagTemplate TagTemplate}.
72
72
  TAG_TEMPLATE = 2
73
73
 
74
- # An {Google::Cloud::DataCatalog::V1::EntryGroup EntryGroup}.
74
+ # An {::Google::Cloud::DataCatalog::V1::EntryGroup EntryGroup}.
75
75
  ENTRY_GROUP = 3
76
76
  end
77
77
  end
@@ -23,62 +23,62 @@ module Google
23
23
  module V1
24
24
  # Describes a BigQuery table.
25
25
  # @!attribute [r] table_source_type
26
- # @return [Google::Cloud::DataCatalog::V1::TableSourceType]
26
+ # @return [::Google::Cloud::DataCatalog::V1::TableSourceType]
27
27
  # Output only. The table source type.
28
28
  # @!attribute [rw] view_spec
29
- # @return [Google::Cloud::DataCatalog::V1::ViewSpec]
29
+ # @return [::Google::Cloud::DataCatalog::V1::ViewSpec]
30
30
  # Table view specification. This field should only be populated if
31
31
  # `table_source_type` is `BIGQUERY_VIEW`.
32
32
  # @!attribute [rw] table_spec
33
- # @return [Google::Cloud::DataCatalog::V1::TableSpec]
33
+ # @return [::Google::Cloud::DataCatalog::V1::TableSpec]
34
34
  # Spec of a BigQuery table. This field should only be populated if
35
35
  # `table_source_type` is `BIGQUERY_TABLE`.
36
36
  class BigQueryTableSpec
37
- include Google::Protobuf::MessageExts
38
- extend Google::Protobuf::MessageExts::ClassMethods
37
+ include ::Google::Protobuf::MessageExts
38
+ extend ::Google::Protobuf::MessageExts::ClassMethods
39
39
  end
40
40
 
41
41
  # Table view specification.
42
42
  # @!attribute [r] view_query
43
- # @return [String]
43
+ # @return [::String]
44
44
  # Output only. The query that defines the table view.
45
45
  class ViewSpec
46
- include Google::Protobuf::MessageExts
47
- extend Google::Protobuf::MessageExts::ClassMethods
46
+ include ::Google::Protobuf::MessageExts
47
+ extend ::Google::Protobuf::MessageExts::ClassMethods
48
48
  end
49
49
 
50
50
  # Normal BigQuery table spec.
51
51
  # @!attribute [r] grouped_entry
52
- # @return [String]
52
+ # @return [::String]
53
53
  # Output only. If the table is a dated shard, i.e., with name pattern `[prefix]YYYYMMDD`,
54
54
  # `grouped_entry` is the Data Catalog resource name of the date sharded
55
55
  # grouped entry, for example,
56
56
  # `projects/{project_id}/locations/{location}/entrygroups/{entry_group_id}/entries/{entry_id}`.
57
57
  # Otherwise, `grouped_entry` is empty.
58
58
  class TableSpec
59
- include Google::Protobuf::MessageExts
60
- extend Google::Protobuf::MessageExts::ClassMethods
59
+ include ::Google::Protobuf::MessageExts
60
+ extend ::Google::Protobuf::MessageExts::ClassMethods
61
61
  end
62
62
 
63
63
  # Spec for a group of BigQuery tables with name pattern `[prefix]YYYYMMDD`.
64
64
  # Context:
65
65
  # https://cloud.google.com/bigquery/docs/partitioned-tables#partitioning_versus_sharding
66
66
  # @!attribute [r] dataset
67
- # @return [String]
67
+ # @return [::String]
68
68
  # Output only. The Data Catalog resource name of the dataset entry the current table
69
69
  # belongs to, for example,
70
70
  # `projects/{project_id}/locations/{location}/entrygroups/{entry_group_id}/entries/{entry_id}`.
71
71
  # @!attribute [r] table_prefix
72
- # @return [String]
72
+ # @return [::String]
73
73
  # Output only. The table name prefix of the shards. The name of any given shard is
74
74
  # `[table_prefix]YYYYMMDD`, for example, for shard `MyTable20180101`, the
75
75
  # `table_prefix` is `MyTable`.
76
76
  # @!attribute [r] shard_count
77
- # @return [Integer]
77
+ # @return [::Integer]
78
78
  # Output only. Total number of shards.
79
79
  class BigQueryDateShardedSpec
80
- include Google::Protobuf::MessageExts
81
- extend Google::Protobuf::MessageExts::ClassMethods
80
+ include ::Google::Protobuf::MessageExts
81
+ extend ::Google::Protobuf::MessageExts::ClassMethods
82
82
  end
83
83
 
84
84
  # Table source type.
@@ -28,7 +28,7 @@ module Google
28
28
  # IAM](https://cloud.google.com/data-catalog/docs/concepts/iam) for information
29
29
  # on the permissions needed to create or view tags.
30
30
  # @!attribute [rw] name
31
- # @return [String]
31
+ # @return [::String]
32
32
  # The resource name of the tag in URL format. Example:
33
33
  #
34
34
  # * projects/\\{project_id}/locations/\\{location}/entrygroups/\\{entry_group_id}/entries/\\{entry_id}/tags/\\{tag_id}
@@ -36,17 +36,17 @@ module Google
36
36
  # where `tag_id` is a system-generated identifier.
37
37
  # Note that this Tag may not actually be stored in the location in this name.
38
38
  # @!attribute [rw] template
39
- # @return [String]
39
+ # @return [::String]
40
40
  # Required. The resource name of the tag template that this tag uses. Example:
41
41
  #
42
42
  # * projects/\\{project_id}/locations/\\{location}/tagTemplates/\\{tag_template_id}
43
43
  #
44
44
  # This field cannot be modified after creation.
45
45
  # @!attribute [r] template_display_name
46
- # @return [String]
46
+ # @return [::String]
47
47
  # Output only. The display name of the tag template.
48
48
  # @!attribute [rw] column
49
- # @return [String]
49
+ # @return [::String]
50
50
  # Resources like Entry can have schemas associated with them. This scope
51
51
  # allows users to attach tags to an individual column based on that schema.
52
52
  #
@@ -55,63 +55,63 @@ module Google
55
55
  #
56
56
  # * `outer_column.inner_column`
57
57
  # @!attribute [rw] fields
58
- # @return [Google::Protobuf::Map{String => Google::Cloud::DataCatalog::V1::TagField}]
58
+ # @return [::Google::Protobuf::Map{::String => ::Google::Cloud::DataCatalog::V1::TagField}]
59
59
  # Required. This maps the ID of a tag field to the value of and additional information
60
60
  # about that field. Valid field IDs are defined by the tag's template. A tag
61
61
  # must have at least 1 field and at most 500 fields.
62
62
  class Tag
63
- include Google::Protobuf::MessageExts
64
- extend Google::Protobuf::MessageExts::ClassMethods
63
+ include ::Google::Protobuf::MessageExts
64
+ extend ::Google::Protobuf::MessageExts::ClassMethods
65
65
 
66
66
  # @!attribute [rw] key
67
- # @return [String]
67
+ # @return [::String]
68
68
  # @!attribute [rw] value
69
- # @return [Google::Cloud::DataCatalog::V1::TagField]
69
+ # @return [::Google::Cloud::DataCatalog::V1::TagField]
70
70
  class FieldsEntry
71
- include Google::Protobuf::MessageExts
72
- extend Google::Protobuf::MessageExts::ClassMethods
71
+ include ::Google::Protobuf::MessageExts
72
+ extend ::Google::Protobuf::MessageExts::ClassMethods
73
73
  end
74
74
  end
75
75
 
76
76
  # Contains the value and supporting information for a field within
77
- # a {Google::Cloud::DataCatalog::V1::Tag Tag}.
77
+ # a {::Google::Cloud::DataCatalog::V1::Tag Tag}.
78
78
  # @!attribute [r] display_name
79
- # @return [String]
79
+ # @return [::String]
80
80
  # Output only. The display name of this field.
81
81
  # @!attribute [rw] double_value
82
- # @return [Float]
82
+ # @return [::Float]
83
83
  # Holds the value for a tag field with double type.
84
84
  # @!attribute [rw] string_value
85
- # @return [String]
85
+ # @return [::String]
86
86
  # Holds the value for a tag field with string type.
87
87
  # @!attribute [rw] bool_value
88
- # @return [Boolean]
88
+ # @return [::Boolean]
89
89
  # Holds the value for a tag field with boolean type.
90
90
  # @!attribute [rw] timestamp_value
91
- # @return [Google::Protobuf::Timestamp]
91
+ # @return [::Google::Protobuf::Timestamp]
92
92
  # Holds the value for a tag field with timestamp type.
93
93
  # @!attribute [rw] enum_value
94
- # @return [Google::Cloud::DataCatalog::V1::TagField::EnumValue]
94
+ # @return [::Google::Cloud::DataCatalog::V1::TagField::EnumValue]
95
95
  # Holds the value for a tag field with enum type. This value must be
96
96
  # one of the allowed values in the definition of this enum.
97
97
  # @!attribute [r] order
98
- # @return [Integer]
98
+ # @return [::Integer]
99
99
  # Output only. The order of this field with respect to other fields in this tag. It can be
100
- # set in {Google::Cloud::DataCatalog::V1::TagTemplateField#order Tag}. For
100
+ # set in {::Google::Cloud::DataCatalog::V1::TagTemplateField#order Tag}. For
101
101
  # example, a higher value can indicate a more important field. The value can
102
102
  # be negative. Multiple fields can have the same order, and field orders
103
103
  # within a tag do not have to be sequential.
104
104
  class TagField
105
- include Google::Protobuf::MessageExts
106
- extend Google::Protobuf::MessageExts::ClassMethods
105
+ include ::Google::Protobuf::MessageExts
106
+ extend ::Google::Protobuf::MessageExts::ClassMethods
107
107
 
108
108
  # Holds an enum value.
109
109
  # @!attribute [rw] display_name
110
- # @return [String]
110
+ # @return [::String]
111
111
  # The display name of the enum value.
112
112
  class EnumValue
113
- include Google::Protobuf::MessageExts
114
- extend Google::Protobuf::MessageExts::ClassMethods
113
+ include ::Google::Protobuf::MessageExts
114
+ extend ::Google::Protobuf::MessageExts::ClassMethods
115
115
  end
116
116
  end
117
117
 
@@ -124,7 +124,7 @@ module Google
124
124
  # User](https://cloud.google.com/data-catalog/docs/how-to/template-user) role,
125
125
  # which includes permission to use the tag template to tag resources.
126
126
  # @!attribute [rw] name
127
- # @return [String]
127
+ # @return [::String]
128
128
  # The resource name of the tag template in URL format. Example:
129
129
  #
130
130
  # * projects/\\{project_id}/locations/\\{location}/tagTemplates/\\{tag_template_id}
@@ -132,10 +132,10 @@ module Google
132
132
  # Note that this TagTemplate and its child resources may not actually be
133
133
  # stored in the location in this name.
134
134
  # @!attribute [rw] display_name
135
- # @return [String]
135
+ # @return [::String]
136
136
  # The display name for this template. Defaults to an empty string.
137
137
  # @!attribute [rw] fields
138
- # @return [Google::Protobuf::Map{String => Google::Cloud::DataCatalog::V1::TagTemplateField}]
138
+ # @return [::Google::Protobuf::Map{::String => ::Google::Cloud::DataCatalog::V1::TagTemplateField}]
139
139
  # Required. Map of tag template field IDs to the settings for the field.
140
140
  # This map is an exhaustive list of the allowed fields. This map must contain
141
141
  # at least one field and at most 500 fields.
@@ -145,22 +145,22 @@ module Google
145
145
  # Field IDs must be at least 1 character long and at most
146
146
  # 64 characters long. Field IDs must start with a letter or underscore.
147
147
  class TagTemplate
148
- include Google::Protobuf::MessageExts
149
- extend Google::Protobuf::MessageExts::ClassMethods
148
+ include ::Google::Protobuf::MessageExts
149
+ extend ::Google::Protobuf::MessageExts::ClassMethods
150
150
 
151
151
  # @!attribute [rw] key
152
- # @return [String]
152
+ # @return [::String]
153
153
  # @!attribute [rw] value
154
- # @return [Google::Cloud::DataCatalog::V1::TagTemplateField]
154
+ # @return [::Google::Cloud::DataCatalog::V1::TagTemplateField]
155
155
  class FieldsEntry
156
- include Google::Protobuf::MessageExts
157
- extend Google::Protobuf::MessageExts::ClassMethods
156
+ include ::Google::Protobuf::MessageExts
157
+ extend ::Google::Protobuf::MessageExts::ClassMethods
158
158
  end
159
159
  end
160
160
 
161
161
  # The template for an individual field within a tag template.
162
162
  # @!attribute [r] name
163
- # @return [String]
163
+ # @return [::String]
164
164
  # Output only. The resource name of the tag template field in URL format. Example:
165
165
  #
166
166
  # * projects/\\{project_id}/locations/\\{location}/tagTemplates/\\{tag_template}/fields/\\{field}
@@ -168,37 +168,37 @@ module Google
168
168
  # Note that this TagTemplateField may not actually be stored in the location
169
169
  # in this name.
170
170
  # @!attribute [rw] display_name
171
- # @return [String]
171
+ # @return [::String]
172
172
  # The display name for this field. Defaults to an empty string.
173
173
  # @!attribute [rw] type
174
- # @return [Google::Cloud::DataCatalog::V1::FieldType]
174
+ # @return [::Google::Cloud::DataCatalog::V1::FieldType]
175
175
  # Required. The type of value this tag field can contain.
176
176
  # @!attribute [rw] is_required
177
- # @return [Boolean]
177
+ # @return [::Boolean]
178
178
  # Whether this is a required field. Defaults to false.
179
179
  # @!attribute [rw] order
180
- # @return [Integer]
180
+ # @return [::Integer]
181
181
  # The order of this field with respect to other fields in this tag
182
182
  # template. For example, a higher value can indicate a more important field.
183
183
  # The value can be negative. Multiple fields can have the same order, and
184
184
  # field orders within a tag do not have to be sequential.
185
185
  class TagTemplateField
186
- include Google::Protobuf::MessageExts
187
- extend Google::Protobuf::MessageExts::ClassMethods
186
+ include ::Google::Protobuf::MessageExts
187
+ extend ::Google::Protobuf::MessageExts::ClassMethods
188
188
  end
189
189
 
190
190
  # @!attribute [rw] primitive_type
191
- # @return [Google::Cloud::DataCatalog::V1::FieldType::PrimitiveType]
191
+ # @return [::Google::Cloud::DataCatalog::V1::FieldType::PrimitiveType]
192
192
  # Represents primitive types - string, bool etc.
193
193
  # @!attribute [rw] enum_type
194
- # @return [Google::Cloud::DataCatalog::V1::FieldType::EnumType]
194
+ # @return [::Google::Cloud::DataCatalog::V1::FieldType::EnumType]
195
195
  # Represents an enum type.
196
196
  class FieldType
197
- include Google::Protobuf::MessageExts
198
- extend Google::Protobuf::MessageExts::ClassMethods
197
+ include ::Google::Protobuf::MessageExts
198
+ extend ::Google::Protobuf::MessageExts::ClassMethods
199
199
 
200
200
  # @!attribute [rw] allowed_values
201
- # @return [Array<Google::Cloud::DataCatalog::V1::FieldType::EnumType::EnumValue>]
201
+ # @return [::Array<::Google::Cloud::DataCatalog::V1::FieldType::EnumType::EnumValue>]
202
202
  # Required on create; optional on update. The set of allowed values for
203
203
  # this enum. This set must not be empty, the display names of the values in
204
204
  # this set must not be empty and the display names of the values must be
@@ -206,15 +206,15 @@ module Google
206
206
  # only be added to the list of allowed values. Deletion and renaming of
207
207
  # enum values are not supported. Can have up to 500 allowed values.
208
208
  class EnumType
209
- include Google::Protobuf::MessageExts
210
- extend Google::Protobuf::MessageExts::ClassMethods
209
+ include ::Google::Protobuf::MessageExts
210
+ extend ::Google::Protobuf::MessageExts::ClassMethods
211
211
 
212
212
  # @!attribute [rw] display_name
213
- # @return [String]
213
+ # @return [::String]
214
214
  # Required. The display name of the enum value. Must not be an empty string.
215
215
  class EnumValue
216
- include Google::Protobuf::MessageExts
217
- extend Google::Protobuf::MessageExts::ClassMethods
216
+ include ::Google::Protobuf::MessageExts
217
+ extend ::Google::Protobuf::MessageExts::ClassMethods
218
218
  end
219
219
  end
220
220