Google Cloud Dataplex V1 Client - Class SchemaField (0.9.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

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.

↳ 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
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.

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getType

Required. The type of field.

Returns
Type
Description
int

setType

Required. The type of field.

Parameter
Name
Description
var
int
Returns
Type
Description
$this

getMode

Required. Additional field semantics.

Returns
Type
Description
int

setMode

Required. Additional field semantics.

Parameter
Name
Description
var
int
Returns
Type
Description
$this

getFields

Optional. Any nested field for complex types.

Returns
Type
Description

setFields

Optional. Any nested field for complex types.

Parameter
Name
Description
Returns
Type
Description
$this
Design a Mobile Site
View Site in Mobile | Classic
Share by: