Package com.google.cloud.automl.v1beta1

Class TablesDatasetMetadata

  • All Implemented Interfaces:
    TablesDatasetMetadataOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    public final class TablesDatasetMetadata
extends com.google.protobuf.GeneratedMessageV3
implements TablesDatasetMetadataOrBuilder
     Metadata for a dataset used for AutoML Tables.
    Protobuf type google.cloud.automl.v1beta1.TablesDatasetMetadata
    See Also:
    Serialized Form

    • Field Detail

      • PRIMARY_TABLE_SPEC_ID_FIELD_NUMBER

        public static final int PRIMARY_TABLE_SPEC_ID_FIELD_NUMBER
        See Also:
        Constant Field Values

      • TARGET_COLUMN_SPEC_ID_FIELD_NUMBER

        public static final int TARGET_COLUMN_SPEC_ID_FIELD_NUMBER
        See Also:
        Constant Field Values

      • WEIGHT_COLUMN_SPEC_ID_FIELD_NUMBER

        public static final int WEIGHT_COLUMN_SPEC_ID_FIELD_NUMBER
        See Also:
        Constant Field Values

      • ML_USE_COLUMN_SPEC_ID_FIELD_NUMBER

        public static final int ML_USE_COLUMN_SPEC_ID_FIELD_NUMBER
        See Also:
        Constant Field Values

      • TARGET_COLUMN_CORRELATIONS_FIELD_NUMBER

        public static final int TARGET_COLUMN_CORRELATIONS_FIELD_NUMBER
        See Also:
        Constant Field Values

      • STATS_UPDATE_TIME_FIELD_NUMBER

        public static final int STATS_UPDATE_TIME_FIELD_NUMBER
        See Also:
        Constant Field Values

    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3

      • getDescriptor

        public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

      • internalGetMapField

        protected com.google.protobuf.MapField internalGetMapField​(int number)
        Overrides:
        internalGetMapField in class com.google.protobuf.GeneratedMessageV3

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

      • getPrimaryTableSpecIdBytes

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

      • getTargetColumnSpecId

        public 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;
        Specified by:
        getTargetColumnSpecId in interface TablesDatasetMetadataOrBuilder
        Returns:
        The targetColumnSpecId.

      • getTargetColumnSpecIdBytes

        public 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;
        Specified by:
        getTargetColumnSpecIdBytes in interface TablesDatasetMetadataOrBuilder
        Returns:
        The bytes for targetColumnSpecId.

      • getWeightColumnSpecId

        public 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;
        Specified by:
        getWeightColumnSpecId in interface TablesDatasetMetadataOrBuilder
        Returns:
        The weightColumnSpecId.

      • getWeightColumnSpecIdBytes

        public 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;
        Specified by:
        getWeightColumnSpecIdBytes in interface TablesDatasetMetadataOrBuilder
        Returns:
        The bytes for weightColumnSpecId.

      • getMlUseColumnSpecId

        public 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;
        Specified by:
        getMlUseColumnSpecId in interface TablesDatasetMetadataOrBuilder
        Returns:
        The mlUseColumnSpecId.

      • getMlUseColumnSpecIdBytes

        public 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;
        Specified by:
        getMlUseColumnSpecIdBytes in interface TablesDatasetMetadataOrBuilder
        Returns:
        The bytes for mlUseColumnSpecId.

      • getTargetColumnCorrelationsCount

        public int getTargetColumnCorrelationsCount()
        Description copied from interface: TablesDatasetMetadataOrBuilder
         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;
        Specified by:
        getTargetColumnCorrelationsCount in interface TablesDatasetMetadataOrBuilder

      • containsTargetColumnCorrelations

        public 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;
        Specified by:
        containsTargetColumnCorrelations in interface TablesDatasetMetadataOrBuilder

      • getTargetColumnCorrelationsMap

        public 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;
        Specified by:
        getTargetColumnCorrelationsMap in interface TablesDatasetMetadataOrBuilder

      • getTargetColumnCorrelationsOrDefault

        public 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;
        Specified by:
        getTargetColumnCorrelationsOrDefault in interface TablesDatasetMetadataOrBuilder

      • getTargetColumnCorrelationsOrThrow

        public 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;
        Specified by:
        getTargetColumnCorrelationsOrThrow in interface TablesDatasetMetadataOrBuilder

      • hasStatsUpdateTime

        public 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;
        Specified by:
        hasStatsUpdateTime in interface TablesDatasetMetadataOrBuilder
        Returns:
        Whether the statsUpdateTime field is set.

      • getStatsUpdateTime

        public 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;
        Specified by:
        getStatsUpdateTime in interface TablesDatasetMetadataOrBuilder
        Returns:
        The statsUpdateTime.

      • getStatsUpdateTimeOrBuilder

        public 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;
        Specified by:
        getStatsUpdateTimeOrBuilder in interface TablesDatasetMetadataOrBuilder

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3

      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
             throws IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        IOException

      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessageV3

      • equals

        public boolean equals​(Object obj)
        Specified by:
        equals in interface com.google.protobuf.Message
        Overrides:
        equals in class com.google.protobuf.AbstractMessage

      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface com.google.protobuf.Message
        Overrides:
        hashCode in class com.google.protobuf.AbstractMessage

      • parseFrom

        public static TablesDatasetMetadata parseFrom​(ByteBuffer data)
                                       throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static TablesDatasetMetadata parseFrom​(ByteBuffer data,
                                              com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                       throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static TablesDatasetMetadata parseFrom​(com.google.protobuf.ByteString data)
                                       throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static TablesDatasetMetadata parseFrom​(com.google.protobuf.ByteString data,
                                              com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                       throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static TablesDatasetMetadata parseFrom​(byte[] data)
                                       throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static TablesDatasetMetadata parseFrom​(byte[] data,
                                              com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                       throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • newBuilderForType

        public TablesDatasetMetadata.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite

      • toBuilder

        public TablesDatasetMetadata.Builder toBuilder()
        Specified by:
        toBuilder in interface com.google.protobuf.Message
        Specified by:
        toBuilder in interface com.google.protobuf.MessageLite

      • newBuilderForType

        protected TablesDatasetMetadata.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • getParserForType

        public com.google.protobuf.Parser<TablesDatasetMetadata> getParserForType()
        Specified by:
        getParserForType in interface com.google.protobuf.Message
        Specified by:
        getParserForType in interface com.google.protobuf.MessageLite
        Overrides:
        getParserForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstanceForType

        public TablesDatasetMetadata getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder