Class FileIO.ReadMatches
- java.lang.Object
-
- org.apache.beam.sdk.transforms.PTransform<PCollection<MatchResult.Metadata>,PCollection<FileIO.ReadableFile>>
-
- org.apache.beam.sdk.io.FileIO.ReadMatches
-
- All Implemented Interfaces:
java.io.Serializable
,HasDisplayData
- Enclosing class:
- FileIO
public abstract static class FileIO.ReadMatches extends PTransform<PCollection<MatchResult.Metadata>,PCollection<FileIO.ReadableFile>>
Implementation ofFileIO.readMatches()
.- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
FileIO.ReadMatches.DirectoryTreatment
Enum to control how directories are handled.
-
Field Summary
-
Fields inherited from class org.apache.beam.sdk.transforms.PTransform
name, resourceHints
-
-
Constructor Summary
Constructors Constructor Description ReadMatches()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description PCollection<FileIO.ReadableFile>
expand(PCollection<MatchResult.Metadata> input)
Override this method to specify how thisPTransform
should be expanded on the givenInputT
.void
populateDisplayData(DisplayData.Builder builder)
Register display data for the given transform or component.FileIO.ReadMatches
withCompression(Compression compression)
Reads files using the givenCompression
.FileIO.ReadMatches
withDirectoryTreatment(FileIO.ReadMatches.DirectoryTreatment directoryTreatment)
Controls how to handle directories in the inputPCollection
.-
Methods inherited from class org.apache.beam.sdk.transforms.PTransform
compose, compose, getAdditionalInputs, getDefaultOutputCoder, getDefaultOutputCoder, getDefaultOutputCoder, getKindString, getName, getResourceHints, setResourceHints, toString, validate, validate
-
-
-
-
Method Detail
-
withCompression
public FileIO.ReadMatches withCompression(Compression compression)
Reads files using the givenCompression
. Default isCompression.AUTO
.
-
withDirectoryTreatment
public FileIO.ReadMatches withDirectoryTreatment(FileIO.ReadMatches.DirectoryTreatment directoryTreatment)
Controls how to handle directories in the inputPCollection
. Default isFileIO.ReadMatches.DirectoryTreatment.SKIP
.
-
expand
public PCollection<FileIO.ReadableFile> expand(PCollection<MatchResult.Metadata> input)
Description copied from class:PTransform
Override this method to specify how thisPTransform
should be expanded on the givenInputT
.NOTE: This method should not be called directly. Instead apply the
PTransform
should be applied to theInputT
using theapply
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 classPTransform<PCollection<MatchResult.Metadata>,PCollection<FileIO.ReadableFile>>
-
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 viaDisplayData.from(HasDisplayData)
. Implementations may callsuper.populateDisplayData(builder)
in order to register display data in the current namespace, but should otherwise usesubcomponent.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 interfaceHasDisplayData
- Overrides:
populateDisplayData
in classPTransform<PCollection<MatchResult.Metadata>,PCollection<FileIO.ReadableFile>>
- Parameters:
builder
- The builder to populate with display data.- See Also:
HasDisplayData
-
-