Class StorageFormat (1.12.0)

Version 1.12.0

• 1.51.0 (latest)
• 1.50.0
• 1.49.0
• 1.47.0
• 1.46.0
• 1.45.0
• 1.44.0
• 1.43.0
• 1.42.0
• 1.41.0
• 1.40.0
• 1.39.0
• 1.38.0
• 1.37.0
• 1.35.0
• 1.34.0
• 1.33.0
• 1.32.0
• 1.31.0
• 1.30.0
• 1.29.0
• 1.28.0
• 1.27.0
• 1.26.0
• 1.25.0
• 1.22.0
• 1.21.0
• 1.20.0
• 1.19.0
• 1.18.0
• 1.17.0
• 1.16.0
• 1.15.0
• 1.14.0
• 1.13.0
• 1.12.0
• 1.11.0
• 1.10.0
• 1.9.0
• 1.7.0
• 1.6.0
• 1.5.0
• 1.4.0
• 1.3.0
• 1.2.0
• 1.1.2
• 1.0.1
• 0.2.2

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

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > StorageFormat

Implements

StorageFormatOrBuilder

Inherited Members

AbstractMessage.equals(Object)

AbstractMessage.findInitializationErrors()

AbstractMessage.getInitializationErrorString()

AbstractMessage.hashBoolean(boolean)

AbstractMessage.hashCode()

AbstractMessage.hashEnum(Internal.EnumLite)

AbstractMessage.hashEnumList(List<? extends Internal.EnumLite>)

AbstractMessage.hashFields(int,Map<Descriptors.FieldDescriptor,Object>)

AbstractMessage.hashLong(long)

AbstractMessage.toString()

AbstractMessageLite.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.checkByteStringIsUtf8(ByteString)

AbstractMessageLite.toByteArray()

AbstractMessageLite.toByteString()

AbstractMessageLite.writeDelimitedTo(OutputStream)

AbstractMessageLite.writeTo(OutputStream)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessageV3.<V>serializeBooleanMapTo(CodedOutputStream,MapField<Boolean,V>,MapEntry<Boolean,V>,int)

GeneratedMessageV3.<V>serializeIntegerMapTo(CodedOutputStream,MapField<Integer,V>,MapEntry<Integer,V>,int)

GeneratedMessageV3.<V>serializeLongMapTo(CodedOutputStream,MapField<Long,V>,MapEntry<Long,V>,int)

GeneratedMessageV3.<V>serializeStringMapTo(CodedOutputStream,MapField<String,V>,MapEntry<String,V>,int)

GeneratedMessageV3.canUseUnsafe()

GeneratedMessageV3.computeStringSize(int,Object)

GeneratedMessageV3.computeStringSizeNoTag(Object)

GeneratedMessageV3.emptyBooleanList()

GeneratedMessageV3.emptyDoubleList()

GeneratedMessageV3.emptyFloatList()

GeneratedMessageV3.emptyIntList()

GeneratedMessageV3.emptyLongList()

GeneratedMessageV3.getAllFields()

GeneratedMessageV3.getDescriptorForType()

GeneratedMessageV3.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.getParserForType()

GeneratedMessageV3.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessageV3.getSerializedSize()

GeneratedMessageV3.getUnknownFields()

GeneratedMessageV3.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.internalGetFieldAccessorTable()

GeneratedMessageV3.internalGetMapField(int)

GeneratedMessageV3.isInitialized()

GeneratedMessageV3.isStringEmpty(Object)

GeneratedMessageV3.makeExtensionsImmutable()

GeneratedMessageV3.mergeFromAndMakeImmutableInternal(CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.mutableCopy(Internal.BooleanList)

GeneratedMessageV3.mutableCopy(Internal.DoubleList)

GeneratedMessageV3.mutableCopy(Internal.FloatList)

GeneratedMessageV3.mutableCopy(Internal.IntList)

GeneratedMessageV3.mutableCopy(Internal.LongList)

GeneratedMessageV3.newBooleanList()

GeneratedMessageV3.newBuilderForType(AbstractMessage.BuilderParent)

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent)

GeneratedMessageV3.newDoubleList()

GeneratedMessageV3.newFloatList()

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter)

GeneratedMessageV3.newIntList()

GeneratedMessageV3.newLongList()

GeneratedMessageV3.parseUnknownField(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.parseUnknownFieldProto3(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.writeReplace()

GeneratedMessageV3.writeString(CodedOutputStream,int,Object)

GeneratedMessageV3.writeStringNoTag(CodedOutputStream,Object)

GeneratedMessageV3.writeTo(CodedOutputStream)

Object.clone()

Object.finalize()

Object.getClass()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

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

AbstractMessage.equals(Object other)

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

GeneratedMessageV3.getParserForType()

getSerializedSize()

public int getSerializedSize()

Returns
Type	Description
int

Overrides

GeneratedMessageV3.getSerializedSize()

getUnknownFields()

public final UnknownFieldSet getUnknownFields()

Returns
Type	Description
UnknownFieldSet

Overrides

GeneratedMessageV3.getUnknownFields()

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

AbstractMessage.hashCode()

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
FieldAccessorTable

Overrides

GeneratedMessageV3.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessageV3.isInitialized()

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

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent parent)

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

Parameter
Name	Description
unused	UnusedPrivateParameter

Returns
Type	Description
Object

Overrides

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

toBuilder()

public StorageFormat.Builder toBuilder()

Returns
Type	Description
StorageFormat.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)

Parameter
Name	Description
output	CodedOutputStream

Overrides

GeneratedMessageV3.writeTo(CodedOutputStream output)

Exceptions
Type	Description
IOException