Struct S3PutFolderTaskletBuilder 

pub struct S3PutFolderTaskletBuilder { /* private fields */ }

Available on crate feature s3 only.

Builder for S3PutFolderTasklet.

Examples

use spring_batch_rs::tasklet::s3::put::S3PutFolderTaskletBuilder;

let tasklet = S3PutFolderTaskletBuilder::new()
    .bucket("my-bucket")
    .prefix("backups/2026-04-10/")
    .local_folder("./exports/")
    .build()?;

Errors

Returns BatchError::Configuration if bucket, prefix, or local_folder are not set.

Implementations

impl S3PutFolderTaskletBuilder

pub fn new() -> Self

Creates a new builder with default settings.

Default chunk_size is 8 MiB.

Examples

use spring_batch_rs::tasklet::s3::put::S3PutFolderTaskletBuilder;

let builder = S3PutFolderTaskletBuilder::new();

pub fn bucket<S: Into<String>>(self, bucket: S) -> Self

Sets the S3 bucket name.

Examples

use spring_batch_rs::tasklet::s3::put::S3PutFolderTaskletBuilder;

let builder = S3PutFolderTaskletBuilder::new().bucket("my-bucket");

pub fn prefix<S: Into<String>>(self, prefix: S) -> Self

Sets the S3 key prefix for uploaded objects.

All uploaded files will be stored under this prefix. Defaults to "" (bucket root).

Examples

use spring_batch_rs::tasklet::s3::put::S3PutFolderTaskletBuilder;

let builder = S3PutFolderTaskletBuilder::new().prefix("backups/2026-04-10/");

pub fn local_folder<P: AsRef<Path>>(self, path: P) -> Self

Sets the local folder path to upload.

Examples

use spring_batch_rs::tasklet::s3::put::S3PutFolderTaskletBuilder;

let builder = S3PutFolderTaskletBuilder::new().local_folder("./exports/");

pub fn region<S: Into<String>>(self, region: S) -> Self

Sets the AWS region.

Defaults to AWS_REGION (or AWS_DEFAULT_REGION) when not set.

Examples

use spring_batch_rs::tasklet::s3::put::S3PutFolderTaskletBuilder;

let builder = S3PutFolderTaskletBuilder::new().region("eu-west-1");

pub fn endpoint_url<S: Into<String>>(self, url: S) -> Self

Sets a custom endpoint URL for S3-compatible services (MinIO, LocalStack).

Examples

use spring_batch_rs::tasklet::s3::put::S3PutFolderTaskletBuilder;

let builder = S3PutFolderTaskletBuilder::new().endpoint_url("http://localhost:9000");

pub fn access_key_id<S: Into<String>>(self, key_id: S) -> Self

Sets the AWS access key ID for explicit credential configuration.

Examples

use spring_batch_rs::tasklet::s3::put::S3PutFolderTaskletBuilder;

let builder = S3PutFolderTaskletBuilder::new().access_key_id("AKIAIOSFODNN7EXAMPLE");

pub fn secret_access_key<S: Into<String>>(self, secret: S) -> Self

Sets the AWS secret access key for explicit credential configuration.

Examples

use spring_batch_rs::tasklet::s3::put::S3PutFolderTaskletBuilder;

let builder = S3PutFolderTaskletBuilder::new().secret_access_key("wJalrXUtnFEMI/K7MDENG");

pub fn chunk_size(self, size: usize) -> Self

Sets the multipart upload chunk size in bytes. Defaults to 8 MiB.

Examples

use spring_batch_rs::tasklet::s3::put::S3PutFolderTaskletBuilder;

let builder = S3PutFolderTaskletBuilder::new().chunk_size(16 * 1024 * 1024);

pub fn build(self) -> Result<S3PutFolderTasklet, BatchError>

Builds the S3PutFolderTasklet.

Errors

Returns BatchError::Configuration if bucket, prefix, or local_folder are not set, or if chunk_size is less than 5 MiB (AWS multipart upload minimum).

Examples

use spring_batch_rs::tasklet::s3::put::S3PutFolderTaskletBuilder;

let tasklet = S3PutFolderTaskletBuilder::new()
    .bucket("my-bucket")
    .prefix("backups/")
    .local_folder("./exports/")
    .build()?;

Trait Implementations

impl Debug for S3PutFolderTaskletBuilder

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for S3PutFolderTaskletBuilder

fn default() -> S3PutFolderTaskletBuilder

Returns the “default value” for a type.