org.apache.beam.sdk.io.fs

Class MatchResult

java.lang.Object

org.apache.beam.sdk.io.fs.MatchResult

public abstract class MatchResult
extends java.lang.Object

The result of FileSystem.match(java.util.List<java.lang.String>).

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MatchResult.Metadata MatchResult.Metadata of a matched file.
static class	MatchResult.Status Status of a MatchResult.

Method Summary

Modifier and Type	Method and Description
static MatchResult	create(MatchResult.Status status, java.io.IOException e) Returns a MatchResult given the MatchResult.Status and IOException.
static MatchResult	create(MatchResult.Status status, java.util.List<MatchResult.Metadata> metadata) Returns a MatchResult given the MatchResult.Status and MatchResult.Metadata.
abstract java.util.List<MatchResult.Metadata>	metadata() MatchResult.Metadata of matched files.
abstract MatchResult.Status	status() Status of the MatchResult.
static MatchResult	unknown() Returns a MatchResult with MatchResult.Status.UNKNOWN.

Methods inherited from class java.lang.Object

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

Method Detail

create

public static MatchResult create(MatchResult.Status status,
                                 java.util.List<MatchResult.Metadata> metadata)

Returns a MatchResult given the MatchResult.Status and MatchResult.Metadata.

create

public static MatchResult create(MatchResult.Status status,
                                 java.io.IOException e)

Returns a MatchResult given the MatchResult.Status and IOException.

unknown

public static MatchResult unknown()

Returns a MatchResult with MatchResult.Status.UNKNOWN.

status

public abstract MatchResult.Status status()

Status of the MatchResult.

metadata

public abstract java.util.List<MatchResult.Metadata> metadata()
                                                       throws java.io.IOException

MatchResult.Metadata of matched files. Note that if status() is MatchResult.Status.NOT_FOUND, this may either throw a FileNotFoundException or return an empty list, depending on the EmptyMatchTreatment used in the FileSystems.match(java.util.List<java.lang.String>) call.

Throws:

java.io.IOException