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()
    Deprecated flag used to prune all immediately and retroactively divulged contracts.
    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`
 3. All immediately divulged contracts created before `prune_up_to` independent of whether
    they were archived before `prune_up_to`.

 Required
      int64 prune_up_to = 1;
      Returns:
      The pruneUpTo.

    • getSubmissionId

      String getSubmissionId()
       Unique submission identifier.
 If not populated, defaults to a random identifier, used for logging.

 Optional
      string submission_id = 2;
      Returns:
      The submissionId.

    • getSubmissionIdBytes

      com.google.protobuf.ByteString getSubmissionIdBytes()
       Unique submission identifier.
 If not populated, defaults to a random identifier, used for logging.

 Optional
      string submission_id = 2;
      Returns:
      The bytes for submissionId.

    • getPruneAllDivulgedContracts

      boolean getPruneAllDivulgedContracts()
       Deprecated flag used to prune all immediately and retroactively divulged contracts.
 It is a no-op since the divulged contracts are pruned along with the deactivated contracts.

 Optional
      bool prune_all_divulged_contracts = 3;
      Returns:
      The pruneAllDivulgedContracts.