class LocalParticipantPartiesAdministrationGroupX extends ParticipantPartiesAdministrationGroupX with FeatureFlagFilter
Linear Supertypes
Ordering
- Alphabetic
- By Inheritance
Inherited
- LocalParticipantPartiesAdministrationGroupX
- FeatureFlagFilter
- NamedLogging
- ParticipantPartiesAdministrationGroupX
- PartiesAdministrationGroupX
- Helpful
- AnyRef
- Any
- Hide All
- Show All
Visibility
- Public
- Protected
Instance Constructors
- new LocalParticipantPartiesAdministrationGroupX(reference: LocalParticipantReferenceX, runner: AdminCommandRunner with BaseInspection[ParticipantNodeX] with ParticipantAdministration with BaseLedgerApiAdministration, consoleEnvironment: ConsoleEnvironment, loggerFactory: NamedLoggerFactory)
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 await_topology_observed[T <: ParticipantReferenceX](partyAssignment: Set[(PartyId, T)], timeout: NonNegativeDuration = consoleEnvironment.commandTimeouts.bounded)(implicit env: ConsoleEnvironment): Unit
- Annotations
- @Summary(s = "Waits for any topology changes to be observed", flag = FeatureFlag.Preview) @Description(s = "Will throw an exception if the given topology has not been observed within the given timeout.")
- def cantonConfig: CantonConfig
- Attributes
- protected
- Definition Classes
- FeatureFlagFilter
- def check[T](flag: FeatureFlag)(command: => T): T
- Attributes
- protected
- Definition Classes
- FeatureFlagFilter
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
- val consoleEnvironment: ConsoleEnvironment
- Definition Classes
- LocalParticipantPartiesAdministrationGroupX → FeatureFlagFilter
- def defaultLimit: PositiveInt
- Attributes
- protected
- Definition Classes
- PartiesAdministrationGroupX
- def disable(name: Identifier, force: Boolean = false): Unit
- Definition Classes
- ParticipantPartiesAdministrationGroupX
- Annotations
- @Summary(s = "Disable party on participant", flag = console.this.Help.Summary.<init>$default$2)
- def enable(name: String, namespace: Namespace = participantId.uid.namespace, participants: Seq[ParticipantId] = Seq(participantId), threshold: PositiveInt = PositiveInt.one, displayName: Option[String] = None, waitForDomain: DomainChoice = DomainChoice.Only(Seq()), synchronizeParticipants: Seq[ParticipantReferenceX] = Seq(), groupAddressing: Boolean = false, mustFullyAuthorize: Boolean = true): PartyId
- Definition Classes
- ParticipantPartiesAdministrationGroupX
- Annotations
- @Summary(s = "Enable/add party to participant", flag = console.this.Help.Summary.<init>$default$2) @Description(s = """This function registers a new party with the current participant within the participants
|namespace. The function fails if the participant does not have appropriate signing keys
|to issue the corresponding PartyToParticipant topology transaction.
|Optionally, a local display name can be added. This display name will be exposed on the
|ledger API party management endpoint.
|Specifying a set of domains via the `WaitForDomain` parameter ensures that the domains have
|enabled/added a party by the time the call returns, but other participants connected to the same domains may not
|yet be aware of the party.
|Additionally, a sequence of additional participants can be added to be synchronized to
|ensure that the party is known to these participants as well before the function terminates.
|""")
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- implicit def errorLoggingContext(implicit traceContext: TraceContext): ErrorLoggingContext
- Attributes
- protected
- Definition Classes
- NamedLogging
- def find(filterParty: String): PartyId
- Definition Classes
- ParticipantPartiesAdministrationGroupX
- Annotations
- @Summary(s = "Find a party from a filter string", flag = console.this.Help.Summary.<init>$default$2) @Description(s = """Will search for all parties that match this filter string. If it finds exactly one party, it
|will return that one. Otherwise, the function will throw.""")
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- 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
- def hosted(filterParty: String = "", filterDomain: String = "", asOf: Option[Instant] = None, limit: PositiveInt = defaultLimit): Seq[ListPartiesResult]
- Definition Classes
- ParticipantPartiesAdministrationGroupX
- Annotations
- @Summary(s = "List parties hosted by this participant", flag = console.this.Help.Summary.<init>$default$2) @Description(s = """Inspect the parties hosted by this participant as used for synchronisation.
|The response is built from the timestamped topology transactions of each domain, excluding the
|authorized store of the given node. The search will include all hosted parties and is equivalent
|to running the `list` method using the participant id of the invoking participant.
|
filterParty: Filter by parties starting with the given string.
filterDomain: Filter by domains whose id starts with the given string.
asOf: Optional timestamp to inspect the topology state at a given point in time.
limit: How many items to return (defaults to canton.parameters.console.default-limit)
Example: participant1.parties.hosted(filterParty="alice")""")
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- def list(filterParty: String = "", filterParticipant: String = "", filterDomain: String = "", asOf: Option[Instant] = None, limit: PositiveInt = defaultLimit): Seq[ListPartiesResult]
- Definition Classes
- PartiesAdministrationGroupX
- Annotations
- @Summary(s = "List active parties, their active participants, and the participants' permissions on domains.", flag = console.this.Help.Summary.<init>$default$2) @Description(s = """Inspect the parties known by this participant as used for synchronisation.
|The response is built from the timestamped topology transactions of each domain, excluding the
|authorized store of the given node. For each known party, the list of active
|participants and their permission on the domain for that party is given.
|
filterParty: Filter by parties starting with the given string.
filterParticipant: Filter for parties that are hosted by a participant with an id starting with the given string
filterDomain: Filter by domains whose id starts with the given string.
asOf: Optional timestamp to inspect the topology state at a given point in time.
limit: Limit on the number of parties fetched (defaults to canton.parameters.console.default-limit).
Example: participant1.parties.list(filterParty="alice")
""")
- def logger: TracedLogger
- Attributes
- protected
- Definition Classes
- NamedLogging
- val loggerFactory: NamedLoggerFactory
- Definition Classes
- LocalParticipantPartiesAdministrationGroupX → NamedLogging
- implicit def namedLoggingContext(implicit traceContext: TraceContext): NamedLoggingContext
- Attributes
- protected
- Definition Classes
- NamedLogging
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def noTracingLogger: Logger
- Attributes
- protected
- Definition Classes
- NamedLogging
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- def set_display_name(party: PartyId, displayName: String): Unit
- Definition Classes
- ParticipantPartiesAdministrationGroupX
- Annotations
- @Summary(s = "Set party display name", flag = console.this.Help.Summary.<init>$default$2) @Description(s = "Locally set the party display name (shown on the ledger-api) to the given value")
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toString(): String
- Definition Classes
- AnyRef → Any
- def update(party: PartyId, modifier: (PartyDetails) => PartyDetails): PartyDetails
- Definition Classes
- ParticipantPartiesAdministrationGroupX
- Annotations
- @Summary(s = "Update participant-local party details", flag = console.this.Help.Summary.<init>$default$2) @Description(s = """Currently you can update only the annotations.
|You cannot update other user attributes.
party: party to be updated,
modifier: a function to modify the party details, e.g.: `partyDetails => { partyDetails.copy(annotations = partyDetails.annotations.updated("a", "b").removed("c")) }`""")
- 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])