Package com.daml.ledger.api.v2

Interface TransactionFilterOuterClass.TransactionFilterOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
TransactionFilterOuterClass.TransactionFilter, TransactionFilterOuterClass.TransactionFilter.Builder
Enclosing class:
TransactionFilterOuterClass
public static interface TransactionFilterOuterClass.TransactionFilterOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Details

    • getFiltersByPartyCount

      int getFiltersByPartyCount()
       Each key must be a valid PartyIdString (as described in ``value.proto``).
 The interpretation of the filter depends on the transaction-shape being filtered:

 1. For **transaction trees** (used in GetUpdateTreesResponse for backwards compatibility) all party keys used as
    wildcard filters, and all subtrees whose root has one of the listed parties as an informee are returned.
    If there are ``CumulativeFilter``s, those will control returned ``CreatedEvent`` fields where applicable, but will
    not be used for template/interface filtering.
 2. For **ledger-effects** create and exercise events are returned, for which the witnesses include at least one of
    the listed parties and match the per-party filter.
 3. For **transaction and active-contract-set streams** create and archive events are returned for all contracts whose
    stakeholders include at least one of the listed parties and match the per-party filter.

 Required
      map<string, .com.daml.ledger.api.v2.Filters> filters_by_party = 1 [json_name = "filtersByParty"];

    • containsFiltersByParty

      boolean containsFiltersByParty(String key)
       Each key must be a valid PartyIdString (as described in ``value.proto``).
 The interpretation of the filter depends on the transaction-shape being filtered:

 1. For **transaction trees** (used in GetUpdateTreesResponse for backwards compatibility) all party keys used as
    wildcard filters, and all subtrees whose root has one of the listed parties as an informee are returned.
    If there are ``CumulativeFilter``s, those will control returned ``CreatedEvent`` fields where applicable, but will
    not be used for template/interface filtering.
 2. For **ledger-effects** create and exercise events are returned, for which the witnesses include at least one of
    the listed parties and match the per-party filter.
 3. For **transaction and active-contract-set streams** create and archive events are returned for all contracts whose
    stakeholders include at least one of the listed parties and match the per-party filter.

 Required
      map<string, .com.daml.ledger.api.v2.Filters> filters_by_party = 1 [json_name = "filtersByParty"];

    • getFiltersByParty

      @Deprecated Map<String,TransactionFilterOuterClass.Filters> getFiltersByParty()
      Deprecated.
      Use getFiltersByPartyMap() instead.

    • getFiltersByPartyMap

      Map<String,TransactionFilterOuterClass.Filters> getFiltersByPartyMap()
       Each key must be a valid PartyIdString (as described in ``value.proto``).
 The interpretation of the filter depends on the transaction-shape being filtered:

 1. For **transaction trees** (used in GetUpdateTreesResponse for backwards compatibility) all party keys used as
    wildcard filters, and all subtrees whose root has one of the listed parties as an informee are returned.
    If there are ``CumulativeFilter``s, those will control returned ``CreatedEvent`` fields where applicable, but will
    not be used for template/interface filtering.
 2. For **ledger-effects** create and exercise events are returned, for which the witnesses include at least one of
    the listed parties and match the per-party filter.
 3. For **transaction and active-contract-set streams** create and archive events are returned for all contracts whose
    stakeholders include at least one of the listed parties and match the per-party filter.

 Required
      map<string, .com.daml.ledger.api.v2.Filters> filters_by_party = 1 [json_name = "filtersByParty"];

    • getFiltersByPartyOrDefault

      TransactionFilterOuterClass.Filters getFiltersByPartyOrDefault(String key, TransactionFilterOuterClass.Filters defaultValue)
       Each key must be a valid PartyIdString (as described in ``value.proto``).
 The interpretation of the filter depends on the transaction-shape being filtered:

 1. For **transaction trees** (used in GetUpdateTreesResponse for backwards compatibility) all party keys used as
    wildcard filters, and all subtrees whose root has one of the listed parties as an informee are returned.
    If there are ``CumulativeFilter``s, those will control returned ``CreatedEvent`` fields where applicable, but will
    not be used for template/interface filtering.
 2. For **ledger-effects** create and exercise events are returned, for which the witnesses include at least one of
    the listed parties and match the per-party filter.
 3. For **transaction and active-contract-set streams** create and archive events are returned for all contracts whose
    stakeholders include at least one of the listed parties and match the per-party filter.

 Required
      map<string, .com.daml.ledger.api.v2.Filters> filters_by_party = 1 [json_name = "filtersByParty"];

    • getFiltersByPartyOrThrow

      TransactionFilterOuterClass.Filters getFiltersByPartyOrThrow(String key)
       Each key must be a valid PartyIdString (as described in ``value.proto``).
 The interpretation of the filter depends on the transaction-shape being filtered:

 1. For **transaction trees** (used in GetUpdateTreesResponse for backwards compatibility) all party keys used as
    wildcard filters, and all subtrees whose root has one of the listed parties as an informee are returned.
    If there are ``CumulativeFilter``s, those will control returned ``CreatedEvent`` fields where applicable, but will
    not be used for template/interface filtering.
 2. For **ledger-effects** create and exercise events are returned, for which the witnesses include at least one of
    the listed parties and match the per-party filter.
 3. For **transaction and active-contract-set streams** create and archive events are returned for all contracts whose
    stakeholders include at least one of the listed parties and match the per-party filter.

 Required
      map<string, .com.daml.ledger.api.v2.Filters> filters_by_party = 1 [json_name = "filtersByParty"];

    • hasFiltersForAnyParty

      boolean hasFiltersForAnyParty()
       Wildcard filters that apply to all the parties existing on the participant. The interpretation of the filters is the same
 with the per-party filter as described above.
      .com.daml.ledger.api.v2.Filters filters_for_any_party = 2 [json_name = "filtersForAnyParty"];
      Returns:
      Whether the filtersForAnyParty field is set.

    • getFiltersForAnyParty

      TransactionFilterOuterClass.Filters getFiltersForAnyParty()
       Wildcard filters that apply to all the parties existing on the participant. The interpretation of the filters is the same
 with the per-party filter as described above.
      .com.daml.ledger.api.v2.Filters filters_for_any_party = 2 [json_name = "filtersForAnyParty"];
      Returns:
      The filtersForAnyParty.

    • getFiltersForAnyPartyOrBuilder

      TransactionFilterOuterClass.FiltersOrBuilder getFiltersForAnyPartyOrBuilder()
       Wildcard filters that apply to all the parties existing on the participant. The interpretation of the filters is the same
 with the per-party filter as described above.
      .com.daml.ledger.api.v2.Filters filters_for_any_party = 2 [json_name = "filtersForAnyParty"];