com.digitalasset.canton.admin.participant.v30.PartyManagementServiceGrpc
PartyManagementService
Companion object PartyManagementService
trait PartyManagementService extends AbstractService
* The PartyManagementService allows modifying party hosting on participants.
Note that ACS refers to Active Contract Set.
Important: The online and offline party replication endpoints serve distinct workflows, and must not be combined.
- Alphabetic
- By Inheritance
- PartyManagementService
- AbstractService
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Abstract Value Members
- abstract def addPartyAsync(request: AddPartyAsyncRequest): Future[AddPartyAsyncResponse]
Online party replication endpoint.
Online party replication endpoint.
Initiate adding a party already hosted on one or more source participants to this target participant in the specified synchronizer. Performs some checks synchronously and then starts the party addition asynchronously.
Depends on the party authorizing the PartyToParticipant topology proposal at the specified topology_serial prior or concurrently to this endpoint. On the other hand, this target participant authorizes the topology proposal as part of this endpoint in a specific, intermediate step, and therefore the target participant signature must not already be in place prior to the call.
- abstract def clearPartyOnboardingFlag(request: ClearPartyOnboardingFlagRequest): Future[ClearPartyOnboardingFlagResponse]
Offline party replication endpoint.
Offline party replication endpoint.
Instructs the target participant to unilaterally clear the 'onboarding' flag on the party-to-participant topology mapping.
This operation is time-sensitive and will only be attempted after a specific safe timestamp has passed.
Because the effect of the topology transaction is not instantaneous, this endpoint is designed to be polled. Callers should invoke it repeatedly until the response confirms the flag has been cleared.
Prerequisite: A prior party-to-participant mapping topology transaction must exist that activates the party on the target participant with the onboarding flag set to
true. - abstract def exportPartyAcs(request: ExportPartyAcsRequest, responseObserver: StreamObserver[ExportPartyAcsResponse]): Unit
Offline party replication focused ACS export.
Offline party replication focused ACS export.
Exports the ACS of a single party from a source participant, so that the party can be replicated onto a target participant.
This endpoint works in conjunction with the ImportPartyAcs endpoint.
- abstract def getAddPartyStatus(request: GetAddPartyStatusRequest): Future[GetAddPartyStatusResponse]
Online party replication endpoint.
Online party replication endpoint.
Status endpoint that given an add_party_request_id returns status information about progress, completion, or errors of a previous call to AddPartyAsync on the source or target participant.
Note that the status reflects the state as perceived by this participant and does not imply the state of other participants. The status on the target participant is more authoritative as the target participant drives the process of adding the party. For example when the target participant status indicates "completed", the party has been added successfully.
- abstract def getHighestOffsetByTimestamp(request: GetHighestOffsetByTimestampRequest): Future[GetHighestOffsetByTimestampResponse]
For a given timestamp, find the highest ledger offset among all events that have record time <= timestamp.
For a given timestamp, find the highest ledger offset among all events that have record time <= timestamp.
Returns a ledger offset, or an error otherwise. Depending on the error cause, a retry may make sense. Retryable errors are defined as: OUT_OF_RANGE/INVALID_TIMESTAMP_PARTY_MANAGEMENT_ERROR. Further, a returned offset is guaranteed to be "clean", meaning all events have been processed fully and published to the Ledger API DB until the requested timestamp.
- abstract def importPartyAcs(responseObserver: StreamObserver[ImportPartyAcsResponse]): StreamObserver[ImportPartyAcsRequest]
Offline party replication focused ACS import.
Offline party replication focused ACS import.
Imports the party's ACS into the target participant.
This endpoint works in conjunction with ExportPartyAcs endpoint.
Concrete Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native()
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- def serviceCompanion: ServiceCompanion[PartyManagementService]
- Definition Classes
- PartyManagementService → AbstractService
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toString(): String
- Definition Classes
- AnyRef → Any
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()