google-cloud-dataplex-v1 0.7.0 → 0.8.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (36) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +1 -1
  3. data/lib/google/cloud/dataplex/v1/content_service/client.rb +2 -2
  4. data/lib/google/cloud/dataplex/v1/content_service/rest/client.rb +2 -2
  5. data/lib/google/cloud/dataplex/v1/data_profile_pb.rb +1 -0
  6. data/lib/google/cloud/dataplex/v1/data_scan_service/client.rb +12 -6
  7. data/lib/google/cloud/dataplex/v1/data_scan_service/operations.rb +2 -2
  8. data/lib/google/cloud/dataplex/v1/data_scan_service/rest/client.rb +12 -6
  9. data/lib/google/cloud/dataplex/v1/data_scan_service/rest/operations.rb +2 -2
  10. data/lib/google/cloud/dataplex/v1/dataplex_service/client.rb +95 -2
  11. data/lib/google/cloud/dataplex/v1/dataplex_service/operations.rb +2 -2
  12. data/lib/google/cloud/dataplex/v1/dataplex_service/rest/client.rb +72 -2
  13. data/lib/google/cloud/dataplex/v1/dataplex_service/rest/operations.rb +2 -2
  14. data/lib/google/cloud/dataplex/v1/dataplex_service/rest/service_stub.rb +60 -0
  15. data/lib/google/cloud/dataplex/v1/datascans_pb.rb +4 -0
  16. data/lib/google/cloud/dataplex/v1/metadata_pb.rb +12 -0
  17. data/lib/google/cloud/dataplex/v1/metadata_service/client.rb +2 -2
  18. data/lib/google/cloud/dataplex/v1/metadata_service/rest/client.rb +2 -2
  19. data/lib/google/cloud/dataplex/v1/processing_pb.rb +1 -0
  20. data/lib/google/cloud/dataplex/v1/resources_pb.rb +8 -0
  21. data/lib/google/cloud/dataplex/v1/rest.rb +1 -1
  22. data/lib/google/cloud/dataplex/v1/service_pb.rb +8 -0
  23. data/lib/google/cloud/dataplex/v1/service_services_pb.rb +2 -0
  24. data/lib/google/cloud/dataplex/v1/version.rb +1 -1
  25. data/lib/google/cloud/dataplex/v1.rb +1 -1
  26. data/proto_docs/google/api/client.rb +67 -4
  27. data/proto_docs/google/cloud/dataplex/v1/analyze.rb +4 -0
  28. data/proto_docs/google/cloud/dataplex/v1/data_profile.rb +64 -87
  29. data/proto_docs/google/cloud/dataplex/v1/data_quality.rb +54 -32
  30. data/proto_docs/google/cloud/dataplex/v1/datascans.rb +10 -2
  31. data/proto_docs/google/cloud/dataplex/v1/metadata.rb +31 -2
  32. data/proto_docs/google/cloud/dataplex/v1/processing.rb +23 -13
  33. data/proto_docs/google/cloud/dataplex/v1/resources.rb +24 -6
  34. data/proto_docs/google/cloud/dataplex/v1/service.rb +17 -0
  35. data/proto_docs/google/cloud/dataplex/v1/tasks.rb +2 -3
  36. metadata +2 -2
@@ -879,9 +879,9 @@ module Google
879
879
  # * (`String`) The path to a service account key file in JSON format
880
880
  # * (`Hash`) A service account key as a Hash
881
881
  # * (`Google::Auth::Credentials`) A googleauth credentials object
882
- # (see the [googleauth docs](https://googleapis.dev/ruby/googleauth/latest/index.html))
882
+ # (see the [googleauth docs](https://rubydoc.info/gems/googleauth/Google/Auth/Credentials))
883
883
  # * (`Signet::OAuth2::Client`) A signet oauth2 client object
