Package com.azure.analytics.synapse.artifacts.models

Class SftpReadSettings

java.lang.Object
com.azure.analytics.synapse.artifacts.models.StoreReadSettings
com.azure.analytics.synapse.artifacts.models.SftpReadSettings
public final class SftpReadSettings extends StoreReadSettings
Sftp read settings.

  • Constructor Details

    • SftpReadSettings

      public SftpReadSettings()

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

    • getWildcardFolderPath

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

    • setWildcardFolderPath

      public SftpReadSettings setWildcardFolderPath(Object wildcardFolderPath)
      Set the wildcardFolderPath property: Sftp wildcardFolderPath. Type: string (or Expression with resultType string).
      Parameters:
      wildcardFolderPath - the wildcardFolderPath value to set.
      Returns:
      the SftpReadSettings object itself.

    • getWildcardFileName

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

    • setWildcardFileName

      public SftpReadSettings setWildcardFileName(Object wildcardFileName)
      Set the wildcardFileName property: Sftp wildcardFileName. Type: string (or Expression with resultType string).
      Parameters:
      wildcardFileName - the wildcardFileName value to set.
      Returns:
      the SftpReadSettings object itself.

    • isEnablePartitionDiscovery

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

    • setEnablePartitionDiscovery

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

    • getDisableChunking

      public Object 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

      public SftpReadSettings setDisableChunking(Object disableChunking)
      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 SftpReadSettings object itself.

    • setMaxConcurrentConnections

      public SftpReadSettings 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.