Class FileServerReadSettings

java.lang.Object
com.azure.analytics.synapse.artifacts.models.StoreReadSettings
com.azure.analytics.synapse.artifacts.models.FileServerReadSettings

public final class FileServerReadSettings extends StoreReadSettings
File server read settings.
  • Constructor Details

    • FileServerReadSettings

      public FileServerReadSettings()
  • Method Details

    • 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 FileServerReadSettings 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 FileServerReadSettings object itself.
    • getWildcardFolderPath

      public Object getWildcardFolderPath()
      Get the wildcardFolderPath property: FileServer wildcardFolderPath. Type: string (or Expression with resultType string).
      Returns:
      the wildcardFolderPath value.
    • setWildcardFolderPath

      public FileServerReadSettings setWildcardFolderPath(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.
    • getWildcardFileName

      public Object getWildcardFileName()
      Get the wildcardFileName property: FileServer wildcardFileName. Type: string (or Expression with resultType string).
      Returns:
      the wildcardFileName value.
    • setWildcardFileName

      public FileServerReadSettings setWildcardFileName(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.
    • 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 FileServerReadSettings 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 FileServerReadSettings object itself.
    • isEnablePartitionDiscovery

      public Boolean isEnablePartitionDiscovery()
      Get the enablePartitionDiscovery property: Indicates whether to enable partition discovery.
      Returns:
      the enablePartitionDiscovery value.
    • setEnablePartitionDiscovery

      public FileServerReadSettings setEnablePartitionDiscovery(Boolean enablePartitionDiscovery)
      Set the enablePartitionDiscovery property: Indicates whether to enable partition discovery.
      Parameters:
      enablePartitionDiscovery - the enablePartitionDiscovery value to set.
      Returns:
      the FileServerReadSettings 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 FileServerReadSettings 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 FileServerReadSettings 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 FileServerReadSettings 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 FileServerReadSettings 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 FileServerReadSettings 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 FileServerReadSettings 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 FileServerReadSettings 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 FileServerReadSettings object itself.
    • getFileFilter

      public Object getFileFilter()
      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.
    • setFileFilter

      public FileServerReadSettings setFileFilter(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.
    • setMaxConcurrentConnections

      public FileServerReadSettings 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 class StoreReadSettings
      Parameters:
      maxConcurrentConnections - the maxConcurrentConnections value to set.
      Returns:
      the StoreReadSettings object itself.