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

Class HomeDirectoryMapEntry

java.lang.Object

software.amazon.awssdk.services.transfer.model.HomeDirectoryMapEntry

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<HomeDirectoryMapEntry.Builder,HomeDirectoryMapEntry>

@Generated("software.amazon.awssdk:codegen")
public final class HomeDirectoryMapEntry
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<HomeDirectoryMapEntry.Builder,HomeDirectoryMapEntry>

Represents an object that contains entries and targets for HomeDirectoryMappings.

The following is an Entry and Target pair example for chroot.

[ { "Entry": "/", "Target": "/bucket_name/home/mydirectory" } ]

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	HomeDirectoryMapEntry.Builder

Method Summary

Modifier and Type	Method	Description
static HomeDirectoryMapEntry.Builder	builder()
String	entry()	Represents an entry for HomeDirectoryMappings.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends HomeDirectoryMapEntry.Builder>	serializableBuilderClass()
String	target()	Represents the map target that is used in a HomeDirectoryMapEntry.
HomeDirectoryMapEntry.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
MapType	type()	Specifies the type of mapping.
String	typeAsString()	Specifies the type of mapping.

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

entry

public final String entry()

Represents an entry for HomeDirectoryMappings.

Returns:

Represents an entry for HomeDirectoryMappings.

target

public final String target()

Represents the map target that is used in a HomeDirectoryMapEntry.

Returns:

Represents the map target that is used in a HomeDirectoryMapEntry.

type

public final MapType type()

Specifies the type of mapping. Set the type to FILE if you want the mapping to point to a file, or DIRECTORY for the directory to point to a directory.

By default, home directory mappings have a Type of DIRECTORY when you create a Transfer Family server. You would need to explicitly set Type to FILE if you want a mapping to have a file target.

If the service returns an enum value that is not available in the current SDK version, type will return MapType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().

Returns:

Specifies the type of mapping. Set the type to FILE if you want the mapping to point to a file, or DIRECTORY for the directory to point to a directory.

By default, home directory mappings have a Type of DIRECTORY when you create a Transfer Family server. You would need to explicitly set Type to FILE if you want a mapping to have a file target.

See Also:

MapType

typeAsString

public final String typeAsString()

Specifies the type of mapping. Set the type to FILE if you want the mapping to point to a file, or DIRECTORY for the directory to point to a directory.

By default, home directory mappings have a Type of DIRECTORY when you create a Transfer Family server. You would need to explicitly set Type to FILE if you want a mapping to have a file target.

If the service returns an enum value that is not available in the current SDK version, type will return MapType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().

Returns:

Specifies the type of mapping. Set the type to FILE if you want the mapping to point to a file, or DIRECTORY for the directory to point to a directory.

By default, home directory mappings have a Type of DIRECTORY when you create a Transfer Family server. You would need to explicitly set Type to FILE if you want a mapping to have a file target.

See Also:

MapType

toBuilder

public HomeDirectoryMapEntry.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<HomeDirectoryMapEntry.Builder,HomeDirectoryMapEntry>

builder

public static HomeDirectoryMapEntry.Builder builder()

serializableBuilderClass

public static Class<? extends HomeDirectoryMapEntry.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