com.daml.ledger.api.v1.admin

Class ParticipantPruningServiceOuterClass.PruneRequest

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

com.daml.ledger.api.v1.admin.ParticipantPruningServiceOuterClass.PruneRequest

All Implemented Interfaces:

ParticipantPruningServiceOuterClass.PruneRequestOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, java.io.Serializable

Enclosing class:

ParticipantPruningServiceOuterClass

public static final class ParticipantPruningServiceOuterClass.PruneRequest
extends com.google.protobuf.GeneratedMessageV3
implements ParticipantPruningServiceOuterClass.PruneRequestOrBuilder

Protobuf type com.daml.ledger.api.v1.admin.PruneRequest

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ParticipantPruningServiceOuterClass.PruneRequest.Builder Protobuf type com.daml.ledger.api.v1.admin.PruneRequest

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage,BuilderType extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields

Modifier and Type	Field and Description
static int	PRUNE_ALL_DIVULGED_CONTRACTS_FIELD_NUMBER
static int	PRUNE_UP_TO_FIELD_NUMBER
static int	SUBMISSION_ID_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
static ParticipantPruningServiceOuterClass.PruneRequest	getDefaultInstance()
ParticipantPruningServiceOuterClass.PruneRequest	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
com.google.protobuf.Parser<ParticipantPruningServiceOuterClass.PruneRequest>	getParserForType()
boolean	getPruneAllDivulgedContracts() Prune all immediately and retroactively divulged contracts created before `prune_up_to` independent of whether they were archived before `prune_up_to`.
java.lang.String	getPruneUpTo() Inclusive offset up to which the ledger is to be pruned.
com.google.protobuf.ByteString	getPruneUpToBytes() Inclusive offset up to which the ledger is to be pruned.
int	getSerializedSize()
java.lang.String	getSubmissionId() Unique submission identifier.
com.google.protobuf.ByteString	getSubmissionIdBytes() Unique submission identifier.
com.google.protobuf.UnknownFieldSet	getUnknownFields()
int	hashCode()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static ParticipantPruningServiceOuterClass.PruneRequest.Builder	newBuilder()
static ParticipantPruningServiceOuterClass.PruneRequest.Builder	newBuilder(ParticipantPruningServiceOuterClass.PruneRequest prototype)
ParticipantPruningServiceOuterClass.PruneRequest.Builder	newBuilderForType()
protected ParticipantPruningServiceOuterClass.PruneRequest.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected java.lang.Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static ParticipantPruningServiceOuterClass.PruneRequest	parseDelimitedFrom(java.io.InputStream input)
static ParticipantPruningServiceOuterClass.PruneRequest	parseDelimitedFrom(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ParticipantPruningServiceOuterClass.PruneRequest	parseFrom(byte[] data)
static ParticipantPruningServiceOuterClass.PruneRequest	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ParticipantPruningServiceOuterClass.PruneRequest	parseFrom(java.nio.ByteBuffer data)
static ParticipantPruningServiceOuterClass.PruneRequest	parseFrom(java.nio.ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ParticipantPruningServiceOuterClass.PruneRequest	parseFrom(com.google.protobuf.ByteString data)
static ParticipantPruningServiceOuterClass.PruneRequest	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ParticipantPruningServiceOuterClass.PruneRequest	parseFrom(com.google.protobuf.CodedInputStream input)
static ParticipantPruningServiceOuterClass.PruneRequest	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ParticipantPruningServiceOuterClass.PruneRequest	parseFrom(java.io.InputStream input)
static ParticipantPruningServiceOuterClass.PruneRequest	parseFrom(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<ParticipantPruningServiceOuterClass.PruneRequest>	parser()
ParticipantPruningServiceOuterClass.PruneRequest.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, makeExtensionsImmutable, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

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

getUnknownFields

public final com.google.protobuf.UnknownFieldSet getUnknownFields()

Specified by:

getUnknownFields in interface com.google.protobuf.MessageOrBuilder

Overrides:

getUnknownFields 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.

getSubmissionId

public java.lang.String getSubmissionId()

 Unique submission identifier.
 Optional, defaults to a random identifier, used for logging.
 

string submission_id = 2 [json_name = "submissionId"];

Specified by:

getSubmissionId in interface ParticipantPruningServiceOuterClass.PruneRequestOrBuilder

Returns:

The submissionId.

getSubmissionIdBytes

public com.google.protobuf.ByteString getSubmissionIdBytes()

 Unique submission identifier.
 Optional, defaults to a random identifier, used for logging.
 

string submission_id = 2 [json_name = "submissionId"];

Specified by:

getSubmissionIdBytes in interface ParticipantPruningServiceOuterClass.PruneRequestOrBuilder

Returns:

The bytes for submissionId.

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)
                                                                  throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

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)
                                                                  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

parseFrom

public static ParticipantPruningServiceOuterClass.PruneRequest parseFrom(java.io.InputStream input)
                                                                  throws java.io.IOException

Throws:

java.io.IOException

parseFrom

public static ParticipantPruningServiceOuterClass.PruneRequest parseFrom(java.io.InputStream input,
                                                                         com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                                  throws java.io.IOException

Throws:

java.io.IOException

parseDelimitedFrom

public static ParticipantPruningServiceOuterClass.PruneRequest parseDelimitedFrom(java.io.InputStream input)
                                                                           throws java.io.IOException

Throws:

java.io.IOException

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)
                                                                  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

newBuilderForType

public ParticipantPruningServiceOuterClass.PruneRequest.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static ParticipantPruningServiceOuterClass.PruneRequest.Builder newBuilder()

newBuilder

public static ParticipantPruningServiceOuterClass.PruneRequest.Builder newBuilder(ParticipantPruningServiceOuterClass.PruneRequest prototype)

toBuilder

public ParticipantPruningServiceOuterClass.PruneRequest.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected ParticipantPruningServiceOuterClass.PruneRequest.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static ParticipantPruningServiceOuterClass.PruneRequest getDefaultInstance()

parser

public static com.google.protobuf.Parser<ParticipantPruningServiceOuterClass.PruneRequest> parser()

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