This repository has been archived on 2025-09-14. You can view files and clone it, but cannot push or open issues or pull requests.
Files
pxz-hos-client-cpp-module/support/aws-sdk-cpp-master/aws-cpp-sdk-redshift/include/aws/redshift/model/DescribeClusterVersionsRequest.h

287 lines
14 KiB
C++

/**
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
* SPDX-License-Identifier: Apache-2.0.
*/
#pragma once
#include <aws/redshift/Redshift_EXPORTS.h>
#include <aws/redshift/RedshiftRequest.h>
#include <aws/core/utils/memory/stl/AWSString.h>
#include <utility>
namespace Aws
{
namespace Redshift
{
namespace Model
{
/**
* <p/><p><h3>See Also:</h3> <a
* href="http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/DescribeClusterVersionsMessage">AWS
* API Reference</a></p>
*/
class AWS_REDSHIFT_API DescribeClusterVersionsRequest : public RedshiftRequest
{
public:
DescribeClusterVersionsRequest();
// 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 "DescribeClusterVersions"; }
Aws::String SerializePayload() const override;
protected:
void DumpBodyToUrl(Aws::Http::URI& uri ) const override;
public:
/**
* <p>The specific cluster version to return.</p> <p>Example: <code>1.0</code> </p>
*/
inline const Aws::String& GetClusterVersion() const{ return m_clusterVersion; }
/**
* <p>The specific cluster version to return.</p> <p>Example: <code>1.0</code> </p>
*/
inline bool ClusterVersionHasBeenSet() const { return m_clusterVersionHasBeenSet; }
/**
* <p>The specific cluster version to return.</p> <p>Example: <code>1.0</code> </p>
*/
inline void SetClusterVersion(const Aws::String& value) { m_clusterVersionHasBeenSet = true; m_clusterVersion = value; }
/**
* <p>The specific cluster version to return.</p> <p>Example: <code>1.0</code> </p>
*/
inline void SetClusterVersion(Aws::String&& value) { m_clusterVersionHasBeenSet = true; m_clusterVersion = std::move(value); }
/**
* <p>The specific cluster version to return.</p> <p>Example: <code>1.0</code> </p>
*/
inline void SetClusterVersion(const char* value) { m_clusterVersionHasBeenSet = true; m_clusterVersion.assign(value); }
/**
* <p>The specific cluster version to return.</p> <p>Example: <code>1.0</code> </p>
*/
inline DescribeClusterVersionsRequest& WithClusterVersion(const Aws::String& value) { SetClusterVersion(value); return *this;}
/**
* <p>The specific cluster version to return.</p> <p>Example: <code>1.0</code> </p>
*/
inline DescribeClusterVersionsRequest& WithClusterVersion(Aws::String&& value) { SetClusterVersion(std::move(value)); return *this;}
/**
* <p>The specific cluster version to return.</p> <p>Example: <code>1.0</code> </p>
*/
inline DescribeClusterVersionsRequest& WithClusterVersion(const char* value) { SetClusterVersion(value); return *this;}
/**
* <p>The name of a specific cluster parameter group family to return details
* for.</p> <p>Constraints:</p> <ul> <li> <p>Must be 1 to 255 alphanumeric
* characters</p> </li> <li> <p>First character must be a letter</p> </li> <li>
* <p>Cannot end with a hyphen or contain two consecutive hyphens</p> </li> </ul>
*/
inline const Aws::String& GetClusterParameterGroupFamily() const{ return m_clusterParameterGroupFamily; }
/**
* <p>The name of a specific cluster parameter group family to return details
* for.</p> <p>Constraints:</p> <ul> <li> <p>Must be 1 to 255 alphanumeric
* characters</p> </li> <li> <p>First character must be a letter</p> </li> <li>
* <p>Cannot end with a hyphen or contain two consecutive hyphens</p> </li> </ul>
*/
inline bool ClusterParameterGroupFamilyHasBeenSet() const { return m_clusterParameterGroupFamilyHasBeenSet; }
/**
* <p>The name of a specific cluster parameter group family to return details
* for.</p> <p>Constraints:</p> <ul> <li> <p>Must be 1 to 255 alphanumeric
* characters</p> </li> <li> <p>First character must be a letter</p> </li> <li>
* <p>Cannot end with a hyphen or contain two consecutive hyphens</p> </li> </ul>
*/
inline void SetClusterParameterGroupFamily(const Aws::String& value) { m_clusterParameterGroupFamilyHasBeenSet = true; m_clusterParameterGroupFamily = value; }
/**
* <p>The name of a specific cluster parameter group family to return details
* for.</p> <p>Constraints:</p> <ul> <li> <p>Must be 1 to 255 alphanumeric
* characters</p> </li> <li> <p>First character must be a letter</p> </li> <li>
* <p>Cannot end with a hyphen or contain two consecutive hyphens</p> </li> </ul>
*/
inline void SetClusterParameterGroupFamily(Aws::String&& value) { m_clusterParameterGroupFamilyHasBeenSet = true; m_clusterParameterGroupFamily = std::move(value); }
/**
* <p>The name of a specific cluster parameter group family to return details
* for.</p> <p>Constraints:</p> <ul> <li> <p>Must be 1 to 255 alphanumeric
* characters</p> </li> <li> <p>First character must be a letter</p> </li> <li>
* <p>Cannot end with a hyphen or contain two consecutive hyphens</p> </li> </ul>
*/
inline void SetClusterParameterGroupFamily(const char* value) { m_clusterParameterGroupFamilyHasBeenSet = true; m_clusterParameterGroupFamily.assign(value); }
/**
* <p>The name of a specific cluster parameter group family to return details
* for.</p> <p>Constraints:</p> <ul> <li> <p>Must be 1 to 255 alphanumeric
* characters</p> </li> <li> <p>First character must be a letter</p> </li> <li>
* <p>Cannot end with a hyphen or contain two consecutive hyphens</p> </li> </ul>
*/
inline DescribeClusterVersionsRequest& WithClusterParameterGroupFamily(const Aws::String& value) { SetClusterParameterGroupFamily(value); return *this;}
/**
* <p>The name of a specific cluster parameter group family to return details
* for.</p> <p>Constraints:</p> <ul> <li> <p>Must be 1 to 255 alphanumeric
* characters</p> </li> <li> <p>First character must be a letter</p> </li> <li>
* <p>Cannot end with a hyphen or contain two consecutive hyphens</p> </li> </ul>
*/
inline DescribeClusterVersionsRequest& WithClusterParameterGroupFamily(Aws::String&& value) { SetClusterParameterGroupFamily(std::move(value)); return *this;}
/**
* <p>The name of a specific cluster parameter group family to return details
* for.</p> <p>Constraints:</p> <ul> <li> <p>Must be 1 to 255 alphanumeric
* characters</p> </li> <li> <p>First character must be a letter</p> </li> <li>
* <p>Cannot end with a hyphen or contain two consecutive hyphens</p> </li> </ul>
*/
inline DescribeClusterVersionsRequest& WithClusterParameterGroupFamily(const char* value) { SetClusterParameterGroupFamily(value); return *this;}
/**
* <p>The maximum number of response records to return in each call. If the number
* of remaining response records exceeds the specified <code>MaxRecords</code>
* value, a value is returned in a <code>marker</code> field of the response. You
* can retrieve the next set of records by retrying the command with the returned
* marker value. </p> <p>Default: <code>100</code> </p> <p>Constraints: minimum 20,
* maximum 100.</p>
*/
inline int GetMaxRecords() const{ return m_maxRecords; }
/**
* <p>The maximum number of response records to return in each call. If the number
* of remaining response records exceeds the specified <code>MaxRecords</code>
* value, a value is returned in a <code>marker</code> field of the response. You
* can retrieve the next set of records by retrying the command with the returned
* marker value. </p> <p>Default: <code>100</code> </p> <p>Constraints: minimum 20,
* maximum 100.</p>
*/
inline bool MaxRecordsHasBeenSet() const { return m_maxRecordsHasBeenSet; }
/**
* <p>The maximum number of response records to return in each call. If the number
* of remaining response records exceeds the specified <code>MaxRecords</code>
* value, a value is returned in a <code>marker</code> field of the response. You
* can retrieve the next set of records by retrying the command with the returned
* marker value. </p> <p>Default: <code>100</code> </p> <p>Constraints: minimum 20,
* maximum 100.</p>
*/
inline void SetMaxRecords(int value) { m_maxRecordsHasBeenSet = true; m_maxRecords = value; }
/**
* <p>The maximum number of response records to return in each call. If the number
* of remaining response records exceeds the specified <code>MaxRecords</code>
* value, a value is returned in a <code>marker</code> field of the response. You
* can retrieve the next set of records by retrying the command with the returned
* marker value. </p> <p>Default: <code>100</code> </p> <p>Constraints: minimum 20,
* maximum 100.</p>
*/
inline DescribeClusterVersionsRequest& WithMaxRecords(int value) { SetMaxRecords(value); return *this;}
/**
* <p>An optional parameter that specifies the starting point to return a set of
* response records. When the results of a <a>DescribeClusterVersions</a> request
* exceed the value specified in <code>MaxRecords</code>, AWS returns a value in
* the <code>Marker</code> field of the response. You can retrieve the next set of
* response records by providing the returned marker value in the
* <code>Marker</code> parameter and retrying the request. </p>
*/
inline const Aws::String& GetMarker() const{ return m_marker; }
/**
* <p>An optional parameter that specifies the starting point to return a set of
* response records. When the results of a <a>DescribeClusterVersions</a> request
* exceed the value specified in <code>MaxRecords</code>, AWS returns a value in
* the <code>Marker</code> field of the response. You can retrieve the next set of
* response records by providing the returned marker value in the
* <code>Marker</code> parameter and retrying the request. </p>
*/
inline bool MarkerHasBeenSet() const { return m_markerHasBeenSet; }
/**
* <p>An optional parameter that specifies the starting point to return a set of
* response records. When the results of a <a>DescribeClusterVersions</a> request
* exceed the value specified in <code>MaxRecords</code>, AWS returns a value in
* the <code>Marker</code> field of the response. You can retrieve the next set of
* response records by providing the returned marker value in the
* <code>Marker</code> parameter and retrying the request. </p>
*/
inline void SetMarker(const Aws::String& value) { m_markerHasBeenSet = true; m_marker = value; }
/**
* <p>An optional parameter that specifies the starting point to return a set of
* response records. When the results of a <a>DescribeClusterVersions</a> request
* exceed the value specified in <code>MaxRecords</code>, AWS returns a value in
* the <code>Marker</code> field of the response. You can retrieve the next set of
* response records by providing the returned marker value in the
* <code>Marker</code> parameter and retrying the request. </p>
*/
inline void SetMarker(Aws::String&& value) { m_markerHasBeenSet = true; m_marker = std::move(value); }
/**
* <p>An optional parameter that specifies the starting point to return a set of
* response records. When the results of a <a>DescribeClusterVersions</a> request
* exceed the value specified in <code>MaxRecords</code>, AWS returns a value in
* the <code>Marker</code> field of the response. You can retrieve the next set of
* response records by providing the returned marker value in the
* <code>Marker</code> parameter and retrying the request. </p>
*/
inline void SetMarker(const char* value) { m_markerHasBeenSet = true; m_marker.assign(value); }
/**
* <p>An optional parameter that specifies the starting point to return a set of
* response records. When the results of a <a>DescribeClusterVersions</a> request
* exceed the value specified in <code>MaxRecords</code>, AWS returns a value in
* the <code>Marker</code> field of the response. You can retrieve the next set of
* response records by providing the returned marker value in the
* <code>Marker</code> parameter and retrying the request. </p>
*/
inline DescribeClusterVersionsRequest& WithMarker(const Aws::String& value) { SetMarker(value); return *this;}
/**
* <p>An optional parameter that specifies the starting point to return a set of
* response records. When the results of a <a>DescribeClusterVersions</a> request
* exceed the value specified in <code>MaxRecords</code>, AWS returns a value in
* the <code>Marker</code> field of the response. You can retrieve the next set of
* response records by providing the returned marker value in the
* <code>Marker</code> parameter and retrying the request. </p>
*/
inline DescribeClusterVersionsRequest& WithMarker(Aws::String&& value) { SetMarker(std::move(value)); return *this;}
/**
* <p>An optional parameter that specifies the starting point to return a set of
* response records. When the results of a <a>DescribeClusterVersions</a> request
* exceed the value specified in <code>MaxRecords</code>, AWS returns a value in
* the <code>Marker</code> field of the response. You can retrieve the next set of
* response records by providing the returned marker value in the
* <code>Marker</code> parameter and retrying the request. </p>
*/
inline DescribeClusterVersionsRequest& WithMarker(const char* value) { SetMarker(value); return *this;}
private:
Aws::String m_clusterVersion;
bool m_clusterVersionHasBeenSet;
Aws::String m_clusterParameterGroupFamily;
bool m_clusterParameterGroupFamilyHasBeenSet;
int m_maxRecords;
bool m_maxRecordsHasBeenSet;
Aws::String m_marker;
bool m_markerHasBeenSet;
};
} // namespace Model
} // namespace Redshift
} // namespace Aws