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-cloudsearch/include/aws/cloudsearch/model/DescribeAnalysisSchemesRequest.h

175 lines
6.5 KiB
C++

/**
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
* SPDX-License-Identifier: Apache-2.0.
*/
#pragma once
#include <aws/cloudsearch/CloudSearch_EXPORTS.h>
#include <aws/cloudsearch/CloudSearchRequest.h>
#include <aws/core/utils/memory/stl/AWSString.h>
#include <aws/core/utils/memory/stl/AWSVector.h>
#include <utility>
namespace Aws
{
namespace CloudSearch
{
namespace Model
{
/**
* <p>Container for the parameters to the
* <code><a>DescribeAnalysisSchemes</a></code> operation. Specifies the name of the
* domain you want to describe. To limit the response to particular analysis
* schemes, specify the names of the analysis schemes you want to describe. To show
* the active configuration and exclude any pending changes, set the
* <code>Deployed</code> option to <code>true</code>. </p><p><h3>See Also:</h3>
* <a
* href="http://docs.aws.amazon.com/goto/WebAPI/cloudsearch-2013-01-01/DescribeAnalysisSchemesRequest">AWS
* API Reference</a></p>
*/
class AWS_CLOUDSEARCH_API DescribeAnalysisSchemesRequest : public CloudSearchRequest
{
public:
DescribeAnalysisSchemesRequest();
// 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 "DescribeAnalysisSchemes"; }
Aws::String SerializePayload() const override;
protected:
void DumpBodyToUrl(Aws::Http::URI& uri ) const override;
public:
/**
* <p>The name of the domain you want to describe.</p>
*/
inline const Aws::String& GetDomainName() const{ return m_domainName; }
/**
* <p>The name of the domain you want to describe.</p>
*/
inline bool DomainNameHasBeenSet() const { return m_domainNameHasBeenSet; }
/**
* <p>The name of the domain you want to describe.</p>
*/
inline void SetDomainName(const Aws::String& value) { m_domainNameHasBeenSet = true; m_domainName = value; }
/**
* <p>The name of the domain you want to describe.</p>
*/
inline void SetDomainName(Aws::String&& value) { m_domainNameHasBeenSet = true; m_domainName = std::move(value); }
/**
* <p>The name of the domain you want to describe.</p>
*/
inline void SetDomainName(const char* value) { m_domainNameHasBeenSet = true; m_domainName.assign(value); }
/**
* <p>The name of the domain you want to describe.</p>
*/
inline DescribeAnalysisSchemesRequest& WithDomainName(const Aws::String& value) { SetDomainName(value); return *this;}
/**
* <p>The name of the domain you want to describe.</p>
*/
inline DescribeAnalysisSchemesRequest& WithDomainName(Aws::String&& value) { SetDomainName(std::move(value)); return *this;}
/**
* <p>The name of the domain you want to describe.</p>
*/
inline DescribeAnalysisSchemesRequest& WithDomainName(const char* value) { SetDomainName(value); return *this;}
/**
* <p>The analysis schemes you want to describe.</p>
*/
inline const Aws::Vector<Aws::String>& GetAnalysisSchemeNames() const{ return m_analysisSchemeNames; }
/**
* <p>The analysis schemes you want to describe.</p>
*/
inline bool AnalysisSchemeNamesHasBeenSet() const { return m_analysisSchemeNamesHasBeenSet; }
/**
* <p>The analysis schemes you want to describe.</p>
*/
inline void SetAnalysisSchemeNames(const Aws::Vector<Aws::String>& value) { m_analysisSchemeNamesHasBeenSet = true; m_analysisSchemeNames = value; }
/**
* <p>The analysis schemes you want to describe.</p>
*/
inline void SetAnalysisSchemeNames(Aws::Vector<Aws::String>&& value) { m_analysisSchemeNamesHasBeenSet = true; m_analysisSchemeNames = std::move(value); }
/**
* <p>The analysis schemes you want to describe.</p>
*/
inline DescribeAnalysisSchemesRequest& WithAnalysisSchemeNames(const Aws::Vector<Aws::String>& value) { SetAnalysisSchemeNames(value); return *this;}
/**
* <p>The analysis schemes you want to describe.</p>
*/
inline DescribeAnalysisSchemesRequest& WithAnalysisSchemeNames(Aws::Vector<Aws::String>&& value) { SetAnalysisSchemeNames(std::move(value)); return *this;}
/**
* <p>The analysis schemes you want to describe.</p>
*/
inline DescribeAnalysisSchemesRequest& AddAnalysisSchemeNames(const Aws::String& value) { m_analysisSchemeNamesHasBeenSet = true; m_analysisSchemeNames.push_back(value); return *this; }
/**
* <p>The analysis schemes you want to describe.</p>
*/
inline DescribeAnalysisSchemesRequest& AddAnalysisSchemeNames(Aws::String&& value) { m_analysisSchemeNamesHasBeenSet = true; m_analysisSchemeNames.push_back(std::move(value)); return *this; }
/**
* <p>The analysis schemes you want to describe.</p>
*/
inline DescribeAnalysisSchemesRequest& AddAnalysisSchemeNames(const char* value) { m_analysisSchemeNamesHasBeenSet = true; m_analysisSchemeNames.push_back(value); return *this; }
/**
* <p>Whether to display the deployed configuration (<code>true</code>) or include
* any pending changes (<code>false</code>). Defaults to <code>false</code>.</p>
*/
inline bool GetDeployed() const{ return m_deployed; }
/**
* <p>Whether to display the deployed configuration (<code>true</code>) or include
* any pending changes (<code>false</code>). Defaults to <code>false</code>.</p>
*/
inline bool DeployedHasBeenSet() const { return m_deployedHasBeenSet; }
/**
* <p>Whether to display the deployed configuration (<code>true</code>) or include
* any pending changes (<code>false</code>). Defaults to <code>false</code>.</p>
*/
inline void SetDeployed(bool value) { m_deployedHasBeenSet = true; m_deployed = value; }
/**
* <p>Whether to display the deployed configuration (<code>true</code>) or include
* any pending changes (<code>false</code>). Defaults to <code>false</code>.</p>
*/
inline DescribeAnalysisSchemesRequest& WithDeployed(bool value) { SetDeployed(value); return *this;}
private:
Aws::String m_domainName;
bool m_domainNameHasBeenSet;
Aws::Vector<Aws::String> m_analysisSchemeNames;
bool m_analysisSchemeNamesHasBeenSet;
bool m_deployed;
bool m_deployedHasBeenSet;
};
} // namespace Model
} // namespace CloudSearch
} // namespace Aws