Reference documentation and code samples for the Google Cloud Dataplex V1 Client class SchemaField.
Represents a column field within a table schema.
Generated from protobuf messagegoogle.cloud.dataplex.v1.Schema.SchemaField
Namespace
Google \ Cloud \ Dataplex \ V1 \ Schema
Methods
__construct
Constructor.
Parameters
Name
Description
data
array
Optional. Data for populating the Message object.
↳ name
string
Required. The name of the field. Must contain only letters, numbers and underscores, with a maximum length of 767 characters, and must begin with a letter or underscore.
↳ description
string
Optional. User friendly field description. Must be less than or equal to 1024 characters.
Required. The name of the field. Must contain only letters, numbers and
underscores, with a maximum length of 767 characters,
and must begin with a letter or underscore.
Returns
Type
Description
string
setName
Required. The name of the field. Must contain only letters, numbers and
underscores, with a maximum length of 767 characters,
and must begin with a letter or underscore.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getDescription
Optional. User friendly field description. Must be less than or equal to
1024 characters.
Returns
Type
Description
string
setDescription
Optional. User friendly field description. Must be less than or equal to
1024 characters.
[[["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 Dataplex V1 Client - Class SchemaField (1.7.1)\n\nVersion latestkeyboard_arrow_down\n\n- [1.7.1 (latest)](/php/docs/reference/cloud-dataplex/latest/V1.Schema.SchemaField)\n- [1.7.0](/php/docs/reference/cloud-dataplex/1.7.0/V1.Schema.SchemaField)\n- [1.6.1](/php/docs/reference/cloud-dataplex/1.6.1/V1.Schema.SchemaField)\n- [1.4.0](/php/docs/reference/cloud-dataplex/1.4.0/V1.Schema.SchemaField)\n- [1.3.0](/php/docs/reference/cloud-dataplex/1.3.0/V1.Schema.SchemaField)\n- [1.2.1](/php/docs/reference/cloud-dataplex/1.2.1/V1.Schema.SchemaField)\n- [1.1.1](/php/docs/reference/cloud-dataplex/1.1.1/V1.Schema.SchemaField)\n- [1.0.1](/php/docs/reference/cloud-dataplex/1.0.1/V1.Schema.SchemaField)\n- [0.16.1](/php/docs/reference/cloud-dataplex/0.16.1/V1.Schema.SchemaField)\n- [0.15.1](/php/docs/reference/cloud-dataplex/0.15.1/V1.Schema.SchemaField)\n- [0.14.0](/php/docs/reference/cloud-dataplex/0.14.0/V1.Schema.SchemaField)\n- [0.13.0](/php/docs/reference/cloud-dataplex/0.13.0/V1.Schema.SchemaField)\n- [0.12.0](/php/docs/reference/cloud-dataplex/0.12.0/V1.Schema.SchemaField)\n- [0.11.1](/php/docs/reference/cloud-dataplex/0.11.1/V1.Schema.SchemaField)\n- [0.10.0](/php/docs/reference/cloud-dataplex/0.10.0/V1.Schema.SchemaField)\n- [0.9.0](/php/docs/reference/cloud-dataplex/0.9.0/V1.Schema.SchemaField)\n- [0.8.0](/php/docs/reference/cloud-dataplex/0.8.0/V1.Schema.SchemaField)\n- [0.7.0](/php/docs/reference/cloud-dataplex/0.7.0/V1.Schema.SchemaField)\n- [0.6.0](/php/docs/reference/cloud-dataplex/0.6.0/V1.Schema.SchemaField)\n- [0.5.1](/php/docs/reference/cloud-dataplex/0.5.1/V1.Schema.SchemaField)\n- [0.4.0](/php/docs/reference/cloud-dataplex/0.4.0/V1.Schema.SchemaField)\n- [0.3.0](/php/docs/reference/cloud-dataplex/0.3.0/V1.Schema.SchemaField)\n- [0.2.3](/php/docs/reference/cloud-dataplex/0.2.3/V1.Schema.SchemaField)\n- [0.1.6](/php/docs/reference/cloud-dataplex/0.1.6/V1.Schema.SchemaField) \nReference documentation and code samples for the Google Cloud Dataplex V1 Client class SchemaField.\n\nRepresents a column field within a table schema.\n\nGenerated from protobuf message `google.cloud.dataplex.v1.Schema.SchemaField`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ Dataplex \\\\ V1 \\\\ Schema\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getName\n\nRequired. The name of the field. Must contain only letters, numbers and\nunderscores, with a maximum length of 767 characters,\nand must begin with a letter or underscore.\n\n### setName\n\nRequired. The name of the field. Must contain only letters, numbers and\nunderscores, with a maximum length of 767 characters,\nand must begin with a letter or underscore.\n\n### getDescription\n\nOptional. User friendly field description. Must be less than or equal to\n1024 characters.\n\n### setDescription\n\nOptional. User friendly field description. Must be less than or equal to\n1024 characters.\n\n### getType\n\nRequired. The type of field.\n\n### setType\n\nRequired. The type of field.\n\n### getMode\n\nRequired. Additional field semantics.\n\n### setMode\n\nRequired. Additional field semantics.\n\n### getFields\n\nOptional. Any nested field for complex types.\n\n### setFields\n\nOptional. Any nested field for complex types."]]
