230 lines
7.9 KiB
C++
230 lines
7.9 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/core/utils/memory/stl/AWSStreamFwd.h>
|
|
#include <aws/core/utils/memory/stl/AWSString.h>
|
|
#include <utility>
|
|
|
|
namespace Aws
|
|
{
|
|
namespace Utils
|
|
{
|
|
namespace Xml
|
|
{
|
|
class XmlNode;
|
|
} // namespace Xml
|
|
} // namespace Utils
|
|
namespace CloudSearch
|
|
{
|
|
namespace Model
|
|
{
|
|
|
|
/**
|
|
* <p>Options for a field that contains an array of text strings. Present if
|
|
* <code>IndexFieldType</code> specifies the field is of type
|
|
* <code>text-array</code>. A <code>text-array</code> field is always searchable.
|
|
* All options are enabled by default.</p><p><h3>See Also:</h3> <a
|
|
* href="http://docs.aws.amazon.com/goto/WebAPI/cloudsearch-2013-01-01/TextArrayOptions">AWS
|
|
* API Reference</a></p>
|
|
*/
|
|
class AWS_CLOUDSEARCH_API TextArrayOptions
|
|
{
|
|
public:
|
|
TextArrayOptions();
|
|
TextArrayOptions(const Aws::Utils::Xml::XmlNode& xmlNode);
|
|
TextArrayOptions& operator=(const Aws::Utils::Xml::XmlNode& xmlNode);
|
|
|
|
void OutputToStream(Aws::OStream& ostream, const char* location, unsigned index, const char* locationValue) const;
|
|
void OutputToStream(Aws::OStream& oStream, const char* location) const;
|
|
|
|
|
|
/**
|
|
* A value to use for the field if the field isn't specified for a document.
|
|
*/
|
|
inline const Aws::String& GetDefaultValue() const{ return m_defaultValue; }
|
|
|
|
/**
|
|
* A value to use for the field if the field isn't specified for a document.
|
|
*/
|
|
inline bool DefaultValueHasBeenSet() const { return m_defaultValueHasBeenSet; }
|
|
|
|
/**
|
|
* A value to use for the field if the field isn't specified for a document.
|
|
*/
|
|
inline void SetDefaultValue(const Aws::String& value) { m_defaultValueHasBeenSet = true; m_defaultValue = value; }
|
|
|
|
/**
|
|
* A value to use for the field if the field isn't specified for a document.
|
|
*/
|
|
inline void SetDefaultValue(Aws::String&& value) { m_defaultValueHasBeenSet = true; m_defaultValue = std::move(value); }
|
|
|
|
/**
|
|
* A value to use for the field if the field isn't specified for a document.
|
|
*/
|
|
inline void SetDefaultValue(const char* value) { m_defaultValueHasBeenSet = true; m_defaultValue.assign(value); }
|
|
|
|
/**
|
|
* A value to use for the field if the field isn't specified for a document.
|
|
*/
|
|
inline TextArrayOptions& WithDefaultValue(const Aws::String& value) { SetDefaultValue(value); return *this;}
|
|
|
|
/**
|
|
* A value to use for the field if the field isn't specified for a document.
|
|
*/
|
|
inline TextArrayOptions& WithDefaultValue(Aws::String&& value) { SetDefaultValue(std::move(value)); return *this;}
|
|
|
|
/**
|
|
* A value to use for the field if the field isn't specified for a document.
|
|
*/
|
|
inline TextArrayOptions& WithDefaultValue(const char* value) { SetDefaultValue(value); return *this;}
|
|
|
|
|
|
/**
|
|
* <p>A list of source fields to map to the field. </p>
|
|
*/
|
|
inline const Aws::String& GetSourceFields() const{ return m_sourceFields; }
|
|
|
|
/**
|
|
* <p>A list of source fields to map to the field. </p>
|
|
*/
|
|
inline bool SourceFieldsHasBeenSet() const { return m_sourceFieldsHasBeenSet; }
|
|
|
|
/**
|
|
* <p>A list of source fields to map to the field. </p>
|
|
*/
|
|
inline void SetSourceFields(const Aws::String& value) { m_sourceFieldsHasBeenSet = true; m_sourceFields = value; }
|
|
|
|
/**
|
|
* <p>A list of source fields to map to the field. </p>
|
|
*/
|
|
inline void SetSourceFields(Aws::String&& value) { m_sourceFieldsHasBeenSet = true; m_sourceFields = std::move(value); }
|
|
|
|
/**
|
|
* <p>A list of source fields to map to the field. </p>
|
|
*/
|
|
inline void SetSourceFields(const char* value) { m_sourceFieldsHasBeenSet = true; m_sourceFields.assign(value); }
|
|
|
|
/**
|
|
* <p>A list of source fields to map to the field. </p>
|
|
*/
|
|
inline TextArrayOptions& WithSourceFields(const Aws::String& value) { SetSourceFields(value); return *this;}
|
|
|
|
/**
|
|
* <p>A list of source fields to map to the field. </p>
|
|
*/
|
|
inline TextArrayOptions& WithSourceFields(Aws::String&& value) { SetSourceFields(std::move(value)); return *this;}
|
|
|
|
/**
|
|
* <p>A list of source fields to map to the field. </p>
|
|
*/
|
|
inline TextArrayOptions& WithSourceFields(const char* value) { SetSourceFields(value); return *this;}
|
|
|
|
|
|
/**
|
|
* <p>Whether the contents of the field can be returned in the search results.</p>
|
|
*/
|
|
inline bool GetReturnEnabled() const{ return m_returnEnabled; }
|
|
|
|
/**
|
|
* <p>Whether the contents of the field can be returned in the search results.</p>
|
|
*/
|
|
inline bool ReturnEnabledHasBeenSet() const { return m_returnEnabledHasBeenSet; }
|
|
|
|
/**
|
|
* <p>Whether the contents of the field can be returned in the search results.</p>
|
|
*/
|
|
inline void SetReturnEnabled(bool value) { m_returnEnabledHasBeenSet = true; m_returnEnabled = value; }
|
|
|
|
/**
|
|
* <p>Whether the contents of the field can be returned in the search results.</p>
|
|
*/
|
|
inline TextArrayOptions& WithReturnEnabled(bool value) { SetReturnEnabled(value); return *this;}
|
|
|
|
|
|
/**
|
|
* <p>Whether highlights can be returned for the field.</p>
|
|
*/
|
|
inline bool GetHighlightEnabled() const{ return m_highlightEnabled; }
|
|
|
|
/**
|
|
* <p>Whether highlights can be returned for the field.</p>
|
|
*/
|
|
inline bool HighlightEnabledHasBeenSet() const { return m_highlightEnabledHasBeenSet; }
|
|
|
|
/**
|
|
* <p>Whether highlights can be returned for the field.</p>
|
|
*/
|
|
inline void SetHighlightEnabled(bool value) { m_highlightEnabledHasBeenSet = true; m_highlightEnabled = value; }
|
|
|
|
/**
|
|
* <p>Whether highlights can be returned for the field.</p>
|
|
*/
|
|
inline TextArrayOptions& WithHighlightEnabled(bool value) { SetHighlightEnabled(value); return *this;}
|
|
|
|
|
|
/**
|
|
* <p>The name of an analysis scheme for a <code>text-array</code> field.</p>
|
|
*/
|
|
inline const Aws::String& GetAnalysisScheme() const{ return m_analysisScheme; }
|
|
|
|
/**
|
|
* <p>The name of an analysis scheme for a <code>text-array</code> field.</p>
|
|
*/
|
|
inline bool AnalysisSchemeHasBeenSet() const { return m_analysisSchemeHasBeenSet; }
|
|
|
|
/**
|
|
* <p>The name of an analysis scheme for a <code>text-array</code> field.</p>
|
|
*/
|
|
inline void SetAnalysisScheme(const Aws::String& value) { m_analysisSchemeHasBeenSet = true; m_analysisScheme = value; }
|
|
|
|
/**
|
|
* <p>The name of an analysis scheme for a <code>text-array</code> field.</p>
|
|
*/
|
|
inline void SetAnalysisScheme(Aws::String&& value) { m_analysisSchemeHasBeenSet = true; m_analysisScheme = std::move(value); }
|
|
|
|
/**
|
|
* <p>The name of an analysis scheme for a <code>text-array</code> field.</p>
|
|
*/
|
|
inline void SetAnalysisScheme(const char* value) { m_analysisSchemeHasBeenSet = true; m_analysisScheme.assign(value); }
|
|
|
|
/**
|
|
* <p>The name of an analysis scheme for a <code>text-array</code> field.</p>
|
|
*/
|
|
inline TextArrayOptions& WithAnalysisScheme(const Aws::String& value) { SetAnalysisScheme(value); return *this;}
|
|
|
|
/**
|
|
* <p>The name of an analysis scheme for a <code>text-array</code> field.</p>
|
|
*/
|
|
inline TextArrayOptions& WithAnalysisScheme(Aws::String&& value) { SetAnalysisScheme(std::move(value)); return *this;}
|
|
|
|
/**
|
|
* <p>The name of an analysis scheme for a <code>text-array</code> field.</p>
|
|
*/
|
|
inline TextArrayOptions& WithAnalysisScheme(const char* value) { SetAnalysisScheme(value); return *this;}
|
|
|
|
private:
|
|
|
|
Aws::String m_defaultValue;
|
|
bool m_defaultValueHasBeenSet;
|
|
|
|
Aws::String m_sourceFields;
|
|
bool m_sourceFieldsHasBeenSet;
|
|
|
|
bool m_returnEnabled;
|
|
bool m_returnEnabledHasBeenSet;
|
|
|
|
bool m_highlightEnabled;
|
|
bool m_highlightEnabledHasBeenSet;
|
|
|
|
Aws::String m_analysisScheme;
|
|
bool m_analysisSchemeHasBeenSet;
|
|
};
|
|
|
|
} // namespace Model
|
|
} // namespace CloudSearch
|
|
} // namespace Aws
|