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

Interface GetObjectAttributesRequest.Builder

    • Method Detail

      • bucket

        GetObjectAttributesRequest.Builder bucket​(String bucket)

        The name of the bucket that contains the object.

        When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.

        When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com . When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts? in the Amazon S3 User Guide.

        Parameters:
        bucket - The name of the bucket that contains the object.

        When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.

        When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com . When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts? in the Amazon S3 User Guide.

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

      • key

        GetObjectAttributesRequest.Builder key​(String key)

        The object key.

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

      • versionId

        GetObjectAttributesRequest.Builder versionId​(String versionId)

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

        Parameters:
        versionId - The version 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.

      • maxParts

        GetObjectAttributesRequest.Builder maxParts​(Integer maxParts)

        Sets the maximum number of parts to return.

        Parameters:
        maxParts - Sets the maximum number of parts to return.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • partNumberMarker

        GetObjectAttributesRequest.Builder partNumberMarker​(Integer partNumberMarker)

        Specifies the part after which listing should begin. Only parts with higher part numbers will be listed.

        Parameters:
        partNumberMarker - Specifies the part after which listing should begin. Only parts with higher part numbers will be listed.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • sseCustomerAlgorithm

        GetObjectAttributesRequest.Builder sseCustomerAlgorithm​(String sseCustomerAlgorithm)

        Specifies the algorithm to use when encrypting the object (for example, AES256).

        Parameters:
        sseCustomerAlgorithm - Specifies the algorithm to use when encrypting the object (for example, AES256).
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • sseCustomerKey

        GetObjectAttributesRequest.Builder sseCustomerKey​(String sseCustomerKey)

        Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data. This value is used to store the object and then it is discarded; Amazon S3 does not store the encryption key. The key must be appropriate for use with the algorithm specified in the x-amz-server-side-encryption-customer-algorithm header.

        Parameters:
        sseCustomerKey - Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data. This value is used to store the object and then it is discarded; Amazon S3 does not store the encryption key. The key must be appropriate for use with the algorithm specified in the x-amz-server-side-encryption-customer-algorithm header.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • sseCustomerKeyMD5

        GetObjectAttributesRequest.Builder sseCustomerKeyMD5​(String sseCustomerKeyMD5)

        Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses this header for a message integrity check to ensure that the encryption key was transmitted without error.

        Parameters:
        sseCustomerKeyMD5 - Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses this header for a message integrity check to ensure that the encryption key was transmitted without error.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • requestPayer

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

      • requestPayer

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

      • expectedBucketOwner

        GetObjectAttributesRequest.Builder expectedBucketOwner​(String expectedBucketOwner)

        The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

        Parameters:
        expectedBucketOwner - The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • objectAttributesWithStrings

        GetObjectAttributesRequest.Builder objectAttributesWithStrings​(Collection<String> objectAttributes)

        Specifies the fields at the root level that you want returned in the response. Fields that you do not specify are not returned.

        Parameters:
        objectAttributes - Specifies the fields at the root level that you want returned in the response. Fields that you do not specify are not returned.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • objectAttributesWithStrings

        GetObjectAttributesRequest.Builder objectAttributesWithStrings​(String... objectAttributes)

        Specifies the fields at the root level that you want returned in the response. Fields that you do not specify are not returned.

        Parameters:
        objectAttributes - Specifies the fields at the root level that you want returned in the response. Fields that you do not specify are not returned.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • objectAttributes

        GetObjectAttributesRequest.Builder objectAttributes​(Collection<ObjectAttributes> objectAttributes)

        Specifies the fields at the root level that you want returned in the response. Fields that you do not specify are not returned.

        Parameters:
        objectAttributes - Specifies the fields at the root level that you want returned in the response. Fields that you do not specify are not returned.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • objectAttributes

        GetObjectAttributesRequest.Builder objectAttributes​(ObjectAttributes... objectAttributes)

        Specifies the fields at the root level that you want returned in the response. Fields that you do not specify are not returned.

        Parameters:
        objectAttributes - Specifies the fields at the root level that you want returned in the response. Fields that you do not specify are not returned.
        Returns:
        Returns a reference to this object so that method calls can be chained together.