Class GetObjectAclRequest

    • Constructor Detail

      • GetObjectAclRequest

        public GetObjectAclRequest​(String bucketName,
                                   String key)
      • GetObjectAclRequest

        public GetObjectAclRequest​(String bucketName,
                                   String key,
                                   String versionId)
    • Method Detail

      • getBucketName

        public String getBucketName()
        Gets the name of the bucket containing the object whose ACL is to be retrieved.
        Returns:
        The name of the bucket containing the object whose ACL is to be retrieved.
        See Also:
        setBucketName(String), withBucket(String)
      • setBucketName

        public void setBucketName​(String bucketName)
        Sets the name of the bucket containing the object whose ACL is to be retrieved.
        Parameters:
        bucketName - The name of the bucket containing the object whose ACL is to be retrieved.
        See Also:
        getBucketName(), withBucket(String)
      • getKey

        public String getKey()
        Gets the key under which the object whose ACL to be retrieved is stored.
        Returns:
        The key under which the object whose ACL to be retrieved is stored.
        See Also:
        setKey(String), withKey(String)
      • setKey

        public void setKey​(String key)
        Sets the key under which the object whose ACL to be retrieved is stored.
        Parameters:
        key - The key under which the object whose ACL to be retrieved is stored.
        See Also:
        getKey(), withKey(String)
      • withKey

        public GetObjectAclRequest withKey​(String key)
        Sets the key under which the object whose ACL to be retrieved is stored. Returns this GetObjectAclRequest, enabling additional method calls to be chained together.
        Parameters:
        key - The key under which the object whose ACL to be retrieved is stored.
        Returns:
        This GetObjectAclRequest, enabling additional method calls to be chained together.
        See Also:
        getKey(), setKey(String)
      • getVersionId

        public String getVersionId()

        Gets the optional version ID specifying which version of the object whose ACL to be retrieved. If not specified, the most recent version's ACL will be retrieved.

        Objects created before versioning was enabled or when versioning is suspended are given the default null version ID (see Constants.NULL_VERSION_ID). Note that the null version ID is a valid version ID and is not the same as not having a version ID.

        For more information about enabling versioning for a bucket, see AmazonS3.setBucketVersioningConfiguration(SetBucketVersioningConfigurationRequest).

        Returns:
        The optional version ID specifying which version of the object whose ACL to be retrieved. If not specified, the most recent version will be retrieved.
        See Also:
        setVersionId(String), withVersionId(String)
      • setVersionId

        public void setVersionId​(String versionId)
        Sets the optional version ID specifying which version of the object whose ACL to be retrieved. If not specified, the most recent version's ACL will be retrieved.

        Objects created before versioning was enabled or when versioning is suspended will be given the default null version ID (see Constants.NULL_VERSION_ID). Note that the null version ID is a valid version ID and is not the same as not having a version ID.

        For more information about enabling versioning for a bucket, see AmazonS3.setBucketVersioningConfiguration(SetBucketVersioningConfigurationRequest).

        Parameters:
        versionId - The optional version ID specifying which version of the object whose ACL to be retrieved.
        See Also:
        getVersionId(), withVersionId(String)
      • withVersionId

        public GetObjectAclRequest withVersionId​(String versionId)

        Sets the optional version ID specifying which version of the object whose ACL to be retrieved and returns this GetObjectAclRequest, enabling additional method calls to be chained together. If not specified, the most recent version's ACL will be retrieved.

        Objects created before versioning was enabled or when versioning is suspended will be given the default or null version ID (see Constants.NULL_VERSION_ID). Note that the null version ID is a valid version ID and is not the same as not having a version ID.

        For more information about enabling versioning for a bucket, see AmazonS3.setBucketVersioningConfiguration(SetBucketVersioningConfigurationRequest).

        Parameters:
        versionId - The optional version ID specifying which version of the object whose ACL is to be retrieved.
        Returns:
        The updated request object, 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 conducting this operation from Requester Pays Bucket; else false.

        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

        Returns:
        true if the user has enabled Requester Pays option for conducting this operation from Requester Pays Bucket.
      • setRequesterPays

        public void setRequesterPays​(boolean isRequesterPays)
        Used for conducting this operation from a Requester Pays Bucket. If set the requester is charged for requests from the bucket.

        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.
      • withRequesterPays

        public GetObjectAclRequest 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 GetObjectAclRequest 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 GetObjectAclRequest object.