Package com.google.cloud.automl.v1beta1

Interface TablesDatasetMetadataOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    TablesDatasetMetadata, TablesDatasetMetadata.Builder
    public interface TablesDatasetMetadataOrBuilder
extends com.google.protobuf.MessageOrBuilder

    • Method Detail

      • getPrimaryTableSpecId

        String getPrimaryTableSpecId()
         Output only. The table_spec_id of the primary table of this dataset.
        string primary_table_spec_id = 1;
        Returns:
        The primaryTableSpecId.

      • getPrimaryTableSpecIdBytes

        com.google.protobuf.ByteString getPrimaryTableSpecIdBytes()
         Output only. The table_spec_id of the primary table of this dataset.
        string primary_table_spec_id = 1;
        Returns:
        The bytes for primaryTableSpecId.

      • getTargetColumnSpecId

        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:
        The targetColumnSpecId.

      • getTargetColumnSpecIdBytes

        com.google.protobuf.ByteString getTargetColumnSpecIdBytes()
         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:
        The bytes for targetColumnSpecId.

      • getWeightColumnSpecId

        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:
        The weightColumnSpecId.

      • getWeightColumnSpecIdBytes

        com.google.protobuf.ByteString getWeightColumnSpecIdBytes()
         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:
        The bytes for weightColumnSpecId.

      • getMlUseColumnSpecId

        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:
        The mlUseColumnSpecId.

      • getMlUseColumnSpecIdBytes

        com.google.protobuf.ByteString getMlUseColumnSpecIdBytes()
         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:
        The bytes for mlUseColumnSpecId.

      • getTargetColumnCorrelationsCount

        int getTargetColumnCorrelationsCount()
         Output only. Correlations between

 [TablesDatasetMetadata.target_column_spec_id][google.cloud.automl.v1beta1.TablesDatasetMetadata.target_column_spec_id],
 and other columns of the

 [TablesDatasetMetadataprimary_table][google.cloud.automl.v1beta1.TablesDatasetMetadata.primary_table_spec_id].
 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;

      • containsTargetColumnCorrelations

        boolean containsTargetColumnCorrelations​(String key)
         Output only. Correlations between

 [TablesDatasetMetadata.target_column_spec_id][google.cloud.automl.v1beta1.TablesDatasetMetadata.target_column_spec_id],
 and other columns of the

 [TablesDatasetMetadataprimary_table][google.cloud.automl.v1beta1.TablesDatasetMetadata.primary_table_spec_id].
 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;

      • getTargetColumnCorrelationsMap

        Map<String,​CorrelationStats> getTargetColumnCorrelationsMap()
         Output only. Correlations between

 [TablesDatasetMetadata.target_column_spec_id][google.cloud.automl.v1beta1.TablesDatasetMetadata.target_column_spec_id],
 and other columns of the

 [TablesDatasetMetadataprimary_table][google.cloud.automl.v1beta1.TablesDatasetMetadata.primary_table_spec_id].
 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;

      • getTargetColumnCorrelationsOrDefault

        CorrelationStats getTargetColumnCorrelationsOrDefault​(String key,
                                                      CorrelationStats defaultValue)
         Output only. Correlations between

 [TablesDatasetMetadata.target_column_spec_id][google.cloud.automl.v1beta1.TablesDatasetMetadata.target_column_spec_id],
 and other columns of the

 [TablesDatasetMetadataprimary_table][google.cloud.automl.v1beta1.TablesDatasetMetadata.primary_table_spec_id].
 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;

      • getTargetColumnCorrelationsOrThrow

        CorrelationStats getTargetColumnCorrelationsOrThrow​(String key)
         Output only. Correlations between

 [TablesDatasetMetadata.target_column_spec_id][google.cloud.automl.v1beta1.TablesDatasetMetadata.target_column_spec_id],
 and other columns of the

 [TablesDatasetMetadataprimary_table][google.cloud.automl.v1beta1.TablesDatasetMetadata.primary_table_spec_id].
 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;

      • hasStatsUpdateTime

        boolean hasStatsUpdateTime()
         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:
        Whether the statsUpdateTime field is set.

      • getStatsUpdateTime

        com.google.protobuf.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:
        The statsUpdateTime.

      • getStatsUpdateTimeOrBuilder

        com.google.protobuf.TimestampOrBuilder getStatsUpdateTimeOrBuilder()
         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;