Package com.daml.ledger.api.v2

Class UpdateServiceOuterClass.GetUpdatesPageRequest

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
com.daml.ledger.api.v2.UpdateServiceOuterClass.GetUpdatesPageRequest
All Implemented Interfaces:
UpdateServiceOuterClass.GetUpdatesPageRequestOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
Enclosing class:
UpdateServiceOuterClass
public static final class UpdateServiceOuterClass.GetUpdatesPageRequest extends com.google.protobuf.GeneratedMessageV3 implements UpdateServiceOuterClass.GetUpdatesPageRequestOrBuilder
Protobuf type com.daml.ledger.api.v2.GetUpdatesPageRequest
See Also:

  • Field Details

    • BEGIN_OFFSET_EXCLUSIVE_FIELD_NUMBER

      public static final int BEGIN_OFFSET_EXCLUSIVE_FIELD_NUMBER
      See Also:

    • END_OFFSET_INCLUSIVE_FIELD_NUMBER

      public static final int END_OFFSET_INCLUSIVE_FIELD_NUMBER
      See Also:

    • MAX_PAGE_SIZE_FIELD_NUMBER

      public static final int MAX_PAGE_SIZE_FIELD_NUMBER
      See Also:

    • UPDATE_FORMAT_FIELD_NUMBER

      public static final int UPDATE_FORMAT_FIELD_NUMBER
      See Also:

    • DESCENDING_ORDER_FIELD_NUMBER

      public static final int DESCENDING_ORDER_FIELD_NUMBER
      See Also:

    • PAGE_TOKEN_FIELD_NUMBER

      public static final int PAGE_TOKEN_FIELD_NUMBER
      See Also:

  • Method Details

    • newInstance

      protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
      Overrides:
      newInstance in class com.google.protobuf.GeneratedMessageV3

    • 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

    • hasBeginOffsetExclusive

      public 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;
      Specified by:
      hasBeginOffsetExclusive in interface UpdateServiceOuterClass.GetUpdatesPageRequestOrBuilder
      Returns:
      Whether the beginOffsetExclusive field is set.

    • getBeginOffsetExclusive

      public 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;
      Specified by:
      getBeginOffsetExclusive in interface UpdateServiceOuterClass.GetUpdatesPageRequestOrBuilder
      Returns:
      The beginOffsetExclusive.

    • hasEndOffsetInclusive

      public 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;
      Specified by:
      hasEndOffsetInclusive in interface UpdateServiceOuterClass.GetUpdatesPageRequestOrBuilder
      Returns:
      Whether the endOffsetInclusive field is set.

    • getEndOffsetInclusive

      public 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;
      Specified by:
      getEndOffsetInclusive in interface UpdateServiceOuterClass.GetUpdatesPageRequestOrBuilder
      Returns:
      The endOffsetInclusive.

    • hasMaxPageSize

      public 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;
      Specified by:
      hasMaxPageSize in interface UpdateServiceOuterClass.GetUpdatesPageRequestOrBuilder
      Returns:
      Whether the maxPageSize field is set.

    • getMaxPageSize

      public 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;
      Specified by:
      getMaxPageSize in interface UpdateServiceOuterClass.GetUpdatesPageRequestOrBuilder
      Returns:
      The maxPageSize.

    • hasUpdateFormat

      public boolean hasUpdateFormat()
       Required
      .com.daml.ledger.api.v2.UpdateFormat update_format = 4;
      Specified by:
      hasUpdateFormat in interface UpdateServiceOuterClass.GetUpdatesPageRequestOrBuilder
      Returns:
      Whether the updateFormat field is set.

    • getUpdateFormat

      public TransactionFilterOuterClass.UpdateFormat getUpdateFormat()
       Required
      .com.daml.ledger.api.v2.UpdateFormat update_format = 4;
      Specified by:
      getUpdateFormat in interface UpdateServiceOuterClass.GetUpdatesPageRequestOrBuilder
      Returns:
      The updateFormat.

    • getUpdateFormatOrBuilder

      public TransactionFilterOuterClass.UpdateFormatOrBuilder getUpdateFormatOrBuilder()
       Required
      .com.daml.ledger.api.v2.UpdateFormat update_format = 4;
      Specified by:
      getUpdateFormatOrBuilder in interface UpdateServiceOuterClass.GetUpdatesPageRequestOrBuilder

    • getDescendingOrder

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

 Optional
      bool descending_order = 5;
      Specified by:
      getDescendingOrder in interface UpdateServiceOuterClass.GetUpdatesPageRequestOrBuilder
      Returns:
      The descendingOrder.

    • hasPageToken

      public 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 with the same version of canton,
 - 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;
      Specified by:
      hasPageToken in interface UpdateServiceOuterClass.GetUpdatesPageRequestOrBuilder
      Returns:
      Whether the pageToken field is set.

    • getPageToken

      public 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 with the same version of canton,
 - 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;
      Specified by:
      getPageToken in interface UpdateServiceOuterClass.GetUpdatesPageRequestOrBuilder
      Returns:
      The pageToken.

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessageV3

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessageV3
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessageV3

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static UpdateServiceOuterClass.GetUpdatesPageRequest parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static UpdateServiceOuterClass.GetUpdatesPageRequest parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static UpdateServiceOuterClass.GetUpdatesPageRequest parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static UpdateServiceOuterClass.GetUpdatesPageRequest parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static UpdateServiceOuterClass.GetUpdatesPageRequest parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static UpdateServiceOuterClass.GetUpdatesPageRequest parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static UpdateServiceOuterClass.GetUpdatesPageRequest parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static UpdateServiceOuterClass.GetUpdatesPageRequest parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static UpdateServiceOuterClass.GetUpdatesPageRequest parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static UpdateServiceOuterClass.GetUpdatesPageRequest parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static UpdateServiceOuterClass.GetUpdatesPageRequest parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static UpdateServiceOuterClass.GetUpdatesPageRequest parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public UpdateServiceOuterClass.GetUpdatesPageRequest.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static UpdateServiceOuterClass.GetUpdatesPageRequest.Builder newBuilder()

    • newBuilder

      public static UpdateServiceOuterClass.GetUpdatesPageRequest.Builder newBuilder(UpdateServiceOuterClass.GetUpdatesPageRequest prototype)

    • toBuilder

      public UpdateServiceOuterClass.GetUpdatesPageRequest.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected UpdateServiceOuterClass.GetUpdatesPageRequest.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
      Specified by:
      newBuilderForType in class com.google.protobuf.GeneratedMessageV3

    • getDefaultInstance

      public static UpdateServiceOuterClass.GetUpdatesPageRequest getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<UpdateServiceOuterClass.GetUpdatesPageRequest> parser()

    • getParserForType

      public com.google.protobuf.Parser<UpdateServiceOuterClass.GetUpdatesPageRequest> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessageV3

    • getDefaultInstanceForType

      public UpdateServiceOuterClass.GetUpdatesPageRequest getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder