org.thales.punch.libraries.punchlang.api

Class S3ResourceHandlerBuilder

java.lang.Object

org.thales.punch.libraries.punchlang.api.AbstractRemoteResourceHandlerBuilder<S3ResourceHandlerBuilder>

org.thales.punch.libraries.punchlang.api.S3ResourceHandlerBuilder

public class S3ResourceHandlerBuilder
extends AbstractRemoteResourceHandlerBuilder<S3ResourceHandlerBuilder>

Use this builder to create a S3 remote resource handler.

A S3 resource is identified by an end point, a bucket, an object name. Additional credentials can be passed as well.

Author:

dimi

Field Summary

Fields inherited from class org.thales.punch.libraries.punchlang.api.AbstractRemoteResourceHandlerBuilder

builder, cron, metricsContext, requiredResource, silent

Constructor Summary

Constructors

Constructor and Description
S3ResourceHandlerBuilder() Ctor

Method Summary

Modifier and Type	Method and Description
Supplier<Tuple>	getTupleSupplier()
S3ResourceHandlerBuilder	setS3Credentials(Path s3Key, Path s3Secret) Set the optional S3 credentials.
S3ResourceHandlerBuilder	setS3ResourceUrl(String s3endpoint, String s3Bucket, String s3Object)

Methods inherited from class org.thales.punch.libraries.punchlang.api.AbstractRemoteResourceHandlerBuilder

setCronExpression, setMetricContext, setRequiredResource, setResourceTupleBuilder, setSilent

Methods inherited from class java.lang.Object

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

Constructor Detail

S3ResourceHandlerBuilder

public S3ResourceHandlerBuilder()

Ctor

Method Detail

getTupleSupplier

public Supplier<Tuple> getTupleSupplier()

Specified by:

getTupleSupplier in class AbstractRemoteResourceHandlerBuilder<S3ResourceHandlerBuilder>

Returns:

the resource tuple supplier.

setS3ResourceUrl

public S3ResourceHandlerBuilder setS3ResourceUrl(String s3endpoint,
                                                 String s3Bucket,
                                                 String s3Object)

Parameters:

s3endpoint - the S3 end point URL

s3Bucket - the bucket

s3Object - the target object name

Returns:

setS3Credentials

public S3ResourceHandlerBuilder setS3Credentials(Path s3Key,
                                                 Path s3Secret)

Set the optional S3 credentials. This is optional if anonymous access is provided.

Paths are expected to conform to a safe usage where someone (typically an K8 init container) provide us with these files at startup.

Parameters:

s3Key -

s3Secret -

Returns:

this builder.