Skip to content

HomeDirectoryMapEntry

Source code in docs_src/capo_transfer/types/home_directory_map_entry.py 
15
16
17
18
19
20
21
class HomeDirectoryMapEntry(TypedDict, closed=True):
    entry: "capo_transfer.types.map_entry.MapEntry"
    """<p>Represents an entry for <code>HomeDirectoryMappings</code>.</p>"""
    target: "capo_transfer.types.map_target.MapTarget"
    """<p>Represents the map target that is used in a <code>HomeDirectoryMapEntry</code>.</p>"""
    type: NotRequired["capo_transfer.types.map_type.MapType"]
    """<p>Specifies the type of mapping. Set the type to <code>FILE</code> if you want the mapping to point to a file, or <code>DIRECTORY</code> for the directory to point to a directory.</p> <note> <p>By default, home directory mappings have a <code>Type</code> of <code>DIRECTORY</code> when you create a Transfer Family server. You would need to explicitly set <code>Type</code> to <code>FILE</code> if you want a mapping to have a file target.</p> </note>"""

entry instance-attribute 

entry: MapEntry

Represents an entry for HomeDirectoryMappings.

target instance-attribute 

target: MapTarget

Represents the map target that is used in a HomeDirectoryMapEntry.

type instance-attribute 

type: NotRequired[MapType]

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.