Dataplex V1 API - Class Google::Cloud::Dataplex::V1::Schema (v0.5.1)

Version 0.5.1

• 1.0.1 (latest)
• 1.0.0
• 0.23.0
• 0.22.0
• 0.21.1
• 0.20.0
• 0.19.0
• 0.18.2
• 0.17.0
• 0.16.0
• 0.15.0
• 0.14.0
• 0.13.0
• 0.12.0
• 0.11.0
• 0.10.1
• 0.9.0
• 0.8.0
• 0.7.0
• 0.6.1
• 0.5.1
• 0.4.0
• 0.3.0
• 0.2.1
• 0.1.0

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>

Returns

• (::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>

Parameter

• value (::Array<::Google::Cloud::Dataplex::V1::Schema::SchemaField>) — Optional. The sequence of fields describing data in table entities. Note: BigQuery SchemaFields are immutable.

Returns

• (::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>

Returns

• (::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>

Parameter

• 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.

Returns

• (::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

Returns

• (::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

Parameter

• value (::Google::Cloud::Dataplex::V1::Schema::PartitionStyle) — Optional. The structure of paths containing partition data within the entity.

Returns

• (::Google::Cloud::Dataplex::V1::Schema::PartitionStyle) — Optional. The structure of paths containing partition data within the entity.

#user_managed

def user_managed() -> ::Boolean

Returns

• (::Boolean) —

  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.

#user_managed=

def user_managed=(value) -> ::Boolean

Parameter

• value (::Boolean) —

  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

• (::Boolean) —

  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.