Package com.daml.ledger.api.v2

Class TransactionFilterOuterClass.TransactionFilter

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
com.daml.ledger.api.v2.TransactionFilterOuterClass.TransactionFilter
All Implemented Interfaces:
TransactionFilterOuterClass.TransactionFilterOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
Enclosing class:
TransactionFilterOuterClass
public static final class TransactionFilterOuterClass.TransactionFilter extends com.google.protobuf.GeneratedMessageV3 implements TransactionFilterOuterClass.TransactionFilterOrBuilder
 Provided for backwards compatibility, it will be removed in the Canton version 3.4.0.
 Used both for filtering create and archive events as well as for filtering transaction trees.
Protobuf type com.daml.ledger.api.v2.TransactionFilter
See Also:

  • Field Details

    • FILTERS_BY_PARTY_FIELD_NUMBER

      public static final int FILTERS_BY_PARTY_FIELD_NUMBER
      See Also:

    • FILTERS_FOR_ANY_PARTY_FIELD_NUMBER

      public static final int FILTERS_FOR_ANY_PARTY_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()

    • internalGetMapField

      protected com.google.protobuf.MapField internalGetMapField(int number)
      Overrides:
      internalGetMapField in class com.google.protobuf.GeneratedMessageV3

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

    • getFiltersByPartyCount

      public int getFiltersByPartyCount()
      Description copied from interface: TransactionFilterOuterClass.TransactionFilterOrBuilder
       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"];
      Specified by:
      getFiltersByPartyCount in interface TransactionFilterOuterClass.TransactionFilterOrBuilder

    • containsFiltersByParty

      public 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"];
      Specified by:
      containsFiltersByParty in interface TransactionFilterOuterClass.TransactionFilterOrBuilder

    • getFiltersByParty

      @Deprecated public Map<String,TransactionFilterOuterClass.Filters> getFiltersByParty()
      Deprecated.
      Use getFiltersByPartyMap() instead.
      Specified by:
      getFiltersByParty in interface TransactionFilterOuterClass.TransactionFilterOrBuilder

    • getFiltersByPartyMap

      public 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"];
      Specified by:
      getFiltersByPartyMap in interface TransactionFilterOuterClass.TransactionFilterOrBuilder

    • getFiltersByPartyOrDefault

      public 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"];
      Specified by:
      getFiltersByPartyOrDefault in interface TransactionFilterOuterClass.TransactionFilterOrBuilder

    • getFiltersByPartyOrThrow

      public 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"];
      Specified by:
      getFiltersByPartyOrThrow in interface TransactionFilterOuterClass.TransactionFilterOrBuilder

    • hasFiltersForAnyParty

      public 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"];
      Specified by:
      hasFiltersForAnyParty in interface TransactionFilterOuterClass.TransactionFilterOrBuilder
      Returns:
      Whether the filtersForAnyParty field is set.

    • getFiltersForAnyParty

      public 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"];
      Specified by:
      getFiltersForAnyParty in interface TransactionFilterOuterClass.TransactionFilterOrBuilder
      Returns:
      The filtersForAnyParty.

    • getFiltersForAnyPartyOrBuilder

      public 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"];
      Specified by:
      getFiltersForAnyPartyOrBuilder in interface TransactionFilterOuterClass.TransactionFilterOrBuilder

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

    • parseFrom

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

    • parseFrom

      public static TransactionFilterOuterClass.TransactionFilter parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

      public static TransactionFilterOuterClass.TransactionFilter parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

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

    • parseDelimitedFrom

      public static TransactionFilterOuterClass.TransactionFilter parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

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

    • parseFrom

      public static TransactionFilterOuterClass.TransactionFilter parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static TransactionFilterOuterClass.TransactionFilter.Builder newBuilder()

    • newBuilder

      public static TransactionFilterOuterClass.TransactionFilter.Builder newBuilder(TransactionFilterOuterClass.TransactionFilter prototype)

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static TransactionFilterOuterClass.TransactionFilter getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<TransactionFilterOuterClass.TransactionFilter> parser()

    • getParserForType

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