Package com.daml.ledger.api.v2

Class UpdateServiceOuterClass.GetUpdatesRequest

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
com.daml.ledger.api.v2.UpdateServiceOuterClass.GetUpdatesRequest
All Implemented Interfaces:
UpdateServiceOuterClass.GetUpdatesRequestOrBuilder, 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.GetUpdatesRequest extends com.google.protobuf.GeneratedMessageV3 implements UpdateServiceOuterClass.GetUpdatesRequestOrBuilder
Protobuf type com.daml.ledger.api.v2.GetUpdatesRequest
See Also:

  • Field Details

    • BEGIN_EXCLUSIVE_FIELD_NUMBER

      public static final int BEGIN_EXCLUSIVE_FIELD_NUMBER
      See Also:

    • END_INCLUSIVE_FIELD_NUMBER

      public static final int END_INCLUSIVE_FIELD_NUMBER
      See Also:

    • FILTER_FIELD_NUMBER

      public static final int FILTER_FIELD_NUMBER
      See Also:

    • VERBOSE_FIELD_NUMBER

      public static final int VERBOSE_FIELD_NUMBER
      See Also:

    • UPDATE_FORMAT_FIELD_NUMBER

      public static final int UPDATE_FORMAT_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

    • getBeginExclusive

      public long getBeginExclusive()
       Beginning of the requested ledger section (non-negative integer).
 The response will only contain transactions whose offset is strictly greater than this.
 If zero, the stream will start from the beginning of the ledger.
 If positive, the streaming will start after this absolute offset.
 If the ledger has been pruned, this parameter must be specified and be greater than the pruning offset.
      int64 begin_exclusive = 1 [json_name = "beginExclusive"];
      Specified by:
      getBeginExclusive in interface UpdateServiceOuterClass.GetUpdatesRequestOrBuilder
      Returns:
      The beginExclusive.

    • hasEndInclusive

      public boolean hasEndInclusive()
       End of the requested ledger section.
 The response will only contain transactions whose offset is less than or equal to this.
 Optional, if empty, the stream will not terminate.
 If specified, the stream will terminate after this absolute offset (positive integer) is reached.
      optional int64 end_inclusive = 2 [json_name = "endInclusive"];
      Specified by:
      hasEndInclusive in interface UpdateServiceOuterClass.GetUpdatesRequestOrBuilder
      Returns:
      Whether the endInclusive field is set.

    • getEndInclusive

      public long getEndInclusive()
       End of the requested ledger section.
 The response will only contain transactions whose offset is less than or equal to this.
 Optional, if empty, the stream will not terminate.
 If specified, the stream will terminate after this absolute offset (positive integer) is reached.
      optional int64 end_inclusive = 2 [json_name = "endInclusive"];
      Specified by:
      getEndInclusive in interface UpdateServiceOuterClass.GetUpdatesRequestOrBuilder
      Returns:
      The endInclusive.

    • hasFilter

      public boolean hasFilter()
       Provided for backwards compatibility, it will be removed in the Canton version 3.4.0.
 Requesting parties with template filters.
 Template filters must be empty for GetUpdateTrees requests.
 Optional for backwards compatibility, if defined update_format must be unset
      .com.daml.ledger.api.v2.TransactionFilter filter = 3 [json_name = "filter"];
      Specified by:
      hasFilter in interface UpdateServiceOuterClass.GetUpdatesRequestOrBuilder
      Returns:
      Whether the filter field is set.

    • getFilter

      public TransactionFilterOuterClass.TransactionFilter getFilter()
       Provided for backwards compatibility, it will be removed in the Canton version 3.4.0.
 Requesting parties with template filters.
 Template filters must be empty for GetUpdateTrees requests.
 Optional for backwards compatibility, if defined update_format must be unset
      .com.daml.ledger.api.v2.TransactionFilter filter = 3 [json_name = "filter"];
      Specified by:
      getFilter in interface UpdateServiceOuterClass.GetUpdatesRequestOrBuilder
      Returns:
      The filter.

    • getFilterOrBuilder

      public TransactionFilterOuterClass.TransactionFilterOrBuilder getFilterOrBuilder()
       Provided for backwards compatibility, it will be removed in the Canton version 3.4.0.
 Requesting parties with template filters.
 Template filters must be empty for GetUpdateTrees requests.
 Optional for backwards compatibility, if defined update_format must be unset
      .com.daml.ledger.api.v2.TransactionFilter filter = 3 [json_name = "filter"];
      Specified by:
      getFilterOrBuilder in interface UpdateServiceOuterClass.GetUpdatesRequestOrBuilder

    • getVerbose

      public boolean getVerbose()
       Provided for backwards compatibility, it will be removed in the Canton version 3.4.0.
 If enabled, values served over the API will contain more information than strictly necessary to interpret the data.
 In particular, setting the verbose flag to true triggers the ledger to include labels, record and variant type ids
 for record fields.
 Optional for backwards compatibility, if defined update_format must be unset
      bool verbose = 4 [json_name = "verbose"];
      Specified by:
      getVerbose in interface UpdateServiceOuterClass.GetUpdatesRequestOrBuilder
      Returns:
      The verbose.

    • hasUpdateFormat

      public boolean hasUpdateFormat()
       Must be unset for GetUpdateTrees request.
 Optional for backwards compatibility for GetUpdates request: defaults to an UpdateFormat where:

 - include_transactions.event_format.filters_by_party = the filter.filters_by_party on this request
 - include_transactions.event_format.filters_for_any_party = the filter.filters_for_any_party on this request
 - include_transactions.event_format.verbose = the same flag specified on this request
 - include_transactions.transaction_shape = TRANSACTION_SHAPE_ACS_DELTA
 - include_reassignments.filter = the same filter specified on this request
 - include_reassignments.verbose = the same flag specified on this request
 - include_topology_events.include_participant_authorization_events.parties = all the parties specified in filter
      .com.daml.ledger.api.v2.UpdateFormat update_format = 5 [json_name = "updateFormat"];
      Specified by:
      hasUpdateFormat in interface UpdateServiceOuterClass.GetUpdatesRequestOrBuilder
      Returns:
      Whether the updateFormat field is set.

    • getUpdateFormat

      public TransactionFilterOuterClass.UpdateFormat getUpdateFormat()
       Must be unset for GetUpdateTrees request.
 Optional for backwards compatibility for GetUpdates request: defaults to an UpdateFormat where:

 - include_transactions.event_format.filters_by_party = the filter.filters_by_party on this request
 - include_transactions.event_format.filters_for_any_party = the filter.filters_for_any_party on this request
 - include_transactions.event_format.verbose = the same flag specified on this request
 - include_transactions.transaction_shape = TRANSACTION_SHAPE_ACS_DELTA
 - include_reassignments.filter = the same filter specified on this request
 - include_reassignments.verbose = the same flag specified on this request
 - include_topology_events.include_participant_authorization_events.parties = all the parties specified in filter
      .com.daml.ledger.api.v2.UpdateFormat update_format = 5 [json_name = "updateFormat"];
      Specified by:
      getUpdateFormat in interface UpdateServiceOuterClass.GetUpdatesRequestOrBuilder
      Returns:
      The updateFormat.

    • getUpdateFormatOrBuilder

      public TransactionFilterOuterClass.UpdateFormatOrBuilder getUpdateFormatOrBuilder()
       Must be unset for GetUpdateTrees request.
 Optional for backwards compatibility for GetUpdates request: defaults to an UpdateFormat where:

 - include_transactions.event_format.filters_by_party = the filter.filters_by_party on this request
 - include_transactions.event_format.filters_for_any_party = the filter.filters_for_any_party on this request
 - include_transactions.event_format.verbose = the same flag specified on this request
 - include_transactions.transaction_shape = TRANSACTION_SHAPE_ACS_DELTA
 - include_reassignments.filter = the same filter specified on this request
 - include_reassignments.verbose = the same flag specified on this request
 - include_topology_events.include_participant_authorization_events.parties = all the parties specified in filter
      .com.daml.ledger.api.v2.UpdateFormat update_format = 5 [json_name = "updateFormat"];
      Specified by:
      getUpdateFormatOrBuilder in interface UpdateServiceOuterClass.GetUpdatesRequestOrBuilder

    • 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.GetUpdatesRequest parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

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

    • parseFrom

      public static UpdateServiceOuterClass.GetUpdatesRequest 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.GetUpdatesRequest parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseDelimitedFrom

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

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static UpdateServiceOuterClass.GetUpdatesRequest.Builder newBuilder()

    • newBuilder

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

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static UpdateServiceOuterClass.GetUpdatesRequest getDefaultInstance()

    • parser

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

    • getParserForType

      public com.google.protobuf.Parser<UpdateServiceOuterClass.GetUpdatesRequest> 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.GetUpdatesRequest getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder