Package com.azure.resourcemanager.datafactory.models

Class FtpReadSettings

java.lang.Object
com.azure.resourcemanager.datafactory.models.StoreReadSettings
com.azure.resourcemanager.datafactory.models.FtpReadSettings
public final class FtpReadSettings extends StoreReadSettings
Ftp read settings.

  • Constructor Details

    • FtpReadSettings

      public FtpReadSettings()
      Creates an instance of FtpReadSettings class.

  • Method Details

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

    • wildcardFolderPath

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

    • withWildcardFolderPath

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

    • wildcardFileName

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

    • withWildcardFileName

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

    • enablePartitionDiscovery

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

    • withEnablePartitionDiscovery

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

    • useBinaryTransfer

      public Boolean useBinaryTransfer()
      Get the useBinaryTransfer property: Specify whether to use binary transfer mode for FTP stores.
      Returns:
      the useBinaryTransfer value.

    • withUseBinaryTransfer

      public FtpReadSettings withUseBinaryTransfer(Boolean useBinaryTransfer)
      Set the useBinaryTransfer property: Specify whether to use binary transfer mode for FTP stores.
      Parameters:
      useBinaryTransfer - the useBinaryTransfer value to set.
      Returns:
      the FtpReadSettings 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 FtpReadSettings 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 FtpReadSettings object itself.

    • withMaxConcurrentConnections

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

    • validate

      public void validate()
      Validates the instance.
      Overrides:
      validate in class StoreReadSettings
      Throws:
      IllegalArgumentException - thrown if the instance is not valid.