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 | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ name |
string
Required. The name of the field. The maximum length is 767 characters. The name must begins with a letter and not contains |
↳ 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. The maximum length is 767 characters. The name
must begins with a letter and not contains : and ..
Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
string | |
setName
Required. The name of the field. The maximum length is 767 characters. The name
must begins with a letter and not contains : and ..
Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getDescription
Optional. User friendly field description. Must be less than or equal to 1024 characters.
Generated from protobuf field string description = 2 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
string | |
setDescription
Optional. User friendly field description. Must be less than or equal to 1024 characters.
Generated from protobuf field string description = 2 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getType
Required. The type of field.
Generated from protobuf field .google.cloud.dataplex.v1.Schema.Type type = 3 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
int | |
setType
Required. The type of field.
Generated from protobuf field .google.cloud.dataplex.v1.Schema.Type type = 3 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getMode
Required. Additional field semantics.
Generated from protobuf field .google.cloud.dataplex.v1.Schema.Mode mode = 4 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
int | |
setMode
Required. Additional field semantics.
Generated from protobuf field .google.cloud.dataplex.v1.Schema.Mode mode = 4 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getFields
Optional. Any nested field for complex types.
Generated from protobuf field repeated .google.cloud.dataplex.v1.Schema.SchemaField fields = 10 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField | |
setFields
Optional. Any nested field for complex types.
Generated from protobuf field repeated .google.cloud.dataplex.v1.Schema.SchemaField fields = 10 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
var |
array<Google\Cloud\Dataplex\V1\Schema\SchemaField>
|
| Returns | |
|---|---|
| Type | Description |
$this | |