Package com.daml.ledger.api.v2

Interface UpdateServiceOuterClass.GetUpdatesRequestOrBuilder

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

  • Method Details

    • getBeginExclusive

      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"];
      Returns:
      The beginExclusive.

    • hasEndInclusive

      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"];
      Returns:
      Whether the endInclusive field is set.

    • getEndInclusive

      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"];
      Returns:
      The endInclusive.

    • hasFilter

      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"];
      Returns:
      Whether the filter field is set.

    • getFilter

      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"];
      Returns:
      The filter.

    • getFilterOrBuilder

      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"];

    • getVerbose

      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"];
      Returns:
      The verbose.

    • hasUpdateFormat

      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"];
      Returns:
      Whether the updateFormat field is set.

    • getUpdateFormat

      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"];
      Returns:
      The updateFormat.

    • getUpdateFormatOrBuilder

      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"];