AWS SDK for C++  1.9.44
AWS SDK for C++
Public Member Functions | List of all members
Aws::S3Crt::Model::ScanRange Class Reference

#include <ScanRange.h>

Public Member Functions

 ScanRange ()
 
 ScanRange (const Aws::Utils::Xml::XmlNode &xmlNode)
 
ScanRangeoperator= (const Aws::Utils::Xml::XmlNode &xmlNode)
 
void AddToNode (Aws::Utils::Xml::XmlNode &parentNode) const
 
long long GetStart () const
 
bool StartHasBeenSet () const
 
void SetStart (long long value)
 
ScanRangeWithStart (long long value)
 
long long GetEnd () const
 
bool EndHasBeenSet () const
 
void SetEnd (long long value)
 
ScanRangeWithEnd (long long value)
 

Detailed Description

Specifies the byte range of the object to get the records from. A record is processed when its first byte is contained by the range. This parameter is optional, but when specified, it must not be empty. See RFC 2616, Section 14.35.1 about how to specify the start and end of the range.

See Also:

AWS API Reference

Definition at line 32 of file ScanRange.h.

Constructor & Destructor Documentation

◆ ScanRange() [1/2]

Aws::S3Crt::Model::ScanRange::ScanRange ( )

◆ ScanRange() [2/2]

Aws::S3Crt::Model::ScanRange::ScanRange ( const Aws::Utils::Xml::XmlNode xmlNode)

Member Function Documentation

◆ AddToNode()

void Aws::S3Crt::Model::ScanRange::AddToNode ( Aws::Utils::Xml::XmlNode parentNode) const

◆ EndHasBeenSet()

bool Aws::S3Crt::Model::ScanRange::EndHasBeenSet ( ) const
inline

Specifies the end of the byte range. This parameter is optional. Valid values: non-negative integers. The default value is one less than the size of the object being queried. If only the End parameter is supplied, it is interpreted to mean scan the last N bytes of the file. For example, <scanrange><end>50</end></scanrange> means scan the last 50 bytes.

Definition at line 97 of file ScanRange.h.

◆ GetEnd()

long long Aws::S3Crt::Model::ScanRange::GetEnd ( ) const
inline

Specifies the end of the byte range. This parameter is optional. Valid values: non-negative integers. The default value is one less than the size of the object being queried. If only the End parameter is supplied, it is interpreted to mean scan the last N bytes of the file. For example, <scanrange><end>50</end></scanrange> means scan the last 50 bytes.

Definition at line 87 of file ScanRange.h.

◆ GetStart()

long long Aws::S3Crt::Model::ScanRange::GetStart ( ) const
inline

Specifies the start of the byte range. This parameter is optional. Valid values: non-negative integers. The default value is 0. If only start is supplied, it means scan from that point to the end of the file.For example; <scanrange><start>50</start></scanrange> means scan from byte 50 until the end of the file.

Definition at line 49 of file ScanRange.h.

◆ operator=()

ScanRange& Aws::S3Crt::Model::ScanRange::operator= ( const Aws::Utils::Xml::XmlNode xmlNode)

◆ SetEnd()

void Aws::S3Crt::Model::ScanRange::SetEnd ( long long  value)
inline

Specifies the end of the byte range. This parameter is optional. Valid values: non-negative integers. The default value is one less than the size of the object being queried. If only the End parameter is supplied, it is interpreted to mean scan the last N bytes of the file. For example, <scanrange><end>50</end></scanrange> means scan the last 50 bytes.

Definition at line 107 of file ScanRange.h.

◆ SetStart()

void Aws::S3Crt::Model::ScanRange::SetStart ( long long  value)
inline

Specifies the start of the byte range. This parameter is optional. Valid values: non-negative integers. The default value is 0. If only start is supplied, it means scan from that point to the end of the file.For example; <scanrange><start>50</start></scanrange> means scan from byte 50 until the end of the file.

Definition at line 67 of file ScanRange.h.

◆ StartHasBeenSet()

bool Aws::S3Crt::Model::ScanRange::StartHasBeenSet ( ) const
inline

Specifies the start of the byte range. This parameter is optional. Valid values: non-negative integers. The default value is 0. If only start is supplied, it means scan from that point to the end of the file.For example; <scanrange><start>50</start></scanrange> means scan from byte 50 until the end of the file.

Definition at line 58 of file ScanRange.h.

◆ WithEnd()

ScanRange& Aws::S3Crt::Model::ScanRange::WithEnd ( long long  value)
inline

Specifies the end of the byte range. This parameter is optional. Valid values: non-negative integers. The default value is one less than the size of the object being queried. If only the End parameter is supplied, it is interpreted to mean scan the last N bytes of the file. For example, <scanrange><end>50</end></scanrange> means scan the last 50 bytes.

Definition at line 117 of file ScanRange.h.

◆ WithStart()

ScanRange& Aws::S3Crt::Model::ScanRange::WithStart ( long long  value)
inline

Specifies the start of the byte range. This parameter is optional. Valid values: non-negative integers. The default value is 0. If only start is supplied, it means scan from that point to the end of the file.For example; <scanrange><start>50</start></scanrange> means scan from byte 50 until the end of the file.

Definition at line 76 of file ScanRange.h.


The documentation for this class was generated from the following file: