Package software.amazon.awssdk.services.s3.model

Interface WriteGetObjectResponseRequest.Builder

    • Method Detail

      • requestRoute

        WriteGetObjectResponseRequest.Builder requestRoute​(String requestRoute)

        Route prefix to the HTTP URL generated.

        Parameters:
        requestRoute - Route prefix to the HTTP URL generated.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • requestToken

        WriteGetObjectResponseRequest.Builder requestToken​(String requestToken)

        A single use encrypted token that maps WriteGetObjectResponse to the end user GetObject request.

        Parameters:
        requestToken - A single use encrypted token that maps WriteGetObjectResponse to the end user GetObject request.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • statusCode

        WriteGetObjectResponseRequest.Builder statusCode​(Integer statusCode)

        The integer status code for an HTTP response of a corresponding GetObject request. The following is a list of status codes.

        • 200 - OK

        • 206 - Partial Content

        • 304 - Not Modified

        • 400 - Bad Request

        • 401 - Unauthorized

        • 403 - Forbidden

        • 404 - Not Found

        • 405 - Method Not Allowed

        • 409 - Conflict

        • 411 - Length Required

        • 412 - Precondition Failed

        • 416 - Range Not Satisfiable

        • 500 - Internal Server Error

        • 503 - Service Unavailable

        Parameters:
        statusCode - The integer status code for an HTTP response of a corresponding GetObject request. The following is a list of status codes.

        • 200 - OK

        • 206 - Partial Content

        • 304 - Not Modified

        • 400 - Bad Request

        • 401 - Unauthorized

        • 403 - Forbidden

        • 404 - Not Found

        • 405 - Method Not Allowed

        • 409 - Conflict

        • 411 - Length Required

        • 412 - Precondition Failed

        • 416 - Range Not Satisfiable

        • 500 - Internal Server Error

        • 503 - Service Unavailable

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • errorCode

        WriteGetObjectResponseRequest.Builder errorCode​(String errorCode)

        A string that uniquely identifies an error condition. Returned in the <Code> tag of the error XML response for a corresponding GetObject call. Cannot be used with a successful StatusCode header or when the transformed object is provided in the body. All error codes from S3 are sentence-cased. The regular expression (regex) value is "^[A-Z][a-zA-Z]+$".

        Parameters:
        errorCode - A string that uniquely identifies an error condition. Returned in the <Code> tag of the error XML response for a corresponding GetObject call. Cannot be used with a successful StatusCode header or when the transformed object is provided in the body. All error codes from S3 are sentence-cased. The regular expression (regex) value is "^[A-Z][a-zA-Z]+$".
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • errorMessage

        WriteGetObjectResponseRequest.Builder errorMessage​(String errorMessage)

        Contains a generic description of the error condition. Returned in the <Message> tag of the error XML response for a corresponding GetObject call. Cannot be used with a successful StatusCode header or when the transformed object is provided in body.

        Parameters:
        errorMessage - Contains a generic description of the error condition. Returned in the <Message> tag of the error XML response for a corresponding GetObject call. Cannot be used with a successful StatusCode header or when the transformed object is provided in body.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • acceptRanges

        WriteGetObjectResponseRequest.Builder acceptRanges​(String acceptRanges)

        Indicates that a range of bytes was specified.

        Parameters:
        acceptRanges - Indicates that a range of bytes was specified.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • cacheControl

        WriteGetObjectResponseRequest.Builder cacheControl​(String cacheControl)

        Specifies caching behavior along the request/reply chain.

        Parameters:
        cacheControl - Specifies caching behavior along the request/reply chain.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • contentDisposition

        WriteGetObjectResponseRequest.Builder contentDisposition​(String contentDisposition)

        Specifies presentational information for the object.

        Parameters:
        contentDisposition - Specifies presentational information for the object.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • contentEncoding

        WriteGetObjectResponseRequest.Builder contentEncoding​(String contentEncoding)

        Specifies what content encodings have been applied to the object and thus what decoding mechanisms must be applied to obtain the media-type referenced by the Content-Type header field.

        Parameters:
        contentEncoding - Specifies what content encodings have been applied to the object and thus what decoding mechanisms must be applied to obtain the media-type referenced by the Content-Type header field.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • contentLanguage

        WriteGetObjectResponseRequest.Builder contentLanguage​(String contentLanguage)

        The language the content is in.

        Parameters:
        contentLanguage - The language the content is in.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • contentLength

        WriteGetObjectResponseRequest.Builder contentLength​(Long contentLength)

        The size of the content body in bytes.

        Parameters:
        contentLength - The size of the content body in bytes.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • contentRange

        WriteGetObjectResponseRequest.Builder contentRange​(String contentRange)

        The portion of the object returned in the response.

        Parameters:
        contentRange - The portion of the object returned in the response.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • contentType

        WriteGetObjectResponseRequest.Builder contentType​(String contentType)

        A standard MIME type describing the format of the object data.

        Parameters:
        contentType - A standard MIME type describing the format of the object data.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • checksumCRC32

        WriteGetObjectResponseRequest.Builder checksumCRC32​(String checksumCRC32)

        This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This specifies the Base64 encoded, 32-bit CRC32 checksum of the object returned by the Object Lambda function. This may not match the checksum for the object stored in Amazon S3. Amazon S3 will perform validation of the checksum values only when the original GetObject request required checksum validation. For more information about checksums, see Checking object integrity in the Amazon S3 User Guide.

        Only one checksum header can be specified at a time. If you supply multiple checksum headers, this request will fail.

        Parameters:
        checksumCRC32 - This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This specifies the Base64 encoded, 32-bit CRC32 checksum of the object returned by the Object Lambda function. This may not match the checksum for the object stored in Amazon S3. Amazon S3 will perform validation of the checksum values only when the original GetObject request required checksum validation. For more information about checksums, see Checking object integrity in the Amazon S3 User Guide.

        Only one checksum header can be specified at a time. If you supply multiple checksum headers, this request will fail.

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • checksumCRC32C

        WriteGetObjectResponseRequest.Builder checksumCRC32C​(String checksumCRC32C)

        This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This specifies the Base64 encoded, 32-bit CRC32C checksum of the object returned by the Object Lambda function. This may not match the checksum for the object stored in Amazon S3. Amazon S3 will perform validation of the checksum values only when the original GetObject request required checksum validation. For more information about checksums, see Checking object integrity in the Amazon S3 User Guide.

        Only one checksum header can be specified at a time. If you supply multiple checksum headers, this request will fail.

        Parameters:
        checksumCRC32C - This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This specifies the Base64 encoded, 32-bit CRC32C checksum of the object returned by the Object Lambda function. This may not match the checksum for the object stored in Amazon S3. Amazon S3 will perform validation of the checksum values only when the original GetObject request required checksum validation. For more information about checksums, see Checking object integrity in the Amazon S3 User Guide.

        Only one checksum header can be specified at a time. If you supply multiple checksum headers, this request will fail.

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • checksumCRC64NVME

        WriteGetObjectResponseRequest.Builder checksumCRC64NVME​(String checksumCRC64NVME)

        This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This header specifies the Base64 encoded, 64-bit CRC64NVME checksum of the part. For more information, see Checking object integrity in the Amazon S3 User Guide.

        Parameters:
        checksumCRC64NVME - This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This header specifies the Base64 encoded, 64-bit CRC64NVME checksum of the part. For more information, see Checking object integrity in the Amazon S3 User Guide.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • checksumSHA1

        WriteGetObjectResponseRequest.Builder checksumSHA1​(String checksumSHA1)

        This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This specifies the Base64 encoded, 160-bit SHA1 digest of the object returned by the Object Lambda function. This may not match the checksum for the object stored in Amazon S3. Amazon S3 will perform validation of the checksum values only when the original GetObject request required checksum validation. For more information about checksums, see Checking object integrity in the Amazon S3 User Guide.

        Only one checksum header can be specified at a time. If you supply multiple checksum headers, this request will fail.

        Parameters:
        checksumSHA1 - This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This specifies the Base64 encoded, 160-bit SHA1 digest of the object returned by the Object Lambda function. This may not match the checksum for the object stored in Amazon S3. Amazon S3 will perform validation of the checksum values only when the original GetObject request required checksum validation. For more information about checksums, see Checking object integrity in the Amazon S3 User Guide.

        Only one checksum header can be specified at a time. If you supply multiple checksum headers, this request will fail.

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • checksumSHA256

        WriteGetObjectResponseRequest.Builder checksumSHA256​(String checksumSHA256)

        This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This specifies the Base64 encoded, 256-bit SHA256 digest of the object returned by the Object Lambda function. This may not match the checksum for the object stored in Amazon S3. Amazon S3 will perform validation of the checksum values only when the original GetObject request required checksum validation. For more information about checksums, see Checking object integrity in the Amazon S3 User Guide.

        Only one checksum header can be specified at a time. If you supply multiple checksum headers, this request will fail.

        Parameters:
        checksumSHA256 - This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This specifies the Base64 encoded, 256-bit SHA256 digest of the object returned by the Object Lambda function. This may not match the checksum for the object stored in Amazon S3. Amazon S3 will perform validation of the checksum values only when the original GetObject request required checksum validation. For more information about checksums, see Checking object integrity in the Amazon S3 User Guide.

        Only one checksum header can be specified at a time. If you supply multiple checksum headers, this request will fail.

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • deleteMarker

        WriteGetObjectResponseRequest.Builder deleteMarker​(Boolean deleteMarker)

        Specifies whether an object stored in Amazon S3 is (true) or is not (false) a delete marker. To learn more about delete markers, see Working with delete markers.

        Parameters:
        deleteMarker - Specifies whether an object stored in Amazon S3 is (true) or is not (false) a delete marker. To learn more about delete markers, see Working with delete markers.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • eTag

        WriteGetObjectResponseRequest.Builder eTag​(String eTag)

        An opaque identifier assigned by a web server to a specific version of a resource found at a URL.

        Parameters:
        eTag - An opaque identifier assigned by a web server to a specific version of a resource found at a URL.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • expires

        WriteGetObjectResponseRequest.Builder expires​(Instant expires)

        The date and time at which the object is no longer cacheable.

        Parameters:
        expires - The date and time at which the object is no longer cacheable.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • expiration

        WriteGetObjectResponseRequest.Builder expiration​(String expiration)

        If the object expiration is configured (see PUT Bucket lifecycle), the response includes this header. It includes the expiry-date and rule-id key-value pairs that provide the object expiration information. The value of the rule-id is URL-encoded.

        Parameters:
        expiration - If the object expiration is configured (see PUT Bucket lifecycle), the response includes this header. It includes the expiry-date and rule-id key-value pairs that provide the object expiration information. The value of the rule-id is URL-encoded.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • lastModified

        WriteGetObjectResponseRequest.Builder lastModified​(Instant lastModified)

        The date and time that the object was last modified.

        Parameters:
        lastModified - The date and time that the object was last modified.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • missingMeta

        WriteGetObjectResponseRequest.Builder missingMeta​(Integer missingMeta)

        Set to the number of metadata entries not returned in x-amz-meta headers. This can happen if you create metadata using an API like SOAP that supports more flexible metadata than the REST API. For example, using SOAP, you can create metadata whose values are not legal HTTP headers.

        Parameters:
        missingMeta - Set to the number of metadata entries not returned in x-amz-meta headers. This can happen if you create metadata using an API like SOAP that supports more flexible metadata than the REST API. For example, using SOAP, you can create metadata whose values are not legal HTTP headers.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • metadata

        WriteGetObjectResponseRequest.Builder metadata​(Map<String,​String> metadata)

        A map of metadata to store with the object in S3.

        Parameters:
        metadata - A map of metadata to store with the object in S3.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • objectLockMode

        WriteGetObjectResponseRequest.Builder objectLockMode​(String objectLockMode)

        Indicates whether an object stored in Amazon S3 has Object Lock enabled. For more information about S3 Object Lock, see Object Lock.

        Parameters:
        objectLockMode - Indicates whether an object stored in Amazon S3 has Object Lock enabled. For more information about S3 Object Lock, see Object Lock.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        ObjectLockMode, ObjectLockMode

      • objectLockMode

        WriteGetObjectResponseRequest.Builder objectLockMode​(ObjectLockMode objectLockMode)

        Indicates whether an object stored in Amazon S3 has Object Lock enabled. For more information about S3 Object Lock, see Object Lock.

        Parameters:
        objectLockMode - Indicates whether an object stored in Amazon S3 has Object Lock enabled. For more information about S3 Object Lock, see Object Lock.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        ObjectLockMode, ObjectLockMode

      • objectLockLegalHoldStatus

        WriteGetObjectResponseRequest.Builder objectLockLegalHoldStatus​(String objectLockLegalHoldStatus)

        Indicates whether an object stored in Amazon S3 has an active legal hold.

        Parameters:
        objectLockLegalHoldStatus - Indicates whether an object stored in Amazon S3 has an active legal hold.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        ObjectLockLegalHoldStatus, ObjectLockLegalHoldStatus

      • objectLockRetainUntilDate

        WriteGetObjectResponseRequest.Builder objectLockRetainUntilDate​(Instant objectLockRetainUntilDate)

        The date and time when Object Lock is configured to expire.

        Parameters:
        objectLockRetainUntilDate - The date and time when Object Lock is configured to expire.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • partsCount

        WriteGetObjectResponseRequest.Builder partsCount​(Integer partsCount)

        The count of parts this object has.

        Parameters:
        partsCount - The count of parts this object has.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • replicationStatus

        WriteGetObjectResponseRequest.Builder replicationStatus​(String replicationStatus)

        Indicates if request involves bucket that is either a source or destination in a Replication rule. For more information about S3 Replication, see Replication.

        Parameters:
        replicationStatus - Indicates if request involves bucket that is either a source or destination in a Replication rule. For more information about S3 Replication, see Replication.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        ReplicationStatus, ReplicationStatus

      • replicationStatus

        WriteGetObjectResponseRequest.Builder replicationStatus​(ReplicationStatus replicationStatus)

        Indicates if request involves bucket that is either a source or destination in a Replication rule. For more information about S3 Replication, see Replication.

        Parameters:
        replicationStatus - Indicates if request involves bucket that is either a source or destination in a Replication rule. For more information about S3 Replication, see Replication.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        ReplicationStatus, ReplicationStatus

      • requestCharged

        WriteGetObjectResponseRequest.Builder requestCharged​(String requestCharged)
        Sets the value of the RequestCharged property for this object.
        Parameters:
        requestCharged - The new value for the RequestCharged property for this object.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        RequestCharged, RequestCharged

      • restore

        WriteGetObjectResponseRequest.Builder restore​(String restore)

        Provides information about object restoration operation and expiration time of the restored object copy.

        Parameters:
        restore - Provides information about object restoration operation and expiration time of the restored object copy.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • serverSideEncryption

        WriteGetObjectResponseRequest.Builder serverSideEncryption​(String serverSideEncryption)

        The server-side encryption algorithm used when storing requested object in Amazon S3 (for example, AES256, aws:kms).

        Parameters:
        serverSideEncryption - The server-side encryption algorithm used when storing requested object in Amazon S3 (for example, AES256, aws:kms).
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        ServerSideEncryption, ServerSideEncryption

      • serverSideEncryption

        WriteGetObjectResponseRequest.Builder serverSideEncryption​(ServerSideEncryption serverSideEncryption)

        The server-side encryption algorithm used when storing requested object in Amazon S3 (for example, AES256, aws:kms).

        Parameters:
        serverSideEncryption - The server-side encryption algorithm used when storing requested object in Amazon S3 (for example, AES256, aws:kms).
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        ServerSideEncryption, ServerSideEncryption

      • sseCustomerAlgorithm

        WriteGetObjectResponseRequest.Builder sseCustomerAlgorithm​(String sseCustomerAlgorithm)

        Encryption algorithm used if server-side encryption with a customer-provided encryption key was specified for object stored in Amazon S3.

        Parameters:
        sseCustomerAlgorithm - Encryption algorithm used if server-side encryption with a customer-provided encryption key was specified for object stored in Amazon S3.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • ssekmsKeyId

        WriteGetObjectResponseRequest.Builder ssekmsKeyId​(String ssekmsKeyId)

        If present, specifies the ID (Key ID, Key ARN, or Key Alias) of the Amazon Web Services Key Management Service (Amazon Web Services KMS) symmetric encryption customer managed key that was used for stored in Amazon S3 object.

        Parameters:
        ssekmsKeyId - If present, specifies the ID (Key ID, Key ARN, or Key Alias) of the Amazon Web Services Key Management Service (Amazon Web Services KMS) symmetric encryption customer managed key that was used for stored in Amazon S3 object.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • storageClass

        WriteGetObjectResponseRequest.Builder storageClass​(String storageClass)

        Provides storage class information of the object. Amazon S3 returns this header for all objects except for S3 Standard storage class objects.

        For more information, see Storage Classes.

        Parameters:
        storageClass - Provides storage class information of the object. Amazon S3 returns this header for all objects except for S3 Standard storage class objects.

        For more information, see Storage Classes.

        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        StorageClass, StorageClass

      • storageClass

        WriteGetObjectResponseRequest.Builder storageClass​(StorageClass storageClass)

        Provides storage class information of the object. Amazon S3 returns this header for all objects except for S3 Standard storage class objects.

        For more information, see Storage Classes.

        Parameters:
        storageClass - Provides storage class information of the object. Amazon S3 returns this header for all objects except for S3 Standard storage class objects.

        For more information, see Storage Classes.

        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        StorageClass, StorageClass

      • tagCount

        WriteGetObjectResponseRequest.Builder tagCount​(Integer tagCount)

        The number of tags, if any, on the object.

        Parameters:
        tagCount - The number of tags, if any, on the object.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • versionId

        WriteGetObjectResponseRequest.Builder versionId​(String versionId)

        An ID used to reference a specific version of the object.

        Parameters:
        versionId - An ID used to reference a specific version of the object.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • bucketKeyEnabled

        WriteGetObjectResponseRequest.Builder bucketKeyEnabled​(Boolean bucketKeyEnabled)

        Indicates whether the object stored in Amazon S3 uses an S3 bucket key for server-side encryption with Amazon Web Services KMS (SSE-KMS).

        Parameters:
        bucketKeyEnabled - Indicates whether the object stored in Amazon S3 uses an S3 bucket key for server-side encryption with Amazon Web Services KMS (SSE-KMS).
        Returns:
        Returns a reference to this object so that method calls can be chained together.