Start line:  
End line:  

Snippet Preview

Snippet HTML Code

Stack Overflow Questions
  /*
   * Copyright 2010-2015 Amazon.com, Inc. or its affiliates. All Rights Reserved.
   *
   * Licensed under the Apache License, Version 2.0 (the "License").
   * You may not use this file except in compliance with the License.
   * A copy of the License is located at
   *
   *  http://aws.amazon.com/apache2.0
   *
  * or in the "license" file accompanying this file. This file is distributed
  * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
  * express or implied. See the License for the specific language governing
  * permissions and limitations under the License.
  */
 package com.amazonaws.services.s3.model;
 
Container for the parameters of the ListMultipartUploads operation.

Required Parameters: BucketName

 
 public class ListMultipartUploadsRequest extends AmazonWebServiceRequest {

    
The name of the bucket containing the uploads to list.
 
     private String bucketName;

Optional parameter that causes multipart uploads for 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 MultipartUploadListing.getCommonPrefixes() list. These rolled-up 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.
 
     private String delimiter;

Optional parameter restricting the response to multipart uploads for keys which begin with the specified prefix. You can use prefixes to separate a bucket into different sets of keys in a way similar to how a file system uses folders.
 
     private String prefix;

    
The optional maximum number of uploads to return.
 
     private Integer maxUploads;

    
The optional key marker indicating where in the results to begin listing.

Together with the upload ID marker, specifies the multipart upload after which listing should begin.

If the upload ID marker is not specified, only the keys lexicographically greater than the specified key-marker will be included in the list.

If the upload ID marker is specified, any multipart uploads for a key equal to the key-marker may also be included, provided those multipart uploads have upload IDs lexicographically greater than the specified marker.

 
     private String keyMarker;

    
The optional upload ID marker indicating where in the results to begin listing.

Together with the key marker, specifies the multipart upload after which listing should begin. If no key marker is specified, the upload ID marker is ignored. Otherwise, any multipart uploads for a key equal to the key marker may be included in the list only if they have an upload ID lexicographically greater than the specified marker.

 
     private String uploadIdMarker;
    
    
Optional 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.
 
     private String encodingType;


    
Constructs a new ListMultipartUploadsRequest to list the multipart uploads from the specified bucket.

Parameters:
bucketName The name of the bucket containing the uploads to list.
 
    public ListMultipartUploadsRequest(String bucketName) {
        this. = bucketName;
    }


    
Returns the name of the bucket containing the uploads to list.

Returns:
The name of the bucket containing the uploads to list.
    public String getBucketName() {
        return ;
    }

    
Sets the name of the bucket containing the multipart uploads to list.

Parameters:
bucketName The name of the bucket containing the uploads to list.
    public void setBucketName(String bucketName) {
        this. = bucketName;
    }

    
Sets The name of the bucket containing the uploads to list, and returns this updated ListMultipartUploadsRequest object so that additional method calls can be chained together.

Parameters:
bucketName The name of the bucket containing the uploads to list.
Returns:
This updated ListMultipartUploadsRequest object.
    public ListMultipartUploadsRequest withBucketName(String bucketName) {
        this. = bucketName;
        return this;
    }

    
Returns the optional maximum number of uploads to return, or null if no maximum number of uploads has been set for this request.

Returns:
The optional maximum number of uploads to return.
    public Integer getMaxUploads() {
        return ;
    }

    
Sets the optional maximum number of uploads to return.

Parameters:
maxUploads The maximum number of uploads to return.
    public void setMaxUploads(Integer maxUploads) {
        this. = maxUploads;
    }

    
Sets the optional maximum number of uploads to return and returns this updated ListMultipartUploadsRequest object so that additional method calls can be chained together.

Parameters:
maxUploadsInt The optional maximum number of uploads to return.
Returns:
This updated ListMultipartUploadsRequest object.
    public ListMultipartUploadsRequest withMaxUploads(int maxUploadsInt) {
        this. = maxUploadsInt;
        return this;
    }

    
Returns the optional key marker indicating where in the results to begin listing.

Together with the upload ID marker, specifies the multipart upload after which listing should begin.

If the upload ID marker is not specified, only the keys lexicographically greater than the specified key-marker will be included in the list.

If the upload ID marker is specified, any multipart uploads for a key equal to the key-marker may also be included, provided those multipart uploads have upload IDs lexicographically greater than the specified marker.

Returns:
The optional key marker indicating where in the results to begin listing.
    public String getKeyMarker() {
        return ;
    }

    
Sets the optional key marker indicating where in the results to begin listing.

Together with the upload ID marker, specifies the multipart upload after which listing should begin.

If the upload ID marker is not specified, only the keys lexicographically greater than the specified key-marker will be included in the list.

If the upload ID marker is specified, any multipart uploads for a key equal to the key-marker may also be included, provided those multipart uploads have upload IDs lexicographically greater than the specified marker.

Parameters:
keyMarker The optional key marker indicating where in the results to begin listing.
    public void setKeyMarker(String keyMarker) {
        this. = keyMarker;
    }

    
Sets the KeyMarker property for this request.

Parameters:
keyMarker The value that KeyMarker is set to
Returns:
the request with the KeyMarker set
    public ListMultipartUploadsRequest withKeyMarker(String keyMarker) {
        this. = keyMarker;
        return this;
    }

    
Returns the optional upload ID marker indicating where in the results to begin listing.

Together with the key marker, specifies the multipart upload after which listing should begin. If no key marker is specified, the upload ID marker is ignored. Otherwise, any multipart uploads for a key equal to the key marker may be included in the list only if they have an upload ID lexicographically greater than the specified marker.

Returns:
The optional upload ID marker indicating where in the results to begin listing.
    public String getUploadIdMarker() {
        return ;
    }

    
Sets the optional upload ID marker indicating where in the results to begin listing.

Together with the key marker, specifies the multipart upload after which listing should begin. If no key marker is specified, the upload ID marker is ignored. Otherwise, any multipart uploads for a key equal to the key marker may be included in the list only if they have an upload ID lexicographically greater than the specified marker.

Parameters:
uploadIdMarker The optional upload ID marker indicating where in the results to begin listing.
    public void setUploadIdMarker(String uploadIdMarker) {
        this. = uploadIdMarker;
    }

    
Sets the optional upload ID marker indicating where in the results to begin listing and returns this updated ListMultipartUploadsRequest object so that additional methods can be chained together.

Together with the key marker, specifies the multipart upload after which listing should begin. If no key marker is specified, the upload ID marker is ignored. Otherwise, any multipart uploads for a key equal to the key marker may be included in the list only if they have an upload ID lexicographically greater than the specified marker.

Parameters:
uploadIdMarker The optional upload ID marker indicating where in the results to begin listing.
Returns:
This updated ListMultipartUploadsRequest object.
    public ListMultipartUploadsRequest withUploadIdMarker(String uploadIdMarker) {
        this. = uploadIdMarker;
        return this;
    }

Returns the optional delimiter parameter that causes multipart uploads for 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 MultipartUploadListing.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 multipart uploads for 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 MultipartUploadListing.getCommonPrefixes() list.
    public String getDelimiter() {
        return ;
    }

Sets the optional delimiter parameter that causes multipart uploads for 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 MultipartUploadListing.getCommonPrefixes() list.

Parameters:
delimiter The optional delimiter parameter that causes multipart uploads for 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 MultipartUploadListing.getCommonPrefixes() list.
    public void setDelimiter(String delimiter) {
        this. = delimiter;
    }

Sets the optional delimiter parameter that causes multipart uploads for 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 MultipartUploadListing.getCommonPrefixes() list. Returns this ListMultipartUploadsRequest, enabling additional method calls to be chained together.

Parameters:
delimiter The optional delimiter parameter that causes multipart uploads for 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 MultipartUploadListing.getCommonPrefixes() list.
Returns:
This ListMultipartUploadsRequest, enabling additional method calls to be chained together.
    public ListMultipartUploadsRequest withDelimiter(String delimiter) {
        setDelimiter(delimiter);
        return this;
    }

Returns the optional prefix parameter that restricts the response to multipart uploads for 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 multipart uploads for keys that begin with the specified prefix.
    public String getPrefix() {
        return ;
    }

Sets the optional prefix parameter, restricting the response to multipart uploads for keys that begin with the specified prefix.

Parameters:
prefix The optional prefix parameter, restricting the response to multipart uploads for keys that begin with the specified prefix.
    public void setPrefix(String prefix) {
        this. = prefix;
    }

Sets the optional prefix parameter restricting the response to multipart uploads for keys that begin with the specified prefix. Returns this ListMultipartUploadsRequest, enabling additional method calls to be chained together.

Parameters:
prefix The optional prefix parameter restricting the response to multipart uploads for keys that begin with the specified prefix.
Returns:
This ListMultipartUploadsRequest, enabling additional method calls to be chained together.
    public ListMultipartUploadsRequest withPrefix(String prefix) {
        setPrefix(prefix);
        return this;
    }
    
    
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.
    public String getEncodingType() {
        return ;
    }

    
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".
    public void setEncodingType(String encodingType) {
        this. = 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 ListMultipartUploadsRequest, 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".
    public ListMultipartUploadsRequest withEncodingType(String encodingType) {
        setEncodingType(encodingType);
        return this;
    }
New to GrepCode? Check out our FAQ X