Class DescribedHostKey

java.lang.Object
software.amazon.awssdk.services.transfer.model.DescribedHostKey
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<DescribedHostKey.Builder,DescribedHostKey>
@Generated("software.amazon.awssdk:codegen") public final class DescribedHostKey extends Object implements SdkPojo, Serializable, ToCopyableBuilder<DescribedHostKey.Builder,DescribedHostKey>

The details for a server host key.

See Also:

  • Method Details

    • arn

      public final String arn()

      The unique Amazon Resource Name (ARN) for the host key.

      Returns:
      The unique Amazon Resource Name (ARN) for the host key.

    • hostKeyId

      public final String hostKeyId()

      A unique identifier for the host key.

      Returns:
      A unique identifier for the host key.

    • hostKeyFingerprint

      public final String hostKeyFingerprint()

      The public key fingerprint, which is a short sequence of bytes used to identify the longer public key.

      Returns:
      The public key fingerprint, which is a short sequence of bytes used to identify the longer public key.

    • description

      public final String description()

      The text description for this host key.

      Returns:
      The text description for this host key.

    • type

      public final String type()

      The encryption algorithm that is used for the host key. The Type parameter is specified by using one of the following values:

      • ssh-rsa

      • ssh-ed25519

      • ecdsa-sha2-nistp256

      • ecdsa-sha2-nistp384

      • ecdsa-sha2-nistp521

      Returns:
      The encryption algorithm that is used for the host key. The Type parameter is specified by using one of the following values:

      • ssh-rsa

      • ssh-ed25519

      • ecdsa-sha2-nistp256

      • ecdsa-sha2-nistp384

      • ecdsa-sha2-nistp521

    • dateImported

      public final Instant dateImported()

      The date on which the host key was added to the server.

      Returns:
      The date on which the host key was added to the server.

    • hasTags

      public final boolean hasTags()
      For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • tags

      public final List<Tag> tags()

      Key-value pairs that can be used to group and search for host keys.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTags() method.

      Returns:
      Key-value pairs that can be used to group and search for host keys.

    • toBuilder

      public DescribedHostKey.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<DescribedHostKey.Builder,DescribedHostKey>
      Returns:
      a builder for type T

    • builder

      public static DescribedHostKey.Builder builder()

    • serializableBuilderClass

      public static Class<? extends DescribedHostKey.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final String toString()
      Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.