Interface TablesDatasetMetadataOrBuilder (2.53.0)

public interface TablesDatasetMetadataOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

containsTargetColumnCorrelations(String key)

public abstract boolean containsTargetColumnCorrelations(String key)

Output only. Correlations between

TablesDatasetMetadata.target_column_spec_id, and other columns of the

TablesDatasetMetadataprimary_table. Only set if the target column is set. Mapping from other column spec id to its CorrelationStats with the target column. This field may be stale, see the stats_update_time field for for the timestamp at which these stats were last updated.

map<string, .google.cloud.automl.v1beta1.CorrelationStats> target_column_correlations = 6;

Parameter
Name	Description
`key`	`String`

Returns
Type	Description
`boolean`

getMlUseColumnSpecId()

public abstract String getMlUseColumnSpecId()

column_spec_id of the primary table column which specifies a possible ML use of the row, i.e. the column will be used to split the rows into TRAIN, VALIDATE and TEST sets. Required type: STRING. This column, if set, must either have all of TRAIN, VALIDATE, TEST among its values, or only have TEST, UNASSIGNED values. In the latter case the rows with UNASSIGNED value will be assigned by AutoML. Note that if a given ml use distribution makes it impossible to create a "good" model, that call will error describing the issue. If both this column_spec_id and primary table's time_column_spec_id are not set, then all rows are treated as UNASSIGNED. NOTE: Updates of this field will instantly affect any other users concurrently working with the dataset.

string ml_use_column_spec_id = 4;

Returns
Type	Description
`String`	The mlUseColumnSpecId.

getMlUseColumnSpecIdBytes()

public abstract ByteString getMlUseColumnSpecIdBytes()

string ml_use_column_spec_id = 4;

Returns
Type	Description
`ByteString`	The bytes for mlUseColumnSpecId.

getPrimaryTableSpecId()

public abstract String getPrimaryTableSpecId()

Output only. The table_spec_id of the primary table of this dataset.

string primary_table_spec_id = 1;

Returns
Type	Description
`String`	The primaryTableSpecId.

getPrimaryTableSpecIdBytes()

public abstract ByteString getPrimaryTableSpecIdBytes()

Output only. The table_spec_id of the primary table of this dataset.

string primary_table_spec_id = 1;

Returns
Type	Description
`ByteString`	The bytes for primaryTableSpecId.

getStatsUpdateTime()

public abstract Timestamp getStatsUpdateTime()

Output only. The most recent timestamp when target_column_correlations field and all descendant ColumnSpec.data_stats and ColumnSpec.top_correlated_columns fields were last (re-)generated. Any changes that happened to the dataset afterwards are not reflected in these fields values. The regeneration happens in the background on a best effort basis.

.google.protobuf.Timestamp stats_update_time = 7;

Returns
Type	Description
`Timestamp`	The statsUpdateTime.

getStatsUpdateTimeOrBuilder()

public abstract TimestampOrBuilder getStatsUpdateTimeOrBuilder()

.google.protobuf.Timestamp stats_update_time = 7;

Returns
Type	Description
`TimestampOrBuilder`

getTargetColumnCorrelations() (deprecated)

public abstract Map<String,CorrelationStats> getTargetColumnCorrelations()

Use #getTargetColumnCorrelationsMap() instead.

Returns
Type	Description
`Map<String,CorrelationStats>`

getTargetColumnCorrelationsCount()

public abstract int getTargetColumnCorrelationsCount()

Output only. Correlations between

TablesDatasetMetadata.target_column_spec_id, and other columns of the

map<string, .google.cloud.automl.v1beta1.CorrelationStats> target_column_correlations = 6;

Returns
Type	Description
`int`

getTargetColumnCorrelationsMap()

public abstract Map<String,CorrelationStats> getTargetColumnCorrelationsMap()

Output only. Correlations between

TablesDatasetMetadata.target_column_spec_id, and other columns of the

map<string, .google.cloud.automl.v1beta1.CorrelationStats> target_column_correlations = 6;

Returns
Type	Description
`Map<String,CorrelationStats>`

getTargetColumnCorrelationsOrDefault(String key, CorrelationStats defaultValue)

public abstract CorrelationStats getTargetColumnCorrelationsOrDefault(String key, CorrelationStats defaultValue)

Output only. Correlations between

TablesDatasetMetadata.target_column_spec_id, and other columns of the

map<string, .google.cloud.automl.v1beta1.CorrelationStats> target_column_correlations = 6;

Parameters
Name	Description
`key`	`String`
`defaultValue`	`CorrelationStats`

Returns
Type	Description
`CorrelationStats`

getTargetColumnCorrelationsOrThrow(String key)

public abstract CorrelationStats getTargetColumnCorrelationsOrThrow(String key)

Output only. Correlations between

TablesDatasetMetadata.target_column_spec_id, and other columns of the

map<string, .google.cloud.automl.v1beta1.CorrelationStats> target_column_correlations = 6;

Parameter
Name	Description
`key`	`String`

Returns
Type	Description
`CorrelationStats`

getTargetColumnSpecId()

public abstract String getTargetColumnSpecId()

column_spec_id of the primary table's column that should be used as the training & prediction target. This column must be non-nullable and have one of following data types (otherwise model creation will error):

CATEGORY
FLOAT64

If the type is CATEGORY , only up to 100 unique values may exist in that column across all rows.

NOTE: Updates of this field will instantly affect any other users concurrently working with the dataset.

string target_column_spec_id = 2;

Returns
Type	Description
`String`	The targetColumnSpecId.

getTargetColumnSpecIdBytes()

public abstract ByteString getTargetColumnSpecIdBytes()

CATEGORY
FLOAT64

If the type is CATEGORY , only up to 100 unique values may exist in that column across all rows.

NOTE: Updates of this field will instantly affect any other users concurrently working with the dataset.

string target_column_spec_id = 2;

Returns
Type	Description
`ByteString`	The bytes for targetColumnSpecId.

getWeightColumnSpecId()

public abstract String getWeightColumnSpecId()

column_spec_id of the primary table's column that should be used as the weight column, i.e. the higher the value the more important the row will be during model training. Required type: FLOAT64. Allowed values: 0 to 10000, inclusive on both ends; 0 means the row is ignored for training. If not set all rows are assumed to have equal weight of 1. NOTE: Updates of this field will instantly affect any other users concurrently working with the dataset.

string weight_column_spec_id = 3;

Returns
Type	Description
`String`	The weightColumnSpecId.

getWeightColumnSpecIdBytes()

public abstract ByteString getWeightColumnSpecIdBytes()

string weight_column_spec_id = 3;

Returns
Type	Description
`ByteString`	The bytes for weightColumnSpecId.

hasStatsUpdateTime()

public abstract boolean hasStatsUpdateTime()

.google.protobuf.Timestamp stats_update_time = 7;

Returns
Type	Description
`boolean`	Whether the statsUpdateTime field is set.