884
- # (see the [signet docs](https://googleapis.dev/ruby/signet/latest/Signet/OAuth2/Client.html))
884
+ # (see the [signet docs](https://rubydoc.info/gems/signet/Signet/OAuth2/Client))
885
885
  # * (`nil`) indicating no credentials
886
886
  # @return [::Object]
887
887
  # @!attribute [rw] scope
@@ -22,6 +22,7 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
22
22
  add_message "google.cloud.dataplex.v1.DataSource" do
23
23
  oneof :source do
24
24
  optional :entity, :string, 100
25
+ optional :resource, :string, 101
25
26
  end
26
27
  end
27
28
  add_message "google.cloud.dataplex.v1.ScannedData" do
@@ -203,16 +203,23 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
203
203
  add_message "google.cloud.dataplex.v1.Asset.ResourceSpec" do
204
204
  optional :name, :string, 1
205
205
  optional :type, :enum, 2, "google.cloud.dataplex.v1.Asset.ResourceSpec.Type"
206
+ optional :read_access_mode, :enum, 5, "google.cloud.dataplex.v1.Asset.ResourceSpec.AccessMode"
206
207
  end
207
208
  add_enum "google.cloud.dataplex.v1.Asset.ResourceSpec.Type" do
208
209
  value :TYPE_UNSPECIFIED, 0
209
210
  value :STORAGE_BUCKET, 1
210
211
  value :BIGQUERY_DATASET, 2
211
212
  end
213
+ add_enum "google.cloud.dataplex.v1.Asset.ResourceSpec.AccessMode" do
214
+ value :ACCESS_MODE_UNSPECIFIED, 0
215
+ value :DIRECT, 1
216
+ value :MANAGED, 2
217
+ end
212
218
  add_message "google.cloud.dataplex.v1.Asset.ResourceStatus" do
213
219
  optional :state, :enum, 1, "google.cloud.dataplex.v1.Asset.ResourceStatus.State"
214
220
  optional :message, :string, 2
215
221
  optional :update_time, :message, 3, "google.protobuf.Timestamp"
222
+ optional :managed_access_identity, :string, 4
216
223
  end
217
224
  add_enum "google.cloud.dataplex.v1.Asset.ResourceStatus.State" do
218
225
  value :STATE_UNSPECIFIED, 0
@@ -286,6 +293,7 @@ module Google
286
293
  Asset::DiscoverySpec::JsonOptions = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.dataplex.v1.Asset.DiscoverySpec.JsonOptions").msgclass
287
294
  Asset::ResourceSpec = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.dataplex.v1.Asset.ResourceSpec").msgclass
288
295
  Asset::ResourceSpec::Type = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.dataplex.v1.Asset.ResourceSpec.Type").enummodule
296
+ Asset::ResourceSpec::AccessMode = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.dataplex.v1.Asset.ResourceSpec.AccessMode").enummodule
289
297
  Asset::ResourceStatus = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.dataplex.v1.Asset.ResourceStatus").msgclass
290
298
  Asset::ResourceStatus::State = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.dataplex.v1.Asset.ResourceStatus.State").enummodule
291
299
  Asset::DiscoveryStatus = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.dataplex.v1.Asset.DiscoveryStatus").msgclass
@@ -17,9 +17,9 @@
17
17
  # Auto-generated by gapic-generator-ruby. DO NOT EDIT!
18
18
 
19
19
  require "google/cloud/dataplex/v1/content_service/rest"
20
+ require "google/cloud/dataplex/v1/dataplex_service/rest"
20
21
  require "google/cloud/dataplex/v1/data_scan_service/rest"
21
22
  require "google/cloud/dataplex/v1/metadata_service/rest"
22
- require "google/cloud/dataplex/v1/dataplex_service/rest"
23
23
  require "google/cloud/dataplex/v1/bindings_override"
24
24
  require "google/cloud/dataplex/v1/version"
25
25
 
@@ -162,6 +162,12 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
162
162
  add_message "google.cloud.dataplex.v1.GetJobRequest" do
