bulk-cdk-toolkit-load-s3/io.airbyte.cdk.load.command.s3/S3PathSpecification

S3PathSpecification

interface S3PathSpecification

Mix-in to provide S3 path configuration fields as properties.

NOTE: For legacy reasons, this is unnecessarily s3-specific. Future cloud storage solutions should create a single generic version of this in the object-storage toolkit and use that.

See io.airbyte.cdk.load.command.DestinationConfiguration for more details on how to use this interface.

Properties

Link copied to clipboard
@get:JsonPropertyDescription(value = "Pattern to match file names in the bucket directory. Read more <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/ListingKeysUsingAPIs.html">here</a>")
abstract val fileNamePattern: String?
Link copied to clipboard
@get:JsonPropertyDescription(value = "Directory under the S3 bucket where data will be written. Read more <a href="https://docs.airbyte.com/integrations/destinations/s3#:~:text=to%20format%20the-,bucket%20path,-%3A">here</a>")
abstract val s3BucketPath: String
Link copied to clipboard
@get:JsonPropertyDescription(value = "Format string on how data will be organized inside the bucket directory. Read more <a href="https://docs.airbyte.com/integrations/destinations/s3#:~:text=The%20full%20path%20of%20the%20output%20data%20with%20the%20default%20S3%20path%20format">here</a>")
abstract val s3PathFormat: String?