org.apache.beam.sdk.io.aws2.s3

Interface S3FileSystemSchemeRegistrar

All Known Implementing Classes:

DefaultS3FileSystemSchemeRegistrar

@Experimental(value=FILESYSTEM)
public interface S3FileSystemSchemeRegistrar

A registrar that creates S3FileSystemConfiguration instances from PipelineOptions.

Users of storage systems that use the S3 protocol have the ability to register a URI scheme by creating a ServiceLoader entry and a concrete implementation of this interface.

It is optional but recommended to use one of the many build time tools such as AutoService to generate the necessary META-INF files automatically.

Method Summary

Modifier and Type	Method and Description
java.lang.Iterable<S3FileSystemConfiguration>	fromOptions(PipelineOptions options) Create zero or more S3FileSystemConfiguration instances from the given PipelineOptions.

Method Detail

fromOptions

java.lang.Iterable<S3FileSystemConfiguration> fromOptions(@Nonnull
                                                          PipelineOptions options)

Create zero or more S3FileSystemConfiguration instances from the given PipelineOptions.

Each scheme is required to be unique among all schemes registered by all S3FileSystemSchemeRegistrars, as well as among all FileSystems registered by all FileSystemRegistrars.