163
163
  optional :name, :string, 1
164
164
  end
165
+ add_message "google.cloud.dataplex.v1.RunTaskRequest" do
166
+ optional :name, :string, 1
167
+ end
168
+ add_message "google.cloud.dataplex.v1.RunTaskResponse" do
169
+ optional :job, :message, 1, "google.cloud.dataplex.v1.Job"
170
+ end
165
171
  add_message "google.cloud.dataplex.v1.ListJobsRequest" do
166
172
  optional :parent, :string, 1
167
173
  optional :page_size, :int32, 2
@@ -249,6 +255,8 @@ module Google
249
255
  ListTasksResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.dataplex.v1.ListTasksResponse").msgclass
250
256
  GetTaskRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.dataplex.v1.GetTaskRequest").msgclass
251
257
  GetJobRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.dataplex.v1.GetJobRequest").msgclass
258
+ RunTaskRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.dataplex.v1.RunTaskRequest").msgclass
259
+ RunTaskResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.dataplex.v1.RunTaskResponse").msgclass
252
260
  ListJobsRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.dataplex.v1.ListJobsRequest").msgclass
253
261
  ListJobsResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.dataplex.v1.ListJobsResponse").msgclass
254
262
  CancelJobRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.dataplex.v1.CancelJobRequest").msgclass
@@ -88,6 +88,8 @@ module Google
88
88
  rpc :GetTask, ::Google::Cloud::Dataplex::V1::GetTaskRequest, ::Google::Cloud::Dataplex::V1::Task
89
89
  # Lists Jobs under the given task.
90
90
  rpc :ListJobs, ::Google::Cloud::Dataplex::V1::ListJobsRequest, ::Google::Cloud::Dataplex::V1::ListJobsResponse
91
+ # Run an on demand execution of a Task.
92
+ rpc :RunTask, ::Google::Cloud::Dataplex::V1::RunTaskRequest, ::Google::Cloud::Dataplex::V1::RunTaskResponse
91
93
  # Get job resource.
92
94
  rpc :GetJob, ::Google::Cloud::Dataplex::V1::GetJobRequest, ::Google::Cloud::Dataplex::V1::Job
93
95
  # Cancel jobs running for the task resource.
@@ -21,7 +21,7 @@ module Google
21
21
  module Cloud
22
22
  module Dataplex
23
23
  module V1
24
- VERSION = "0.7.0"
24
+ VERSION = "0.8.0"
25
25
  end
26
26
  end
27
27
  end
@@ -17,9 +17,9 @@
17
17
  # Auto-generated by gapic-generator-ruby. DO NOT EDIT!
18
18
 
19
19
  require "google/cloud/dataplex/v1/content_service"
20
+ require "google/cloud/dataplex/v1/dataplex_service"
20
21
  require "google/cloud/dataplex/v1/data_scan_service"
21
22
  require "google/cloud/dataplex/v1/metadata_service"
22
- require "google/cloud/dataplex/v1/dataplex_service"
23
23
  require "google/cloud/dataplex/v1/version"
24
24
 
25
25
  module Google
@@ -35,7 +35,9 @@ module Google
35
35
  # Details about how and where to publish client libraries.
36
36
  # @!attribute [rw] version
37
37
  # @return [::String]
38
- # Version of the API to apply these settings to.
38
+ # Version of the API to apply these settings to. This is the full protobuf
39
+ # package for the API, ending in the version element.
40
+ # Examples: "google.cloud.speech.v1" and "google.spanner.admin.database.v1".
39
41
  # @!attribute [rw] launch_stage
40
42
  # @return [::Google::Api::LaunchStage]
41
43
  # Launch stage of this version of the API.
@@ -81,7 +83,7 @@ module Google
81
83
  # long-running operation pattern.
82
84
  # @!attribute [rw] new_issue_uri
