Class TableSpec (2.42.0)

public final class TableSpec extends GeneratedMessageV3 implements TableSpecOrBuilder

A specification of a relational table. The table's schema is represented via its child column specs. It is pre-populated as part of ImportData by schema inference algorithm, the version of which is a required parameter of ImportData InputConfig. Note: While working with a table, at times the schema may be inconsistent with the data in the table (e.g. string in a FLOAT64 column). The consistency validation is done upon creation of a model. Used by:

  • Tables

Protobuf type google.cloud.automl.v1beta1.TableSpec

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > TableSpec

Implements

TableSpecOrBuilder

Static Fields

COLUMN_COUNT_FIELD_NUMBER

public static final int COLUMN_COUNT_FIELD_NUMBER
Field Value
Type Description
int

ETAG_FIELD_NUMBER

public static final int ETAG_FIELD_NUMBER
Field Value
Type Description
int

INPUT_CONFIGS_FIELD_NUMBER

public static final int INPUT_CONFIGS_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

ROW_COUNT_FIELD_NUMBER

public static final int ROW_COUNT_FIELD_NUMBER
Field Value
Type Description
int

TIME_COLUMN_SPEC_ID_FIELD_NUMBER

public static final int TIME_COLUMN_SPEC_ID_FIELD_NUMBER
Field Value
Type Description
int

VALID_ROW_COUNT_FIELD_NUMBER

public static final int VALID_ROW_COUNT_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static TableSpec getDefaultInstance()
Returns
Type Description
TableSpec

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static TableSpec.Builder newBuilder()
Returns
Type Description
TableSpec.Builder

newBuilder(TableSpec prototype)

public static TableSpec.Builder newBuilder(TableSpec prototype)
Parameter
Name Description
prototype TableSpec
Returns
Type Description
TableSpec.Builder

parseDelimitedFrom(InputStream input)

public static TableSpec parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
TableSpec
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static TableSpec parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
TableSpec
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static TableSpec parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
TableSpec
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static TableSpec parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
TableSpec
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static TableSpec parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
TableSpec
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static TableSpec parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
TableSpec
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static TableSpec parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
TableSpec
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static TableSpec parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
TableSpec
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static TableSpec parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
TableSpec
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static TableSpec parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
TableSpec
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static TableSpec parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
TableSpec
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static TableSpec parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
TableSpec
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<TableSpec> parser()
Returns
Type Description
Parser<TableSpec>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getColumnCount()

public long getColumnCount()

Output only. The number of columns of the table. That is, the number of child ColumnSpec-s.

int64 column_count = 7;

Returns
Type Description
long

The columnCount.

getDefaultInstanceForType()

public TableSpec getDefaultInstanceForType()
Returns
Type Description
TableSpec

getEtag()

public String getEtag()

Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.

string etag = 6;

Returns
Type Description
String

The etag.

getEtagBytes()

public ByteString getEtagBytes()

Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.

string etag = 6;

Returns
Type Description
ByteString

The bytes for etag.

getInputConfigs(int index)

public InputConfig getInputConfigs(int index)

Output only. Input configs via which data currently residing in the table had been imported.

repeated .google.cloud.automl.v1beta1.InputConfig input_configs = 5;

Parameter
Name Description
index int
Returns
Type Description
InputConfig

getInputConfigsCount()

public int getInputConfigsCount()

Output only. Input configs via which data currently residing in the table had been imported.

repeated .google.cloud.automl.v1beta1.InputConfig input_configs = 5;

Returns
Type Description
int

getInputConfigsList()

public List<InputConfig> getInputConfigsList()

Output only. Input configs via which data currently residing in the table had been imported.

repeated .google.cloud.automl.v1beta1.InputConfig input_configs = 5;

Returns
Type Description
List<InputConfig>

getInputConfigsOrBuilder(int index)

public InputConfigOrBuilder getInputConfigsOrBuilder(int index)

Output only. Input configs via which data currently residing in the table had been imported.

repeated .google.cloud.automl.v1beta1.InputConfig input_configs = 5;

Parameter
Name Description
index int
Returns
Type Description
InputConfigOrBuilder

getInputConfigsOrBuilderList()

public List<? extends InputConfigOrBuilder> getInputConfigsOrBuilderList()

Output only. Input configs via which data currently residing in the table had been imported.

repeated .google.cloud.automl.v1beta1.InputConfig input_configs = 5;

Returns
Type Description
List<? extends com.google.cloud.automl.v1beta1.InputConfigOrBuilder>

getName()

public String getName()

Output only. The resource name of the table spec. Form:

projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/tableSpecs/{table_spec_id}

string name = 1;

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

Output only. The resource name of the table spec. Form:

projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/tableSpecs/{table_spec_id}

string name = 1;

Returns
Type Description
ByteString

The bytes for name.

getParserForType()

public Parser<TableSpec> getParserForType()
Returns
Type Description
Parser<TableSpec>
Overrides

getRowCount()

public long getRowCount()

Output only. The number of rows (i.e. examples) in the table.

int64 row_count = 3;

Returns
Type Description
long

The rowCount.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getTimeColumnSpecId()

public String getTimeColumnSpecId()

column_spec_id of the time column. Only used if the parent dataset's ml_use_column_spec_id is not set. Used to split rows into TRAIN, VALIDATE and TEST sets such that oldest rows go to TRAIN set, newest to TEST, and those in between to VALIDATE. Required type: TIMESTAMP. If both this column and ml_use_column are not set, then ML use of all rows will be assigned by AutoML. NOTE: Updates of this field will instantly affect any other users concurrently working with the dataset.

string time_column_spec_id = 2;

Returns
Type Description
String

The timeColumnSpecId.

getTimeColumnSpecIdBytes()

public ByteString getTimeColumnSpecIdBytes()

column_spec_id of the time column. Only used if the parent dataset's ml_use_column_spec_id is not set. Used to split rows into TRAIN, VALIDATE and TEST sets such that oldest rows go to TRAIN set, newest to TEST, and those in between to VALIDATE. Required type: TIMESTAMP. If both this column and ml_use_column are not set, then ML use of all rows will be assigned by AutoML. NOTE: Updates of this field will instantly affect any other users concurrently working with the dataset.

string time_column_spec_id = 2;

Returns
Type Description
ByteString

The bytes for timeColumnSpecId.

getValidRowCount()

public long getValidRowCount()

Output only. The number of valid rows (i.e. without values that don't match DataType-s of their columns).

int64 valid_row_count = 4;

Returns
Type Description
long

The validRowCount.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public TableSpec.Builder newBuilderForType()
Returns
Type Description
TableSpec.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected TableSpec.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
TableSpec.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public TableSpec.Builder toBuilder()
Returns
Type Description
TableSpec.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException