/** * 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 Utils { namespace Json { class JsonValue; class JsonView; } // namespace Json } // namespace Utils namespace CloudSearchDomain { namespace Model { /** *

The collection of documents that match the search request.

See * Also:

AWS * API Reference

*/ class Hits { public: AWS_CLOUDSEARCHDOMAIN_API Hits(); AWS_CLOUDSEARCHDOMAIN_API Hits(Aws::Utils::Json::JsonView jsonValue); AWS_CLOUDSEARCHDOMAIN_API Hits& operator=(Aws::Utils::Json::JsonView jsonValue); AWS_CLOUDSEARCHDOMAIN_API Aws::Utils::Json::JsonValue Jsonize() const; /** *

The total number of documents that match the search request.

*/ inline long long GetFound() const{ return m_found; } /** *

The total number of documents that match the search request.

*/ inline bool FoundHasBeenSet() const { return m_foundHasBeenSet; } /** *

The total number of documents that match the search request.

*/ inline void SetFound(long long value) { m_foundHasBeenSet = true; m_found = value; } /** *

The total number of documents that match the search request.

*/ inline Hits& WithFound(long long value) { SetFound(value); return *this;} /** *

The index of the first matching document.

*/ inline long long GetStart() const{ return m_start; } /** *

The index of the first matching document.

*/ inline bool StartHasBeenSet() const { return m_startHasBeenSet; } /** *

The index of the first matching document.

*/ inline void SetStart(long long value) { m_startHasBeenSet = true; m_start = value; } /** *

The index of the first matching document.

*/ inline Hits& WithStart(long long value) { SetStart(value); return *this;} /** *

A cursor that can be used to retrieve the next set of matching documents when * you want to page through a large result set.

*/ inline const Aws::String& GetCursor() const{ return m_cursor; } /** *

A cursor that can be used to retrieve the next set of matching documents when * you want to page through a large result set.

*/ inline bool CursorHasBeenSet() const { return m_cursorHasBeenSet; } /** *

A cursor that can be used to retrieve the next set of matching documents when * you want to page through a large result set.

*/ inline void SetCursor(const Aws::String& value) { m_cursorHasBeenSet = true; m_cursor = value; } /** *

A cursor that can be used to retrieve the next set of matching documents when * you want to page through a large result set.

*/ inline void SetCursor(Aws::String&& value) { m_cursorHasBeenSet = true; m_cursor = std::move(value); } /** *

A cursor that can be used to retrieve the next set of matching documents when * you want to page through a large result set.

*/ inline void SetCursor(const char* value) { m_cursorHasBeenSet = true; m_cursor.assign(value); } /** *

A cursor that can be used to retrieve the next set of matching documents when * you want to page through a large result set.

*/ inline Hits& WithCursor(const Aws::String& value) { SetCursor(value); return *this;} /** *

A cursor that can be used to retrieve the next set of matching documents when * you want to page through a large result set.

*/ inline Hits& WithCursor(Aws::String&& value) { SetCursor(std::move(value)); return *this;} /** *

A cursor that can be used to retrieve the next set of matching documents when * you want to page through a large result set.

*/ inline Hits& WithCursor(const char* value) { SetCursor(value); return *this;} /** *

A document that matches the search request.

*/ inline const Aws::Vector& GetHit() const{ return m_hit; } /** *

A document that matches the search request.

*/ inline bool HitHasBeenSet() const { return m_hitHasBeenSet; } /** *

A document that matches the search request.

*/ inline void SetHit(const Aws::Vector& value) { m_hitHasBeenSet = true; m_hit = value; } /** *

A document that matches the search request.

*/ inline void SetHit(Aws::Vector&& value) { m_hitHasBeenSet = true; m_hit = std::move(value); } /** *

A document that matches the search request.

*/ inline Hits& WithHit(const Aws::Vector& value) { SetHit(value); return *this;} /** *

A document that matches the search request.

*/ inline Hits& WithHit(Aws::Vector&& value) { SetHit(std::move(value)); return *this;} /** *

A document that matches the search request.

*/ inline Hits& AddHit(const Hit& value) { m_hitHasBeenSet = true; m_hit.push_back(value); return *this; } /** *

A document that matches the search request.

*/ inline Hits& AddHit(Hit&& value) { m_hitHasBeenSet = true; m_hit.push_back(std::move(value)); return *this; } private: long long m_found; bool m_foundHasBeenSet = false; long long m_start; bool m_startHasBeenSet = false; Aws::String m_cursor; bool m_cursorHasBeenSet = false; Aws::Vector m_hit; bool m_hitHasBeenSet = false; }; } // namespace Model } // namespace CloudSearchDomain } // namespace Aws