Package com.google.cloud.dataplex.v1

Class Schema.Builder

  • All Implemented Interfaces:
    SchemaOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
    Enclosing class:
    Schema
    public static final class Schema.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<Schema.Builder>
implements SchemaOrBuilder
     Schema information describing the structure and layout of the data.
    Protobuf type google.cloud.dataplex.v1.Schema

    • Method Detail

      • getDescriptor

        public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<Schema.Builder>

      • clear

        public Schema.Builder clear()
        Specified by:
        clear in interface com.google.protobuf.Message.Builder
        Specified by:
        clear in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        clear in class com.google.protobuf.GeneratedMessageV3.Builder<Schema.Builder>

      • getDescriptorForType

        public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
        Specified by:
        getDescriptorForType in interface com.google.protobuf.Message.Builder
        Specified by:
        getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
        Overrides:
        getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<Schema.Builder>

      • getDefaultInstanceForType

        public Schema getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

      • build

        public Schema build()
        Specified by:
        build in interface com.google.protobuf.Message.Builder
        Specified by:
        build in interface com.google.protobuf.MessageLite.Builder

      • buildPartial

        public Schema buildPartial()
        Specified by:
        buildPartial in interface com.google.protobuf.Message.Builder
        Specified by:
        buildPartial in interface com.google.protobuf.MessageLite.Builder

      • clone

        public Schema.Builder clone()
        Specified by:
        clone in interface com.google.protobuf.Message.Builder
        Specified by:
        clone in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        clone in class com.google.protobuf.GeneratedMessageV3.Builder<Schema.Builder>

      • setField

        public Schema.Builder setField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                               Object value)
        Specified by:
        setField in interface com.google.protobuf.Message.Builder
        Overrides:
        setField in class com.google.protobuf.GeneratedMessageV3.Builder<Schema.Builder>

      • clearField

        public Schema.Builder clearField​(com.google.protobuf.Descriptors.FieldDescriptor field)
        Specified by:
        clearField in interface com.google.protobuf.Message.Builder
        Overrides:
        clearField in class com.google.protobuf.GeneratedMessageV3.Builder<Schema.Builder>

      • clearOneof

        public Schema.Builder clearOneof​(com.google.protobuf.Descriptors.OneofDescriptor oneof)
        Specified by:
        clearOneof in interface com.google.protobuf.Message.Builder
        Overrides:
        clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<Schema.Builder>

      • setRepeatedField

        public Schema.Builder setRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                       int index,
                                       Object value)
        Specified by:
        setRepeatedField in interface com.google.protobuf.Message.Builder
        Overrides:
        setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<Schema.Builder>

      • addRepeatedField

        public Schema.Builder addRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                       Object value)
        Specified by:
        addRepeatedField in interface com.google.protobuf.Message.Builder
        Overrides:
        addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<Schema.Builder>

      • mergeFrom

        public Schema.Builder mergeFrom​(com.google.protobuf.Message other)
        Specified by:
        mergeFrom in interface com.google.protobuf.Message.Builder
        Overrides:
        mergeFrom in class com.google.protobuf.AbstractMessage.Builder<Schema.Builder>

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<Schema.Builder>

      • mergeFrom

        public Schema.Builder mergeFrom​(com.google.protobuf.CodedInputStream input,
                                com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                         throws IOException
        Specified by:
        mergeFrom in interface com.google.protobuf.Message.Builder
        Specified by:
        mergeFrom in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        mergeFrom in class com.google.protobuf.AbstractMessage.Builder<Schema.Builder>
        Throws:
        IOException

      • getUserManaged

        public 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];
        Specified by:
        getUserManaged in interface SchemaOrBuilder
        Returns:
        The userManaged.

      • setUserManaged

        public Schema.Builder setUserManaged​(boolean value)
         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];
        Parameters:
        value - The userManaged to set.
        Returns:
        This builder for chaining.

      • clearUserManaged

        public Schema.Builder clearUserManaged()
         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:
        This builder for chaining.

      • getFieldsList

        public 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];
        Specified by:
        getFieldsList in interface SchemaOrBuilder

      • getFieldsCount

        public 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];
        Specified by:
        getFieldsCount in interface SchemaOrBuilder

      • getFields

        public 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];
        Specified by:
        getFields in interface SchemaOrBuilder

      • setFields

        public Schema.Builder setFields​(int index,
                                Schema.SchemaField value)
         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];

      • setFields

        public Schema.Builder setFields​(int index,
                                Schema.SchemaField.Builder builderForValue)
         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];

      • addFields

        public Schema.Builder addFields​(Schema.SchemaField value)
         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];

      • addFields

        public Schema.Builder addFields​(int index,
                                Schema.SchemaField value)
         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];

      • addFields

        public Schema.Builder addFields​(Schema.SchemaField.Builder builderForValue)
         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];

      • addFields

        public Schema.Builder addFields​(int index,
                                Schema.SchemaField.Builder builderForValue)
         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];

      • addAllFields

        public Schema.Builder addAllFields​(Iterable<? extends Schema.SchemaField> values)
         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];

      • clearFields

        public Schema.Builder clearFields()
         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];

      • removeFields

        public Schema.Builder removeFields​(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];

      • getFieldsBuilder

        public Schema.SchemaField.Builder getFieldsBuilder​(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];

      • getFieldsOrBuilder

        public 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];
        Specified by:
        getFieldsOrBuilder in interface SchemaOrBuilder

      • getFieldsOrBuilderList

        public 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];
        Specified by:
        getFieldsOrBuilderList in interface SchemaOrBuilder

      • addFieldsBuilder

        public Schema.SchemaField.Builder addFieldsBuilder()
         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];

      • addFieldsBuilder

        public Schema.SchemaField.Builder addFieldsBuilder​(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];

      • getFieldsBuilderList

        public List<Schema.SchemaField.Builder> getFieldsBuilderList()
         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

        public 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];
        Specified by:
        getPartitionFieldsList in interface SchemaOrBuilder

      • getPartitionFieldsCount

        public 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];
        Specified by:
        getPartitionFieldsCount in interface SchemaOrBuilder

      • getPartitionFields

        public 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];
        Specified by:
        getPartitionFields in interface SchemaOrBuilder

      • setPartitionFields

        public Schema.Builder setPartitionFields​(int index,
                                         Schema.PartitionField value)
         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];

      • setPartitionFields

        public Schema.Builder setPartitionFields​(int index,
                                         Schema.PartitionField.Builder builderForValue)
         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];

      • addPartitionFields

        public Schema.Builder addPartitionFields​(Schema.PartitionField value)
         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];

      • addPartitionFields

        public Schema.Builder addPartitionFields​(int index,
                                         Schema.PartitionField value)
         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];

      • addPartitionFields

        public Schema.Builder addPartitionFields​(Schema.PartitionField.Builder builderForValue)
         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];

      • addPartitionFields

        public Schema.Builder addPartitionFields​(int index,
                                         Schema.PartitionField.Builder builderForValue)
         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];

      • addAllPartitionFields

        public Schema.Builder addAllPartitionFields​(Iterable<? extends Schema.PartitionField> values)
         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];

      • clearPartitionFields

        public Schema.Builder clearPartitionFields()
         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];

      • removePartitionFields

        public Schema.Builder removePartitionFields​(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];

      • getPartitionFieldsBuilder

        public Schema.PartitionField.Builder getPartitionFieldsBuilder​(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];

      • getPartitionFieldsOrBuilder

        public 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];
        Specified by:
        getPartitionFieldsOrBuilder in interface SchemaOrBuilder

      • getPartitionFieldsOrBuilderList

        public 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];
        Specified by:
        getPartitionFieldsOrBuilderList in interface SchemaOrBuilder

      • addPartitionFieldsBuilder

        public Schema.PartitionField.Builder addPartitionFieldsBuilder()
         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];

      • addPartitionFieldsBuilder

        public Schema.PartitionField.Builder addPartitionFieldsBuilder​(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];

      • getPartitionFieldsBuilderList

        public List<Schema.PartitionField.Builder> getPartitionFieldsBuilderList()
         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

        public 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];
        Specified by:
        getPartitionStyleValue in interface SchemaOrBuilder
        Returns:
        The enum numeric value on the wire for partitionStyle.

      • setPartitionStyleValue

        public Schema.Builder setPartitionStyleValue​(int value)
         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];
        Parameters:
        value - The enum numeric value on the wire for partitionStyle to set.
        Returns:
        This builder for chaining.

      • getPartitionStyle

        public 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];
        Specified by:
        getPartitionStyle in interface SchemaOrBuilder
        Returns:
        The partitionStyle.

      • setPartitionStyle

        public Schema.Builder setPartitionStyle​(Schema.PartitionStyle value)
         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];
        Parameters:
        value - The partitionStyle to set.
        Returns:
        This builder for chaining.

      • clearPartitionStyle

        public Schema.Builder clearPartitionStyle()
         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:
        This builder for chaining.

      • setUnknownFields

        public final Schema.Builder setUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)
        Specified by:
        setUnknownFields in interface com.google.protobuf.Message.Builder
        Overrides:
        setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<Schema.Builder>

      • mergeUnknownFields

        public final Schema.Builder mergeUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)
        Specified by:
        mergeUnknownFields in interface com.google.protobuf.Message.Builder
        Overrides:
        mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<Schema.Builder>