Package com.daml.ledger.api.v2

Interface EventOuterClass.CreatedEventOrBuilder

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

  • Method Details

    • getOffset

      long getOffset()
       The offset of origin, which has contextual meaning, please see description at messages that include a CreatedEvent.
 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.
 The origin has contextual meaning, please see description at messages that include a CreatedEvent.
 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 created 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 created 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 created 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 created 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 created contract.
 The identifier uses the package-id reference format.

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

    • hasContractKey

      boolean hasContractKey()
       The key of the created contract.
 This will be set if and only if ``create_arguments`` is set and ``template_id`` defines a contract key.
 Optional
      .com.daml.ledger.api.v2.Value contract_key = 5 [json_name = "contractKey"];
      Returns:
      Whether the contractKey field is set.

    • getContractKey

      ValueOuterClass.Value getContractKey()
       The key of the created contract.
 This will be set if and only if ``create_arguments`` is set and ``template_id`` defines a contract key.
 Optional
      .com.daml.ledger.api.v2.Value contract_key = 5 [json_name = "contractKey"];
      Returns:
      The contractKey.

    • getContractKeyOrBuilder

      ValueOuterClass.ValueOrBuilder getContractKeyOrBuilder()
       The key of the created contract.
 This will be set if and only if ``create_arguments`` is set and ``template_id`` defines a contract key.
 Optional
      .com.daml.ledger.api.v2.Value contract_key = 5 [json_name = "contractKey"];

    • hasCreateArguments

      boolean hasCreateArguments()
       The arguments that have been used to create the contract.
 Set either:

 - if there was a party, which is in the ``witness_parties`` of this event,
   and for which a ``CumulativeFilter`` exists with the ``template_id`` of this event
   among the ``template_filters``,
 - or if there was a party, which is in the ``witness_parties`` of this event,
   and for which a wildcard filter exists (``Filters`` with a ``CumulativeFilter`` of ``WildcardFilter``).

 Optional
      .com.daml.ledger.api.v2.Record create_arguments = 6 [json_name = "createArguments"];
      Returns:
      Whether the createArguments field is set.

    • getCreateArguments

      ValueOuterClass.Record getCreateArguments()
       The arguments that have been used to create the contract.
 Set either:

 - if there was a party, which is in the ``witness_parties`` of this event,
   and for which a ``CumulativeFilter`` exists with the ``template_id`` of this event
   among the ``template_filters``,
 - or if there was a party, which is in the ``witness_parties`` of this event,
   and for which a wildcard filter exists (``Filters`` with a ``CumulativeFilter`` of ``WildcardFilter``).

 Optional
      .com.daml.ledger.api.v2.Record create_arguments = 6 [json_name = "createArguments"];
      Returns:
      The createArguments.

    • getCreateArgumentsOrBuilder

      ValueOuterClass.RecordOrBuilder getCreateArgumentsOrBuilder()
       The arguments that have been used to create the contract.
 Set either:

 - if there was a party, which is in the ``witness_parties`` of this event,
   and for which a ``CumulativeFilter`` exists with the ``template_id`` of this event
   among the ``template_filters``,
 - or if there was a party, which is in the ``witness_parties`` of this event,
   and for which a wildcard filter exists (``Filters`` with a ``CumulativeFilter`` of ``WildcardFilter``).

 Optional
      .com.daml.ledger.api.v2.Record create_arguments = 6 [json_name = "createArguments"];

    • getCreatedEventBlob

      com.google.protobuf.ByteString getCreatedEventBlob()
       Opaque representation of contract create event payload intended for forwarding
 to an API server as a contract disclosed as part of a command
 submission.
 Optional
      bytes created_event_blob = 7 [json_name = "createdEventBlob"];
      Returns:
      The createdEventBlob.

    • getInterfaceViewsList

      List<EventOuterClass.InterfaceView> getInterfaceViewsList()
       Interface views specified in the transaction filter.
 Includes an ``InterfaceView`` for each interface for which there is a ``InterfaceFilter`` with

 - its party in the ``witness_parties`` of this event,
 - and which is implemented by the template of this event,
 - and which has ``include_interface_view`` set.

 Optional
      repeated .com.daml.ledger.api.v2.InterfaceView interface_views = 8 [json_name = "interfaceViews"];

    • getInterfaceViews

      EventOuterClass.InterfaceView getInterfaceViews(int index)
       Interface views specified in the transaction filter.
 Includes an ``InterfaceView`` for each interface for which there is a ``InterfaceFilter`` with

 - its party in the ``witness_parties`` of this event,
 - and which is implemented by the template of this event,
 - and which has ``include_interface_view`` set.

 Optional
      repeated .com.daml.ledger.api.v2.InterfaceView interface_views = 8 [json_name = "interfaceViews"];

    • getInterfaceViewsCount

      int getInterfaceViewsCount()
       Interface views specified in the transaction filter.
 Includes an ``InterfaceView`` for each interface for which there is a ``InterfaceFilter`` with

 - its party in the ``witness_parties`` of this event,
 - and which is implemented by the template of this event,
 - and which has ``include_interface_view`` set.

 Optional
      repeated .com.daml.ledger.api.v2.InterfaceView interface_views = 8 [json_name = "interfaceViews"];

    • getInterfaceViewsOrBuilderList

      List<? extends EventOuterClass.InterfaceViewOrBuilder> getInterfaceViewsOrBuilderList()
       Interface views specified in the transaction filter.
 Includes an ``InterfaceView`` for each interface for which there is a ``InterfaceFilter`` with

 - its party in the ``witness_parties`` of this event,
 - and which is implemented by the template of this event,
 - and which has ``include_interface_view`` set.

 Optional
      repeated .com.daml.ledger.api.v2.InterfaceView interface_views = 8 [json_name = "interfaceViews"];

    • getInterfaceViewsOrBuilder

      EventOuterClass.InterfaceViewOrBuilder getInterfaceViewsOrBuilder(int index)
       Interface views specified in the transaction filter.
 Includes an ``InterfaceView`` for each interface for which there is a ``InterfaceFilter`` with

 - its party in the ``witness_parties`` of this event,
 - and which is implemented by the template of this event,
 - and which has ``include_interface_view`` set.

 Optional
      repeated .com.daml.ledger.api.v2.InterfaceView interface_views = 8 [json_name = "interfaceViews"];

    • getWitnessPartiesList

      List<String> getWitnessPartiesList()
       The parties that are notified of this event. When a ``CreatedEvent``
 is returned as part of a transaction tree or ledger-effects transaction, this will include all
 the parties specified in the ``TransactionFilter`` that are informees
 of the event. If served as part of a ACS delta transaction those will
 be limited to all parties specified in the ``TransactionFilter`` that
 are stakeholders of the contract (i.e. either signatories or observers).
 If the ``CreatedEvent`` is returned as part of an AssignedEvent,
 ActiveContract or IncompleteUnassigned (so the event is related to
 an assignment or unassignment): this will include all parties of the
 ``TransactionFilter`` that are stakeholders of the contract.

 The behavior of reading create events visible to parties not hosted
 on the participant node serving the Ledger API is undefined. Concretely,
 there is neither a guarantee that the participant node will serve all their
 create events on the ACS stream, nor is there a guarantee that matching archive
 events are delivered for such create events.

 For most clients this is not a problem, as they only read events for parties
 that are hosted on the participant node. If you need to read events
 for parties that may not be hosted at all times on the participant node,
 subscribe to the ``TopologyEvent``s for that party by setting a corresponding
 ``UpdateFormat``.  Using these events, query the ACS as-of an offset where the
 party is hosted on the participant node, and ignore create events at offsets
 where the party is not hosted on the participant node.
 Required
      repeated string witness_parties = 9 [json_name = "witnessParties"];
      Returns:
      A list containing the witnessParties.

    • getWitnessPartiesCount

      int getWitnessPartiesCount()
       The parties that are notified of this event. When a ``CreatedEvent``
 is returned as part of a transaction tree or ledger-effects transaction, this will include all
 the parties specified in the ``TransactionFilter`` that are informees
 of the event. If served as part of a ACS delta transaction those will
 be limited to all parties specified in the ``TransactionFilter`` that
 are stakeholders of the contract (i.e. either signatories or observers).
 If the ``CreatedEvent`` is returned as part of an AssignedEvent,
 ActiveContract or IncompleteUnassigned (so the event is related to
 an assignment or unassignment): this will include all parties of the
 ``TransactionFilter`` that are stakeholders of the contract.

 The behavior of reading create events visible to parties not hosted
 on the participant node serving the Ledger API is undefined. Concretely,
 there is neither a guarantee that the participant node will serve all their
 create events on the ACS stream, nor is there a guarantee that matching archive
 events are delivered for such create events.

 For most clients this is not a problem, as they only read events for parties
 that are hosted on the participant node. If you need to read events
 for parties that may not be hosted at all times on the participant node,
 subscribe to the ``TopologyEvent``s for that party by setting a corresponding
 ``UpdateFormat``.  Using these events, query the ACS as-of an offset where the
 party is hosted on the participant node, and ignore create events at offsets
 where the party is not hosted on the participant node.
 Required
      repeated string witness_parties = 9 [json_name = "witnessParties"];
      Returns:
      The count of witnessParties.

    • getWitnessParties

      String getWitnessParties(int index)
       The parties that are notified of this event. When a ``CreatedEvent``
 is returned as part of a transaction tree or ledger-effects transaction, this will include all
 the parties specified in the ``TransactionFilter`` that are informees
 of the event. If served as part of a ACS delta transaction those will
 be limited to all parties specified in the ``TransactionFilter`` that
 are stakeholders of the contract (i.e. either signatories or observers).
 If the ``CreatedEvent`` is returned as part of an AssignedEvent,
 ActiveContract or IncompleteUnassigned (so the event is related to
 an assignment or unassignment): this will include all parties of the
 ``TransactionFilter`` that are stakeholders of the contract.

 The behavior of reading create events visible to parties not hosted
 on the participant node serving the Ledger API is undefined. Concretely,
 there is neither a guarantee that the participant node will serve all their
 create events on the ACS stream, nor is there a guarantee that matching archive
 events are delivered for such create events.

 For most clients this is not a problem, as they only read events for parties
 that are hosted on the participant node. If you need to read events
 for parties that may not be hosted at all times on the participant node,
 subscribe to the ``TopologyEvent``s for that party by setting a corresponding
 ``UpdateFormat``.  Using these events, query the ACS as-of an offset where the
 party is hosted on the participant node, and ignore create events at offsets
 where the party is not hosted on the participant node.
 Required
      repeated string witness_parties = 9 [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. When a ``CreatedEvent``
 is returned as part of a transaction tree or ledger-effects transaction, this will include all
 the parties specified in the ``TransactionFilter`` that are informees
 of the event. If served as part of a ACS delta transaction those will
 be limited to all parties specified in the ``TransactionFilter`` that
 are stakeholders of the contract (i.e. either signatories or observers).
 If the ``CreatedEvent`` is returned as part of an AssignedEvent,
 ActiveContract or IncompleteUnassigned (so the event is related to
 an assignment or unassignment): this will include all parties of the
 ``TransactionFilter`` that are stakeholders of the contract.

 The behavior of reading create events visible to parties not hosted
 on the participant node serving the Ledger API is undefined. Concretely,
 there is neither a guarantee that the participant node will serve all their
 create events on the ACS stream, nor is there a guarantee that matching archive
 events are delivered for such create events.

 For most clients this is not a problem, as they only read events for parties
 that are hosted on the participant node. If you need to read events
 for parties that may not be hosted at all times on the participant node,
 subscribe to the ``TopologyEvent``s for that party by setting a corresponding
 ``UpdateFormat``.  Using these events, query the ACS as-of an offset where the
 party is hosted on the participant node, and ignore create events at offsets
 where the party is not hosted on the participant node.
 Required
      repeated string witness_parties = 9 [json_name = "witnessParties"];
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the witnessParties at the given index.

    • getSignatoriesList

      List<String> getSignatoriesList()
       The signatories for this contract as specified by the template.
 Required
      repeated string signatories = 10 [json_name = "signatories"];
      Returns:
      A list containing the signatories.

    • getSignatoriesCount

      int getSignatoriesCount()
       The signatories for this contract as specified by the template.
 Required
      repeated string signatories = 10 [json_name = "signatories"];
      Returns:
      The count of signatories.

    • getSignatories

      String getSignatories(int index)
       The signatories for this contract as specified by the template.
 Required
      repeated string signatories = 10 [json_name = "signatories"];
      Parameters:
      index - The index of the element to return.
      Returns:
      The signatories at the given index.

    • getSignatoriesBytes

      com.google.protobuf.ByteString getSignatoriesBytes(int index)
       The signatories for this contract as specified by the template.
 Required
      repeated string signatories = 10 [json_name = "signatories"];
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the signatories at the given index.

    • getObserversList

      List<String> getObserversList()
       The observers for this contract as specified explicitly by the template or implicitly as choice controllers.
 This field never contains parties that are signatories.
 Required
      repeated string observers = 11 [json_name = "observers"];
      Returns:
      A list containing the observers.

    • getObserversCount

      int getObserversCount()
       The observers for this contract as specified explicitly by the template or implicitly as choice controllers.
 This field never contains parties that are signatories.
 Required
      repeated string observers = 11 [json_name = "observers"];
      Returns:
      The count of observers.

    • getObservers

      String getObservers(int index)
       The observers for this contract as specified explicitly by the template or implicitly as choice controllers.
 This field never contains parties that are signatories.
 Required
      repeated string observers = 11 [json_name = "observers"];
      Parameters:
      index - The index of the element to return.
      Returns:
      The observers at the given index.

    • getObserversBytes

      com.google.protobuf.ByteString getObserversBytes(int index)
       The observers for this contract as specified explicitly by the template or implicitly as choice controllers.
 This field never contains parties that are signatories.
 Required
      repeated string observers = 11 [json_name = "observers"];
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the observers at the given index.

    • hasCreatedAt

      boolean hasCreatedAt()
       Ledger effective time of the transaction that created the contract.
 Required
      .google.protobuf.Timestamp created_at = 12 [json_name = "createdAt"];
      Returns:
      Whether the createdAt field is set.

    • getCreatedAt

      com.google.protobuf.Timestamp getCreatedAt()
       Ledger effective time of the transaction that created the contract.
 Required
      .google.protobuf.Timestamp created_at = 12 [json_name = "createdAt"];
      Returns:
      The createdAt.

    • getCreatedAtOrBuilder

      com.google.protobuf.TimestampOrBuilder getCreatedAtOrBuilder()
       Ledger effective time of the transaction that created the contract.
 Required
      .google.protobuf.Timestamp created_at = 12 [json_name = "createdAt"];

    • getPackageName

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

    • getPackageNameBytes

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