Reference documentation and code samples for the Dataplex V1 API class Google::Cloud::Dataplex::V1::Schema.
Schema information describing the structure and layout of the data.
Inherits
- Object
Extended By
- Google::Protobuf::MessageExts::ClassMethods
Includes
- Google::Protobuf::MessageExts
Methods
#fields
def fields() -> ::Array<::Google::Cloud::Dataplex::V1::Schema::SchemaField>
- (::Array<::Google::Cloud::Dataplex::V1::Schema::SchemaField>) — Optional. The sequence of fields describing data in table entities. Note: BigQuery SchemaFields are immutable.
#fields=
def fields=(value) -> ::Array<::Google::Cloud::Dataplex::V1::Schema::SchemaField>
- value (::Array<::Google::Cloud::Dataplex::V1::Schema::SchemaField>) — Optional. The sequence of fields describing data in table entities. Note: BigQuery SchemaFields are immutable.
- (::Array<::Google::Cloud::Dataplex::V1::Schema::SchemaField>) — Optional. The sequence of fields describing data in table entities. Note: BigQuery SchemaFields are immutable.
#partition_fields
def partition_fields() -> ::Array<::Google::Cloud::Dataplex::V1::Schema::PartitionField>
- (::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_fields=
def partition_fields=(value) -> ::Array<::Google::Cloud::Dataplex::V1::Schema::PartitionField>
- value (::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.
- (::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
def partition_style() -> ::Google::Cloud::Dataplex::V1::Schema::PartitionStyle
- (::Google::Cloud::Dataplex::V1::Schema::PartitionStyle) — Optional. The structure of paths containing partition data within the entity.
#partition_style=
def partition_style=(value) -> ::Google::Cloud::Dataplex::V1::Schema::PartitionStyle
- value (::Google::Cloud::Dataplex::V1::Schema::PartitionStyle) — Optional. The structure of paths containing partition data within the entity.
- (::Google::Cloud::Dataplex::V1::Schema::PartitionStyle) — Optional. The structure of paths containing partition data within the entity.
#user_managed
def user_managed() -> ::Boolean
-
(::Boolean) —
Required. Set to
true
if user-managed orfalse
if managed by Dataplex. The default isfalse
(managed by Dataplex).Set to
false
to 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.
#user_managed=
def user_managed=(value) -> ::Boolean
-
value (::Boolean) —
Required. Set to
true
if user-managed orfalse
if managed by Dataplex. The default isfalse
(managed by Dataplex).Set to
false
to 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.
-
(::Boolean) —
Required. Set to
true
if user-managed orfalse
if managed by Dataplex. The default isfalse
(managed by Dataplex).Set to
false
to 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.