Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.S3.Types.ScanRange

Description

Synopsis

data ScanRange = ScanRange' {
- start :: Maybe Integer
- end :: Maybe Integer
}
newScanRange :: ScanRange
scanRange_start :: Lens' ScanRange (Maybe Integer)
scanRange_end :: Lens' ScanRange (Maybe Integer)

Documentation

data ScanRange Source #

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: newScanRange smart constructor.

Constructors

ScanRange'

Fields

start :: Maybe Integer
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.
end :: Maybe Integer
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.

Instances

Instances details

Eq ScanRange Source #
Instance details Defined in Amazonka.S3.Types.ScanRange Methods (==) :: ScanRange -> ScanRange -> Bool # (/=) :: ScanRange -> ScanRange -> Bool #
Read ScanRange Source #
Instance details Defined in Amazonka.S3.Types.ScanRange Methods readsPrec :: Int -> ReadS ScanRange # readList :: ReadS [ScanRange] # readPrec :: ReadPrec ScanRange # readListPrec :: ReadPrec [ScanRange] #
Show ScanRange Source #
Instance details Defined in Amazonka.S3.Types.ScanRange Methods showsPrec :: Int -> ScanRange -> ShowS # show :: ScanRange -> String # showList :: [ScanRange] -> ShowS #
Generic ScanRange Source #
Instance details Defined in Amazonka.S3.Types.ScanRange Associated Types type Rep ScanRange :: Type -> Type # Methods from :: ScanRange -> Rep ScanRange x # to :: Rep ScanRange x -> ScanRange #
NFData ScanRange Source #
Instance details Defined in Amazonka.S3.Types.ScanRange Methods rnf :: ScanRange -> () #
Hashable ScanRange Source #
Instance details Defined in Amazonka.S3.Types.ScanRange Methods hashWithSalt :: Int -> ScanRange -> Int # hash :: ScanRange -> Int #
ToXML ScanRange Source #
Instance details Defined in Amazonka.S3.Types.ScanRange Methods toXML :: ScanRange -> XML #
type Rep ScanRange Source #
Instance details Defined in Amazonka.S3.Types.ScanRange type Rep ScanRange = D1 ('MetaData "ScanRange" "Amazonka.S3.Types.ScanRange" "libZSservicesZSamazonka-s3ZSamazonka-s3" 'False) (C1 ('MetaCons "ScanRange'" 'PrefixI 'True) (S1 ('MetaSel ('Just "start") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer)) :*: S1 ('MetaSel ('Just "end") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer))))

newScanRange :: ScanRange Source #

Create a value of ScanRange with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:start:ScanRange', scanRange_start - 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.

$sel:end:ScanRange', scanRange_end - 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.

scanRange_start :: Lens' ScanRange (Maybe Integer) Source #

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.

scanRange_end :: Lens' ScanRange (Maybe Integer) Source #

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.