Package com.daml.ledger.api.v1

Class EventOuterClass.ExercisedEvent

  • All Implemented Interfaces:
    EventOuterClass.ExercisedEventOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, java.io.Serializable
    Enclosing class:
    EventOuterClass
    public static final class EventOuterClass.ExercisedEvent
extends com.google.protobuf.GeneratedMessageV3
implements EventOuterClass.ExercisedEventOrBuilder
     Records that a choice has been exercised on a target contract.
    Protobuf type com.daml.ledger.api.v1.ExercisedEvent
    See Also:
    Serialized Form

    • Method Detail

      • newInstance

        protected java.lang.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()

      • internalGetFieldAccessorTable

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

      • getEventId

        public 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"];
        Specified by:
        getEventId in interface EventOuterClass.ExercisedEventOrBuilder
        Returns:
        The eventId.

      • getEventIdBytes

        public 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"];
        Specified by:
        getEventIdBytes in interface EventOuterClass.ExercisedEventOrBuilder
        Returns:
        The bytes for eventId.

      • getContractId

        public 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"];
        Specified by:
        getContractId in interface EventOuterClass.ExercisedEventOrBuilder
        Returns:
        The contractId.

      • getContractIdBytes

        public 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"];
        Specified by:
        getContractIdBytes in interface EventOuterClass.ExercisedEventOrBuilder
        Returns:
        The bytes for contractId.

      • hasTemplateId

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

      • hasInterfaceId

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

      • getChoice

        public java.lang.String getChoice()
         The choice that was exercised on the target contract.
 Must be a valid NameString (as described in ``value.proto``).
 Required
        string choice = 5 [json_name = "choice"];
        Specified by:
        getChoice in interface EventOuterClass.ExercisedEventOrBuilder
        Returns:
        The choice.

      • getChoiceBytes

        public 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 = 5 [json_name = "choice"];
        Specified by:
        getChoiceBytes in interface EventOuterClass.ExercisedEventOrBuilder
        Returns:
        The bytes for choice.

      • hasChoiceArgument

        public boolean hasChoiceArgument()
         The argument of the exercised choice.
 Required
        .com.daml.ledger.api.v1.Value choice_argument = 6 [json_name = "choiceArgument"];
        Specified by:
        hasChoiceArgument in interface EventOuterClass.ExercisedEventOrBuilder
        Returns:
        Whether the choiceArgument field is set.

      • getActingPartiesList

        public com.google.protobuf.ProtocolStringList getActingPartiesList()
         The parties that exercised the choice.
 Each element must be a valid PartyIdString (as described in ``value.proto``).
 Required
        repeated string acting_parties = 7 [json_name = "actingParties"];
        Specified by:
        getActingPartiesList in interface EventOuterClass.ExercisedEventOrBuilder
        Returns:
        A list containing the actingParties.

      • getActingPartiesCount

        public 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 = 7 [json_name = "actingParties"];
        Specified by:
        getActingPartiesCount in interface EventOuterClass.ExercisedEventOrBuilder
        Returns:
        The count of actingParties.

      • getActingParties

        public java.lang.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 = 7 [json_name = "actingParties"];
        Specified by:
        getActingParties in interface EventOuterClass.ExercisedEventOrBuilder
        Parameters:
        index - The index of the element to return.
        Returns:
        The actingParties at the given index.

      • getActingPartiesBytes

        public 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 = 7 [json_name = "actingParties"];
        Specified by:
        getActingPartiesBytes in interface EventOuterClass.ExercisedEventOrBuilder
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the actingParties at the given index.

      • getConsuming

        public boolean getConsuming()
         If true, the target contract may no longer be exercised.
 Required
        bool consuming = 8 [json_name = "consuming"];
        Specified by:
        getConsuming in interface EventOuterClass.ExercisedEventOrBuilder
        Returns:
        The consuming.

      • getWitnessPartiesList

        public com.google.protobuf.ProtocolStringList 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"];
        Specified by:
        getWitnessPartiesList in interface EventOuterClass.ExercisedEventOrBuilder
        Returns:
        A list containing the witnessParties.

      • getWitnessPartiesCount

        public 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"];
        Specified by:
        getWitnessPartiesCount in interface EventOuterClass.ExercisedEventOrBuilder
        Returns:
        The count of witnessParties.

      • getWitnessParties

        public 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"];
        Specified by:
        getWitnessParties in interface EventOuterClass.ExercisedEventOrBuilder
        Parameters:
        index - The index of the element to return.
        Returns:
        The witnessParties at the given index.

      • getWitnessPartiesBytes

        public 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"];
        Specified by:
        getWitnessPartiesBytes in interface EventOuterClass.ExercisedEventOrBuilder
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the witnessParties at the given index.

      • getChildEventIdsList

        public com.google.protobuf.ProtocolStringList 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"];
        Specified by:
        getChildEventIdsList in interface EventOuterClass.ExercisedEventOrBuilder
        Returns:
        A list containing the childEventIds.

      • getChildEventIdsCount

        public 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"];
        Specified by:
        getChildEventIdsCount in interface EventOuterClass.ExercisedEventOrBuilder
        Returns:
        The count of childEventIds.

      • getChildEventIds

        public 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"];
        Specified by:
        getChildEventIds in interface EventOuterClass.ExercisedEventOrBuilder
        Parameters:
        index - The index of the element to return.
        Returns:
        The childEventIds at the given index.

      • getChildEventIdsBytes

        public 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"];
        Specified by:
        getChildEventIdsBytes in interface EventOuterClass.ExercisedEventOrBuilder
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the childEventIds at the given index.

      • hasExerciseResult

        public boolean hasExerciseResult()
         The result of exercising the choice.
 Required
        .com.daml.ledger.api.v1.Value exercise_result = 12 [json_name = "exerciseResult"];
        Specified by:
        hasExerciseResult in interface EventOuterClass.ExercisedEventOrBuilder
        Returns:
        Whether the exerciseResult field is set.

      • 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 java.io.IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        java.io.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​(java.lang.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 EventOuterClass.ExercisedEvent parseFrom​(java.nio.ByteBuffer data)
                                                throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static EventOuterClass.ExercisedEvent parseFrom​(java.nio.ByteBuffer data,
                                                       com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static EventOuterClass.ExercisedEvent parseFrom​(com.google.protobuf.ByteString data)
                                                throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static EventOuterClass.ExercisedEvent parseFrom​(com.google.protobuf.ByteString data,
                                                       com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static EventOuterClass.ExercisedEvent parseFrom​(byte[] data)
                                                throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

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

      • parseFrom

        public static EventOuterClass.ExercisedEvent parseFrom​(java.io.InputStream input)
                                                throws java.io.IOException
        Throws:
        java.io.IOException

      • parseFrom

        public static EventOuterClass.ExercisedEvent parseFrom​(java.io.InputStream input,
                                                       com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                throws java.io.IOException
        Throws:
        java.io.IOException

      • parseDelimitedFrom

        public static EventOuterClass.ExercisedEvent parseDelimitedFrom​(java.io.InputStream input)
                                                         throws java.io.IOException
        Throws:
        java.io.IOException

      • parseDelimitedFrom

        public static EventOuterClass.ExercisedEvent parseDelimitedFrom​(java.io.InputStream input,
                                                                com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                         throws java.io.IOException
        Throws:
        java.io.IOException

      • parseFrom

        public static EventOuterClass.ExercisedEvent parseFrom​(com.google.protobuf.CodedInputStream input)
                                                throws java.io.IOException
        Throws:
        java.io.IOException

      • parseFrom

        public static EventOuterClass.ExercisedEvent parseFrom​(com.google.protobuf.CodedInputStream input,
                                                       com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                throws java.io.IOException
        Throws:
        java.io.IOException

      • newBuilderForType

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

      • toBuilder

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

      • newBuilderForType

        protected EventOuterClass.ExercisedEvent.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • getParserForType

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