Struct SystemParams

pub struct SystemParams {

    pub barrier_interval_ms: Option<u32>,
    pub checkpoint_frequency: Option<u64>,
    pub sstable_size_mb: Option<u32>,
    pub block_size_kb: Option<u32>,
    pub bloom_false_positive: Option<f64>,
    pub state_store: Option<String>,
    pub data_directory: Option<String>,
    pub backup_storage_url: Option<String>,
    pub backup_storage_directory: Option<String>,
    pub telemetry_enabled: Option<bool>,
    pub parallel_compact_size_mb: Option<u32>,
    pub max_concurrent_creating_streaming_jobs: Option<u32>,
    pub pause_on_next_bootstrap: Option<bool>,
    pub wasm_storage_url: Option<String>,
    pub enable_tracing: Option<bool>,
    pub use_new_object_prefix_strategy: Option<bool>,
    pub license_key: Option<String>,
    pub time_travel_retention_ms: Option<u64>,
}

The schema for persisted system parameters. Note on backward compatibility:

• Do not remove deprecated fields. Mark them as deprecated instead.
• Do not rename existing fields, since each field is stored separately in the meta store with the field name as the key.
• To modify (rename, change the type or semantic of) a field, introduce a new field suffixed by the version.

Fields

barrier_interval_ms: Option<u32>

checkpoint_frequency: Option<u64>

sstable_size_mb: Option<u32>

block_size_kb: Option<u32>

bloom_false_positive: Option<f64>

state_store: Option<String>

data_directory: Option<String>

backup_storage_url: Option<String>

backup_storage_directory: Option<String>

telemetry_enabled: Option<bool>

👎Deprecated

Deprecated. Use config file instead.

parallel_compact_size_mb: Option<u32>

max_concurrent_creating_streaming_jobs: Option<u32>

pause_on_next_bootstrap: Option<bool>

wasm_storage_url: Option<String>

👎Deprecated

enable_tracing: Option<bool>

use_new_object_prefix_strategy: Option<bool>

license_key: Option<String>

time_travel_retention_ms: Option<u64>

Implementations

impl SystemParams

pub fn barrier_interval_ms(&self) -> u32

Returns the value of barrier_interval_ms, or the default value if barrier_interval_ms is unset.

pub fn checkpoint_frequency(&self) -> u64

Returns the value of checkpoint_frequency, or the default value if checkpoint_frequency is unset.

pub fn sstable_size_mb(&self) -> u32

Returns the value of sstable_size_mb, or the default value if sstable_size_mb is unset.

pub fn block_size_kb(&self) -> u32

Returns the value of block_size_kb, or the default value if block_size_kb is unset.

pub fn bloom_false_positive(&self) -> f64

Returns the value of bloom_false_positive, or the default value if bloom_false_positive is unset.

pub fn state_store(&self) -> &str

Returns the value of state_store, or the default value if state_store is unset.

pub fn data_directory(&self) -> &str

Returns the value of data_directory, or the default value if data_directory is unset.

pub fn backup_storage_url(&self) -> &str

Returns the value of backup_storage_url, or the default value if backup_storage_url is unset.

pub fn backup_storage_directory(&self) -> &str

Returns the value of backup_storage_directory, or the default value if backup_storage_directory is unset.

pub fn telemetry_enabled(&self) -> bool

Returns the value of telemetry_enabled, or the default value if telemetry_enabled is unset.

pub fn parallel_compact_size_mb(&self) -> u32

Returns the value of parallel_compact_size_mb, or the default value if parallel_compact_size_mb is unset.

pub fn max_concurrent_creating_streaming_jobs(&self) -> u32

Returns the value of max_concurrent_creating_streaming_jobs, or the default value if max_concurrent_creating_streaming_jobs is unset.

pub fn pause_on_next_bootstrap(&self) -> bool

Returns the value of pause_on_next_bootstrap, or the default value if pause_on_next_bootstrap is unset.

pub fn wasm_storage_url(&self) -> &str

Returns the value of wasm_storage_url, or the default value if wasm_storage_url is unset.

pub fn enable_tracing(&self) -> bool

Returns the value of enable_tracing, or the default value if enable_tracing is unset.

pub fn use_new_object_prefix_strategy(&self) -> bool

Returns the value of use_new_object_prefix_strategy, or the default value if use_new_object_prefix_strategy is unset.

pub fn license_key(&self) -> &str

Returns the value of license_key, or the default value if license_key is unset.

pub fn time_travel_retention_ms(&self) -> u64

Returns the value of time_travel_retention_ms, or the default value if time_travel_retention_ms is unset.

impl SystemParams

pub fn get_barrier_interval_ms(&self) -> Result<&u32, PbFieldNotFound>

pub fn get_checkpoint_frequency(&self) -> Result<&u64, PbFieldNotFound>

pub fn get_sstable_size_mb(&self) -> Result<&u32, PbFieldNotFound>

pub fn get_block_size_kb(&self) -> Result<&u32, PbFieldNotFound>

pub fn get_bloom_false_positive(&self) -> Result<&f64, PbFieldNotFound>

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

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

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

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

pub fn get_telemetry_enabled(&self) -> Result<&bool, PbFieldNotFound>

pub fn get_parallel_compact_size_mb(&self) -> Result<&u32, PbFieldNotFound>

pub fn get_max_concurrent_creating_streaming_jobs( &self, ) -> Result<&u32, PbFieldNotFound>

pub fn get_pause_on_next_bootstrap(&self) -> Result<&bool, PbFieldNotFound>

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

pub fn get_enable_tracing(&self) -> Result<&bool, PbFieldNotFound>

pub fn get_use_new_object_prefix_strategy( &self, ) -> Result<&bool, PbFieldNotFound>

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

pub fn get_time_travel_retention_ms(&self) -> Result<&u64, PbFieldNotFound>

Trait Implementations

impl Clone for SystemParams

fn clone(&self) -> SystemParams

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SystemParams

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

Directly formatting SystemParams can be inaccurate or leak sensitive information.

Use SystemParamsReader instead.

impl Default for SystemParams

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for SystemParams

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Message for SystemParams

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited( &self, buf: &mut impl BufMut, ) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq for SystemParams

fn eq(&self, other: &SystemParams) -> 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 SystemParams

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for SystemParams