ScanRequest.h

 
#pragma once
#include <aws/core/utils/memory/stl/AWSMap.h>
#include <aws/core/utils/memory/stl/AWSString.h>
#include <aws/core/utils/memory/stl/AWSVector.h>
#include <aws/dynamodb/DynamoDBRequest.h>
#include <aws/dynamodb/DynamoDB_EXPORTS.h>
#include <aws/dynamodb/model/AttributeValue.h>
#include <aws/dynamodb/model/Condition.h>
#include <aws/dynamodb/model/ConditionalOperator.h>
#include <aws/dynamodb/model/ReturnConsumedCapacity.h>
#include <aws/dynamodb/model/Select.h>
 
#include <utility>
 
namespace Aws {
namespace DynamoDB {
namespace Model {
 
class ScanRequest : public DynamoDBRequest {
 public:
  AWS_DYNAMODB_API ScanRequest() = default;
 
  // 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 "Scan"; }
 
  AWS_DYNAMODB_API Aws::String SerializePayload() const override;
 
  AWS_DYNAMODB_API Aws::Http::HeaderValueCollection GetRequestSpecificHeaders() const override;
 
  AWS_DYNAMODB_API EndpointParameters GetEndpointContextParams() const override;
 
 
  inline const Aws::String& GetTableName() const { return m_tableName; }
  inline bool TableNameHasBeenSet() const { return m_tableNameHasBeenSet; }
  template <typename TableNameT = Aws::String>
  void SetTableName(TableNameT&& value) {
    m_tableNameHasBeenSet = true;
    m_tableName = std::forward<TableNameT>(value);
  }
  template <typename TableNameT = Aws::String>
  ScanRequest& WithTableName(TableNameT&& value) {
    SetTableName(std::forward<TableNameT>(value));
    return *this;
  }
 
 
  inline const Aws::String& GetIndexName() const { return m_indexName; }
  inline bool IndexNameHasBeenSet() const { return m_indexNameHasBeenSet; }
  template <typename IndexNameT = Aws::String>
  void SetIndexName(IndexNameT&& value) {
    m_indexNameHasBeenSet = true;
    m_indexName = std::forward<IndexNameT>(value);
  }
  template <typename IndexNameT = Aws::String>
  ScanRequest& WithIndexName(IndexNameT&& value) {
    SetIndexName(std::forward<IndexNameT>(value));
    return *this;
  }
 
 
  inline const Aws::Vector<Aws::String>& GetAttributesToGet() const { return m_attributesToGet; }
  inline bool AttributesToGetHasBeenSet() const { return m_attributesToGetHasBeenSet; }
  template <typename AttributesToGetT = Aws::Vector<Aws::String>>
  void SetAttributesToGet(AttributesToGetT&& value) {
    m_attributesToGetHasBeenSet = true;
    m_attributesToGet = std::forward<AttributesToGetT>(value);
  }
  template <typename AttributesToGetT = Aws::Vector<Aws::String>>
  ScanRequest& WithAttributesToGet(AttributesToGetT&& value) {
    SetAttributesToGet(std::forward<AttributesToGetT>(value));
    return *this;
  }
  template <typename AttributesToGetT = Aws::String>
  ScanRequest& AddAttributesToGet(AttributesToGetT&& value) {
    m_attributesToGetHasBeenSet = true;
    m_attributesToGet.emplace_back(std::forward<AttributesToGetT>(value));
    return *this;
  }
 
 
  inline int GetLimit() const { return m_limit; }
  inline bool LimitHasBeenSet() const { return m_limitHasBeenSet; }
  inline void SetLimit(int value) {
    m_limitHasBeenSet = true;
    m_limit = value;
  }
  inline ScanRequest& WithLimit(int value) {
    SetLimit(value);
    return *this;
  }
 
 
  inline Select GetSelect() const { return m_select; }
  inline bool SelectHasBeenSet() const { return m_selectHasBeenSet; }
  inline void SetSelect(Select value) {
    m_selectHasBeenSet = true;
    m_select = value;
  }
  inline ScanRequest& WithSelect(Select value) {
    SetSelect(value);
    return *this;
  }
 
 
  inline const Aws::Map<Aws::String, Condition>& GetScanFilter() const { return m_scanFilter; }
  inline bool ScanFilterHasBeenSet() const { return m_scanFilterHasBeenSet; }
  template <typename ScanFilterT = Aws::Map<Aws::String, Condition>>
  void SetScanFilter(ScanFilterT&& value) {
    m_scanFilterHasBeenSet = true;
    m_scanFilter = std::forward<ScanFilterT>(value);
  }
  template <typename ScanFilterT = Aws::Map<Aws::String, Condition>>
  ScanRequest& WithScanFilter(ScanFilterT&& value) {
    SetScanFilter(std::forward<ScanFilterT>(value));
    return *this;
  }
  template <typename ScanFilterKeyT = Aws::String, typename ScanFilterValueT = Condition>
  ScanRequest& AddScanFilter(ScanFilterKeyT&& key, ScanFilterValueT&& value) {
    m_scanFilterHasBeenSet = true;
    m_scanFilter.emplace(std::forward<ScanFilterKeyT>(key), std::forward<ScanFilterValueT>(value));
    return *this;
  }
 
 
  inline ConditionalOperator GetConditionalOperator() const { return m_conditionalOperator; }
  inline bool ConditionalOperatorHasBeenSet() const { return m_conditionalOperatorHasBeenSet; }
  inline void SetConditionalOperator(ConditionalOperator value) {
    m_conditionalOperatorHasBeenSet = true;
    m_conditionalOperator = value;
  }
  inline ScanRequest& WithConditionalOperator(ConditionalOperator value) {
    SetConditionalOperator(value);
    return *this;
  }
 
 
  inline const Aws::Map<Aws::String, AttributeValue>& GetExclusiveStartKey() const { return m_exclusiveStartKey; }
  inline bool ExclusiveStartKeyHasBeenSet() const { return m_exclusiveStartKeyHasBeenSet; }
  template <typename ExclusiveStartKeyT = Aws::Map<Aws::String, AttributeValue>>
  void SetExclusiveStartKey(ExclusiveStartKeyT&& value) {
    m_exclusiveStartKeyHasBeenSet = true;
    m_exclusiveStartKey = std::forward<ExclusiveStartKeyT>(value);
  }
  template <typename ExclusiveStartKeyT = Aws::Map<Aws::String, AttributeValue>>
  ScanRequest& WithExclusiveStartKey(ExclusiveStartKeyT&& value) {
    SetExclusiveStartKey(std::forward<ExclusiveStartKeyT>(value));
    return *this;
  }
  template <typename ExclusiveStartKeyKeyT = Aws::String, typename ExclusiveStartKeyValueT = AttributeValue>
  ScanRequest& AddExclusiveStartKey(ExclusiveStartKeyKeyT&& key, ExclusiveStartKeyValueT&& value) {
    m_exclusiveStartKeyHasBeenSet = true;
    m_exclusiveStartKey.emplace(std::forward<ExclusiveStartKeyKeyT>(key), std::forward<ExclusiveStartKeyValueT>(value));
    return *this;
  }
 
 
  inline ReturnConsumedCapacity GetReturnConsumedCapacity() const { return m_returnConsumedCapacity; }
  inline bool ReturnConsumedCapacityHasBeenSet() const { return m_returnConsumedCapacityHasBeenSet; }
  inline void SetReturnConsumedCapacity(ReturnConsumedCapacity value) {
    m_returnConsumedCapacityHasBeenSet = true;
    m_returnConsumedCapacity = value;
  }
  inline ScanRequest& WithReturnConsumedCapacity(ReturnConsumedCapacity value) {
    SetReturnConsumedCapacity(value);
    return *this;
  }
 
 
  inline int GetTotalSegments() const { return m_totalSegments; }
  inline bool TotalSegmentsHasBeenSet() const { return m_totalSegmentsHasBeenSet; }
  inline void SetTotalSegments(int value) {
    m_totalSegmentsHasBeenSet = true;
    m_totalSegments = value;
  }
  inline ScanRequest& WithTotalSegments(int value) {
    SetTotalSegments(value);
    return *this;
  }
 
 
  inline int GetSegment() const { return m_segment; }
  inline bool SegmentHasBeenSet() const { return m_segmentHasBeenSet; }
  inline void SetSegment(int value) {
    m_segmentHasBeenSet = true;
    m_segment = value;
  }
  inline ScanRequest& WithSegment(int value) {
    SetSegment(value);
    return *this;
  }
 
 
  inline const Aws::String& GetProjectionExpression() const { return m_projectionExpression; }
  inline bool ProjectionExpressionHasBeenSet() const { return m_projectionExpressionHasBeenSet; }
  template <typename ProjectionExpressionT = Aws::String>
  void SetProjectionExpression(ProjectionExpressionT&& value) {
    m_projectionExpressionHasBeenSet = true;
    m_projectionExpression = std::forward<ProjectionExpressionT>(value);
  }
  template <typename ProjectionExpressionT = Aws::String>
  ScanRequest& WithProjectionExpression(ProjectionExpressionT&& value) {
    SetProjectionExpression(std::forward<ProjectionExpressionT>(value));
    return *this;
  }
 
 
  inline const Aws::String& GetFilterExpression() const { return m_filterExpression; }
  inline bool FilterExpressionHasBeenSet() const { return m_filterExpressionHasBeenSet; }
  template <typename FilterExpressionT = Aws::String>
  void SetFilterExpression(FilterExpressionT&& value) {
    m_filterExpressionHasBeenSet = true;
    m_filterExpression = std::forward<FilterExpressionT>(value);
  }
  template <typename FilterExpressionT = Aws::String>
  ScanRequest& WithFilterExpression(FilterExpressionT&& value) {
    SetFilterExpression(std::forward<FilterExpressionT>(value));
    return *this;
  }
 
 
  inline const Aws::Map<Aws::String, Aws::String>& GetExpressionAttributeNames() const { return m_expressionAttributeNames; }
  inline bool ExpressionAttributeNamesHasBeenSet() const { return m_expressionAttributeNamesHasBeenSet; }
  template <typename ExpressionAttributeNamesT = Aws::Map<Aws::String, Aws::String>>
  void SetExpressionAttributeNames(ExpressionAttributeNamesT&& value) {
    m_expressionAttributeNamesHasBeenSet = true;
    m_expressionAttributeNames = std::forward<ExpressionAttributeNamesT>(value);
  }
  template <typename ExpressionAttributeNamesT = Aws::Map<Aws::String, Aws::String>>
  ScanRequest& WithExpressionAttributeNames(ExpressionAttributeNamesT&& value) {
    SetExpressionAttributeNames(std::forward<ExpressionAttributeNamesT>(value));
    return *this;
  }
  template <typename ExpressionAttributeNamesKeyT = Aws::String, typename ExpressionAttributeNamesValueT = Aws::String>
  ScanRequest& AddExpressionAttributeNames(ExpressionAttributeNamesKeyT&& key, ExpressionAttributeNamesValueT&& value) {
    m_expressionAttributeNamesHasBeenSet = true;
    m_expressionAttributeNames.emplace(std::forward<ExpressionAttributeNamesKeyT>(key),
                                       std::forward<ExpressionAttributeNamesValueT>(value));
    return *this;
  }
 
 
  inline const Aws::Map<Aws::String, AttributeValue>& GetExpressionAttributeValues() const { return m_expressionAttributeValues; }
  inline bool ExpressionAttributeValuesHasBeenSet() const { return m_expressionAttributeValuesHasBeenSet; }
  template <typename ExpressionAttributeValuesT = Aws::Map<Aws::String, AttributeValue>>
  void SetExpressionAttributeValues(ExpressionAttributeValuesT&& value) {
    m_expressionAttributeValuesHasBeenSet = true;
    m_expressionAttributeValues = std::forward<ExpressionAttributeValuesT>(value);
  }
  template <typename ExpressionAttributeValuesT = Aws::Map<Aws::String, AttributeValue>>
  ScanRequest& WithExpressionAttributeValues(ExpressionAttributeValuesT&& value) {
    SetExpressionAttributeValues(std::forward<ExpressionAttributeValuesT>(value));
    return *this;
  }
  template <typename ExpressionAttributeValuesKeyT = Aws::String, typename ExpressionAttributeValuesValueT = AttributeValue>
  ScanRequest& AddExpressionAttributeValues(ExpressionAttributeValuesKeyT&& key, ExpressionAttributeValuesValueT&& value) {
    m_expressionAttributeValuesHasBeenSet = true;
    m_expressionAttributeValues.emplace(std::forward<ExpressionAttributeValuesKeyT>(key),
                                        std::forward<ExpressionAttributeValuesValueT>(value));
    return *this;
  }
 
 
  inline bool GetConsistentRead() const { return m_consistentRead; }
  inline bool ConsistentReadHasBeenSet() const { return m_consistentReadHasBeenSet; }
  inline void SetConsistentRead(bool value) {
    m_consistentReadHasBeenSet = true;
    m_consistentRead = value;
  }
  inline ScanRequest& WithConsistentRead(bool value) {
    SetConsistentRead(value);
    return *this;
  }
 private:
  Aws::String m_tableName;
 
