Package com.daml.ledger.api.v2

Interface EventOuterClass.ExercisedEventOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
EventOuterClass.ExercisedEvent, EventOuterClass.ExercisedEvent.Builder
Enclosing class:
EventOuterClass
public static interface EventOuterClass.ExercisedEventOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Details

    • getOffset

      long getOffset()
       The offset of origin.
 Offsets are managed by the participant nodes.
 Transactions can thus NOT be assumed to have the same offsets on different participant nodes.
 Required, it is a valid absolute offset (positive integer)
      int64 offset = 1 [json_name = "offset"];
      Returns:
      The offset.

    • getNodeId

      int getNodeId()
       The position of this event in the originating transaction or reassignment.
 Node IDs are not necessarily equal across participants,
 as these may see different projections/parts of transactions.
 Required, must be valid node ID (non-negative integer)
      int32 node_id = 2 [json_name = "nodeId"];
      Returns:
      The nodeId.

    • getContractId

      String getContractId()
       The ID of the target contract.
 Must be a valid LedgerString (as described in ``value.proto``).
 Required
      string contract_id = 3 [json_name = "contractId"];
      Returns:
      The contractId.

    • getContractIdBytes

      com.google.protobuf.ByteString getContractIdBytes()
       The ID of the target contract.
 Must be a valid LedgerString (as described in ``value.proto``).
 Required
      string contract_id = 3 [json_name = "contractId"];
      Returns:
      The bytes for contractId.

    • hasTemplateId

      boolean hasTemplateId()
       The template of the target contract.
 The identifier uses the package-id reference format.

 Required
      .com.daml.ledger.api.v2.Identifier template_id = 4 [json_name = "templateId"];
      Returns:
      Whether the templateId field is set.

    • getTemplateId

      ValueOuterClass.Identifier getTemplateId()
       The template of the target contract.
 The identifier uses the package-id reference format.

 Required
      .com.daml.ledger.api.v2.Identifier template_id = 4 [json_name = "templateId"];
      Returns:
      The templateId.

    • getTemplateIdOrBuilder

      ValueOuterClass.IdentifierOrBuilder getTemplateIdOrBuilder()
       The template of the target contract.
 The identifier uses the package-id reference format.

 Required
      .com.daml.ledger.api.v2.Identifier template_id = 4 [json_name = "templateId"];

    • hasInterfaceId

      boolean hasInterfaceId()
       The interface where the choice is defined, if inherited.
 If defined, the identifier uses the package-id reference format.

 Optional
      .com.daml.ledger.api.v2.Identifier interface_id = 5 [json_name = "interfaceId"];
      Returns:
      Whether the interfaceId field is set.

    • getInterfaceId

      ValueOuterClass.Identifier getInterfaceId()
       The interface where the choice is defined, if inherited.
 If defined, the identifier uses the package-id reference format.

 Optional
      .com.daml.ledger.api.v2.Identifier interface_id = 5 [json_name = "interfaceId"];
      Returns:
      The interfaceId.

    • getInterfaceIdOrBuilder

      ValueOuterClass.IdentifierOrBuilder getInterfaceIdOrBuilder()
       The interface where the choice is defined, if inherited.
 If defined, the identifier uses the package-id reference format.

 Optional
      .com.daml.ledger.api.v2.Identifier interface_id = 5 [json_name = "interfaceId"];

    • getChoice

      String getChoice()
       The choice that was exercised on the target contract.
 Must be a valid NameString (as described in ``value.proto``).
 Required
      string choice = 6 [json_name = "choice"];
      Returns:
      The choice.

    • getChoiceBytes

      com.google.protobuf.ByteString getChoiceBytes()
       The choice that was exercised on the target contract.
 Must be a valid NameString (as described in ``value.proto``).
 Required
      string choice = 6 [json_name = "choice"];
      Returns:
      The bytes for choice.

    • hasChoiceArgument

      boolean hasChoiceArgument()
       The argument of the exercised choice.
 Required
      .com.daml.ledger.api.v2.Value choice_argument = 7 [json_name = "choiceArgument"];
      Returns:
      Whether the choiceArgument field is set.

    • getChoiceArgument

      ValueOuterClass.Value getChoiceArgument()
       The argument of the exercised choice.
 Required
      .com.daml.ledger.api.v2.Value choice_argument = 7 [json_name = "choiceArgument"];
      Returns:
      The choiceArgument.

    • getChoiceArgumentOrBuilder

      ValueOuterClass.ValueOrBuilder getChoiceArgumentOrBuilder()
       The argument of the exercised choice.
 Required
      .com.daml.ledger.api.v2.Value choice_argument = 7 [json_name = "choiceArgument"];

    • getActingPartiesList

      List<String> getActingPartiesList()
       The parties that exercised the choice.
 Each element must be a valid PartyIdString (as described in ``value.proto``).
 Required
      repeated string acting_parties = 8 [json_name = "actingParties"];
      Returns:
      A list containing the actingParties.

    • getActingPartiesCount

      int getActingPartiesCount()
       The parties that exercised the choice.
 Each element must be a valid PartyIdString (as described in ``value.proto``).
 Required
      repeated string acting_parties = 8 [json_name = "actingParties"];
      Returns:
      The count of actingParties.

    • getActingParties

      String getActingParties(int index)
       The parties that exercised the choice.
 Each element must be a valid PartyIdString (as described in ``value.proto``).
 Required
      repeated string acting_parties = 8 [json_name = "actingParties"];
      Parameters:
      index - The index of the element to return.
      Returns:
      The actingParties at the given index.

    • getActingPartiesBytes

      com.google.protobuf.ByteString getActingPartiesBytes(int index)
       The parties that exercised the choice.
 Each element must be a valid PartyIdString (as described in ``value.proto``).
 Required
      repeated string acting_parties = 8 [json_name = "actingParties"];
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the actingParties at the given index.

    • getConsuming

      boolean getConsuming()
       If true, the target contract may no longer be exercised.
 Required
      bool consuming = 9 [json_name = "consuming"];
      Returns:
      The consuming.

    • getWitnessPartiesList

      List<String> getWitnessPartiesList()
       The parties that are notified of this event. The witnesses of an exercise
 node will depend on whether the exercise was consuming or not.
 If consuming, the witnesses are the union of the stakeholders and
 the actors.
 If not consuming, the witnesses are the union of the signatories and
 the actors. Note that the actors might not necessarily be observers
 and thus signatories. This is the case when the controllers of a
 choice are specified using "flexible controllers", using the
 ``choice ... controller`` syntax, and said controllers are not
 explicitly marked as observers.
 Each element must be a valid PartyIdString (as described in ``value.proto``).
 Required
      repeated string witness_parties = 10 [json_name = "witnessParties"];
      Returns:
      A list containing the witnessParties.

    • getWitnessPartiesCount

      int getWitnessPartiesCount()
       The parties that are notified of this event. The witnesses of an exercise
 node will depend on whether the exercise was consuming or not.
 If consuming, the witnesses are the union of the stakeholders and
 the actors.
 If not consuming, the witnesses are the union of the signatories and
 the actors. Note that the actors might not necessarily be observers
 and thus signatories. This is the case when the controllers of a
 choice are specified using "flexible controllers", using the
 ``choice ... controller`` syntax, and said controllers are not
 explicitly marked as observers.
 Each element must be a valid PartyIdString (as described in ``value.proto``).
 Required
      repeated string witness_parties = 10 [json_name = "witnessParties"];
      Returns:
      The count of witnessParties.

    • getWitnessParties

      String getWitnessParties(int index)
       The parties that are notified of this event. The witnesses of an exercise
 node will depend on whether the exercise was consuming or not.
 If consuming, the witnesses are the union of the stakeholders and
 the actors.
 If not consuming, the witnesses are the union of the signatories and
 the actors. Note that the actors might not necessarily be observers
 and thus signatories. This is the case when the controllers of a
 choice are specified using "flexible controllers", using the
 ``choice ... controller`` syntax, and said controllers are not
 explicitly marked as observers.
 Each element must be a valid PartyIdString (as described in ``value.proto``).
 Required
      repeated string witness_parties = 10 [json_name = "witnessParties"];
      Parameters:
      index - The index of the element to return.
      Returns:
      The witnessParties at the given index.

    • getWitnessPartiesBytes

      com.google.protobuf.ByteString getWitnessPartiesBytes(int index)
       The parties that are notified of this event. The witnesses of an exercise
 node will depend on whether the exercise was consuming or not.
 If consuming, the witnesses are the union of the stakeholders and
 the actors.
 If not consuming, the witnesses are the union of the signatories and
 the actors. Note that the actors might not necessarily be observers
 and thus signatories. This is the case when the controllers of a
 choice are specified using "flexible controllers", using the
 ``choice ... controller`` syntax, and said controllers are not
 explicitly marked as observers.
 Each element must be a valid PartyIdString (as described in ``value.proto``).
 Required
      repeated string witness_parties = 10 [json_name = "witnessParties"];
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the witnessParties at the given index.

    • getLastDescendantNodeId

      int getLastDescendantNodeId()
       Specifies the upper boundary of the node ids of the events in the same transaction that appeared as a result of
 this ``ExercisedEvent``. This allows unambiguous identification of all the members of the subtree rooted at this
 node. A full subtree can be constructed when all descendant nodes are present in the stream. If nodes are heavily
 filtered, it is only possible to determine if a node is in a consequent subtree or not.
 Required
      int32 last_descendant_node_id = 11 [json_name = "lastDescendantNodeId"];
      Returns:
      The lastDescendantNodeId.

    • hasExerciseResult

      boolean hasExerciseResult()
       The result of exercising the choice.
 Required
      .com.daml.ledger.api.v2.Value exercise_result = 12 [json_name = "exerciseResult"];
      Returns:
      Whether the exerciseResult field is set.

    • getExerciseResult

      ValueOuterClass.Value getExerciseResult()
       The result of exercising the choice.
 Required
      .com.daml.ledger.api.v2.Value exercise_result = 12 [json_name = "exerciseResult"];
      Returns:
      The exerciseResult.

    • getExerciseResultOrBuilder

      ValueOuterClass.ValueOrBuilder getExerciseResultOrBuilder()
       The result of exercising the choice.
 Required
      .com.daml.ledger.api.v2.Value exercise_result = 12 [json_name = "exerciseResult"];

    • getPackageName

      String getPackageName()
       The package name of the contract.
 Required
      string package_name = 13 [json_name = "packageName"];
      Returns:
      The packageName.

    • getPackageNameBytes

      com.google.protobuf.ByteString getPackageNameBytes()
       The package name of the contract.
 Required
      string package_name = 13 [json_name = "packageName"];
      Returns:
      The bytes for packageName.

    • getImplementedInterfacesList

      List<ValueOuterClass.Identifier> getImplementedInterfacesList()
       If the event is consuming, the interfaces implemented by the target template that have been
 matched from the interface filter query.
 Populated only in case interface filters with include_interface_view set.

 The identifier uses the package-id reference format.

 Optional
      repeated .com.daml.ledger.api.v2.Identifier implemented_interfaces = 14 [json_name = "implementedInterfaces"];

    • getImplementedInterfaces

      ValueOuterClass.Identifier getImplementedInterfaces(int index)
       If the event is consuming, the interfaces implemented by the target template that have been
 matched from the interface filter query.
 Populated only in case interface filters with include_interface_view set.

 The identifier uses the package-id reference format.

 Optional
      repeated .com.daml.ledger.api.v2.Identifier implemented_interfaces = 14 [json_name = "implementedInterfaces"];

    • getImplementedInterfacesCount

      int getImplementedInterfacesCount()
       If the event is consuming, the interfaces implemented by the target template that have been
 matched from the interface filter query.
 Populated only in case interface filters with include_interface_view set.

 The identifier uses the package-id reference format.

 Optional
      repeated .com.daml.ledger.api.v2.Identifier implemented_interfaces = 14 [json_name = "implementedInterfaces"];

    • getImplementedInterfacesOrBuilderList

      List<? extends ValueOuterClass.IdentifierOrBuilder> getImplementedInterfacesOrBuilderList()
       If the event is consuming, the interfaces implemented by the target template that have been
 matched from the interface filter query.
 Populated only in case interface filters with include_interface_view set.

 The identifier uses the package-id reference format.

 Optional
      repeated .com.daml.ledger.api.v2.Identifier implemented_interfaces = 14 [json_name = "implementedInterfaces"];

    • getImplementedInterfacesOrBuilder

      ValueOuterClass.IdentifierOrBuilder getImplementedInterfacesOrBuilder(int index)
       If the event is consuming, the interfaces implemented by the target template that have been
 matched from the interface filter query.
 Populated only in case interface filters with include_interface_view set.

 The identifier uses the package-id reference format.

 Optional
      repeated .com.daml.ledger.api.v2.Identifier implemented_interfaces = 14 [json_name = "implementedInterfaces"];