Package com.daml.ledger.api.v2.admin

Interface ParticipantPruningServiceOuterClass.PruneRequestOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
ParticipantPruningServiceOuterClass.PruneRequest, ParticipantPruningServiceOuterClass.PruneRequest.Builder
Enclosing class:
ParticipantPruningServiceOuterClass
public static interface ParticipantPruningServiceOuterClass.PruneRequestOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    getPruneAllDivulgedContracts()
    Prune all immediately and retroactively divulged contracts created before `prune_up_to` independent of whether they were archived before `prune_up_to`.
    long
    getPruneUpTo()
    Inclusive valid absolute offset (positive integer) up to which the ledger is to be pruned.
    String
    getSubmissionId()
    Unique submission identifier.
    com.google.protobuf.ByteString
    getSubmissionIdBytes()
    Unique submission identifier.

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    isInitialized

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

  • Method Details

    • getPruneUpTo

      long getPruneUpTo()
       Inclusive valid absolute offset (positive integer) up to which the ledger is to be pruned.
 By default the following data is pruned:

 1. All normal and divulged contracts that have been archived before
    `prune_up_to`.
 2. All transaction events and completions before `prune_up_to`
      int64 prune_up_to = 1 [json_name = "pruneUpTo"];
      Returns:
      The pruneUpTo.

    • getSubmissionId

      String getSubmissionId()
       Unique submission identifier.
 Optional, defaults to a random identifier, used for logging.
      string submission_id = 2 [json_name = "submissionId"];
      Returns:
      The submissionId.

    • getSubmissionIdBytes

      com.google.protobuf.ByteString getSubmissionIdBytes()
       Unique submission identifier.
 Optional, defaults to a random identifier, used for logging.
      string submission_id = 2 [json_name = "submissionId"];
      Returns:
      The bytes for submissionId.

    • getPruneAllDivulgedContracts

      boolean getPruneAllDivulgedContracts()
       Prune all immediately and retroactively divulged contracts created before `prune_up_to`
 independent of whether they were archived before `prune_up_to`. Useful to avoid leaking
 storage on participant nodes that can see a divulged contract but not its archival.

 Application developers SHOULD write their Daml applications
 such that they do not rely on divulged contracts; i.e., no warnings from
 using divulged contracts as inputs to transactions are emitted.

 Participant node operators SHOULD set the `prune_all_divulged_contracts` flag to avoid leaking
 storage due to accumulating unarchived divulged contracts PROVIDED that:

 1. no application using this participant node relies on divulgence OR
 2. divulged contracts on which applications rely have been re-divulged after the `prune_up_to` offset.
      bool prune_all_divulged_contracts = 3 [json_name = "pruneAllDivulgedContracts"];
      Returns:
      The pruneAllDivulgedContracts.