Class AzureDataLakeStoreReadSettings
- java.lang.Object
-
- com.azure.analytics.synapse.artifacts.models.StoreReadSettings
-
- com.azure.analytics.synapse.artifacts.models.AzureDataLakeStoreReadSettings
-
public final class AzureDataLakeStoreReadSettings extends StoreReadSettings
Azure data lake store read settings.
-
-
Constructor Summary
Constructors Constructor Description AzureDataLakeStoreReadSettings()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description Object
getDeleteFilesAfterCompletion()
Get the deleteFilesAfterCompletion property: Indicates whether the source files need to be deleted after copy completion.Object
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.Object
getListAfter()
Get the listAfter property: Lists files after the value (exclusive) based on file/folder names’ lexicographical order.Object
getListBefore()
Get the listBefore property: Lists files before the value (inclusive) based on file/folder names’ lexicographical order.Object
getModifiedDatetimeEnd()
Get the modifiedDatetimeEnd property: The end of file's modified datetime.Object
getModifiedDatetimeStart()
Get the modifiedDatetimeStart property: The start of file's modified datetime.Object
getPartitionRootPath()
Get the partitionRootPath property: Specify the root path where partition discovery starts from.Object
getRecursive()
Get the recursive property: If true, files under the folder path will be read recursively.Object
getWildcardFileName()
Get the wildcardFileName property: ADLS wildcardFileName.Object
getWildcardFolderPath()
Get the wildcardFolderPath property: ADLS wildcardFolderPath.Boolean
isEnablePartitionDiscovery()
Get the enablePartitionDiscovery property: Indicates whether to enable partition discovery.AzureDataLakeStoreReadSettings
setDeleteFilesAfterCompletion(Object deleteFilesAfterCompletion)
Set the deleteFilesAfterCompletion property: Indicates whether the source files need to be deleted after copy completion.AzureDataLakeStoreReadSettings
setEnablePartitionDiscovery(Boolean enablePartitionDiscovery)
Set the enablePartitionDiscovery property: Indicates whether to enable partition discovery.AzureDataLakeStoreReadSettings
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.AzureDataLakeStoreReadSettings
setListAfter(Object listAfter)
Set the listAfter property: Lists files after the value (exclusive) based on file/folder names’ lexicographical order.AzureDataLakeStoreReadSettings
setListBefore(Object listBefore)
Set the listBefore property: Lists files before the value (inclusive) based on file/folder names’ lexicographical order.AzureDataLakeStoreReadSettings
setMaxConcurrentConnections(Object maxConcurrentConnections)
Set the maxConcurrentConnections property: The maximum concurrent connection count for the source data store.AzureDataLakeStoreReadSettings
setModifiedDatetimeEnd(Object modifiedDatetimeEnd)
Set the modifiedDatetimeEnd property: The end of file's modified datetime.AzureDataLakeStoreReadSettings
setModifiedDatetimeStart(Object modifiedDatetimeStart)
Set the modifiedDatetimeStart property: The start of file's modified datetime.AzureDataLakeStoreReadSettings
setPartitionRootPath(Object partitionRootPath)
Set the partitionRootPath property: Specify the root path where partition discovery starts from.AzureDataLakeStoreReadSettings
setRecursive(Object recursive)
Set the recursive property: If true, files under the folder path will be read recursively.AzureDataLakeStoreReadSettings
setWildcardFileName(Object wildcardFileName)
Set the wildcardFileName property: ADLS wildcardFileName.AzureDataLakeStoreReadSettings
setWildcardFolderPath(Object wildcardFolderPath)
Set the wildcardFolderPath property: ADLS wildcardFolderPath.-
Methods inherited from class com.azure.analytics.synapse.artifacts.models.StoreReadSettings
getAdditionalProperties, getMaxConcurrentConnections, setAdditionalProperties
-
-
-
-
Method Detail
-
getRecursive
public Object 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
public AzureDataLakeStoreReadSettings setRecursive(Object recursive)
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 AzureDataLakeStoreReadSettings object itself.
-
getWildcardFolderPath
public Object getWildcardFolderPath()
Get the wildcardFolderPath property: ADLS wildcardFolderPath. Type: string (or Expression with resultType string).- Returns:
- the wildcardFolderPath value.
-
setWildcardFolderPath
public AzureDataLakeStoreReadSettings setWildcardFolderPath(Object wildcardFolderPath)
Set the wildcardFolderPath property: ADLS wildcardFolderPath. Type: string (or Expression with resultType string).- Parameters:
wildcardFolderPath
- the wildcardFolderPath value to set.- Returns:
- the AzureDataLakeStoreReadSettings object itself.
-
getWildcardFileName
public Object getWildcardFileName()
Get the wildcardFileName property: ADLS wildcardFileName. Type: string (or Expression with resultType string).- Returns:
- the wildcardFileName value.
-
setWildcardFileName
public AzureDataLakeStoreReadSettings setWildcardFileName(Object wildcardFileName)
Set the wildcardFileName property: ADLS wildcardFileName. Type: string (or Expression with resultType string).- Parameters:
wildcardFileName
- the wildcardFileName value to set.- Returns:
- the AzureDataLakeStoreReadSettings object itself.
-
getFileListPath
public Object 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
public AzureDataLakeStoreReadSettings 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. Type: string (or Expression with resultType string).- Parameters:
fileListPath
- the fileListPath value to set.- Returns:
- the AzureDataLakeStoreReadSettings object itself.
-
getListAfter
public Object getListAfter()
Get the listAfter property: Lists files after the value (exclusive) based on file/folder names’ lexicographical order. Applies under the folderPath in data set, and filter files/sub-folders under the folderPath. Type: string (or Expression with resultType string).- Returns:
- the listAfter value.
-
setListAfter
public AzureDataLakeStoreReadSettings setListAfter(Object listAfter)
Set the listAfter property: Lists files after the value (exclusive) based on file/folder names’ lexicographical order. Applies under the folderPath in data set, and filter files/sub-folders under the folderPath. Type: string (or Expression with resultType string).- Parameters:
listAfter
- the listAfter value to set.- Returns:
- the AzureDataLakeStoreReadSettings object itself.
-
getListBefore
public Object getListBefore()
Get the listBefore property: Lists files before the value (inclusive) based on file/folder names’ lexicographical order. Applies under the folderPath in data set, and filter files/sub-folders under the folderPath. Type: string (or Expression with resultType string).- Returns:
- the listBefore value.
-
setListBefore
public AzureDataLakeStoreReadSettings setListBefore(Object listBefore)
Set the listBefore property: Lists files before the value (inclusive) based on file/folder names’ lexicographical order. Applies under the folderPath in data set, and filter files/sub-folders under the folderPath. Type: string (or Expression with resultType string).- Parameters:
listBefore
- the listBefore value to set.- Returns:
- the AzureDataLakeStoreReadSettings object itself.
-
isEnablePartitionDiscovery
public Boolean isEnablePartitionDiscovery()
Get the enablePartitionDiscovery property: Indicates whether to enable partition discovery.- Returns:
- the enablePartitionDiscovery value.
-
setEnablePartitionDiscovery
public AzureDataLakeStoreReadSettings setEnablePartitionDiscovery(Boolean enablePartitionDiscovery)
Set the enablePartitionDiscovery property: Indicates whether to enable partition discovery.- Parameters:
enablePartitionDiscovery
- the enablePartitionDiscovery value to set.- Returns:
- the AzureDataLakeStoreReadSettings object itself.
-
getPartitionRootPath
public Object 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
public AzureDataLakeStoreReadSettings setPartitionRootPath(Object partitionRootPath)
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 AzureDataLakeStoreReadSettings object itself.
-
getDeleteFilesAfterCompletion
public Object 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
public AzureDataLakeStoreReadSettings setDeleteFilesAfterCompletion(Object deleteFilesAfterCompletion)
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 AzureDataLakeStoreReadSettings object itself.
-
getModifiedDatetimeStart
public Object getModifiedDatetimeStart()
Get the modifiedDatetimeStart property: The start of file's modified datetime. Type: string (or Expression with resultType string).- Returns:
- the modifiedDatetimeStart value.
-
setModifiedDatetimeStart
public AzureDataLakeStoreReadSettings setModifiedDatetimeStart(Object modifiedDatetimeStart)
Set the modifiedDatetimeStart property: The start of file's modified datetime. Type: string (or Expression with resultType string).- Parameters:
modifiedDatetimeStart
- the modifiedDatetimeStart value to set.- Returns:
- the AzureDataLakeStoreReadSettings object itself.
-
getModifiedDatetimeEnd
public Object getModifiedDatetimeEnd()
Get the modifiedDatetimeEnd property: The end of file's modified datetime. Type: string (or Expression with resultType string).- Returns:
- the modifiedDatetimeEnd value.
-
setModifiedDatetimeEnd
public AzureDataLakeStoreReadSettings setModifiedDatetimeEnd(Object modifiedDatetimeEnd)
Set the modifiedDatetimeEnd property: The end of file's modified datetime. Type: string (or Expression with resultType string).- Parameters:
modifiedDatetimeEnd
- the modifiedDatetimeEnd value to set.- Returns:
- the AzureDataLakeStoreReadSettings object itself.
-
setMaxConcurrentConnections
public AzureDataLakeStoreReadSettings setMaxConcurrentConnections(Object maxConcurrentConnections)
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.
-
-