Class FtpReadSettings
java.lang.Object
com.azure.analytics.synapse.artifacts.models.StoreReadSettings
com.azure.analytics.synapse.artifacts.models.FtpReadSettings
Ftp read settings.
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionGet the deleteFilesAfterCompletion property: Indicates whether the source files need to be deleted after copy completion.Get the disableChunking property: If true, disable parallel reading within each file.Get the fileListPath property: Point to a text file that lists each file (relative path to the path configured in the dataset) that you want to copy.Get the partitionRootPath property: Specify the root path where partition discovery starts from.Get the recursive property: If true, files under the folder path will be read recursively.Get the wildcardFileName property: Ftp wildcardFileName.Get the wildcardFolderPath property: Ftp wildcardFolderPath.Get the enablePartitionDiscovery property: Indicates whether to enable partition discovery.Get the useBinaryTransfer property: Specify whether to use binary transfer mode for FTP stores.setDeleteFilesAfterCompletion
(Object deleteFilesAfterCompletion) Set the deleteFilesAfterCompletion property: Indicates whether the source files need to be deleted after copy completion.setDisableChunking
(Object disableChunking) Set the disableChunking property: If true, disable parallel reading within each file.setEnablePartitionDiscovery
(Boolean enablePartitionDiscovery) Set the enablePartitionDiscovery property: Indicates whether to enable partition discovery.setFileListPath
(Object fileListPath) Set the fileListPath property: Point to a text file that lists each file (relative path to the path configured in the dataset) that you want to copy.setMaxConcurrentConnections
(Object maxConcurrentConnections) Set the maxConcurrentConnections property: The maximum concurrent connection count for the source data store.setPartitionRootPath
(Object partitionRootPath) Set the partitionRootPath property: Specify the root path where partition discovery starts from.setRecursive
(Object recursive) Set the recursive property: If true, files under the folder path will be read recursively.setUseBinaryTransfer
(Boolean useBinaryTransfer) Set the useBinaryTransfer property: Specify whether to use binary transfer mode for FTP stores.setWildcardFileName
(Object wildcardFileName) Set the wildcardFileName property: Ftp wildcardFileName.setWildcardFolderPath
(Object wildcardFolderPath) Set the wildcardFolderPath property: Ftp wildcardFolderPath.Methods inherited from class com.azure.analytics.synapse.artifacts.models.StoreReadSettings
getAdditionalProperties, getMaxConcurrentConnections, setAdditionalProperties
-
Constructor Details
-
FtpReadSettings
public FtpReadSettings()
-
-
Method Details
-
getRecursive
Get the recursive property: If true, files under the folder path will be read recursively. Default is true. Type: boolean (or Expression with resultType boolean).- Returns:
- the recursive value.
-
setRecursive
Set the recursive property: If true, files under the folder path will be read recursively. Default is true. Type: boolean (or Expression with resultType boolean).- Parameters:
recursive
- the recursive value to set.- Returns:
- the FtpReadSettings object itself.
-
getWildcardFolderPath
Get the wildcardFolderPath property: Ftp wildcardFolderPath. Type: string (or Expression with resultType string).- Returns:
- the wildcardFolderPath value.
-
setWildcardFolderPath
Set the wildcardFolderPath property: Ftp wildcardFolderPath. Type: string (or Expression with resultType string).- Parameters:
wildcardFolderPath
- the wildcardFolderPath value to set.- Returns:
- the FtpReadSettings object itself.
-
getWildcardFileName
Get the wildcardFileName property: Ftp wildcardFileName. Type: string (or Expression with resultType string).- Returns:
- the wildcardFileName value.
-
setWildcardFileName
Set the wildcardFileName property: Ftp wildcardFileName. Type: string (or Expression with resultType string).- Parameters:
wildcardFileName
- the wildcardFileName value to set.- Returns:
- the FtpReadSettings object itself.
-
isEnablePartitionDiscovery
Get the enablePartitionDiscovery property: Indicates whether to enable partition discovery.- Returns:
- the enablePartitionDiscovery value.
-
setEnablePartitionDiscovery
Set the enablePartitionDiscovery property: Indicates whether to enable partition discovery.- Parameters:
enablePartitionDiscovery
- the enablePartitionDiscovery value to set.- Returns:
- the FtpReadSettings object itself.
-
getPartitionRootPath
Get the partitionRootPath property: Specify the root path where partition discovery starts from. Type: string (or Expression with resultType string).- Returns:
- the partitionRootPath value.
-
setPartitionRootPath
Set the partitionRootPath property: Specify the root path where partition discovery starts from. Type: string (or Expression with resultType string).- Parameters:
partitionRootPath
- the partitionRootPath value to set.- Returns:
- the FtpReadSettings object itself.
-
getDeleteFilesAfterCompletion
Get the deleteFilesAfterCompletion property: Indicates whether the source files need to be deleted after copy completion. Default is false. Type: boolean (or Expression with resultType boolean).- Returns:
- the deleteFilesAfterCompletion value.
-
setDeleteFilesAfterCompletion
Set the deleteFilesAfterCompletion property: Indicates whether the source files need to be deleted after copy completion. Default is false. Type: boolean (or Expression with resultType boolean).- Parameters:
deleteFilesAfterCompletion
- the deleteFilesAfterCompletion value to set.- Returns:
- the FtpReadSettings object itself.
-
getFileListPath
Get the fileListPath property: Point to a text file that lists each file (relative path to the path configured in the dataset) that you want to copy. Type: string (or Expression with resultType string).- Returns:
- the fileListPath value.
-
setFileListPath
Set the fileListPath property: Point to a text file that lists each file (relative path to the path configured in the dataset) that you want to copy. Type: string (or Expression with resultType string).- Parameters:
fileListPath
- the fileListPath value to set.- Returns:
- the FtpReadSettings object itself.
-
isUseBinaryTransfer
Get the useBinaryTransfer property: Specify whether to use binary transfer mode for FTP stores.- Returns:
- the useBinaryTransfer value.
-
setUseBinaryTransfer
Set the useBinaryTransfer property: Specify whether to use binary transfer mode for FTP stores.- Parameters:
useBinaryTransfer
- the useBinaryTransfer value to set.- Returns:
- the FtpReadSettings object itself.
-
getDisableChunking
Get the disableChunking property: If true, disable parallel reading within each file. Default is false. Type: boolean (or Expression with resultType boolean).- Returns:
- the disableChunking value.
-
setDisableChunking
Set the disableChunking property: If true, disable parallel reading within each file. Default is false. Type: boolean (or Expression with resultType boolean).- Parameters:
disableChunking
- the disableChunking value to set.- Returns:
- the FtpReadSettings object itself.
-
setMaxConcurrentConnections
Set the maxConcurrentConnections property: The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).- Overrides:
setMaxConcurrentConnections
in classStoreReadSettings
- Parameters:
maxConcurrentConnections
- the maxConcurrentConnections value to set.- Returns:
- the StoreReadSettings object itself.
-