83
85
  # @return [::String]
84
- # Link to a place that API users can report issues. Example:
86
+ # Link to a *public* URI where users can report issues. Example:
85
87
  # https://issuetracker.google.com/issues/new?component=190865&template=1161103
86
88
  # @!attribute [rw] documentation_uri
87
89
  # @return [::String]
@@ -111,6 +113,10 @@ module Google
111
113
  # Client library settings. If the same version string appears multiple
112
114
  # times in this list, then the last one wins. Settings from earlier
113
115
  # settings with the same version string are discarded.
116
+ # @!attribute [rw] proto_reference_documentation_uri
117
+ # @return [::String]
118
+ # Optional link to proto reference documentation. Example:
119
+ # https://cloud.google.com/pubsub/lite/docs/reference/rpc
114
120
  class Publishing
115
121
  include ::Google::Protobuf::MessageExts
116
122
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -203,9 +209,57 @@ module Google
203
209
  # @!attribute [rw] common
204
210
  # @return [::Google::Api::CommonLanguageSettings]
205
211
  # Some settings.
212
+ # @!attribute [rw] renamed_services
213
+ # @return [::Google::Protobuf::Map{::String => ::String}]
214
+ # Map from original service names to renamed versions.
215
+ # This is used when the default generated types
216
+ # would cause a naming conflict. (Neither name is
217
+ # fully-qualified.)
218
+ # Example: Subscriber to SubscriberServiceApi.
219
+ # @!attribute [rw] renamed_resources
220
+ # @return [::Google::Protobuf::Map{::String => ::String}]
221
+ # Map from full resource types to the effective short name
222
+ # for the resource. This is used when otherwise resource
223
+ # named from different services would cause naming collisions.
224
+ # Example entry:
225
+ # "datalabeling.googleapis.com/Dataset": "DataLabelingDataset"
226
+ # @!attribute [rw] ignored_resources
227
+ # @return [::Array<::String>]
228
+ # List of full resource types to ignore during generation.
229
+ # This is typically used for API-specific Location resources,
230
+ # which should be handled by the generator as if they were actually
231
+ # the common Location resources.
232
+ # Example entry: "documentai.googleapis.com/Location"
233
+ # @!attribute [rw] forced_namespace_aliases
234
+ # @return [::Array<::String>]
235
+ # Namespaces which must be aliased in snippets due to
236
+ # a known (but non-generator-predictable) naming collision
237
+ # @!attribute [rw] handwritten_signatures
238
+ # @return [::Array<::String>]
239
+ # Method signatures (in the form "service.method(signature)")
240
+ # which are provided separately, so shouldn't be generated.
241
+ # Snippets *calling* these methods are still generated, however.
206
242
  class DotnetSettings
207
243
  include ::Google::Protobuf::MessageExts
208
244
  extend ::Google::Protobuf::MessageExts::ClassMethods
245
+
246
+ # @!attribute [rw] key
247
+ # @return [::String]
248
+ # @!attribute [rw] value
249
+ # @return [::String]
250
+ class RenamedServicesEntry
251
+ include ::Google::Protobuf::MessageExts
252
+ extend ::Google::Protobuf::MessageExts::ClassMethods
253
+ end
254
+
255
+ # @!attribute [rw] key
256
+ # @return [::String]
257
+ # @!attribute [rw] value
258
+ # @return [::String]
259
+ class RenamedResourcesEntry
260
+ include ::Google::Protobuf::MessageExts
261
+ extend ::Google::Protobuf::MessageExts::ClassMethods
262
+ end
209
263
  end
210
264
 
211
265
  # Settings for Ruby client libraries.
@@ -240,8 +294,8 @@ module Google
240
294
  # Example of a YAML configuration::
241
295
  #
242
296
  # publishing:
243
- # method_behavior:
244
- # - selector: CreateAdDomain
297
+ # method_settings:
298
+ # - selector: google.cloud.speech.v2.Speech.BatchRecognize
245
299
  # long_running:
