Package com.google.cloud.dataplex.v1

Interface SchemaOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    Schema, Schema.Builder
    public interface SchemaOrBuilder
extends com.google.protobuf.MessageOrBuilder

    • Method Detail

      • getUserManaged

        boolean getUserManaged()
         Required. Set to `true` if user-managed or `false` if managed by Dataplex.
 The default is `false` (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.
        bool user_managed = 1 [(.google.api.field_behavior) = REQUIRED];
        Returns:
        The userManaged.

      • getFieldsList

        List<Schema.SchemaField> getFieldsList()
         Optional. The sequence of fields describing data in table entities.
 **Note:** BigQuery SchemaFields are immutable.
        repeated .google.cloud.dataplex.v1.Schema.SchemaField fields = 2 [(.google.api.field_behavior) = OPTIONAL];

      • getFields

        Schema.SchemaField getFields​(int index)
         Optional. The sequence of fields describing data in table entities.
 **Note:** BigQuery SchemaFields are immutable.
        repeated .google.cloud.dataplex.v1.Schema.SchemaField fields = 2 [(.google.api.field_behavior) = OPTIONAL];

      • getFieldsCount

        int getFieldsCount()
         Optional. The sequence of fields describing data in table entities.
 **Note:** BigQuery SchemaFields are immutable.
        repeated .google.cloud.dataplex.v1.Schema.SchemaField fields = 2 [(.google.api.field_behavior) = OPTIONAL];

      • getFieldsOrBuilderList

        List<? extends Schema.SchemaFieldOrBuilder> getFieldsOrBuilderList()
         Optional. The sequence of fields describing data in table entities.
 **Note:** BigQuery SchemaFields are immutable.
        repeated .google.cloud.dataplex.v1.Schema.SchemaField fields = 2 [(.google.api.field_behavior) = OPTIONAL];

      • getFieldsOrBuilder

        Schema.SchemaFieldOrBuilder getFieldsOrBuilder​(int index)
         Optional. The sequence of fields describing data in table entities.
 **Note:** BigQuery SchemaFields are immutable.
        repeated .google.cloud.dataplex.v1.Schema.SchemaField fields = 2 [(.google.api.field_behavior) = OPTIONAL];

      • getPartitionFieldsList

        List<Schema.PartitionField> getPartitionFieldsList()
         Optional. The sequence of fields describing the partition structure in
 entities. If this field is empty, there are no partitions within the data.
        repeated .google.cloud.dataplex.v1.Schema.PartitionField partition_fields = 3 [(.google.api.field_behavior) = OPTIONAL];

      • getPartitionFields

        Schema.PartitionField getPartitionFields​(int index)
         Optional. The sequence of fields describing the partition structure in
 entities. If this field is empty, there are no partitions within the data.
        repeated .google.cloud.dataplex.v1.Schema.PartitionField partition_fields = 3 [(.google.api.field_behavior) = OPTIONAL];

      • getPartitionFieldsCount

        int getPartitionFieldsCount()
         Optional. The sequence of fields describing the partition structure in
 entities. If this field is empty, there are no partitions within the data.
        repeated .google.cloud.dataplex.v1.Schema.PartitionField partition_fields = 3 [(.google.api.field_behavior) = OPTIONAL];

      • getPartitionFieldsOrBuilderList

        List<? extends Schema.PartitionFieldOrBuilder> getPartitionFieldsOrBuilderList()
         Optional. The sequence of fields describing the partition structure in
 entities. If this field is empty, there are no partitions within the data.
        repeated .google.cloud.dataplex.v1.Schema.PartitionField partition_fields = 3 [(.google.api.field_behavior) = OPTIONAL];

      • getPartitionFieldsOrBuilder

        Schema.PartitionFieldOrBuilder getPartitionFieldsOrBuilder​(int index)
         Optional. The sequence of fields describing the partition structure in
 entities. If this field is empty, there are no partitions within the data.
        repeated .google.cloud.dataplex.v1.Schema.PartitionField partition_fields = 3 [(.google.api.field_behavior) = OPTIONAL];

      • getPartitionStyleValue

        int getPartitionStyleValue()
         Optional. The structure of paths containing partition data within the
 entity.
        .google.cloud.dataplex.v1.Schema.PartitionStyle partition_style = 4 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        The enum numeric value on the wire for partitionStyle.

      • getPartitionStyle

        Schema.PartitionStyle getPartitionStyle()
         Optional. The structure of paths containing partition data within the
 entity.
        .google.cloud.dataplex.v1.Schema.PartitionStyle partition_style = 4 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        The partitionStyle.