Packages

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
  1. Alphabetic
  2. By Inheritance
Inherited
  1. party_to_participant_mappings
  2. Helpful
  3. AnyRef
  4. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

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 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
    """
    )
  6. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @IntrinsicCandidate()
  7. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  8. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  9. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  10. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  11. 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"))
  12. def help()(implicit consoleEnvironment: ConsoleEnvironment): Unit
    Definition Classes
    Helpful
  13. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  14. 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.
    |"""
    )
  15. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  16. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  17. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  18. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  19. def toString(): String
    Definition Classes
    AnyRef → Any
  20. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  21. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  22. 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
    Deprecated

Inherited from Helpful

Inherited from AnyRef

Inherited from Any

Ungrouped