Package com.daml.ledger.api.v2

Class TransactionFilterOuterClass.EventFormat.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<TransactionFilterOuterClass.EventFormat.Builder>
com.google.protobuf.GeneratedMessageV3.Builder<TransactionFilterOuterClass.EventFormat.Builder>
com.daml.ledger.api.v2.TransactionFilterOuterClass.EventFormat.Builder
All Implemented Interfaces:
TransactionFilterOuterClass.EventFormatOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
Enclosing class:
TransactionFilterOuterClass.EventFormat
public static final class TransactionFilterOuterClass.EventFormat.Builder extends com.google.protobuf.GeneratedMessageV3.Builder<TransactionFilterOuterClass.EventFormat.Builder> implements TransactionFilterOuterClass.EventFormatOrBuilder
 A format for events which defines both which events should be included
 and what data should be computed and included for them.

 Note that some of the filtering behavior depends on the `TransactionShape`,
 which is expected to be specified alongside usages of `EventFormat`.
Protobuf type com.daml.ledger.api.v2.EventFormat

  • Method Details

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetMapFieldReflection

      protected com.google.protobuf.MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
      Overrides:
      internalGetMapFieldReflection in class com.google.protobuf.GeneratedMessageV3.Builder<TransactionFilterOuterClass.EventFormat.Builder>

    • internalGetMutableMapFieldReflection

      protected com.google.protobuf.MapFieldReflectionAccessor internalGetMutableMapFieldReflection(int number)
      Overrides:
      internalGetMutableMapFieldReflection in class com.google.protobuf.GeneratedMessageV3.Builder<TransactionFilterOuterClass.EventFormat.Builder>

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<TransactionFilterOuterClass.EventFormat.Builder>

    • clear

      public TransactionFilterOuterClass.EventFormat.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<TransactionFilterOuterClass.EventFormat.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<TransactionFilterOuterClass.EventFormat.Builder>

    • getDefaultInstanceForType

      public TransactionFilterOuterClass.EventFormat getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

    • build

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

    • buildPartial

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

    • clone

      public TransactionFilterOuterClass.EventFormat.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<TransactionFilterOuterClass.EventFormat.Builder>

    • setField

      public TransactionFilterOuterClass.EventFormat.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<TransactionFilterOuterClass.EventFormat.Builder>

    • clearField

      public TransactionFilterOuterClass.EventFormat.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<TransactionFilterOuterClass.EventFormat.Builder>

    • clearOneof

      public TransactionFilterOuterClass.EventFormat.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<TransactionFilterOuterClass.EventFormat.Builder>

    • setRepeatedField

      public TransactionFilterOuterClass.EventFormat.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<TransactionFilterOuterClass.EventFormat.Builder>

    • addRepeatedField

      public TransactionFilterOuterClass.EventFormat.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<TransactionFilterOuterClass.EventFormat.Builder>

    • mergeFrom

      public TransactionFilterOuterClass.EventFormat.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<TransactionFilterOuterClass.EventFormat.Builder>

    • mergeFrom

      public TransactionFilterOuterClass.EventFormat.Builder mergeFrom(TransactionFilterOuterClass.EventFormat other)

    • isInitialized

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

    • mergeFrom

      public TransactionFilterOuterClass.EventFormat.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<TransactionFilterOuterClass.EventFormat.Builder>
      Throws:
      IOException

    • getFiltersByPartyCount

      public int getFiltersByPartyCount()
      Description copied from interface: TransactionFilterOuterClass.EventFormatOrBuilder
       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 **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.
 2. 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.

 Optional: can be empty
      map<string, .com.daml.ledger.api.v2.Filters> filters_by_party = 1;
      Specified by:
      getFiltersByPartyCount in interface TransactionFilterOuterClass.EventFormatOrBuilder

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

 Optional: can be empty
      map<string, .com.daml.ledger.api.v2.Filters> filters_by_party = 1;
      Specified by:
      containsFiltersByParty in interface TransactionFilterOuterClass.EventFormatOrBuilder

    • getFiltersByParty

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

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

 Optional: can be empty
      map<string, .com.daml.ledger.api.v2.Filters> filters_by_party = 1;
      Specified by:
      getFiltersByPartyMap in interface TransactionFilterOuterClass.EventFormatOrBuilder

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

 Optional: can be empty
      map<string, .com.daml.ledger.api.v2.Filters> filters_by_party = 1;
      Specified by:
      getFiltersByPartyOrDefault in interface TransactionFilterOuterClass.EventFormatOrBuilder

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

 Optional: can be empty
      map<string, .com.daml.ledger.api.v2.Filters> filters_by_party = 1;
      Specified by:
      getFiltersByPartyOrThrow in interface TransactionFilterOuterClass.EventFormatOrBuilder

    • clearFiltersByParty

      public TransactionFilterOuterClass.EventFormat.Builder clearFiltersByParty()

    • removeFiltersByParty

      public TransactionFilterOuterClass.EventFormat.Builder removeFiltersByParty(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 **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.
 2. 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.

 Optional: can be empty
      map<string, .com.daml.ledger.api.v2.Filters> filters_by_party = 1;

    • getMutableFiltersByParty

      @Deprecated public Map<String,TransactionFilterOuterClass.Filters> getMutableFiltersByParty()
      Deprecated.
      Use alternate mutation accessors instead.

    • putFiltersByParty

      public TransactionFilterOuterClass.EventFormat.Builder putFiltersByParty(String key, TransactionFilterOuterClass.Filters value)
       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 **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.
 2. 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.

 Optional: can be empty
      map<string, .com.daml.ledger.api.v2.Filters> filters_by_party = 1;

    • putAllFiltersByParty

      public TransactionFilterOuterClass.EventFormat.Builder putAllFiltersByParty(Map<String,TransactionFilterOuterClass.Filters> values)
       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 **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.
 2. 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.

 Optional: can be empty
      map<string, .com.daml.ledger.api.v2.Filters> filters_by_party = 1;

    • putFiltersByPartyBuilderIfAbsent

      public TransactionFilterOuterClass.Filters.Builder putFiltersByPartyBuilderIfAbsent(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 **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.
 2. 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.

 Optional: can be empty
      map<string, .com.daml.ledger.api.v2.Filters> filters_by_party = 1;

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

 Optional
      .com.daml.ledger.api.v2.Filters filters_for_any_party = 2;
      Specified by:
      hasFiltersForAnyParty in interface TransactionFilterOuterClass.EventFormatOrBuilder
      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.

 Optional
      .com.daml.ledger.api.v2.Filters filters_for_any_party = 2;
      Specified by:
      getFiltersForAnyParty in interface TransactionFilterOuterClass.EventFormatOrBuilder
      Returns:
      The filtersForAnyParty.

    • setFiltersForAnyParty

      public TransactionFilterOuterClass.EventFormat.Builder setFiltersForAnyParty(TransactionFilterOuterClass.Filters value)
       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.

 Optional
      .com.daml.ledger.api.v2.Filters filters_for_any_party = 2;

    • setFiltersForAnyParty

      public TransactionFilterOuterClass.EventFormat.Builder setFiltersForAnyParty(TransactionFilterOuterClass.Filters.Builder builderForValue)
       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.

 Optional
      .com.daml.ledger.api.v2.Filters filters_for_any_party = 2;

    • mergeFiltersForAnyParty

      public TransactionFilterOuterClass.EventFormat.Builder mergeFiltersForAnyParty(TransactionFilterOuterClass.Filters value)
       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.

 Optional
      .com.daml.ledger.api.v2.Filters filters_for_any_party = 2;

    • clearFiltersForAnyParty

      public TransactionFilterOuterClass.EventFormat.Builder clearFiltersForAnyParty()
       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.

 Optional
      .com.daml.ledger.api.v2.Filters filters_for_any_party = 2;

    • getFiltersForAnyPartyBuilder

      public TransactionFilterOuterClass.Filters.Builder getFiltersForAnyPartyBuilder()
       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.

 Optional
      .com.daml.ledger.api.v2.Filters filters_for_any_party = 2;

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

 Optional
      .com.daml.ledger.api.v2.Filters filters_for_any_party = 2;
      Specified by:
      getFiltersForAnyPartyOrBuilder in interface TransactionFilterOuterClass.EventFormatOrBuilder

    • getVerbose

      public boolean getVerbose()
       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 for record fields.

 Optional
      bool verbose = 3;
      Specified by:
      getVerbose in interface TransactionFilterOuterClass.EventFormatOrBuilder
      Returns:
      The verbose.

    • setVerbose

      public TransactionFilterOuterClass.EventFormat.Builder setVerbose(boolean value)
       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 for record fields.

 Optional
      bool verbose = 3;
      Parameters:
      value - The verbose to set.
      Returns:
      This builder for chaining.

    • clearVerbose

      public TransactionFilterOuterClass.EventFormat.Builder clearVerbose()
       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 for record fields.

 Optional
      bool verbose = 3;
      Returns:
      This builder for chaining.

    • setUnknownFields

      public final TransactionFilterOuterClass.EventFormat.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<TransactionFilterOuterClass.EventFormat.Builder>

    • mergeUnknownFields

      public final TransactionFilterOuterClass.EventFormat.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<TransactionFilterOuterClass.EventFormat.Builder>