Google Cloud Dataplex V1 Client - Class Schema (0.4.0)

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

Methods

__construct

Constructor.

Parameters
NameDescription
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. 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 true to fully manage the entity schema. This setting guarantees that Dataplex will not change schema fields.

↳ 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 true to fully manage the entity schema. This setting guarantees that Dataplex will not change schema fields.
Returns
TypeDescription
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 true to fully manage the entity schema. This setting guarantees that Dataplex will not change schema fields.
Parameter
NameDescription
var bool
Returns
TypeDescription
$this

getFields

Optional. The sequence of fields describing data in table entities.

Note: BigQuery SchemaFields are immutable.

Returns
TypeDescription
Google\Protobuf\Internal\RepeatedField

setFields

Optional. The sequence of fields describing data in table entities.

Note: BigQuery SchemaFields are immutable.

Parameter
NameDescription
var array<Google\Cloud\Dataplex\V1\Schema\SchemaField>
Returns
TypeDescription
$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
TypeDescription
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
NameDescription
var array<Google\Cloud\Dataplex\V1\Schema\PartitionField>
Returns
TypeDescription
$this

getPartitionStyle

Optional. The structure of paths containing partition data within the entity.

Returns
TypeDescription
int

setPartitionStyle

Optional. The structure of paths containing partition data within the entity.

Parameter
NameDescription
var int
Returns
TypeDescription
$this