Skip to content

Add docs on how to retrieve account details #239

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: 2.0
Choose a base branch
from
Open

Add docs on how to retrieve account details #239

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 16 additions & 1 deletion doc/services/object-store/v1/account.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,21 @@ To work with an Object Store account, you must first retrieve an account object
.. sample:: object_store/v1/account/get.php
.. refdoc:: OpenStack/ObjectStore/v1/Service.html#method_getAccount

At this point, the object returned is *empty* because we did not execute a HTTP request to receive the state of the
account from the API. This is in accordance with one of the SDK's general policies of not assuming too much at the
expense of performance.

To synchronize the local object's state with the remote API, you can run:

.. code-block:: php

$account->retrieve();

printf("Account has %d objects and %d bytes in %d containers",
$account->objectCount, $account->bytesUsed, $account->containerCount);

and all of the local properties will match those of the remote resource.

Get account metadata
--------------------

Expand Down Expand Up @@ -76,4 +91,4 @@ the metadata of the account will now be:
To reset metadata, you must run:

.. sample:: object_store/v1/account/merge_metadata.php
.. refdoc:: OpenStack/ObjectStore/v1/Models/Account.html#method_mergeMetadata
.. refdoc:: OpenStack/ObjectStore/v1/Models/Account.html#method_mergeMetadata