org.apache.beam.sdk.io

Enum FileBasedSink.CompressionType

java.lang.Object

java.lang.Enum<FileBasedSink.CompressionType>

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

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<FileBasedSink.CompressionType>, FileBasedSink.OutputFileHints, FileBasedSink.WritableByteChannelFactory

Enclosing class:

FileBasedSink<UserT,DestinationT,OutputT>

Deprecated.

use Compression.

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

Enum Constant Summary

Enum Constants

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

Method Summary

Modifier and Type	Method and Description
java.nio.channels.WritableByteChannel	create(java.nio.channels.WritableByteChannel channel) Deprecated.
static FileBasedSink.CompressionType	fromCanonical(Compression canonical) Deprecated.
@Nullable java.lang.String	getMimeType() Deprecated. Returns the MIME type that should be used for the files that will hold the output data.
java.lang.String	getSuggestedFilenameSuffix() Deprecated.
static FileBasedSink.CompressionType	valueOf(java.lang.String name) Deprecated. Returns the enum constant of this type with the specified name.
static FileBasedSink.CompressionType[]	values() Deprecated. Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

UNCOMPRESSED

public static final FileBasedSink.CompressionType UNCOMPRESSED

Deprecated.

See Also:

Compression.UNCOMPRESSED

GZIP

public static final FileBasedSink.CompressionType GZIP

Deprecated.

See Also:

Compression.GZIP

BZIP2

public static final FileBasedSink.CompressionType BZIP2

Deprecated.

See Also:

Compression.BZIP2

ZSTD

public static final FileBasedSink.CompressionType ZSTD

Deprecated.

See Also:

Compression.ZSTD

LZO

public static final FileBasedSink.CompressionType LZO

Deprecated.

See Also:

Compression.LZO

LZOP

public static final FileBasedSink.CompressionType LZOP

Deprecated.

See Also:

Compression.LZOP

DEFLATE

public static final FileBasedSink.CompressionType DEFLATE

Deprecated.

See Also:

Compression.DEFLATE

SNAPPY

public static final FileBasedSink.CompressionType SNAPPY

Deprecated.

See Also:

Compression.SNAPPY

Method Detail

values

public static FileBasedSink.CompressionType[] values()

Deprecated.

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (FileBasedSink.CompressionType c : FileBasedSink.CompressionType.values())
    System.out.println(c);

Returns:

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

valueOf

public static FileBasedSink.CompressionType valueOf(java.lang.String name)

Deprecated.

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

getSuggestedFilenameSuffix

public java.lang.String getSuggestedFilenameSuffix()

Deprecated.

Specified by:

getSuggestedFilenameSuffix in interface FileBasedSink.OutputFileHints

Returns:

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

getMimeType

public @Nullable java.lang.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 java.nio.channels.WritableByteChannel create(java.nio.channels.WritableByteChannel channel)
                                             throws java.io.IOException

Deprecated.

Specified by:

create in interface FileBasedSink.WritableByteChannelFactory

Parameters:

channel - the WritableByteChannel to wrap

Returns:

the WritableByteChannel to be used during output

Throws:

java.io.IOException

fromCanonical

public static FileBasedSink.CompressionType fromCanonical(Compression canonical)

Deprecated.