Class SshPublicKey


  • public final class SshPublicKey
    extends Object
    The SshPublicKey model.
    • Constructor Detail

      • SshPublicKey

        public SshPublicKey()
    • Method Detail

      • description

        public String description()
        Get the description property: Optional. It is used to store the function/usage of the key.
        Returns:
        the description value.
      • withDescription

        public SshPublicKey withDescription​(String description)
        Set the description property: Optional. It is used to store the function/usage of the key.
        Parameters:
        description - the description value to set.
        Returns:
        the SshPublicKey object itself.
      • key

        public String key()
        Get the key property: Ssh public key base64 encoded. The format should be: '<keyType> <keyData>', e.g. ssh-rsa AAAABBBB.
        Returns:
        the key value.
      • withKey

        public SshPublicKey withKey​(String key)
        Set the key property: Ssh public key base64 encoded. The format should be: '<keyType> <keyData>', e.g. ssh-rsa AAAABBBB.
        Parameters:
        key - the key value to set.
        Returns:
        the SshPublicKey object itself.
      • validate

        public void validate()
        Validates the instance.
        Throws:
        IllegalArgumentException - thrown if the instance is not valid.