python-openstackclient/doc/source/command-objects/object.rst
Xi Yang 32e0ed6980 Change 'Object Store' to 'Object Storage'
Because the official documents uses 'Object Storage',
so change it in this project.

Change-Id: I87c0996b48c452b3ff619b8214676ae377e6d0af
2015-11-26 16:35:54 +08:00

191 lines
2.8 KiB
ReStructuredText

======
object
======
Object Storage v1
object create
-------------
Upload object to container
.. program:: object create
.. code:: bash
os object create
<container>
<filename> [<filename> ...]
.. describe:: <container>
Container for new object
.. describe:: <filename>
Local filename(s) to upload
object delete
-------------
Delete object from container
.. program:: object delete
.. code:: bash
os object delete
<container>
<object> [<object> ...]
.. describe:: <container>
Delete object(s) from <container>
.. describe:: <object>
Object(s) to delete
object list
-----------
List objects
.. program object list
.. code:: bash
os object list
[--prefix <prefix>]
[--delimiter <delimiter>]
[--marker <marker>]
[--end-marker <end-marker>]
[--limit <limit>]
[--long]
[--all]
<container>]
.. option:: --prefix <prefix>
Filter list using <prefix>
.. option:: --delimiter <delimiter>
Roll up items with <delimiter>
.. option:: --marker <marker>
Anchor for paging
.. option:: --end-marker <end-marker>
End anchor for paging
.. option:: --limit <limit>
Limit number of objects returned
.. option:: --long
List additional fields in output
.. option:: --all
List all objects in <container> (default is 10000)
.. describe:: <container>
Container to list
object save
-----------
Save object locally
.. program:: object save
.. code:: bash
os object save
[--file <filename>]
[<container>]
[<object>]
.. option:: --file <filename>
Destination filename (defaults to object name)
.. describe:: <container>
Download <object> from <container>
.. describe:: <object>
Object to save
object set
----------
Set object properties
.. program:: object set
.. code:: bash
os object set
[--property <key=value> [...] ]
<container>
[<object>]
.. option:: --property <key=value>
Set a property on this object (repeat option to set multiple properties)
.. describe:: <container>
Modify <object> from <container>
.. describe:: <object>
Object to modify
object show
-----------
Display object details
.. program:: object show
.. code:: bash
os object show
<container>
<object>
.. describe:: <container>
Display <object> from <container>
.. describe:: <object>
Object to display
object unset
------------
Unset object properties
.. program:: object unset
.. code:: bash
os object unset
[--property <key>]
<container>
[<object>]
.. option:: --property <key>
Property to remove from object (repeat option to remove multiple properties)
.. describe:: <container>
Modify <object> from <container>
.. describe:: <object>
Object to modify