org.apache.beam.sdk.io

Interface FileBasedSink.OutputFileHints

All Superinterfaces:

java.io.Serializable

All Known Subinterfaces:

FileBasedSink.WritableByteChannelFactory

All Known Implementing Classes:

FileBasedSink.CompressionType

Enclosing class:

FileBasedSink<UserT,DestinationT,OutputT>

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

Provides hints about how to generate output files, such as a suggested filename suffix (e.g. based on the compression type), and the file MIME type.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getMimeType() Returns the MIME type that should be used for the files that will hold the output data.
java.lang.String	getSuggestedFilenameSuffix()

Method Detail

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 Compression.UNCOMPRESSED).

See Also:

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

getSuggestedFilenameSuffix

@Nullable
java.lang.String getSuggestedFilenameSuffix()

Returns:

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