/** * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. * SPDX-License-Identifier: Apache-2.0. */ #pragma once #include #include #include #include #include namespace Aws { namespace CloudSearch { namespace Model { /** *

Container for the parameters to the DescribeIndexFields * operation. Specifies the name of the domain you want to describe. To restrict * the response to particular index fields, specify the names of the index fields * you want to describe. To show the active configuration and exclude any pending * changes, set the Deployed option to * true.

See Also:

AWS * API Reference

*/ class DescribeIndexFieldsRequest : public CloudSearchRequest { public: AWS_CLOUDSEARCH_API DescribeIndexFieldsRequest(); // 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 "DescribeIndexFields"; } AWS_CLOUDSEARCH_API Aws::String SerializePayload() const override; protected: AWS_CLOUDSEARCH_API void DumpBodyToUrl(Aws::Http::URI& uri ) const override; public: /** *

The name of the domain you want to describe.

*/ inline const Aws::String& GetDomainName() const{ return m_domainName; } /** *

The name of the domain you want to describe.

*/ inline bool DomainNameHasBeenSet() const { return m_domainNameHasBeenSet; } /** *

The name of the domain you want to describe.

*/ inline void SetDomainName(const Aws::String& value) { m_domainNameHasBeenSet = true; m_domainName = value; } /** *

The name of the domain you want to describe.

*/ inline void SetDomainName(Aws::String&& value) { m_domainNameHasBeenSet = true; m_domainName = std::move(value); } /** *

The name of the domain you want to describe.

*/ inline void SetDomainName(const char* value) { m_domainNameHasBeenSet = true; m_domainName.assign(value); } /** *

The name of the domain you want to describe.

*/ inline DescribeIndexFieldsRequest& WithDomainName(const Aws::String& value) { SetDomainName(value); return *this;} /** *

The name of the domain you want to describe.

*/ inline DescribeIndexFieldsRequest& WithDomainName(Aws::String&& value) { SetDomainName(std::move(value)); return *this;} /** *

The name of the domain you want to describe.

*/ inline DescribeIndexFieldsRequest& WithDomainName(const char* value) { SetDomainName(value); return *this;} /** *

A list of the index fields you want to describe. If not specified, * information is returned for all configured index fields.

*/ inline const Aws::Vector& GetFieldNames() const{ return m_fieldNames; } /** *

A list of the index fields you want to describe. If not specified, * information is returned for all configured index fields.

*/ inline bool FieldNamesHasBeenSet() const { return m_fieldNamesHasBeenSet; } /** *

A list of the index fields you want to describe. If not specified, * information is returned for all configured index fields.

*/ inline void SetFieldNames(const Aws::Vector& value) { m_fieldNamesHasBeenSet = true; m_fieldNames = value; } /** *

A list of the index fields you want to describe. If not specified, * information is returned for all configured index fields.

*/ inline void SetFieldNames(Aws::Vector&& value) { m_fieldNamesHasBeenSet = true; m_fieldNames = std::move(value); } /** *

A list of the index fields you want to describe. If not specified, * information is returned for all configured index fields.

*/ inline DescribeIndexFieldsRequest& WithFieldNames(const Aws::Vector& value) { SetFieldNames(value); return *this;} /** *

A list of the index fields you want to describe. If not specified, * information is returned for all configured index fields.

*/ inline DescribeIndexFieldsRequest& WithFieldNames(Aws::Vector&& value) { SetFieldNames(std::move(value)); return *this;} /** *

A list of the index fields you want to describe. If not specified, * information is returned for all configured index fields.

*/ inline DescribeIndexFieldsRequest& AddFieldNames(const Aws::String& value) { m_fieldNamesHasBeenSet = true; m_fieldNames.push_back(value); return *this; } /** *

A list of the index fields you want to describe. If not specified, * information is returned for all configured index fields.

*/ inline DescribeIndexFieldsRequest& AddFieldNames(Aws::String&& value) { m_fieldNamesHasBeenSet = true; m_fieldNames.push_back(std::move(value)); return *this; } /** *

A list of the index fields you want to describe. If not specified, * information is returned for all configured index fields.

*/ inline DescribeIndexFieldsRequest& AddFieldNames(const char* value) { m_fieldNamesHasBeenSet = true; m_fieldNames.push_back(value); return *this; } /** *

Whether to display the deployed configuration (true) or include * any pending changes (false). Defaults to false.

*/ inline bool GetDeployed() const{ return m_deployed; } /** *

Whether to display the deployed configuration (true) or include * any pending changes (false). Defaults to false.

*/ inline bool DeployedHasBeenSet() const { return m_deployedHasBeenSet; } /** *

Whether to display the deployed configuration (true) or include * any pending changes (false). Defaults to false.

*/ inline void SetDeployed(bool value) { m_deployedHasBeenSet = true; m_deployed = value; } /** *

Whether to display the deployed configuration (true) or include * any pending changes (false). Defaults to false.

*/ inline DescribeIndexFieldsRequest& WithDeployed(bool value) { SetDeployed(value); return *this;} private: Aws::String m_domainName; bool m_domainNameHasBeenSet = false; Aws::Vector m_fieldNames; bool m_fieldNamesHasBeenSet = false; bool m_deployed; bool m_deployedHasBeenSet = false; }; } // namespace Model } // namespace CloudSearch } // namespace Aws