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 the parameters of the ListParts operation.

Required Parameters: BucketName, Key, UploadId

 
 public class ListPartsRequest extends AmazonWebServiceRequest {

    
The name of the bucket containing the multipart upload whose parts are being listed.
 
     private String bucketName;

    
The key of the associated multipart upload whose parts are being listed.
 
     private String key;

    
The ID of the multipart upload whose parts are being listed.
 
     private String uploadId;

    
The optional maximum number of parts to be returned in the part listing.
 
     private Integer maxParts;

    
The optional part number marker indicating where in the results to being listing parts.
 
     private Integer partNumberMarker;

    
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 ListPartsRequest from the required parameters bucket name, key and upload ID.

Parameters:
bucketName The name of the bucket containing the parts to list.
key The key of the associated multipart upload whose parts are being listed.
uploadId The ID of the multipart upload whose parts are being listed.
 
     public ListPartsRequest(String bucketNameString keyString uploadId) {
         this. = bucketName;
         this. = key;
         this. = uploadId;
     }


    
Returns the name of the bucket containing the multipart upload whose parts are being listed.

Returns:
The name of the bucket containing the multipart upload whose parts are being listed.
 
     public String getBucketName() {
         return ;
     }

    
Sets the name of the bucket containing the multipart upload whose parts are being listed.

Parameters:
bucketName The name of the bucket containing the multipart upload whose parts are being listed.
 
     public void setBucketName(String bucketName) {
         this. = bucketName;
     }

    
Sets the BucketName property for this request.

Parameters:
bucketName The value that BucketName is set to
Returns:
the request with the BucketName set
    public ListPartsRequest withBucketName(String bucketName) {
        this. = bucketName;
        return this;
    }

    
Returns the key of the associated multipart upload whose parts are being listed.

Returns:
The key of the associated multipart upload whose parts are being listed.
    public String getKey() {
        return ;
    }

    
Sets the key of the associated multipart upload whose parts are being listed.

Parameters:
key The key of the associated multipart upload whose parts are being listed.
    public void setKey(String key) {
        this. = key;
    }

    
Sets the key of the associated multipart upload whose parts are being listed, and returns this updated ListPartsRequest object so that additional method calls can be chained together.

Parameters:
key The key of the associated multipart upload whose parts are being listed.
Returns:
This updated ListPartsRequest object.
    public ListPartsRequest withKey(String key) {
        this. = key;
        return this;
    }

    
Returns the ID of the multipart upload whose parts are being listed.

Returns:
The ID of the multipart upload whose parts are being listed.
    public String getUploadId() {
        return ;
    }

    
Sets the ID of the multipart upload whose parts are being listed.

Parameters:
uploadId The ID of the multipart upload whose parts are being listed.
    public void setUploadId(String uploadId) {
        this. = uploadId;
    }

    
Sets the ID of the multipart upload whose parts are being listed, and returns this updated ListPartsRequest object so that additional method calls can be chained together.

Parameters:
uploadId The ID of the multipart upload whose parts are being listed.
Returns:
This updated ListPartsRequest object.
    public ListPartsRequest withUploadId(String uploadId) {
        this. = uploadId;
        return this;
    }

    
Returns the optional maximum number of parts to be returned in the part listing.

Returns:
The optional maximum number of parts to be returned in the part listing.
    public Integer getMaxParts() {
        return ;
    }

    
Sets the optional maximum number of parts to be returned in the part listing.

Parameters:
maxParts The optional maximum number of parts to be returned in the part listing.
    public void setMaxParts(int maxParts) {
        this. = maxParts;
    }

    
Sets the optional maximum number of parts to be returned in the part listing and returns this updated ListPartsRequest objects so that additional method calls can be chained together.

Parameters:
maxParts The optional maximum number of parts to be returned in the part listing.
Returns:
This updated ListPartsRequest object.
    public ListPartsRequest withMaxParts(int maxParts) {
        this. = maxParts;
        return this;
    }

    
Returns the optional part number marker indicating where in the results to being listing parts.

Returns:
The optional part number marker indicating where in the results to being listing parts.
    public Integer getPartNumberMarker() {
        return ;
    }

    
Sets the optional part number marker indicating where in the results to being listing parts.

Parameters:
partNumberMarker The optional part number marker indicating where in the results to being listing parts.
    public void setPartNumberMarker(Integer partNumberMarker) {
        this. = partNumberMarker;
    }

    
Sets the optional part number marker indicating where in the results to being listing parts, and returns this updated ListPartsRequest object so that additional method calls can be chained together.

Parameters:
partNumberMarker The optional part number marker indicating where in the results to being listing parts.
Returns:
This updated ListPartsRequest object.
    public ListPartsRequest withPartNumberMarker(Integer partNumberMarker) {
        this. = partNumberMarker;
        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 ListPartsRequest, 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 ListPartsRequest withEncodingType(String encodingType) {
        setEncodingType(encodingType);
        return this;
    }
New to GrepCode? Check out our FAQ X