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

Class ImportHostKeyRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.transfer.model.TransferRequest

software.amazon.awssdk.services.transfer.model.ImportHostKeyRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<ImportHostKeyRequest.Builder,ImportHostKeyRequest>

@Generated("software.amazon.awssdk:codegen")
public final class ImportHostKeyRequest
extends TransferRequest
implements ToCopyableBuilder<ImportHostKeyRequest.Builder,ImportHostKeyRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ImportHostKeyRequest.Builder

Method Summary

Modifier and Type	Method	Description
static ImportHostKeyRequest.Builder	builder()
String	description()	The text description that identifies 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	hostKeyBody()	The private key portion of an SSH key pair.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends ImportHostKeyRequest.Builder>	serializableBuilderClass()
String	serverId()	The identifier of the server that contains the host key that you are importing.
List<Tag>	tags()	Key-value pairs that can be used to group and search for host keys.
ImportHostKeyRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

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

serverId

public final String serverId()

The identifier of the server that contains the host key that you are importing.

Returns:

The identifier of the server that contains the host key that you are importing.

hostKeyBody

public final String hostKeyBody()

The private key portion of an SSH key pair.

Transfer Family accepts RSA, ECDSA, and ED25519 keys.

Returns:

The private key portion of an SSH key pair.

Transfer Family accepts RSA, ECDSA, and ED25519 keys.

description

public final String description()

The text description that identifies this host key.

Returns:

The text description that identifies this host key.

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 ImportHostKeyRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ImportHostKeyRequest.Builder,ImportHostKeyRequest>

Specified by:

toBuilder in class TransferRequest

builder

public static ImportHostKeyRequest.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

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)

Overrides:

getValueForField in class SdkRequest

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