Class AzureFileStorageReadSettings
java.lang.Object
com.azure.analytics.synapse.artifacts.models.StoreReadSettings
com.azure.analytics.synapse.artifacts.models.AzureFileStorageReadSettings
Azure File Storage read settings.
-
Constructor Summary
ConstructorDescriptionCreates an instance of AzureFileStorageReadSettings class. -
Method Summary
Modifier and TypeMethodDescriptionGet the deleteFilesAfterCompletion property: Indicates whether the source files need to be deleted after copy completion.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 modifiedDatetimeEnd property: The end of file's modified datetime.Get the modifiedDatetimeStart property: The start of file's modified datetime.Get the partitionRootPath property: Specify the root path where partition discovery starts from.Get the prefix property: The prefix filter for the Azure File name starting from root path.Get the recursive property: If true, files under the folder path will be read recursively.Get the wildcardFileName property: Azure File Storage wildcardFileName.Get the wildcardFolderPath property: Azure File Storage wildcardFolderPath.Get the enablePartitionDiscovery property: Indicates whether to enable partition discovery.setDeleteFilesAfterCompletion
(Object deleteFilesAfterCompletion) Set the deleteFilesAfterCompletion property: Indicates whether the source files need to be deleted after copy completion.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.setModifiedDatetimeEnd
(Object modifiedDatetimeEnd) Set the modifiedDatetimeEnd property: The end of file's modified datetime.setModifiedDatetimeStart
(Object modifiedDatetimeStart) Set the modifiedDatetimeStart property: The start of file's modified datetime.setPartitionRootPath
(Object partitionRootPath) Set the partitionRootPath property: Specify the root path where partition discovery starts from.Set the prefix property: The prefix filter for the Azure File name starting from root path.setRecursive
(Object recursive) Set the recursive property: If true, files under the folder path will be read recursively.setWildcardFileName
(Object wildcardFileName) Set the wildcardFileName property: Azure File Storage wildcardFileName.setWildcardFolderPath
(Object wildcardFolderPath) Set the wildcardFolderPath property: Azure File Storage wildcardFolderPath.Methods inherited from class com.azure.analytics.synapse.artifacts.models.StoreReadSettings
getAdditionalProperties, getMaxConcurrentConnections, setAdditionalProperties
-
Constructor Details
-
AzureFileStorageReadSettings
public AzureFileStorageReadSettings()Creates an instance of AzureFileStorageReadSettings class.
-
-
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 AzureFileStorageReadSettings object itself.
-
getWildcardFolderPath
Get the wildcardFolderPath property: Azure File Storage wildcardFolderPath. Type: string (or Expression with resultType string).- Returns:
- the wildcardFolderPath value.
-
setWildcardFolderPath
Set the wildcardFolderPath property: Azure File Storage wildcardFolderPath. Type: string (or Expression with resultType string).- Parameters:
wildcardFolderPath
- the wildcardFolderPath value to set.- Returns:
- the AzureFileStorageReadSettings object itself.
-
getWildcardFileName
Get the wildcardFileName property: Azure File Storage wildcardFileName. Type: string (or Expression with resultType string).- Returns:
- the wildcardFileName value.
-
setWildcardFileName
Set the wildcardFileName property: Azure File Storage wildcardFileName. Type: string (or Expression with resultType string).- Parameters:
wildcardFileName
- the wildcardFileName value to set.- Returns:
- the AzureFileStorageReadSettings object itself.
-
getPrefix
Get the prefix property: The prefix filter for the Azure File name starting from root path. Type: string (or Expression with resultType string).- Returns:
- the prefix value.
-
setPrefix
Set the prefix property: The prefix filter for the Azure File name starting from root path. Type: string (or Expression with resultType string).- Parameters:
prefix
- the prefix value to set.- Returns:
- the AzureFileStorageReadSettings 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 AzureFileStorageReadSettings 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 AzureFileStorageReadSettings 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 AzureFileStorageReadSettings 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
public AzureFileStorageReadSettings 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 AzureFileStorageReadSettings object itself.
-
getModifiedDatetimeStart
Get the modifiedDatetimeStart property: The start of file's modified datetime. Type: string (or Expression with resultType string).- Returns:
- the modifiedDatetimeStart value.
-
setModifiedDatetimeStart
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 AzureFileStorageReadSettings object itself.
-
getModifiedDatetimeEnd
Get the modifiedDatetimeEnd property: The end of file's modified datetime. Type: string (or Expression with resultType string).- Returns:
- the modifiedDatetimeEnd value.
-
setModifiedDatetimeEnd
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 AzureFileStorageReadSettings 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.
-