Package org.apache.beam.sdk.io

Class FileIO.Match

java.lang.Object

org.apache.beam.sdk.transforms.PTransform<PBegin,PCollection<MatchResult.Metadata>>

org.apache.beam.sdk.io.FileIO.Match

All Implemented Interfaces:

java.io.Serializable, HasDisplayData

Enclosing class:

FileIO

public abstract static class FileIO.Match
extends PTransform<PBegin,PCollection<MatchResult.Metadata>>

Implementation of FileIO.match().

See Also:

Serialized Form

Field Summary

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

name, resourceHints

Constructor Summary

Constructors

Constructor	Description
Match()

Method Summary

Modifier and Type	Method	Description
FileIO.Match	continuously(org.joda.time.Duration pollInterval, Watch.Growth.TerminationCondition<java.lang.String,?> terminationCondition)	See FileIO.MatchConfiguration.continuously(org.joda.time.Duration, org.apache.beam.sdk.transforms.Watch.Growth.TerminationCondition<java.lang.String, ?>, boolean).
FileIO.Match	continuously(org.joda.time.Duration pollInterval, Watch.Growth.TerminationCondition<java.lang.String,?> terminationCondition, boolean matchUpdatedFiles)	See FileIO.MatchConfiguration.continuously(org.joda.time.Duration, org.apache.beam.sdk.transforms.Watch.Growth.TerminationCondition<java.lang.String, ?>, boolean).
PCollection<MatchResult.Metadata>	expand(PBegin input)	Override this method to specify how this PTransform should be expanded on the given InputT.
FileIO.Match	filepattern(java.lang.String filepattern)	Matches the given filepattern.
FileIO.Match	filepattern(ValueProvider<java.lang.String> filepattern)	Like filepattern(String) but using a ValueProvider.
void	populateDisplayData(DisplayData.Builder builder)	Register display data for the given transform or component.
FileIO.Match	withConfiguration(FileIO.MatchConfiguration configuration)	Sets the FileIO.MatchConfiguration.
FileIO.Match	withEmptyMatchTreatment(EmptyMatchTreatment treatment)	See FileIO.MatchConfiguration.withEmptyMatchTreatment(EmptyMatchTreatment).

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

Match

public Match()

Method Detail

filepattern

public FileIO.Match filepattern(java.lang.String filepattern)

Matches the given filepattern.

filepattern

public FileIO.Match filepattern(ValueProvider<java.lang.String> filepattern)

Like filepattern(String) but using a ValueProvider.

withConfiguration

public FileIO.Match withConfiguration(FileIO.MatchConfiguration configuration)

Sets the FileIO.MatchConfiguration.

withEmptyMatchTreatment

public FileIO.Match withEmptyMatchTreatment(EmptyMatchTreatment treatment)

See FileIO.MatchConfiguration.withEmptyMatchTreatment(EmptyMatchTreatment).

continuously

public FileIO.Match continuously(org.joda.time.Duration pollInterval,
                                 Watch.Growth.TerminationCondition<java.lang.String,?> terminationCondition,
                                 boolean matchUpdatedFiles)

See FileIO.MatchConfiguration.continuously(org.joda.time.Duration, org.apache.beam.sdk.transforms.Watch.Growth.TerminationCondition<java.lang.String, ?>, boolean). The returned PCollection is unbounded.

This works only in runners supporting splittable DoFn.

continuously

public FileIO.Match continuously(org.joda.time.Duration pollInterval,
                                 Watch.Growth.TerminationCondition<java.lang.String,?> terminationCondition)

See FileIO.MatchConfiguration.continuously(org.joda.time.Duration, org.apache.beam.sdk.transforms.Watch.Growth.TerminationCondition<java.lang.String, ?>, boolean). The returned PCollection is unbounded.

This works only in runners supporting splittable DoFn.

expand

public PCollection<MatchResult.Metadata> expand(PBegin 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<PBegin,PCollection<MatchResult.Metadata>>

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<PBegin,PCollection<MatchResult.Metadata>>

Parameters:

builder - The builder to populate with display data.

See Also:

HasDisplayData