246
300
  # initial_poll_delay:
247
301
  # seconds: 60 # 1 minute
@@ -299,6 +353,15 @@ module Google
299
353
 
300
354
  # Street View Org.
301
355
  STREET_VIEW = 4
356
+
357
+ # Shopping Org.
358
+ SHOPPING = 5
359
+
360
+ # Geo Org.
361
+ GEO = 6
362
+
363
+ # Generative AI - https://developers.generativeai.google
364
+ GENERATIVE_AI = 7
302
365
  end
303
366
 
304
367
  # To where should client libraries be published?
@@ -131,6 +131,7 @@ module Google
131
131
  end
132
132
  end
133
133
 
134
+ # Configuration for sessions created for this environment.
134
135
  # @!attribute [rw] max_idle_duration
135
136
  # @return [::Google::Protobuf::Duration]
136
137
  # Optional. The idle time configuration of the session. The session will be
@@ -147,6 +148,7 @@ module Google
147
148
  extend ::Google::Protobuf::MessageExts::ClassMethods
148
149
  end
149
150
 
151
+ # Status of sessions created for this environment.
150
152
  # @!attribute [r] active
151
153
  # @return [::Boolean]
152
154
  # Output only. Queries over sessions to mark whether the environment is
@@ -156,6 +158,7 @@ module Google
156
158
  extend ::Google::Protobuf::MessageExts::ClassMethods
157
159
  end
158
160
 
161
+ # URI Endpoints to access sessions associated with the Environment.
159
162
  # @!attribute [r] notebooks
160
163
  # @return [::String]
161
164
  # Output only. URI to serve notebook APIs
@@ -276,6 +279,7 @@ module Google
276
279
  # Output only. Session start time.
277
280
  # @!attribute [r] state
278
281
  # @return [::Google::Cloud::Dataplex::V1::State]
282
+ # Output only. State of Session
279
283
  class Session
280
284
  include ::Google::Protobuf::MessageExts
281
285
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -27,131 +27,113 @@ module Google
27
27
  extend ::Google::Protobuf::MessageExts::ClassMethods
28
28
  end
29
29
 
30
- # DataProfileResult defines the output of DataProfileScan.
31
- # Each field of the table will have field type specific profile result.
30
+ # DataProfileResult defines the output of DataProfileScan. Each field of the
31
+ # table will have field type specific profile result.
32
32
  # @!attribute [rw] row_count
33
33
  # @return [::Integer]
34
- # The count of all rows in the sampled data.
35
- # Return 0, if zero rows.
34
+ # The count of rows scanned.
36
35
  # @!attribute [rw] profile
37
36
  # @return [::Google::Cloud::Dataplex::V1::DataProfileResult::Profile]
38
- # This represents the profile information per field.
37
+ # The profile information per field.
39
38
  # @!attribute [rw] scanned_data
40
39
  # @return [::Google::Cloud::Dataplex::V1::ScannedData]
41
- # The data scanned for this profile.
40
+ # The data scanned for this result.
42
41
  class DataProfileResult
43
42
  include ::Google::Protobuf::MessageExts
44
43
  extend ::Google::Protobuf::MessageExts::ClassMethods
45
44
 
46
- # Profile information describing the structure and layout of the data
47
- # and contains the profile info.
45
+ # Contains name, type, mode and field type specific profile information.
48
46
  # @!attribute [rw] fields
49
47
  # @return [::Array<::Google::Cloud::Dataplex::V1::DataProfileResult::Profile::Field>]
50
- # The sequence of fields describing data in table entities.
48
+ # List of fields with structural and profile information for each field.
51
49
  class Profile
52
50
  include ::Google::Protobuf::MessageExts
53
51
  extend ::Google::Protobuf::MessageExts::ClassMethods
54
52
 
