Class FileShareDataset
- java.lang.Object
-
- com.azure.resourcemanager.datafactory.models.Dataset
-
- com.azure.resourcemanager.datafactory.models.FileShareDataset
-
public final class FileShareDataset extends Dataset
An on-premises file system dataset.
-
-
Constructor Summary
Constructors Constructor Description FileShareDataset()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description DatasetCompression
compression()
Get the compression property: The data compression method used for the file system.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
fileName()
Get the fileName property: The name of the on-premises file system.Object
folderPath()
Get the folderPath property: The path of the on-premises file system.DatasetStorageFormat
format()
Get the format property: The format of the files.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.void
validate()
Validates the instance.FileShareDataset
withAnnotations(List<Object> annotations)
Set the annotations property: List of tags that can be used for describing the Dataset.FileShareDataset
withCompression(DatasetCompression compression)
Set the compression property: The data compression method used for the file system.FileShareDataset
withDescription(String description)
Set the description property: Dataset description.FileShareDataset
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.FileShareDataset
withFileName(Object fileName)
Set the fileName property: The name of the on-premises file system.FileShareDataset
withFolder(DatasetFolder folder)
Set the folder property: The folder that this Dataset is in.FileShareDataset
withFolderPath(Object folderPath)
Set the folderPath property: The path of the on-premises file system.FileShareDataset
withFormat(DatasetStorageFormat format)
Set the format property: The format of the files.FileShareDataset
withLinkedServiceName(LinkedServiceReference linkedServiceName)
Set the linkedServiceName property: Linked service reference.FileShareDataset
withModifiedDatetimeEnd(Object modifiedDatetimeEnd)
Set the modifiedDatetimeEnd property: The end of file's modified datetime.FileShareDataset
withModifiedDatetimeStart(Object modifiedDatetimeStart)
Set the modifiedDatetimeStart property: The start of file's modified datetime.FileShareDataset
withParameters(Map<String,ParameterSpecification> parameters)
Set the parameters property: Parameters for dataset.FileShareDataset
withSchema(Object schema)
Set the schema property: Columns that define the physical type schema of the dataset.FileShareDataset
withStructure(Object structure)
Set the structure property: Columns that define the structure of the dataset.-
Methods inherited from class com.azure.resourcemanager.datafactory.models.Dataset
additionalProperties, annotations, description, folder, linkedServiceName, parameters, schema, structure, withAdditionalProperties
-
-
-
-
Method Detail
-
withDescription
public FileShareDataset withDescription(String description)
Set the description property: Dataset description.- Overrides:
withDescription
in classDataset
- Parameters:
description
- the description value to set.- Returns:
- the Dataset object itself.
-
withStructure
public FileShareDataset withStructure(Object structure)
Set the structure property: Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.- Overrides:
withStructure
in classDataset
- Parameters:
structure
- the structure value to set.- Returns:
- the Dataset object itself.
-
withSchema
public FileShareDataset withSchema(Object schema)
Set the schema property: Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.- Overrides:
withSchema
in classDataset
- Parameters:
schema
- the schema value to set.- Returns:
- the Dataset object itself.
-
withLinkedServiceName
public FileShareDataset withLinkedServiceName(LinkedServiceReference linkedServiceName)
Set the linkedServiceName property: Linked service reference.- Overrides:
withLinkedServiceName
in classDataset
- Parameters:
linkedServiceName
- the linkedServiceName value to set.- Returns:
- the Dataset object itself.
-
withParameters
public FileShareDataset withParameters(Map<String,ParameterSpecification> parameters)
Set the parameters property: Parameters for dataset.- Overrides:
withParameters
in classDataset
- Parameters:
parameters
- the parameters value to set.- Returns:
- the Dataset object itself.
-
withAnnotations
public FileShareDataset withAnnotations(List<Object> annotations)
Set the annotations property: List of tags that can be used for describing the Dataset.- Overrides:
withAnnotations
in classDataset
- Parameters:
annotations
- the annotations value to set.- Returns:
- the Dataset object itself.
-
withFolder
public FileShareDataset withFolder(DatasetFolder folder)
Set the folder property: The folder that this Dataset is in. If not specified, Dataset will appear at the root level.- Overrides:
withFolder
in classDataset
- Parameters:
folder
- the folder value to set.- Returns:
- the Dataset object itself.
-
folderPath
public Object folderPath()
Get the folderPath property: The path of the on-premises file system. Type: string (or Expression with resultType string).- Returns:
- the folderPath value.
-
withFolderPath
public FileShareDataset withFolderPath(Object folderPath)
Set the folderPath property: The path of the on-premises file system. Type: string (or Expression with resultType string).- Parameters:
folderPath
- the folderPath value to set.- Returns:
- the FileShareDataset object itself.
-
fileName
public Object fileName()
Get the fileName property: The name of the on-premises file system. Type: string (or Expression with resultType string).- Returns:
- the fileName value.
-
withFileName
public FileShareDataset withFileName(Object fileName)
Set the fileName property: The name of the on-premises file system. Type: string (or Expression with resultType string).- Parameters:
fileName
- the fileName value to set.- Returns:
- the FileShareDataset 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 FileShareDataset 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 FileShareDataset 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 FileShareDataset 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 FileShareDataset object itself.
-
format
public DatasetStorageFormat format()
Get the format property: The format of the files.- Returns:
- the format value.
-
withFormat
public FileShareDataset withFormat(DatasetStorageFormat format)
Set the format property: The format of the files.- Parameters:
format
- the format value to set.- Returns:
- the FileShareDataset object itself.
-
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.
-
withFileFilter
public FileShareDataset 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 FileShareDataset object itself.
-
compression
public DatasetCompression compression()
Get the compression property: The data compression method used for the file system.- Returns:
- the compression value.
-
withCompression
public FileShareDataset withCompression(DatasetCompression compression)
Set the compression property: The data compression method used for the file system.- Parameters:
compression
- the compression value to set.- Returns:
- the FileShareDataset object itself.
-
validate
public void validate()
Validates the instance.- Overrides:
validate
in classDataset
- Throws:
IllegalArgumentException
- thrown if the instance is not valid.
-
-