object party_to_participant_mappings extends Helpful
- Annotations
- @Summary(s = "Manage party to participant mappings", flag = console.this.Help.Summary.<init>$default$2) @Group(name = "Party to participant mappings")
Linear Supertypes
Ordering
- Alphabetic
- By Inheritance
Inherited
- party_to_participant_mappings
- Helpful
- AnyRef
- Any
- Hide All
- Show All
Visibility
- Public
- Protected
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 authorize(ops: TopologyChangeOp, party: PartyId, participant: ParticipantId, side: RequestSide = RequestSide.Both, permission: ParticipantPermission = ParticipantPermission.Submission, signedBy: Option[Fingerprint] = None, synchronize: Option[NonNegativeDuration] = Some(
consoleEnvironment.commandTimeouts.bounded
), replaceExisting: Boolean = true, force: Boolean = false): ByteString
- Annotations
- @Summary(s = "Change party to participant mapping", flag = FeatureFlag.Preview) @Description(s = """Change the association of a party to a participant. If both identifiers are in the same namespace, then the
|request-side is Both. If they differ, then we need to say whether the request comes from the
|party (RequestSide.From) or from the participant (RequestSide.To). And, we need the matching request
|of the other side.
|Please note that this is a preview feature due to the fact that inhomogeneous topologies can not yet be properly
|represented on the Ledger API.
ops: Either Add or Remove the mapping
signedBy: Refers to the optional fingerprint of the authorizing key which in turn refers to a specific, locally existing certificate.
party: The unique identifier of the party we want to map to a participant.
participant: The unique identifier of the participant to which the party is supposed to be mapped.
side: The request side (RequestSide.From if we the transaction is from the perspective of the party, RequestSide.To from the participant.)
privilege: The privilege of the given participant which allows us to restrict an association (e.g. Confirmation or Observation).
replaceExisting: If true (default), replace any existing mapping with the new setting
synchronize: Synchronize timeout can be used to ensure that the state has been propagated into the node
""")
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native() @IntrinsicCandidate()
- 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() @IntrinsicCandidate()
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @IntrinsicCandidate()
- def help(methodName: String)(implicit consoleEnvironment: ConsoleEnvironment): Unit
- Definition Classes
- Helpful
- Annotations
- @Summary(s = "Help for specific commands (use help() or help(\"method\") for more information)", flag = console.this.Help.Summary.<init>$default$2) @Topic(t = Seq("Top-level Commands"))
- def help()(implicit consoleEnvironment: ConsoleEnvironment): Unit
- Definition Classes
- Helpful
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- def list(filterStore: String = "", useStateStore: Boolean = true, timeQuery: TimeQuery = TimeQuery.HeadState, operation: Option[TopologyChangeOp] = None, filterParty: String = "", filterParticipant: String = "", filterRequestSide: Option[RequestSide] = None, filterPermission: Option[ParticipantPermission] = None, filterSigningKey: String = "", protocolVersion: Option[String] = None): Seq[ListPartyToParticipantResult]
- Annotations
- @Summary(s = "List party to participant mapping transactions", flag = console.this.Help.Summary.<init>$default$2) @Description(s = """List the party to participant mapping transactions present in the stores. Party to participant mappings
|are topology transactions used to allocate a party to a certain participant. The same party can be allocated
|on several participants with different privileges.
|A party to participant mapping has a request-side that identifies whether the mapping is authorized by the
|party, by the participant or by both. In order to have a party be allocated to a given participant, we therefore
|need either two transactions (one with RequestSide.From, one with RequestSide.To) or one with RequestSide.Both.
filterStore: Filter for topology stores starting with the given filter string (Authorized, <domain-id>, Requested)
useStateStore: If true (default), only properly authorized transactions that are part of the state will be selected.
timeQuery: The time query allows to customize the query by time. The following options are supported:
TimeQuery.HeadState (default): The most recent known state.
TimeQuery.Snapshot(ts): The state at a certain point in time.
TimeQuery.Range(fromO, toO): Time-range of when the transaction was added to the store
operation: Optionally, what type of operation the transaction should have. State store only has "Add".
filterSigningKey: Filter for transactions that are authorized with a key that starts with the given filter string.
filterParty: Filter for parties starting with the given filter string.
filterParticipant: Filter for participants starting with the given filter string.
filterRequestSide: Optional filter for a particular request side (Both, From, To).
protocolVersion: Export the topology transactions in the optional protocol version.
|""")
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @IntrinsicCandidate()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @IntrinsicCandidate()
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toString(): String
- Definition Classes
- AnyRef → Any
- 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()
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])