55
- # Represents a column field within a table schema.
53
+ # A field within a table.
56
54
  # @!attribute [rw] name
57
55
  # @return [::String]
58
56
  # The name of the field.
59
57
  # @!attribute [rw] type
60
58
  # @return [::String]
61
- # The field data type. Possible values include:
62
- #
63
- # * STRING
64
- # * BYTE
65
- # * INT64
66
- # * INT32
67
- # * INT16
68
- # * DOUBLE
69
- # * FLOAT
70
- # * DECIMAL
71
- # * BOOLEAN
72
- # * BINARY
73
- # * TIMESTAMP
74
- # * DATE
75
- # * TIME
76
- # * NULL
77
- # * RECORD
59
+ # The data type retrieved from the schema of the data source. For
60
+ # instance, for a BigQuery native table, it is the [BigQuery Table
61
+ # Schema](https://cloud.google.com/bigquery/docs/reference/rest/v2/tables#tablefieldschema).
62
+ # For a Dataplex Entity, it is the [Entity
63
+ # Schema](https://cloud.google.com/dataplex/docs/reference/rpc/google.cloud.dataplex.v1#type_3).
78
64
  # @!attribute [rw] mode
79
65
  # @return [::String]
80
- # The mode of the field. Its value will be:
81
- # REQUIRED, if it is a required field.
82
- # NULLABLE, if it is an optional field.
83
- # REPEATED, if it is a repeated field.
66
+ # The mode of the field. Possible values include:
67
+ #
68
+ # * REQUIRED, if it is a required field.
69
+ # * NULLABLE, if it is an optional field.
70
+ # * REPEATED, if it is a repeated field.
84
71
  # @!attribute [rw] profile
85
72
  # @return [::Google::Cloud::Dataplex::V1::DataProfileResult::Profile::Field::ProfileInfo]
86
- # The profile information for the corresponding field.
73
+ # Profile information for the corresponding field.
87
74
  class Field
88
75
  include ::Google::Protobuf::MessageExts
89
76
  extend ::Google::Protobuf::MessageExts::ClassMethods
90
77
 
91
- # ProfileInfo defines the profile information for each schema field type.
78
+ # The profile information for each field type.
92
79
  # @!attribute [rw] null_ratio
93
80
  # @return [::Float]
94
- # The ratio of null rows against the rows in the sampled data.
81
+ # Ratio of rows with null value against total scanned rows.
95
82
  # @!attribute [rw] distinct_ratio
96
83
  # @return [::Float]
97
- # The ratio of rows that are distinct against the rows in the sampled
98
- # data.
84
+ # Ratio of rows with distinct values against total scanned rows.
85
+ # Not available for complex non-groupable field type RECORD and fields
86
+ # with REPEATABLE mode.
99
87
  # @!attribute [rw] top_n_values
100
88
  # @return [::Array<::Google::Cloud::Dataplex::V1::DataProfileResult::Profile::Field::ProfileInfo::TopNValue>]
101
- # The array of top N values of the field in the sampled data.
102
- # Currently N is set as 10 or equal to distinct values in the field,
103
- # whichever is smaller. This will be optional for complex non-groupable
104
- # data-types such as JSON, ARRAY, JSON, STRUCT.
89
+ # The list of top N non-null values and number of times they occur in
90
+ # the scanned data. N is 10 or equal to the number of distinct values
91
+ # in the field, whichever is smaller. Not available for complex
92
+ # non-groupable field type RECORD and fields with REPEATABLE mode.
105
93
  # @!attribute [rw] string_profile
106
94
  # @return [::Google::Cloud::Dataplex::V1::DataProfileResult::Profile::Field::ProfileInfo::StringFieldInfo]
107
- # The corresponding string field profile.
95
+ # String type field information.
108
96
  # @!attribute [rw] integer_profile
109
97
  # @return [::Google::Cloud::Dataplex::V1::DataProfileResult::Profile::Field::ProfileInfo::IntegerFieldInfo]
