Class AmazonS3Dataset

java.lang.Object
com.azure.resourcemanager.datafactory.models.Dataset
com.azure.resourcemanager.datafactory.models.AmazonS3Dataset

public final class AmazonS3Dataset extends Dataset
A single Amazon Simple Storage Service (S3) object or a set of S3 objects.
  • Constructor Details

    • AmazonS3Dataset

      public AmazonS3Dataset()
  • Method Details

    • withDescription

      public AmazonS3Dataset withDescription(String description)
      Set the description property: Dataset description.
      Overrides:
      withDescription in class Dataset
      Parameters:
      description - the description value to set.
      Returns:
      the Dataset object itself.
    • withStructure

      public AmazonS3Dataset 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 class Dataset
      Parameters:
      structure - the structure value to set.
      Returns:
      the Dataset object itself.
    • withSchema

      public AmazonS3Dataset 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 class Dataset
      Parameters:
      schema - the schema value to set.
      Returns:
      the Dataset object itself.
    • withLinkedServiceName

      public AmazonS3Dataset withLinkedServiceName(LinkedServiceReference linkedServiceName)
      Set the linkedServiceName property: Linked service reference.
      Overrides:
      withLinkedServiceName in class Dataset
      Parameters:
      linkedServiceName - the linkedServiceName value to set.
      Returns:
      the Dataset object itself.
    • withParameters

      public AmazonS3Dataset withParameters(Map<String,ParameterSpecification> parameters)
      Set the parameters property: Parameters for dataset.
      Overrides:
      withParameters in class Dataset
      Parameters:
      parameters - the parameters value to set.
      Returns:
      the Dataset object itself.
    • withAnnotations

      public AmazonS3Dataset withAnnotations(List<Object> annotations)
      Set the annotations property: List of tags that can be used for describing the Dataset.
      Overrides:
      withAnnotations in class Dataset
      Parameters:
      annotations - the annotations value to set.
      Returns:
      the Dataset object itself.
    • withFolder

      public AmazonS3Dataset 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 class Dataset
      Parameters:
      folder - the folder value to set.
      Returns:
      the Dataset object itself.
    • bucketName

      public Object bucketName()
      Get the bucketName property: The name of the Amazon S3 bucket. Type: string (or Expression with resultType string).
      Returns:
      the bucketName value.
    • withBucketName

      public AmazonS3Dataset withBucketName(Object bucketName)
      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

      public Object key()
      Get the key property: The key of the Amazon S3 object. Type: string (or Expression with resultType string).
      Returns:
      the key value.
    • withKey

      public AmazonS3Dataset withKey(Object key)
      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

      public Object 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

      public AmazonS3Dataset withPrefix(Object prefix)
      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

      public Object version()
      Get the version property: The version for the S3 object. Type: string (or Expression with resultType string).
      Returns:
      the version value.
    • withVersion

      public AmazonS3Dataset withVersion(Object version)
      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

      public Object 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

      public AmazonS3Dataset withModifiedDatetimeStart(Object modifiedDatetimeStart)
      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

      public Object 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

      public AmazonS3Dataset withModifiedDatetimeEnd(Object modifiedDatetimeEnd)
      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

      public DatasetStorageFormat format()
      Get the format property: The format of files.
      Returns:
      the format value.
    • withFormat

      public AmazonS3Dataset withFormat(DatasetStorageFormat format)
      Set the format property: The format of files.
      Parameters:
      format - the format value to set.
      Returns:
      the AmazonS3Dataset object itself.
    • compression

      public DatasetCompression compression()
      Get the compression property: The data compression method used for the Amazon S3 object.
      Returns:
      the compression value.
    • withCompression

      public AmazonS3Dataset withCompression(DatasetCompression compression)
      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 class Dataset
      Throws:
      IllegalArgumentException - thrown if the instance is not valid.