Package org.apache.beam.sdk.io

Class TFRecordIO.Write

java.lang.Object

org.apache.beam.sdk.transforms.PTransform<PCollection<byte[]>,PDone>

org.apache.beam.sdk.io.TFRecordIO.Write

All Implemented Interfaces:

java.io.Serializable, HasDisplayData

Enclosing class:

TFRecordIO

public abstract static class TFRecordIO.Write
extends PTransform<PCollection<byte[]>,PDone>

Implementation of TFRecordIO.write().

See Also:

Serialized Form

Field Summary

Fields inherited from class org.apache.beam.sdk.transforms.PTransform

name, resourceHints

Constructor Summary

Constructors

Constructor	Description
Write()

Method Summary

Modifier and Type	Method	Description
PDone	expand(PCollection<byte[]> input)	Override this method to specify how this PTransform should be expanded on the given InputT.
void	populateDisplayData(DisplayData.Builder builder)	Register display data for the given transform or component.
TFRecordIO.Write	to(java.lang.String outputPrefix)	Writes TFRecord file(s) with the given output prefix.
TFRecordIO.Write	to(ResourceId outputResource)	Writes TFRecord file(s) with a prefix given by the specified resource.
TFRecordIO.Write	toResource(ValueProvider<ResourceId> outputResource)	Like to(ResourceId).
TFRecordIO.Write	withCompression(Compression compression)	Writes to output files using the specified compression type.
TFRecordIO.Write	withCompressionType(TFRecordIO.CompressionType compressionType)	Deprecated. use withCompression(org.apache.beam.sdk.io.Compression).
TFRecordIO.Write	withNoSpilling()	See WriteFiles.withNoSpilling().
TFRecordIO.Write	withNumShards(int numShards)	Writes to the provided number of shards.
TFRecordIO.Write	withoutSharding()	Forces a single file as output.
TFRecordIO.Write	withShardNameTemplate(java.lang.String shardTemplate)	Uses the given shard name template.
TFRecordIO.Write	withSuffix(java.lang.String suffix)	Writes to the file(s) with the given filename suffix.

Methods inherited from class org.apache.beam.sdk.transforms.PTransform

compose, compose, getAdditionalInputs, getDefaultOutputCoder, getDefaultOutputCoder, getDefaultOutputCoder, getKindString, getName, getResourceHints, setResourceHints, toString, validate, validate

Methods inherited from class java.lang.Object

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

Constructor Detail

Write

public Write()

Method Detail

to

public TFRecordIO.Write to(java.lang.String outputPrefix)

Writes TFRecord file(s) with the given output prefix. The prefix will be used as a to generate a ResourceId using any supported FileSystem.

In addition to their prefix, created files will have a shard identifier (see withNumShards(int)), and end in a common suffix, if given by withSuffix(String).

For more information on filenames, see DefaultFilenamePolicy.

to

@Experimental(FILESYSTEM)
public TFRecordIO.Write to(ResourceId outputResource)

Writes TFRecord file(s) with a prefix given by the specified resource.

In addition to their prefix, created files will have a shard identifier (see withNumShards(int)), and end in a common suffix, if given by withSuffix(String).

For more information on filenames, see DefaultFilenamePolicy.

toResource

@Experimental(FILESYSTEM)
public TFRecordIO.Write toResource(ValueProvider<ResourceId> outputResource)

Like to(ResourceId).

withSuffix

public TFRecordIO.Write withSuffix(java.lang.String suffix)

Writes to the file(s) with the given filename suffix.

See Also:

ShardNameTemplate

withNumShards

public TFRecordIO.Write withNumShards(int numShards)

Writes to the provided number of shards.

Constraining the number of shards is likely to reduce the performance of a pipeline. Setting this value is not recommended unless you require a specific number of output files.

Parameters:

numShards - the number of shards to use, or 0 to let the system decide.

See Also:

ShardNameTemplate

withShardNameTemplate

public TFRecordIO.Write withShardNameTemplate(java.lang.String shardTemplate)

Uses the given shard name template.

See Also:

ShardNameTemplate

withoutSharding

public TFRecordIO.Write withoutSharding()

Forces a single file as output.

Constraining the number of shards is likely to reduce the performance of a pipeline. Using this setting is not recommended unless you truly require a single output file.

This is a shortcut for .withNumShards(1).withShardNameTemplate("")

withCompressionType

@Deprecated
public TFRecordIO.Write withCompressionType(TFRecordIO.CompressionType compressionType)

Deprecated.

use withCompression(org.apache.beam.sdk.io.Compression).

withCompression

public TFRecordIO.Write withCompression(Compression compression)

Writes to output files using the specified compression type.

If no compression type is specified, the default is Compression.UNCOMPRESSED. See TFRecordIO.Read.withCompression(org.apache.beam.sdk.io.Compression) for more details.

withNoSpilling

public TFRecordIO.Write withNoSpilling()

See WriteFiles.withNoSpilling().

expand

public PDone expand(PCollection<byte[]> input)

Description copied from class: PTransform

Override this method to specify how this PTransform should be expanded on the given InputT.

NOTE: This method should not be called directly. Instead apply the PTransform should be applied to the InputT using the apply method.

Composite transforms, which are defined in terms of other transforms, should return the output of one of the composed transforms. Non-composite transforms, which do not apply any transforms internally, should return a new unbound output and register evaluators (via backend-specific registration methods).

Specified by:

expand in class PTransform<PCollection<byte[]>,PDone>

populateDisplayData

public void populateDisplayData(DisplayData.Builder builder)

Description copied from class: PTransform

Register display data for the given transform or component.

populateDisplayData(DisplayData.Builder) is invoked by Pipeline runners to collect display data via DisplayData.from(HasDisplayData). Implementations may call super.populateDisplayData(builder) in order to register display data in the current namespace, but should otherwise use subcomponent.populateDisplayData(builder) to use the namespace of the subcomponent.

By default, does not register any display data. Implementors may override this method to provide their own display data.

Specified by:

populateDisplayData in interface HasDisplayData

Overrides:

populateDisplayData in class PTransform<PCollection<byte[]>,PDone>

Parameters:

builder - The builder to populate with display data.

See Also:

HasDisplayData