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/LatLonOptions.h

218 lines
7.0 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 latlon field. A latlon field contains a location stored as a
* latitude and longitude value pair. Present if <code>IndexFieldType</code>
* specifies the field is of type <code>latlon</code>. 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/LatLonOptions">AWS
* API Reference</a></p>
*/
class AWS_CLOUDSEARCH_API LatLonOptions
{
public:
LatLonOptions();
LatLonOptions(const Aws::Utils::Xml::XmlNode& xmlNode);
LatLonOptions& 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 LatLonOptions& 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 LatLonOptions& 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 LatLonOptions& WithDefaultValue(const char* value) { SetDefaultValue(value); return *this;}
inline const Aws::String& GetSourceField() const{ return m_sourceField; }
inline bool SourceFieldHasBeenSet() const { return m_sourceFieldHasBeenSet; }
inline void SetSourceField(const Aws::String& value) { m_sourceFieldHasBeenSet = true; m_sourceField = value; }
inline void SetSourceField(Aws::String&& value) { m_sourceFieldHasBeenSet = true; m_sourceField = std::move(value); }
inline void SetSourceField(const char* value) { m_sourceFieldHasBeenSet = true; m_sourceField.assign(value); }
inline LatLonOptions& WithSourceField(const Aws::String& value) { SetSourceField(value); return *this;}
inline LatLonOptions& WithSourceField(Aws::String&& value) { SetSourceField(std::move(value)); return *this;}
inline LatLonOptions& WithSourceField(const char* value) { SetSourceField(value); return *this;}
/**
* <p>Whether facet information can be returned for the field.</p>
*/
inline bool GetFacetEnabled() const{ return m_facetEnabled; }
/**
* <p>Whether facet information can be returned for the field.</p>
*/
inline bool FacetEnabledHasBeenSet() const { return m_facetEnabledHasBeenSet; }
/**
* <p>Whether facet information can be returned for the field.</p>
*/
inline void SetFacetEnabled(bool value) { m_facetEnabledHasBeenSet = true; m_facetEnabled = value; }
/**
* <p>Whether facet information can be returned for the field.</p>
*/
inline LatLonOptions& WithFacetEnabled(bool value) { SetFacetEnabled(value); return *this;}
/**
* <p>Whether the contents of the field are searchable.</p>
*/
inline bool GetSearchEnabled() const{ return m_searchEnabled; }
/**
* <p>Whether the contents of the field are searchable.</p>
*/
inline bool SearchEnabledHasBeenSet() const { return m_searchEnabledHasBeenSet; }
/**
* <p>Whether the contents of the field are searchable.</p>
*/
inline void SetSearchEnabled(bool value) { m_searchEnabledHasBeenSet = true; m_searchEnabled = value; }
/**
* <p>Whether the contents of the field are searchable.</p>
*/
inline LatLonOptions& WithSearchEnabled(bool value) { SetSearchEnabled(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 LatLonOptions& WithReturnEnabled(bool value) { SetReturnEnabled(value); return *this;}
/**
* <p>Whether the field can be used to sort the search results.</p>
*/
inline bool GetSortEnabled() const{ return m_sortEnabled; }
/**
* <p>Whether the field can be used to sort the search results.</p>
*/
inline bool SortEnabledHasBeenSet() const { return m_sortEnabledHasBeenSet; }
/**
* <p>Whether the field can be used to sort the search results.</p>
*/
inline void SetSortEnabled(bool value) { m_sortEnabledHasBeenSet = true; m_sortEnabled = value; }
/**
* <p>Whether the field can be used to sort the search results.</p>
*/
inline LatLonOptions& WithSortEnabled(bool value) { SetSortEnabled(value); return *this;}
private:
Aws::String m_defaultValue;
bool m_defaultValueHasBeenSet;
Aws::String m_sourceField;
bool m_sourceFieldHasBeenSet;
bool m_facetEnabled;
bool m_facetEnabledHasBeenSet;
bool m_searchEnabled;
bool m_searchEnabledHasBeenSet;
bool m_returnEnabled;
bool m_returnEnabledHasBeenSet;
bool m_sortEnabled;
bool m_sortEnabledHasBeenSet;
};
} // namespace Model
} // namespace CloudSearch
} // namespace Aws