| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::S3::ScanRange; | ||
| 3 | use Moose; | ||
| 4 | has End => (is => 'ro', isa => 'Int'); | ||
| 5 | has Start => (is => 'ro', isa => 'Int'); | ||
| 6 | |||
| 7 | 1; | ||
| 8 | |||
| 9 | ### main pod documentation begin ### | ||
| 10 | |||
| 11 | =head1 NAME | ||
| 12 | |||
| 13 | Paws::S3::ScanRange | ||
| 14 | |||
| 15 | =head1 USAGE | ||
| 16 | |||
| 17 | This class represents one of two things: | ||
| 18 | |||
| 19 | =head3 Arguments in a call to a service | ||
| 20 | |||
| 21 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 22 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 23 | |||
| 24 | As an example, if Att1 is expected to be a Paws::S3::ScanRange object: | ||
| 25 | |||
| 26 | $service_obj->Method(Att1 => { End => $value, ..., Start => $value }); | ||
| 27 | |||
| 28 | =head3 Results returned from an API call | ||
| 29 | |||
| 30 | Use accessors for each attribute. If Att1 is expected to be an Paws::S3::ScanRange object: | ||
| 31 | |||
| 32 | $result = $service_obj->Method(...); | ||
| 33 | $result->Att1->End | ||
| 34 | |||
| 35 | =head1 DESCRIPTION | ||
| 36 | |||
| 37 | Specifies the byte range of the object to get the records from. A | ||
| 38 | record is processed when its first byte is contained by the range. This | ||
| 39 | parameter is optional, but when specified, it must not be empty. See | ||
| 40 | RFC 2616, Section 14.35.1 about how to specify the start and end of the | ||
| 41 | range. | ||
| 42 | |||
| 43 | =head1 ATTRIBUTES | ||
| 44 | |||
| 45 | |||
| 46 | =head2 End => Int | ||
| 47 | |||
| 48 | Specifies the end of the byte range. This parameter is optional. Valid | ||
| 49 | values: non-negative integers. The default value is one less than the | ||
| 50 | size of the object being queried. If only the End parameter is | ||
| 51 | supplied, it is interpreted to mean scan the last N bytes of the file. | ||
| 52 | For example, | ||
| 53 | C<E<lt>scanrangeE<gt>E<lt>endE<gt>50E<lt>/endE<gt>E<lt>/scanrangeE<gt>> | ||
| 54 | means scan the last 50 bytes. | ||
| 55 | |||
| 56 | |||
| 57 | =head2 Start => Int | ||
| 58 | |||
| 59 | Specifies the start of the byte range. This parameter is optional. | ||
| 60 | Valid values: non-negative integers. The default value is 0. If only | ||
| 61 | start is supplied, it means scan from that point to the end of the | ||
| 62 | file.For example; | ||
| 63 | C<E<lt>scanrangeE<gt>E<lt>startE<gt>50E<lt>/startE<gt>E<lt>/scanrangeE<gt>> | ||
| 64 | means scan from byte 50 until the end of the file. | ||
| 65 | |||
| 66 | |||
| 67 | |||
| 68 | =head1 SEE ALSO | ||
| 69 | |||
| 70 | This class forms part of L<Paws>, describing an object used in L<Paws::S3> | ||
| 71 | |||
| 72 | =head1 BUGS and CONTRIBUTIONS | ||
| 73 | |||
| 74 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 75 | |||
| 76 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 77 | |||
| 78 | =cut | ||
| 79 |