  Aws::String m_indexName;
 
  Aws::Vector<Aws::String> m_attributesToGet;
 
  int m_limit{0};
 
  Select m_select{Select::NOT_SET};
 
  Aws::Map<Aws::String, Condition> m_scanFilter;
 
  ConditionalOperator m_conditionalOperator{ConditionalOperator::NOT_SET};
 
  Aws::Map<Aws::String, AttributeValue> m_exclusiveStartKey;
 
  ReturnConsumedCapacity m_returnConsumedCapacity{ReturnConsumedCapacity::NOT_SET};
 
  int m_totalSegments{0};
 
  int m_segment{0};
 
  Aws::String m_projectionExpression;
 
  Aws::String m_filterExpression;
 
  Aws::Map<Aws::String, Aws::String> m_expressionAttributeNames;
 
  Aws::Map<Aws::String, AttributeValue> m_expressionAttributeValues;
 
  bool m_consistentRead{false};
  bool m_tableNameHasBeenSet = false;
  bool m_indexNameHasBeenSet = false;
  bool m_attributesToGetHasBeenSet = false;
  bool m_limitHasBeenSet = false;
  bool m_selectHasBeenSet = false;
  bool m_scanFilterHasBeenSet = false;
  bool m_conditionalOperatorHasBeenSet = false;
  bool m_exclusiveStartKeyHasBeenSet = false;
  bool m_returnConsumedCapacityHasBeenSet = false;
  bool m_totalSegmentsHasBeenSet = false;
  bool m_segmentHasBeenSet = false;
  bool m_projectionExpressionHasBeenSet = false;
  bool m_filterExpressionHasBeenSet = false;
  bool m_expressionAttributeNamesHasBeenSet = false;
  bool m_expressionAttributeValuesHasBeenSet = false;
  bool m_consistentReadHasBeenSet = false;
};
 
}  // namespace Model
}  // namespace DynamoDB
}  // namespace Aws