/** * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. * SPDX-License-Identifier: Apache-2.0. */ #pragma once #include #include #include #include namespace Aws { namespace Http { class URI; } //namespace Http namespace Glacier { namespace Model { /** *

Provides options for retrieving a list of parts of an archive that have been * uploaded in a specific multipart upload.

See Also:

AWS * API Reference

*/ class ListPartsRequest : public GlacierRequest { public: AWS_GLACIER_API 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_GLACIER_API Aws::String SerializePayload() const override; AWS_GLACIER_API void AddQueryStringParameters(Aws::Http::URI& uri) const override; /** *

The AccountId value is the AWS account ID of the account that * owns the vault. You can either specify an AWS account ID or optionally a single * '-' (hyphen), in which case Amazon S3 Glacier uses the AWS account * ID associated with the credentials used to sign the request. If you use an * account ID, do not include any hyphens ('-') in the ID.

*/ inline const Aws::String& GetAccountId() const{ return m_accountId; } /** *

The AccountId value is the AWS account ID of the account that * owns the vault. You can either specify an AWS account ID or optionally a single * '-' (hyphen), in which case Amazon S3 Glacier uses the AWS account * ID associated with the credentials used to sign the request. If you use an * account ID, do not include any hyphens ('-') in the ID.

*/ inline bool AccountIdHasBeenSet() const { return m_accountIdHasBeenSet; } /** *

The AccountId value is the AWS account ID of the account that * owns the vault. You can either specify an AWS account ID or optionally a single * '-' (hyphen), in which case Amazon S3 Glacier uses the AWS account * ID associated with the credentials used to sign the request. If you use an * account ID, do not include any hyphens ('-') in the ID.

*/ inline void SetAccountId(const Aws::String& value) { m_accountIdHasBeenSet = true; m_accountId = value; } /** *

The AccountId value is the AWS account ID of the account that * owns the vault. You can either specify an AWS account ID or optionally a single * '-' (hyphen), in which case Amazon S3 Glacier uses the AWS account * ID associated with the credentials used to sign the request. If you use an * account ID, do not include any hyphens ('-') in the ID.

*/ inline void SetAccountId(Aws::String&& value) { m_accountIdHasBeenSet = true; m_accountId = std::move(value); } /** *

The AccountId value is the AWS account ID of the account that * owns the vault. You can either specify an AWS account ID or optionally a single * '-' (hyphen), in which case Amazon S3 Glacier uses the AWS account * ID associated with the credentials used to sign the request. If you use an * account ID, do not include any hyphens ('-') in the ID.

*/ inline void SetAccountId(const char* value) { m_accountIdHasBeenSet = true; m_accountId.assign(value); } /** *

The AccountId value is the AWS account ID of the account that * owns the vault. You can either specify an AWS account ID or optionally a single * '-' (hyphen), in which case Amazon S3 Glacier uses the AWS account * ID associated with the credentials used to sign the request. If you use an * account ID, do not include any hyphens ('-') in the ID.

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

The AccountId value is the AWS account ID of the account that * owns the vault. You can either specify an AWS account ID or optionally a single * '-' (hyphen), in which case Amazon S3 Glacier uses the AWS account * ID associated with the credentials used to sign the request. If you use an * account ID, do not include any hyphens ('-') in the ID.

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

The AccountId value is the AWS account ID of the account that * owns the vault. You can either specify an AWS account ID or optionally a single * '-' (hyphen), in which case Amazon S3 Glacier uses the AWS account * ID associated with the credentials used to sign the request. If you use an * account ID, do not include any hyphens ('-') in the ID.

*/ inline ListPartsRequest& WithAccountId(const char* value) { SetAccountId(value); return *this;} /** *

The name of the vault.

*/ inline const Aws::String& GetVaultName() const{ return m_vaultName; } /** *

The name of the vault.

*/ inline bool VaultNameHasBeenSet() const { return m_vaultNameHasBeenSet; } /** *

The name of the vault.

*/ inline void SetVaultName(const Aws::String& value) { m_vaultNameHasBeenSet = true; m_vaultName = value; } /** *

The name of the vault.

*/ inline void SetVaultName(Aws::String&& value) { m_vaultNameHasBeenSet = true; m_vaultName = std::move(value); } /** *

The name of the vault.

*/ inline void SetVaultName(const char* value) { m_vaultNameHasBeenSet = true; m_vaultName.assign(value); } /** *

The name of the vault.

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

The name of the vault.

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

The name of the vault.

*/ inline ListPartsRequest& WithVaultName(const char* value) { SetVaultName(value); return *this;} /** *

The upload ID of the multipart upload.

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

The upload ID of the multipart upload.

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

The upload ID of the multipart upload.

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

The upload ID of the multipart upload.

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

The upload ID of the multipart upload.

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

The upload ID of the multipart upload.

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

The upload ID of the multipart upload.

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

The upload ID of the multipart upload.

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

An opaque string used for pagination. This value specifies the part at which * the listing of parts should begin. Get the marker value from the response of a * previous List Parts response. You need only include the marker if you are * continuing the pagination of results started in a previous List Parts * request.

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

An opaque string used for pagination. This value specifies the part at which * the listing of parts should begin. Get the marker value from the response of a * previous List Parts response. You need only include the marker if you are * continuing the pagination of results started in a previous List Parts * request.

*/ inline bool MarkerHasBeenSet() const { return m_markerHasBeenSet; } /** *

An opaque string used for pagination. This value specifies the part at which * the listing of parts should begin. Get the marker value from the response of a * previous List Parts response. You need only include the marker if you are * continuing the pagination of results started in a previous List Parts * request.

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

An opaque string used for pagination. This value specifies the part at which * the listing of parts should begin. Get the marker value from the response of a * previous List Parts response. You need only include the marker if you are * continuing the pagination of results started in a previous List Parts * request.

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

An opaque string used for pagination. This value specifies the part at which * the listing of parts should begin. Get the marker value from the response of a * previous List Parts response. You need only include the marker if you are * continuing the pagination of results started in a previous List Parts * request.

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

An opaque string used for pagination. This value specifies the part at which * the listing of parts should begin. Get the marker value from the response of a * previous List Parts response. You need only include the marker if you are * continuing the pagination of results started in a previous List Parts * request.

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

An opaque string used for pagination. This value specifies the part at which * the listing of parts should begin. Get the marker value from the response of a * previous List Parts response. You need only include the marker if you are * continuing the pagination of results started in a previous List Parts * request.

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

An opaque string used for pagination. This value specifies the part at which * the listing of parts should begin. Get the marker value from the response of a * previous List Parts response. You need only include the marker if you are * continuing the pagination of results started in a previous List Parts * request.

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

The maximum number of parts to be returned. The default limit is 50. The * number of parts returned might be fewer than the specified limit, but the number * of returned parts never exceeds the limit.

*/ inline const Aws::String& GetLimit() const{ return m_limit; } /** *

The maximum number of parts to be returned. The default limit is 50. The * number of parts returned might be fewer than the specified limit, but the number * of returned parts never exceeds the limit.

*/ inline bool LimitHasBeenSet() const { return m_limitHasBeenSet; } /** *

The maximum number of parts to be returned. The default limit is 50. The * number of parts returned might be fewer than the specified limit, but the number * of returned parts never exceeds the limit.

*/ inline void SetLimit(const Aws::String& value) { m_limitHasBeenSet = true; m_limit = value; } /** *

The maximum number of parts to be returned. The default limit is 50. The * number of parts returned might be fewer than the specified limit, but the number * of returned parts never exceeds the limit.

*/ inline void SetLimit(Aws::String&& value) { m_limitHasBeenSet = true; m_limit = std::move(value); } /** *

The maximum number of parts to be returned. The default limit is 50. The * number of parts returned might be fewer than the specified limit, but the number * of returned parts never exceeds the limit.

*/ inline void SetLimit(const char* value) { m_limitHasBeenSet = true; m_limit.assign(value); } /** *

The maximum number of parts to be returned. The default limit is 50. The * number of parts returned might be fewer than the specified limit, but the number * of returned parts never exceeds the limit.

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

The maximum number of parts to be returned. The default limit is 50. The * number of parts returned might be fewer than the specified limit, but the number * of returned parts never exceeds the limit.

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

The maximum number of parts to be returned. The default limit is 50. The * number of parts returned might be fewer than the specified limit, but the number * of returned parts never exceeds the limit.

*/ inline ListPartsRequest& WithLimit(const char* value) { SetLimit(value); return *this;} private: Aws::String m_accountId; bool m_accountIdHasBeenSet = false; Aws::String m_vaultName; bool m_vaultNameHasBeenSet = false; Aws::String m_uploadId; bool m_uploadIdHasBeenSet = false; Aws::String m_marker; bool m_markerHasBeenSet = false; Aws::String m_limit; bool m_limitHasBeenSet = false; }; } // namespace Model } // namespace Glacier } // namespace Aws