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

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

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.

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

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

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

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