Struct DumpConfig

pub struct DumpConfig {
    pub credentials_file: Option<String>,
    pub iteration_delay: Option<DurationAsStdSchemaProvider>,
    pub location: ExternalStorageLocation,
    pub restart_dump_for_shards: Option<Vec<ShardId>>,
}

Configures how to dump state to external storage.

JSON schema

{
 "description": "Configures how to dump state to external storage.",
 "type": "object",
 "required": [
   "location"
 ],
 "properties": {
   "credentials_file": {
     "description": "Location of a json file with credentials allowing write access to the bucket.",
     "type": [
       "string",
       "null"
     ]
   },
   "iteration_delay": {
     "description": "How often to check if a new epoch has started.\n Feel free to set to `None`, defaults are sensible.",
     "oneOf": [
       {
         "type": "null"
       },
       {
         "allOf": [
           {
             "$ref": "#/components/schemas/DurationAsStdSchemaProvider"
           }
         ]
       }
     ]
   },
   "location": {
     "description": "Specifies where to write the obtained state parts.",
     "allOf": [
       {
         "$ref": "#/components/schemas/ExternalStorageLocation"
       }
     ]
   },
   "restart_dump_for_shards": {
     "description": "Use in case a node that dumps state to the external storage\n gets in trouble.",
     "type": [
       "array",
       "null"
     ],
     "items": {
       "$ref": "#/components/schemas/ShardId"
     }
   }
 }
}

Fields

credentials_file: Option<String>

Location of a json file with credentials allowing write access to the bucket.

iteration_delay: Option<DurationAsStdSchemaProvider>

How often to check if a new epoch has started. Feel free to set to None, defaults are sensible.

location: ExternalStorageLocation

Specifies where to write the obtained state parts.

restart_dump_for_shards: Option<Vec<ShardId>>

Use in case a node that dumps state to the external storage gets in trouble.

Trait Implementations

impl Clone for DumpConfig

fn clone(&self) -> DumpConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DumpConfig

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for DumpConfig

fn deserialize<__D>( __deserializer: __D, ) -> Result<DumpConfig, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<&DumpConfig> for DumpConfig

fn from(value: &DumpConfig) -> DumpConfig

Converts to this type from the input type.

impl Serialize for DumpConfig

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

where __S: Serializer,

Serialize this value into the given Serde serializer.