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.
data
array
Optional. Data for populating the Message object.
↳ user_managed
bool
Required. Set to true
if user-managed or false
if managed by Dataplex Universal Catalog. The default is false
(managed by Dataplex Universal Catalog). - Set to false
to enable Dataplex Universal Catalog 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 Universal Catalog treats schema input by the user as though produced by a previous Dataplex Universal Catalog discovery operation, and it will evolve the schema and take action based on that treatment. - Set to true
to fully manage the entity schema. This setting guarantees that Dataplex Universal Catalog will not change schema fields.
↳ fields
array< Schema\SchemaField
>
Optional. The sequence of fields describing data in table entities. Note:BigQuery SchemaFields are immutable.
↳ partition_fields
array< 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
Universal Catalog. The default is false
(managed by Dataplex Universal
Catalog).
- Set to
falseto enable Dataplex Universal Catalog 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 Universal Catalog treats schema input by the user as though produced by a previous Dataplex Universal Catalog 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 Universal Catalog will not change schema fields.
bool
setUserManaged
Required. Set to true
if user-managed or false
if managed by Dataplex
Universal Catalog. The default is false
(managed by Dataplex Universal
Catalog).
- Set to
falseto enable Dataplex Universal Catalog 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 Universal Catalog treats schema input by the user as though produced by a previous Dataplex Universal Catalog 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 Universal Catalog will not change schema fields.
var
bool
$this
getFields
Optional. The sequence of fields describing data in table entities.
Note:BigQuery SchemaFields are immutable.
setFields
Optional. The sequence of fields describing data in table entities.
Note:BigQuery SchemaFields are immutable.
$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.
setPartitionFields
Optional. The sequence of fields describing the partition structure in entities. If this field is empty, there are no partitions within the data.
$this
getPartitionStyle
Optional. The structure of paths containing partition data within the entity.
setPartitionStyle
Optional. The structure of paths containing partition data within the entity.
$this
