Package com.daml.ledger.api.v2

Interface StateServiceOuterClass.GetActiveContractsPageRequestOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
StateServiceOuterClass.GetActiveContractsPageRequest, StateServiceOuterClass.GetActiveContractsPageRequest.Builder
Enclosing class:
StateServiceOuterClass
public static interface StateServiceOuterClass.GetActiveContractsPageRequestOrBuilder 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.
    int
    getMaxPageSize()
    The result page will contain at most max_page_size entries of the respective active contract snapshot.
    com.google.protobuf.ByteString
    getPageToken()
    To get the next page of the active contracts snapshot, the ``page_token`` should be set to the ``next_page_token`` of the last ``GetActiveContractsPageResponse``.
    boolean
    hasActiveAtOffset()
    The offset at which the snapshot of the active contracts will be computed.
    boolean
    hasEventFormat()
    Format of the contract_entries in the result.
    boolean
    hasMaxPageSize()
    The result page will contain at most max_page_size entries of the respective active contract snapshot.
    boolean
    hasPageToken()
    To get the next page of the active contracts snapshot, the ``page_token`` should be set to the ``next_page_token`` of the last ``GetActiveContractsPageResponse``.

    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

    • hasActiveAtOffset

      boolean hasActiveAtOffset()
       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.
 Optional, if defined, it must be a valid absolute offset (positive integer) or ledger begin offset (zero).
 If zero, the empty set will be returned.
 If not defined, the current ledger end will be used and it will be populated in the response.

 Optional
      optional int64 active_at_offset = 1;
      Returns:
      Whether the activeAtOffset field is set.

    • 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.
 Optional, if defined, it must be a valid absolute offset (positive integer) or ledger begin offset (zero).
 If zero, the empty set will be returned.
 If not defined, the current ledger end will be used and it will be populated in the response.

 Optional
      optional int64 active_at_offset = 1;
      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 = 2;
      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 = 2;
      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 = 2;

    • hasMaxPageSize

      boolean hasMaxPageSize()
       The result page will contain at most max_page_size entries of the respective active contract snapshot.
 The server might reject max_page_size breaching the server-specified limit.
 Optional, if not defined, the default will be determined by the server.

 Optional
      optional int32 max_page_size = 3;
      Returns:
      Whether the maxPageSize field is set.

    • getMaxPageSize

      int getMaxPageSize()
       The result page will contain at most max_page_size entries of the respective active contract snapshot.
 The server might reject max_page_size breaching the server-specified limit.
 Optional, if not defined, the default will be determined by the server.

 Optional
      optional int32 max_page_size = 3;
      Returns:
      The maxPageSize.

    • hasPageToken

      boolean hasPageToken()
       To get the next page of the active contracts snapshot, the ``page_token`` should be set to the
 ``next_page_token`` of the last ``GetActiveContractsPageResponse``.
 The page token only works if subsequent requests:

 - are executed on the same participant,
 - use the same active_at_offset and event_format,
 - and the participant's store was not pruned to after the active_at_offset.

 If not specified, the first page of the active contracts snapshot will be returned.

 Optional: can be empty
      optional bytes page_token = 4;
      Returns:
      Whether the pageToken field is set.

    • getPageToken

      com.google.protobuf.ByteString getPageToken()
       To get the next page of the active contracts snapshot, the ``page_token`` should be set to the
 ``next_page_token`` of the last ``GetActiveContractsPageResponse``.
 The page token only works if subsequent requests:

 - are executed on the same participant,
 - use the same active_at_offset and event_format,
 - and the participant's store was not pruned to after the active_at_offset.

 If not specified, the first page of the active contracts snapshot will be returned.

 Optional: can be empty
      optional bytes page_token = 4;
      Returns:
      The pageToken.