Struct SyncConfig 

pub struct SyncConfig {

    pub endpoint: Option<String>,
    pub bucket: String,
    pub region: Option<String>,
    pub provider: Option<String>,
    pub access_key: Option<String>,
    pub secret_key: Option<String>,
    pub start_from_checkpoint: Option<StartFromCheckpoint>,
    pub fail_if_no_checkpoint: bool,
    pub transfers: Option<u8>,
    pub checkers: Option<u8>,
    pub ignore_checksum: Option<bool>,
    pub multi_thread_streams: Option<u8>,
    pub multi_thread_cutoff: Option<String>,
    pub upload_concurrency: Option<u8>,
    pub standby: bool,
    pub pull_interval: u64,
    pub push_interval: Option<u64>,
    pub flags: Option<Vec<String>>,
    pub retention_min_count: u32,
    pub retention_min_age: u32,
}

Fields

endpoint: Option<String>

The endpoint URL for the storage service.

This is typically required for custom or local S3-compatible storage providers like MinIO. Example: http://localhost:9000

Relevant rclone config key: endpoint

bucket: String

The name of the storage bucket.

This may include a path to a folder inside the bucket (e.g., my-bucket/data).

region: Option<String>

The region that this bucket is in.

Leave empty for Minio or the default region (us-east-1 for AWS).

provider: Option<String>

The name of the cloud storage provider (e.g., "AWS", "Minio").

Used for provider-specific behavior in rclone. If omitted, defaults to "Other".

See rclone S3 provider documentation

access_key: Option<String>

The access key used to authenticate with the storage provider.

If not provided, rclone will fall back to environment-based credentials, such as RCLONE_S3_ACCESS_KEY_ID. In Kubernetes environments using IRSA (IAM Roles for Service Accounts), this can be left empty to allow automatic authentication via the pod’s service account.

secret_key: Option<String>

The secret key used together with the access key for authentication.

If not provided, rclone will fall back to environment-based credentials, such as RCLONE_S3_SECRET_ACCESS_KEY. In Kubernetes environments using IRSA (IAM Roles for Service Accounts), this can be left empty to allow automatic authentication via the pod’s service account.

start_from_checkpoint: Option<StartFromCheckpoint>

When set, the pipeline will try fetch the specified checkpoint from the object store.

If fail_if_no_checkpoint is true, the pipeline will fail to initialize.

fail_if_no_checkpoint: bool

When true, the pipeline will fail to initialize if fetching the specified checkpoint fails (missing, download error). When false, the pipeline will start from scratch instead.

False by default.

transfers: Option<u8>

The number of file transfers to run in parallel. Default: 20

checkers: Option<u8>

The number of checkers to run in parallel. Default: 20

ignore_checksum: Option<bool>

Set to skip post copy check of checksums, and only check the file sizes. This can significantly improve the throughput. Defualt: false

multi_thread_streams: Option<u8>

Number of streams to use for multi-thread downloads. Default: 10

multi_thread_cutoff: Option<String>

Use multi-thread download for files above this size. Format: [size][Suffix] (Example: 1G, 500M) Supported suffixes: k|M|G|T Default: 100M

upload_concurrency: Option<u8>

The number of chunks of the same file that are uploaded for multipart uploads. Default: 10

standby: bool

When true, the pipeline starts in standby mode; processing doesn’t start until activation (POST /activate). If this pipeline was previously activated and the storage has not been cleared, the pipeline will auto activate, no newer checkpoints will be fetched.

Standby behavior depends on start_from_checkpoint:

• If latest, pipeline continuously fetches the latest available checkpoint until activated.
• If checkpoint UUID, pipeline fetches this checkpoint once and waits in standby until activated.

Default: false

pull_interval: u64

The interval (in seconds) between each attempt to fetch the latest checkpoint from object store while in standby mode.

Applies only when start_from_checkpoint is set to latest.

Default: 10 seconds

push_interval: Option<u64>

The interval (in seconds) between each push of checkpoints to object store.

Default: disabled (no periodic push).

flags: Option<Vec<String>>

Extra flags to pass to rclone.

WARNING: Supplying incorrect or conflicting flags can break rclone. Use with caution.

Refer to the docs to see the supported flags:

• Global flags
• S3 specific flags

retention_min_count: u32

The minimum number of checkpoints to retain in object store. No checkpoints will be deleted if the total count is below this threshold.

Default: 10

retention_min_age: u32

The minimum age (in days) a checkpoint must reach before it becomes eligible for deletion. All younger checkpoints will be preserved.

Default: 30

Implementations

impl SyncConfig

pub fn validate(&self) -> Result<(), String>

Trait Implementations

impl Clone for SyncConfig

fn clone(&self) -> SyncConfig

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for SyncConfig

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

Formats the value using the given formatter.

impl Default for SyncConfig

fn default() -> SyncConfig

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for SyncConfig

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for SyncConfig

fn eq(&self, other: &SyncConfig) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for SyncConfig

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<'__s> ToSchema<'__s> for SyncConfig

fn schema() -> (&'__s str, RefOr<Schema>)

Return a tuple of name and schema or reference to a schema that can be referenced by the name or inlined directly to responses, request bodies or parameters.

fn aliases() -> Vec<(&'__s str, Schema)>

Optional set of alias schemas for the ToSchema::schema.

impl Eq for SyncConfig

impl StructuralPartialEq for SyncConfig