org.apache.beam.sdk.io

Interface FileBasedSink.WritableByteChannelFactory

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

FileBasedSink.CompressionType

Enclosing class:

FileBasedSink<T>

public static interface FileBasedSink.WritableByteChannelFactory
extends java.io.Serializable

Implementations create instances of WritableByteChannel used by FileBasedSink and related classes to allow decorating, or otherwise transforming, the raw data that would normally be written directly to the WritableByteChannel passed into create(WritableByteChannel).

Subclasses should override Object.toString() with something meaningful, as it is used when building DisplayData.

Method Summary

Modifier and Type	Method and Description
java.nio.channels.WritableByteChannel	create(java.nio.channels.WritableByteChannel channel)
java.lang.String	getFilenameSuffix()
java.lang.String	getMimeType() Returns the MIME type that should be used for the files that will hold the output data.

Method Detail

create

java.nio.channels.WritableByteChannel create(java.nio.channels.WritableByteChannel channel)
                                      throws java.io.IOException

Parameters:

channel - the WritableByteChannel to wrap

Returns:

the WritableByteChannel to be used during output

Throws:

java.io.IOException

getMimeType

@Nullable
java.lang.String getMimeType()

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 FileBasedSink.CompressionType.UNCOMPRESSED).

See Also:

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

getFilenameSuffix

@Nullable
java.lang.String getFilenameSuffix()

Returns:

an optional filename suffix, eg, ".gz" is returned by FileBasedSink.CompressionType.GZIP