110
- # The corresponding integer field profile.
98
+ # Integer type field information.
111
99
  # @!attribute [rw] double_profile
112
100
  # @return [::Google::Cloud::Dataplex::V1::DataProfileResult::Profile::Field::ProfileInfo::DoubleFieldInfo]
113
- # The corresponding double field profile.
101
+ # Double type field information.
114
102
  class ProfileInfo
115
103
  include ::Google::Protobuf::MessageExts
116
104
  extend ::Google::Protobuf::MessageExts::ClassMethods
117
105
 
118
- # StringFieldInfo defines output info for any string type field.
106
+ # The profile information for a string type field.
119
107
  # @!attribute [rw] min_length
120
108
  # @return [::Integer]
121
- # The minimum length of the string field in the sampled data.
122
- # Optional if zero non-null rows.
109
+ # Minimum length of non-null values in the scanned data.
123
110
  # @!attribute [rw] max_length
124
111
  # @return [::Integer]
125
- # The maximum length of a string field in the sampled data.
126
- # Optional if zero non-null rows.
112
+ # Maximum length of non-null values in the scanned data.
127
113
  # @!attribute [rw] average_length
128
114
  # @return [::Float]
129
- # The average length of a string field in the sampled data.
130
- # Optional if zero non-null rows.
115
+ # Average length of non-null values in the scanned data.
131
116
  class StringFieldInfo
132
117
  include ::Google::Protobuf::MessageExts
133
118
  extend ::Google::Protobuf::MessageExts::ClassMethods
134
119
  end
135
120
 
136
- # IntegerFieldInfo defines output for any integer type field.
121
+ # The profile information for an integer type field.
137
122
  # @!attribute [rw] average
138
123
  # @return [::Float]
139
- # The average of non-null values of integer field in the sampled
140
- # data. Return NaN, if the field has a NaN. Optional if zero non-null
141
- # rows.
124
+ # Average of non-null values in the scanned data. NaN, if the field
125
+ # has a NaN.
142
126
  # @!attribute [rw] standard_deviation
143
127
  # @return [::Float]
144
- # The standard deviation of non-null of integer field in the sampled
145
- # data. Return NaN, if the field has a NaN. Optional if zero non-null
146
- # rows.
128
+ # Standard deviation of non-null values in the scanned data. NaN, if
129
+ # the field has a NaN.
147
130
  # @!attribute [rw] min
148
131
  # @return [::Integer]
149
- # The minimum value of an integer field in the sampled data.
150
- # Return NaN, if the field has a NaN. Optional if zero non-null
151
- # rows.
132
+ # Minimum of non-null values in the scanned data. NaN, if the field
133
+ # has a NaN.
152
134
  # @!attribute [rw] quartiles
153
135
  # @return [::Array<::Integer>]
154
- # A quartile divide the number of data points into four parts, or
136
+ # A quartile divides the number of data points into four parts, or
155
137
  # quarters, of more-or-less equal size. Three main quartiles used
156
138
  # are: The first quartile (Q1) splits off the lowest 25% of data from
157
139
  # the highest 75%. It is also known as the lower or 25th empirical
@@ -159,37 +141,34 @@ module Google
159
141
  # quartile (Q2) is the median of a data set. So, 50% of the data lies
160
142
  # below this point. The third quartile (Q3) splits off the highest
161
143
  # 25% of data from the lowest 75%. It is known as the upper or 75th
162
- # empirical quartile, as 75% of the data lies below this point. So,
163
- # here the quartiles is provided as an ordered list of quartile
164
- # values, occurring in order Q1, median, Q3.
144
+ # empirical quartile, as 75% of the data lies below this point.
145
+ # Here, the quartiles is provided as an ordered list of quartile
146
+ # values for the scanned data, occurring in order Q1, median, Q3.
165
147
  # @!attribute [rw] max
166
148
  # @return [::Integer]
