Package com.daml.ledger.api.v2

Class StateServiceOuterClass.GetActiveContractsRequest.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessageV3.Builder<StateServiceOuterClass.GetActiveContractsRequest.Builder>
com.daml.ledger.api.v2.StateServiceOuterClass.GetActiveContractsRequest.Builder
All Implemented Interfaces:
StateServiceOuterClass.GetActiveContractsRequestOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
Enclosing class:
StateServiceOuterClass.GetActiveContractsRequest
public static final class StateServiceOuterClass.GetActiveContractsRequest.Builder extends com.google.protobuf.GeneratedMessageV3.Builder<StateServiceOuterClass.GetActiveContractsRequest.Builder> implements StateServiceOuterClass.GetActiveContractsRequestOrBuilder
 If the given offset is different than the ledger end, and there are (un)assignments in-flight at the given offset,
 the snapshot may fail with "FAILED_PRECONDITION/PARTICIPANT_PRUNED_DATA_ACCESSED".
 Note that it is ok to request acs snapshots for party migration with offsets other than ledger end, because party
 migration is not concerned with incomplete (un)assignments.
Protobuf type com.daml.ledger.api.v2.GetActiveContractsRequest

  • Method Details

    • 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<StateServiceOuterClass.GetActiveContractsRequest.Builder>

    • clear

      public StateServiceOuterClass.GetActiveContractsRequest.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<StateServiceOuterClass.GetActiveContractsRequest.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<StateServiceOuterClass.GetActiveContractsRequest.Builder>

    • getDefaultInstanceForType

      public StateServiceOuterClass.GetActiveContractsRequest getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

    • build

      public StateServiceOuterClass.GetActiveContractsRequest build()
      Specified by:
      build in interface com.google.protobuf.Message.Builder
      Specified by:
      build in interface com.google.protobuf.MessageLite.Builder

    • buildPartial

      public StateServiceOuterClass.GetActiveContractsRequest buildPartial()
      Specified by:
      buildPartial in interface com.google.protobuf.Message.Builder
      Specified by:
      buildPartial in interface com.google.protobuf.MessageLite.Builder

    • clone

      public StateServiceOuterClass.GetActiveContractsRequest.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<StateServiceOuterClass.GetActiveContractsRequest.Builder>

    • setField

      public StateServiceOuterClass.GetActiveContractsRequest.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
      Specified by:
      setField in interface com.google.protobuf.Message.Builder
      Overrides:
      setField in class com.google.protobuf.GeneratedMessageV3.Builder<StateServiceOuterClass.GetActiveContractsRequest.Builder>

    • clearField

      public StateServiceOuterClass.GetActiveContractsRequest.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<StateServiceOuterClass.GetActiveContractsRequest.Builder>

    • clearOneof

      public StateServiceOuterClass.GetActiveContractsRequest.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<StateServiceOuterClass.GetActiveContractsRequest.Builder>

    • setRepeatedField

      public StateServiceOuterClass.GetActiveContractsRequest.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
      Specified by:
      setRepeatedField in interface com.google.protobuf.Message.Builder
      Overrides:
      setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<StateServiceOuterClass.GetActiveContractsRequest.Builder>

    • addRepeatedField

      public StateServiceOuterClass.GetActiveContractsRequest.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
      Specified by:
      addRepeatedField in interface com.google.protobuf.Message.Builder
      Overrides:
      addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<StateServiceOuterClass.GetActiveContractsRequest.Builder>

    • mergeFrom

      public StateServiceOuterClass.GetActiveContractsRequest.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<StateServiceOuterClass.GetActiveContractsRequest.Builder>

    • mergeFrom

      public StateServiceOuterClass.GetActiveContractsRequest.Builder mergeFrom(StateServiceOuterClass.GetActiveContractsRequest other)

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<StateServiceOuterClass.GetActiveContractsRequest.Builder>

    • mergeFrom

      public StateServiceOuterClass.GetActiveContractsRequest.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws 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<StateServiceOuterClass.GetActiveContractsRequest.Builder>
      Throws:
      IOException

    • hasFilter

      public boolean hasFilter()
       Provided for backwards compatibility, it will be removed in the Canton version 3.4.0.
 Templates to include in the served snapshot, per party.
 Optional, if specified event_format must be unset, if not specified event_format must be set.
      .com.daml.ledger.api.v2.TransactionFilter filter = 1 [json_name = "filter"];
      Specified by:
      hasFilter in interface StateServiceOuterClass.GetActiveContractsRequestOrBuilder
      Returns:
      Whether the filter field is set.

    • getFilter

      public TransactionFilterOuterClass.TransactionFilter getFilter()
       Provided for backwards compatibility, it will be removed in the Canton version 3.4.0.
 Templates to include in the served snapshot, per party.
 Optional, if specified event_format must be unset, if not specified event_format must be set.
      .com.daml.ledger.api.v2.TransactionFilter filter = 1 [json_name = "filter"];
      Specified by:
      getFilter in interface StateServiceOuterClass.GetActiveContractsRequestOrBuilder
      Returns:
      The filter.

    • setFilter

      public StateServiceOuterClass.GetActiveContractsRequest.Builder setFilter(TransactionFilterOuterClass.TransactionFilter value)
       Provided for backwards compatibility, it will be removed in the Canton version 3.4.0.
 Templates to include in the served snapshot, per party.
 Optional, if specified event_format must be unset, if not specified event_format must be set.
      .com.daml.ledger.api.v2.TransactionFilter filter = 1 [json_name = "filter"];

    • setFilter

      public StateServiceOuterClass.GetActiveContractsRequest.Builder setFilter(TransactionFilterOuterClass.TransactionFilter.Builder builderForValue)
       Provided for backwards compatibility, it will be removed in the Canton version 3.4.0.
 Templates to include in the served snapshot, per party.
 Optional, if specified event_format must be unset, if not specified event_format must be set.
      .com.daml.ledger.api.v2.TransactionFilter filter = 1 [json_name = "filter"];

    • mergeFilter

      public StateServiceOuterClass.GetActiveContractsRequest.Builder mergeFilter(TransactionFilterOuterClass.TransactionFilter value)
       Provided for backwards compatibility, it will be removed in the Canton version 3.4.0.
 Templates to include in the served snapshot, per party.
 Optional, if specified event_format must be unset, if not specified event_format must be set.
      .com.daml.ledger.api.v2.TransactionFilter filter = 1 [json_name = "filter"];

    • clearFilter

      public StateServiceOuterClass.GetActiveContractsRequest.Builder clearFilter()
       Provided for backwards compatibility, it will be removed in the Canton version 3.4.0.
 Templates to include in the served snapshot, per party.
 Optional, if specified event_format must be unset, if not specified event_format must be set.
      .com.daml.ledger.api.v2.TransactionFilter filter = 1 [json_name = "filter"];

    • getFilterBuilder

      public TransactionFilterOuterClass.TransactionFilter.Builder getFilterBuilder()
       Provided for backwards compatibility, it will be removed in the Canton version 3.4.0.
 Templates to include in the served snapshot, per party.
 Optional, if specified event_format must be unset, if not specified event_format must be set.
      .com.daml.ledger.api.v2.TransactionFilter filter = 1 [json_name = "filter"];

    • getFilterOrBuilder

      public TransactionFilterOuterClass.TransactionFilterOrBuilder getFilterOrBuilder()
       Provided for backwards compatibility, it will be removed in the Canton version 3.4.0.
 Templates to include in the served snapshot, per party.
 Optional, if specified event_format must be unset, if not specified event_format must be set.
      .com.daml.ledger.api.v2.TransactionFilter filter = 1 [json_name = "filter"];
      Specified by:
      getFilterOrBuilder in interface StateServiceOuterClass.GetActiveContractsRequestOrBuilder

    • getVerbose

      public boolean getVerbose()
       Provided for backwards compatibility, it will be removed in the Canton version 3.4.0.
 If enabled, values served over the API will contain more information than strictly necessary to interpret the data.
 In particular, setting the verbose flag to true triggers the ledger to include labels for record fields.
 Optional, if specified event_format must be unset.
      bool verbose = 2 [json_name = "verbose"];
      Specified by:
      getVerbose in interface StateServiceOuterClass.GetActiveContractsRequestOrBuilder
      Returns:
      The verbose.

    • setVerbose

      public StateServiceOuterClass.GetActiveContractsRequest.Builder setVerbose(boolean value)
       Provided for backwards compatibility, it will be removed in the Canton version 3.4.0.
 If enabled, values served over the API will contain more information than strictly necessary to interpret the data.
 In particular, setting the verbose flag to true triggers the ledger to include labels for record fields.
 Optional, if specified event_format must be unset.
      bool verbose = 2 [json_name = "verbose"];
      Parameters:
      value - The verbose to set.
      Returns:
      This builder for chaining.

    • clearVerbose

      public StateServiceOuterClass.GetActiveContractsRequest.Builder clearVerbose()
       Provided for backwards compatibility, it will be removed in the Canton version 3.4.0.
 If enabled, values served over the API will contain more information than strictly necessary to interpret the data.
 In particular, setting the verbose flag to true triggers the ledger to include labels for record fields.
 Optional, if specified event_format must be unset.
      bool verbose = 2 [json_name = "verbose"];
      Returns:
      This builder for chaining.

    • getActiveAtOffset

      public long getActiveAtOffset()
       The offset at which the snapshot of the active contracts will be computed.
 Must be no greater than the current ledger end offset.
 Must be greater than or equal to the last pruning offset.
 Required, must be a valid absolute offset (positive integer) or ledger begin offset (zero).
 If zero, the empty set will be returned.
      int64 active_at_offset = 3 [json_name = "activeAtOffset"];
      Specified by:
      getActiveAtOffset in interface StateServiceOuterClass.GetActiveContractsRequestOrBuilder
      Returns:
      The activeAtOffset.

    • setActiveAtOffset

      public StateServiceOuterClass.GetActiveContractsRequest.Builder setActiveAtOffset(long value)
       The offset at which the snapshot of the active contracts will be computed.
 Must be no greater than the current ledger end offset.
 Must be greater than or equal to the last pruning offset.
 Required, must be a valid absolute offset (positive integer) or ledger begin offset (zero).
 If zero, the empty set will be returned.
      int64 active_at_offset = 3 [json_name = "activeAtOffset"];
      Parameters:
      value - The activeAtOffset to set.
      Returns:
      This builder for chaining.

    • clearActiveAtOffset

      public StateServiceOuterClass.GetActiveContractsRequest.Builder clearActiveAtOffset()
       The offset at which the snapshot of the active contracts will be computed.
 Must be no greater than the current ledger end offset.
 Must be greater than or equal to the last pruning offset.
 Required, must be a valid absolute offset (positive integer) or ledger begin offset (zero).
 If zero, the empty set will be returned.
      int64 active_at_offset = 3 [json_name = "activeAtOffset"];
      Returns:
      This builder for chaining.

    • hasEventFormat

      public boolean hasEventFormat()
       Format of the contract_entries in the result. In case of CreatedEvent the presentation will be of
 TRANSACTION_SHAPE_ACS_DELTA.
 Optional for backwards compatibility, defaults to an EventFormat where:

 - filters_by_party is the filter.filters_by_party from this request
 - filters_for_any_party is the filter.filters_for_any_party from this request
 - verbose is the verbose field from this request
      .com.daml.ledger.api.v2.EventFormat event_format = 4 [json_name = "eventFormat"];
      Specified by:
      hasEventFormat in interface StateServiceOuterClass.GetActiveContractsRequestOrBuilder
      Returns:
      Whether the eventFormat field is set.

    • getEventFormat

      public TransactionFilterOuterClass.EventFormat getEventFormat()
       Format of the contract_entries in the result. In case of CreatedEvent the presentation will be of
 TRANSACTION_SHAPE_ACS_DELTA.
 Optional for backwards compatibility, defaults to an EventFormat where:

 - filters_by_party is the filter.filters_by_party from this request
 - filters_for_any_party is the filter.filters_for_any_party from this request
 - verbose is the verbose field from this request
      .com.daml.ledger.api.v2.EventFormat event_format = 4 [json_name = "eventFormat"];
      Specified by:
      getEventFormat in interface StateServiceOuterClass.GetActiveContractsRequestOrBuilder
      Returns:
      The eventFormat.

    • setEventFormat

      public StateServiceOuterClass.GetActiveContractsRequest.Builder setEventFormat(TransactionFilterOuterClass.EventFormat value)
       Format of the contract_entries in the result. In case of CreatedEvent the presentation will be of
 TRANSACTION_SHAPE_ACS_DELTA.
 Optional for backwards compatibility, defaults to an EventFormat where:

 - filters_by_party is the filter.filters_by_party from this request
 - filters_for_any_party is the filter.filters_for_any_party from this request
 - verbose is the verbose field from this request
      .com.daml.ledger.api.v2.EventFormat event_format = 4 [json_name = "eventFormat"];

    • setEventFormat

      public StateServiceOuterClass.GetActiveContractsRequest.Builder setEventFormat(TransactionFilterOuterClass.EventFormat.Builder builderForValue)
       Format of the contract_entries in the result. In case of CreatedEvent the presentation will be of
 TRANSACTION_SHAPE_ACS_DELTA.
 Optional for backwards compatibility, defaults to an EventFormat where:

 - filters_by_party is the filter.filters_by_party from this request
 - filters_for_any_party is the filter.filters_for_any_party from this request
 - verbose is the verbose field from this request
      .com.daml.ledger.api.v2.EventFormat event_format = 4 [json_name = "eventFormat"];

    • mergeEventFormat

      public StateServiceOuterClass.GetActiveContractsRequest.Builder mergeEventFormat(TransactionFilterOuterClass.EventFormat value)
       Format of the contract_entries in the result. In case of CreatedEvent the presentation will be of
 TRANSACTION_SHAPE_ACS_DELTA.
 Optional for backwards compatibility, defaults to an EventFormat where:

 - filters_by_party is the filter.filters_by_party from this request
 - filters_for_any_party is the filter.filters_for_any_party from this request
 - verbose is the verbose field from this request
      .com.daml.ledger.api.v2.EventFormat event_format = 4 [json_name = "eventFormat"];

    • clearEventFormat

      public StateServiceOuterClass.GetActiveContractsRequest.Builder clearEventFormat()
       Format of the contract_entries in the result. In case of CreatedEvent the presentation will be of
 TRANSACTION_SHAPE_ACS_DELTA.
 Optional for backwards compatibility, defaults to an EventFormat where:

 - filters_by_party is the filter.filters_by_party from this request
 - filters_for_any_party is the filter.filters_for_any_party from this request
 - verbose is the verbose field from this request
      .com.daml.ledger.api.v2.EventFormat event_format = 4 [json_name = "eventFormat"];

    • getEventFormatBuilder

      public TransactionFilterOuterClass.EventFormat.Builder getEventFormatBuilder()
       Format of the contract_entries in the result. In case of CreatedEvent the presentation will be of
 TRANSACTION_SHAPE_ACS_DELTA.
 Optional for backwards compatibility, defaults to an EventFormat where:

 - filters_by_party is the filter.filters_by_party from this request
 - filters_for_any_party is the filter.filters_for_any_party from this request
 - verbose is the verbose field from this request
      .com.daml.ledger.api.v2.EventFormat event_format = 4 [json_name = "eventFormat"];

    • getEventFormatOrBuilder

      public TransactionFilterOuterClass.EventFormatOrBuilder getEventFormatOrBuilder()
       Format of the contract_entries in the result. In case of CreatedEvent the presentation will be of
 TRANSACTION_SHAPE_ACS_DELTA.
 Optional for backwards compatibility, defaults to an EventFormat where:

 - filters_by_party is the filter.filters_by_party from this request
 - filters_for_any_party is the filter.filters_for_any_party from this request
 - verbose is the verbose field from this request
      .com.daml.ledger.api.v2.EventFormat event_format = 4 [json_name = "eventFormat"];
      Specified by:
      getEventFormatOrBuilder in interface StateServiceOuterClass.GetActiveContractsRequestOrBuilder

    • setUnknownFields

      public final StateServiceOuterClass.GetActiveContractsRequest.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<StateServiceOuterClass.GetActiveContractsRequest.Builder>

    • mergeUnknownFields

      public final StateServiceOuterClass.GetActiveContractsRequest.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<StateServiceOuterClass.GetActiveContractsRequest.Builder>