Package com.daml.ledger.api.v2

Interface EventQueryServiceOuterClass.GetEventsByContractIdRequestOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
EventQueryServiceOuterClass.GetEventsByContractIdRequest, EventQueryServiceOuterClass.GetEventsByContractIdRequest.Builder
Enclosing class:
EventQueryServiceOuterClass
public static interface EventQueryServiceOuterClass.GetEventsByContractIdRequestOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getContractId()
    The contract id being queried.
    com.google.protobuf.ByteString
    getContractIdBytes()
    The contract id being queried.
    TransactionFilterOuterClass.EventFormat
    getEventFormat()
    Format of the events in the result, the presentation will be of TRANSACTION_SHAPE_ACS_DELTA.
    TransactionFilterOuterClass.EventFormatOrBuilder
    getEventFormatOrBuilder()
    Format of the events in the result, the presentation will be of TRANSACTION_SHAPE_ACS_DELTA.
    String
    getRequestingParties(int index)
    Provided for backwards compatibility, it will be removed in the Canton version 3.4.0.
    com.google.protobuf.ByteString
    getRequestingPartiesBytes(int index)
    Provided for backwards compatibility, it will be removed in the Canton version 3.4.0.
    int
    getRequestingPartiesCount()
    Provided for backwards compatibility, it will be removed in the Canton version 3.4.0.
    List<String>
    getRequestingPartiesList()
    Provided for backwards compatibility, it will be removed in the Canton version 3.4.0.
    boolean
    hasEventFormat()
    Format of the events in the result, the presentation will be of TRANSACTION_SHAPE_ACS_DELTA.

    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

    • getContractId

      String getContractId()
       The contract id being queried.
 Required
      string contract_id = 1 [json_name = "contractId"];
      Returns:
      The contractId.

    • getContractIdBytes

      com.google.protobuf.ByteString getContractIdBytes()
       The contract id being queried.
 Required
      string contract_id = 1 [json_name = "contractId"];
      Returns:
      The bytes for contractId.

    • getRequestingPartiesList

      List<String> getRequestingPartiesList()
       Provided for backwards compatibility, it will be removed in the Canton version 3.4.0.
 The parties whose events the client expects to see.
 The events associated with the contract id will only be returned if the requesting parties includes
 at least one party that is a stakeholder of the event. For a definition of stakeholders see
 https://docs.daml.com/concepts/ledger-model/ledger-privacy.html#contract-observers-and-stakeholders
 Optional, if some parties specified, event_format needs to be unset.
      repeated string requesting_parties = 2 [json_name = "requestingParties"];
      Returns:
      A list containing the requestingParties.

    • getRequestingPartiesCount

      int getRequestingPartiesCount()
       Provided for backwards compatibility, it will be removed in the Canton version 3.4.0.
 The parties whose events the client expects to see.
 The events associated with the contract id will only be returned if the requesting parties includes
 at least one party that is a stakeholder of the event. For a definition of stakeholders see
 https://docs.daml.com/concepts/ledger-model/ledger-privacy.html#contract-observers-and-stakeholders
 Optional, if some parties specified, event_format needs to be unset.
      repeated string requesting_parties = 2 [json_name = "requestingParties"];
      Returns:
      The count of requestingParties.

    • getRequestingParties

      String getRequestingParties(int index)
       Provided for backwards compatibility, it will be removed in the Canton version 3.4.0.
 The parties whose events the client expects to see.
 The events associated with the contract id will only be returned if the requesting parties includes
 at least one party that is a stakeholder of the event. For a definition of stakeholders see
 https://docs.daml.com/concepts/ledger-model/ledger-privacy.html#contract-observers-and-stakeholders
 Optional, if some parties specified, event_format needs to be unset.
      repeated string requesting_parties = 2 [json_name = "requestingParties"];
      Parameters:
      index - The index of the element to return.
      Returns:
      The requestingParties at the given index.

    • getRequestingPartiesBytes

      com.google.protobuf.ByteString getRequestingPartiesBytes(int index)
       Provided for backwards compatibility, it will be removed in the Canton version 3.4.0.
 The parties whose events the client expects to see.
 The events associated with the contract id will only be returned if the requesting parties includes
 at least one party that is a stakeholder of the event. For a definition of stakeholders see
 https://docs.daml.com/concepts/ledger-model/ledger-privacy.html#contract-observers-and-stakeholders
 Optional, if some parties specified, event_format needs to be unset.
      repeated string requesting_parties = 2 [json_name = "requestingParties"];
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the requestingParties at the given index.

    • hasEventFormat

      boolean hasEventFormat()
       Format of the events in the result, the presentation will be of TRANSACTION_SHAPE_ACS_DELTA.
 Optional for backwards compatibility, defaults to an EventFormat where:

 - filters_by_party is a template-wildcard filter for all requesting_parties
 - filters_for_any_party is unset
 - verbose is set
      .com.daml.ledger.api.v2.EventFormat event_format = 3 [json_name = "eventFormat"];
      Returns:
      Whether the eventFormat field is set.

    • getEventFormat

      TransactionFilterOuterClass.EventFormat getEventFormat()
       Format of the events in the result, the presentation will be of TRANSACTION_SHAPE_ACS_DELTA.
 Optional for backwards compatibility, defaults to an EventFormat where:

 - filters_by_party is a template-wildcard filter for all requesting_parties
 - filters_for_any_party is unset
 - verbose is set
      .com.daml.ledger.api.v2.EventFormat event_format = 3 [json_name = "eventFormat"];
      Returns:
      The eventFormat.

    • getEventFormatOrBuilder

      TransactionFilterOuterClass.EventFormatOrBuilder getEventFormatOrBuilder()
       Format of the events in the result, the presentation will be of TRANSACTION_SHAPE_ACS_DELTA.
 Optional for backwards compatibility, defaults to an EventFormat where:

 - filters_by_party is a template-wildcard filter for all requesting_parties
 - filters_for_any_party is unset
 - verbose is set
      .com.daml.ledger.api.v2.EventFormat event_format = 3 [json_name = "eventFormat"];