Package com.daml.ledger.api.v2

Interface StateServiceOuterClass.GetActiveContractsRequestOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
StateServiceOuterClass.GetActiveContractsRequest, StateServiceOuterClass.GetActiveContractsRequest.Builder
Enclosing class:
StateServiceOuterClass
public static interface StateServiceOuterClass.GetActiveContractsRequestOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Details

    • hasFilter

      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"];
      Returns:
      Whether the filter field is set.

    • getFilter

      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"];
      Returns:
      The filter.

    • getFilterOrBuilder

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

    • getVerbose

      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"];
      Returns:
      The verbose.

    • getActiveAtOffset

      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"];
      Returns:
      The activeAtOffset.

    • hasEventFormat

      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"];
      Returns:
      Whether the eventFormat field is set.

    • getEventFormat

      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"];
      Returns:
      The eventFormat.

    • getEventFormatOrBuilder

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