Packages

c

com.digitalasset.canton.console.commands

PublicKeyAdministration

class PublicKeyAdministration extends Helpful

Linear Supertypes
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. PublicKeyAdministration
  2. Helpful
  3. AnyRef
  4. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new PublicKeyAdministration(runner: AdminCommandRunner, consoleEnvironment: ConsoleEnvironment)

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]) @native() @IntrinsicCandidate()
  6. def download(fingerprint: Fingerprint, protocolVersion: ProtocolVersion = ProtocolVersion.latestStable): ByteString
    Annotations
    @Summary(s = "Download public key", flag = console.this.Help.Summary.<init>$default$2)
  7. def download_to(fingerprint: Fingerprint, outputFile: String, protocolVersion: ProtocolVersion = ProtocolVersion.latestStable): Unit
    Annotations
    @Summary(s = "Download public key and save it to a file", flag = console.this.Help.Summary.<init>$default$2)
  8. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  9. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  10. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  11. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  12. 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"))
  13. def help()(implicit consoleEnvironment: ConsoleEnvironment): Unit
    Definition Classes
    Helpful
  14. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  15. def list(filterFingerprint: String = "", filterContext: String = ""): Seq[PublicKeyWithName]
    Annotations
    @Summary(s = "List public keys in registry", flag = console.this.Help.Summary.<init>$default$2) @Description(s = """Returns all public keys that have been added to the key registry.
    Optional arguments can be used for filtering."""
    )
  16. def list_by_owner(keyOwner: KeyOwner, filterDomain: String = "", asOf: Option[Instant] = None, limit: PositiveInt = defaultLimit): Seq[ListKeyOwnersResult]
    Annotations
    @Summary(s = "List keys for given keyOwner.", flag = console.this.Help.Summary.<init>$default$2) @Description(s = """This command is a convenience wrapper for `list_key_owners`, taking an explicit keyOwner as search argument.
    |The response includes the public keys."""
    )
  17. def list_owners(filterKeyOwnerUid: String = "", filterKeyOwnerType: Option[KeyOwnerCode] = None, filterDomain: String = "", asOf: Option[Instant] = None, limit: PositiveInt = defaultLimit): Seq[ListKeyOwnersResult]
    Annotations
    @Summary(s = "List active owners with keys for given search arguments.", flag = console.this.Help.Summary.<init>$default$2) @Description(s = """This command allows deep inspection of the topology state.
    |The response includes the public keys.
    |Optional filterKeyOwnerType type can be 'ParticipantId.Code' , 'MediatorId.Code','SequencerId.Code', 'DomainTopologyManagerId.Code'.
    |"""
    )
  18. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  19. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  20. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  21. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  22. def toString(): String
    Definition Classes
    AnyRef → Any
  23. def upload(filename: String, name: Option[String]): Fingerprint
    Annotations
    @Summary(s = "Upload public key", flag = console.this.Help.Summary.<init>$default$2) @Summary(s = "Load a public key from a file and store it together with a name used to provide some context to that key.", flag = console.this.Help.Summary.<init>$default$2)
  24. def upload(keyBytes: ByteString, name: Option[String]): Fingerprint
    Annotations
    @Summary(s = "Upload public key", flag = console.this.Help.Summary.<init>$default$2) @Description(s = """Import a public key and store it together with a name used to provide some context to that key.""")
  25. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  26. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  27. 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