Class GetObjectMetadataRequest

    • Method Detail

      • setBucketName

        public void setBucketName​(String bucketName)
        Sets the name of the bucket containing the object whose metadata is being retrieved.
        Parameters:
        bucketName - The name of the bucket containing the object's whose metadata is being retrieved.
        See Also:
        getBucketName(), withBucketName(String)
      • getKey

        public String getKey()
        Gets the key of the object whose metadata is being retrieved.
        Returns:
        The key of the object whose metadata is being retrieved.
        See Also:
        setKey(String), withKey(String)
      • setKey

        public void setKey​(String key)
        Sets the key of the object whose metadata is being retrieved.
        Parameters:
        key - The key of the object whose metadata is being retrieved.
        See Also:
        getKey(), withKey(String)
      • getVersionId

        public String getVersionId()
        Gets the optional version ID of the object version whose metadata is being retrieved. If not specified, the latest version will be used.
        Returns:
        The optional version ID of the object version whose metadata is being retrieved. If not specified, the latest version will be used.
        See Also:
        setVersionId(String), withVersionId(String)
      • setVersionId

        public void setVersionId​(String versionId)
        Sets the optional version ID of the object version whose metadata is being retrieved. If not specified, the latest version will be used.
        Parameters:
        versionId - The optional version ID of the object version whose metadata is being retrieved. If not specified, the latest version will be used.
        See Also:
        getVersionId(), withVersionId(String)
      • withVersionId

        public GetObjectMetadataRequest withVersionId​(String versionId)
        Sets the optional version ID of the object version whose metadata is being retrieved. Returns this GetObjectMetadataRequest, enabling additional method calls to be chained together. If not specified, the latest version will be used.
        Parameters:
        versionId - The optional version ID of the object version whose metadata is being retrieved.
        Returns:
        This GetObjectMetadataRequest, enabling additional method calls to be chained together.
        See Also:
        getVersionId(), setVersionId(String)
      • isRequesterPays

        public boolean isRequesterPays()
        Returns true if the user has enabled Requester Pays option when downloading the object metadata from Requester Pays Bucket; else false.

        If a bucket is enabled for Requester Pays, then any attempt to read an object from it without Requester Pays enabled will result in a 403 error and the bucket owner will be charged for the request.

        Enabling Requester Pays disables the ability to have anonymous access to this bucket

        Returns:
        true if the user has enabled Requester Pays option for downloading the object metadata from Requester Pays Bucket.
      • setRequesterPays

        public void setRequesterPays​(boolean isRequesterPays)
        Used for downloading an Amazon S3 Object metadata from a Requester Pays Bucket. If set the requester is charged for downloading the data from the bucket.

        If a bucket is enabled for Requester Pays, then any attempt to read an object metadata from it without Requester Pays enabled will result in a 403 error and the bucket owner will be charged for the request.

        Enabling Requester Pays disables the ability to have anonymous access to this bucket

        Parameters:
        isRequesterPays - Enable Requester Pays option for the operation.
      • withRequesterPays

        public GetObjectMetadataRequest withRequesterPays​(boolean isRequesterPays)
        Used for conducting this operation from a Requester Pays Bucket. If set the requester is charged for requests from the bucket. It returns this updated GetObjectMetadataRequest object so that additional method calls can be chained together.

        If a bucket is enabled for Requester Pays, then any attempt to upload or download an object from it without Requester Pays enabled will result in a 403 error and the bucket owner will be charged for the request.

        Enabling Requester Pays disables the ability to have anonymous access to this bucket.

        Parameters:
        isRequesterPays - Enable Requester Pays option for the operation.
        Returns:
        The updated GetObjectMetadataRequest object.
      • getSSECustomerKey

        public SSECustomerKey getSSECustomerKey()
        Description copied from interface: SSECustomerKeyProvider
        Returns the optional customer-provided server-side encryption key to use to encrypt the uploaded object.
        Specified by:
        getSSECustomerKey in interface SSECustomerKeyProvider
        Returns:
        The optional customer-provided server-side encryption key to use to encrypt the uploaded object.
      • setSSECustomerKey

        public void setSSECustomerKey​(SSECustomerKey sseKey)
        Sets the optional customer-provided server-side encryption key to use when retrieving the metadata of a server-side encrypted object.
        Parameters:
        sseKey - The optional customer-provided server-side encryption key to use when retrieving the metadata of a server-side encrypted object.
      • withSSECustomerKey

        public GetObjectMetadataRequest withSSECustomerKey​(SSECustomerKey sseKey)
        Sets the optional customer-provided server-side encryption key to use when retrieving the metadata of a server-side encrypted object, and retuns the updated request object so that additional method calls can be chained together.
        Parameters:
        sseKey - The optional customer-provided server-side encryption key to use when retrieving the metadata of a server-side encrypted object.
        Returns:
        This updated request object so that additional method calls can be chained together.
      • setPartNumber

        public void setPartNumber​(Integer partNumber)

        Sets the optional part number to find the number of parts of an object.

        To find the number of parts of an object, set partNumber to 1 and observe the x-amz-mp-parts-count response. If the object exists and x-amz-mp-parts-count is missing it's implicitly 1. Otherwise number of parts is equal to the value returned by x-amz-mp-parts-count.

        The valid range for part number is 1 - 10000 inclusive. For partNumber < 1, an AmazonS3Exception is thrown with response code 400 bad request For partNumber larger than actual part count, an AmazonS3Exception is thrown with response code 416 Request Range Not Satisfiable

        Parameters:
        partNumber - The part number representing a part in a multipart object.
        See Also:
        getPartNumber(), withPartNumber(Integer)
      • withPartNumber

        public GetObjectMetadataRequest withPartNumber​(Integer partNumber)

        Sets the optional part number to find the number of parts of an object.

        To find the number of parts of an object, set partNumber to 1 and observe the x-amz-mp-parts-count response. If the object exists and x-amz-mp-parts-count is missing it's implicitly 1. Otherwise number of parts is equal to the value returned by x-amz-mp-parts-count.

        The valid range for part number is 1 - 10000 inclusive. For partNumber < 1, an AmazonS3Exception is thrown with response code 400 bad request For partNumber larger than actual part count, an AmazonS3Exception is thrown with response code 416 Request Range Not Satisfiable

        Parameters:
        partNumber - The part number representing a part in a multipart object.
        Returns:
        This GetObjectRequest, enabling additional method calls to be chained together.
        See Also:
        getPartNumber(), setPartNumber(Integer)