Reference documentation and code samples for the Google Cloud Dataplex V1 Client class Field.
A field within a table.
Generated from protobuf message google.cloud.dataplex.v1.DataProfileResult.Profile.Field
Namespace
Google \ Cloud \ Dataplex \ V1 \ DataProfileResult \ ProfileMethods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ name |
string
The name of the field. |
↳ type |
string
The data type retrieved from the schema of the data source. For instance, for a BigQuery native table, it is the BigQuery Table Schema. For a Dataplex Entity, it is the Entity Schema. |
↳ mode |
string
The mode of the field. Possible values include: * * REQUIRED, if it is a required field. * * NULLABLE, if it is an optional field. * * REPEATED, if it is a repeated field. |
↳ profile |
Field\ProfileInfo
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 data type retrieved from the schema of the data source. For instance, for a BigQuery native table, it is the BigQuery Table Schema.
For a Dataplex Entity, it is the Entity Schema.
| Returns | |
|---|---|
| Type | Description |
string |
|
setType
The data type retrieved from the schema of the data source. For instance, for a BigQuery native table, it is the BigQuery Table Schema.
For a Dataplex Entity, it is the Entity Schema.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getMode
The mode of the field. Possible values include:
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. Possible values include:
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
Profile information for the corresponding field.
| Returns | |
|---|---|
| Type | Description |
Field\ProfileInfo|null |
|
hasProfile
clearProfile
setProfile
Profile information for the corresponding field.
| Parameter | |
|---|---|
| Name | Description |
var |
Field\ProfileInfo
|
| Returns | |
|---|---|
| Type | Description |
$this |
|