Package org.apache.beam.sdk.io.fileschematransform

Class FileWriteSchemaTransformConfiguration

java.lang.Object

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

@DefaultSchema(AutoValueSchema.class)
public abstract class FileWriteSchemaTransformConfiguration
extends Object

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	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	Description
FileWriteSchemaTransformConfiguration()

Method Summary

Modifier and Type	Method	Description
static FileWriteSchemaTransformConfiguration.Builder	builder()
static FileWriteSchemaTransformConfiguration.CsvConfiguration.Builder	csvConfigurationBuilder()
abstract String	getCompression()	See Compression for expected values.
abstract FileWriteSchemaTransformConfiguration.CsvConfiguration	getCsvConfiguration()
abstract String	getFilenamePrefix()
abstract String	getFilenameSuffix()
abstract String	getFormat()
abstract Integer	getNumShards()
abstract FileWriteSchemaTransformConfiguration.ParquetConfiguration	getParquetConfiguration()
abstract String	getShardNameTemplate()	See ShardNameTemplate for the expected values.
abstract FileWriteSchemaTransformConfiguration.XmlConfiguration	getXmlConfiguration()
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 Details

FileWriteSchemaTransformConfiguration

public FileWriteSchemaTransformConfiguration()

Method Details

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

@SchemaFieldDescription("The format of the file content. Value must be one of: \"avro\", \"csv\", \"json\", \"parquet\", \"xml\"")
public abstract String getFormat()

getFilenamePrefix

@SchemaFieldDescription("A common prefix to use for all generated filenames.")
public abstract String getFilenamePrefix()

getCompression

@SchemaFieldDescription("The compression of all generated shard files. By default, appends the respective extension to the filename. Valid options can be found in: https://beam.apache.org/releases/javadoc/2.46.0/org/apache/beam/sdk/io/Compression.html")
@Nullable
public abstract String getCompression()

See Compression for expected values.

getNumShards

@SchemaFieldDescription("The number of output shards produced; a value of 1 disables sharding.")
@Nullable
public abstract Integer getNumShards()

getShardNameTemplate

@SchemaFieldDescription("Uses the given shard name template for naming output files.")
@Nullable
public abstract String getShardNameTemplate()

See ShardNameTemplate for the expected values.

getFilenameSuffix

@SchemaFieldDescription("Configures the filename suffix for written files.")
@Nullable
public abstract String getFilenameSuffix()

getCsvConfiguration

@SchemaFieldDescription("Configures extra details related to writing CSV formatted files.")
@Nullable
public abstract FileWriteSchemaTransformConfiguration.CsvConfiguration getCsvConfiguration()

getParquetConfiguration

@SchemaFieldDescription("Configures extra details related to writing Parquet formatted files.")
@Nullable
public abstract FileWriteSchemaTransformConfiguration.ParquetConfiguration getParquetConfiguration()

getXmlConfiguration

@SchemaFieldDescription("Configures extra details related to writing XML formatted files.")
@Nullable
public abstract FileWriteSchemaTransformConfiguration.XmlConfiguration getXmlConfiguration()