Class SshPublicKey

java.lang.Object
com.azure.resourcemanager.storage.models.SshPublicKey
All Implemented Interfaces:
com.azure.json.JsonSerializable<SshPublicKey>
public final class SshPublicKey extends Object implements com.azure.json.JsonSerializable<SshPublicKey>
The SshPublicKey model.

  • Constructor Details

    • SshPublicKey

      public SshPublicKey()
      Creates an instance of SshPublicKey class.

  • Method Details

    • 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.

    • toJson

      public com.azure.json.JsonWriter toJson(com.azure.json.JsonWriter jsonWriter) throws IOException
      Specified by:
      toJson in interface com.azure.json.JsonSerializable<SshPublicKey>
      Throws:
      IOException

    • fromJson

      public static SshPublicKey fromJson(com.azure.json.JsonReader jsonReader) throws IOException
      Reads an instance of SshPublicKey from the JsonReader.
      Parameters:
      jsonReader - The JsonReader being read.
      Returns:
      An instance of SshPublicKey if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.
      Throws:
      IOException - If an error occurs while reading the SshPublicKey.