/** * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. * SPDX-License-Identifier: Apache-2.0. */ #pragma once #include <aws/dms/DatabaseMigrationService_EXPORTS.h> #include <aws/dms/DatabaseMigrationServiceRequest.h> #include <aws/core/utils/memory/stl/AWSVector.h> #include <aws/core/utils/memory/stl/AWSString.h> #include <aws/dms/model/Filter.h> #include <utility> namespace Aws { namespace DatabaseMigrationService { namespace Model { /** * <p/><p><h3>See Also:</h3> <a * href="http://docs.aws.amazon.com/goto/WebAPI/dms-2016-01-01/DescribeReplicationTasksMessage">AWS * API Reference</a></p> */ class DescribeReplicationTasksRequest : public DatabaseMigrationServiceRequest { public: AWS_DATABASEMIGRATIONSERVICE_API DescribeReplicationTasksRequest(); // 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 "DescribeReplicationTasks"; } AWS_DATABASEMIGRATIONSERVICE_API Aws::String SerializePayload() const override; AWS_DATABASEMIGRATIONSERVICE_API Aws::Http::HeaderValueCollection GetRequestSpecificHeaders() const override; /** * <p>Filters applied to replication tasks.</p> <p>Valid filter names: * replication-task-arn | replication-task-id | migration-type | endpoint-arn | * replication-instance-arn</p> */ inline const Aws::Vector<Filter>& GetFilters() const{ return m_filters; } /** * <p>Filters applied to replication tasks.</p> <p>Valid filter names: * replication-task-arn | replication-task-id | migration-type | endpoint-arn | * replication-instance-arn</p> */ inline bool FiltersHasBeenSet() const { return m_filtersHasBeenSet; } /** * <p>Filters applied to replication tasks.</p> <p>Valid filter names: * replication-task-arn | replication-task-id | migration-type | endpoint-arn | * replication-instance-arn</p> */ inline void SetFilters(const Aws::Vector<Filter>& value) { m_filtersHasBeenSet = true; m_filters = value; } /** * <p>Filters applied to replication tasks.</p> <p>Valid filter names: * replication-task-arn | replication-task-id | migration-type | endpoint-arn | * replication-instance-arn</p> */ inline void SetFilters(Aws::Vector<Filter>&& value) { m_filtersHasBeenSet = true; m_filters = std::move(value); } /** * <p>Filters applied to replication tasks.</p> <p>Valid filter names: * replication-task-arn | replication-task-id | migration-type | endpoint-arn | * replication-instance-arn</p> */ inline DescribeReplicationTasksRequest& WithFilters(const Aws::Vector<Filter>& value) { SetFilters(value); return *this;} /** * <p>Filters applied to replication tasks.</p> <p>Valid filter names: * replication-task-arn | replication-task-id | migration-type | endpoint-arn | * replication-instance-arn</p> */ inline DescribeReplicationTasksRequest& WithFilters(Aws::Vector<Filter>&& value) { SetFilters(std::move(value)); return *this;} /** * <p>Filters applied to replication tasks.</p> <p>Valid filter names: * replication-task-arn | replication-task-id | migration-type | endpoint-arn | * replication-instance-arn</p> */ inline DescribeReplicationTasksRequest& AddFilters(const Filter& value) { m_filtersHasBeenSet = true; m_filters.push_back(value); return *this; } /** * <p>Filters applied to replication tasks.</p> <p>Valid filter names: * replication-task-arn | replication-task-id | migration-type | endpoint-arn | * replication-instance-arn</p> */ inline DescribeReplicationTasksRequest& AddFilters(Filter&& value) { m_filtersHasBeenSet = true; m_filters.push_back(std::move(value)); return *this; } /** * <p> The maximum number of records to include in the response. If more records * exist than the specified <code>MaxRecords</code> value, a pagination token * called a marker is included in the response so that the remaining results can be * retrieved. </p> <p>Default: 100</p> <p>Constraints: Minimum 20, maximum 100.</p> */ inline int GetMaxRecords() const{ return m_maxRecords; } /** * <p> The maximum number of records to include in the response. If more records * exist than the specified <code>MaxRecords</code> value, a pagination token * called a marker is included in the response so that the remaining results can be * retrieved. </p> <p>Default: 100</p> <p>Constraints: Minimum 20, maximum 100.</p> */ inline bool MaxRecordsHasBeenSet() const { return m_maxRecordsHasBeenSet; } /** * <p> The maximum number of records to include in the response. If more records * exist than the specified <code>MaxRecords</code> value, a pagination token * called a marker is included in the response so that the remaining results can be * retrieved. </p> <p>Default: 100</p> <p>Constraints: Minimum 20, maximum 100.</p> */ inline void SetMaxRecords(int value) { m_maxRecordsHasBeenSet = true; m_maxRecords = value; } /** * <p> The maximum number of records to include in the response. If more records * exist than the specified <code>MaxRecords</code> value, a pagination token * called a marker is included in the response so that the remaining results can be * retrieved. </p> <p>Default: 100</p> <p>Constraints: Minimum 20, maximum 100.</p> */ inline DescribeReplicationTasksRequest& WithMaxRecords(int value) { SetMaxRecords(value); return *this;} /** * <p> An optional pagination token provided by a previous request. If this * parameter is specified, the response includes only records beyond the marker, up * to the value specified by <code>MaxRecords</code>. </p> */ inline const Aws::String& GetMarker() const{ return m_marker; } /** * <p> An optional pagination token provided by a previous request. If this * parameter is specified, the response includes only records beyond the marker, up * to the value specified by <code>MaxRecords</code>. </p> */ inline bool MarkerHasBeenSet() const { return m_markerHasBeenSet; } /** * <p> An optional pagination token provided by a previous request. If this * parameter is specified, the response includes only records beyond the marker, up * to the value specified by <code>MaxRecords</code>. </p> */ inline void SetMarker(const Aws::String& value) { m_markerHasBeenSet = true; m_marker = value; } /** * <p> An optional pagination token provided by a previous request. If this * parameter is specified, the response includes only records beyond the marker, up * to the value specified by <code>MaxRecords</code>. </p> */ inline void SetMarker(Aws::String&& value) { m_markerHasBeenSet = true; m_marker = std::move(value); } /** * <p> An optional pagination token provided by a previous request. If this * parameter is specified, the response includes only records beyond the marker, up * to the value specified by <code>MaxRecords</code>. </p> */ inline void SetMarker(const char* value) { m_markerHasBeenSet = true; m_marker.assign(value); } /** * <p> An optional pagination token provided by a previous request. If this * parameter is specified, the response includes only records beyond the marker, up * to the value specified by <code>MaxRecords</code>. </p> */ inline DescribeReplicationTasksRequest& WithMarker(const Aws::String& value) { SetMarker(value); return *this;} /** * <p> An optional pagination token provided by a previous request. If this * parameter is specified, the response includes only records beyond the marker, up * to the value specified by <code>MaxRecords</code>. </p> */ inline DescribeReplicationTasksRequest& WithMarker(Aws::String&& value) { SetMarker(std::move(value)); return *this;} /** * <p> An optional pagination token provided by a previous request. If this * parameter is specified, the response includes only records beyond the marker, up * to the value specified by <code>MaxRecords</code>. </p> */ inline DescribeReplicationTasksRequest& WithMarker(const char* value) { SetMarker(value); return *this;} /** * <p>An option to set to avoid returning information about settings. Use this to * reduce overhead when setting information is too large. To use this option, * choose <code>true</code>; otherwise, choose <code>false</code> (the * default).</p> */ inline bool GetWithoutSettings() const{ return m_withoutSettings; } /** * <p>An option to set to avoid returning information about settings. Use this to * reduce overhead when setting information is too large. To use this option, * choose <code>true</code>; otherwise, choose <code>false</code> (the * default).</p> */ inline bool WithoutSettingsHasBeenSet() const { return m_withoutSettingsHasBeenSet; } /** * <p>An option to set to avoid returning information about settings. Use this to * reduce overhead when setting information is too large. To use this option, * choose <code>true</code>; otherwise, choose <code>false</code> (the * default).</p> */ inline void SetWithoutSettings(bool value) { m_withoutSettingsHasBeenSet = true; m_withoutSettings = value; } /** * <p>An option to set to avoid returning information about settings. Use this to * reduce overhead when setting information is too large. To use this option, * choose <code>true</code>; otherwise, choose <code>false</code> (the * default).</p> */ inline DescribeReplicationTasksRequest& WithWithoutSettings(bool value) { SetWithoutSettings(value); return *this;} private: Aws::Vector<Filter> m_filters; bool m_filtersHasBeenSet = false; int m_maxRecords; bool m_maxRecordsHasBeenSet = false; Aws::String m_marker; bool m_markerHasBeenSet = false; bool m_withoutSettings; bool m_withoutSettingsHasBeenSet = false; }; } // namespace Model } // namespace DatabaseMigrationService } // namespace Aws