/** * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. * SPDX-License-Identifier: Apache-2.0. */ #pragma once #include #include #include #include #include #include namespace Aws { namespace Http { class URI; } //namespace Http namespace S3 { namespace Model { /** */ class ListMultipartUploadsRequest : public S3Request { public: AWS_S3_API ListMultipartUploadsRequest(); // Service request name is the Operation name which will send this request out, // each operation should has unique request name, so that we can get operation's name from this request. // Note: this is not true for response, multiple operations may have the same response name, // so we can not get operation's name from response. inline virtual const char* GetServiceRequestName() const override { return "ListMultipartUploads"; } AWS_S3_API Aws::String SerializePayload() const override; AWS_S3_API void AddQueryStringParameters(Aws::Http::URI& uri) const override; AWS_S3_API Aws::Http::HeaderValueCollection GetRequestSpecificHeaders() const override; /** * Helper function to collect parameters (configurable and static hardcoded) required for endpoint computation. */ AWS_S3_API EndpointParameters GetEndpointContextParams() const override; /** *

The name of the bucket to which the multipart upload was initiated.

When using this action with an access point, you must direct requests to the * access point hostname. The access point hostname takes the form * AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. * When using this action with an access point through the Amazon Web Services * SDKs, you provide the access point ARN in place of the bucket name. For more * information about access point ARNs, see Using * access points in the Amazon S3 User Guide.

When using this * action with Amazon S3 on Outposts, you must direct requests to the S3 on * Outposts hostname. The S3 on Outposts hostname takes the form * AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. * When using this action with S3 on Outposts through the Amazon Web Services SDKs, * you provide the Outposts bucket ARN in place of the bucket name. For more * information about S3 on Outposts ARNs, see Using * Amazon S3 on Outposts in the Amazon S3 User Guide.

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

The name of the bucket to which the multipart upload was initiated.

*/ inline bool BucketHasBeenSet() const { return m_bucketHasBeenSet; } /** *

The name of the bucket to which the multipart upload was initiated.

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

The name of the bucket to which the multipart upload was initiated.

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

The name of the bucket to which the multipart upload was initiated.

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

The name of the bucket to which the multipart upload was initiated.

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

The name of the bucket to which the multipart upload was initiated.

*/ inline ListMultipartUploadsRequest& WithBucket(Aws::String&& value) { SetBucket(std::move(value)); return *this;} /** *

The name of the bucket to which the multipart upload was initiated.

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

Character you use to group keys.

All keys that contain the same string * between the prefix, if specified, and the first occurrence of the delimiter * after the prefix are grouped under a single result element, * CommonPrefixes. If you don't specify the prefix parameter, then the * substring starts at the beginning of the key. The keys that are grouped under * CommonPrefixes result element are not returned elsewhere in the * response.

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

Character you use to group keys.

*/ inline bool DelimiterHasBeenSet() const { return m_delimiterHasBeenSet; } /** *

Character you use to group keys.

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

Character you use to group keys.

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

Character you use to group keys.

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

Character you use to group keys.

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

Character you use to group keys.

*/ inline ListMultipartUploadsRequest& WithDelimiter(Aws::String&& value) { SetDelimiter(std::move(value)); return *this;} /** *

Character you use to group keys.

*/ inline ListMultipartUploadsRequest& WithDelimiter(const char* value) { SetDelimiter(value); return *this;} inline const EncodingType& GetEncodingType() const{ return m_encodingType; } inline bool EncodingTypeHasBeenSet() const { return m_encodingTypeHasBeenSet; } inline void SetEncodingType(const EncodingType& value) { m_encodingTypeHasBeenSet = true; m_encodingType = value; } inline void SetEncodingType(EncodingType&& value) { m_encodingTypeHasBeenSet = true; m_encodingType = std::move(value); } inline ListMultipartUploadsRequest& WithEncodingType(const EncodingType& value) { SetEncodingType(value); return *this;} inline ListMultipartUploadsRequest& WithEncodingType(EncodingType&& value) { SetEncodingType(std::move(value)); return *this;} /** *

Together with upload-id-marker, this parameter specifies the multipart upload * after which listing should begin.