Cloud AutoML V1beta1 Client - Class TableSpec (1.4.17)

Reference documentation and code samples for the Cloud AutoML V1beta1 Client class TableSpec.

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

Generated from protobuf message google.cloud.automl.v1beta1.TableSpec

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ name string

Output only. The resource name of the table spec. Form: projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/tableSpecs/{table_spec_id}

↳ time_column_spec_id string

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.

↳ row_count int|string

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

↳ valid_row_count int|string

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

↳ column_count int|string

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

↳ input_configs array<Google\Cloud\AutoMl\V1beta1\InputConfig>

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

↳ etag string

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

getName

Output only. The resource name of the table spec.

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

Returns
TypeDescription
string

setName

Output only. The resource name of the table spec.

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

Parameter
NameDescription
var string
Returns
TypeDescription
$this

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.

Returns
TypeDescription
string

setTimeColumnSpecId

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.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getRowCount

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

Returns
TypeDescription
int|string

setRowCount

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

Parameter
NameDescription
var int|string
Returns
TypeDescription
$this

getValidRowCount

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

Returns
TypeDescription
int|string

setValidRowCount

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

Parameter
NameDescription
var int|string
Returns
TypeDescription
$this

getColumnCount

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

Returns
TypeDescription
int|string

setColumnCount

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

Parameter
NameDescription
var int|string
Returns
TypeDescription
$this

getInputConfigs

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

Returns
TypeDescription
Google\Protobuf\Internal\RepeatedField

setInputConfigs

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

Parameter
NameDescription
var array<Google\Cloud\AutoMl\V1beta1\InputConfig>
Returns
TypeDescription
$this

getEtag

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

Returns
TypeDescription
string

setEtag

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

Parameter
NameDescription
var string
Returns
TypeDescription
$this