SftpReadSettings Class

Package:

com.azure.resourcemanager.datafactory.models

Maven Artifact:

com.azure.resourcemanager:azure-resourcemanager-datafactory:1.0.0-beta.28

• java.lang.Object
• • com.azure.resourcemanager.datafactory.models.StoreReadSettings
  • • com.azure.resourcemanager.datafactory.models.SftpReadSettings

public final class SftpReadSettings
extends StoreReadSettings

Sftp read settings.

Constructor Summary

Constructor	Description
SftpReadSettings()	Creates an instance of SftpReadSettings class.

Method Summary

Modifier and Type	Method and Description
Object	deleteFilesAfterCompletion() Get the deleteFilesAfterCompletion property: Indicates whether the source files need to be deleted after copy completion.
Object	disableChunking() Get the disableChunking property: If true, disable parallel reading within each file.
Object	enablePartitionDiscovery() Get the enablePartitionDiscovery property: Indicates whether to enable partition discovery.
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.
String	type() Get the type property: The read setting type.
void	validate() Validates the instance.
Object	wildcardFileName() Get the wildcardFileName property: Sftp wildcardFileName.
Object	wildcardFolderPath() Get the wildcardFolderPath property: Sftp wildcardFolderPath.
SftpReadSettings	withDeleteFilesAfterCompletion(Object deleteFilesAfterCompletion) Set the deleteFilesAfterCompletion property: Indicates whether the source files need to be deleted after copy completion.
SftpReadSettings	withDisableChunking(Object disableChunking) Set the disableChunking property: If true, disable parallel reading within each file.
SftpReadSettings	withDisableMetricsCollection(Object disableMetricsCollection) Set the disableMetricsCollection property: If true, disable data store metrics collection.
SftpReadSettings	withEnablePartitionDiscovery(Object enablePartitionDiscovery) Set the enablePartitionDiscovery property: Indicates whether to enable partition discovery.
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.
SftpReadSettings	withMaxConcurrentConnections(Object maxConcurrentConnections) Set the maxConcurrentConnections property: The maximum concurrent connection count for the source data store.
SftpReadSettings	withModifiedDatetimeEnd(Object modifiedDatetimeEnd) Set the modifiedDatetimeEnd property: The end of file's modified datetime.
SftpReadSettings	withModifiedDatetimeStart(Object modifiedDatetimeStart) Set the modifiedDatetimeStart property: The start of file's modified datetime.
SftpReadSettings	withPartitionRootPath(Object partitionRootPath) Set the partitionRootPath property: Specify the root path where partition discovery starts from.
SftpReadSettings	withRecursive(Object recursive) Set the recursive property: If true, files under the folder path will be read recursively.
SftpReadSettings	withWildcardFileName(Object wildcardFileName) Set the wildcardFileName property: Sftp wildcardFileName.
SftpReadSettings	withWildcardFolderPath(Object wildcardFolderPath) Set the wildcardFolderPath property: Sftp wildcardFolderPath.

Methods inherited from StoreReadSettings

additionalProperties disableMetricsCollection maxConcurrentConnections type validate withAdditionalProperties withDisableMetricsCollection withMaxConcurrentConnections

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

SftpReadSettings

public SftpReadSettings()

Creates an instance of SftpReadSettings class.

Method Details

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.

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.

enablePartitionDiscovery

public Object enablePartitionDiscovery()

Get the enablePartitionDiscovery property: Indicates whether to enable partition discovery. Type: boolean (or Expression with resultType boolean).

Returns:

the enablePartitionDiscovery value.

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.

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.

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.

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.

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.

type

public String type()

Get the type property: The read setting type.

Overrides:

SftpReadSettings.type()

Returns:

the type value.

validate

public void validate()

Validates the instance.

Overrides:

SftpReadSettings.validate()

wildcardFileName

public Object wildcardFileName()

Get the wildcardFileName property: Sftp wildcardFileName. Type: string (or Expression with resultType string).

Returns:

the wildcardFileName value.

wildcardFolderPath

public Object wildcardFolderPath()

Get the wildcardFolderPath property: Sftp wildcardFolderPath. Type: string (or Expression with resultType string).

Returns:

the wildcardFolderPath 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.

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.

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:

SftpReadSettings.withDisableMetricsCollection(Object disableMetricsCollection)

Parameters:

disableMetricsCollection

withEnablePartitionDiscovery

public SftpReadSettings withEnablePartitionDiscovery(Object enablePartitionDiscovery)

Set the enablePartitionDiscovery property: Indicates whether to enable partition discovery. Type: boolean (or Expression with resultType boolean).

Parameters:

enablePartitionDiscovery - the enablePartitionDiscovery value to set.

Returns:

the SftpReadSettings object itself.

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.

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:

SftpReadSettings.withMaxConcurrentConnections(Object maxConcurrentConnections)

Parameters:

maxConcurrentConnections

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.

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.

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.

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.

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.

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.