Class AWS2S3EndpointBuilderFactory.AWS2S3HeaderNameBuilder
- java.lang.Object
-
- org.apache.camel.builder.endpoint.dsl.AWS2S3EndpointBuilderFactory.AWS2S3HeaderNameBuilder
-
- Enclosing interface:
- AWS2S3EndpointBuilderFactory
public static class AWS2S3EndpointBuilderFactory.AWS2S3HeaderNameBuilder extends Object
The builder of headers' name for the AWS S3 Storage Service component.
-
-
Constructor Summary
Constructors Constructor Description AWS2S3HeaderNameBuilder()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description String
awsS3Acl()
A well constructed Amazon S3 Access Control List object.String
awsS3BucketDestinationName()
The bucket Destination Name which will be used for the current operation.String
awsS3BucketName()
The bucket Name which this object will be stored or which will be used for the current operation or in which this object is contained.String
awsS3CannedAcl()
The canned acl that will be applied to the object.String
awsS3ContentControl()
The optional Cache-Control HTTP header which allows the user to specify caching behavior along the HTTP request/reply chain.String
awsS3ContentDisposition()
The optional Content-Disposition HTTP header, which specifies presentational information such as the recommended filename for the object to be saved as.String
awsS3ContentEncoding()
The optional Content-Encoding HTTP header specifying what content encodings have been applied to the object and what decoding mechanisms must be applied in order to obtain the media-type referenced by the Content-Type field.String
awsS3ContentLength()
The Content-Length HTTP header indicating the size of the associated object in bytes.String
awsS3ContentMD5()
The base64 encoded 128-bit MD5 digest of the associated object (content - not including headers) according to RFC 1864.String
awsS3ContentType()
The Content-Type HTTP header, which indicates the type of content stored in the associated object.String
awsS3Delimiter()
The delimiter which is used in the com.amazonaws.services.s3.model.ListObjectsRequest to only list objects we are interested in.String
awsS3DestinationKey()
The Destination key which will be used for the current operation.String
awsS3DowloadLinkExpirationTime()
The expiration time of the download link in milliseconds.String
awsS3DownloadLinkBrowserCompatible()
Whether the download link is browser compatible.String
awsS3DownloadLinkHttpRequestHeaders()
The headers that are needed by the service (not needed when BrowserCompatible is true).String
awsS3DownloadLinkSignedPayload()
The request payload that is needed by the service (not needed when BrowserCompatible is true).String
awsS3ETag()
(producer) The ETag value for the newly uploaded object.String
awsS3ExpirationTime()
If the object expiration is configured (see PUT Bucket lifecycle), the response includes this header.String
awsS3Key()
The key under which this object is stored or will be stored or which will be used for the current operation.String
awsS3LastModified()
The value of the Last-Modified header, indicating the date and time at which Amazon S3 last recorded a modification to the associated object.String
awsS3Metadata()
A map of metadata to be stored or stored with the object in S3.String
awsS3Operation()
The operation to perform.String
awsS3Prefix()
The prefix which is used in the com.amazonaws.services.s3.model.ListObjectsRequest to only list objects we are interested in.String
awsS3RangeEnd()
The position of the last byte to get.String
awsS3RangeStart()
The position of the first byte to get.String
awsS3ReplicationStatus()
Amazon S3 can return this if your request involves a bucket that is either a source or destination in a replication rule.String
awsS3ServerSideEncryption()
Sets the server-side encryption algorithm when encrypting the object using AWS-managed keys.String
awsS3StorageClass()
The storage class of this object.String
awsS3VersionId()
(producer) The optional version ID of the newly uploaded object.String
messageTimestamp()
The timestamp of the message.
-
-
-
Method Detail
-
awsS3BucketName
public String awsS3BucketName()
The bucket Name which this object will be stored or which will be used for the current operation or in which this object is contained. The option is a:String
type. Group: common- Returns:
- the name of the header
AwsS3BucketName
.
-
awsS3BucketDestinationName
public String awsS3BucketDestinationName()
The bucket Destination Name which will be used for the current operation. The option is a:String
type. Group: producer- Returns:
- the name of the header
AwsS3BucketDestinationName
.
-
awsS3ContentControl
public String awsS3ContentControl()
The optional Cache-Control HTTP header which allows the user to specify caching behavior along the HTTP request/reply chain. The option is a:String
type. Group: common- Returns:
- the name of the header
AwsS3ContentControl
.
-
awsS3ContentDisposition
public String awsS3ContentDisposition()
The optional Content-Disposition HTTP header, which specifies presentational information such as the recommended filename for the object to be saved as. The option is a:String
type. Group: common- Returns:
- the name of the header
AwsS3ContentDisposition
.
-
awsS3ContentEncoding
public String awsS3ContentEncoding()
The optional Content-Encoding HTTP header specifying what content encodings have been applied to the object and what decoding mechanisms must be applied in order to obtain the media-type referenced by the Content-Type field. The option is a:String
type. Group: common- Returns:
- the name of the header
AwsS3ContentEncoding
.
-
awsS3ContentLength
public String awsS3ContentLength()
The Content-Length HTTP header indicating the size of the associated object in bytes. The option is a:Long
type. Group: common- Returns:
- the name of the header
AwsS3ContentLength
.
-
awsS3ContentMD5
public String awsS3ContentMD5()
The base64 encoded 128-bit MD5 digest of the associated object (content - not including headers) according to RFC 1864. This data is used as a message integrity check to verify that the data received by Amazon S3 is the same data that the caller sent. The option is a:String
type. Group: common- Returns:
- the name of the header
AwsS3ContentMD5
.
-
awsS3ContentType
public String awsS3ContentType()
The Content-Type HTTP header, which indicates the type of content stored in the associated object. The value of this header is a standard MIME type. The option is a:String
type. Group: common- Returns:
- the name of the header
AwsS3ContentType
.
-
awsS3ETag
public String awsS3ETag()
(producer) The ETag value for the newly uploaded object. (consumer) The hex encoded 128-bit MD5 digest of the associated object according to RFC 1864. This data is used as an integrity check to verify that the data received by the caller is the same data that was sent by Amazon S3. The option is a:String
type. Group: common- Returns:
- the name of the header
AwsS3ETag
.
-
awsS3Key
public String awsS3Key()
The key under which this object is stored or will be stored or which will be used for the current operation. The option is a:String
type. Group: common- Returns:
- the name of the header
AwsS3Key
.
-
awsS3DestinationKey
public String awsS3DestinationKey()
The Destination key which will be used for the current operation. The option is a:String
type. Group: producer- Returns:
- the name of the header
AwsS3DestinationKey
.
-
awsS3LastModified
public String awsS3LastModified()
The value of the Last-Modified header, indicating the date and time at which Amazon S3 last recorded a modification to the associated object. The option is a:Date
type. Group: common- Returns:
- the name of the header
AwsS3LastModified
.
-
awsS3StorageClass
public String awsS3StorageClass()
The storage class of this object. The option is a:String
type. Group: common- Returns:
- the name of the header
AwsS3StorageClass
.
-
awsS3VersionId
public String awsS3VersionId()
(producer) The optional version ID of the newly uploaded object. (consumer) The version ID of the associated Amazon S3 object if available. Version IDs are only assigned to objects when an object is uploaded to an Amazon S3 bucket that has object versioning enabled. The option is a:String
type. Group: common- Returns:
- the name of the header
AwsS3VersionId
.
-
awsS3CannedAcl
public String awsS3CannedAcl()
The canned acl that will be applied to the object. see software.amazon.awssdk.services.s3.model.ObjectCannedACL for allowed values. The option is a:String
type. Group: producer- Returns:
- the name of the header
AwsS3CannedAcl
.
-
awsS3Acl
public String awsS3Acl()
A well constructed Amazon S3 Access Control List object. The option is a:software.amazon.awssdk.services.s3.model.BucketCannedACL
type. Group: producer- Returns:
- the name of the header
AwsS3Acl
.
-
awsS3Operation
public String awsS3Operation()
The operation to perform. Permitted values are copyObject, deleteObject, listBuckets, deleteBucket, listObjects. The option is a:String
type. Group: common- Returns:
- the name of the header
AwsS3Operation
.
-
awsS3ServerSideEncryption
public String awsS3ServerSideEncryption()
Sets the server-side encryption algorithm when encrypting the object using AWS-managed keys. For example use AES256. The option is a:String
type. Group: common- Returns:
- the name of the header
AwsS3ServerSideEncryption
.
-
awsS3ExpirationTime
public String awsS3ExpirationTime()
If the object expiration is configured (see PUT Bucket lifecycle), the response includes this header. The option is a:String
type. Group: consumer- Returns:
- the name of the header
AwsS3ExpirationTime
.
-
awsS3ReplicationStatus
public String awsS3ReplicationStatus()
Amazon S3 can return this if your request involves a bucket that is either a source or destination in a replication rule. The option is a:software.amazon.awssdk.services.s3.model.ReplicationStatus
type. Group: consumer- Returns:
- the name of the header
AwsS3ReplicationStatus
.
-
awsS3RangeStart
public String awsS3RangeStart()
The position of the first byte to get. The option is a:String
type. Group: producer- Returns:
- the name of the header
AwsS3RangeStart
.
-
awsS3RangeEnd
public String awsS3RangeEnd()
The position of the last byte to get. The option is a:String
type. Group: producer- Returns:
- the name of the header
AwsS3RangeEnd
.
-
awsS3DowloadLinkExpirationTime
public String awsS3DowloadLinkExpirationTime()
The expiration time of the download link in milliseconds. The option is a:Long
type. Group: producer- Returns:
- the name of the header
AwsS3DowloadLinkExpirationTime
.
-
awsS3DownloadLinkBrowserCompatible
public String awsS3DownloadLinkBrowserCompatible()
Whether the download link is browser compatible. The option is a:boolean
type. Group: producer- Returns:
- the name of the header
AwsS3DownloadLinkBrowserCompatible
.
-
awsS3DownloadLinkHttpRequestHeaders
public String awsS3DownloadLinkHttpRequestHeaders()
The headers that are needed by the service (not needed when BrowserCompatible is true). The option is a:Map<String, List<String>>
type. Group: producer- Returns:
- the name of the header
AwsS3DownloadLinkHttpRequestHeaders
.
-
awsS3DownloadLinkSignedPayload
public String awsS3DownloadLinkSignedPayload()
The request payload that is needed by the service (not needed when BrowserCompatible is true). The option is a:String
type. Group: producer- Returns:
- the name of the header
AwsS3DownloadLinkSignedPayload
.
-
awsS3Metadata
public String awsS3Metadata()
A map of metadata to be stored or stored with the object in S3. More details about metadata https://docs.aws.amazon.com/AmazonS3/latest/userguide/UsingMetadata.htmlhere. The option is a:Map<String, String>
type. Group: common- Returns:
- the name of the header
AwsS3Metadata
.
-
messageTimestamp
public String messageTimestamp()
The timestamp of the message. The option is a:long
type. Group: consumer- Returns:
- the name of the header
MessageTimestamp
.
-
awsS3Prefix
public String awsS3Prefix()
The prefix which is used in the com.amazonaws.services.s3.model.ListObjectsRequest to only list objects we are interested in. The option is a: type. Group: common- Returns:
- the name of the header
AwsS3Prefix
.
-
awsS3Delimiter
public String awsS3Delimiter()
The delimiter which is used in the com.amazonaws.services.s3.model.ListObjectsRequest to only list objects we are interested in. The option is a:String
type. Group: common- Returns:
- the name of the header
AwsS3Delimiter
.
-
-