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 Summary

Modifier and Type

Method

Description

boolean

getAcsDelta()

Whether this event would be part of respective ACS_DELTA shaped stream, and should therefore considered when tracking contract activeness on the client-side.

String

getActingParties(int index)

The parties that exercised the choice.

com.google.protobuf.ByteString

getActingPartiesBytes(int index)

The parties that exercised the choice.

int

getActingPartiesCount()

The parties that exercised the choice.

List<String>

getActingPartiesList()

The parties that exercised the choice.

String

getChoice()

The choice that was exercised on the target contract.

com.daml.ledger.api.v2.ValueOuterClass.Value

getChoiceArgument()

The argument of the exercised choice.

com.daml.ledger.api.v2.ValueOuterClass.ValueOrBuilder

getChoiceArgumentOrBuilder()

The argument of the exercised choice.

com.google.protobuf.ByteString

getChoiceBytes()

The choice that was exercised on the target contract.

boolean

getConsuming()

If true, the target contract may no longer be exercised.

String

getContractId()

The ID of the target contract.

com.google.protobuf.ByteString

getContractIdBytes()

The ID of the target contract.

com.daml.ledger.api.v2.ValueOuterClass.Value

getExerciseResult()

The result of exercising the choice.

com.daml.ledger.api.v2.ValueOuterClass.ValueOrBuilder

getExerciseResultOrBuilder()

The result of exercising the choice.

com.daml.ledger.api.v2.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.

int

getImplementedInterfacesCount()

If the event is consuming, the interfaces implemented by the target template that have been matched from the interface filter query.

List<com.daml.ledger.api.v2.ValueOuterClass.Identifier>

getImplementedInterfacesList()

If the event is consuming, the interfaces implemented by the target template that have been matched from the interface filter query.

com.daml.ledger.api.v2.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.

List<? extends com.daml.ledger.api.v2.ValueOuterClass.IdentifierOrBuilder>

getImplementedInterfacesOrBuilderList()

If the event is consuming, the interfaces implemented by the target template that have been matched from the interface filter query.

com.daml.ledger.api.v2.ValueOuterClass.Identifier

getInterfaceId()

The interface where the choice is defined, if inherited.

com.daml.ledger.api.v2.ValueOuterClass.IdentifierOrBuilder

getInterfaceIdOrBuilder()

The interface where the choice is defined, if inherited.

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

int

getNodeId()

The position of this event in the originating transaction or reassignment.

long

getOffset()

The offset of origin.

String

getPackageName()

The package name of the contract.

com.google.protobuf.ByteString

getPackageNameBytes()

The package name of the contract.

com.daml.ledger.api.v2.ValueOuterClass.Identifier

getTemplateId()

Identifies the template that defines the executed choice.

com.daml.ledger.api.v2.ValueOuterClass.IdentifierOrBuilder

getTemplateIdOrBuilder()

Identifies the template that defines the executed choice.

String

getWitnessParties(int index)

The parties that are notified of this event.

com.google.protobuf.ByteString

getWitnessPartiesBytes(int index)

The parties that are notified of this event.

int

getWitnessPartiesCount()

The parties that are notified of this event.

List<String>

getWitnessPartiesList()

The parties that are notified of this event.

boolean

hasChoiceArgument()

The argument of the exercised choice.

boolean

hasExerciseResult()

The result of exercising the choice.

boolean

hasInterfaceId()

The interface where the choice is defined, if inherited.

boolean

hasTemplateId()

Identifies the template that defines the executed choice.

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder
isInitialized

Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

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.
 It is a valid absolute offset (positive integer)

 Required

int64 offset = 1;

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.
 Must be valid node ID (non-negative integer)

 Required

int32 node_id = 2;

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;

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;
Returns:

The bytes for contractId.

hasTemplateId

boolean hasTemplateId()

 Identifies the template that defines the executed choice.
 This template's package-id may differ from the target contract's package-id
 if the target contract has been upgraded or downgraded.

 The identifier uses the package-id reference format.

 Required

.com.daml.ledger.api.v2.Identifier template_id = 4;

Returns:: Whether the templateId field is set.

getTemplateId

com.daml.ledger.api.v2.ValueOuterClass.Identifier getTemplateId()

 Identifies the template that defines the executed choice.
 This template's package-id may differ from the target contract's package-id
 if the target contract has been upgraded or downgraded.

 The identifier uses the package-id reference format.

 Required

.com.daml.ledger.api.v2.Identifier template_id = 4;

Returns:: The templateId.

getTemplateIdOrBuilder

