Package org.apache.beam.sdk.io

Enum Class FileBasedSink.CompressionType

java.lang.Object

java.lang.Enum<FileBasedSink.CompressionType>

org.apache.beam.sdk.io.FileBasedSink.CompressionType

All Implemented Interfaces:

Serializable, Comparable<FileBasedSink.CompressionType>, Constable, FileBasedSink.OutputFileHints, FileBasedSink.WritableByteChannelFactory

Enclosing class:

FileBasedSink<UserT,DestinationT,OutputT>

@Deprecated
public static enum FileBasedSink.CompressionType
extends Enum<FileBasedSink.CompressionType>
implements FileBasedSink.WritableByteChannelFactory

Deprecated.

use Compression.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
BZIP2	Deprecated. See Compression.BZIP2.
DEFLATE	Deprecated. See Compression.DEFLATE.
GZIP	Deprecated. See Compression.GZIP.
LZO	Deprecated. See Compression.LZO.
LZOP	Deprecated. See Compression.LZOP.
SNAPPY	Deprecated. See Compression.SNAPPY.
UNCOMPRESSED	Deprecated. See Compression.UNCOMPRESSED.
ZSTD	Deprecated. See Compression.ZSTD.

Method Summary

Modifier and Type	Method	Description
WritableByteChannel	create(WritableByteChannel channel)	Deprecated. Returns the WritableByteChannel to be used during output.
static FileBasedSink.CompressionType	fromCanonical(Compression canonical)	Deprecated.
@Nullable String	getMimeType()	Deprecated. Returns the MIME type that should be used for the files that will hold the output data.
String	getSuggestedFilenameSuffix()	Deprecated. Returns an optional filename suffix, eg, ".gz" is returned for Compression.GZIP.
static FileBasedSink.CompressionType	valueOf(String name)	Deprecated. Returns the enum constant of this class with the specified name.
static FileBasedSink.CompressionType[]	values()	Deprecated. Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

UNCOMPRESSED

public static final FileBasedSink.CompressionType UNCOMPRESSED

Deprecated.

See Compression.UNCOMPRESSED.

GZIP

public static final FileBasedSink.CompressionType GZIP

Deprecated.

See Compression.GZIP.

BZIP2

public static final FileBasedSink.CompressionType BZIP2

Deprecated.

See Compression.BZIP2.

ZSTD

public static final FileBasedSink.CompressionType ZSTD

Deprecated.

See Compression.ZSTD.

LZO

public static final FileBasedSink.CompressionType LZO

Deprecated.

See Compression.LZO.

LZOP

public static final FileBasedSink.CompressionType LZOP

Deprecated.

See Compression.LZOP.

DEFLATE

public static final FileBasedSink.CompressionType DEFLATE

Deprecated.

See Compression.DEFLATE.

SNAPPY

public static final FileBasedSink.CompressionType SNAPPY

Deprecated.

See Compression.SNAPPY.

Method Details

values

public static FileBasedSink.CompressionType[] values()

Deprecated.

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static FileBasedSink.CompressionType valueOf(String name)

Deprecated.

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null

getSuggestedFilenameSuffix

public String getSuggestedFilenameSuffix()

Deprecated.

Description copied from interface: FileBasedSink.OutputFileHints

Returns an optional filename suffix, eg, ".gz" is returned for Compression.GZIP.

Specified by:

getSuggestedFilenameSuffix in interface FileBasedSink.OutputFileHints

getMimeType

public @Nullable String getMimeType()

Deprecated.

Description copied from interface: FileBasedSink.OutputFileHints

Returns the MIME type that should be used for the files that will hold the output data. May return null if this WritableByteChannelFactory does not meaningfully change the MIME type (e.g., for Compression.UNCOMPRESSED).

Specified by:

getMimeType in interface FileBasedSink.OutputFileHints

See Also:

• MimeTypes
• http://www.iana.org/assignments/media-types/media-types.xhtml

create

public WritableByteChannel create(WritableByteChannel channel)
                           throws IOException

Deprecated.

Description copied from interface: FileBasedSink.WritableByteChannelFactory

Returns the WritableByteChannel to be used during output.

Specified by:

create in interface FileBasedSink.WritableByteChannelFactory

Parameters:

channel - the WritableByteChannel to wrap

Throws:

IOException

fromCanonical

public static FileBasedSink.CompressionType fromCanonical(Compression canonical)

Deprecated.