Struct SyncConfig 

pub struct SyncConfig {

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

SyncConfig

JSON schema

{
 "type": "object",
 "required": [
   "bucket"
 ],
 "properties": {
   "access_key": {
     "description": "The access key used to authenticate with the storage provider.\n\nIf not provided, rclone will fall back to environment-based credentials, such as\n`RCLONE_S3_ACCESS_KEY_ID`. In Kubernetes environments using IRSA (IAM Roles for Service Accounts),\nthis can be left empty to allow automatic authentication via the pod's service account.",
     "type": [
       "string",
       "null"
     ]
   },
   "bucket": {
     "description": "The name of the storage bucket.\n\nThis may include a path to a folder inside the bucket (e.g., `my-bucket/data`).",
     "type": "string"
   },
   "checkers": {
     "description": "The number of checkers to run in parallel.\nDefault: 20",
     "type": [
       "integer",
       "null"
     ],
     "format": "int32",
     "minimum": 0.0
   },
   "endpoint": {
     "description": "The endpoint URL for the storage service.\n\nThis is typically required for custom or local S3-compatible storage providers like MinIO.\nExample: `http://localhost:9000`\n\nRelevant rclone config key: [`endpoint`](https://rclone.org/s3/#s3-endpoint)",
     "type": [
       "string",
       "null"
     ]
   },
   "fail_if_no_checkpoint": {
     "description": "When true, the pipeline will fail to initialize if fetching the\nspecified checkpoint fails (missing, download error).\nWhen false, the pipeline will start from scratch instead.\n\nFalse by default.",
     "default": false,
     "type": "boolean"
   },
   "flags": {
     "description": "Extra flags to pass to `rclone`.\n\nWARNING: Supplying incorrect or conflicting flags can break `rclone`.\nUse with caution.\n\nRefer to the docs to see the supported flags:\n- [Global flags](https://rclone.org/flags/)\n- [S3 specific flags](https://rclone.org/s3/)",
     "type": [
       "array",
       "null"
     ],
     "items": {
       "type": "string"
     }
   },
   "ignore_checksum": {
     "description": "Set to skip post copy check of checksums, and only check the file sizes.\nThis can significantly improve the throughput.\nDefualt: false",
     "type": [
       "boolean",
       "null"
     ]
   },
   "multi_thread_cutoff": {
     "description": "Use multi-thread download for files above this size.\nFormat: `[size][Suffix]` (Example: 1G, 500M)\nSupported suffixes: k|M|G|T\nDefault: 100M",
     "type": [
       "string",
       "null"
     ]
   },
   "multi_thread_streams": {
     "description": "Number of streams to use for multi-thread downloads.\nDefault: 10",
     "type": [
       "integer",
       "null"
     ],
     "format": "int32",
     "minimum": 0.0
   },
   "provider": {
     "description": "The name of the cloud storage provider (e.g., `\"AWS\"`, `\"Minio\"`).\n\nUsed for provider-specific behavior in rclone.\nIf omitted, defaults to `\"Other\"`.\n\nSee [rclone S3 provider documentation](https://rclone.org/s3/#s3-provider)",
     "type": [
       "string",
       "null"
     ]
   },
   "pull_interval": {
     "description": "The interval (in seconds) between each attempt to fetch the latest\ncheckpoint from object store while in standby mode.\n\nApplies only when `start_from_checkpoint` is set to `latest`.\n\nDefault: 10 seconds",
     "default": 10,
     "type": "integer",
     "format": "int64",
     "minimum": 0.0
   },
   "push_interval": {
     "description": "The interval (in seconds) between each push of checkpoints to object store.\n\nDefault: disabled (no periodic push).",
     "type": [
       "integer",
       "null"
     ],
     "format": "int64",
     "minimum": 0.0
   },
   "read_bucket": {
     "description": "A read-only bucket used as a fallback checkpoint source.\n\nWhen the pipeline has no local checkpoint and `bucket` contains no\ncheckpoint either, it will attempt to fetch the checkpoint from this\nlocation instead.  All connection settings (`endpoint`, `region`,\n`provider`, `access_key`, `secret_key`) are shared with `bucket`.\n\nThe pipeline **never writes** to `read_bucket`.\n\nMust point to a different location than `bucket`.",
     "type": [
       "string",
       "null"
     ]
   },
   "region": {
     "description": "The region that this bucket is in.\n\nLeave empty for Minio or the default region (`us-east-1` for AWS).",
     "type": [
       "string",
       "null"
     ]
   },
   "retention_min_age": {
     "description": "The minimum age (in days) a checkpoint must reach before it becomes\neligible for deletion. All younger checkpoints will be preserved.\n\nDefault: 30",
     "default": 30,
     "type": "integer",
     "format": "int32",
     "minimum": 0.0
   },
   "retention_min_count": {
     "description": "The minimum number of checkpoints to retain in object store.\nNo checkpoints will be deleted if the total count is below this threshold.\n\nDefault: 10",
     "default": 10,
     "type": "integer",
     "format": "int32",
     "minimum": 0.0
   },
   "secret_key": {
     "description": "The secret key used together with the access key for authentication.\n\nIf not provided, rclone will fall back to environment-based credentials, such as\n`RCLONE_S3_SECRET_ACCESS_KEY`. In Kubernetes environments using IRSA (IAM Roles for Service Accounts),\nthis can be left empty to allow automatic authentication via the pod's service account.",
     "type": [
       "string",
       "null"
     ]
   },
   "standby": {
     "description": "When `true`, the pipeline starts in **standby** mode; processing doesn't\nstart until activation (`POST /activate`).\nIf this pipeline was previously activated and the storage has not been\ncleared, the pipeline will auto activate, no newer checkpoints will be\nfetched.\n\nStandby behavior depends on `start_from_checkpoint`:\n- If `latest`, pipeline continuously fetches the latest available\ncheckpoint until activated.\n- If checkpoint UUID, pipeline fetches this checkpoint once and waits\nin standby until activated.\n\nDefault: `false`",
     "default": false,
     "type": "boolean"
   },
   "start_from_checkpoint": {
     "allOf": [
       {
         "$ref": "#/components/schemas/StartFromCheckpoint"
       }
     ]
   },
   "transfers": {
     "description": "The number of file transfers to run in parallel.\nDefault: 20",
     "type": [
       "integer",
       "null"
     ],
     "format": "int32",
     "minimum": 0.0
   },
   "upload_concurrency": {
     "description": "The number of chunks of the same file that are uploaded for multipart uploads.\nDefault: 10",
     "type": [
       "integer",
       "null"
     ],
     "format": "int32",
     "minimum": 0.0
   }
 }
}

Fields

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.

bucket: String

The name of the storage bucket.

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

checkers: Option<i64>

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

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

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.

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

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_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

multi_thread_streams: Option<i64>

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

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

pull_interval: i64

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<i64>

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

Default: disabled (no periodic push).

read_bucket: Option<String>

A read-only bucket used as a fallback checkpoint source.

When the pipeline has no local checkpoint and bucket contains no checkpoint either, it will attempt to fetch the checkpoint from this location instead. All connection settings (endpoint, region, provider, access_key, secret_key) are shared with bucket.

The pipeline never writes to read_bucket.

Must point to a different location than bucket.

region: Option<String>

The region that this bucket is in.

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

retention_min_age: i64

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

Default: 30

retention_min_count: i64

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

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.

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

start_from_checkpoint: Option<StartFromCheckpoint>

transfers: Option<i64>

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

upload_concurrency: Option<i64>

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

Implementations

impl SyncConfig

pub fn builder() -> SyncConfig

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<'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 From<&SyncConfig> for SyncConfig

fn from(value: &SyncConfig) -> Self

Converts to this type from the input type.

impl From<SyncConfig> for SyncConfig

fn from(value: SyncConfig) -> Self

Converts to this type from the input type.

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 TryFrom<SyncConfig> for SyncConfig

type Error = ConversionError

The type returned in the event of a conversion error.

fn try_from(value: SyncConfig) -> Result<Self, ConversionError>

Performs the conversion.