com.daml.ledger.api.v1.admin

Class ParticipantPruningServiceOuterClass.PruneRequest.Builder

java.lang.Object

com.google.protobuf.AbstractMessageLite.Builder

com.google.protobuf.AbstractMessage.Builder<BuilderType>

com.google.protobuf.GeneratedMessageV3.Builder<ParticipantPruningServiceOuterClass.PruneRequest.Builder>

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

All Implemented Interfaces:

ParticipantPruningServiceOuterClass.PruneRequestOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, java.lang.Cloneable

Enclosing class:

ParticipantPruningServiceOuterClass.PruneRequest

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

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

Method Summary

Modifier and Type	Method and Description
ParticipantPruningServiceOuterClass.PruneRequest.Builder	addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, java.lang.Object value)
ParticipantPruningServiceOuterClass.PruneRequest	build()
ParticipantPruningServiceOuterClass.PruneRequest	buildPartial()
ParticipantPruningServiceOuterClass.PruneRequest.Builder	clear()
ParticipantPruningServiceOuterClass.PruneRequest.Builder	clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
ParticipantPruningServiceOuterClass.PruneRequest.Builder	clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
ParticipantPruningServiceOuterClass.PruneRequest.Builder	clearPruneAllDivulgedContracts() Prune all immediately and retroactively divulged contracts created before `prune_up_to` independent of whether they were archived before `prune_up_to`.
ParticipantPruningServiceOuterClass.PruneRequest.Builder	clearPruneUpTo() Inclusive offset up to which the ledger is to be pruned.
ParticipantPruningServiceOuterClass.PruneRequest.Builder	clearSubmissionId() Unique submission identifier.
ParticipantPruningServiceOuterClass.PruneRequest.Builder	clone()
ParticipantPruningServiceOuterClass.PruneRequest	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
com.google.protobuf.Descriptors.Descriptor	getDescriptorForType()
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.
java.lang.String	getSubmissionId() Unique submission identifier.
com.google.protobuf.ByteString	getSubmissionIdBytes() Unique submission identifier.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
ParticipantPruningServiceOuterClass.PruneRequest.Builder	mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
ParticipantPruningServiceOuterClass.PruneRequest.Builder	mergeFrom(com.google.protobuf.Message other)
ParticipantPruningServiceOuterClass.PruneRequest.Builder	mergeFrom(ParticipantPruningServiceOuterClass.PruneRequest other)
ParticipantPruningServiceOuterClass.PruneRequest.Builder	mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
ParticipantPruningServiceOuterClass.PruneRequest.Builder	setField(com.google.protobuf.Descriptors.FieldDescriptor field, java.lang.Object value)
ParticipantPruningServiceOuterClass.PruneRequest.Builder	setPruneAllDivulgedContracts(boolean value) Prune all immediately and retroactively divulged contracts created before `prune_up_to` independent of whether they were archived before `prune_up_to`.
ParticipantPruningServiceOuterClass.PruneRequest.Builder	setPruneUpTo(java.lang.String value) Inclusive offset up to which the ledger is to be pruned.
ParticipantPruningServiceOuterClass.PruneRequest.Builder	setPruneUpToBytes(com.google.protobuf.ByteString value) Inclusive offset up to which the ledger is to be pruned.
ParticipantPruningServiceOuterClass.PruneRequest.Builder	setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, java.lang.Object value)
ParticipantPruningServiceOuterClass.PruneRequest.Builder	setSubmissionId(java.lang.String value) Unique submission identifier.
ParticipantPruningServiceOuterClass.PruneRequest.Builder	setSubmissionIdBytes(com.google.protobuf.ByteString value) Unique submission identifier.
ParticipantPruningServiceOuterClass.PruneRequest.Builder	setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder

getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMutableMapField, isClean, markClean, newBuilderForField, onBuilt, onChanged, setUnknownFieldsProto3

Methods inherited from class com.google.protobuf.AbstractMessage.Builder

findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder

addAll, addAll, mergeFrom, newUninitializedMessageException

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.MessageLite.Builder

mergeFrom

Method Detail

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.Builder<ParticipantPruningServiceOuterClass.PruneRequest.Builder>

clear

public ParticipantPruningServiceOuterClass.PruneRequest.Builder clear()

Specified by:

clear in interface com.google.protobuf.Message.Builder

Specified by:

clear in interface com.google.protobuf.MessageLite.Builder

Overrides:

clear in class com.google.protobuf.GeneratedMessageV3.Builder<ParticipantPruningServiceOuterClass.PruneRequest.Builder>

getDescriptorForType

public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()

Specified by:

getDescriptorForType in interface com.google.protobuf.Message.Builder

Specified by:

getDescriptorForType in interface com.google.protobuf.MessageOrBuilder

Overrides:

getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<ParticipantPruningServiceOuterClass.PruneRequest.Builder>

getDefaultInstanceForType

public ParticipantPruningServiceOuterClass.PruneRequest getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

build

public ParticipantPruningServiceOuterClass.PruneRequest build()

Specified by:

build in interface com.google.protobuf.Message.Builder

Specified by:

build in interface com.google.protobuf.MessageLite.Builder

buildPartial

public ParticipantPruningServiceOuterClass.PruneRequest buildPartial()

Specified by:

