Google Cloud Data Catalog V1 Client - Class ColumnSchema (1.8.2)

Reference documentation and code samples for the Google Cloud Data Catalog V1 Client class ColumnSchema.

A column within a schema. Columns can be nested inside other columns.

Generated from protobuf message google.cloud.datacatalog.v1.ColumnSchema

Namespace

Google \ Cloud \ DataCatalog \ V1

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ column string

Required. Name of the column. Must be a UTF-8 string without dots (.). The maximum size is 64 bytes.

↳ type string

Required. Type of the column. Must be a UTF-8 string with the maximum size of 128 bytes.

↳ description string

Optional. Description of the column. Default value is an empty string. The description must be a UTF-8 string with the maximum size of 2000 bytes.

↳ mode string

Optional. A column's mode indicates whether values in this column are required, nullable, or repeated. Only NULLABLE, REQUIRED, and REPEATED values are supported. Default mode is NULLABLE.

↳ default_value string

Optional. Default value for the column.

↳ ordinal_position int

Optional. Ordinal position

↳ highest_indexing_type int

Optional. Most important inclusion of this column.

↳ subcolumns array<Google\Cloud\DataCatalog\V1\ColumnSchema>

Optional. Schema of sub-columns. A column can have zero or more sub-columns.

↳ looker_column_spec Google\Cloud\DataCatalog\V1\ColumnSchema\LookerColumnSpec

Looker specific column info of this column.

↳ gc_rule string

Optional. Garbage collection policy for the column or column family. Applies to systems like Cloud Bigtable.

getColumn

Required. Name of the column.

Must be a UTF-8 string without dots (.). The maximum size is 64 bytes.

Returns
TypeDescription
string

setColumn

Required. Name of the column.

Must be a UTF-8 string without dots (.). The maximum size is 64 bytes.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getType

Required. Type of the column.

Must be a UTF-8 string with the maximum size of 128 bytes.

Returns
TypeDescription
string

setType

Required. Type of the column.

Must be a UTF-8 string with the maximum size of 128 bytes.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getDescription

Optional. Description of the column. Default value is an empty string.

The description must be a UTF-8 string with the maximum size of 2000 bytes.

Returns
TypeDescription
string

setDescription

Optional. Description of the column. Default value is an empty string.

The description must be a UTF-8 string with the maximum size of 2000 bytes.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getMode

Optional. A column's mode indicates whether values in this column are required, nullable, or repeated.

Only NULLABLE, REQUIRED, and REPEATED values are supported. Default mode is NULLABLE.

Returns
TypeDescription
string

setMode

Optional. A column's mode indicates whether values in this column are required, nullable, or repeated.

Only NULLABLE, REQUIRED, and REPEATED values are supported. Default mode is NULLABLE.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getDefaultValue

Optional. Default value for the column.

Returns
TypeDescription
string

setDefaultValue

Optional. Default value for the column.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getOrdinalPosition

Optional. Ordinal position

Returns
TypeDescription
int

setOrdinalPosition

Optional. Ordinal position

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getHighestIndexingType

Optional. Most important inclusion of this column.

Returns
TypeDescription
int

setHighestIndexingType

Optional. Most important inclusion of this column.

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getSubcolumns

Optional. Schema of sub-columns. A column can have zero or more sub-columns.

Returns
TypeDescription
Google\Protobuf\Internal\RepeatedField

setSubcolumns

Optional. Schema of sub-columns. A column can have zero or more sub-columns.

Parameter
NameDescription
var array<Google\Cloud\DataCatalog\V1\ColumnSchema>
Returns
TypeDescription
$this

getLookerColumnSpec

Looker specific column info of this column.

Returns
TypeDescription
Google\Cloud\DataCatalog\V1\ColumnSchema\LookerColumnSpec|null

hasLookerColumnSpec

setLookerColumnSpec

Looker specific column info of this column.

Parameter
NameDescription
var Google\Cloud\DataCatalog\V1\ColumnSchema\LookerColumnSpec
Returns
TypeDescription
$this

getGcRule

Optional. Garbage collection policy for the column or column family.

Applies to systems like Cloud Bigtable.

Returns
TypeDescription
string

setGcRule

Optional. Garbage collection policy for the column or column family.

Applies to systems like Cloud Bigtable.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getSystemSpec

Returns
TypeDescription
string