Class StorageFormat.Builder (1.41.0)

public static final class StorageFormat.Builder extends GeneratedMessageV3.Builder<StorageFormat.Builder> implements StorageFormatOrBuilder

Describes the format of the data within its storage location.

Protobuf type google.cloud.dataplex.v1.StorageFormat

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public StorageFormat.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
StorageFormat.Builder
Overrides

build()

public StorageFormat build()
Returns
Type Description
StorageFormat

buildPartial()

public StorageFormat buildPartial()
Returns
Type Description
StorageFormat

clear()

public StorageFormat.Builder clear()
Returns
Type Description
StorageFormat.Builder
Overrides

clearCompressionFormat()

public StorageFormat.Builder clearCompressionFormat()

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

This builder for chaining.

clearCsv()

public StorageFormat.Builder clearCsv()

Optional. Additional information about CSV formatted data.

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

Returns
Type Description
StorageFormat.Builder

clearField(Descriptors.FieldDescriptor field)

public StorageFormat.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
StorageFormat.Builder
Overrides

clearFormat()

public StorageFormat.Builder clearFormat()

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

This builder for chaining.

clearIceberg()

public StorageFormat.Builder clearIceberg()

Optional. Additional information about iceberg tables.

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

Returns
Type Description
StorageFormat.Builder

clearJson()

public StorageFormat.Builder clearJson()

Optional. Additional information about CSV formatted data.

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

Returns
Type Description
StorageFormat.Builder

clearMimeType()

public StorageFormat.Builder clearMimeType()

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
StorageFormat.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public StorageFormat.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
StorageFormat.Builder
Overrides

clearOptions()

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

clone()

public StorageFormat.Builder clone()
Returns
Type Description
StorageFormat.Builder
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.

getCsvBuilder()

public StorageFormat.CsvOptions.Builder getCsvBuilder()

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

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

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

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.

getIcebergBuilder()

public StorageFormat.IcebergOptions.Builder getIcebergBuilder()

Optional. Additional information about iceberg tables.

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

Returns
Type Description
StorageFormat.IcebergOptions.Builder

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.

getJsonBuilder()

public StorageFormat.JsonOptions.Builder getJsonBuilder()

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

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

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.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeCsv(StorageFormat.CsvOptions value)

public StorageFormat.Builder mergeCsv(StorageFormat.CsvOptions value)

Optional. Additional information about CSV formatted data.

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

Parameter
Name Description
value StorageFormat.CsvOptions
Returns
Type Description
StorageFormat.Builder

mergeFrom(StorageFormat other)

public StorageFormat.Builder mergeFrom(StorageFormat other)
Parameter
Name Description
other StorageFormat
Returns
Type Description
StorageFormat.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public StorageFormat.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
StorageFormat.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public StorageFormat.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
StorageFormat.Builder
Overrides

mergeIceberg(StorageFormat.IcebergOptions value)

public StorageFormat.Builder mergeIceberg(StorageFormat.IcebergOptions value)

Optional. Additional information about iceberg tables.

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

Parameter
Name Description
value StorageFormat.IcebergOptions
Returns
Type Description
StorageFormat.Builder

mergeJson(StorageFormat.JsonOptions value)

public StorageFormat.Builder mergeJson(StorageFormat.JsonOptions value)

Optional. Additional information about CSV formatted data.

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

Parameter
Name Description
value StorageFormat.JsonOptions
Returns
Type Description
StorageFormat.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final StorageFormat.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
StorageFormat.Builder
Overrides

setCompressionFormat(StorageFormat.CompressionFormat value)

public StorageFormat.Builder setCompressionFormat(StorageFormat.CompressionFormat value)

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

Parameter
Name Description
value StorageFormat.CompressionFormat

The compressionFormat to set.

Returns
Type Description
StorageFormat.Builder

This builder for chaining.

setCompressionFormatValue(int value)

public StorageFormat.Builder setCompressionFormatValue(int value)

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

Parameter
Name Description
value int

The enum numeric value on the wire for compressionFormat to set.

Returns
Type Description
StorageFormat.Builder

This builder for chaining.

setCsv(StorageFormat.CsvOptions value)

public StorageFormat.Builder setCsv(StorageFormat.CsvOptions value)

Optional. Additional information about CSV formatted data.

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

Parameter
Name Description
value StorageFormat.CsvOptions
Returns
Type Description
StorageFormat.Builder

setCsv(StorageFormat.CsvOptions.Builder builderForValue)

public StorageFormat.Builder setCsv(StorageFormat.CsvOptions.Builder builderForValue)

Optional. Additional information about CSV formatted data.

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

Parameter
Name Description
builderForValue StorageFormat.CsvOptions.Builder
Returns
Type Description
StorageFormat.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public StorageFormat.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
StorageFormat.Builder
Overrides

setFormat(StorageFormat.Format value)

public StorageFormat.Builder setFormat(StorageFormat.Format value)

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

Parameter
Name Description
value StorageFormat.Format

The format to set.

Returns
Type Description
StorageFormat.Builder

This builder for chaining.

setFormatValue(int value)

public StorageFormat.Builder setFormatValue(int value)

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

Parameter
Name Description
value int

The enum numeric value on the wire for format to set.

Returns
Type Description
StorageFormat.Builder

This builder for chaining.

setIceberg(StorageFormat.IcebergOptions value)

public StorageFormat.Builder setIceberg(StorageFormat.IcebergOptions value)

Optional. Additional information about iceberg tables.

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

Parameter
Name Description
value StorageFormat.IcebergOptions
Returns
Type Description
StorageFormat.Builder

setIceberg(StorageFormat.IcebergOptions.Builder builderForValue)

public StorageFormat.Builder setIceberg(StorageFormat.IcebergOptions.Builder builderForValue)

Optional. Additional information about iceberg tables.

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

Parameter
Name Description
builderForValue StorageFormat.IcebergOptions.Builder
Returns
Type Description
StorageFormat.Builder

setJson(StorageFormat.JsonOptions value)

public StorageFormat.Builder setJson(StorageFormat.JsonOptions value)

Optional. Additional information about CSV formatted data.

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

Parameter
Name Description
value StorageFormat.JsonOptions
Returns
Type Description
StorageFormat.Builder

setJson(StorageFormat.JsonOptions.Builder builderForValue)

public StorageFormat.Builder setJson(StorageFormat.JsonOptions.Builder builderForValue)

Optional. Additional information about CSV formatted data.

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

Parameter
Name Description
builderForValue StorageFormat.JsonOptions.Builder
Returns
Type Description
StorageFormat.Builder

setMimeType(String value)

public StorageFormat.Builder setMimeType(String value)

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

Parameter
Name Description
value String

The mimeType to set.

Returns
Type Description
StorageFormat.Builder

This builder for chaining.

setMimeTypeBytes(ByteString value)

public StorageFormat.Builder setMimeTypeBytes(ByteString value)

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

Parameter
Name Description
value ByteString

The bytes for mimeType to set.

Returns
Type Description
StorageFormat.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public StorageFormat.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
StorageFormat.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final StorageFormat.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
StorageFormat.Builder
Overrides