Package com.daml.ledger.api.v1

Interface EventOuterClass.ExercisedEventOrBuilder

    • Method Detail

      • getEventId

        java.lang.String getEventId()
         The ID of this particular event.
 Must be a valid LedgerString (as described in ``value.proto``).
 Required
        string event_id = 1 [json_name = "eventId"];
        Returns:
        The eventId.

      • getEventIdBytes

        com.google.protobuf.ByteString getEventIdBytes()
         The ID of this particular event.
 Must be a valid LedgerString (as described in ``value.proto``).
 Required
        string event_id = 1 [json_name = "eventId"];
        Returns:
        The bytes for eventId.

      • getContractId

        java.lang.String getContractId()
         The ID of the target contract.
 Must be a valid LedgerString (as described in ``value.proto``).
 Required
        string contract_id = 2 [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 = 2 [json_name = "contractId"];
        Returns:
        The bytes for contractId.

      • hasTemplateId

        boolean hasTemplateId()
         The template of the target contract.
 Required
        .com.daml.ledger.api.v1.Identifier template_id = 3 [json_name = "templateId"];
        Returns:
        Whether the templateId field is set.

      • getTemplateId

        ValueOuterClass.Identifier getTemplateId()
         The template of the target contract.
 Required
        .com.daml.ledger.api.v1.Identifier template_id = 3 [json_name = "templateId"];
        Returns:
        The templateId.

      • getTemplateIdOrBuilder

        ValueOuterClass.IdentifierOrBuilder getTemplateIdOrBuilder()
         The template of the target contract.
 Required
        .com.daml.ledger.api.v1.Identifier template_id = 3 [json_name = "templateId"];

      • hasInterfaceId

        boolean hasInterfaceId()
         The interface where the choice is defined if inherited
 Optional
        .com.daml.ledger.api.v1.Identifier interface_id = 13 [json_name = "interfaceId"];
        Returns:
        Whether the interfaceId field is set.

      • getInterfaceId

        ValueOuterClass.Identifier getInterfaceId()
         The interface where the choice is defined if inherited
 Optional
        .com.daml.ledger.api.v1.Identifier interface_id = 13 [json_name = "interfaceId"];
        Returns:
        The interfaceId.

      • getInterfaceIdOrBuilder

        ValueOuterClass.IdentifierOrBuilder getInterfaceIdOrBuilder()
         The interface where the choice is defined if inherited
 Optional
        .com.daml.ledger.api.v1.Identifier interface_id = 13 [json_name = "interfaceId"];

      • getChoice

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

      • getChoiceBytes

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

      • hasChoiceArgument

        boolean hasChoiceArgument()
         The argument the choice was made with.
 Required
        .com.daml.ledger.api.v1.Value choice_argument = 6 [json_name = "choiceArgument"];
        Returns:
        Whether the choiceArgument field is set.

      • getChoiceArgument

        ValueOuterClass.Value getChoiceArgument()
         The argument the choice was made with.
 Required
        .com.daml.ledger.api.v1.Value choice_argument = 6 [json_name = "choiceArgument"];
        Returns:
        The choiceArgument.

      • getChoiceArgumentOrBuilder

        ValueOuterClass.ValueOrBuilder getChoiceArgumentOrBuilder()
         The argument the choice was made with.
 Required
        .com.daml.ledger.api.v1.Value choice_argument = 6 [json_name = "choiceArgument"];

      • getActingPartiesList

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

      • getActingPartiesCount

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

      • getActingParties

        java.lang.String getActingParties​(int index)
         The parties that made the choice.
 Each element must be a valid PartyIdString (as described in ``value.proto``).
 Required
        repeated string acting_parties = 7 [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 made the choice.
 Each element must be a valid PartyIdString (as described in ``value.proto``).
 Required
        repeated string acting_parties = 7 [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 = 8 [json_name = "consuming"];
        Returns:
        The consuming.

      • getWitnessPartiesList

        java.util.List<java.lang.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

        java.lang.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.

      • getChildEventIdsList

        java.util.List<java.lang.String> getChildEventIdsList()
         References to further events in the same transaction that appeared as a result of this ``ExercisedEvent``.
 It contains only the immediate children of this event, not all members of the subtree rooted at this node.
 The order of the children is the same as the event order in the transaction.
 Each element must be a valid LedgerString (as described in ``value.proto``).
 Optional
        repeated string child_event_ids = 11 [json_name = "childEventIds"];
        Returns:
        A list containing the childEventIds.

      • getChildEventIdsCount

        int getChildEventIdsCount()
         References to further events in the same transaction that appeared as a result of this ``ExercisedEvent``.
 It contains only the immediate children of this event, not all members of the subtree rooted at this node.
 The order of the children is the same as the event order in the transaction.
 Each element must be a valid LedgerString (as described in ``value.proto``).
 Optional
        repeated string child_event_ids = 11 [json_name = "childEventIds"];
        Returns:
        The count of childEventIds.

      • getChildEventIds

        java.lang.String getChildEventIds​(int index)
         References to further events in the same transaction that appeared as a result of this ``ExercisedEvent``.
 It contains only the immediate children of this event, not all members of the subtree rooted at this node.
 The order of the children is the same as the event order in the transaction.
 Each element must be a valid LedgerString (as described in ``value.proto``).
 Optional
        repeated string child_event_ids = 11 [json_name = "childEventIds"];
        Parameters:
        index - The index of the element to return.
        Returns:
        The childEventIds at the given index.

      • getChildEventIdsBytes

        com.google.protobuf.ByteString getChildEventIdsBytes​(int index)
         References to further events in the same transaction that appeared as a result of this ``ExercisedEvent``.
 It contains only the immediate children of this event, not all members of the subtree rooted at this node.
 The order of the children is the same as the event order in the transaction.
 Each element must be a valid LedgerString (as described in ``value.proto``).
 Optional
        repeated string child_event_ids = 11 [json_name = "childEventIds"];
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the childEventIds at the given index.

      • hasExerciseResult

        boolean hasExerciseResult()
         The result of exercising the choice
 Required
        .com.daml.ledger.api.v1.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.v1.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.v1.Value exercise_result = 12 [json_name = "exerciseResult"];