Package com.daml.ledger.api.v1

Interface EventOuterClass.CreatedEventOrBuilder

    • 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 created 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 created 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 created 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 created 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 created contract.
 Required
        .com.daml.ledger.api.v1.Identifier template_id = 3 [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.v1.Value contract_key = 7 [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.v1.Value contract_key = 7 [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.v1.Value contract_key = 7 [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 an ``InclusiveFilters`` exists with the ``template_id`` of this event
     among the ``template_ids``,
   - or if there was a party, which is in the ``witness_parties`` of this event,
     and for which a wildcard filter exists (``Filters`` without ``InclusiveFilters``,
     or with an ``InclusiveFilters`` with empty ``template_ids`` and empty ``interface_filters``).
 Optional
        .com.daml.ledger.api.v1.Record create_arguments = 4 [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 an ``InclusiveFilters`` exists with the ``template_id`` of this event
     among the ``template_ids``,
   - or if there was a party, which is in the ``witness_parties`` of this event,
     and for which a wildcard filter exists (``Filters`` without ``InclusiveFilters``,
     or with an ``InclusiveFilters`` with empty ``template_ids`` and empty ``interface_filters``).
 Optional
        .com.daml.ledger.api.v1.Record create_arguments = 4 [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 an ``InclusiveFilters`` exists with the ``template_id`` of this event
     among the ``template_ids``,
   - or if there was a party, which is in the ``witness_parties`` of this event,
     and for which a wildcard filter exists (``Filters`` without ``InclusiveFilters``,
     or with an ``InclusiveFilters`` with empty ``template_ids`` and empty ``interface_filters``).
 Optional
        .com.daml.ledger.api.v1.Record create_arguments = 4 [json_name = "createArguments"];

      • hasCreateArgumentsBlob

        boolean hasCreateArgumentsBlob()
         Opaque representation of contract payload intended for forwarding
 to an API server as a contract disclosed as part of a command
 submission.
 Optional
        .google.protobuf.Any create_arguments_blob = 12 [json_name = "createArgumentsBlob"];
        Returns:
        Whether the createArgumentsBlob field is set.

      • getCreateArgumentsBlob

        com.google.protobuf.Any getCreateArgumentsBlob()
         Opaque representation of contract payload intended for forwarding
 to an API server as a contract disclosed as part of a command
 submission.
 Optional
        .google.protobuf.Any create_arguments_blob = 12 [json_name = "createArgumentsBlob"];
        Returns:
        The createArgumentsBlob.

      • getCreateArgumentsBlobOrBuilder

        com.google.protobuf.AnyOrBuilder getCreateArgumentsBlobOrBuilder()
         Opaque representation of contract payload intended for forwarding
 to an API server as a contract disclosed as part of a command
 submission.
 Optional
        .google.protobuf.Any create_arguments_blob = 12 [json_name = "createArgumentsBlob"];

      • getInterfaceViewsList

        java.util.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.v1.InterfaceView interface_views = 11 [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.v1.InterfaceView interface_views = 11 [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.v1.InterfaceView interface_views = 11 [json_name = "interfaceViews"];

      • getInterfaceViewsOrBuilderList

        java.util.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.v1.InterfaceView interface_views = 11 [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.v1.InterfaceView interface_views = 11 [json_name = "interfaceViews"];

      • getWitnessPartiesList

        java.util.List<java.lang.String> getWitnessPartiesList()
         The parties that are notified of this event. When a ``CreatedEvent``
 is returned as part of a transaction tree, this will include all
 the parties specified in the ``TransactionFilter`` that are informees
 of the event. If served as part of a flat transaction those will
 be limited to all parties specified in the ``TransactionFilter`` that
 are stakeholders of the contract (i.e. either signatories or observers).
 In case of v2 API:
   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.
 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. When a ``CreatedEvent``
 is returned as part of a transaction tree, this will include all
 the parties specified in the ``TransactionFilter`` that are informees
 of the event. If served as part of a flat transaction those will
 be limited to all parties specified in the ``TransactionFilter`` that
 are stakeholders of the contract (i.e. either signatories or observers).
 In case of v2 API:
   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.
 Required
        repeated string witness_parties = 5 [json_name = "witnessParties"];
        Returns:
        The count of witnessParties.

      • getWitnessParties

        java.lang.String getWitnessParties​(int index)
         The parties that are notified of this event. When a ``CreatedEvent``
 is returned as part of a transaction tree, this will include all
 the parties specified in the ``TransactionFilter`` that are informees
 of the event. If served as part of a flat transaction those will
 be limited to all parties specified in the ``TransactionFilter`` that
 are stakeholders of the contract (i.e. either signatories or observers).
 In case of v2 API:
   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.
 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. When a ``CreatedEvent``
 is returned as part of a transaction tree, this will include all
 the parties specified in the ``TransactionFilter`` that are informees
 of the event. If served as part of a flat transaction those will
 be limited to all parties specified in the ``TransactionFilter`` that
 are stakeholders of the contract (i.e. either signatories or observers).
 In case of v2 API:
   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.
 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.

      • getSignatoriesList

        java.util.List<java.lang.String> getSignatoriesList()
         The signatories for this contract as specified by the template.
 Required
        repeated string signatories = 8 [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 = 8 [json_name = "signatories"];
        Returns:
        The count of signatories.

      • getSignatories

        java.lang.String getSignatories​(int index)
         The signatories for this contract as specified by the template.
 Required
        repeated string signatories = 8 [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 = 8 [json_name = "signatories"];
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the signatories at the given index.

      • getObserversList

        java.util.List<java.lang.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 = 9 [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 = 9 [json_name = "observers"];
        Returns:
        The count of observers.

      • getObservers

        java.lang.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 = 9 [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 = 9 [json_name = "observers"];
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the observers at the given index.

      • hasAgreementText

        boolean hasAgreementText()
         The agreement text of the contract.
 We use StringValue to properly reflect optionality on the wire for backwards compatibility.
 This is necessary since the empty string is an acceptable (and in fact the default) agreement
 text, but also the default string in protobuf.
 This means a newer client works with an older sandbox seamlessly.
 Optional
        .google.protobuf.StringValue agreement_text = 6 [json_name = "agreementText"];
        Returns:
        Whether the agreementText field is set.

      • getAgreementText

        com.google.protobuf.StringValue getAgreementText()
         The agreement text of the contract.
 We use StringValue to properly reflect optionality on the wire for backwards compatibility.
 This is necessary since the empty string is an acceptable (and in fact the default) agreement
 text, but also the default string in protobuf.
 This means a newer client works with an older sandbox seamlessly.
 Optional
        .google.protobuf.StringValue agreement_text = 6 [json_name = "agreementText"];
        Returns:
        The agreementText.

      • getAgreementTextOrBuilder

        com.google.protobuf.StringValueOrBuilder getAgreementTextOrBuilder()
         The agreement text of the contract.
 We use StringValue to properly reflect optionality on the wire for backwards compatibility.
 This is necessary since the empty string is an acceptable (and in fact the default) agreement
 text, but also the default string in protobuf.
 This means a newer client works with an older sandbox seamlessly.
 Optional
        .google.protobuf.StringValue agreement_text = 6 [json_name = "agreementText"];

      • hasMetadata

        boolean hasMetadata()
         Metadata of the contract. Required for contracts created
 after the introduction of explicit disclosure.
 Optional
        .com.daml.ledger.api.v1.ContractMetadata metadata = 10 [json_name = "metadata"];
        Returns:
        Whether the metadata field is set.

      • getMetadata

        ContractMetadataOuterClass.ContractMetadata getMetadata()
         Metadata of the contract. Required for contracts created
 after the introduction of explicit disclosure.
 Optional
        .com.daml.ledger.api.v1.ContractMetadata metadata = 10 [json_name = "metadata"];
        Returns:
        The metadata.

      • getMetadataOrBuilder

        ContractMetadataOuterClass.ContractMetadataOrBuilder getMetadataOrBuilder()
         Metadata of the contract. Required for contracts created
 after the introduction of explicit disclosure.
 Optional
        .com.daml.ledger.api.v1.ContractMetadata metadata = 10 [json_name = "metadata"];