Package software.amazon.awssdk.services.transfer.model

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:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	DescribedHostKey.Builder

Method Summary

Modifier and Type	Method	Description
String	arn()	The unique Amazon Resource Name (ARN) for the host key.
static DescribedHostKey.Builder	builder()
Instant	dateImported()	The date on which the host key was added to the server.
String	description()	The text description for this host key.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasTags()	For responses, this returns true if the service returned a value for the Tags property.
String	hostKeyFingerprint()	The public key fingerprint, which is a short sequence of bytes used to identify the longer public key.
String	hostKeyId()	A unique identifier for the host key.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends DescribedHostKey.Builder>	serializableBuilderClass()
List<Tag>	tags()	Key-value pairs that can be used to group and search for host keys.
DescribedHostKey.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
String	type()	The encryption algorithm that is used for the host key.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

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()

Specified by:

toBuilder in interface ToCopyableBuilder<DescribedHostKey.Builder,DescribedHostKey>

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)

Specified by:

equalsBySdkFields in interface SdkPojo

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

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo