/** * 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 FSx { namespace Model { /** *

The request object for the DescribeBackups * operation.

See Also:

AWS * API Reference

*/ class DescribeBackupsRequest : public FSxRequest { public: AWS_FSX_API DescribeBackupsRequest(); // 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 "DescribeBackups"; } AWS_FSX_API Aws::String SerializePayload() const override; AWS_FSX_API Aws::Http::HeaderValueCollection GetRequestSpecificHeaders() const override; /** *

The IDs of the backups that you want to retrieve. This parameter value * overrides any filters. If any IDs aren't found, a BackupNotFound * error occurs.

*/ inline const Aws::Vector& GetBackupIds() const{ return m_backupIds; } /** *

The IDs of the backups that you want to retrieve. This parameter value * overrides any filters. If any IDs aren't found, a BackupNotFound * error occurs.

*/ inline bool BackupIdsHasBeenSet() const { return m_backupIdsHasBeenSet; } /** *

The IDs of the backups that you want to retrieve. This parameter value * overrides any filters. If any IDs aren't found, a BackupNotFound * error occurs.

*/ inline void SetBackupIds(const Aws::Vector& value) { m_backupIdsHasBeenSet = true; m_backupIds = value; } /** *

The IDs of the backups that you want to retrieve. This parameter value * overrides any filters. If any IDs aren't found, a BackupNotFound * error occurs.

*/ inline void SetBackupIds(Aws::Vector&& value) { m_backupIdsHasBeenSet = true; m_backupIds = std::move(value); } /** *

The IDs of the backups that you want to retrieve. This parameter value * overrides any filters. If any IDs aren't found, a BackupNotFound * error occurs.

*/ inline DescribeBackupsRequest& WithBackupIds(const Aws::Vector& value) { SetBackupIds(value); return *this;} /** *

The IDs of the backups that you want to retrieve. This parameter value * overrides any filters. If any IDs aren't found, a BackupNotFound * error occurs.

*/ inline DescribeBackupsRequest& WithBackupIds(Aws::Vector&& value) { SetBackupIds(std::move(value)); return *this;} /** *

The IDs of the backups that you want to retrieve. This parameter value * overrides any filters. If any IDs aren't found, a BackupNotFound * error occurs.

*/ inline DescribeBackupsRequest& AddBackupIds(const Aws::String& value) { m_backupIdsHasBeenSet = true; m_backupIds.push_back(value); return *this; } /** *

The IDs of the backups that you want to retrieve. This parameter value * overrides any filters. If any IDs aren't found, a BackupNotFound * error occurs.

*/ inline DescribeBackupsRequest& AddBackupIds(Aws::String&& value) { m_backupIdsHasBeenSet = true; m_backupIds.push_back(std::move(value)); return *this; } /** *

The IDs of the backups that you want to retrieve. This parameter value * overrides any filters. If any IDs aren't found, a BackupNotFound * error occurs.

*/ inline DescribeBackupsRequest& AddBackupIds(const char* value) { m_backupIdsHasBeenSet = true; m_backupIds.push_back(value); return *this; } /** *

The filters structure. The supported names are file-system-id, * backup-type, file-system-type, and * volume-id.

*/ inline const Aws::Vector& GetFilters() const{ return m_filters; } /** *

The filters structure. The supported names are file-system-id, * backup-type, file-system-type, and * volume-id.

*/ inline bool FiltersHasBeenSet() const { return m_filtersHasBeenSet; } /** *

The filters structure. The supported names are file-system-id, * backup-type, file-system-type, and * volume-id.

*/ inline void SetFilters(const Aws::Vector& value) { m_filtersHasBeenSet = true; m_filters = value; } /** *

The filters structure. The supported names are file-system-id, * backup-type, file-system-type, and * volume-id.

*/ inline void SetFilters(Aws::Vector&& value) { m_filtersHasBeenSet = true; m_filters = std::move(value); } /** *

The filters structure. The supported names are file-system-id, * backup-type, file-system-type, and * volume-id.

*/ inline DescribeBackupsRequest& WithFilters(const Aws::Vector& value) { SetFilters(value); return *this;} /** *

The filters structure. The supported names are file-system-id, * backup-type, file-system-type, and * volume-id.

*/ inline DescribeBackupsRequest& WithFilters(Aws::Vector&& value) { SetFilters(std::move(value)); return *this;} /** *

The filters structure. The supported names are file-system-id, * backup-type, file-system-type, and * volume-id.

*/ inline DescribeBackupsRequest& AddFilters(const Filter& value) { m_filtersHasBeenSet = true; m_filters.push_back(value); return *this; } /** *

The filters structure. The supported names are file-system-id, * backup-type, file-system-type, and * volume-id.

*/ inline DescribeBackupsRequest& AddFilters(Filter&& value) { m_filtersHasBeenSet = true; m_filters.push_back(std::move(value)); return *this; } /** *

Maximum number of backups to return in the response. This parameter value * must be greater than 0. The number of items that Amazon FSx returns is the * minimum of the MaxResults parameter specified in the request and * the service's internal maximum number of items per page.

*/ inline int GetMaxResults() const{ return m_maxResults; } /** *

Maximum number of backups to return in the response. This parameter value * must be greater than 0. The number of items that Amazon FSx returns is the * minimum of the MaxResults parameter specified in the request and * the service's internal maximum number of items per page.

*/ inline bool MaxResultsHasBeenSet() const { return m_maxResultsHasBeenSet; } /** *

Maximum number of backups to return in the response. This parameter value * must be greater than 0. The number of items that Amazon FSx returns is the * minimum of the MaxResults parameter specified in the request and * the service's internal maximum number of items per page.

*/ inline void SetMaxResults(int value) { m_maxResultsHasBeenSet = true; m_maxResults = value; } /** *

Maximum number of backups to return in the response. This parameter value * must be greater than 0. The number of items that Amazon FSx returns is the * minimum of the MaxResults parameter specified in the request and * the service's internal maximum number of items per page.

*/ inline DescribeBackupsRequest& WithMaxResults(int value) { SetMaxResults(value); return *this;} /** *

An opaque pagination token returned from a previous * DescribeBackups operation. If a token is present, the operation * continues the list from where the returning call left off.

*/ inline const Aws::String& GetNextToken() const{ return m_nextToken; } /** *

An opaque pagination token returned from a previous * DescribeBackups operation. If a token is present, the operation * continues the list from where the returning call left off.

*/ inline bool NextTokenHasBeenSet() const { return m_nextTokenHasBeenSet; } /** *

An opaque pagination token returned from a previous * DescribeBackups operation. If a token is present, the operation * continues the list from where the returning call left off.

*/ inline void SetNextToken(const Aws::String& value) { m_nextTokenHasBeenSet = true; m_nextToken = value; } /** *

An opaque pagination token returned from a previous * DescribeBackups operation. If a token is present, the operation * continues the list from where the returning call left off.

*/ inline void SetNextToken(Aws::String&& value) { m_nextTokenHasBeenSet = true; m_nextToken = std::move(value); } /** *

An opaque pagination token returned from a previous * DescribeBackups operation. If a token is present, the operation * continues the list from where the returning call left off.

*/ inline void SetNextToken(const char* value) { m_nextTokenHasBeenSet = true; m_nextToken.assign(value); } /** *

An opaque pagination token returned from a previous * DescribeBackups operation. If a token is present, the operation * continues the list from where the returning call left off.

*/ inline DescribeBackupsRequest& WithNextToken(const Aws::String& value) { SetNextToken(value); return *this;} /** *

An opaque pagination token returned from a previous * DescribeBackups operation. If a token is present, the operation * continues the list from where the returning call left off.

*/ inline DescribeBackupsRequest& WithNextToken(Aws::String&& value) { SetNextToken(std::move(value)); return *this;} /** *

An opaque pagination token returned from a previous * DescribeBackups operation. If a token is present, the operation * continues the list from where the returning call left off.

*/ inline DescribeBackupsRequest& WithNextToken(const char* value) { SetNextToken(value); return *this;} private: Aws::Vector m_backupIds; bool m_backupIdsHasBeenSet = false; Aws::Vector m_filters; bool m_filtersHasBeenSet = false; int m_maxResults; bool m_maxResultsHasBeenSet = false; Aws::String m_nextToken; bool m_nextTokenHasBeenSet = false; }; } // namespace Model } // namespace FSx } // namespace Aws