Package com.daml.ledger.api.v2

Interface EventOuterClass.ArchivedEventOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
EventOuterClass.ArchivedEvent, EventOuterClass.ArchivedEvent.Builder
Enclosing class:
EventOuterClass
public static interface EventOuterClass.ArchivedEventOrBuilder 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 archived 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 archived 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 archived 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 archived 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 archived contract.
 The identifier uses the package-id reference format.

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

    • getWitnessPartiesList

      List<String> getWitnessPartiesList()
       The parties that are notified of this event. For an ``ArchivedEvent``,
 these are the intersection of the stakeholders of the contract in
 question and the parties specified in the ``TransactionFilter``. The
 stakeholders are the union of the signatories and the observers of
 the contract.
 Each one of its elements must be a valid PartyIdString (as described
 in ``value.proto``).
 Required
      repeated string witness_parties = 5 [json_name = "witnessParties"];
      Returns:
      A list containing the witnessParties.

    • getWitnessPartiesCount

      int getWitnessPartiesCount()
       The parties that are notified of this event. For an ``ArchivedEvent``,
 these are the intersection of the stakeholders of the contract in
 question and the parties specified in the ``TransactionFilter``. The
 stakeholders are the union of the signatories and the observers of
 the contract.
 Each one of its elements must be a valid PartyIdString (as described
 in ``value.proto``).
 Required
      repeated string witness_parties = 5 [json_name = "witnessParties"];
      Returns:
      The count of witnessParties.

    • getWitnessParties

      String getWitnessParties(int index)
       The parties that are notified of this event. For an ``ArchivedEvent``,
 these are the intersection of the stakeholders of the contract in
 question and the parties specified in the ``TransactionFilter``. The
 stakeholders are the union of the signatories and the observers of
 the contract.
 Each one of its elements must be a valid PartyIdString (as described
 in ``value.proto``).
 Required
      repeated string witness_parties = 5 [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. For an ``ArchivedEvent``,
 these are the intersection of the stakeholders of the contract in
 question and the parties specified in the ``TransactionFilter``. The
 stakeholders are the union of the signatories and the observers of
 the contract.
 Each one of its elements must be a valid PartyIdString (as described
 in ``value.proto``).
 Required
      repeated string witness_parties = 5 [json_name = "witnessParties"];
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the witnessParties at the given index.

    • getPackageName

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

    • getPackageNameBytes

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

    • getImplementedInterfacesList

      List<ValueOuterClass.Identifier> getImplementedInterfacesList()
       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.

 If defined, the identifier uses the package-id reference format.

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

    • getImplementedInterfaces

      ValueOuterClass.Identifier getImplementedInterfaces(int index)
       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.

 If defined, the identifier uses the package-id reference format.

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

    • getImplementedInterfacesCount

      int getImplementedInterfacesCount()
       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.

 If defined, the identifier uses the package-id reference format.

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

    • getImplementedInterfacesOrBuilderList

      List<? extends ValueOuterClass.IdentifierOrBuilder> getImplementedInterfacesOrBuilderList()
       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.

 If defined, the identifier uses the package-id reference format.

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

    • getImplementedInterfacesOrBuilder

      ValueOuterClass.IdentifierOrBuilder getImplementedInterfacesOrBuilder(int index)
       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.

 If defined, the identifier uses the package-id reference format.

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