Class SftpReadSettings

    • Constructor Detail

      • SftpReadSettings

        public SftpReadSettings()
    • 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 SftpReadSettings 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 SftpReadSettings object itself.
      • wildcardFolderPath

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

        public SftpReadSettings withWildcardFolderPath​(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.
      • wildcardFileName

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

        public SftpReadSettings withWildcardFileName​(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.
      • enablePartitionDiscovery

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

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

        public Object disableChunking()
        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.
      • withDisableChunking

        public SftpReadSettings withDisableChunking​(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.
      • withMaxConcurrentConnections

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

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