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 messagegoogle.cloud.datacatalog.v1.ColumnSchema
Namespace
Google \ Cloud \ DataCatalog \ V1
Methods
__construct
Constructor.
Parameters
Name
Description
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. OnlyNULLABLE,REQUIRED, andREPEATEDvalues are supported. Default mode isNULLABLE.
↳ 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.
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.
Returns
Type
Description
string
setColumn
Required. Name of the column.
Must be a UTF-8 string without dots (.).
The maximum size is 64 bytes.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getType
Required. Type of the column.
Must be a UTF-8 string with the maximum size of 128 bytes.
Returns
Type
Description
string
setType
Required. Type of the column.
Must be a UTF-8 string with the maximum size of 128 bytes.
Parameter
Name
Description
var
string
Returns
Type
Description
$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
Type
Description
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
Name
Description
var
string
Returns
Type
Description
$this
getMode
Optional. A column's mode indicates whether values in this column are
required, nullable, or repeated.
OnlyNULLABLE,REQUIRED, andREPEATEDvalues are supported.
Default mode isNULLABLE.
Returns
Type
Description
string
setMode
Optional. A column's mode indicates whether values in this column are
required, nullable, or repeated.
OnlyNULLABLE,REQUIRED, andREPEATEDvalues are supported.
Default mode isNULLABLE.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getDefaultValue
Optional. Default value for the column.
Returns
Type
Description
string
setDefaultValue
Optional. Default value for the column.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getOrdinalPosition
Optional. Ordinal position
Returns
Type
Description
int
setOrdinalPosition
Optional. Ordinal position
Parameter
Name
Description
var
int
Returns
Type
Description
$this
getHighestIndexingType
Optional. Most important inclusion of this column.
Returns
Type
Description
int
setHighestIndexingType
Optional. Most important inclusion of this column.
Parameter
Name
Description
var
int
Returns
Type
Description
$this
getSubcolumns
Optional. Schema of sub-columns. A column can have zero or more
sub-columns.
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:
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:
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[],[],null,["# Google Cloud Data Catalog V1 Client - Class ColumnSchema (2.3.2)\n\nVersion latestkeyboard_arrow_down\n\n- [2.3.2 (latest)](/php/docs/reference/cloud-data-catalog/latest/V1.ColumnSchema)\n- [2.3.1](/php/docs/reference/cloud-data-catalog/2.3.1/V1.ColumnSchema)\n- [2.2.4](/php/docs/reference/cloud-data-catalog/2.2.4/V1.ColumnSchema)\n- [2.1.0](/php/docs/reference/cloud-data-catalog/2.1.0/V1.ColumnSchema)\n- [2.0.2](/php/docs/reference/cloud-data-catalog/2.0.2/V1.ColumnSchema)\n- [1.10.3](/php/docs/reference/cloud-data-catalog/1.10.3/V1.ColumnSchema)\n- [1.9.1](/php/docs/reference/cloud-data-catalog/1.9.1/V1.ColumnSchema)\n- [1.8.2](/php/docs/reference/cloud-data-catalog/1.8.2/V1.ColumnSchema)\n- [1.7.1](/php/docs/reference/cloud-data-catalog/1.7.1/V1.ColumnSchema)\n- [1.6.0](/php/docs/reference/cloud-data-catalog/1.6.0/V1.ColumnSchema)\n- [1.5.1](/php/docs/reference/cloud-data-catalog/1.5.1/V1.ColumnSchema)\n- [1.4.2](/php/docs/reference/cloud-data-catalog/1.4.2/V1.ColumnSchema)\n- [1.3.9](/php/docs/reference/cloud-data-catalog/1.3.9/V1.ColumnSchema) \nReference documentation and code samples for the Google Cloud Data Catalog V1 Client class ColumnSchema.\n\nA column within a schema. Columns can be nested inside\nother columns.\n\nGenerated from protobuf message `google.cloud.datacatalog.v1.ColumnSchema`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ DataCatalog \\\\ V1\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getColumn\n\nRequired. Name of the column.\n\nMust be a UTF-8 string without dots (.).\nThe maximum size is 64 bytes.\n\n### setColumn\n\nRequired. Name of the column.\n\nMust be a UTF-8 string without dots (.).\nThe maximum size is 64 bytes.\n\n### getType\n\nRequired. Type of the column.\n\nMust be a UTF-8 string with the maximum size of 128 bytes.\n\n### setType\n\nRequired. Type of the column.\n\nMust be a UTF-8 string with the maximum size of 128 bytes.\n\n### getDescription\n\nOptional. Description of the column. Default value is an empty string.\n\nThe description must be a UTF-8 string with the maximum size of 2000\nbytes.\n\n### setDescription\n\nOptional. Description of the column. Default value is an empty string.\n\nThe description must be a UTF-8 string with the maximum size of 2000\nbytes.\n\n### getMode\n\nOptional. A column's mode indicates whether values in this column are\nrequired, nullable, or repeated.\n\nOnly `NULLABLE`, `REQUIRED`, and `REPEATED` values are supported.\nDefault mode is `NULLABLE`.\n\n### setMode\n\nOptional. A column's mode indicates whether values in this column are\nrequired, nullable, or repeated.\n\nOnly `NULLABLE`, `REQUIRED`, and `REPEATED` values are supported.\nDefault mode is `NULLABLE`.\n\n### getDefaultValue\n\nOptional. Default value for the column.\n\n### setDefaultValue\n\nOptional. Default value for the column.\n\n### getOrdinalPosition\n\nOptional. Ordinal position\n\n### setOrdinalPosition\n\nOptional. Ordinal position\n\n### getHighestIndexingType\n\nOptional. Most important inclusion of this column.\n\n### setHighestIndexingType\n\nOptional. Most important inclusion of this column.\n\n### getSubcolumns\n\nOptional. Schema of sub-columns. A column can have zero or more\nsub-columns.\n\n### setSubcolumns\n\nOptional. Schema of sub-columns. A column can have zero or more\nsub-columns.\n\n### getLookerColumnSpec\n\nLooker specific column info of this column.\n\n### hasLookerColumnSpec\n\n### setLookerColumnSpec\n\nLooker specific column info of this column.\n\n### getRangeElementType\n\nOptional. The subtype of the RANGE, if the type of this field is RANGE. If\nthe type is RANGE, this field is required. Possible values for the field\nelement type of a RANGE include:\n\n- DATE\n- DATETIME\n- TIMESTAMP\n\n### hasRangeElementType\n\n### clearRangeElementType\n\n### setRangeElementType\n\nOptional. The subtype of the RANGE, if the type of this field is RANGE. If\nthe type is RANGE, this field is required. Possible values for the field\nelement type of a RANGE include:\n\n- DATE\n- DATETIME\n- TIMESTAMP\n\n### getGcRule\n\nOptional. Garbage collection policy for the column or column family.\n\nApplies to systems like Cloud Bigtable.\n\n### setGcRule\n\nOptional. Garbage collection policy for the column or column family.\n\nApplies to systems like Cloud Bigtable.\n\n### getSystemSpec"]]
