Package com.google.cloud.dataplex.v1

Class StorageFormat

  • All Implemented Interfaces:
    StorageFormatOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    public final class StorageFormat
extends com.google.protobuf.GeneratedMessageV3
implements StorageFormatOrBuilder
     Describes the format of the data within its storage location.
    Protobuf type google.cloud.dataplex.v1.StorageFormat
    See Also:
    Serialized Form

    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3

      • 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

      • getFormatValue

        public int getFormatValue()
         Output only. The data format associated with the stored data, which
 represents content type values. The value is inferred from mime type.
        .google.cloud.dataplex.v1.StorageFormat.Format format = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getFormatValue in interface StorageFormatOrBuilder
        Returns:
        The enum numeric value on the wire for format.

      • getFormat

        public StorageFormat.Format getFormat()
         Output only. The data format associated with the stored data, which
 represents content type values. The value is inferred from mime type.
        .google.cloud.dataplex.v1.StorageFormat.Format format = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getFormat in interface StorageFormatOrBuilder
        Returns:
        The format.

      • getCompressionFormatValue

        public int getCompressionFormatValue()
         Optional. The compression type associated with the stored data.
 If unspecified, the data is uncompressed.
        .google.cloud.dataplex.v1.StorageFormat.CompressionFormat compression_format = 2 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getCompressionFormatValue in interface StorageFormatOrBuilder
        Returns:
        The enum numeric value on the wire for compressionFormat.

      • getCompressionFormat

        public StorageFormat.CompressionFormat getCompressionFormat()
         Optional. The compression type associated with the stored data.
 If unspecified, the data is uncompressed.
        .google.cloud.dataplex.v1.StorageFormat.CompressionFormat compression_format = 2 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getCompressionFormat in interface StorageFormatOrBuilder
        Returns:
        The compressionFormat.

      • getMimeType

        public String getMimeType()
         Required. The mime type descriptor for the data. Must match the pattern
 {type}/{subtype}. Supported values:

 - application/x-parquet
 - application/x-avro
 - application/x-orc
 - application/x-tfrecord
 - application/x-parquet+iceberg
 - application/x-avro+iceberg
 - application/x-orc+iceberg
 - application/json
 - application/{subtypes}
 - text/csv
 - text/<subtypes>
 - image/{image subtype}
 - video/{video subtype}
 - audio/{audio subtype}
        string mime_type = 3 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getMimeType in interface StorageFormatOrBuilder
        Returns:
        The mimeType.

      • getMimeTypeBytes

        public com.google.protobuf.ByteString getMimeTypeBytes()
         Required. The mime type descriptor for the data. Must match the pattern
 {type}/{subtype}. Supported values:

 - application/x-parquet
 - application/x-avro
 - application/x-orc
 - application/x-tfrecord
 - application/x-parquet+iceberg
 - application/x-avro+iceberg
 - application/x-orc+iceberg
 - application/json
 - application/{subtypes}
 - text/csv
 - text/<subtypes>
 - image/{image subtype}
 - video/{video subtype}
 - audio/{audio subtype}
        string mime_type = 3 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getMimeTypeBytes in interface StorageFormatOrBuilder
        Returns:
        The bytes for mimeType.

      • hasCsv

        public boolean hasCsv()
         Optional. Additional information about CSV formatted data.
        .google.cloud.dataplex.v1.StorageFormat.CsvOptions csv = 10 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        hasCsv in interface StorageFormatOrBuilder
        Returns:
        Whether the csv field is set.

      • getCsv

        public StorageFormat.CsvOptions getCsv()
         Optional. Additional information about CSV formatted data.
        .google.cloud.dataplex.v1.StorageFormat.CsvOptions csv = 10 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getCsv in interface StorageFormatOrBuilder
        Returns:
        The csv.

      • hasJson

        public boolean hasJson()
         Optional. Additional information about CSV formatted data.
        .google.cloud.dataplex.v1.StorageFormat.JsonOptions json = 11 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        hasJson in interface StorageFormatOrBuilder
        Returns:
        Whether the json field is set.

      • getJson

        public StorageFormat.JsonOptions getJson()
         Optional. Additional information about CSV formatted data.
        .google.cloud.dataplex.v1.StorageFormat.JsonOptions json = 11 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getJson in interface StorageFormatOrBuilder
        Returns:
        The json.

      • hasIceberg

        public boolean hasIceberg()
         Optional. Additional information about iceberg tables.
        .google.cloud.dataplex.v1.StorageFormat.IcebergOptions iceberg = 12 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        hasIceberg in interface StorageFormatOrBuilder
        Returns:
        Whether the iceberg field is set.

      • getIceberg

        public StorageFormat.IcebergOptions getIceberg()
         Optional. Additional information about iceberg tables.
        .google.cloud.dataplex.v1.StorageFormat.IcebergOptions iceberg = 12 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getIceberg in interface StorageFormatOrBuilder
        Returns:
        The iceberg.

      • isInitialized

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

      • 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.GeneratedMessageV3
        Throws:
        IOException

      • getSerializedSize

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

      • 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 StorageFormat parseFrom​(ByteBuffer data)
                               throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • newBuilderForType

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

      • toBuilder

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

      • newBuilderForType

        protected StorageFormat.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstance

        public static StorageFormat getDefaultInstance()

      • parser

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

      • getParserForType

        public com.google.protobuf.Parser<StorageFormat> 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.GeneratedMessageV3

      • getDefaultInstanceForType

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