Package com.daml.ledger.api.v2

Class UpdateServiceOuterClass.GetUpdatesPageRequest.Builder

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

  • Method Details

    • 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.Builder<UpdateServiceOuterClass.GetUpdatesPageRequest.Builder>

    • clear

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

    • getDescriptorForType

      public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
      Specified by:
      getDescriptorForType in interface com.google.protobuf.Message.Builder
      Specified by:
      getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
      Overrides:
      getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<UpdateServiceOuterClass.GetUpdatesPageRequest.Builder>

    • getDefaultInstanceForType

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

    • build

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

    • buildPartial

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

    • clone

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

    • setField

      public UpdateServiceOuterClass.GetUpdatesPageRequest.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
      Specified by:
      setField in interface com.google.protobuf.Message.Builder
      Overrides:
      setField in class com.google.protobuf.GeneratedMessageV3.Builder<UpdateServiceOuterClass.GetUpdatesPageRequest.Builder>

    • clearField

      public UpdateServiceOuterClass.GetUpdatesPageRequest.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
      Specified by:
      clearField in interface com.google.protobuf.Message.Builder
      Overrides:
      clearField in class com.google.protobuf.GeneratedMessageV3.Builder<UpdateServiceOuterClass.GetUpdatesPageRequest.Builder>

    • clearOneof

      public UpdateServiceOuterClass.GetUpdatesPageRequest.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
      Specified by:
      clearOneof in interface com.google.protobuf.Message.Builder
      Overrides:
      clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<UpdateServiceOuterClass.GetUpdatesPageRequest.Builder>

    • setRepeatedField

      public UpdateServiceOuterClass.GetUpdatesPageRequest.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
      Specified by:
      setRepeatedField in interface com.google.protobuf.Message.Builder
      Overrides:
      setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<UpdateServiceOuterClass.GetUpdatesPageRequest.Builder>

    • addRepeatedField

      public UpdateServiceOuterClass.GetUpdatesPageRequest.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
      Specified by:
      addRepeatedField in interface com.google.protobuf.Message.Builder
      Overrides:
      addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<UpdateServiceOuterClass.GetUpdatesPageRequest.Builder>

    • mergeFrom

      public UpdateServiceOuterClass.GetUpdatesPageRequest.Builder mergeFrom(com.google.protobuf.Message other)
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<UpdateServiceOuterClass.GetUpdatesPageRequest.Builder>

    • mergeFrom

      public UpdateServiceOuterClass.GetUpdatesPageRequest.Builder mergeFrom(UpdateServiceOuterClass.GetUpdatesPageRequest other)

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<UpdateServiceOuterClass.GetUpdatesPageRequest.Builder>

    • mergeFrom

      public UpdateServiceOuterClass.GetUpdatesPageRequest.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Specified by:
      mergeFrom in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<UpdateServiceOuterClass.GetUpdatesPageRequest.Builder>
      Throws:
      IOException

    • 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.

    • setBeginOffsetExclusive

      public UpdateServiceOuterClass.GetUpdatesPageRequest.Builder setBeginOffsetExclusive(long value)
       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;
      Parameters:
      value - The beginOffsetExclusive to set.
      Returns:
      This builder for chaining.

    • clearBeginOffsetExclusive

      public UpdateServiceOuterClass.GetUpdatesPageRequest.Builder clearBeginOffsetExclusive()
       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:
      This builder for chaining.

    • 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.

    • setEndOffsetInclusive

      public UpdateServiceOuterClass.GetUpdatesPageRequest.Builder setEndOffsetInclusive(long value)
       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;
      Parameters:
      value - The endOffsetInclusive to set.
      Returns:
      This builder for chaining.

    • clearEndOffsetInclusive

      public UpdateServiceOuterClass.GetUpdatesPageRequest.Builder clearEndOffsetInclusive()
       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:
      This builder for chaining.

    • 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.

    • setMaxPageSize

      public UpdateServiceOuterClass.GetUpdatesPageRequest.Builder setMaxPageSize(int value)
       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;
      Parameters:
      value - The maxPageSize to set.
      Returns:
      This builder for chaining.

    • clearMaxPageSize

      public UpdateServiceOuterClass.GetUpdatesPageRequest.Builder clearMaxPageSize()
       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:
      This builder for chaining.

    • 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.

    • setUpdateFormat

      public UpdateServiceOuterClass.GetUpdatesPageRequest.Builder setUpdateFormat(TransactionFilterOuterClass.UpdateFormat value)
       Required
      .com.daml.ledger.api.v2.UpdateFormat update_format = 4;

    • setUpdateFormat

      public UpdateServiceOuterClass.GetUpdatesPageRequest.Builder setUpdateFormat(TransactionFilterOuterClass.UpdateFormat.Builder builderForValue)
       Required
      .com.daml.ledger.api.v2.UpdateFormat update_format = 4;

    • mergeUpdateFormat

      public UpdateServiceOuterClass.GetUpdatesPageRequest.Builder mergeUpdateFormat(TransactionFilterOuterClass.UpdateFormat value)
       Required
      .com.daml.ledger.api.v2.UpdateFormat update_format = 4;

    • clearUpdateFormat

      public UpdateServiceOuterClass.GetUpdatesPageRequest.Builder clearUpdateFormat()
       Required
      .com.daml.ledger.api.v2.UpdateFormat update_format = 4;

    • getUpdateFormatBuilder

      public TransactionFilterOuterClass.UpdateFormat.Builder getUpdateFormatBuilder()
       Required
      .com.daml.ledger.api.v2.UpdateFormat update_format = 4;

    • 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.

    • setDescendingOrder

      public UpdateServiceOuterClass.GetUpdatesPageRequest.Builder setDescendingOrder(boolean value)
      If set, the page will populate the elements in descending order starting from the end_offset_inclusive.

 Optional
      bool descending_order = 5;
      Parameters:
      value - The descendingOrder to set.
      Returns:
      This builder for chaining.

    • clearDescendingOrder

      public UpdateServiceOuterClass.GetUpdatesPageRequest.Builder clearDescendingOrder()
      If set, the page will populate the elements in descending order starting from the end_offset_inclusive.

 Optional
      bool descending_order = 5;
      Returns:
      This builder for chaining.

    • 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,
 - 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,
 - 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.

    • setPageToken

      public UpdateServiceOuterClass.GetUpdatesPageRequest.Builder setPageToken(com.google.protobuf.ByteString value)
       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;
      Parameters:
      value - The pageToken to set.
      Returns:
      This builder for chaining.

    • clearPageToken

      public UpdateServiceOuterClass.GetUpdatesPageRequest.Builder clearPageToken()
       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:
      This builder for chaining.

    • setUnknownFields

      public final UpdateServiceOuterClass.GetUpdatesPageRequest.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
      Specified by:
      setUnknownFields in interface com.google.protobuf.Message.Builder
      Overrides:
      setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<UpdateServiceOuterClass.GetUpdatesPageRequest.Builder>

    • mergeUnknownFields

      public final UpdateServiceOuterClass.GetUpdatesPageRequest.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
      Specified by:
      mergeUnknownFields in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<UpdateServiceOuterClass.GetUpdatesPageRequest.Builder>