Class TablesDatasetMetadata

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

ML_USE_COLUMN_SPEC_ID_FIELD_NUMBER

public static final int ML_USE_COLUMN_SPEC_ID_FIELD_NUMBER
Field Value
TypeDescription
int

PRIMARY_TABLE_SPEC_ID_FIELD_NUMBER

public static final int PRIMARY_TABLE_SPEC_ID_FIELD_NUMBER
Field Value
TypeDescription
int

STATS_UPDATE_TIME_FIELD_NUMBER

public static final int STATS_UPDATE_TIME_FIELD_NUMBER
Field Value
TypeDescription
int

TARGET_COLUMN_CORRELATIONS_FIELD_NUMBER

public static final int TARGET_COLUMN_CORRELATIONS_FIELD_NUMBER
Field Value
TypeDescription
int

TARGET_COLUMN_SPEC_ID_FIELD_NUMBER

public static final int TARGET_COLUMN_SPEC_ID_FIELD_NUMBER
Field Value
TypeDescription
int

WEIGHT_COLUMN_SPEC_ID_FIELD_NUMBER

public static final int WEIGHT_COLUMN_SPEC_ID_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static TablesDatasetMetadata getDefaultInstance()
Returns
TypeDescription
TablesDatasetMetadata

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static TablesDatasetMetadata.Builder newBuilder()
Returns
TypeDescription
TablesDatasetMetadata.Builder

newBuilder(TablesDatasetMetadata prototype)

public static TablesDatasetMetadata.Builder newBuilder(TablesDatasetMetadata prototype)
Parameter
NameDescription
prototypeTablesDatasetMetadata
Returns
TypeDescription
TablesDatasetMetadata.Builder

parseDelimitedFrom(InputStream input)

public static TablesDatasetMetadata parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
TablesDatasetMetadata
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static TablesDatasetMetadata parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
TablesDatasetMetadata
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static TablesDatasetMetadata parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
TablesDatasetMetadata
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static TablesDatasetMetadata parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
TablesDatasetMetadata
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static TablesDatasetMetadata parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
TablesDatasetMetadata
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static TablesDatasetMetadata parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
TablesDatasetMetadata
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static TablesDatasetMetadata parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
TablesDatasetMetadata
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static TablesDatasetMetadata parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
TablesDatasetMetadata
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static TablesDatasetMetadata parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
TablesDatasetMetadata
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static TablesDatasetMetadata parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
TablesDatasetMetadata
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static TablesDatasetMetadata parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
TablesDatasetMetadata
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static TablesDatasetMetadata parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
TablesDatasetMetadata
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<TablesDatasetMetadata> parser()
Returns
TypeDescription
Parser<TablesDatasetMetadata>

Methods

containsTargetColumnCorrelations(String key)

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
NameDescription
keyString
Returns
TypeDescription
boolean

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getDefaultInstanceForType()

public TablesDatasetMetadata getDefaultInstanceForType()
Returns
TypeDescription
TablesDatasetMetadata

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;

Returns
TypeDescription
String

The mlUseColumnSpecId.

getMlUseColumnSpecIdBytes()

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
TypeDescription
ByteString

The bytes for mlUseColumnSpecId.

getParserForType()

public Parser<TablesDatasetMetadata> getParserForType()
Returns
TypeDescription
Parser<TablesDatasetMetadata>
Overrides

getPrimaryTableSpecId()

public String getPrimaryTableSpecId()

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

string primary_table_spec_id = 1;

Returns
TypeDescription
String

The primaryTableSpecId.

getPrimaryTableSpecIdBytes()

public ByteString getPrimaryTableSpecIdBytes()

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

string primary_table_spec_id = 1;

Returns
TypeDescription
ByteString

The bytes for primaryTableSpecId.

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getStatsUpdateTime()

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
TypeDescription
Timestamp

The statsUpdateTime.

getStatsUpdateTimeOrBuilder()

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;

Returns
TypeDescription
TimestampOrBuilder

getTargetColumnCorrelations()

public Map<String,CorrelationStats> getTargetColumnCorrelations()
Returns
TypeDescription
Map<String,CorrelationStats>

getTargetColumnCorrelationsCount()

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
TypeDescription
int

getTargetColumnCorrelationsMap()

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;

Returns
TypeDescription
Map<String,CorrelationStats>

getTargetColumnCorrelationsOrDefault(String key, CorrelationStats defaultValue)

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;

Parameters
NameDescription
keyString
defaultValueCorrelationStats
Returns
TypeDescription
CorrelationStats

getTargetColumnCorrelationsOrThrow(String key)

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
NameDescription
keyString
Returns
TypeDescription
CorrelationStats

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;

Returns
TypeDescription
String

The targetColumnSpecId.

getTargetColumnSpecIdBytes()

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
TypeDescription
ByteString

The bytes for targetColumnSpecId.

getUnknownFields()

public final UnknownFieldSet getUnknownFields()
Returns
TypeDescription
UnknownFieldSet
Overrides

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;

Returns
TypeDescription
String

The weightColumnSpecId.

getWeightColumnSpecIdBytes()

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
TypeDescription
ByteString

The bytes for weightColumnSpecId.

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;

Returns
TypeDescription
boolean

Whether the statsUpdateTime field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

internalGetMapField(int number)

protected MapField internalGetMapField(int number)
Parameter
NameDescription
numberint
Returns
TypeDescription
MapField
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public TablesDatasetMetadata.Builder newBuilderForType()
Returns
TypeDescription
TablesDatasetMetadata.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected TablesDatasetMetadata.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
TablesDatasetMetadata.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public TablesDatasetMetadata.Builder toBuilder()
Returns
TypeDescription
TablesDatasetMetadata.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides Exceptions
TypeDescription
IOException