Class FileServerReadSettings
- java.lang.Object
-
- com.azure.resourcemanager.datafactory.models.StoreReadSettings
-
- com.azure.resourcemanager.datafactory.models.FileServerReadSettings
-
public final class FileServerReadSettings extends StoreReadSettings
File server read settings.
-
-
Constructor Summary
Constructors Constructor Description FileServerReadSettings()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description Object
deleteFilesAfterCompletion()
Get the deleteFilesAfterCompletion property: Indicates whether the source files need to be deleted after copy completion.Boolean
enablePartitionDiscovery()
Get the enablePartitionDiscovery property: Indicates whether to enable partition discovery.Object
fileFilter()
Get the fileFilter property: Specify a filter to be used to select a subset of files in the folderPath rather than all files.Object
fileListPath()
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
modifiedDatetimeEnd()
Get the modifiedDatetimeEnd property: The end of file's modified datetime.Object
modifiedDatetimeStart()
Get the modifiedDatetimeStart property: The start of file's modified datetime.Object
partitionRootPath()
Get the partitionRootPath property: Specify the root path where partition discovery starts from.Object
recursive()
Get the recursive property: If true, files under the folder path will be read recursively.void
validate()
Validates the instance.Object
wildcardFileName()
Get the wildcardFileName property: FileServer wildcardFileName.Object
wildcardFolderPath()
Get the wildcardFolderPath property: FileServer wildcardFolderPath.FileServerReadSettings
withDeleteFilesAfterCompletion(Object deleteFilesAfterCompletion)
Set the deleteFilesAfterCompletion property: Indicates whether the source files need to be deleted after copy completion.FileServerReadSettings
withDisableMetricsCollection(Object disableMetricsCollection)
Set the disableMetricsCollection property: If true, disable data store metrics collection.FileServerReadSettings
withEnablePartitionDiscovery(Boolean enablePartitionDiscovery)
Set the enablePartitionDiscovery property: Indicates whether to enable partition discovery.FileServerReadSettings
withFileFilter(Object fileFilter)
Set the fileFilter property: Specify a filter to be used to select a subset of files in the folderPath rather than all files.FileServerReadSettings
withFileListPath(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.FileServerReadSettings
withMaxConcurrentConnections(Object maxConcurrentConnections)
Set the maxConcurrentConnections property: The maximum concurrent connection count for the source data store.FileServerReadSettings
withModifiedDatetimeEnd(Object modifiedDatetimeEnd)
Set the modifiedDatetimeEnd property: The end of file's modified datetime.FileServerReadSettings
withModifiedDatetimeStart(Object modifiedDatetimeStart)
Set the modifiedDatetimeStart property: The start of file's modified datetime.FileServerReadSettings
withPartitionRootPath(Object partitionRootPath)
Set the partitionRootPath property: Specify the root path where partition discovery starts from.FileServerReadSettings
withRecursive(Object recursive)
Set the recursive property: If true, files under the folder path will be read recursively.FileServerReadSettings
withWildcardFileName(Object wildcardFileName)
Set the wildcardFileName property: FileServer wildcardFileName.FileServerReadSettings
withWildcardFolderPath(Object wildcardFolderPath)
Set the wildcardFolderPath property: FileServer wildcardFolderPath.-
Methods inherited from class com.azure.resourcemanager.datafactory.models.StoreReadSettings
additionalProperties, disableMetricsCollection, maxConcurrentConnections, withAdditionalProperties
-
-
-
-
Method Detail
-
recursive
public Object recursive()
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.
-
withRecursive
public FileServerReadSettings withRecursive(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 FileServerReadSettings object itself.
-
wildcardFolderPath
public Object wildcardFolderPath()
Get the wildcardFolderPath property: FileServer wildcardFolderPath. Type: string (or Expression with resultType string).- Returns:
- the wildcardFolderPath value.
-
withWildcardFolderPath
public FileServerReadSettings withWildcardFolderPath(Object wildcardFolderPath)
Set the wildcardFolderPath property: FileServer wildcardFolderPath. Type: string (or Expression with resultType string).- Parameters:
wildcardFolderPath
- the wildcardFolderPath value to set.- Returns:
- the FileServerReadSettings object itself.
-
wildcardFileName
public Object wildcardFileName()
Get the wildcardFileName property: FileServer wildcardFileName. Type: string (or Expression with resultType string).- Returns:
- the wildcardFileName value.
-
withWildcardFileName
public FileServerReadSettings withWildcardFileName(Object wildcardFileName)
Set the wildcardFileName property: FileServer wildcardFileName. Type: string (or Expression with resultType string).- Parameters:
wildcardFileName
- the wildcardFileName value to set.- Returns:
- the FileServerReadSettings object itself.
-
fileListPath
public Object fileListPath()
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.
-
withFileListPath
public FileServerReadSettings withFileListPath(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 FileServerReadSettings object itself.
-
enablePartitionDiscovery
public Boolean enablePartitionDiscovery()
Get the enablePartitionDiscovery property: Indicates whether to enable partition discovery.- Returns:
- the enablePartitionDiscovery value.
-
withEnablePartitionDiscovery
public FileServerReadSettings withEnablePartitionDiscovery(Boolean enablePartitionDiscovery)
Set the enablePartitionDiscovery property: Indicates whether to enable partition discovery.- Parameters:
enablePartitionDiscovery
- the enablePartitionDiscovery value to set.- Returns:
- the FileServerReadSettings object itself.
-
partitionRootPath
public Object partitionRootPath()
Get the partitionRootPath property: Specify the root path where partition discovery starts from. Type: string (or Expression with resultType string).- Returns:
- the partitionRootPath value.
-
withPartitionRootPath
public FileServerReadSettings withPartitionRootPath(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 FileServerReadSettings object itself.
-
deleteFilesAfterCompletion
public Object deleteFilesAfterCompletion()
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.
-
withDeleteFilesAfterCompletion
public FileServerReadSettings withDeleteFilesAfterCompletion(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 FileServerReadSettings object itself.
-
modifiedDatetimeStart
public Object modifiedDatetimeStart()
Get the modifiedDatetimeStart property: The start of file's modified datetime. Type: string (or Expression with resultType string).- Returns:
- the modifiedDatetimeStart value.
-
withModifiedDatetimeStart
public FileServerReadSettings withModifiedDatetimeStart(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 FileServerReadSettings object itself.
-
modifiedDatetimeEnd
public Object modifiedDatetimeEnd()
Get the modifiedDatetimeEnd property: The end of file's modified datetime. Type: string (or Expression with resultType string).- Returns:
- the modifiedDatetimeEnd value.
-
withModifiedDatetimeEnd
public FileServerReadSettings withModifiedDatetimeEnd(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 FileServerReadSettings object itself.
-
fileFilter
public Object fileFilter()
Get the fileFilter property: Specify a filter to be used to select a subset of files in the folderPath rather than all files. Type: string (or Expression with resultType string).- Returns:
- the fileFilter value.
-
withFileFilter
public FileServerReadSettings withFileFilter(Object fileFilter)
Set the fileFilter property: Specify a filter to be used to select a subset of files in the folderPath rather than all files. Type: string (or Expression with resultType string).- Parameters:
fileFilter
- the fileFilter value to set.- Returns:
- the FileServerReadSettings object itself.
-
withMaxConcurrentConnections
public FileServerReadSettings withMaxConcurrentConnections(Object maxConcurrentConnections)
Set the maxConcurrentConnections property: The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).- Overrides:
withMaxConcurrentConnections
in classStoreReadSettings
- Parameters:
maxConcurrentConnections
- the maxConcurrentConnections value to set.- Returns:
- the StoreReadSettings object itself.
-
withDisableMetricsCollection
public FileServerReadSettings withDisableMetricsCollection(Object disableMetricsCollection)
Set the disableMetricsCollection property: If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean).- Overrides:
withDisableMetricsCollection
in classStoreReadSettings
- Parameters:
disableMetricsCollection
- the disableMetricsCollection value to set.- Returns:
- the StoreReadSettings object itself.
-
validate
public void validate()
Validates the instance.- Overrides:
validate
in classStoreReadSettings
- Throws:
IllegalArgumentException
- thrown if the instance is not valid.
-
-