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

153 lines
5.1 KiB
C++

/**
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
* SPDX-License-Identifier: Apache-2.0.
*/
#pragma once
#include <aws/snowball/Snowball_EXPORTS.h>
#include <aws/core/utils/memory/stl/AWSString.h>
#include <utility>
namespace Aws
{
namespace Utils
{
namespace Json
{
class JsonValue;
class JsonView;
} // namespace Json
} // namespace Utils
namespace Snowball
{
namespace Model
{
/**
* <p>Contains a key range. For export jobs, a <code>S3Resource</code> object can
* have an optional <code>KeyRange</code> value. The length of the range is defined
* at job creation, and has either an inclusive <code>BeginMarker</code>, an
* inclusive <code>EndMarker</code>, or both. Ranges are UTF-8 binary
* sorted.</p><p><h3>See Also:</h3> <a
* href="http://docs.aws.amazon.com/goto/WebAPI/snowball-2016-06-30/KeyRange">AWS
* API Reference</a></p>
*/
class AWS_SNOWBALL_API KeyRange
{
public:
KeyRange();
KeyRange(Aws::Utils::Json::JsonView jsonValue);
KeyRange& operator=(Aws::Utils::Json::JsonView jsonValue);
Aws::Utils::Json::JsonValue Jsonize() const;
/**
* <p>The key that starts an optional key range for an export job. Ranges are
* inclusive and UTF-8 binary sorted.</p>
*/
inline const Aws::String& GetBeginMarker() const{ return m_beginMarker; }
/**
* <p>The key that starts an optional key range for an export job. Ranges are
* inclusive and UTF-8 binary sorted.</p>
*/
inline bool BeginMarkerHasBeenSet() const { return m_beginMarkerHasBeenSet; }
/**
* <p>The key that starts an optional key range for an export job. Ranges are
* inclusive and UTF-8 binary sorted.</p>
*/
inline void SetBeginMarker(const Aws::String& value) { m_beginMarkerHasBeenSet = true; m_beginMarker = value; }
/**
* <p>The key that starts an optional key range for an export job. Ranges are
* inclusive and UTF-8 binary sorted.</p>
*/
inline void SetBeginMarker(Aws::String&& value) { m_beginMarkerHasBeenSet = true; m_beginMarker = std::move(value); }
/**
* <p>The key that starts an optional key range for an export job. Ranges are
* inclusive and UTF-8 binary sorted.</p>
*/
inline void SetBeginMarker(const char* value) { m_beginMarkerHasBeenSet = true; m_beginMarker.assign(value); }
/**
* <p>The key that starts an optional key range for an export job. Ranges are
* inclusive and UTF-8 binary sorted.</p>
*/
inline KeyRange& WithBeginMarker(const Aws::String& value) { SetBeginMarker(value); return *this;}
/**
* <p>The key that starts an optional key range for an export job. Ranges are
* inclusive and UTF-8 binary sorted.</p>
*/
inline KeyRange& WithBeginMarker(Aws::String&& value) { SetBeginMarker(std::move(value)); return *this;}
/**
* <p>The key that starts an optional key range for an export job. Ranges are
* inclusive and UTF-8 binary sorted.</p>
*/
inline KeyRange& WithBeginMarker(const char* value) { SetBeginMarker(value); return *this;}
/**
* <p>The key that ends an optional key range for an export job. Ranges are
* inclusive and UTF-8 binary sorted.</p>
*/
inline const Aws::String& GetEndMarker() const{ return m_endMarker; }
/**
* <p>The key that ends an optional key range for an export job. Ranges are
* inclusive and UTF-8 binary sorted.</p>
*/
inline bool EndMarkerHasBeenSet() const { return m_endMarkerHasBeenSet; }
/**
* <p>The key that ends an optional key range for an export job. Ranges are
* inclusive and UTF-8 binary sorted.</p>
*/
inline void SetEndMarker(const Aws::String& value) { m_endMarkerHasBeenSet = true; m_endMarker = value; }
/**
* <p>The key that ends an optional key range for an export job. Ranges are
* inclusive and UTF-8 binary sorted.</p>
*/
inline void SetEndMarker(Aws::String&& value) { m_endMarkerHasBeenSet = true; m_endMarker = std::move(value); }
/**
* <p>The key that ends an optional key range for an export job. Ranges are
* inclusive and UTF-8 binary sorted.</p>
*/
inline void SetEndMarker(const char* value) { m_endMarkerHasBeenSet = true; m_endMarker.assign(value); }
/**
* <p>The key that ends an optional key range for an export job. Ranges are
* inclusive and UTF-8 binary sorted.</p>
*/
inline KeyRange& WithEndMarker(const Aws::String& value) { SetEndMarker(value); return *this;}
/**
* <p>The key that ends an optional key range for an export job. Ranges are
* inclusive and UTF-8 binary sorted.</p>
*/
inline KeyRange& WithEndMarker(Aws::String&& value) { SetEndMarker(std::move(value)); return *this;}
/**
* <p>The key that ends an optional key range for an export job. Ranges are
* inclusive and UTF-8 binary sorted.</p>
*/
inline KeyRange& WithEndMarker(const char* value) { SetEndMarker(value); return *this;}
private:
Aws::String m_beginMarker;
bool m_beginMarkerHasBeenSet;
Aws::String m_endMarker;
bool m_endMarkerHasBeenSet;
};
} // namespace Model
} // namespace Snowball
} // namespace Aws