forked from jdunck/python-cloudfiles
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathcloudfiles.storage_object.Object-class.html
More file actions
1131 lines (1062 loc) · 50 KB
/
cloudfiles.storage_object.Object-class.html
File metadata and controls
1131 lines (1062 loc) · 50 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<?xml version="1.0" encoding="ascii"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<title>cloudfiles.storage_object.Object</title>
<link rel="stylesheet" href="epydoc.css" type="text/css" />
<script type="text/javascript" src="epydoc.js"></script>
</head>
<body bgcolor="white" text="black" link="blue" vlink="#204080"
alink="#204080">
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
bgcolor="#a0c0ff" cellspacing="0">
<tr valign="middle">
<!-- Home link -->
<th> <a
href="cloudfiles-module.html">Home</a> </th>
<!-- Tree link -->
<th> <a
href="module-tree.html">Trees</a> </th>
<!-- Index link -->
<th> <a
href="identifier-index.html">Indices</a> </th>
<!-- Help link -->
<th> <a
href="help.html">Help</a> </th>
<!-- Project homepage -->
<th class="navbar" align="right" width="100%">
<table border="0" cellpadding="0" cellspacing="0">
<tr><th class="navbar" align="center"
><a class="navbar" target="_top" href="http://www.rackspacecloud.com/">Cloud Files Python API</a></th>
</tr></table></th>
</tr>
</table>
<table width="100%" cellpadding="0" cellspacing="0">
<tr valign="top">
<td width="100%">
<span class="breadcrumbs">
<a href="cloudfiles-module.html">Package cloudfiles</a> ::
<a href="cloudfiles.storage_object-module.html">Module storage_object</a> ::
Class Object
</span>
</td>
<td>
<table cellpadding="0" cellspacing="0">
<!-- hide/show private -->
<tr><td align="right"><span class="options"
>[<a href="frames.html" target="_top">frames</a
>] | <a href="cloudfiles.storage_object.Object-class.html"
target="_top">no frames</a>]</span></td></tr>
</table>
</td>
</tr>
</table>
<!-- ==================== CLASS DESCRIPTION ==================== -->
<h1 class="epydoc">Class Object</h1><p class="nomargin-top"><span class="codelink"><a href="cloudfiles.storage_object-pysrc.html#Object">source code</a></span></p>
<center>
<center> <map id="uml_class_diagram_for_cloudfil_22" name="uml_class_diagram_for_cloudfil_22">
<area shape="rect" href="cloudfiles.container.Container-class.html" title="Container object and Object instance factory." alt="" coords="185,491,311,517"/>
<area shape="rect" href="cloudfiles.storage_object.Object-class.html#objsum" title="cloudfiles.storage_object.Object.objsum" alt="" coords="17,28,479,47"/>
<area shape="rect" href="cloudfiles.storage_object.Object-class.html#etag" title="cloudfiles.storage_object.Object.etag" alt="" coords="17,47,479,65"/>
<area shape="rect" href="cloudfiles.storage_object.Object-class.html#content_type" title="the object's content-type (set or read)" alt="" coords="17,65,479,84"/>
<area shape="rect" href="cloudfiles.storage_object.Object-class.html#last_modified" title="date and time of last file modification (cached)" alt="" coords="17,84,479,103"/>
<area shape="rect" href="cloudfiles.storage_object.Object-class.html#metadata" title="metadata associated with the object (set or read)" alt="" coords="17,103,479,121"/>
<area shape="rect" href="cloudfiles.storage_object.Object-class.html#name" title="the object's name (generally treat as read-only)" alt="" coords="17,121,479,140"/>
<area shape="rect" href="cloudfiles.storage_object.Object-class.html#size" title="the object's size (cached)" alt="" coords="17,140,479,159"/>
<area shape="rect" href="cloudfiles.storage_object.Object-class.html#__init__" title="Storage objects rarely if ever need to be instantiated directly by the  user." alt="" coords="17,161,479,180"/>
<area shape="rect" href="cloudfiles.storage_object.Object-class.html#read" title="Read the content from the remote storage object." alt="" coords="17,180,479,199"/>
<area shape="rect" href="cloudfiles.storage_object.Object-class.html#save_to_filename" title="Save the contents of the object to filename." alt="" coords="17,199,479,217"/>
<area shape="rect" href="cloudfiles.storage_object.Object-class.html#stream" title="Return a generator of the remote storage object's data." alt="" coords="17,217,479,236"/>
<area shape="rect" href="cloudfiles.storage_object.Object-class.html#sync_metadata" title="Commits the metadata to the remote storage system." alt="" coords="17,236,479,255"/>
<area shape="rect" href="cloudfiles.storage_object.Object-class.html#sync_manifest" title="Commits the manifest to the remote storage system." alt="" coords="17,255,479,273"/>
<area shape="rect" href="cloudfiles.storage_object.Object-class.html#write" title="Write data to the remote storage system." alt="" coords="17,273,479,292"/>
<area shape="rect" href="cloudfiles.storage_object.Object-class.html#copy_to" title="Copy an object's contents to another location." alt="" coords="17,292,479,311"/>
<area shape="rect" href="cloudfiles.storage_object.Object-class.html#copy_from" title="Copy another object's contents to this object." alt="" coords="17,311,479,329"/>
<area shape="rect" href="cloudfiles.storage_object.Object-class.html#send" title="Write potentially transient data to the remote storage system using a  generator or stream." alt="" coords="17,329,479,348"/>
<area shape="rect" href="cloudfiles.storage_object.Object-class.html#load_from_filename" title="Put the contents of the named file into remote storage." alt="" coords="17,348,479,367"/>
<area shape="rect" href="cloudfiles.storage_object.Object-class.html#__str__" title="str(x)" alt="" coords="17,367,479,385"/>
<area shape="rect" href="cloudfiles.storage_object.Object-class.html#public_uri" title="Retrieve the URI for this object, if its container is public." alt="" coords="17,385,479,404"/>
<area shape="rect" href="cloudfiles.storage_object.Object-class.html#purge_from_cdn" title="Purge Edge cache for this object." alt="" coords="17,423,479,441"/>
<area shape="rect" href="cloudfiles.storage_object.Object-class.html" title="Storage data representing an object, (metadata and data)." alt="" coords="16,11,480,443"/>
<area shape="poly" href="cloudfiles.storage_object.Object-class.html#container" title="cloudfiles.storage_object.Object.container" alt="" coords="251,443 251,477 245,477 245,443"/>
<area shape="rect" href="cloudfiles.storage_object.Object-class.html#container" title="cloudfiles.storage_object.Object.container" alt="" coords="244,439,252,447"/>
<area shape="rect" href="cloudfiles.storage_object.Object-class.html#container" title="cloudfiles.storage_object.Object.container" alt="" coords="244,487,252,495"/>
<area shape="rect" href="cloudfiles.storage_object.Object-class.html#container" title="container" alt="" coords="248,459,301,475"/>
</map>
<img src="uml_class_diagram_for_cloudfil_22.gif" alt='' usemap="#uml_class_diagram_for_cloudfil_22" ismap="ismap" class="graph-without-title" />
</center>
</center>
<hr />
<p>Storage data representing an object, (metadata and data).</p>
<!-- ==================== INSTANCE METHODS ==================== -->
<a name="section-InstanceMethods"></a>
<table class="summary" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
<td align="left" colspan="2" class="table-header">
<span class="table-header">Instance Methods</span></td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="cloudfiles.storage_object.Object-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">container</span>,
<span class="summary-sig-arg">name</span>=<span class="summary-sig-default">None</span>,
<span class="summary-sig-arg">force_exists</span>=<span class="summary-sig-default">False</span>,
<span class="summary-sig-arg">object_record</span>=<span class="summary-sig-default">None</span>)</span><br />
Storage objects rarely if ever need to be instantiated directly by
the user.</td>
<td align="right" valign="top">
<span class="codelink"><a href="cloudfiles.storage_object-pysrc.html#Object.__init__">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">str or None</span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="cloudfiles.storage_object.Object-class.html#read" class="summary-sig-name">read</a>(<span class="summary-sig-arg">*args</span>,
<span class="summary-sig-arg">**kwargs</span>)</span><br />
Read the content from the remote storage object.</td>
<td align="right" valign="top">
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="cloudfiles.storage_object.Object-class.html#save_to_filename" class="summary-sig-name">save_to_filename</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">filename</span>,
<span class="summary-sig-arg">callback</span>=<span class="summary-sig-default">None</span>)</span><br />
Save the contents of the object to filename.</td>
<td align="right" valign="top">
<span class="codelink"><a href="cloudfiles.storage_object-pysrc.html#Object.save_to_filename">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">str generator</span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="cloudfiles.storage_object.Object-class.html#stream" class="summary-sig-name">stream</a>(<span class="summary-sig-arg">*args</span>,
<span class="summary-sig-arg">**kwargs</span>)</span><br />
Return a generator of the remote storage object's data.</td>
<td align="right" valign="top">
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="cloudfiles.storage_object.Object-class.html#sync_metadata" class="summary-sig-name">sync_metadata</a>(<span class="summary-sig-arg">*args</span>,
<span class="summary-sig-arg">**kwargs</span>)</span><br />
Commits the metadata to the remote storage system.</td>
<td align="right" valign="top">
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="cloudfiles.storage_object.Object-class.html#sync_manifest" class="summary-sig-name">sync_manifest</a>(<span class="summary-sig-arg">*args</span>,
<span class="summary-sig-arg">**kwargs</span>)</span><br />
Commits the manifest to the remote storage system.</td>
<td align="right" valign="top">
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="cloudfiles.storage_object.Object-class.html#write" class="summary-sig-name">write</a>(<span class="summary-sig-arg">*args</span>,
<span class="summary-sig-arg">**kwargs</span>)</span><br />
Write data to the remote storage system.</td>
<td align="right" valign="top">
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="cloudfiles.storage_object.Object-class.html#copy_to" class="summary-sig-name">copy_to</a>(<span class="summary-sig-arg">*args</span>,
<span class="summary-sig-arg">**kwargs</span>)</span><br />
Copy an object's contents to another location.</td>
<td align="right" valign="top">
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="cloudfiles.storage_object.Object-class.html#copy_from" class="summary-sig-name">copy_from</a>(<span class="summary-sig-arg">*args</span>,
<span class="summary-sig-arg">**kwargs</span>)</span><br />
Copy another object's contents to this object.</td>
<td align="right" valign="top">
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="cloudfiles.storage_object.Object-class.html#send" class="summary-sig-name">send</a>(<span class="summary-sig-arg">*args</span>,
<span class="summary-sig-arg">**kwargs</span>)</span><br />
Write potentially transient data to the remote storage system using a
generator or stream.</td>
<td align="right" valign="top">
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="cloudfiles.storage_object.Object-class.html#load_from_filename" class="summary-sig-name">load_from_filename</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">filename</span>,
<span class="summary-sig-arg">verify</span>=<span class="summary-sig-default">True</span>,
<span class="summary-sig-arg">callback</span>=<span class="summary-sig-default">None</span>)</span><br />
Put the contents of the named file into remote storage.</td>
<td align="right" valign="top">
<span class="codelink"><a href="cloudfiles.storage_object-pysrc.html#Object.load_from_filename">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="cloudfiles.storage_object.Object-class.html#__str__" class="summary-sig-name">__str__</a>(<span class="summary-sig-arg">self</span>)</span><br />
str(x)</td>
<td align="right" valign="top">
<span class="codelink"><a href="cloudfiles.storage_object-pysrc.html#Object.__str__">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">str</span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="cloudfiles.storage_object.Object-class.html#public_uri" class="summary-sig-name">public_uri</a>(<span class="summary-sig-arg">self</span>)</span><br />
Retrieve the URI for this object, if its container is public.</td>
<td align="right" valign="top">
<span class="codelink"><a href="cloudfiles.storage_object-pysrc.html#Object.public_uri">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">str</span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="cloudfiles.storage_object.Object-class.html#public_ssl_uri" class="summary-sig-name">public_ssl_uri</a>(<span class="summary-sig-arg">self</span>)</span><br />
Retrieve the SSL URI for this object, if its container is public.</td>
<td align="right" valign="top">
<span class="codelink"><a href="cloudfiles.storage_object-pysrc.html#Object.public_ssl_uri">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">str</span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="cloudfiles.storage_object.Object-class.html#public_streaming_uri" class="summary-sig-name">public_streaming_uri</a>(<span class="summary-sig-arg">self</span>)</span><br />
Retrieve the streaming URI for this object, if its container is
public.</td>
<td align="right" valign="top">
<span class="codelink"><a href="cloudfiles.storage_object-pysrc.html#Object.public_streaming_uri">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="cloudfiles.storage_object.Object-class.html#purge_from_cdn" class="summary-sig-name">purge_from_cdn</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">email</span>=<span class="summary-sig-default">None</span>)</span><br />
Purge Edge cache for this object.</td>
<td align="right" valign="top">
<span class="codelink"><a href="cloudfiles.storage_object-pysrc.html#Object.purge_from_cdn">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td colspan="2" class="summary">
<p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
<code>__delattr__</code>,
<code>__format__</code>,
<code>__getattribute__</code>,
<code>__hash__</code>,
<code>__new__</code>,
<code>__reduce__</code>,
<code>__reduce_ex__</code>,
<code>__repr__</code>,
<code>__setattr__</code>,
<code>__sizeof__</code>,
<code>__subclasshook__</code>
</p>
</td>
</tr>
</table>
<!-- ==================== INSTANCE VARIABLES ==================== -->
<a name="section-InstanceVariables"></a>
<table class="summary" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
<td align="left" colspan="2" class="table-header">
<span class="table-header">Instance Variables</span></td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"><a href="cloudfiles.container.Container-class.html"
class="link">Container</a></span>
</td><td class="summary">
<a name="container"></a><span class="summary-name">container</span><br />
the object's container (generally treat as read-only)
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">str</span>
</td><td class="summary">
<a name="content_type"></a><span class="summary-name">content_type</span><br />
the object's content-type (set or read)
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">str</span>
</td><td class="summary">
<a name="last_modified"></a><span class="summary-name">last_modified</span><br />
date and time of last file modification (cached)
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">dict</span>
</td><td class="summary">
<a name="metadata"></a><span class="summary-name">metadata</span><br />
metadata associated with the object (set or read)
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">str</span>
</td><td class="summary">
<a name="name"></a><span class="summary-name">name</span><br />
the object's name (generally treat as read-only)
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">number</span>
</td><td class="summary">
<a name="size"></a><span class="summary-name">size</span><br />
the object's size (cached)
</td>
</tr>
</table>
<!-- ==================== PROPERTIES ==================== -->
<a name="section-Properties"></a>
<table class="summary" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
<td align="left" colspan="2" class="table-header">
<span class="table-header">Properties</span></td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<a href="cloudfiles.storage_object.Object-class.html#objsum" class="summary-name">objsum</a>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<a href="cloudfiles.storage_object.Object-class.html#etag" class="summary-name">etag</a>
</td>
</tr>
<tr>
<td colspan="2" class="summary">
<p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
<code>__class__</code>
</p>
</td>
</tr>
</table>
<!-- ==================== METHOD DETAILS ==================== -->
<a name="section-MethodDetails"></a>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
<td align="left" colspan="2" class="table-header">
<span class="table-header">Method Details</span></td>
</tr>
</table>
<a name="__init__"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">container</span>,
<span class="sig-arg">name</span>=<span class="sig-default">None</span>,
<span class="sig-arg">force_exists</span>=<span class="sig-default">False</span>,
<span class="sig-arg">object_record</span>=<span class="sig-default">None</span>)</span>
<br /><em class="fname">(Constructor)</em>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="cloudfiles.storage_object-pysrc.html#Object.__init__">source code</a></span>
</td>
</tr></table>
<p>Storage objects rarely if ever need to be instantiated directly by the
user.</p>
<p>Instead, use the <a
href="cloudfiles.container.Container-class.html#create_object"
class="link">create_object</a>, <a
href="cloudfiles.container.Container-class.html#get_object"
class="link">get_object</a>, <a
href="cloudfiles.container.Container-class.html#list_objects"
class="link">list_objects</a> and other methods on its parent <a
href="cloudfiles.container.Container-class.html"
class="link">Container</a> object.</p>
<dl class="fields">
<dt>Overrides:
object.__init__
</dt>
</dl>
</td></tr></table>
</div>
<a name="read"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">read</span>(<span class="sig-arg">*args</span>,
<span class="sig-arg">**kwargs</span>)</span>
</h3>
</td><td align="right" valign="top"
>
</td>
</tr></table>
<p>Read the content from the remote storage object.</p>
<p>By default this method will buffer the response in memory and return
it as a string. However, if a file-like object is passed in using the
buffer keyword, the response will be written to it instead.</p>
<p>A callback can be passed in for reporting on the progress of the
download. The callback should accept two integers, the first will be for
the amount of data written so far, the second for the total size of the
transfer. Note: This option is only applicable when used in conjunction
with the buffer option.</p>
<pre class="py-doctest">
<span class="py-prompt">>>> </span>test_object.write(<span class="py-string">'hello'</span>)
<span class="py-prompt">>>> </span>test_object.read()
<span class="py-output">'hello'</span></pre>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>size</code></strong> (number) - combined with offset, defines the length of data to be read</li>
<li><strong class="pname"><code>offset</code></strong> (number) - combined with size, defines the start location to be read</li>
<li><strong class="pname"><code>hdrs</code></strong> (dictionary) - an optional dict of headers to send with the request</li>
<li><strong class="pname"><code>buffer</code></strong> (file-like object) - an optional file-like object to write the content to</li>
<li><strong class="pname"><code>callback</code></strong> (callable(transferred, size)) - function to be used as a progress callback</li>
</ul></dd>
<dt>Returns: str or None</dt>
<dd>a string of all data in the object, or None if a buffer is used</dd>
<dt>Decorators:</dt>
<dd><ul class="nomargin-top">
<li><code>@requires_name(InvalidObjectName)</code></li>
</ul></dd>
</dl>
</td></tr></table>
</div>
<a name="save_to_filename"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">save_to_filename</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">filename</span>,
<span class="sig-arg">callback</span>=<span class="sig-default">None</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="cloudfiles.storage_object-pysrc.html#Object.save_to_filename">source code</a></span>
</td>
</tr></table>
<p>Save the contents of the object to filename.</p>
<pre class="py-doctest">
<span class="py-prompt">>>> </span>container = connection[<span class="py-string">'container1'</span>]
<span class="py-prompt">>>> </span>obj = container.get_object(<span class="py-string">'backup_file'</span>)
<span class="py-prompt">>>> </span>obj.save_to_filename(<span class="py-string">'./backup_file'</span>)</pre>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>filename</code></strong> (str) - name of the file</li>
<li><strong class="pname"><code>callback</code></strong> (callable(transferred, size)) - function to be used as a progress callback</li>
</ul></dd>
</dl>
</td></tr></table>
</div>
<a name="stream"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">stream</span>(<span class="sig-arg">*args</span>,
<span class="sig-arg">**kwargs</span>)</span>
</h3>
</td><td align="right" valign="top"
>
</td>
</tr></table>
<p>Return a generator of the remote storage object's data.</p>
<p>Warning: The HTTP response is only complete after this generator has
raised a StopIteration. No other methods can be called until this has
occurred.</p>
<pre class="py-doctest">
<span class="py-prompt">>>> </span>test_object.write(<span class="py-string">'hello'</span>)
<span class="py-prompt">>>> </span>test_object.stream()
<span class="py-output"><generator object at 0xb77939cc></span>
<span class="py-output"></span><span class="py-prompt">>>> </span><span class="py-string">'-'</span>.join(test_object.stream(chunksize=1))
<span class="py-output">'h-e-l-l-o'</span></pre>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>chunksize</code></strong> (number) - size in bytes yielded by the generator</li>
<li><strong class="pname"><code>hdrs</code></strong> (dict) - an optional dict of headers to send in the request</li>
</ul></dd>
<dt>Returns: str generator</dt>
<dd>a generator which yields strings as the object is downloaded</dd>
<dt>Decorators:</dt>
<dd><ul class="nomargin-top">
<li><code>@requires_name(InvalidObjectName)</code></li>
</ul></dd>
</dl>
</td></tr></table>
</div>
<a name="sync_metadata"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">sync_metadata</span>(<span class="sig-arg">*args</span>,
<span class="sig-arg">**kwargs</span>)</span>
</h3>
</td><td align="right" valign="top"
>
</td>
</tr></table>
<p>Commits the metadata to the remote storage system.</p>
<pre class="py-doctest">
<span class="py-prompt">>>> </span>test_object = container[<span class="py-string">'paradise_lost.pdf'</span>]
<span class="py-prompt">>>> </span>test_object.metadata = {<span class="py-string">'author'</span>: <span class="py-string">'John Milton'</span>}
<span class="py-prompt">>>> </span>test_object.sync_metadata()</pre>
<p>Object metadata can be set and retrieved through the object's
.metadata attribute.</p>
<dl class="fields">
<dt>Decorators:</dt>
<dd><ul class="nomargin-top">
<li><code>@requires_name(InvalidObjectName)</code></li>
</ul></dd>
</dl>
</td></tr></table>
</div>
<a name="sync_manifest"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">sync_manifest</span>(<span class="sig-arg">*args</span>,
<span class="sig-arg">**kwargs</span>)</span>
</h3>
</td><td align="right" valign="top"
>
</td>
</tr></table>
<p>Commits the manifest to the remote storage system.</p>
<pre class="py-doctest">
<span class="py-prompt">>>> </span>test_object = container[<span class="py-string">'paradise_lost.pdf'</span>]
<span class="py-prompt">>>> </span>test_object.manifest = <span class="py-string">'container/prefix'</span>
<span class="py-prompt">>>> </span>test_object.sync_manifest()</pre>
<p>Object manifests can be set and retrieved through the object's
.manifest attribute.</p>
<dl class="fields">
<dt>Decorators:</dt>
<dd><ul class="nomargin-top">
<li><code>@requires_name(InvalidObjectName)</code></li>
</ul></dd>
</dl>
</td></tr></table>
</div>
<a name="write"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">write</span>(<span class="sig-arg">*args</span>,
<span class="sig-arg">**kwargs</span>)</span>
</h3>
</td><td align="right" valign="top"
>
</td>
</tr></table>
<p>Write data to the remote storage system.</p>
<p>By default, server-side verification is enabled, (verify=True), and
end-to-end verification is performed using an md5 checksum. When
verification is disabled, (verify=False), the etag attribute will be set
to the value returned by the server, not one calculated locally. When
disabling verification, there is no guarantee that what you think was
uploaded matches what was actually stored. Use this optional carefully.
You have been warned.</p>
<p>A callback can be passed in for reporting on the progress of the
upload. The callback should accept two integers, the first will be for
the amount of data written so far, the second for the total size of the
transfer.</p>
<pre class="py-doctest">
<span class="py-prompt">>>> </span>test_object = container.create_object(<span class="py-string">'file.txt'</span>)
<span class="py-prompt">>>> </span>test_object.content_type = <span class="py-string">'text/plain'</span>
<span class="py-prompt">>>> </span>fp = open(<span class="py-string">'./file.txt'</span>)
<span class="py-prompt">>>> </span>test_object.write(fp)</pre>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>data</code></strong> (str or file) - the data to be written</li>
<li><strong class="pname"><code>verify</code></strong> (boolean) - enable/disable server-side checksum verification</li>
<li><strong class="pname"><code>callback</code></strong> (callable(transferred, size)) - function to be used as a progress callback</li>
</ul></dd>
<dt>Decorators:</dt>
<dd><ul class="nomargin-top">
<li><code>@requires_name(InvalidObjectName)</code></li>
</ul></dd>
</dl>
</td></tr></table>
</div>
<a name="copy_to"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">copy_to</span>(<span class="sig-arg">*args</span>,
<span class="sig-arg">**kwargs</span>)</span>
</h3>
</td><td align="right" valign="top"
>
</td>
</tr></table>
<p>Copy an object's contents to another location.</p>
<dl class="fields">
<dt>Decorators:</dt>
<dd><ul class="nomargin-top">
<li><code>@requires_name(InvalidObjectName)</code></li>
</ul></dd>
</dl>
</td></tr></table>
</div>
<a name="copy_from"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">copy_from</span>(<span class="sig-arg">*args</span>,
<span class="sig-arg">**kwargs</span>)</span>
</h3>
</td><td align="right" valign="top"
>
</td>
</tr></table>
<p>Copy another object's contents to this object.</p>
<dl class="fields">
<dt>Decorators:</dt>
<dd><ul class="nomargin-top">
<li><code>@requires_name(InvalidObjectName)</code></li>
</ul></dd>
</dl>
</td></tr></table>
</div>
<a name="send"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">send</span>(<span class="sig-arg">*args</span>,
<span class="sig-arg">**kwargs</span>)</span>
</h3>
</td><td align="right" valign="top"
>
</td>
</tr></table>
<p>Write potentially transient data to the remote storage system using a
generator or stream.</p>
<p>If the object's size is not set, chunked transfer encoding will be
used to upload the file.</p>
<p>If the object's size attribute is set, it will be used as the
Content-Length. If the generator raises StopIteration prior to yielding
the right number of bytes, an IncompleteSend exception is raised.</p>
<p>If the content_type attribute is not set then a value of
application/octet-stream will be used.</p>
<p>Server-side verification will be performed if an md5 checksum is
assigned to the etag property before calling this method, otherwise no
verification will be performed, (verification can be performed afterward
though by using the etag attribute which is set to the value returned by
the server).</p>
<pre class="py-doctest">
<span class="py-prompt">>>> </span>test_object = container.create_object(<span class="py-string">'backup.tar.gz'</span>)
<span class="py-prompt">>>> </span>pfd = os.popen(<span class="py-string">'tar -czvf - ./data/'</span>, <span class="py-string">'r'</span>)
<span class="py-prompt">>>> </span>test_object.send(pfd)</pre>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>iterable</code></strong> (generator or stream) - stream or generator which yields the content to upload</li>
</ul></dd>
<dt>Decorators:</dt>
<dd><ul class="nomargin-top">
<li><code>@requires_name(InvalidObjectName)</code></li>
</ul></dd>
</dl>
</td></tr></table>
</div>
<a name="load_from_filename"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">load_from_filename</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">filename</span>,
<span class="sig-arg">verify</span>=<span class="sig-default">True</span>,
<span class="sig-arg">callback</span>=<span class="sig-default">None</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="cloudfiles.storage_object-pysrc.html#Object.load_from_filename">source code</a></span>
</td>
</tr></table>
<p>Put the contents of the named file into remote storage.</p>
<pre class="py-doctest">
<span class="py-prompt">>>> </span>test_object = container.create_object(<span class="py-string">'file.txt'</span>)
<span class="py-prompt">>>> </span>test_object.content_type = <span class="py-string">'text/plain'</span>
<span class="py-prompt">>>> </span>test_object.load_from_filename(<span class="py-string">'./my_file.txt'</span>)</pre>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>filename</code></strong> (str) - path to the file</li>
<li><strong class="pname"><code>verify</code></strong> (boolean) - enable/disable server-side checksum verification</li>
<li><strong class="pname"><code>callback</code></strong> (callable(transferred, size)) - function to be used as a progress callback</li>
</ul></dd>
</dl>
</td></tr></table>
</div>
<a name="__str__"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">__str__</span>(<span class="sig-arg">self</span>)</span>
<br /><em class="fname">(Informal representation operator)</em>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="cloudfiles.storage_object-pysrc.html#Object.__str__">source code</a></span>
</td>
</tr></table>
<p>str(x)</p>
<dl class="fields">
<dt>Overrides:
object.__str__
<dd><em class="note">(inherited documentation)</em></dd>
</dt>
</dl>
</td></tr></table>
</div>
<a name="public_uri"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">public_uri</span>(<span class="sig-arg">self</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="cloudfiles.storage_object-pysrc.html#Object.public_uri">source code</a></span>
</td>
</tr></table>
<p>Retrieve the URI for this object, if its container is public.</p>
<pre class="py-doctest">
<span class="py-prompt">>>> </span>container1 = connection[<span class="py-string">'container1'</span>]
<span class="py-prompt">>>> </span>container1.make_public()
<span class="py-prompt">>>> </span>container1.create_object(<span class="py-string">'file.txt'</span>).write(<span class="py-string">'testing'</span>)
<span class="py-prompt">>>> </span>container1[<span class="py-string">'file.txt'</span>].public_uri()
<span class="py-output">'http://c00061.cdn.cloudfiles.rackspacecloud.com/file.txt'</span></pre>
<dl class="fields">
<dt>Returns: str</dt>
<dd>the public URI for this object</dd>
</dl>
</td></tr></table>
</div>
<a name="public_ssl_uri"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">public_ssl_uri</span>(<span class="sig-arg">self</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="cloudfiles.storage_object-pysrc.html#Object.public_ssl_uri">source code</a></span>
</td>
</tr></table>
<p>Retrieve the SSL URI for this object, if its container is public.</p>
<pre class="py-doctest">
<span class="py-prompt">>>> </span>container1 = connection[<span class="py-string">'container1'</span>]
<span class="py-prompt">>>> </span>container1.make_public()
<span class="py-prompt">>>> </span>container1.create_object(<span class="py-string">'file.txt'</span>).write(<span class="py-string">'testing'</span>)
<span class="py-prompt">>>> </span>container1[<span class="py-string">'file.txt'</span>].public_ssl_uri()
<span class="py-output">'https://c61.ssl.cf0.rackcdn.com/file.txt'</span></pre>
<dl class="fields">
<dt>Returns: str</dt>
<dd>the public SSL URI for this object</dd>
</dl>
</td></tr></table>
</div>
<a name="public_streaming_uri"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">public_streaming_uri</span>(<span class="sig-arg">self</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="cloudfiles.storage_object-pysrc.html#Object.public_streaming_uri">source code</a></span>
</td>
</tr></table>
<p>Retrieve the streaming URI for this object, if its container is
public.</p>
<pre class="py-doctest">
<span class="py-prompt">>>> </span>container1 = connection[<span class="py-string">'container1'</span>]
<span class="py-prompt">>>> </span>container1.make_public()
<span class="py-prompt">>>> </span>container1.create_object(<span class="py-string">'file.txt'</span>).write(<span class="py-string">'testing'</span>)
<span class="py-prompt">>>> </span>container1[<span class="py-string">'file.txt'</span>].public_streaming_uri()
<span class="py-output">'https://c61.stream.rackcdn.com/file.txt'</span></pre>
<dl class="fields">
<dt>Returns: str</dt>