Cloud Dataplex v1 API - Class Schema (2.3.0)

public sealed class Schema : IMessage<Schema>, IEquatable<Schema>, IDeepCloneable<Schema>, IBufferMessage, IMessage

Reference documentation and code samples for the Cloud Dataplex v1 API class Schema.

Schema information describing the structure and layout of the data.

Inheritance

object > Schema

Namespace

GoogleCloudGoogle.Cloud.DataplexV1

Assembly

Google.Cloud.Dataplex.V1.dll

Constructors

Schema()

public Schema()

Schema(Schema)

public Schema(Schema other)
Parameter
NameDescription
otherSchema

Properties

Fields

public RepeatedField<Schema.Types.SchemaField> Fields { get; }

Optional. The sequence of fields describing data in table entities. Note: BigQuery SchemaFields are immutable.

Property Value
TypeDescription
RepeatedFieldSchemaTypesSchemaField

PartitionFields

public RepeatedField<Schema.Types.PartitionField> PartitionFields { get; }

Optional. The sequence of fields describing the partition structure in entities. If this field is empty, there are no partitions within the data.

Property Value
TypeDescription
RepeatedFieldSchemaTypesPartitionField

PartitionStyle

public Schema.Types.PartitionStyle PartitionStyle { get; set; }

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

Property Value
TypeDescription
SchemaTypesPartitionStyle

UserManaged

public bool UserManaged { get; set; }

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.

Property Value
TypeDescription
bool