Package com.daml.ledger.api.v1.admin

Class ParticipantPruningServiceOuterClass.PruneRequest

    • Field Detail

      • PRUNE_UP_TO_FIELD_NUMBER

        public static final int PRUNE_UP_TO_FIELD_NUMBER
        See Also:
        Constant Field Values

      • SUBMISSION_ID_FIELD_NUMBER

        public static final int SUBMISSION_ID_FIELD_NUMBER
        See Also:
        Constant Field Values

      • PRUNE_ALL_DIVULGED_CONTRACTS_FIELD_NUMBER

        public static final int PRUNE_ALL_DIVULGED_CONTRACTS_FIELD_NUMBER
        See Also:
        Constant Field Values

    • Method Detail

      • newInstance

        protected java.lang.Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3

      • getDescriptor

        public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

      • getPruneUpTo

        public java.lang.String getPruneUpTo()
         Inclusive offset 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`
        string prune_up_to = 1 [json_name = "pruneUpTo"];
        Specified by:
        getPruneUpTo in interface ParticipantPruningServiceOuterClass.PruneRequestOrBuilder
        Returns:
        The pruneUpTo.

      • getPruneUpToBytes

        public com.google.protobuf.ByteString getPruneUpToBytes()
         Inclusive offset 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`
        string prune_up_to = 1 [json_name = "pruneUpTo"];
        Specified by:
        getPruneUpToBytes in interface ParticipantPruningServiceOuterClass.PruneRequestOrBuilder
        Returns:
        The bytes for pruneUpTo.

      • getPruneAllDivulgedContracts

        public 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"];
        Specified by:
        getPruneAllDivulgedContracts in interface ParticipantPruningServiceOuterClass.PruneRequestOrBuilder
        Returns:
        The pruneAllDivulgedContracts.

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3

      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
             throws java.io.IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        java.io.IOException

      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessageV3

      • equals

        public boolean equals​(java.lang.Object obj)
        Specified by:
        equals in interface com.google.protobuf.Message
        Overrides:
        equals in class com.google.protobuf.AbstractMessage

      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface com.google.protobuf.Message
        Overrides:
        hashCode in class com.google.protobuf.AbstractMessage

      • parseFrom

        public static ParticipantPruningServiceOuterClass.PruneRequest parseFrom​(java.nio.ByteBuffer data,
                                                                         com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                                  throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static ParticipantPruningServiceOuterClass.PruneRequest parseFrom​(com.google.protobuf.ByteString data)
                                                                  throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static ParticipantPruningServiceOuterClass.PruneRequest parseFrom​(com.google.protobuf.ByteString data,
                                                                         com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                                  throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static ParticipantPruningServiceOuterClass.PruneRequest parseFrom​(byte[] data,
                                                                         com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                                  throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseDelimitedFrom

        public static ParticipantPruningServiceOuterClass.PruneRequest parseDelimitedFrom​(java.io.InputStream input,
                                                                                  com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                                           throws java.io.IOException
        Throws:
        java.io.IOException

      • parseFrom

        public static ParticipantPruningServiceOuterClass.PruneRequest parseFrom​(com.google.protobuf.CodedInputStream input,
                                                                         com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                                  throws java.io.IOException
        Throws:
        java.io.IOException

      • getParserForType

        public com.google.protobuf.Parser<ParticipantPruningServiceOuterClass.PruneRequest> getParserForType()
        Specified by:
        getParserForType in interface com.google.protobuf.Message
        Specified by:
        getParserForType in interface com.google.protobuf.MessageLite
        Overrides:
        getParserForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstanceForType

        public ParticipantPruningServiceOuterClass.PruneRequest getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder