Class ListObjectsV2Request

    • Constructor Detail

      • ListObjectsV2Request

        public ListObjectsV2Request()
    • Method Detail

      • getBucketName

        public String getBucketName()
        Gets the name of the Amazon S3 bucket whose objects are to be listed.
        Returns:
        The name of the Amazon S3 bucket whose objects are to be listed.
      • setBucketName

        public void setBucketName​(String bucketName)
        Sets the name of the Amazon S3 bucket whose objects are to be listed.
        Parameters:
        bucketName - The name of the Amazon S3 bucket whose objects are to be listed.
      • withBucketName

        public ListObjectsV2Request withBucketName​(String bucketName)
        Sets the name of the Amazon S3 bucket whose objects are to be listed. Returns this ListObjectsV2Request, enabling additional method calls to be chained together.
        Parameters:
        bucketName - The name of the Amazon S3 bucket whose objects are to be listed.
        Returns:
        This ListObjectsV2Request, enabling additional method calls to be chained together.
      • getDelimiter

        public String getDelimiter()
        Gets the optional delimiter parameter that causes keys that contain the same string between the prefix and the first occurrence of the delimiter to be combined into a single result element in the ListObjectsV2Result.getCommonPrefixes() list. These combined keys are not returned elsewhere in the response. The most commonly used delimiter is "/", which simulates a hierarchical organization similar to a file system directory structure.
        Returns:
        The optional delimiter parameter that causes keys that contain the same string between the prefix and the first occurrence of the delimiter to be combined into a single result element in the ListObjectsV2Result.getCommonPrefixes() list.
      • setDelimiter

        public void setDelimiter​(String delimiter)
        Sets the optional delimiter parameter that causes keys that contain the same string between the prefix and the first occurrence of the delimiter to be combined into a single result element in the ListObjectsV2Result.getCommonPrefixes() list.
        Parameters:
        delimiter - The optional delimiter parameter that causes keys that contain the same string between the prefix and the first occurrence of the delimiter to be combined into a single result element in the ListObjectsV2Result.getCommonPrefixes() list.
      • withDelimiter

        public ListObjectsV2Request withDelimiter​(String delimiter)
        Sets the optional delimiter parameter that causes keys that contain the same string between the prefix and the first occurrence of the delimiter to be rolled up into a single result element in the ListObjectsV2Result.getCommonPrefixes() list. Returns this ListObjectsRequest, enabling additional method calls to be chained together.
        Parameters:
        delimiter - The optional delimiter parameter that causes keys that contain the same string between the prefix and the first occurrence of the delimiter to be rolled up into a single result element in the ListObjectsV2Result.getCommonPrefixes() list.
        Returns:
        This ListObjectsRequest, enabling additional method calls to be chained together.
      • getEncodingType

        public String getEncodingType()
        Gets the optional encodingType parameter indicating the encoding method to be applied on the response.
        Returns:
        The encoding method to be applied on the response.
      • setEncodingType

        public void setEncodingType​(String encodingType)
        Sets the optional encodingType parameter indicating the encoding method to be applied on the response. An object key can contain any Unicode character; however, XML 1.0 parser cannot parse some characters, such as characters with an ASCII value from 0 to 10. For characters that are not supported in XML 1.0, you can add this parameter to request that Amazon S3 encode the keys in the response.
        Parameters:
        encodingType - The encoding method to be applied on the response. Valid values: null (not encoded) or "url".
      • withEncodingType

        public ListObjectsV2Request withEncodingType​(String encodingType)
        Sets the optional encodingType parameter indicating the encoding method to be applied on the response. An object key can contain any Unicode character; however, XML 1.0 parser cannot parse some characters, such as characters with an ASCII value from 0 to 10. For characters that are not supported in XML 1.0, you can add this parameter to request that Amazon S3 encode the keys in the response. Returns this ListObjectsV2Request, enabling additional method calls to be chained together.
        Parameters:
        encodingType - The encoding method to be applied on the response. Valid values: null (not encoded) or "url".
      • getMaxKeys

        public Integer getMaxKeys()
        Gets the optional maxKeys parameter indicating the maximum number of keys to include in the response. Amazon S3 might return fewer keys than specified, but will never return more. Even if the optional parameter is not specified, Amazon S3 will limit the number of results in the response.
        Returns:
        The optional parameter indicating the maximum number of keys to include in the response.
      • setMaxKeys

        public void setMaxKeys​(Integer maxKeys)
        Sets the optional maxKeys parameter indicating the maximum number of keys to include in the response.
        Parameters:
        maxKeys - The optional parameter indicating the maximum number of keys to include in the response.
      • withMaxKeys

        public ListObjectsV2Request withMaxKeys​(Integer maxKeys)
        Sets the optional maxKeys parameter indicating the maximum number of keys to include in the response. Returns this ListObjectsV2Request, enabling additional method calls to be chained together.
        Parameters:
        maxKeys - The optional parameter indicating the maximum number of keys to include in the response.
        Returns:
        This ListObjectsV2Request, enabling additional method calls to be chained together.
        See Also:
        getMaxKeys(), setMaxKeys(Integer)
      • getPrefix

        public String getPrefix()
        Gets the optional prefix parameter and restricts the response to keys that begin with the specified prefix. Use prefixes to separate a bucket into different sets of keys, similar to how a file system organizes files into directories.
        Returns:
        The optional prefix parameter restricting the response to keys that begin with the specified prefix.
        See Also:
        setPrefix(String)
      • setPrefix

        public void setPrefix​(String prefix)
        Sets the optional prefix parameter, restricting the response to keys that begin with the specified prefix.
        Parameters:
        prefix - The optional prefix parameter, restricting the response to keys that begin with the specified prefix.
        See Also:
        getPrefix()
      • withPrefix

        public ListObjectsV2Request withPrefix​(String prefix)
        Sets the optional prefix parameter restricting the response to keys that begin with the specified prefix. Returns this ListObjectsV2Request, enabling additional method calls to be chained together.
        Parameters:
        prefix - The optional prefix parameter restricting the response to keys that begin with the specified prefix.
        Returns:
        This ListObjectsV2Request, enabling additional method calls to be chained together.
        See Also:
        getPrefix(), setPrefix(String)
      • getContinuationToken

        public String getContinuationToken()
        Gets the optional continuation token. Continuation token allows a list to be continued from a specific point. ContinuationToken is provided in truncated list results.
        Returns:
        The optional continuation token associated with this request.
      • setContinuationToken

        public void setContinuationToken​(String continuationToken)
        Sets the optional continuation token. Continuation token allows a list to be continued from a specific point. ContinuationToken is provided in truncated list results.
        Parameters:
        continuationToken - The optional continuation token to associate with this request.
      • withContinuationToken

        public ListObjectsV2Request withContinuationToken​(String continuationToken)
        Sets the optional continuation token. Continuation token allows a list to be continued from a specific point. ContinuationToken is provided in truncated list results.
        Parameters:
        continuationToken - The optional continuation token to associate with this request.
        Returns:
        This ListObjectsV2Request, enabling additional method calls to be chained together.
      • isFetchOwner

        public boolean isFetchOwner()
        Returns if fetch owner is set. The owner field is not present in ListObjectsV2 results by default. If this flag is set to true the owner field will be included.
        Returns:
        whether fetchOwner is set
      • setFetchOwner

        public void setFetchOwner​(boolean fetchOwner)
        Sets the optional fetch owner flag. The owner field is not present in ListObjectsV2 results by default. If this flag is set to true the owner field will be included.
        Parameters:
        fetchOwner - Set to true if the owner field should be included in results
      • withFetchOwner

        public ListObjectsV2Request withFetchOwner​(boolean fetchOwner)
        Sets the optional fetch owner flag. The owner field is not present in ListObjectsV2 results by default. If this flag is set to true the owner field will be included.
        Parameters:
        fetchOwner - Set to true if the owner field should be included in results
        Returns:
        This ListObjectsV2Request, enabling additional method calls to be chained together.
      • getStartAfter

        public String getStartAfter()
        Returns optional parameter indicating where you want Amazon S3 to start the object listing from. This can be any key in the bucket.
        Returns:
        the optional startAfter parameter
      • setStartAfter

        public void setStartAfter​(String startAfter)
        Sets the optional parameter indicating where you want Amazon S3 to start the object listing from. This can be any key in the bucket.
        Parameters:
        startAfter - The optional startAfter parameter. This can be any key in the bucket.
      • withStartAfter

        public ListObjectsV2Request withStartAfter​(String startAfter)
        Sets the optional parameter indicating where you want Amazon S3 to start the object listing from. This can be any key in the bucket.
        Parameters:
        startAfter - The optional startAfter parameter. This can be any key in the bucket.
        Returns:
        This ListObjectsV2Request, enabling additional method calls to be chained together.