Google Cloud Dataplex V1 Client - Class Field (1.12.0)

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 \ Profile

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ name string

Output only. The name of the field.
↳ type string

Output only. 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 Universal Catalog Entity, it is the Entity Schema.
↳ mode string

Output only. 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

Output only. Profile information for the corresponding field.

getName

Output only. The name of the field.

Returns
Type Description
string

setName

Output only. The name of the field.

Parameter
Name Description
var string
Returns
Type Description
$this

getType

Output only. 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 Universal Catalog Entity, it is the Entity Schema.

Returns
Type Description
string

setType

Output only. 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 Universal Catalog Entity, it is the Entity Schema.

Parameter
Name Description
var string
Returns
Type Description
$this

getMode

Output only. 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

Output only. 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

Output only. Profile information for the corresponding field.

Returns
Type Description
Field\ProfileInfo|null

hasProfile

clearProfile

setProfile

Output only. Profile information for the corresponding field.

Parameter
Name Description
var Field\ProfileInfo
Returns
Type Description
$this