public final class TablesDatasetMetadata extends GeneratedMessageV3 implements TablesDatasetMetadataOrBuilder
Metadata for a dataset used for AutoML Tables.
Protobuf type google.cloud.automl.v1beta1.TablesDatasetMetadata
Static Fields
public static final int ML_USE_COLUMN_SPEC_ID_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
public static final int PRIMARY_TABLE_SPEC_ID_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
public static final int STATS_UPDATE_TIME_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
public static final int TARGET_COLUMN_CORRELATIONS_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
public static final int TARGET_COLUMN_SPEC_ID_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
public static final int WEIGHT_COLUMN_SPEC_ID_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
Static Methods
public static TablesDatasetMetadata getDefaultInstance()
public static final Descriptors.Descriptor getDescriptor()
public static TablesDatasetMetadata.Builder newBuilder()
public static TablesDatasetMetadata.Builder newBuilder(TablesDatasetMetadata prototype)
public static TablesDatasetMetadata parseDelimitedFrom(InputStream input)
public static TablesDatasetMetadata parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static TablesDatasetMetadata parseFrom(byte[] data)
| Parameter |
|---|
| Name | Description |
data | byte[]
|
public static TablesDatasetMetadata parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static TablesDatasetMetadata parseFrom(ByteString data)
public static TablesDatasetMetadata parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static TablesDatasetMetadata parseFrom(CodedInputStream input)
public static TablesDatasetMetadata parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static TablesDatasetMetadata parseFrom(InputStream input)
public static TablesDatasetMetadata parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static TablesDatasetMetadata parseFrom(ByteBuffer data)
public static TablesDatasetMetadata parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Parser<TablesDatasetMetadata> parser()
Methods
public 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
|
public boolean equals(Object obj)
| Parameter |
|---|
| Name | Description |
obj | Object
|
Overrides
public TablesDatasetMetadata getDefaultInstanceForType()
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;
| Returns |
|---|
| Type | Description |
String | The mlUseColumnSpecId.
|
public 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 |
|---|
| Type | Description |
ByteString | The bytes for mlUseColumnSpecId.
|
public Parser<TablesDatasetMetadata> getParserForType()
Overrides
public 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.
|
public 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.
|
public int getSerializedSize()
| Returns |
|---|
| Type | Description |
int | |
Overrides
public 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.
|
public 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;
public Map<String,CorrelationStats> getTargetColumnCorrelations()
public int getTargetColumnCorrelationsCount()
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;
| Returns |
|---|
| Type | Description |
int | |
public Map<String,CorrelationStats> getTargetColumnCorrelationsMap()
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;
public CorrelationStats getTargetColumnCorrelationsOrDefault(String key, CorrelationStats defaultValue)
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;
public CorrelationStats getTargetColumnCorrelationsOrThrow(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
|
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;
| Returns |
|---|
| Type | Description |
String | The targetColumnSpecId.
|
public 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 |
|---|
| Type | Description |
ByteString | The bytes for targetColumnSpecId.
|
public final UnknownFieldSet getUnknownFields()
Overrides
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;
| Returns |
|---|
| Type | Description |
String | The weightColumnSpecId.
|
public 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 |
|---|
| Type | Description |
ByteString | The bytes for weightColumnSpecId.
|
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;
| Returns |
|---|
| Type | Description |
boolean | Whether the statsUpdateTime field is set.
|
| Returns |
|---|
| Type | Description |
int | |
Overrides
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
protected MapField internalGetMapField(int number)
| Parameter |
|---|
| Name | Description |
number | int
|
Overrides
public final boolean isInitialized()
Overrides
public TablesDatasetMetadata.Builder newBuilderForType()
protected TablesDatasetMetadata.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Overrides
public TablesDatasetMetadata.Builder toBuilder()
public void writeTo(CodedOutputStream output)
Overrides
