Package com.daml.ledger.api.v2

Interface UpdateServiceOuterClass.GetUpdatesPageRequestOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
UpdateServiceOuterClass.GetUpdatesPageRequest, UpdateServiceOuterClass.GetUpdatesPageRequest.Builder
Enclosing class:
UpdateServiceOuterClass
public static interface UpdateServiceOuterClass.GetUpdatesPageRequestOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    long
    getBeginOffsetExclusive()
    Exclusive lower bound offset of the requested ledger section (non-negative integer).
    boolean
    getDescendingOrder()
    If set, the page will populate the elements in descending order starting from the end_offset_inclusive.
    long
    getEndOffsetInclusive()
    Inclusive upper bound offset of the requested ledger section.
    int
    getMaxPageSize()
    The result page will contain the first max_page_size Updates of all matching updates.
    com.google.protobuf.ByteString
    getPageToken()
    To get the next page of updates, the ``page_token`` should be set to the ``next_page_token`` of the last ``GetUpdatesPageResponse``.
    TransactionFilterOuterClass.UpdateFormat
    getUpdateFormat()
    Required
    TransactionFilterOuterClass.UpdateFormatOrBuilder
    getUpdateFormatOrBuilder()
    Required
    boolean
    hasBeginOffsetExclusive()
    Exclusive lower bound offset of the requested ledger section (non-negative integer).
    boolean
    hasEndOffsetInclusive()
    Inclusive upper bound offset of the requested ledger section.
    boolean
    hasMaxPageSize()
    The result page will contain the first max_page_size Updates of all matching updates.
    boolean
    hasPageToken()
    To get the next page of updates, the ``page_token`` should be set to the ``next_page_token`` of the last ``GetUpdatesPageResponse``.
    boolean
    hasUpdateFormat()
    Required

    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

    • hasBeginOffsetExclusive

      boolean hasBeginOffsetExclusive()
       Exclusive lower bound offset of the requested ledger section (non-negative integer).
 The response page will only contain updates whose offset is strictly greater than this.
 If set to zero or not defined, the lower bound is set to the actual pruning offset or to the beginning of the
 ledger if the participant was not pruned yet.
 If set to positive and the ledger has been pruned, this parameter must be greater or equal than the pruning offset.

 Optional
      optional int64 begin_offset_exclusive = 1;
      Returns:
      Whether the beginOffsetExclusive field is set.

    • getBeginOffsetExclusive

      long getBeginOffsetExclusive()
       Exclusive lower bound offset of the requested ledger section (non-negative integer).
 The response page will only contain updates whose offset is strictly greater than this.
 If set to zero or not defined, the lower bound is set to the actual pruning offset or to the beginning of the
 ledger if the participant was not pruned yet.
 If set to positive and the ledger has been pruned, this parameter must be greater or equal than the pruning offset.

 Optional
      optional int64 begin_offset_exclusive = 1;
      Returns:
      The beginOffsetExclusive.

    • hasEndOffsetInclusive

      boolean hasEndOffsetInclusive()
       Inclusive upper bound offset of the requested ledger section.
 If specified the response will only contain updates whose offset is less than or equal to this.
 If not specified response will only contain updates whose offset is less than the current ledger-end.

 Optional
      optional int64 end_offset_inclusive = 2;
      Returns:
      Whether the endOffsetInclusive field is set.

    • getEndOffsetInclusive

      long getEndOffsetInclusive()
       Inclusive upper bound offset of the requested ledger section.
 If specified the response will only contain updates whose offset is less than or equal to this.
 If not specified response will only contain updates whose offset is less than the current ledger-end.

 Optional
      optional int64 end_offset_inclusive = 2;
      Returns:
      The endOffsetInclusive.

    • hasMaxPageSize

      boolean hasMaxPageSize()
       The result page will contain the first max_page_size Updates of all matching updates.
 The server may reject queries with max_page_size above server specified limits.
 If not specified, the default max_page_size is 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 the first max_page_size Updates of all matching updates.
 The server may reject queries with max_page_size above server specified limits.
 If not specified, the default max_page_size is determined by the server.

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

    • hasUpdateFormat

      boolean hasUpdateFormat()
       Required
      .com.daml.ledger.api.v2.UpdateFormat update_format = 4;
      Returns:
      Whether the updateFormat field is set.

    • getUpdateFormat

      TransactionFilterOuterClass.UpdateFormat getUpdateFormat()
       Required
      .com.daml.ledger.api.v2.UpdateFormat update_format = 4;
      Returns:
      The updateFormat.

    • getUpdateFormatOrBuilder

      TransactionFilterOuterClass.UpdateFormatOrBuilder getUpdateFormatOrBuilder()
       Required
      .com.daml.ledger.api.v2.UpdateFormat update_format = 4;

    • getDescendingOrder

      boolean getDescendingOrder()
      If set, the page will populate the elements in descending order starting from the end_offset_inclusive.

 Optional
      bool descending_order = 5;
      Returns:
      The descendingOrder.

    • hasPageToken

      boolean hasPageToken()
       To get the next page of updates, the ``page_token`` should be set to the
 ``next_page_token`` of the last ``GetUpdatesPageResponse``.
 To achieve correct paging: subsequent requests must

 - be executed on the same participant,
 - have the same begin_offset_exclusive,
 - have the same end_offset_inclusive,
 - have the same update_format and
 - have the same descending_order.

 If not specified, the first page of updates will be returned.

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

    • getPageToken

      com.google.protobuf.ByteString getPageToken()
       To get the next page of updates, the ``page_token`` should be set to the
 ``next_page_token`` of the last ``GetUpdatesPageResponse``.
 To achieve correct paging: subsequent requests must

 - be executed on the same participant,
 - have the same begin_offset_exclusive,
 - have the same end_offset_inclusive,
 - have the same update_format and
 - have the same descending_order.

 If not specified, the first page of updates will be returned.

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