Google Cloud Dataplex V1 Client - Class SchemaField (0.3.0)

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 message google.cloud.dataplex.v1.Schema.SchemaField

Methods

__construct

Constructor.

Parameters
NameDescription
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.

↳ type int

Required. The type of field.

↳ mode int

Required. Additional field semantics.

↳ fields array<Google\Cloud\Dataplex\V1\Schema\SchemaField>

Optional. Any nested field for complex types.

getName

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
TypeDescription
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
NameDescription
var string
Returns
TypeDescription
$this

getDescription

Optional. User friendly field description. Must be less than or equal to 1024 characters.

Returns
TypeDescription
string

setDescription

Optional. User friendly field description. Must be less than or equal to 1024 characters.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getType

Required. The type of field.

Returns
TypeDescription
int

setType

Required. The type of field.

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getMode

Required. Additional field semantics.

Returns
TypeDescription
int

setMode

Required. Additional field semantics.

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getFields

Optional. Any nested field for complex types.

Returns
TypeDescription
Google\Protobuf\Internal\RepeatedField

setFields

Optional. Any nested field for complex types.

Parameter
NameDescription
var array<Google\Cloud\Dataplex\V1\Schema\SchemaField>
Returns
TypeDescription
$this