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 \ V1Methods
__construct
Constructor.
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.
↳ range_element_type
Google\Cloud\DataCatalog\V1\ColumnSchema\FieldElementType
Optional. The subtype of the RANGE, if the type of this field is RANGE. If the type is RANGE, this field is required. Possible values for the field element type of a RANGE include: * DATE * DATETIME * TIMESTAMP
↳ 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.
string
setColumn
Required. Name of the column.
Must be a UTF-8 string without dots (.). The maximum size is 64 bytes.
var
string
$this
getType
Required. Type of the column.
Must be a UTF-8 string with the maximum size of 128 bytes.
string
setType
Required. Type of the column.
Must be a UTF-8 string with the maximum size of 128 bytes.
var
string
$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.
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.
var
string
$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
.
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
.
var
string
$this
getDefaultValue
Optional. Default value for the column.
string
setDefaultValue
Optional. Default value for the column.
var
string
$this
getOrdinalPosition
Optional. Ordinal position
int
setOrdinalPosition
Optional. Ordinal position
var
int
$this
getHighestIndexingType
Optional. Most important inclusion of this column.
int
setHighestIndexingType
Optional. Most important inclusion of this column.
var
int
$this
getSubcolumns
Optional. Schema of sub-columns. A column can have zero or more sub-columns.
setSubcolumns
Optional. Schema of sub-columns. A column can have zero or more sub-columns.
$this
getLookerColumnSpec
Looker specific column info of this column.
hasLookerColumnSpec
setLookerColumnSpec
Looker specific column info of this column.
$this
getRangeElementType
Optional. The subtype of the RANGE, if the type of this field is RANGE. If the type is RANGE, this field is required. Possible values for the field element type of a RANGE include:
- DATE
- DATETIME
- TIMESTAMP
hasRangeElementType
clearRangeElementType
setRangeElementType
Optional. The subtype of the RANGE, if the type of this field is RANGE. If the type is RANGE, this field is required. Possible values for the field element type of a RANGE include:
- DATE
- DATETIME
- TIMESTAMP
$this
getGcRule
Optional. Garbage collection policy for the column or column family.
Applies to systems like Cloud Bigtable.
string
setGcRule
Optional. Garbage collection policy for the column or column family.
Applies to systems like Cloud Bigtable.
var
string
$this
getSystemSpec
string
