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 Summary

    Modifier and Type
    Method
    Description
    long
    getActiveAtOffset()
    The offset at which the snapshot of the active contracts will be computed.
    TransactionFilterOuterClass.EventFormat
    getEventFormat()
    Format of the contract_entries in the result.
    TransactionFilterOuterClass.EventFormatOrBuilder
    getEventFormatOrBuilder()
    Format of the contract_entries in the result.
    com.google.protobuf.ByteString
    getStreamContinuationToken()
    Opaque representation of a continuation token defining a position in the active contracts snapshot.
    boolean
    hasEventFormat()
    Format of the contract_entries in the result.
    boolean
    hasStreamContinuationToken()
    Opaque representation of a continuation token defining a position in the active contracts snapshot.

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    isInitialized

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

  • Method Details

    • 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.
 Must be a valid absolute offset (positive integer) or ledger begin offset (zero).
 If zero, the empty set will be returned.

 Required
      int64 active_at_offset = 3;
      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.

 Required
      .com.daml.ledger.api.v2.EventFormat event_format = 4;
      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.

 Required
      .com.daml.ledger.api.v2.EventFormat event_format = 4;
      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.

 Required
      .com.daml.ledger.api.v2.EventFormat event_format = 4;

    • hasStreamContinuationToken

      boolean hasStreamContinuationToken()
       Opaque representation of a continuation token defining a position in the active contracts snapshot.
 The prefix of the active contracts snapshot will be omitted up to and including the element from which
 the continuation token was read.
 To reuse the continuation token from a `GetActiveContractsPageResponse`:

 - subsequent request must be executed on the same participant with the same version of canton,
 - subsequent request must have the same active_at_offset,
 - subsequent request must have the same event_format
 - and the participant must not have been pruned after the active_at_offset.

 If not specified, the whole active contracts snapshot will be returned.

 Optional: can be empty
      optional bytes stream_continuation_token = 5;
      Returns:
      Whether the streamContinuationToken field is set.

    • getStreamContinuationToken

      com.google.protobuf.ByteString getStreamContinuationToken()
       Opaque representation of a continuation token defining a position in the active contracts snapshot.
 The prefix of the active contracts snapshot will be omitted up to and including the element from which
 the continuation token was read.
 To reuse the continuation token from a `GetActiveContractsPageResponse`:

 - subsequent request must be executed on the same participant with the same version of canton,
 - subsequent request must have the same active_at_offset,
 - subsequent request must have the same event_format
 - and the participant must not have been pruned after the active_at_offset.

 If not specified, the whole active contracts snapshot will be returned.

 Optional: can be empty
      optional bytes stream_continuation_token = 5;
      Returns:
      The streamContinuationToken.