Class AmazonS3Dataset
java.lang.Object
com.azure.resourcemanager.datafactory.models.Dataset
com.azure.resourcemanager.datafactory.models.AmazonS3Dataset
A single Amazon Simple Storage Service (S3) object or a set of S3 objects.
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionGet the bucketName property: The name of the Amazon S3 bucket.Get the compression property: The data compression method used for the Amazon S3 object.format()
Get the format property: The format of files.key()
Get the key property: The key of the Amazon S3 object.Get the modifiedDatetimeEnd property: The end of S3 object's modified datetime.Get the modifiedDatetimeStart property: The start of S3 object's modified datetime.prefix()
Get the prefix property: The prefix filter for the S3 object name.void
validate()
Validates the instance.version()
Get the version property: The version for the S3 object.withAnnotations
(List<Object> annotations) Set the annotations property: List of tags that can be used for describing the Dataset.withBucketName
(Object bucketName) Set the bucketName property: The name of the Amazon S3 bucket.withCompression
(DatasetCompression compression) Set the compression property: The data compression method used for the Amazon S3 object.withDescription
(String description) Set the description property: Dataset description.withFolder
(DatasetFolder folder) Set the folder property: The folder that this Dataset is in.withFormat
(DatasetStorageFormat format) Set the format property: The format of files.Set the key property: The key of the Amazon S3 object.withLinkedServiceName
(LinkedServiceReference linkedServiceName) Set the linkedServiceName property: Linked service reference.withModifiedDatetimeEnd
(Object modifiedDatetimeEnd) Set the modifiedDatetimeEnd property: The end of S3 object's modified datetime.withModifiedDatetimeStart
(Object modifiedDatetimeStart) Set the modifiedDatetimeStart property: The start of S3 object's modified datetime.withParameters
(Map<String, ParameterSpecification> parameters) Set the parameters property: Parameters for dataset.withPrefix
(Object prefix) Set the prefix property: The prefix filter for the S3 object name.withSchema
(Object schema) Set the schema property: Columns that define the physical type schema of the dataset.withStructure
(Object structure) Set the structure property: Columns that define the structure of the dataset.withVersion
(Object version) Set the version property: The version for the S3 object.Methods inherited from class com.azure.resourcemanager.datafactory.models.Dataset
additionalProperties, annotations, description, folder, linkedServiceName, parameters, schema, structure, withAdditionalProperties
-
Constructor Details
-
AmazonS3Dataset
public AmazonS3Dataset()Creates an instance of AmazonS3Dataset class.
-
-
Method Details
-
withDescription
Set the description property: Dataset description.- Overrides:
withDescription
in classDataset
- Parameters:
description
- the description value to set.- Returns:
- the Dataset object itself.
-
withStructure
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
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
Set the linkedServiceName property: Linked service reference.- Overrides:
withLinkedServiceName
in classDataset
- Parameters:
linkedServiceName
- the linkedServiceName value to set.- Returns:
- the Dataset object itself.
-
withParameters
Set the parameters property: Parameters for dataset.- Overrides:
withParameters
in classDataset
- Parameters:
parameters
- the parameters value to set.- Returns:
- the Dataset object itself.
-
withAnnotations
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
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.
-
bucketName
Get the bucketName property: The name of the Amazon S3 bucket. Type: string (or Expression with resultType string).- Returns:
- the bucketName value.
-
withBucketName
Set the bucketName property: The name of the Amazon S3 bucket. Type: string (or Expression with resultType string).- Parameters:
bucketName
- the bucketName value to set.- Returns:
- the AmazonS3Dataset object itself.
-
key
Get the key property: The key of the Amazon S3 object. Type: string (or Expression with resultType string).- Returns:
- the key value.
-
withKey
Set the key property: The key of the Amazon S3 object. Type: string (or Expression with resultType string).- Parameters:
key
- the key value to set.- Returns:
- the AmazonS3Dataset object itself.
-
prefix
Get the prefix property: The prefix filter for the S3 object name. Type: string (or Expression with resultType string).- Returns:
- the prefix value.
-
withPrefix
Set the prefix property: The prefix filter for the S3 object name. Type: string (or Expression with resultType string).- Parameters:
prefix
- the prefix value to set.- Returns:
- the AmazonS3Dataset object itself.
-
version
Get the version property: The version for the S3 object. Type: string (or Expression with resultType string).- Returns:
- the version value.
-
withVersion
Set the version property: The version for the S3 object. Type: string (or Expression with resultType string).- Parameters:
version
- the version value to set.- Returns:
- the AmazonS3Dataset object itself.
-
modifiedDatetimeStart
Get the modifiedDatetimeStart property: The start of S3 object's modified datetime. Type: string (or Expression with resultType string).- Returns:
- the modifiedDatetimeStart value.
-
withModifiedDatetimeStart
Set the modifiedDatetimeStart property: The start of S3 object's modified datetime. Type: string (or Expression with resultType string).- Parameters:
modifiedDatetimeStart
- the modifiedDatetimeStart value to set.- Returns:
- the AmazonS3Dataset object itself.
-
modifiedDatetimeEnd
Get the modifiedDatetimeEnd property: The end of S3 object's modified datetime. Type: string (or Expression with resultType string).- Returns:
- the modifiedDatetimeEnd value.
-
withModifiedDatetimeEnd
Set the modifiedDatetimeEnd property: The end of S3 object's modified datetime. Type: string (or Expression with resultType string).- Parameters:
modifiedDatetimeEnd
- the modifiedDatetimeEnd value to set.- Returns:
- the AmazonS3Dataset object itself.
-
format
Get the format property: The format of files.- Returns:
- the format value.
-
withFormat
Set the format property: The format of files.- Parameters:
format
- the format value to set.- Returns:
- the AmazonS3Dataset object itself.
-
compression
Get the compression property: The data compression method used for the Amazon S3 object.- Returns:
- the compression value.
-
withCompression
Set the compression property: The data compression method used for the Amazon S3 object.- Parameters:
compression
- the compression value to set.- Returns:
- the AmazonS3Dataset object itself.
-
validate
public void validate()Validates the instance.- Overrides:
validate
in classDataset
- Throws:
IllegalArgumentException
- thrown if the instance is not valid.
-