com.daml.ledger.api.v2.ValueOuterClass.IdentifierOrBuilder getTemplateIdOrBuilder()

 Identifies the template that defines the executed choice.
 This template's package-id may differ from the target contract's package-id
 if the target contract has been upgraded or downgraded.

 The identifier uses the package-id reference format.

 Required

.com.daml.ledger.api.v2.Identifier template_id = 4;

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;

Returns:: Whether the interfaceId field is set.

getInterfaceId

com.daml.ledger.api.v2.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;
Returns:

The interfaceId.
getInterfaceIdOrBuilder

com.daml.ledger.api.v2.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;

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;

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;

Returns:: The bytes for choice.

hasChoiceArgument

boolean hasChoiceArgument()
```
 The argument of the exercised choice.

 Required
 
```
.com.daml.ledger.api.v2.Value choice_argument = 7;
Returns:

Whether the choiceArgument field is set.
getChoiceArgument

com.daml.ledger.api.v2.ValueOuterClass.Value getChoiceArgument()
```
 The argument of the exercised choice.

 Required
 
```
.com.daml.ledger.api.v2.Value choice_argument = 7;
Returns:

The choiceArgument.
getChoiceArgumentOrBuilder

com.daml.ledger.api.v2.ValueOuterClass.ValueOrBuilder getChoiceArgumentOrBuilder()
```
 The argument of the exercised choice.

 Required
 
```
.com.daml.ledger.api.v2.Value choice_argument = 7;

getActingPartiesList

List<String> getActingPartiesList()

 The parties that exercised the choice.
 Each element must be a valid PartyIdString (as described in ``value.proto``).

 Required: must be non-empty

repeated string acting_parties = 8;

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: must be non-empty

repeated string acting_parties = 8;

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: must be non-empty
 
```
repeated string acting_parties = 8;
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: must be non-empty
 
```
repeated string acting_parties = 8;
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;
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,
 the actors and all informees of all the ancestors of this event this
 participant knows about.
 If not consuming, the witnesses are the union of the signatories,
 the actors and all informees of all the ancestors of this event this
 participant knows about.
 In both cases the witnesses are limited to the querying parties, or not
 limited in case anyParty filters are used.
 Note that the actors might not necessarily be observers
 and thus stakeholders. 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: must be non-empty

repeated string witness_parties = 10;

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,
 the actors and all informees of all the ancestors of this event this
 participant knows about.
 If not consuming, the witnesses are the union of the signatories,
 the actors and all informees of all the ancestors of this event this
 participant knows about.
 In both cases the witnesses are limited to the querying parties, or not
 limited in case anyParty filters are used.
 Note that the actors might not necessarily be observers
 and thus stakeholders. 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: must be non-empty

repeated string witness_parties = 10;

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,
 the actors and all informees of all the ancestors of this event this
 participant knows about.
 If not consuming, the witnesses are the union of the signatories,
 the actors and all informees of all the ancestors of this event this
 participant knows about.
 In both cases the witnesses are limited to the querying parties, or not
 limited in case anyParty filters are used.
 Note that the actors might not necessarily be observers
 and thus stakeholders. 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: must be non-empty

repeated string witness_parties = 10;

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,
 the actors and all informees of all the ancestors of this event this
 participant knows about.
 If not consuming, the witnesses are the union of the signatories,
 the actors and all informees of all the ancestors of this event this
 participant knows about.
 In both cases the witnesses are limited to the querying parties, or not
 limited in case anyParty filters are used.
 Note that the actors might not necessarily be observers
 and thus stakeholders. 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: must be non-empty

repeated string witness_parties = 10;

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;

Returns:: The lastDescendantNodeId.

hasExerciseResult

boolean hasExerciseResult()
```
 The result of exercising the choice.

 Optional
 
```
.com.daml.ledger.api.v2.Value exercise_result = 12;
Returns:

Whether the exerciseResult field is set.
getExerciseResult

com.daml.ledger.api.v2.ValueOuterClass.Value getExerciseResult()
```
 The result of exercising the choice.

 Optional
 
```
.com.daml.ledger.api.v2.Value exercise_result = 12;
Returns:

The exerciseResult.
getExerciseResultOrBuilder

com.daml.ledger.api.v2.ValueOuterClass.ValueOrBuilder getExerciseResultOrBuilder()
```
 The result of exercising the choice.

 Optional
 
```
.com.daml.ledger.api.v2.Value exercise_result = 12;
getPackageName

String getPackageName()
```
 The package name of the contract.

 Required
 
```
string package_name = 13;
Returns:

The packageName.
getPackageNameBytes

com.google.protobuf.ByteString getPackageNameBytes()
```
 The package name of the contract.

 Required
 
```
string package_name = 13;
Returns:

The bytes for packageName.