Reference documentation and code samples for the Google Cloud Dataplex V1 Client class Schema.
Schema information describing the structure and layout of the data.
Generated from protobuf message google.cloud.dataplex.v1.Schema
Namespace
Google \ Cloud \ Dataplex \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ user_managed |
bool
Required. Set to |
↳ fields |
array<Google\Cloud\Dataplex\V1\Schema\SchemaField>
Optional. The sequence of fields describing data in table entities. Note: BigQuery SchemaFields are immutable. |
↳ partition_fields |
array<Google\Cloud\Dataplex\V1\Schema\PartitionField>
Optional. The sequence of fields describing the partition structure in entities. If this field is empty, there are no partitions within the data. |
↳ partition_style |
int
Optional. The structure of paths containing partition data within the entity. |
getUserManaged
Required. Set to true if user-managed or false if managed by Dataplex.
The default is false (managed by Dataplex).
- Set to
falseto enable Dataplex discovery to update the schema. including new data discovery, schema inference, and schema evolution. Users retain the ability to input and edit the schema. Dataplex treats schema input by the user as though produced by a previous Dataplex discovery operation, and it will evolve the schema and take action based on that treatment. - Set to
trueto fully manage the entity schema. This setting guarantees that Dataplex will not change schema fields.
| Returns | |
|---|---|
| Type | Description |
bool | |
setUserManaged
Required. Set to true if user-managed or false if managed by Dataplex.
The default is false (managed by Dataplex).
- Set to
falseto enable Dataplex discovery to update the schema. including new data discovery, schema inference, and schema evolution. Users retain the ability to input and edit the schema. Dataplex treats schema input by the user as though produced by a previous Dataplex discovery operation, and it will evolve the schema and take action based on that treatment. - Set to
trueto fully manage the entity schema. This setting guarantees that Dataplex will not change schema fields.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getFields
Optional. The sequence of fields describing data in table entities.
Note: BigQuery SchemaFields are immutable.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField | |
setFields
Optional. The sequence of fields describing data in table entities.
Note: BigQuery SchemaFields are immutable.
| Parameter | |
|---|---|
| Name | Description |
var |
array<Google\Cloud\Dataplex\V1\Schema\SchemaField>
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getPartitionFields
Optional. The sequence of fields describing the partition structure in entities. If this field is empty, there are no partitions within the data.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField | |
setPartitionFields
Optional. The sequence of fields describing the partition structure in entities. If this field is empty, there are no partitions within the data.
| Parameter | |
|---|---|
| Name | Description |
var |
array<Google\Cloud\Dataplex\V1\Schema\PartitionField>
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getPartitionStyle
Optional. The structure of paths containing partition data within the entity.
| Returns | |
|---|---|
| Type | Description |
int | |
setPartitionStyle
Optional. The structure of paths containing partition data within the entity.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this | |