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:

  • Method Details

    • 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:

    • 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:

    • 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.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.