167
- # The maximum value of an integer field in the sampled data.
168
- # Return NaN, if the field has a NaN. Optional if zero non-null
169
- # rows.
149
+ # Maximum of non-null values in the scanned data. NaN, if the field
150
+ # has a NaN.
170
151
  class IntegerFieldInfo
171
152
  include ::Google::Protobuf::MessageExts
172
153
  extend ::Google::Protobuf::MessageExts::ClassMethods
173
154
  end
174
155
 
175
- # DoubleFieldInfo defines output for any double type field.
156
+ # The profile information for a double type field.
176
157
  # @!attribute [rw] average
177
158
  # @return [::Float]
178
- # The average of non-null values of double field in the sampled data.
179
- # Return NaN, if the field has a NaN. Optional if zero non-null rows.
159
+ # Average of non-null values in the scanned data. NaN, if the field
160
+ # has a NaN.
180
161
  # @!attribute [rw] standard_deviation
181
162
  # @return [::Float]
182
- # The standard deviation of non-null of double field in the sampled
183
- # data. Return NaN, if the field has a NaN. Optional if zero non-null
184
- # rows.
163
+ # Standard deviation of non-null values in the scanned data. NaN, if
164
+ # the field has a NaN.
185
165
  # @!attribute [rw] min
186
166
  # @return [::Float]
187
- # The minimum value of a double field in the sampled data.
188
- # Return NaN, if the field has a NaN. Optional if zero non-null
189
- # rows.
167
+ # Minimum of non-null values in the scanned data. NaN, if the field
168
+ # has a NaN.
190
169
  # @!attribute [rw] quartiles
191
170
  # @return [::Array<::Float>]
192
- # A quartile divide the numebr of data points into four parts, or
171
+ # A quartile divides the number of data points into four parts, or
193
172
  # quarters, of more-or-less equal size. Three main quartiles used
194
173
  # are: The first quartile (Q1) splits off the lowest 25% of data from
195
174
  # the highest 75%. It is also known as the lower or 25th empirical
@@ -197,27 +176,25 @@ module Google
197
176
  # quartile (Q2) is the median of a data set. So, 50% of the data lies
198
177
  # below this point. The third quartile (Q3) splits off the highest
199
178
  # 25% of data from the lowest 75%. It is known as the upper or 75th
200
- # empirical quartile, as 75% of the data lies below this point. So,
201
- # here the quartiles is provided as an ordered list of quartile
202
- # values, occurring in order Q1, median, Q3.
179
+ # empirical quartile, as 75% of the data lies below this point.
180
+ # Here, the quartiles is provided as an ordered list of quartile
181
+ # values for the scanned data, occurring in order Q1, median, Q3.
203
182
  # @!attribute [rw] max
204
183
  # @return [::Float]
205
- # The maximum value of a double field in the sampled data.
206
- # Return NaN, if the field has a NaN. Optional if zero non-null
207
- # rows.
184
+ # Maximum of non-null values in the scanned data. NaN, if the field
185
+ # has a NaN.
208
186
  class DoubleFieldInfo
209
187
  include ::Google::Protobuf::MessageExts
210
188
  extend ::Google::Protobuf::MessageExts::ClassMethods
211
189
  end
212
190
 
213
- # The TopNValue defines the structure of output of top N values of a
214
- # field.
191
+ # Top N non-null values in the scanned data.
215
192
  # @!attribute [rw] value
216
193
  # @return [::String]
217
- # The value is the string value of the actual value from the field.
194
+ # String value of a top N non-null value.
218
195
  # @!attribute [rw] count
219
196
  # @return [::Integer]
220
- # The frequency count of the corresponding value in the field.
197
+ # Count of the corresponding value in the scanned data.
221
198
  class TopNValue
222
199
  include ::Google::Protobuf::MessageExts
223
200
  extend ::Google::Protobuf::MessageExts::ClassMethods