buildPartial in interface com.google.protobuf.Message.Builder

Specified by:

buildPartial in interface com.google.protobuf.MessageLite.Builder

clone

public ParticipantPruningServiceOuterClass.PruneRequest.Builder clone()

Specified by:

clone in interface com.google.protobuf.Message.Builder

Specified by:

clone in interface com.google.protobuf.MessageLite.Builder

Overrides:

clone in class com.google.protobuf.GeneratedMessageV3.Builder<ParticipantPruningServiceOuterClass.PruneRequest.Builder>

setField

public ParticipantPruningServiceOuterClass.PruneRequest.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                                         java.lang.Object value)

Specified by:

setField in interface com.google.protobuf.Message.Builder

Overrides:

setField in class com.google.protobuf.GeneratedMessageV3.Builder<ParticipantPruningServiceOuterClass.PruneRequest.Builder>

clearField

public ParticipantPruningServiceOuterClass.PruneRequest.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)

Specified by:

clearField in interface com.google.protobuf.Message.Builder

Overrides:

clearField in class com.google.protobuf.GeneratedMessageV3.Builder<ParticipantPruningServiceOuterClass.PruneRequest.Builder>

clearOneof

public ParticipantPruningServiceOuterClass.PruneRequest.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)

Specified by:

clearOneof in interface com.google.protobuf.Message.Builder

Overrides:

clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<ParticipantPruningServiceOuterClass.PruneRequest.Builder>

setRepeatedField

public ParticipantPruningServiceOuterClass.PruneRequest.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                                                 int index,
                                                                                 java.lang.Object value)

Specified by:

setRepeatedField in interface com.google.protobuf.Message.Builder

Overrides:

setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<ParticipantPruningServiceOuterClass.PruneRequest.Builder>

addRepeatedField

public ParticipantPruningServiceOuterClass.PruneRequest.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                                                 java.lang.Object value)

Specified by:

addRepeatedField in interface com.google.protobuf.Message.Builder

Overrides:

addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<ParticipantPruningServiceOuterClass.PruneRequest.Builder>

mergeFrom

public ParticipantPruningServiceOuterClass.PruneRequest.Builder mergeFrom(com.google.protobuf.Message other)

Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<ParticipantPruningServiceOuterClass.PruneRequest.Builder>

mergeFrom

public ParticipantPruningServiceOuterClass.PruneRequest.Builder mergeFrom(ParticipantPruningServiceOuterClass.PruneRequest other)

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<ParticipantPruningServiceOuterClass.PruneRequest.Builder>

mergeFrom

public ParticipantPruningServiceOuterClass.PruneRequest.Builder mergeFrom(com.google.protobuf.CodedInputStream input,
                                                                          com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                                   throws java.io.IOException

Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Specified by:

mergeFrom in interface com.google.protobuf.MessageLite.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<ParticipantPruningServiceOuterClass.PruneRequest.Builder>

Throws:

java.io.IOException

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.

setPruneUpTo

public ParticipantPruningServiceOuterClass.PruneRequest.Builder setPruneUpTo(java.lang.String value)

 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"];

Parameters:

value - The pruneUpTo to set.

Returns:

This builder for chaining.

clearPruneUpTo

public ParticipantPruningServiceOuterClass.PruneRequest.Builder clearPruneUpTo()

 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"];

Returns:

This builder for chaining.

setPruneUpToBytes

public ParticipantPruningServiceOuterClass.PruneRequest.Builder setPruneUpToBytes(com.google.protobuf.ByteString value)

 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"];

Parameters:

value - The bytes for pruneUpTo to set.

Returns:

This builder for chaining.

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.

setSubmissionId

public ParticipantPruningServiceOuterClass.PruneRequest.Builder setSubmissionId(java.lang.String value)

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

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

Parameters:

value - The submissionId to set.

Returns:

This builder for chaining.

clearSubmissionId

public ParticipantPruningServiceOuterClass.PruneRequest.Builder clearSubmissionId()

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

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

Returns:

This builder for chaining.

setSubmissionIdBytes

public ParticipantPruningServiceOuterClass.PruneRequest.Builder setSubmissionIdBytes(com.google.protobuf.ByteString value)

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

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

Parameters:

value - The bytes for submissionId to set.

Returns:

This builder for chaining.

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.

setPruneAllDivulgedContracts

public ParticipantPruningServiceOuterClass.PruneRequest.Builder setPruneAllDivulgedContracts(boolean value)

 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"];

Parameters:

value - The pruneAllDivulgedContracts to set.

Returns:

This builder for chaining.

clearPruneAllDivulgedContracts

public ParticipantPruningServiceOuterClass.PruneRequest.Builder clearPruneAllDivulgedContracts()

 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:

This builder for chaining.

setUnknownFields

public final ParticipantPruningServiceOuterClass.PruneRequest.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Specified by:

setUnknownFields in interface com.google.protobuf.Message.Builder

Overrides:

setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<ParticipantPruningServiceOuterClass.PruneRequest.Builder>

mergeUnknownFields

public final ParticipantPruningServiceOuterClass.PruneRequest.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Specified by:

mergeUnknownFields in interface com.google.protobuf.Message.Builder

Overrides:

mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<ParticipantPruningServiceOuterClass.PruneRequest.Builder>