org.apache.beam.sdk.io.aws.options

Interface S3Options

All Superinterfaces:

AwsOptions, HasDisplayData, PipelineOptions

public interface S3Options
extends AwsOptions

Options used to configure Amazon Web Services S3.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	S3Options.S3UploadBufferSizeBytesFactory Provide the default s3 upload buffer size in bytes: 64MB if more than 512MB in RAM are available and 5MB otherwise.

Nested classes/interfaces inherited from interface org.apache.beam.sdk.io.aws.options.AwsOptions

AwsOptions.AwsRegionFactory, AwsOptions.AwsUserCredentialsFactory, AwsOptions.ClientConfigurationFactory

Nested classes/interfaces inherited from interface org.apache.beam.sdk.options.PipelineOptions

PipelineOptions.AtomicLongFactory, PipelineOptions.CheckEnabled, PipelineOptions.DirectRunner, PipelineOptions.JobNameFactory, PipelineOptions.UserAgentFactory

Method Summary

Modifier and Type	Method and Description
boolean	getBucketKeyEnabled()
java.lang.Class<? extends S3ClientBuilderFactory>	getS3ClientFactoryClass()
java.lang.String	getS3StorageClass()
int	getS3ThreadPoolSize()
java.lang.Integer	getS3UploadBufferSizeBytes()
@Nullable java.lang.String	getSSEAlgorithm()
@Nullable SSEAwsKeyManagementParams	getSSEAwsKeyManagementParams()
@Nullable SSECustomerKey	getSSECustomerKey()
void	setBucketKeyEnabled(boolean value)
void	setS3ClientFactoryClass(java.lang.Class<? extends S3ClientBuilderFactory> s3ClientFactoryClass)
void	setS3StorageClass(java.lang.String value)
void	setS3ThreadPoolSize(int value)
void	setS3UploadBufferSizeBytes(java.lang.Integer value)
void	setSSEAlgorithm(java.lang.String value)
void	setSSEAwsKeyManagementParams(SSEAwsKeyManagementParams value)
void	setSSECustomerKey(SSECustomerKey value)

Methods inherited from interface org.apache.beam.sdk.io.aws.options.AwsOptions

getAwsCredentialsProvider, getAwsRegion, getAwsServiceEndpoint, getClientConfiguration, setAwsCredentialsProvider, setAwsRegion, setAwsServiceEndpoint, setClientConfiguration

Methods inherited from interface org.apache.beam.sdk.options.PipelineOptions

as, getJobName, getOptionsId, getRunner, getStableUniqueNames, getTempLocation, getUserAgent, outputRuntimeOptions, revision, setJobName, setOptionsId, setRunner, setStableUniqueNames, setTempLocation, setUserAgent

Methods inherited from interface org.apache.beam.sdk.transforms.display.HasDisplayData

populateDisplayData

Method Detail

getS3StorageClass

@Default.String(value="STANDARD")
java.lang.String getS3StorageClass()

setS3StorageClass

void setS3StorageClass(java.lang.String value)

getS3UploadBufferSizeBytes

@Default.InstanceFactory(value=S3Options.S3UploadBufferSizeBytesFactory.class)
java.lang.Integer getS3UploadBufferSizeBytes()

setS3UploadBufferSizeBytes

void setS3UploadBufferSizeBytes(java.lang.Integer value)

getS3ThreadPoolSize

@Default.Integer(value=50)
int getS3ThreadPoolSize()

setS3ThreadPoolSize

void setS3ThreadPoolSize(int value)

getSSEAlgorithm

@Nullable java.lang.String getSSEAlgorithm()

setSSEAlgorithm

void setSSEAlgorithm(java.lang.String value)

getSSECustomerKey

@Nullable SSECustomerKey getSSECustomerKey()

setSSECustomerKey

void setSSECustomerKey(SSECustomerKey value)

getSSEAwsKeyManagementParams

@Nullable SSEAwsKeyManagementParams getSSEAwsKeyManagementParams()

setSSEAwsKeyManagementParams

void setSSEAwsKeyManagementParams(SSEAwsKeyManagementParams value)

getBucketKeyEnabled

@Default.Boolean(value=false)
boolean getBucketKeyEnabled()

setBucketKeyEnabled

void setBucketKeyEnabled(boolean value)

getS3ClientFactoryClass

@Default.Class(value=DefaultS3ClientBuilderFactory.class)
java.lang.Class<? extends S3ClientBuilderFactory> getS3ClientFactoryClass()

setS3ClientFactoryClass

void setS3ClientFactoryClass(java.lang.Class<? extends S3ClientBuilderFactory> s3ClientFactoryClass)