/** * 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 AWS_S3_API ListPartsRequest : public S3Request { public: ListPartsRequest(); // 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 "ListParts"; } Aws::String SerializePayload() const override; void AddQueryStringParameters(Aws::Http::URI& uri) const override; Aws::Http::HeaderValueCollection GetRequestSpecificHeaders() const override; /** *

The name of the bucket to which the parts are being uploaded.

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 using 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 * 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 parts are being uploaded.

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 using 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 * S3 on Outposts in the Amazon S3 User Guide.

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

The name of the bucket to which the parts are being uploaded.

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 using 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 * S3 on Outposts in the Amazon S3 User Guide.

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

The name of the bucket to which the parts are being uploaded.

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 using 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 * S3 on Outposts in the Amazon S3 User Guide.

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

The name of the bucket to which the parts are being uploaded.

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 using 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 * S3 on Outposts in the Amazon S3 User Guide.

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

The name of the bucket to which the parts are being uploaded.

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 using 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 * S3 on Outposts in the Amazon S3 User Guide.

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

The name of the bucket to which the parts are being uploaded.

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 using 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 * S3 on Outposts in the Amazon S3 User Guide.

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

The name of the bucket to which the parts are being uploaded.

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 using 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 * S3 on Outposts in the Amazon S3 User Guide.

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

Object key for which the multipart upload was initiated.

*/ inline const Aws::String& GetKey() const{ return m_key; } /** *

Object key for which the multipart upload was initiated.

*/ inline bool KeyHasBeenSet() const { return m_keyHasBeenSet; } /** *

Object key for which the multipart upload was initiated.

*/ inline void SetKey(const Aws::String& value) { m_keyHasBeenSet = true; m_key = value; } /** *

Object key for which the multipart upload was initiated.

*/ inline void SetKey(Aws::String&& value) { m_keyHasBeenSet = true; m_key = std::move(value); } /** *

Object key for which the multipart upload was initiated.

*/ inline void SetKey(const char* value) { m_keyHasBeenSet = true; m_key.assign(value); } /** *

Object key for which the multipart upload was initiated.

*/ inline ListPartsRequest& WithKey(const Aws::String& value) { SetKey(value); return *this;} /** *

Object key for which the multipart upload was initiated.

*/ inline ListPartsRequest& WithKey(Aws::String&& value) { SetKey(std::move(value)); return *this;} /** *

Object key for which the multipart upload was initiated.

*/ inline ListPartsRequest& WithKey(const char* value) { SetKey(value); return *this;} /** *

Sets the maximum number of parts to return.

*/ inline int GetMaxParts() const{ return m_maxParts; } /** *

Sets the maximum number of parts to return.

*/ inline bool MaxPartsHasBeenSet() const { return m_maxPartsHasBeenSet; } /** *

Sets the maximum number of parts to return.

*/ inline void SetMaxParts(int value) { m_maxPartsHasBeenSet = true; m_maxParts = value; } /** *

Sets the maximum number of parts to return.

*/ inline ListPartsRequest& WithMaxParts(int value) { SetMaxParts(value); return *this;} /** *

Specifies the part after which listing should begin. Only parts with higher * part numbers will be listed.

*/ inline int GetPartNumberMarker() const{ return m_partNumberMarker; } /** *

Specifies the part after which listing should begin. Only parts with higher * part numbers will be listed.

*/ inline bool PartNumberMarkerHasBeenSet() const { return m_partNumberMarkerHasBeenSet; } /** *

Specifies the part after which listing should begin. Only parts with higher * part numbers will be listed.

*/ inline void SetPartNumberMarker(int value) { m_partNumberMarkerHasBeenSet = true; m_partNumberMarker = value; } /** *

Specifies the part after which listing should begin. Only parts with higher * part numbers will be listed.

*/ inline ListPartsRequest& WithPartNumberMarker(int value) { SetPartNumberMarker(value); return *this;} /** *

Upload ID identifying the multipart upload whose parts are being listed.

*/ inline const Aws::String& GetUploadId() const{ return m_uploadId; } /** *

Upload ID identifying the multipart upload whose parts are being listed.

*/ inline bool UploadIdHasBeenSet() const { return m_uploadIdHasBeenSet; } /** *

Upload ID identifying the multipart upload whose parts are being listed.

*/ inline void SetUploadId(const Aws::String& value) { m_uploadIdHasBeenSet = true; m_uploadId = value; } /** *

Upload ID identifying the multipart upload whose parts are being listed.

*/ inline void SetUploadId(Aws::String&& value) { m_uploadIdHasBeenSet = true; m_uploadId = std::move(value); } /** *

Upload ID identifying the multipart upload whose parts are being listed.

*/ inline void SetUploadId(const char* value) { m_uploadIdHasBeenSet = true; m_uploadId.assign(value); } /** *

Upload ID identifying the multipart upload whose parts are being listed.

*/ inline ListPartsRequest& WithUploadId(const Aws::String& value) { SetUploadId(value); return *this;} /** *

Upload ID identifying the multipart upload whose parts are being listed.

*/ inline ListPartsRequest& WithUploadId(Aws::String&& value) { SetUploadId(std::move(value)); return *this;} /** *

Upload ID identifying the multipart upload whose parts are being listed.

*/ inline ListPartsRequest& WithUploadId(const char* value) { SetUploadId(value); return *this;} inline const RequestPayer& GetRequestPayer() const{ return m_requestPayer; } inline bool RequestPayerHasBeenSet() const { return m_requestPayerHasBeenSet; } inline void SetRequestPayer(const RequestPayer& value) { m_requestPayerHasBeenSet = true; m_requestPayer = value; } inline void SetRequestPayer(RequestPayer&& value) { m_requestPayerHasBeenSet = true; m_requestPayer = std::move(value); } inline ListPartsRequest& WithRequestPayer(const RequestPayer& value) { SetRequestPayer(value); return *this;} inline ListPartsRequest& WithRequestPayer(RequestPayer&& value) { SetRequestPayer(std::move(value)); return *this;} /** *

The account ID of the expected bucket owner. If the bucket is owned by a * different account, the request will fail with an HTTP 403 (Access * Denied) error.

*/ inline const Aws::String& GetExpectedBucketOwner() const{ return m_expectedBucketOwner; } /** *

The account ID of the expected bucket owner. If the bucket is owned by a * different account, the request will fail with an HTTP 403 (Access * Denied) error.

*/ inline bool ExpectedBucketOwnerHasBeenSet() const { return m_expectedBucketOwnerHasBeenSet; } /** *

The account ID of the expected bucket owner. If the bucket is owned by a * different account, the request will fail with an HTTP 403 (Access * Denied) error.

*/ inline void SetExpectedBucketOwner(const Aws::String& value) { m_expectedBucketOwnerHasBeenSet = true; m_expectedBucketOwner = value; } /** *

The account ID of the expected bucket owner. If the bucket is owned by a * different account, the request will fail with an HTTP 403 (Access * Denied) error.

*/ inline void SetExpectedBucketOwner(Aws::String&& value) { m_expectedBucketOwnerHasBeenSet = true; m_expectedBucketOwner = std::move(value); } /** *

The account ID of the expected bucket owner. If the bucket is owned by a * different account, the request will fail with an HTTP 403 (Access * Denied) error.

*/ inline void SetExpectedBucketOwner(const char* value) { m_expectedBucketOwnerHasBeenSet = true; m_expectedBucketOwner.assign(value); } /** *

The account ID of the expected bucket owner. If the bucket is owned by a * different account, the request will fail with an HTTP 403 (Access * Denied) error.

*/ inline ListPartsRequest& WithExpectedBucketOwner(const Aws::String& value) { SetExpectedBucketOwner(value); return *this;} /** *

The account ID of the expected bucket owner. If the bucket is owned by a * different account, the request will fail with an HTTP 403 (Access * Denied) error.

*/ inline ListPartsRequest& WithExpectedBucketOwner(Aws::String&& value) { SetExpectedBucketOwner(std::move(value)); return *this;} /** *

The account ID of the expected bucket owner. If the bucket is owned by a * different account, the request will fail with an HTTP 403 (Access * Denied) error.

*/ inline ListPartsRequest& WithExpectedBucketOwner(const char* value) { SetExpectedBucketOwner(value); return *this;} inline const Aws::Map& GetCustomizedAccessLogTag() const{ return m_customizedAccessLogTag; } inline bool CustomizedAccessLogTagHasBeenSet() const { return m_customizedAccessLogTagHasBeenSet; } inline void SetCustomizedAccessLogTag(const Aws::Map& value) { m_customizedAccessLogTagHasBeenSet = true; m_customizedAccessLogTag = value; } inline void SetCustomizedAccessLogTag(Aws::Map&& value) { m_customizedAccessLogTagHasBeenSet = true; m_customizedAccessLogTag = std::move(value); } inline ListPartsRequest& WithCustomizedAccessLogTag(const Aws::Map& value) { SetCustomizedAccessLogTag(value); return *this;} inline ListPartsRequest& WithCustomizedAccessLogTag(Aws::Map&& value) { SetCustomizedAccessLogTag(std::move(value)); return *this;} inline ListPartsRequest& AddCustomizedAccessLogTag(const Aws::String& key, const Aws::String& value) { m_customizedAccessLogTagHasBeenSet = true; m_customizedAccessLogTag.emplace(key, value); return *this; } inline ListPartsRequest& AddCustomizedAccessLogTag(Aws::String&& key, const Aws::String& value) { m_customizedAccessLogTagHasBeenSet = true; m_customizedAccessLogTag.emplace(std::move(key), value); return *this; } inline ListPartsRequest& AddCustomizedAccessLogTag(const Aws::String& key, Aws::String&& value) { m_customizedAccessLogTagHasBeenSet = true; m_customizedAccessLogTag.emplace(key, std::move(value)); return *this; } inline ListPartsRequest& AddCustomizedAccessLogTag(Aws::String&& key, Aws::String&& value) { m_customizedAccessLogTagHasBeenSet = true; m_customizedAccessLogTag.emplace(std::move(key), std::move(value)); return *this; } inline ListPartsRequest& AddCustomizedAccessLogTag(const char* key, Aws::String&& value) { m_customizedAccessLogTagHasBeenSet = true; m_customizedAccessLogTag.emplace(key, std::move(value)); return *this; } inline ListPartsRequest& AddCustomizedAccessLogTag(Aws::String&& key, const char* value) { m_customizedAccessLogTagHasBeenSet = true; m_customizedAccessLogTag.emplace(std::move(key), value); return *this; } inline ListPartsRequest& AddCustomizedAccessLogTag(const char* key, const char* value) { m_customizedAccessLogTagHasBeenSet = true; m_customizedAccessLogTag.emplace(key, value); return *this; } private: Aws::String m_bucket; bool m_bucketHasBeenSet; Aws::String m_key; bool m_keyHasBeenSet; int m_maxParts; bool m_maxPartsHasBeenSet; int m_partNumberMarker; bool m_partNumberMarkerHasBeenSet; Aws::String m_uploadId; bool m_uploadIdHasBeenSet; RequestPayer m_requestPayer; bool m_requestPayerHasBeenSet; Aws::String m_expectedBucketOwner; bool m_expectedBucketOwnerHasBeenSet; Aws::Map m_customizedAccessLogTag; bool m_customizedAccessLogTagHasBeenSet; }; } // namespace Model } // namespace S3 } // namespace Aws