Cloud AutoML V1beta1 Client - Class ColumnSpec (1.6.3)

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

A representation of a column in a relational table. When listing them, column specs are returned in the same order in which they were given on import .

Used by:

  • Tables

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

Namespace

Google \ Cloud \ AutoMl \ V1beta1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ name string

Output only. The resource name of the column specs. Form: projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/tableSpecs/{table_spec_id}/columnSpecs/{column_spec_id}

↳ data_type Google\Cloud\AutoMl\V1beta1\DataType

The data type of elements stored in the column.

↳ display_name string

Output only. The name of the column to show in the interface. The name can be up to 100 characters long and can consist only of ASCII Latin letters A-Z and a-z, ASCII digits 0-9, underscores(_), and forward slashes(/), and must start with a letter or a digit.

↳ data_stats Google\Cloud\AutoMl\V1beta1\DataStats

Output only. Stats of the series of values in the column. This field may be stale, see the ancestor's Dataset.tables_dataset_metadata.stats_update_time field for the timestamp at which these stats were last updated.

↳ top_correlated_columns array<Google\Cloud\AutoMl\V1beta1\ColumnSpec\CorrelatedColumn>

Deprecated.

↳ 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 column specs.

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

Returns
Type Description
string

setName

Output only. The resource name of the column specs.

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

Parameter
Name Description
var string
Returns
Type Description
$this

getDataType

The data type of elements stored in the column.

Returns
Type Description
Google\Cloud\AutoMl\V1beta1\DataType|null

hasDataType

clearDataType

setDataType

The data type of elements stored in the column.

Parameter
Name Description
var Google\Cloud\AutoMl\V1beta1\DataType
Returns
Type Description
$this

getDisplayName

Output only. The name of the column to show in the interface. The name can be up to 100 characters long and can consist only of ASCII Latin letters A-Z and a-z, ASCII digits 0-9, underscores(_), and forward slashes(/), and must start with a letter or a digit.

Returns
Type Description
string

setDisplayName

Output only. The name of the column to show in the interface. The name can be up to 100 characters long and can consist only of ASCII Latin letters A-Z and a-z, ASCII digits 0-9, underscores(_), and forward slashes(/), and must start with a letter or a digit.

Parameter
Name Description
var string
Returns
Type Description
$this

getDataStats

Output only. Stats of the series of values in the column.

This field may be stale, see the ancestor's Dataset.tables_dataset_metadata.stats_update_time field for the timestamp at which these stats were last updated.

Returns
Type Description
Google\Cloud\AutoMl\V1beta1\DataStats|null

hasDataStats

clearDataStats

setDataStats

Output only. Stats of the series of values in the column.

This field may be stale, see the ancestor's Dataset.tables_dataset_metadata.stats_update_time field for the timestamp at which these stats were last updated.

Parameter
Name Description
var Google\Cloud\AutoMl\V1beta1\DataStats
Returns
Type Description
$this

getTopCorrelatedColumns

Deprecated.

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setTopCorrelatedColumns

Deprecated.

Parameter
Name Description
var array<Google\Cloud\AutoMl\V1beta1\ColumnSpec\CorrelatedColumn>
Returns
Type Description
$this

getEtag

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

Returns
Type Description
string

setEtag

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

Parameter
Name Description
var string
Returns
Type Description
$this