Package org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.controller.config.distributed.datastore.provider.rev140612

Interface DataStoreProperties

All Superinterfaces:
BindingContract<DataContainer>, BindingObject, DataContainer, DataObject
All Known Subinterfaces:
DataStorePropertiesContainer
@Generated("mdsal-binding-generator") public interface DataStoreProperties extends DataObject

This class represents the following YANG schema fragment defined in module distributed-datastore-provider 

 grouping data-store-properties {
   leaf shard-transaction-idle-timeout-in-minutes {
     default 10;
     type non-zero-uint32-type;
   }
   leaf shard-snapshot-batch-count {
     default 20000;
     type non-zero-uint32-type;
   }
   leaf shard-snapshot-data-threshold-percentage {
     default 12;
     type percentage;
   }
   leaf shard-snapshot-data-threshold {
     default 0;
     type uint32 {
       range 0..max;
     }
   }
   leaf shard-heartbeat-interval-in-millis {
     default 500;
     type heartbeat-interval-type;
   }
   leaf shard-election-timeout-factor {
     default 20;
     type non-zero-uint32-type;
   }
   leaf operation-timeout-in-seconds {
     default 5;
     type operation-timeout-type;
   }
   leaf shard-journal-recovery-log-batch-size {
     default 1;
     type non-zero-uint32-type;
   }
   leaf shard-transaction-commit-timeout-in-seconds {
     default 30;
     type non-zero-uint32-type;
   }
   leaf shard-transaction-commit-queue-capacity {
     default 50000;
     type non-zero-uint32-type;
   }
   leaf shard-commit-queue-expiry-timeout-in-seconds {
     default 120;
     type non-zero-uint32-type;
   }
   leaf shard-initialization-timeout-in-seconds {
     default 300;
     type non-zero-uint32-type;
   }
   leaf shard-leader-election-timeout-in-seconds {
     default 30;
     type non-zero-uint32-type;
   }
   leaf initial-settle-timeout-multiplier {
     default 3;
     type uint32;
   }
   leaf recovery-snapshot-interval-seconds {
     default 0;
     type uint32;
   }
   leaf shard-batched-modification-count {
     default 1000;
     type non-zero-uint32-type;
   }
   leaf enable-metric-capture {
     default false;
     type boolean;
   }
   leaf bounded-mailbox-capacity {
     default 1000;
     type non-zero-uint32-type;
   }
   leaf persistent {
     default true;
     type boolean;
   }
   leaf snapshotOnRootOverwrite {
     default false;
     type boolean;
   }
   leaf shard-isolated-leader-check-interval-in-millis {
     default 5000;
     type heartbeat-interval-type;
   }
   leaf transaction-creation-initial-rate-limit {
     default 100;
     type non-zero-uint32-type;
   }
   leaf transaction-debug-context-enabled {
     default false;
     type boolean;
   }
   leaf custom-raft-policy-implementation {
     default "";
     type string;
   }
   leaf shard-snapshot-chunk-size {
     status deprecated;
     default 491520;
     type non-zero-uint32-type;
   }
   leaf maximum-message-slice-size {
     default 491520;
     type non-zero-uint32-type;
   }
   leaf use-tell-based-protocol {
     status obsolete;
     default false;
     type boolean;
   }
   leaf file-backed-streaming-threshold-in-megabytes {
     default 128;
     type non-zero-uint32-type;
   }
   leaf sync-index-threshold {
     default 10;
     type non-zero-uint32-type;
   }
   leaf backend-aliveness-timer-interval-in-seconds {
     default 30;
     type non-zero-uint32-type;
   }
   leaf frontend-request-timeout-in-seconds {
     default 120;
     type non-zero-uint32-type;
   }
   leaf frontend-no-progress-timeout-in-seconds {
     default 900;
     type non-zero-uint32-type;
   }
   leaf initial-payload-serialized-buffer-capacity {
     default 512;
     type non-zero-uint32-type;
   }
   leaf use-lz4-compression {
     default false;
     type boolean;
   }
   leaf export-on-recovery {
     default off;
     type enumeration {
       enum off;
       enum json;
     }
   }
   leaf recovery-export-base-dir {
     default persistence-export;
     type string;
   }
 }

  • Field Details

    • QNAME

      static final @NonNull QName QNAME
      YANG identifier of the statement represented by this class.

  • Method Details

    • implementedInterface

      Class<? extends DataStoreProperties> implementedInterface()
      Specified by:
      implementedInterface in interface BindingContract<DataContainer>
      Specified by:
      implementedInterface in interface DataObject

    • getShardTransactionIdleTimeoutInMinutes

      NonZeroUint32Type getShardTransactionIdleTimeoutInMinutes()
      Return shardTransactionIdleTimeoutInMinutes, or null if it is not present. 
           
         The maximum amount of time a shard transaction can be idle without receiving any
         messages before it self-destructs.
      Returns:
      NonZeroUint32Type shardTransactionIdleTimeoutInMinutes, or null if it is not present.

    • requireShardTransactionIdleTimeoutInMinutes

      default @NonNull NonZeroUint32Type requireShardTransactionIdleTimeoutInMinutes()
      Return shardTransactionIdleTimeoutInMinutes, guaranteed to be non-null. 
           
         The maximum amount of time a shard transaction can be idle without receiving any
         messages before it self-destructs.
      Returns:
      NonZeroUint32Type shardTransactionIdleTimeoutInMinutes, guaranteed to be non-null.
      Throws:
      NoSuchElementException - if shardTransactionIdleTimeoutInMinutes is not present

    • getShardSnapshotBatchCount

      NonZeroUint32Type getShardSnapshotBatchCount()
      Return shardSnapshotBatchCount, or null if it is not present. 
           
         The minimum number of entries to be present in the in-memory journal log before
         a snapshot is to be taken.
      Returns:
      NonZeroUint32Type shardSnapshotBatchCount, or null if it is not present.

    • requireShardSnapshotBatchCount

      default @NonNull NonZeroUint32Type requireShardSnapshotBatchCount()
      Return shardSnapshotBatchCount, guaranteed to be non-null. 
           
         The minimum number of entries to be present in the in-memory journal log before
         a snapshot is to be taken.
      Returns:
      NonZeroUint32Type shardSnapshotBatchCount, guaranteed to be non-null.
      Throws:
      NoSuchElementException - if shardSnapshotBatchCount is not present

    • getShardSnapshotDataThresholdPercentage

      Percentage getShardSnapshotDataThresholdPercentage()
      Return shardSnapshotDataThresholdPercentage, or null if it is not present. 
           
         The percentage of Runtime.maxMemory() used by the in-memory journal log before a
         snapshot is to be taken. Disabled, if direct threshold is enabled.
      Returns:
      Percentage shardSnapshotDataThresholdPercentage, or null if it is not present.

    • requireShardSnapshotDataThresholdPercentage

      default @NonNull Percentage requireShardSnapshotDataThresholdPercentage()
      Return shardSnapshotDataThresholdPercentage, guaranteed to be non-null. 
           
         The percentage of Runtime.maxMemory() used by the in-memory journal log before a
         snapshot is to be taken. Disabled, if direct threshold is enabled.
      Returns:
      Percentage shardSnapshotDataThresholdPercentage, guaranteed to be non-null.
      Throws:
      NoSuchElementException - if shardSnapshotDataThresholdPercentage is not present

    • getShardSnapshotDataThreshold

      Uint32 getShardSnapshotDataThreshold()
      Return shardSnapshotDataThreshold, or null if it is not present. 
           
         The threshold of in-memory journal size before a snapshot is to be taken. If set
         to 0, direct threshold is disabled and percentage is used instead.
      Returns:
      Uint32 shardSnapshotDataThreshold, or null if it is not present.

    • requireShardSnapshotDataThreshold

      default @NonNull Uint32 requireShardSnapshotDataThreshold()
      Return shardSnapshotDataThreshold, guaranteed to be non-null. 
           
         The threshold of in-memory journal size before a snapshot is to be taken. If set
         to 0, direct threshold is disabled and percentage is used instead.
      Returns:
      Uint32 shardSnapshotDataThreshold, guaranteed to be non-null.
      Throws:
      NoSuchElementException - if shardSnapshotDataThreshold is not present

    • getShardHeartbeatIntervalInMillis

      HeartbeatIntervalType getShardHeartbeatIntervalInMillis()
      Return shardHeartbeatIntervalInMillis, or null if it is not present. 
           
         The interval at which a shard will send a heart beat message to its remote
         shard.
      Returns:
      HeartbeatIntervalType shardHeartbeatIntervalInMillis, or null if it is not present.

    • requireShardHeartbeatIntervalInMillis

      default @NonNull HeartbeatIntervalType requireShardHeartbeatIntervalInMillis()
      Return shardHeartbeatIntervalInMillis, guaranteed to be non-null. 
           
         The interval at which a shard will send a heart beat message to its remote
         shard.
      Returns:
      HeartbeatIntervalType shardHeartbeatIntervalInMillis, guaranteed to be non-null.
      Throws:
      NoSuchElementException - if shardHeartbeatIntervalInMillis is not present

    • getShardElectionTimeoutFactor

      NonZeroUint32Type getShardElectionTimeoutFactor()
      Return shardElectionTimeoutFactor, or null if it is not present. 
           
         The multiplication factor to be used to determine shard election timeout. The
         shard election timeout is determined by multiplying
         shard-heartbeat-interval-in-millis with the shard-election-timeout-factor
      Returns:
      NonZeroUint32Type shardElectionTimeoutFactor, or null if it is not present.

    • requireShardElectionTimeoutFactor

      default @NonNull NonZeroUint32Type requireShardElectionTimeoutFactor()
      Return shardElectionTimeoutFactor, guaranteed to be non-null. 
           
         The multiplication factor to be used to determine shard election timeout. The
         shard election timeout is determined by multiplying
         shard-heartbeat-interval-in-millis with the shard-election-timeout-factor
      Returns:
      NonZeroUint32Type shardElectionTimeoutFactor, guaranteed to be non-null.
      Throws:
      NoSuchElementException - if shardElectionTimeoutFactor is not present

    • getOperationTimeoutInSeconds

      OperationTimeoutType getOperationTimeoutInSeconds()
      Return operationTimeoutInSeconds, or null if it is not present. 
           
         The maximum amount of time for akka operations (remote or local) to complete
         before failing.
      Returns:
      OperationTimeoutType operationTimeoutInSeconds, or null if it is not present.

    • requireOperationTimeoutInSeconds

      default @NonNull OperationTimeoutType requireOperationTimeoutInSeconds()
      Return operationTimeoutInSeconds, guaranteed to be non-null. 
           
         The maximum amount of time for akka operations (remote or local) to complete
         before failing.
      Returns:
      OperationTimeoutType operationTimeoutInSeconds, guaranteed to be non-null.
      Throws:
      NoSuchElementException - if operationTimeoutInSeconds is not present

    • getShardJournalRecoveryLogBatchSize

      NonZeroUint32Type getShardJournalRecoveryLogBatchSize()
      Return shardJournalRecoveryLogBatchSize, or null if it is not present. 
           
         The maximum number of journal log entries to batch on recovery for a shard
         before committing to the data store.
      Returns:
      NonZeroUint32Type shardJournalRecoveryLogBatchSize, or null if it is not present.

    • requireShardJournalRecoveryLogBatchSize

      default @NonNull NonZeroUint32Type requireShardJournalRecoveryLogBatchSize()
      Return shardJournalRecoveryLogBatchSize, guaranteed to be non-null. 
           
         The maximum number of journal log entries to batch on recovery for a shard
         before committing to the data store.
      Returns:
      NonZeroUint32Type shardJournalRecoveryLogBatchSize, guaranteed to be non-null.
      Throws:
      NoSuchElementException - if shardJournalRecoveryLogBatchSize is not present

    • getShardTransactionCommitTimeoutInSeconds

      NonZeroUint32Type getShardTransactionCommitTimeoutInSeconds()
      Return shardTransactionCommitTimeoutInSeconds, or null if it is not present. 
           
         The maximum amount of time a shard transaction three-phase commit can be idle
         without receiving the next messages before it aborts the transaction
      Returns:
      NonZeroUint32Type shardTransactionCommitTimeoutInSeconds, or null if it is not present.

    • requireShardTransactionCommitTimeoutInSeconds

      default @NonNull NonZeroUint32Type requireShardTransactionCommitTimeoutInSeconds()
      Return shardTransactionCommitTimeoutInSeconds, guaranteed to be non-null. 
           
         The maximum amount of time a shard transaction three-phase commit can be idle
         without receiving the next messages before it aborts the transaction
      Returns:
      NonZeroUint32Type shardTransactionCommitTimeoutInSeconds, guaranteed to be non-null.
      Throws:
      NoSuchElementException - if shardTransactionCommitTimeoutInSeconds is not present

    • getShardTransactionCommitQueueCapacity

      NonZeroUint32Type getShardTransactionCommitQueueCapacity()
      Return shardTransactionCommitQueueCapacity, or null if it is not present. 
           
         The maximum allowed capacity for each shard's transaction commit queue.
      Returns:
      NonZeroUint32Type shardTransactionCommitQueueCapacity, or null if it is not present.

    • requireShardTransactionCommitQueueCapacity

      default @NonNull NonZeroUint32Type requireShardTransactionCommitQueueCapacity()
      Return shardTransactionCommitQueueCapacity, guaranteed to be non-null. 
           
         The maximum allowed capacity for each shard's transaction commit queue.
      Returns:
      NonZeroUint32Type shardTransactionCommitQueueCapacity, guaranteed to be non-null.
      Throws:
      NoSuchElementException - if shardTransactionCommitQueueCapacity is not present

    • getShardCommitQueueExpiryTimeoutInSeconds

      NonZeroUint32Type getShardCommitQueueExpiryTimeoutInSeconds()
      Return shardCommitQueueExpiryTimeoutInSeconds, or null if it is not present. 
           
         The maximum amount of time a transaction can remain in a shard's commit queue
         waiting to begin the CanCommit phase as coordinated by the broker front-end.
         Normally this should be quick but latencies can occur in between transaction
         ready and CanCommit or a remote broker could lose connection and CanCommit might
         never occur. Expiring transactions from the queue allows subsequent pending
         transaction to be processed.
      Returns:
      NonZeroUint32Type shardCommitQueueExpiryTimeoutInSeconds, or null if it is not present.

    • requireShardCommitQueueExpiryTimeoutInSeconds

      default @NonNull NonZeroUint32Type requireShardCommitQueueExpiryTimeoutInSeconds()
      Return shardCommitQueueExpiryTimeoutInSeconds, guaranteed to be non-null. 
           
         The maximum amount of time a transaction can remain in a shard's commit queue
         waiting to begin the CanCommit phase as coordinated by the broker front-end.
         Normally this should be quick but latencies can occur in between transaction
         ready and CanCommit or a remote broker could lose connection and CanCommit might
         never occur. Expiring transactions from the queue allows subsequent pending
         transaction to be processed.
      Returns:
      NonZeroUint32Type shardCommitQueueExpiryTimeoutInSeconds, guaranteed to be non-null.
      Throws:
      NoSuchElementException - if shardCommitQueueExpiryTimeoutInSeconds is not present

    • getShardInitializationTimeoutInSeconds

      NonZeroUint32Type getShardInitializationTimeoutInSeconds()
      Return shardInitializationTimeoutInSeconds, or null if it is not present. 
           
         The maximum amount of time to wait for a shard to initialize from persistence on
         startup before failing an operation (eg transaction create and change listener
         registration).
      Returns:
      NonZeroUint32Type shardInitializationTimeoutInSeconds, or null if it is not present.

    • requireShardInitializationTimeoutInSeconds

      default @NonNull NonZeroUint32Type requireShardInitializationTimeoutInSeconds()
      Return shardInitializationTimeoutInSeconds, guaranteed to be non-null. 
           
         The maximum amount of time to wait for a shard to initialize from persistence on
         startup before failing an operation (eg transaction create and change listener
         registration).
      Returns:
      NonZeroUint32Type shardInitializationTimeoutInSeconds, guaranteed to be non-null.
      Throws:
      NoSuchElementException - if shardInitializationTimeoutInSeconds is not present

    • getShardLeaderElectionTimeoutInSeconds

      NonZeroUint32Type getShardLeaderElectionTimeoutInSeconds()
      Return shardLeaderElectionTimeoutInSeconds, or null if it is not present. 
           
         The maximum amount of time to wait for a shard to elect a leader before failing
         an operation (eg transaction create).
      Returns:
      NonZeroUint32Type shardLeaderElectionTimeoutInSeconds, or null if it is not present.

    • requireShardLeaderElectionTimeoutInSeconds

      default @NonNull NonZeroUint32Type requireShardLeaderElectionTimeoutInSeconds()
      Return shardLeaderElectionTimeoutInSeconds, guaranteed to be non-null. 
           
         The maximum amount of time to wait for a shard to elect a leader before failing
         an operation (eg transaction create).
      Returns:
      NonZeroUint32Type shardLeaderElectionTimeoutInSeconds, guaranteed to be non-null.
      Throws:
      NoSuchElementException - if shardLeaderElectionTimeoutInSeconds is not present

    • getInitialSettleTimeoutMultiplier

      Uint32 getInitialSettleTimeoutMultiplier()
      Return initialSettleTimeoutMultiplier, or null if it is not present. 
           
         Multiplier for the maximum amount of time to wait for a shard to elect a leader.
         Zero value means wait indefinitely (as long as it takes).
      Returns:
      Uint32 initialSettleTimeoutMultiplier, or null if it is not present.

    • requireInitialSettleTimeoutMultiplier

      default @NonNull Uint32 requireInitialSettleTimeoutMultiplier()
      Return initialSettleTimeoutMultiplier, guaranteed to be non-null. 
           
         Multiplier for the maximum amount of time to wait for a shard to elect a leader.
         Zero value means wait indefinitely (as long as it takes).
      Returns:
      Uint32 initialSettleTimeoutMultiplier, guaranteed to be non-null.
      Throws:
      NoSuchElementException - if initialSettleTimeoutMultiplier is not present

    • getRecoverySnapshotIntervalSeconds

      Uint32 getRecoverySnapshotIntervalSeconds()
      Return recoverySnapshotIntervalSeconds, or null if it is not present. 
           
         Interval after which a snapshot should be taken during the recovery process.
      Returns:
      Uint32 recoverySnapshotIntervalSeconds, or null if it is not present.

    • requireRecoverySnapshotIntervalSeconds

      default @NonNull Uint32 requireRecoverySnapshotIntervalSeconds()
      Return recoverySnapshotIntervalSeconds, guaranteed to be non-null. 
           
         Interval after which a snapshot should be taken during the recovery process.
      Returns:
      Uint32 recoverySnapshotIntervalSeconds, guaranteed to be non-null.
      Throws:
      NoSuchElementException - if recoverySnapshotIntervalSeconds is not present

    • getShardBatchedModificationCount

      NonZeroUint32Type getShardBatchedModificationCount()
      Return shardBatchedModificationCount, or null if it is not present. 
           
         The number of transaction modification operations (put, merge, delete) to batch
         before sending to the shard transaction actor. Batching improves performance as
         less modifications messages are sent to the actor and thus lessens the chance
         that the transaction actor's mailbox queue could get full.
      Returns:
      NonZeroUint32Type shardBatchedModificationCount, or null if it is not present.

    • requireShardBatchedModificationCount

      default @NonNull NonZeroUint32Type requireShardBatchedModificationCount()
      Return shardBatchedModificationCount, guaranteed to be non-null. 
           
         The number of transaction modification operations (put, merge, delete) to batch
         before sending to the shard transaction actor. Batching improves performance as
         less modifications messages are sent to the actor and thus lessens the chance
         that the transaction actor's mailbox queue could get full.
      Returns:
      NonZeroUint32Type shardBatchedModificationCount, guaranteed to be non-null.
      Throws:
      NoSuchElementException - if shardBatchedModificationCount is not present

    • getEnableMetricCapture

      Boolean getEnableMetricCapture()
      Return enableMetricCapture, or null if it is not present. 
           
         Enable or disable metric capture.
      Returns:
      Boolean enableMetricCapture, or null if it is not present.

    • requireEnableMetricCapture

      default @NonNull Boolean requireEnableMetricCapture()
      Return enableMetricCapture, guaranteed to be non-null. 
           
         Enable or disable metric capture.
      Returns:
      Boolean enableMetricCapture, guaranteed to be non-null.
      Throws:
      NoSuchElementException - if enableMetricCapture is not present

    • getBoundedMailboxCapacity

      NonZeroUint32Type getBoundedMailboxCapacity()
      Return boundedMailboxCapacity, or null if it is not present. 
           
         Max queue size that an actor's mailbox can reach
      Returns:
      NonZeroUint32Type boundedMailboxCapacity, or null if it is not present.

    • requireBoundedMailboxCapacity

      default @NonNull NonZeroUint32Type requireBoundedMailboxCapacity()
      Return boundedMailboxCapacity, guaranteed to be non-null. 
           
         Max queue size that an actor's mailbox can reach
      Returns:
      NonZeroUint32Type boundedMailboxCapacity, guaranteed to be non-null.
      Throws:
      NoSuchElementException - if boundedMailboxCapacity is not present

    • getPersistent

      Boolean getPersistent()
      Return persistent, or null if it is not present. 
           
         Enable or disable data persistence
      Returns:
      Boolean persistent, or null if it is not present.

    • requirePersistent

      default @NonNull Boolean requirePersistent()
      Return persistent, guaranteed to be non-null. 
           
         Enable or disable data persistence
      Returns:
      Boolean persistent, guaranteed to be non-null.
      Throws:
      NoSuchElementException - if persistent is not present

    • getSnapshotOnRootOverwrite

      Boolean getSnapshotOnRootOverwrite()
      Return snapshotOnRootOverwrite, or null if it is not present. 
           
         Enable or disable capturing snapshots on DataTree root overwrites
      Returns:
      Boolean snapshotOnRootOverwrite, or null if it is not present.

    • requireSnapshotOnRootOverwrite

      default @NonNull Boolean requireSnapshotOnRootOverwrite()
      Return snapshotOnRootOverwrite, guaranteed to be non-null. 
           
         Enable or disable capturing snapshots on DataTree root overwrites
      Returns:
      Boolean snapshotOnRootOverwrite, guaranteed to be non-null.
      Throws:
      NoSuchElementException - if snapshotOnRootOverwrite is not present

    • getShardIsolatedLeaderCheckIntervalInMillis

      HeartbeatIntervalType getShardIsolatedLeaderCheckIntervalInMillis()
      Return shardIsolatedLeaderCheckIntervalInMillis, or null if it is not present. 
           
         The interval at which the leader of the shard will check if its majority
         followers are active and term itself as isolated
      Returns:
      HeartbeatIntervalType shardIsolatedLeaderCheckIntervalInMillis, or null if it is not present.

    • requireShardIsolatedLeaderCheckIntervalInMillis

      default @NonNull HeartbeatIntervalType requireShardIsolatedLeaderCheckIntervalInMillis()
      Return shardIsolatedLeaderCheckIntervalInMillis, guaranteed to be non-null. 
           
         The interval at which the leader of the shard will check if its majority
         followers are active and term itself as isolated
      Returns:
      HeartbeatIntervalType shardIsolatedLeaderCheckIntervalInMillis, guaranteed to be non-null.
      Throws:
      NoSuchElementException - if shardIsolatedLeaderCheckIntervalInMillis is not present

    • getTransactionCreationInitialRateLimit

      NonZeroUint32Type getTransactionCreationInitialRateLimit()
      Return transactionCreationInitialRateLimit, or null if it is not present. 
           
         The initial number of transactions per second that are allowed before the data
         store should begin applying back pressure. This number is only used as an
         initial guidance, subsequently the datastore measures the latency for a commit
         and auto-adjusts the rate limit
      Returns:
      NonZeroUint32Type transactionCreationInitialRateLimit, or null if it is not present.

    • requireTransactionCreationInitialRateLimit

      default @NonNull NonZeroUint32Type requireTransactionCreationInitialRateLimit()
      Return transactionCreationInitialRateLimit, guaranteed to be non-null. 
           
         The initial number of transactions per second that are allowed before the data
         store should begin applying back pressure. This number is only used as an
         initial guidance, subsequently the datastore measures the latency for a commit
         and auto-adjusts the rate limit
      Returns:
      NonZeroUint32Type transactionCreationInitialRateLimit, guaranteed to be non-null.
      Throws:
      NoSuchElementException - if transactionCreationInitialRateLimit is not present

    • getTransactionDebugContextEnabled

      Boolean getTransactionDebugContextEnabled()
      Return transactionDebugContextEnabled, or null if it is not present. 
           
         Enable or disable transaction context debug. This will log the call site trace
         for transactions that fail
      Returns:
      Boolean transactionDebugContextEnabled, or null if it is not present.

    • requireTransactionDebugContextEnabled

      default @NonNull Boolean requireTransactionDebugContextEnabled()
      Return transactionDebugContextEnabled, guaranteed to be non-null. 
           
         Enable or disable transaction context debug. This will log the call site trace
         for transactions that fail
      Returns:
      Boolean transactionDebugContextEnabled, guaranteed to be non-null.
      Throws:
      NoSuchElementException - if transactionDebugContextEnabled is not present

    • getCustomRaftPolicyImplementation

      String getCustomRaftPolicyImplementation()
      Return customRaftPolicyImplementation, or null if it is not present. 
           
         A fully qualified java class name. The class should implement
         org.opendaylight.controller.cluster.raft.policy.RaftPolicy. This java class
         should be accessible to the distributed data store OSGi module so that it can be
         dynamically loaded via reflection. For now let's assume that these classes to
         customize raft behaviors should be present in the distributed data store module
         itself. If this property is set to a class which cannot be found then the
         default raft behavior will be applied
      Returns:
      String customRaftPolicyImplementation, or null if it is not present.

    • requireCustomRaftPolicyImplementation

      default @NonNull String requireCustomRaftPolicyImplementation()
      Return customRaftPolicyImplementation, guaranteed to be non-null. 
           
         A fully qualified java class name. The class should implement
         org.opendaylight.controller.cluster.raft.policy.RaftPolicy. This java class
         should be accessible to the distributed data store OSGi module so that it can be
         dynamically loaded via reflection. For now let's assume that these classes to
         customize raft behaviors should be present in the distributed data store module
         itself. If this property is set to a class which cannot be found then the
         default raft behavior will be applied
      Returns:
      String customRaftPolicyImplementation, guaranteed to be non-null.
      Throws:
      NoSuchElementException - if customRaftPolicyImplementation is not present

    • getShardSnapshotChunkSize

      @Deprecated NonZeroUint32Type getShardSnapshotChunkSize()
      Deprecated.
      Return shardSnapshotChunkSize, or null if it is not present. 
           
         When sending a snapshot to a follower, this is the maximum size in bytes for a
         chunk of data.
      Returns:
      NonZeroUint32Type shardSnapshotChunkSize, or null if it is not present.

    • requireShardSnapshotChunkSize

      default @NonNull NonZeroUint32Type requireShardSnapshotChunkSize()
      Return shardSnapshotChunkSize, guaranteed to be non-null. 
           
         When sending a snapshot to a follower, this is the maximum size in bytes for a
         chunk of data.
      Returns:
      NonZeroUint32Type shardSnapshotChunkSize, guaranteed to be non-null.
      Throws:
      NoSuchElementException - if shardSnapshotChunkSize is not present

    • getMaximumMessageSliceSize

      NonZeroUint32Type getMaximumMessageSliceSize()
      Return maximumMessageSliceSize, or null if it is not present. 
           
         When fragmenting messages thru the akka remoting framework, this is the maximum
         size in bytes for a message slice.
      Returns:
      NonZeroUint32Type maximumMessageSliceSize, or null if it is not present.

    • requireMaximumMessageSliceSize

      default @NonNull NonZeroUint32Type requireMaximumMessageSliceSize()
      Return maximumMessageSliceSize, guaranteed to be non-null. 
           
         When fragmenting messages thru the akka remoting framework, this is the maximum
         size in bytes for a message slice.
      Returns:
      NonZeroUint32Type maximumMessageSliceSize, guaranteed to be non-null.
      Throws:
      NoSuchElementException - if maximumMessageSliceSize is not present

    • getUseTellBasedProtocol

      @Deprecated(forRemoval=true) Boolean getUseTellBasedProtocol()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Return useTellBasedProtocol, or null if it is not present. 
           
         Use a newer protocol between the frontend and backend. This feature is
         considered exprerimental at this point.
      Returns:
      Boolean useTellBasedProtocol, or null if it is not present.

    • requireUseTellBasedProtocol

      default @NonNull Boolean requireUseTellBasedProtocol()
      Return useTellBasedProtocol, guaranteed to be non-null. 
           
         Use a newer protocol between the frontend and backend. This feature is
         considered exprerimental at this point.
      Returns:
      Boolean useTellBasedProtocol, guaranteed to be non-null.
      Throws:
      NoSuchElementException - if useTellBasedProtocol is not present

    • getFileBackedStreamingThresholdInMegabytes

      NonZeroUint32Type getFileBackedStreamingThresholdInMegabytes()
      Return fileBackedStreamingThresholdInMegabytes, or null if it is not present. 
           
         When streaming large amounts of data, eg when sending a snapshot to a follower,
         this is the threshold in terms of number of megabytes before it should switch
         from storing in memory to buffering to a file.
      Returns:
      NonZeroUint32Type fileBackedStreamingThresholdInMegabytes, or null if it is not present.

    • requireFileBackedStreamingThresholdInMegabytes

      default @NonNull NonZeroUint32Type requireFileBackedStreamingThresholdInMegabytes()
      Return fileBackedStreamingThresholdInMegabytes, guaranteed to be non-null. 
           
         When streaming large amounts of data, eg when sending a snapshot to a follower,
         this is the threshold in terms of number of megabytes before it should switch
         from storing in memory to buffering to a file.
      Returns:
      NonZeroUint32Type fileBackedStreamingThresholdInMegabytes, guaranteed to be non-null.
      Throws:
      NoSuchElementException - if fileBackedStreamingThresholdInMegabytes is not present

    • getSyncIndexThreshold

      NonZeroUint32Type getSyncIndexThreshold()
      Return syncIndexThreshold, or null if it is not present. 
           
         Permitted synchronization lag, expressed in terms of RAFT entry count. It a
         follower's commitIndex trails the leader's journal by more than this amount of
         entries the follower is considered to be out-of-sync.
      Returns:
      NonZeroUint32Type syncIndexThreshold, or null if it is not present.

    • requireSyncIndexThreshold

      default @NonNull NonZeroUint32Type requireSyncIndexThreshold()
      Return syncIndexThreshold, guaranteed to be non-null. 
           
         Permitted synchronization lag, expressed in terms of RAFT entry count. It a
         follower's commitIndex trails the leader's journal by more than this amount of
         entries the follower is considered to be out-of-sync.
      Returns:
      NonZeroUint32Type syncIndexThreshold, guaranteed to be non-null.
      Throws:
      NoSuchElementException - if syncIndexThreshold is not present

    • getBackendAlivenessTimerIntervalInSeconds

      NonZeroUint32Type getBackendAlivenessTimerIntervalInSeconds()
      Return backendAlivenessTimerIntervalInSeconds, or null if it is not present. 
           
         The timer interval whereby, on expiration after response inactivity from the
         back-end, the connection to the back-end is torn down and reconnection is
         attempted.
      Returns:
      NonZeroUint32Type backendAlivenessTimerIntervalInSeconds, or null if it is not present.

    • requireBackendAlivenessTimerIntervalInSeconds

      default @NonNull NonZeroUint32Type requireBackendAlivenessTimerIntervalInSeconds()
      Return backendAlivenessTimerIntervalInSeconds, guaranteed to be non-null. 
           
         The timer interval whereby, on expiration after response inactivity from the
         back-end, the connection to the back-end is torn down and reconnection is
         attempted.
      Returns:
      NonZeroUint32Type backendAlivenessTimerIntervalInSeconds, guaranteed to be non-null.
      Throws:
      NoSuchElementException - if backendAlivenessTimerIntervalInSeconds is not present

    • getFrontendRequestTimeoutInSeconds

      NonZeroUint32Type getFrontendRequestTimeoutInSeconds()
      Return frontendRequestTimeoutInSeconds, or null if it is not present. 
           
         The timeout interval whereby client frontend transaction requests are failed.
      Returns:
      NonZeroUint32Type frontendRequestTimeoutInSeconds, or null if it is not present.

    • requireFrontendRequestTimeoutInSeconds

      default @NonNull NonZeroUint32Type requireFrontendRequestTimeoutInSeconds()
      Return frontendRequestTimeoutInSeconds, guaranteed to be non-null. 
           
         The timeout interval whereby client frontend transaction requests are failed.
      Returns:
      NonZeroUint32Type frontendRequestTimeoutInSeconds, guaranteed to be non-null.
      Throws:
      NoSuchElementException - if frontendRequestTimeoutInSeconds is not present

    • getFrontendNoProgressTimeoutInSeconds

      NonZeroUint32Type getFrontendNoProgressTimeoutInSeconds()
      Return frontendNoProgressTimeoutInSeconds, or null if it is not present. 
           
         The timeout interval whereby the client front-end hasn't made progress with the
         back-end on any request and terminates.
      Returns:
      NonZeroUint32Type frontendNoProgressTimeoutInSeconds, or null if it is not present.

    • requireFrontendNoProgressTimeoutInSeconds

      default @NonNull NonZeroUint32Type requireFrontendNoProgressTimeoutInSeconds()
      Return frontendNoProgressTimeoutInSeconds, guaranteed to be non-null. 
           
         The timeout interval whereby the client front-end hasn't made progress with the
         back-end on any request and terminates.
      Returns:
      NonZeroUint32Type frontendNoProgressTimeoutInSeconds, guaranteed to be non-null.
      Throws:
      NoSuchElementException - if frontendNoProgressTimeoutInSeconds is not present

    • getInitialPayloadSerializedBufferCapacity

      NonZeroUint32Type getInitialPayloadSerializedBufferCapacity()
      Return initialPayloadSerializedBufferCapacity, or null if it is not present. 
           
         The initial buffer capacity, in bytes, to use when serializing message payloads.
      Returns:
      NonZeroUint32Type initialPayloadSerializedBufferCapacity, or null if it is not present.

    • requireInitialPayloadSerializedBufferCapacity

      default @NonNull NonZeroUint32Type requireInitialPayloadSerializedBufferCapacity()
      Return initialPayloadSerializedBufferCapacity, guaranteed to be non-null. 
           
         The initial buffer capacity, in bytes, to use when serializing message payloads.
      Returns:
      NonZeroUint32Type initialPayloadSerializedBufferCapacity, guaranteed to be non-null.
      Throws:
      NoSuchElementException - if initialPayloadSerializedBufferCapacity is not present

    • getUseLz4Compression

      Boolean getUseLz4Compression()
      Return useLz4Compression, or null if it is not present. 
           
         Use lz4 compression for snapshots, sent from leader to follower, for snapshots
         stored by LocalSnapshotStore, use akka.conf configuration.
      Returns:
      Boolean useLz4Compression, or null if it is not present.

    • requireUseLz4Compression

      default @NonNull Boolean requireUseLz4Compression()
      Return useLz4Compression, guaranteed to be non-null. 
           
         Use lz4 compression for snapshots, sent from leader to follower, for snapshots
         stored by LocalSnapshotStore, use akka.conf configuration.
      Returns:
      Boolean useLz4Compression, guaranteed to be non-null.
      Throws:
      NoSuchElementException - if useLz4Compression is not present

    • getExportOnRecovery

      DataStoreProperties.ExportOnRecovery getExportOnRecovery()
      Return exportOnRecovery, or null if it is not present. 
           
         Export snapshot and journal during recovery. Possible modes: off(default),
         json(export to json files). Note that in case of large snapshot, export will
         take a lot of time.
      Returns:
      ExportOnRecovery exportOnRecovery, or null if it is not present.

    • requireExportOnRecovery

      default @NonNull DataStoreProperties.ExportOnRecovery requireExportOnRecovery()
      Return exportOnRecovery, guaranteed to be non-null. 
           
         Export snapshot and journal during recovery. Possible modes: off(default),
         json(export to json files). Note that in case of large snapshot, export will
         take a lot of time.
      Returns:
      ExportOnRecovery exportOnRecovery, guaranteed to be non-null.
      Throws:
      NoSuchElementException - if exportOnRecovery is not present

    • getRecoveryExportBaseDir

      String getRecoveryExportBaseDir()
      Return recoveryExportBaseDir, or null if it is not present. 
           
         Directory name for snapshot and journal dumps.
      Returns:
      String recoveryExportBaseDir, or null if it is not present.

    • requireRecoveryExportBaseDir

      default @NonNull String requireRecoveryExportBaseDir()
      Return recoveryExportBaseDir, guaranteed to be non-null. 
           
         Directory name for snapshot and journal dumps.
      Returns:
      String recoveryExportBaseDir, guaranteed to be non-null.
      Throws:
      NoSuchElementException - if recoveryExportBaseDir is not present