FileServerReadSettings Class

Package:
com.azure.resourcemanager.datafactory.models
Maven Artifact:
com.azure.resourcemanager:azure-resourcemanager-datafactory:1.2.0

public final class FileServerReadSettings
extends StoreReadSettings

File server read settings.

Constructor Summary

Constructor Description
FileServerReadSettings()

Creates an instance of FileServerReadSettings 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 enablePartitionDiscovery()

Get the enablePartitionDiscovery property: Indicates whether to enable partition discovery.
Object fileFilter()

Get the fileFilter property: Specify a filter to be used to select a subset of files in the folderPath rather than all files.
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.
static FileServerReadSettings fromJson(JsonReader jsonReader)

Reads an instance of FileServerReadSettings from the JsonReader.
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.
JsonWriter toJson(JsonWriter jsonWriter)
String type()

Get the type property: The read setting type.
void validate()

Validates the instance.
Object wildcardFileName()

Get the wildcardFileName property: FileServer wildcardFileName.
Object wildcardFolderPath()

Get the wildcardFolderPath property: FileServer wildcardFolderPath.
FileServerReadSettings withDeleteFilesAfterCompletion(Object deleteFilesAfterCompletion)

Set the deleteFilesAfterCompletion property: Indicates whether the source files need to be deleted after copy completion.
FileServerReadSettings withDisableMetricsCollection(Object disableMetricsCollection)

Set the disableMetricsCollection property: If true, disable data store metrics collection.
FileServerReadSettings withEnablePartitionDiscovery(Object enablePartitionDiscovery)

Set the enablePartitionDiscovery property: Indicates whether to enable partition discovery.
FileServerReadSettings withFileFilter(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.
FileServerReadSettings 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.
FileServerReadSettings withMaxConcurrentConnections(Object maxConcurrentConnections)

Set the maxConcurrentConnections property: The maximum concurrent connection count for the source data store.
FileServerReadSettings withModifiedDatetimeEnd(Object modifiedDatetimeEnd)

Set the modifiedDatetimeEnd property: The end of file's modified datetime.
FileServerReadSettings withModifiedDatetimeStart(Object modifiedDatetimeStart)

Set the modifiedDatetimeStart property: The start of file's modified datetime.
FileServerReadSettings withPartitionRootPath(Object partitionRootPath)

Set the partitionRootPath property: Specify the root path where partition discovery starts from.
FileServerReadSettings withRecursive(Object recursive)

Set the recursive property: If true, files under the folder path will be read recursively.
FileServerReadSettings withWildcardFileName(Object wildcardFileName)

Set the wildcardFileName property: FileServer wildcardFileName.
FileServerReadSettings withWildcardFolderPath(Object wildcardFolderPath)

Set the wildcardFolderPath property: FileServer wildcardFolderPath.

Methods inherited from StoreReadSettings

additionalProperties disableMetricsCollection fromJson maxConcurrentConnections toJson type validate withAdditionalProperties withDisableMetricsCollection withMaxConcurrentConnections

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

FileServerReadSettings

public FileServerReadSettings()

Creates an instance of FileServerReadSettings 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.

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.

fileFilter

public Object fileFilter()

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.

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.

fromJson

public static FileServerReadSettings fromJson(JsonReader jsonReader)

Reads an instance of FileServerReadSettings from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of FileServerReadSettings if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.

Throws:

IOException

 - If an error occurs while reading the FileServerReadSettings.

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.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Overrides:

FileServerReadSettings.toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

type

public String type()

Get the type property: The read setting type.

Overrides:

FileServerReadSettings.type()

Returns:

the type value.

validate

public void validate()

Validates the instance.

Overrides:

FileServerReadSettings.validate()

wildcardFileName

public Object wildcardFileName()

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

Returns:

the wildcardFileName value.

wildcardFolderPath

public Object wildcardFolderPath()

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

Returns:

the wildcardFolderPath value.

withDeleteFilesAfterCompletion

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

withDisableMetricsCollection

public FileServerReadSettings 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:

FileServerReadSettings.withDisableMetricsCollection(Object disableMetricsCollection)

Parameters:

disableMetricsCollection

withEnablePartitionDiscovery

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

withFileFilter

public FileServerReadSettings withFileFilter(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.

withFileListPath

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

withMaxConcurrentConnections

public FileServerReadSettings 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:

FileServerReadSettings.withMaxConcurrentConnections(Object maxConcurrentConnections)

Parameters:

maxConcurrentConnections

withModifiedDatetimeEnd

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

withModifiedDatetimeStart

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

withPartitionRootPath

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

withRecursive

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

withWildcardFileName

public FileServerReadSettings withWildcardFileName(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.

withWildcardFolderPath

public FileServerReadSettings withWildcardFolderPath(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.

Applies to