/** * 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 Neptune { namespace Model { /** */ class DescribeDBClustersRequest : public NeptuneRequest { public: AWS_NEPTUNE_API DescribeDBClustersRequest(); // 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 "DescribeDBClusters"; } AWS_NEPTUNE_API Aws::String SerializePayload() const override; protected: AWS_NEPTUNE_API void DumpBodyToUrl(Aws::Http::URI& uri ) const override; public: /** *

The user-supplied DB cluster identifier. If this parameter is specified, * information from only the specific DB cluster is returned. This parameter isn't * case-sensitive.

Constraints:

  • If supplied, must match an * existing DBClusterIdentifier.

*/ inline const Aws::String& GetDBClusterIdentifier() const{ return m_dBClusterIdentifier; } /** *

The user-supplied DB cluster identifier. If this parameter is specified, * information from only the specific DB cluster is returned. This parameter isn't * case-sensitive.

Constraints:

  • If supplied, must match an * existing DBClusterIdentifier.

*/ inline bool DBClusterIdentifierHasBeenSet() const { return m_dBClusterIdentifierHasBeenSet; } /** *

The user-supplied DB cluster identifier. If this parameter is specified, * information from only the specific DB cluster is returned. This parameter isn't * case-sensitive.

Constraints:

  • If supplied, must match an * existing DBClusterIdentifier.

*/ inline void SetDBClusterIdentifier(const Aws::String& value) { m_dBClusterIdentifierHasBeenSet = true; m_dBClusterIdentifier = value; } /** *

The user-supplied DB cluster identifier. If this parameter is specified, * information from only the specific DB cluster is returned. This parameter isn't * case-sensitive.

Constraints:

  • If supplied, must match an * existing DBClusterIdentifier.

*/ inline void SetDBClusterIdentifier(Aws::String&& value) { m_dBClusterIdentifierHasBeenSet = true; m_dBClusterIdentifier = std::move(value); } /** *

The user-supplied DB cluster identifier. If this parameter is specified, * information from only the specific DB cluster is returned. This parameter isn't * case-sensitive.

Constraints:

  • If supplied, must match an * existing DBClusterIdentifier.

*/ inline void SetDBClusterIdentifier(const char* value) { m_dBClusterIdentifierHasBeenSet = true; m_dBClusterIdentifier.assign(value); } /** *

The user-supplied DB cluster identifier. If this parameter is specified, * information from only the specific DB cluster is returned. This parameter isn't * case-sensitive.

Constraints:

  • If supplied, must match an * existing DBClusterIdentifier.

*/ inline DescribeDBClustersRequest& WithDBClusterIdentifier(const Aws::String& value) { SetDBClusterIdentifier(value); return *this;} /** *

The user-supplied DB cluster identifier. If this parameter is specified, * information from only the specific DB cluster is returned. This parameter isn't * case-sensitive.

Constraints:

  • If supplied, must match an * existing DBClusterIdentifier.

*/ inline DescribeDBClustersRequest& WithDBClusterIdentifier(Aws::String&& value) { SetDBClusterIdentifier(std::move(value)); return *this;} /** *

The user-supplied DB cluster identifier. If this parameter is specified, * information from only the specific DB cluster is returned. This parameter isn't * case-sensitive.

Constraints:

  • If supplied, must match an * existing DBClusterIdentifier.

*/ inline DescribeDBClustersRequest& WithDBClusterIdentifier(const char* value) { SetDBClusterIdentifier(value); return *this;} /** *

A filter that specifies one or more DB clusters to describe.

Supported * filters:

  • db-cluster-id - Accepts DB cluster * identifiers and DB cluster Amazon Resource Names (ARNs). The results list will * only include information about the DB clusters identified by these ARNs.

    *
  • engine - Accepts an engine name (such as * neptune), and restricts the results list to DB clusters created by * that engine.

For example, to invoke this API from the Amazon * CLI and filter so that only Neptune DB clusters are returned, you could use the * following command:

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

A filter that specifies one or more DB clusters to describe.

Supported * filters:

  • db-cluster-id - Accepts DB cluster * identifiers and DB cluster Amazon Resource Names (ARNs). The results list will * only include information about the DB clusters identified by these ARNs.

    *
  • engine - Accepts an engine name (such as * neptune), and restricts the results list to DB clusters created by * that engine.

For example, to invoke this API from the Amazon * CLI and filter so that only Neptune DB clusters are returned, you could use the * following command:

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

A filter that specifies one or more DB clusters to describe.

Supported * filters:

  • db-cluster-id - Accepts DB cluster * identifiers and DB cluster Amazon Resource Names (ARNs). The results list will * only include information about the DB clusters identified by these ARNs.

    *
  • engine - Accepts an engine name (such as * neptune), and restricts the results list to DB clusters created by * that engine.

For example, to invoke this API from the Amazon * CLI and filter so that only Neptune DB clusters are returned, you could use the * following command:

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

A filter that specifies one or more DB clusters to describe.

Supported * filters:

  • db-cluster-id - Accepts DB cluster * identifiers and DB cluster Amazon Resource Names (ARNs). The results list will * only include information about the DB clusters identified by these ARNs.

    *
  • engine - Accepts an engine name (such as * neptune), and restricts the results list to DB clusters created by * that engine.

For example, to invoke this API from the Amazon * CLI and filter so that only Neptune DB clusters are returned, you could use the * following command:

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

A filter that specifies one or more DB clusters to describe.

Supported * filters:

  • db-cluster-id - Accepts DB cluster * identifiers and DB cluster Amazon Resource Names (ARNs). The results list will * only include information about the DB clusters identified by these ARNs.

    *
  • engine - Accepts an engine name (such as * neptune), and restricts the results list to DB clusters created by * that engine.

For example, to invoke this API from the Amazon * CLI and filter so that only Neptune DB clusters are returned, you could use the * following command:

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

A filter that specifies one or more DB clusters to describe.

Supported * filters:

  • db-cluster-id - Accepts DB cluster * identifiers and DB cluster Amazon Resource Names (ARNs). The results list will * only include information about the DB clusters identified by these ARNs.

    *
  • engine - Accepts an engine name (such as * neptune), and restricts the results list to DB clusters created by * that engine.

For example, to invoke this API from the Amazon * CLI and filter so that only Neptune DB clusters are returned, you could use the * following command:

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

A filter that specifies one or more DB clusters to describe.

Supported * filters:

  • db-cluster-id - Accepts DB cluster * identifiers and DB cluster Amazon Resource Names (ARNs). The results list will * only include information about the DB clusters identified by these ARNs.

    *
  • engine - Accepts an engine name (such as * neptune), and restricts the results list to DB clusters created by * that engine.

For example, to invoke this API from the Amazon * CLI and filter so that only Neptune DB clusters are returned, you could use the * following command:

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

A filter that specifies one or more DB clusters to describe.

Supported * filters:

  • db-cluster-id - Accepts DB cluster * identifiers and DB cluster Amazon Resource Names (ARNs). The results list will * only include information about the DB clusters identified by these ARNs.

    *
  • engine - Accepts an engine name (such as * neptune), and restricts the results list to DB clusters created by * that engine.

For example, to invoke this API from the Amazon * CLI and filter so that only Neptune DB clusters are returned, you could use the * following command:

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

The maximum number of records to include in the response. If more records * exist than the specified MaxRecords value, a pagination token * called a marker is included in the response so that the remaining results can be * retrieved.

Default: 100

Constraints: Minimum 20, maximum 100.

*/ inline int GetMaxRecords() const{ return m_maxRecords; } /** *

The maximum number of records to include in the response. If more records * exist than the specified MaxRecords value, a pagination token * called a marker is included in the response so that the remaining results can be * retrieved.

Default: 100

Constraints: Minimum 20, maximum 100.

*/ inline bool MaxRecordsHasBeenSet() const { return m_maxRecordsHasBeenSet; } /** *

The maximum number of records to include in the response. If more records * exist than the specified MaxRecords value, a pagination token * called a marker is included in the response so that the remaining results can be * retrieved.

Default: 100

Constraints: Minimum 20, maximum 100.

*/ inline void SetMaxRecords(int value) { m_maxRecordsHasBeenSet = true; m_maxRecords = value; } /** *

The maximum number of records to include in the response. If more records * exist than the specified MaxRecords value, a pagination token * called a marker is included in the response so that the remaining results can be * retrieved.

Default: 100

Constraints: Minimum 20, maximum 100.

*/ inline DescribeDBClustersRequest& WithMaxRecords(int value) { SetMaxRecords(value); return *this;} /** *

An optional pagination token provided by a previous DescribeDBClusters * request. If this parameter is specified, the response includes only records * beyond the marker, up to the value specified by MaxRecords.

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

An optional pagination token provided by a previous DescribeDBClusters * request. If this parameter is specified, the response includes only records * beyond the marker, up to the value specified by MaxRecords.

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

An optional pagination token provided by a previous DescribeDBClusters * request. If this parameter is specified, the response includes only records * beyond the marker, up to the value specified by MaxRecords.

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

An optional pagination token provided by a previous DescribeDBClusters * request. If this parameter is specified, the response includes only records * beyond the marker, up to the value specified by MaxRecords.

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

An optional pagination token provided by a previous DescribeDBClusters * request. If this parameter is specified, the response includes only records * beyond the marker, up to the value specified by MaxRecords.

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

An optional pagination token provided by a previous DescribeDBClusters * request. If this parameter is specified, the response includes only records * beyond the marker, up to the value specified by MaxRecords.

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

An optional pagination token provided by a previous DescribeDBClusters * request. If this parameter is specified, the response includes only records * beyond the marker, up to the value specified by MaxRecords.

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

An optional pagination token provided by a previous DescribeDBClusters * request. If this parameter is specified, the response includes only records * beyond the marker, up to the value specified by MaxRecords.

*/ inline DescribeDBClustersRequest& WithMarker(const char* value) { SetMarker(value); return *this;} private: Aws::String m_dBClusterIdentifier; bool m_dBClusterIdentifierHasBeenSet = false; Aws::Vector m_filters; bool m_filtersHasBeenSet = false; int m_maxRecords; bool m_maxRecordsHasBeenSet = false; Aws::String m_marker; bool m_markerHasBeenSet = false; }; } // namespace Model } // namespace Neptune } // namespace Aws