org.apache.beam.sdk.io.fileschematransform

Class FileWriteSchemaTransformConfiguration

java.lang.Object

org.apache.beam.sdk.io.fileschematransform.FileWriteSchemaTransformConfiguration

@DefaultSchema(value=AutoValueSchema.class)
public abstract class FileWriteSchemaTransformConfiguration
extends java.lang.Object

The configuration for building file writing transforms using SchemaTransform and SchemaTransformProvider.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FileWriteSchemaTransformConfiguration.Builder
static class	FileWriteSchemaTransformConfiguration.CsvConfiguration Configures extra details related to writing CSV formatted files.
static class	FileWriteSchemaTransformConfiguration.ParquetConfiguration Configures extra details related to writing Parquet formatted files.
static class	FileWriteSchemaTransformConfiguration.XmlConfiguration Configures extra details related to writing XML formatted files.

Constructor Summary

Constructors

Constructor and Description
FileWriteSchemaTransformConfiguration()

Method Summary

Modifier and Type	Method and Description
static FileWriteSchemaTransformConfiguration.Builder	builder()
static FileWriteSchemaTransformConfiguration.CsvConfiguration.Builder	csvConfigurationBuilder()
abstract java.lang.String	getCompression() Specifies to compress all generated shard files by default, append the respective extension to the filename.
abstract FileWriteSchemaTransformConfiguration.CsvConfiguration	getCsvConfiguration() Configures extra details related to writing CSV formatted files.
abstract java.lang.String	getFilenamePrefix() Specifies a common prefix to use for all generated filenames.
abstract java.lang.String	getFilenameSuffix() Configures the filename suffix for written files.
abstract java.lang.String	getFormat() The format of the file content.
abstract java.lang.Integer	getNumShards() The number of output shards produced; a value of 1 disables sharding.
abstract FileWriteSchemaTransformConfiguration.ParquetConfiguration	getParquetConfiguration() Configures extra details related to writing Parquet formatted files.
abstract java.lang.String	getShardNameTemplate() Uses the given ShardNameTemplate for naming output files.
abstract FileWriteSchemaTransformConfiguration.XmlConfiguration	getXmlConfiguration() Configures extra details related to writing XML formatted files.
static FileWriteSchemaTransformConfiguration.ParquetConfiguration.Builder	parquetConfigurationBuilder()
static FileWriteSchemaTransformConfiguration.XmlConfiguration.Builder	xmlConfigurationBuilder()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

FileWriteSchemaTransformConfiguration

public FileWriteSchemaTransformConfiguration()

Method Detail

builder

public static FileWriteSchemaTransformConfiguration.Builder builder()

csvConfigurationBuilder

public static FileWriteSchemaTransformConfiguration.CsvConfiguration.Builder csvConfigurationBuilder()

parquetConfigurationBuilder

public static FileWriteSchemaTransformConfiguration.ParquetConfiguration.Builder parquetConfigurationBuilder()

xmlConfigurationBuilder

public static FileWriteSchemaTransformConfiguration.XmlConfiguration.Builder xmlConfigurationBuilder()

getFormat

public abstract java.lang.String getFormat()

The format of the file content. Used as String key lookup of FileWriteSchemaTransformFormatProviders.loadProviders().

getFilenamePrefix

public abstract java.lang.String getFilenamePrefix()

Specifies a common prefix to use for all generated filenames.

getCompression

@Nullable
public abstract java.lang.String getCompression()

Specifies to compress all generated shard files by default, append the respective extension to the filename. See Compression for expected values, though stringified in all lowercase format.

getNumShards

@Nullable
public abstract java.lang.Integer getNumShards()

The number of output shards produced; a value of 1 disables sharding.

getShardNameTemplate

@Nullable
public abstract java.lang.String getShardNameTemplate()

Uses the given ShardNameTemplate for naming output files.

getFilenameSuffix

@Nullable
public abstract java.lang.String getFilenameSuffix()

Configures the filename suffix for written files.

getCsvConfiguration

@Nullable
public abstract FileWriteSchemaTransformConfiguration.CsvConfiguration getCsvConfiguration()

Configures extra details related to writing CSV formatted files.

getParquetConfiguration

@Nullable
public abstract FileWriteSchemaTransformConfiguration.ParquetConfiguration getParquetConfiguration()

Configures extra details related to writing Parquet formatted files.

getXmlConfiguration

@Nullable
public abstract FileWriteSchemaTransformConfiguration.XmlConfiguration getXmlConfiguration()

Configures extra details related to writing XML formatted files.