Reference documentation and code samples for the Google Cloud Dataplex V1 Client class Field.
Represents a column field within a table schema.
Generated from protobuf message google.cloud.dataplex.v1.DataProfileResult.Profile.Field
Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ name |
string
The name of the field. |
↳ type |
string
The field data type. Possible values include: * STRING * BYTE * INT64 * INT32 * INT16 * DOUBLE * FLOAT * DECIMAL * BOOLEAN * BINARY * TIMESTAMP * DATE * TIME * NULL * RECORD |
↳ mode |
string
The mode of the field. Its value will be: REQUIRED, if it is a required field. NULLABLE, if it is an optional field. REPEATED, if it is a repeated field. |
↳ profile |
Google\Cloud\Dataplex\V1\DataProfileResult\Profile\Field\ProfileInfo
The profile information for the corresponding field. |
getName
The name of the field.
| Returns | |
|---|---|
| Type | Description |
string | |
setName
The name of the field.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getType
The field data type. Possible values include:
- STRING
- BYTE
- INT64
- INT32
- INT16
- DOUBLE
- FLOAT
- DECIMAL
- BOOLEAN
- BINARY
- TIMESTAMP
- DATE
- TIME
- NULL
- RECORD
| Returns | |
|---|---|
| Type | Description |
string | |
setType
The field data type. Possible values include:
- STRING
- BYTE
- INT64
- INT32
- INT16
- DOUBLE
- FLOAT
- DECIMAL
- BOOLEAN
- BINARY
- TIMESTAMP
- DATE
- TIME
- NULL
- RECORD
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getMode
The mode of the field. Its value will be: REQUIRED, if it is a required field.
NULLABLE, if it is an optional field. REPEATED, if it is a repeated field.
| Returns | |
|---|---|
| Type | Description |
string | |
setMode
The mode of the field. Its value will be: REQUIRED, if it is a required field.
NULLABLE, if it is an optional field. REPEATED, if it is a repeated field.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getProfile
The profile information for the corresponding field.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Dataplex\V1\DataProfileResult\Profile\Field\ProfileInfo|null | |
hasProfile
clearProfile
setProfile
The profile information for the corresponding field.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\Dataplex\V1\DataProfileResult\Profile\Field\ProfileInfo
|
| Returns | |
|---|---|
| Type | Description |
$this | |