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(value="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" } ]

If the target of a logical directory entry does not exist in Amazon S3 or EFS, the entry is ignored. As a workaround, you can use the Amazon S3 API or EFS API to create 0 byte objects as place holders for your directory. If using the CLI, use the s3api or efsapi call instead of s3 or efs so you can use the put-object operation. For example, you use the following: aws s3api put-object --bucket bucketname --key path/to/folder/. Make sure that the end of the key name ends in a / for it to be considered a folder.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	HomeDirectoryMapEntry.Builder

Method Summary

Modifier and Type	Method and Description
static HomeDirectoryMapEntry.Builder	builder()
String	entry() Represents an entry for HomeDirectoryMappings.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
List<SdkField<?>>	sdkFields()
static Class<? extends HomeDirectoryMapEntry.Builder>	serializableBuilderClass()
String	target() Represents the map target that is used in a HomeDirectorymapEntry.
HomeDirectoryMapEntry.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString() Returns a string representation of this object.

Methods inherited from class java.lang.Object

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.

toBuilder

public HomeDirectoryMapEntry.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<HomeDirectoryMapEntry.Builder,HomeDirectoryMapEntry>

Returns:

a builder for type T

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)

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.