Package com.google.cloud.dataplex.v1

Class Schema

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.dataplex.v1.Schema
All Implemented Interfaces:
SchemaOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class Schema extends com.google.protobuf.GeneratedMessage implements SchemaOrBuilder
 Schema information describing the structure and layout of the data.
Protobuf type google.cloud.dataplex.v1.Schema
See Also:

  • Field Details

    • USER_MANAGED_FIELD_NUMBER

      public static final int USER_MANAGED_FIELD_NUMBER
      See Also:

    • FIELDS_FIELD_NUMBER

      public static final int FIELDS_FIELD_NUMBER
      See Also:

    • PARTITION_FIELDS_FIELD_NUMBER

      public static final int PARTITION_FIELDS_FIELD_NUMBER
      See Also:

    • PARTITION_STYLE_FIELD_NUMBER

      public static final int PARTITION_STYLE_FIELD_NUMBER
      See Also:

  • Method Details

    • getDescriptor

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

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage

    • getUserManaged

      public boolean getUserManaged()
       Required. Set to `true` if user-managed or `false` if managed by Dataplex
 Universal Catalog. The default is `false` (managed by Dataplex Universal
 Catalog).

 - Set to `false`to enable Dataplex Universal Catalog 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 Universal
 Catalog treats schema input by the user as though produced by a previous
 Dataplex Universal Catalog 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 Universal Catalog will not
 change schema fields.
      bool user_managed = 1 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getUserManaged in interface SchemaOrBuilder
      Returns:
      The userManaged.

    • 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

    • 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

    • 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

    • 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

    • 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

    • 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

    • 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

    • 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

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

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

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessage

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static Schema parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Schema parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Schema parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Schema parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Schema parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Schema parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Schema parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Schema parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static Schema parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static Schema parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Schema parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Schema parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

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

    • newBuilder

      public static Schema.Builder newBuilder()

    • newBuilder

      public static Schema.Builder newBuilder(Schema prototype)

    • toBuilder

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

    • newBuilderForType

      protected Schema.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static Schema getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<Schema> parser()

    • getParserForType

      public com.google.protobuf.Parser<Schema> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessage

    • getDefaultInstanceForType

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