Class: Google::Apis::LanguageV2::XpsColumnSpec

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/language_v2/classes.rb,
lib/google/apis/language_v2/representations.rb,
lib/google/apis/language_v2/representations.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ XpsColumnSpec

Returns a new instance of XpsColumnSpec.



1378
1379
1380
 
# File 'lib/google/apis/language_v2/classes.rb', line 1378

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#column_id ⇒ Fixnum

The unique id of the column. When Preprocess, the Tables BE will popuate the order id of the column, which reflects the order of the column inside the table, i.e. 0 means the first column in the table, N-1 means the last column. AutoML BE will persist this order id in Spanner and set the order id here when calling RefreshTablesStats and Train. Note: it's different than the column_spec_id that is generated in AutoML BE. Corresponds to the JSON property columnId

Returns:

  • (Fixnum) 


1348
1349
1350
 
# File 'lib/google/apis/language_v2/classes.rb', line 1348

def column_id
  @column_id
end

#data_stats ⇒ Google::Apis::LanguageV2::XpsDataStats

The data statistics of a series of values that share the same DataType. Corresponds to the JSON property dataStats

Returns:



1353
1354
1355
 
# File 'lib/google/apis/language_v2/classes.rb', line 1353

def data_stats
  @data_stats
end

#data_type ⇒ Google::Apis::LanguageV2::XpsDataType

Indicated the type of data that can be stored in a structured data entity (e.g. a table). Corresponds to the JSON property dataType

Returns:



1359
1360
1361
 
# File 'lib/google/apis/language_v2/classes.rb', line 1359

def data_type
  @data_type
end

#display_name ⇒ String

The display name of the column. It's outputed in Preprocess and a required input for RefreshTablesStats and Train. Corresponds to the JSON property displayName

Returns:

  • (String) 


1365
1366
1367
 
# File 'lib/google/apis/language_v2/classes.rb', line 1365

def display_name
  @display_name
end

#forecasting_metadata ⇒ Google::Apis::LanguageV2::XpsColumnSpecForecastingMetadata

=========================================================================== # The fields below are used exclusively for Forecasting. Corresponds to the JSON property forecastingMetadata

Returns:



1371
1372
1373
 
# File 'lib/google/apis/language_v2/classes.rb', line 1371

def forecasting_metadata
  @forecasting_metadata
end

#top_correlated_columns ⇒ Array<Google::Apis::LanguageV2::XpsColumnSpecCorrelatedColumn>

It's outputed in RefreshTablesStats, and a required input in Train. Corresponds to the JSON property topCorrelatedColumns

Returns:



1376
1377
1378
 
# File 'lib/google/apis/language_v2/classes.rb', line 1376

def top_correlated_columns
  @top_correlated_columns
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1383
1384
1385
1386
1387
1388
1389
1390
 
# File 'lib/google/apis/language_v2/classes.rb', line 1383

def update!(**args)
  @column_id = args[:column_id] if args.key?(:column_id)
  @data_stats = args[:data_stats] if args.key?(:data_stats)
  @data_type = args[:data_type] if args.key?(:data_type)
  @display_name = args[:display_name] if args.key?(:display_name)
  @forecasting_metadata = args[:forecasting_metadata] if args.key?(:forecasting_metadata)
  @top_correlated_columns = args[:top_correlated_columns] if args.key?(:top_correlated_columns)
end