Packages

trait IndexService extends IndexCompletionsService with IndexUpdateService with IndexEventQueryService with IndexActiveContractsService with ContractStore with MaximumLedgerTimeService with IndexPartyManagementService with IndexParticipantPruningService with ReportsHealth

Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. IndexService
  2. ReportsHealth
  3. IndexParticipantPruningService
  4. IndexPartyManagementService
  5. MaximumLedgerTimeService
  6. ContractStore
  7. IndexActiveContractsService
  8. IndexEventQueryService
  9. IndexUpdateService
  10. IndexCompletionsService
  11. LedgerEndService
  12. AnyRef
  13. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Abstract Value Members

  1. abstract def currentHealth(): HealthStatus

    Reports the current health of the object.

    Reports the current health of the object. This should always return immediately.

    Definition Classes
    ReportsHealth
  2. abstract def currentLedgerEnd(): Future[Option[Offset]]
    Definition Classes
    LedgerEndService
  3. abstract def getActiveContracts(filter: EventFormat, activeAt: Option[Offset])(implicit loggingContext: LoggingContextWithTrace): Source[GetActiveContractsResponse, NotUsed]
    Definition Classes
    IndexActiveContractsService
  4. abstract def getCompletions(begin: Option[Offset], userId: daml.lf.data.Ref.UserId, parties: Set[Party])(implicit loggingContext: LoggingContextWithTrace): Source[CompletionStreamResponse, NotUsed]
    Definition Classes
    IndexCompletionsService
  5. abstract def getEventsByContractId(contractId: ContractId, eventFormat: EventFormat)(implicit loggingContext: LoggingContextWithTrace): Future[GetEventsByContractIdResponse]
    Definition Classes
    IndexEventQueryService
  6. abstract def getParticipantId(): Future[ParticipantId]
    Definition Classes
    IndexPartyManagementService
  7. abstract def getParties(parties: Seq[Party])(implicit loggingContext: LoggingContextWithTrace): Future[List[IndexerPartyDetails]]
    Definition Classes
    IndexPartyManagementService
  8. abstract def getTransactionById(updateId: UpdateId, transactionFormat: TransactionFormat)(implicit loggingContext: LoggingContextWithTrace): Future[Option[GetTransactionResponse]]
    Definition Classes
    IndexUpdateService
  9. abstract def getTransactionByOffset(offset: Offset, transactionFormat: TransactionFormat)(implicit loggingContext: LoggingContextWithTrace): Future[Option[GetTransactionResponse]]
    Definition Classes
    IndexUpdateService
  10. abstract def getTransactionTreeById(updateId: UpdateId, requestingParties: Set[Party])(implicit loggingContext: LoggingContextWithTrace): Future[Option[GetTransactionTreeResponse]]
    Definition Classes
    IndexUpdateService
  11. abstract def getTransactionTreeByOffset(offset: Offset, requestingParties: Set[Party])(implicit loggingContext: LoggingContextWithTrace): Future[Option[GetTransactionTreeResponse]]
    Definition Classes
    IndexUpdateService
  12. abstract def getUpdateBy(lookupKey: LookupKey, updateFormat: UpdateFormat)(implicit loggingContext: LoggingContextWithTrace): Future[Option[GetUpdateResponse]]
    Definition Classes
    IndexUpdateService
  13. abstract def latestPrunedOffsets()(implicit loggingContext: LoggingContextWithTrace): Future[(Option[Offset], Option[Offset])]
    Definition Classes
    IndexUpdateService
  14. abstract def listKnownParties(fromExcl: Option[Party], maxResults: Int)(implicit loggingContext: LoggingContextWithTrace): Future[List[IndexerPartyDetails]]
    Definition Classes
    IndexPartyManagementService
  15. abstract def lookupActiveContract(readers: Set[Party], contractId: ContractId)(implicit loggingContext: LoggingContextWithTrace): Future[Option[VersionedContractInstance]]

    Looking up an active contract.

    Looking up an active contract.

    Definition Classes
    ContractStore
  16. abstract def lookupContractKey(readers: Set[Party], key: GlobalKey)(implicit loggingContext: LoggingContextWithTrace): Future[Option[ContractId]]
    Definition Classes
    ContractStore
  17. abstract def lookupContractState(contractId: ContractId)(implicit loggingContext: LoggingContextWithTrace): Future[ContractState]

    Querying the state of the contracts.

    Querying the state of the contracts.

    Definition Classes
    ContractStore
  18. abstract def lookupMaximumLedgerTimeAfterInterpretation(ids: Set[ContractId])(implicit loggingContext: LoggingContextWithTrace): Future[MaximumLedgerTime]

    This method serves two purposes:

    This method serves two purposes:

    1. Verify that none of the specified contracts are archived
    2. Calculate the maximum ledger time of all the specified contracts

    Important note: existence of the contracts is not checked, only the fact of archival, therefore this method is intended to be used after interpretation, which guarantees that all the used ids were visible once.

    returns

    NotAvailable, if the specified set is empty. Max, if none of the specified contracts are archived, and the maximum ledger-time of all specified contracts is known Archived, if there was at least one contract specified which is archived (this list is not necessarily exhaustive)

    Definition Classes
    MaximumLedgerTimeService
  19. abstract def prune(pruneUpToInclusive: Offset, pruneAllDivulgedContracts: Boolean, incompletReassignmentOffsets: Vector[Offset])(implicit loggingContext: LoggingContextWithTrace): Future[Unit]
  20. abstract def transactionTrees(begin: Option[Offset], endAt: Option[Offset], eventFormat: EventFormat)(implicit loggingContext: LoggingContextWithTrace): Source[GetUpdateTreesResponse, NotUsed]
    Definition Classes
    IndexUpdateService
  21. abstract def updates(begin: Option[Offset], endAt: Option[Offset], updateFormat: UpdateFormat)(implicit loggingContext: LoggingContextWithTrace): Source[GetUpdatesResponse, NotUsed]
    Definition Classes
    IndexUpdateService

Concrete Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @IntrinsicCandidate() @native()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  8. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @IntrinsicCandidate() @native()
  9. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @IntrinsicCandidate() @native()
  10. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  11. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  12. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  13. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  14. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  15. def toString(): String
    Definition Classes
    AnyRef → Any
  16. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  17. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  18. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated

    (Since version 9)

Inherited from ReportsHealth

Inherited from ContractStore

Inherited from IndexEventQueryService

Inherited from IndexUpdateService

Inherited from LedgerEndService

Inherited from AnyRef

Inherited from Any

Ungrouped