ListObjectsRequest.h

Go to the documentation of this file.

/*
* Copyright 2010-2016 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.
*/
#pragma once
#include <aws/s3/S3_EXPORTS.h>
#include <aws/s3/S3Request.h>
#include <aws/core/utils/memory/stl/AWSString.h>
#include <aws/s3/model/EncodingType.h>

namespace Aws
{
namespace Http
{
    class URI;
} //namespace Http
namespace S3
{
namespace Model
{

  class AWS_S3_API ListObjectsRequest : public S3Request
  {
  public:
    ListObjectsRequest();
    Aws::String SerializePayload() const override;

    void AddQueryStringParameters(Aws::Http::URI& uri) const override;

    
    inline const Aws::String& GetBucket() const{ return m_bucket; }

    
    inline void SetBucket(const Aws::String& value) { m_bucketHasBeenSet = true; m_bucket = value; }

    
    inline void SetBucket(Aws::String&& value) { m_bucketHasBeenSet = true; m_bucket = value; }

    
    inline void SetBucket(const char* value) { m_bucketHasBeenSet = true; m_bucket.assign(value); }

    
    inline ListObjectsRequest& WithBucket(const Aws::String& value) { SetBucket(value); return *this;}

    
    inline ListObjectsRequest& WithBucket(Aws::String&& value) { SetBucket(value); return *this;}

    
    inline ListObjectsRequest& WithBucket(const char* value) { SetBucket(value); return *this;}

    inline const Aws::String& GetDelimiter() const{ return m_delimiter; }

    inline void SetDelimiter(const Aws::String& value) { m_delimiterHasBeenSet = true; m_delimiter = value; }

    inline void SetDelimiter(Aws::String&& value) { m_delimiterHasBeenSet = true; m_delimiter = value; }

    inline void SetDelimiter(const char* value) { m_delimiterHasBeenSet = true; m_delimiter.assign(value); }

    inline ListObjectsRequest& WithDelimiter(const Aws::String& value) { SetDelimiter(value); return *this;}

    inline ListObjectsRequest& WithDelimiter(Aws::String&& value) { SetDelimiter(value); return *this;}

    inline ListObjectsRequest& WithDelimiter(const char* value) { SetDelimiter(value); return *this;}

    
    inline const EncodingType& GetEncodingType() const{ return m_encodingType; }

    
    inline void SetEncodingType(const EncodingType& value) { m_encodingTypeHasBeenSet = true; m_encodingType = value; }

    
    inline void SetEncodingType(EncodingType&& value) { m_encodingTypeHasBeenSet = true; m_encodingType = value; }

    
    inline ListObjectsRequest& WithEncodingType(const EncodingType& value) { SetEncodingType(value); return *this;}

    
    inline ListObjectsRequest& WithEncodingType(EncodingType&& value) { SetEncodingType(value); return *this;}

    inline const Aws::String& GetMarker() const{ return m_marker; }

    inline void SetMarker(const Aws::String& value) { m_markerHasBeenSet = true; m_marker = value; }

    inline void SetMarker(Aws::String&& value) { m_markerHasBeenSet = true; m_marker = value; }

    inline void SetMarker(const char* value) { m_markerHasBeenSet = true; m_marker.assign(value); }

    inline ListObjectsRequest& WithMarker(const Aws::String& value) { SetMarker(value); return *this;}

    inline ListObjectsRequest& WithMarker(Aws::String&& value) { SetMarker(value); return *this;}

    inline ListObjectsRequest& WithMarker(const char* value) { SetMarker(value); return *this;}

    inline long GetMaxKeys() const{ return m_maxKeys; }

    inline void SetMaxKeys(long value) { m_maxKeysHasBeenSet = true; m_maxKeys = value; }

    inline ListObjectsRequest& WithMaxKeys(long value) { SetMaxKeys(value); return *this;}

    inline const Aws::String& GetPrefix() const{ return m_prefix; }

    inline void SetPrefix(const Aws::String& value) { m_prefixHasBeenSet = true; m_prefix = value; }

    inline void SetPrefix(Aws::String&& value) { m_prefixHasBeenSet = true; m_prefix = value; }

    inline void SetPrefix(const char* value) { m_prefixHasBeenSet = true; m_prefix.assign(value); }

    inline ListObjectsRequest& WithPrefix(const Aws::String& value) { SetPrefix(value); return *this;}

    inline ListObjectsRequest& WithPrefix(Aws::String&& value) { SetPrefix(value); return *this;}

    inline ListObjectsRequest& WithPrefix(const char* value) { SetPrefix(value); return *this;}

  private:
    Aws::String m_bucket;
    bool m_bucketHasBeenSet;
    Aws::String m_delimiter;
    bool m_delimiterHasBeenSet;
    EncodingType m_encodingType;
    bool m_encodingTypeHasBeenSet;
    Aws::String m_marker;
    bool m_markerHasBeenSet;
    long m_maxKeys;
    bool m_maxKeysHasBeenSet;
    Aws::String m_prefix;
    bool m_prefixHasBeenSet;
  };

} // namespace Model
} // namespace S3
} // namespace Aws