Class StorageFormat (1.43.0)

public final class StorageFormat extends GeneratedMessageV3 implements StorageFormatOrBuilder

Describes the format of the data within its storage location.

Protobuf type google.cloud.dataplex.v1.StorageFormat

Static Fields

COMPRESSION_FORMAT_FIELD_NUMBER

public static final int COMPRESSION_FORMAT_FIELD_NUMBER
Field Value
Type Description
int

CSV_FIELD_NUMBER

public static final int CSV_FIELD_NUMBER
Field Value
Type Description
int

FORMAT_FIELD_NUMBER

public static final int FORMAT_FIELD_NUMBER
Field Value
Type Description
int

ICEBERG_FIELD_NUMBER

public static final int ICEBERG_FIELD_NUMBER
Field Value
Type Description
int

JSON_FIELD_NUMBER

public static final int JSON_FIELD_NUMBER
Field Value
Type Description
int

MIME_TYPE_FIELD_NUMBER

public static final int MIME_TYPE_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static StorageFormat getDefaultInstance()
Returns
Type Description
StorageFormat

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static StorageFormat.Builder newBuilder()
Returns
Type Description
StorageFormat.Builder

newBuilder(StorageFormat prototype)

public static StorageFormat.Builder newBuilder(StorageFormat prototype)
Parameter
Name Description
prototype StorageFormat
Returns
Type Description
StorageFormat.Builder

parseDelimitedFrom(InputStream input)

public static StorageFormat parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
StorageFormat
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static StorageFormat parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
StorageFormat
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static StorageFormat parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
StorageFormat
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static StorageFormat parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
StorageFormat
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static StorageFormat parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
StorageFormat
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static StorageFormat parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
StorageFormat
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static StorageFormat parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
StorageFormat
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static StorageFormat parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
StorageFormat
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static StorageFormat parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
StorageFormat
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static StorageFormat parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
StorageFormat
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static StorageFormat parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
StorageFormat
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static StorageFormat parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
StorageFormat
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<StorageFormat> parser()
Returns
Type Description
Parser<StorageFormat>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

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];

Returns
Type Description
StorageFormat.CompressionFormat

The compressionFormat.

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];

Returns
Type Description
int

The enum numeric value on the wire for compressionFormat.

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];

Returns
Type Description
StorageFormat.CsvOptions

The csv.

getCsvOrBuilder()

public StorageFormat.CsvOptionsOrBuilder getCsvOrBuilder()

Optional. Additional information about CSV formatted data.

.google.cloud.dataplex.v1.StorageFormat.CsvOptions csv = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
StorageFormat.CsvOptionsOrBuilder

getDefaultInstanceForType()

public StorageFormat getDefaultInstanceForType()
Returns
Type Description
StorageFormat

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];

Returns
Type Description
StorageFormat.Format

The format.

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];

Returns
Type Description
int

The enum numeric value on the wire for format.

getIceberg()

public StorageFormat.IcebergOptions getIceberg()

Optional. Additional information about iceberg tables.

.google.cloud.dataplex.v1.StorageFormat.IcebergOptions iceberg = 12 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
StorageFormat.IcebergOptions

The iceberg.

getIcebergOrBuilder()

public StorageFormat.IcebergOptionsOrBuilder getIcebergOrBuilder()

Optional. Additional information about iceberg tables.

.google.cloud.dataplex.v1.StorageFormat.IcebergOptions iceberg = 12 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
StorageFormat.IcebergOptionsOrBuilder

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];

Returns
Type Description
StorageFormat.JsonOptions

The json.

getJsonOrBuilder()

public StorageFormat.JsonOptionsOrBuilder getJsonOrBuilder()

Optional. Additional information about CSV formatted data.

.google.cloud.dataplex.v1.StorageFormat.JsonOptions json = 11 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
StorageFormat.JsonOptionsOrBuilder

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];

Returns
Type Description
String

The mimeType.

getMimeTypeBytes()

public 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];

Returns
Type Description
ByteString

The bytes for mimeType.

getOptionsCase()

public StorageFormat.OptionsCase getOptionsCase()
Returns
Type Description
StorageFormat.OptionsCase

getParserForType()

public Parser<StorageFormat> getParserForType()
Returns
Type Description
Parser<StorageFormat>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hasCsv()

public boolean hasCsv()

Optional. Additional information about CSV formatted data.

.google.cloud.dataplex.v1.StorageFormat.CsvOptions csv = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the csv field is set.

hasIceberg()

public boolean hasIceberg()

Optional. Additional information about iceberg tables.

.google.cloud.dataplex.v1.StorageFormat.IcebergOptions iceberg = 12 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the iceberg field is set.

hasJson()

public boolean hasJson()

Optional. Additional information about CSV formatted data.

.google.cloud.dataplex.v1.StorageFormat.JsonOptions json = 11 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the json field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public StorageFormat.Builder newBuilderForType()
Returns
Type Description
StorageFormat.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected StorageFormat.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
StorageFormat.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public StorageFormat.Builder toBuilder()
Returns
Type Description
StorageFormat.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException