.\" Automatically generated by Pod::Man 2.27 (Pod::Simple 3.28)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is turned on, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{
.    if \nF \{
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "Net::Amazon::S3::Client::Object 3pm"
.TH Net::Amazon::S3::Client::Object 3pm "2014-05-11" "perl v5.18.2" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
Net::Amazon::S3::Client::Object \- An easy\-to\-use Amazon S3 client object
.SH "VERSION"
.IX Header "VERSION"
version 0.60
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 2
\&  # show the key
\&  print $object\->key . "\en";
\&
\&  # show the etag of an existing object (if fetched by listing
\&  # a bucket)
\&  print $object\->etag . "\en";
\&
\&  # show the size of an existing object (if fetched by listing
\&  # a bucket)
\&  print $object\->size . "\en";
\&
\&  # to create a new object
\&  my $object = $bucket\->object( key => \*(Aqthis is the key\*(Aq );
\&  $object\->put(\*(Aqthis is the value\*(Aq);
\&
\&  # to get the vaue of an object
\&  my $value = $object\->get;
\&
\&  # to see if an object exists
\&  if ($object\->exists) { ... }
\&
\&  # to delete an object
\&  $object\->delete;
\&
\&  # to create a new object which is publically\-accessible with a
\&  # content\-type of text/plain which expires on 2010\-01\-02
\&  my $object = $bucket\->object(
\&    key          => \*(Aqthis is the public key\*(Aq,
\&    acl_short    => \*(Aqpublic\-read\*(Aq,
\&    content_type => \*(Aqtext/plain\*(Aq,
\&    expires      => \*(Aq2010\-01\-02\*(Aq,
\&  );
\&  $object\->put(\*(Aqthis is the public value\*(Aq);
\&
\&  # return the URI of a publically\-accessible object
\&  my $uri = $object\->uri;
\&
\&  # upload a file
\&  my $object = $bucket\->object(
\&    key          => \*(Aqimages/my_hat.jpg\*(Aq,
\&    content_type => \*(Aqimage/jpeg\*(Aq,
\&  );
\&  $object\->put_filename(\*(Aqhat.jpg\*(Aq);
\&
\&  # upload a file if you already know its md5_hex and size
\&  my $object = $bucket\->object(
\&    key          => \*(Aqimages/my_hat.jpg\*(Aq,
\&    content_type => \*(Aqimage/jpeg\*(Aq,
\&    etag         => $md5_hex,
\&    size         => $size,
\&  );
\&  $object\->put_filename(\*(Aqhat.jpg\*(Aq);
\&
\&  # download the value of the object into a file
\&  my $object = $bucket\->object( key => \*(Aqimages/my_hat.jpg\*(Aq );
\&  $object\->get_filename(\*(Aqhat_backup.jpg\*(Aq);
\&
\&  # use query string authentication
\&  my $object = $bucket\->object(
\&    key          => \*(Aqimages/my_hat.jpg\*(Aq,
\&    expires      => \*(Aq2009\-03\-01\*(Aq,
\&  );
\&  my $uri = $object\->query_string_authentication_uri();
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This module represents objects in buckets.
.SH "METHODS"
.IX Header "METHODS"
.SS "etag"
.IX Subsection "etag"
.Vb 3
\&  # show the etag of an existing object (if fetched by listing
\&  # a bucket)
\&  print $object\->etag . "\en";
.Ve
.SS "delete"
.IX Subsection "delete"
.Vb 2
\&  # to delete an object
\&  $object\->delete;
.Ve
.SS "exists"
.IX Subsection "exists"
.Vb 2
\&  # to see if an object exists
\&  if ($object\->exists) { ... }
.Ve
.SS "get"
.IX Subsection "get"
.Vb 2
\&  # to get the vaue of an object
\&  my $value = $object\->get;
.Ve
.SS "get_decoded"
.IX Subsection "get_decoded"
.Vb 3
\&  # get the value of an object, and decode any Content\-Encoding and/or
\&  # charset; see decoded_content in HTTP::Response
\&  my $value = $object\->get_decoded;
.Ve
.SS "get_filename"
.IX Subsection "get_filename"
.Vb 3
\&  # download the value of the object into a file
\&  my $object = $bucket\->object( key => \*(Aqimages/my_hat.jpg\*(Aq );
\&  $object\->get_filename(\*(Aqhat_backup.jpg\*(Aq);
.Ve
.SS "key"
.IX Subsection "key"
.Vb 2
\&  # show the key
\&  print $object\->key . "\en";
.Ve
.SS "put"
.IX Subsection "put"
.Vb 3
\&  # to create a new object
\&  my $object = $bucket\->object( key => \*(Aqthis is the key\*(Aq );
\&  $object\->put(\*(Aqthis is the value\*(Aq);
\&
\&  # to create a new object which is publically\-accessible with a
\&  # content\-type of text/plain
\&  my $object = $bucket\->object(
\&    key          => \*(Aqthis is the public key\*(Aq,
\&    acl_short    => \*(Aqpublic\-read\*(Aq,
\&    content_type => \*(Aqtext/plain\*(Aq,
\&  );
\&  $object\->put(\*(Aqthis is the public value\*(Aq);
.Ve
.PP
You may also set Content-Encoding using \f(CW\*(C`content_encoding\*(C'\fR, and
Content-Disposition using \f(CW\*(C`content_disposition\*(C'\fR.
.PP
You may specify the S3 storage class by setting \f(CW\*(C`storage_class\*(C'\fR to either
\&\f(CW\*(C`standard\*(C'\fR or \f(CW\*(C`reduced_redundancy\*(C'\fR; the default is \f(CW\*(C`standard\*(C'\fR.
.SS "put_filename"
.IX Subsection "put_filename"
.Vb 6
\&  # upload a file
\&  my $object = $bucket\->object(
\&    key          => \*(Aqimages/my_hat.jpg\*(Aq,
\&    content_type => \*(Aqimage/jpeg\*(Aq,
\&  );
\&  $object\->put_filename(\*(Aqhat.jpg\*(Aq);
\&
\&  # upload a file if you already know its md5_hex and size
\&  my $object = $bucket\->object(
\&    key          => \*(Aqimages/my_hat.jpg\*(Aq,
\&    content_type => \*(Aqimage/jpeg\*(Aq,
\&    etag         => $md5_hex,
\&    size         => $size,
\&  );
\&  $object\->put_filename(\*(Aqhat.jpg\*(Aq);
.Ve
.PP
You may also set Content-Encoding using \f(CW\*(C`content_encoding\*(C'\fR, and
Content-Disposition using \f(CW\*(C`content_disposition\*(C'\fR.
.PP
You may specify the S3 storage class by setting \f(CW\*(C`storage_class\*(C'\fR to either
\&\f(CW\*(C`standard\*(C'\fR or \f(CW\*(C`reduced_redundancy\*(C'\fR; the default is \f(CW\*(C`standard\*(C'\fR.
.PP
User metadata may be set by providing a non-empty hashref as
\&\f(CW\*(C`user_metadata\*(C'\fR.
.SS "query_string_authentication_uri"
.IX Subsection "query_string_authentication_uri"
.Vb 6
\&  # use query string authentication
\&  my $object = $bucket\->object(
\&    key          => \*(Aqimages/my_hat.jpg\*(Aq,
\&    expires      => \*(Aq2009\-03\-01\*(Aq,
\&  );
\&  my $uri = $object\->query_string_authentication_uri();
.Ve
.SS "size"
.IX Subsection "size"
.Vb 3
\&  # show the size of an existing object (if fetched by listing
\&  # a bucket)
\&  print $object\->size . "\en";
.Ve
.SS "uri"
.IX Subsection "uri"
.Vb 2
\&  # return the URI of a publically\-accessible object
\&  my $uri = $object\->uri;
.Ve
.SS "initiate_multipart_upload"
.IX Subsection "initiate_multipart_upload"
.Vb 5
\&  #initiate a new multipart upload for this object
\&  my $object = $bucket\->object(
\&    key         => \*(Aqmassive_video.avi\*(Aq
\&  );
\&  my $upload_id = $object\->initiate_multipart_upload;
.Ve
.SS "put_part"
.IX Subsection "put_part"
.Vb 7
\&  #add a part to a multipart upload
\&  my $put_part_response = $object\->put_part(
\&     upload_id      => $upload_id,
\&     part_number    => 1,
\&     value          => $chunk_content,
\&  );
\&  my $part_etag = $put_part_response\->header(\*(AqETag\*(Aq)
\&
\&  Returns an L<HTTP::Response> object. It is necessary to keep the ETags for
\&  each part, as these are required to complete the upload.
.Ve
.SS "complete_multipart_upload"
.IX Subsection "complete_multipart_upload"
.Vb 6
\&  #complete a multipart upload
\&  $object\->complete_multipart_upload(
\&    upload_id       => $upload_id,
\&    etags           => [$etag_1, $etag_2],
\&    part_numbers    => [$part_number_1, $part_number2],
\&  );
\&
\&  The etag and part_numbers parameters are ordered lists specifying the part
\&  numbers and ETags for each individual part of the multipart upload.
.Ve
.SS "user_metadata"
.IX Subsection "user_metadata"
.Vb 2
\&  my $object = $bucket\->object(key => $key);
\&  my $content = $object\->get; # or use $object\->get_filename($filename)
\&
\&  # return the user metadata downloaded, as a hashref
\&  my $user_metadata = $object\->user_metadata;
.Ve
.PP
To upload an object with user metadata, set \f(CW\*(C`user_metadata\*(C'\fR at construction
time to a hashref, with no \f(CW\*(C`x\-amz\-meta\-\*(C'\fR prefixes on the key names.  When
downloading an object, the \f(CW\*(C`get\*(C'\fR, \f(CW\*(C`get_decoded\*(C'\fR and \f(CW\*(C`get_filename\*(C'\fR
methods set the contents of \f(CW\*(C`user_metadata\*(C'\fR to the same format.
.SH "AUTHOR"
.IX Header "AUTHOR"
Pedro Figueiredo <me@pedrofigueiredo.org>
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
This software is copyright (c) 2014 by Amazon Digital Services, Leon Brocard, Brad Fitzpatrick, Pedro Figueiredo.
.PP
This is free software; you can redistribute it and/or modify it under
the same terms as the Perl 5 programming language system itself.