dbsnapshot : The DBSnapshot WAPI object.¶
The object provides information about the OneDB snapshot, the last time it was taken and the descriptive comment.
Object Reference¶
References to dbsnapshot are object references.
Example: dbsnapshot/b25lLmRiX3NuYXBzaG90JDA:1465912167/Test%20snapshot
Restrictions¶
The object does not support the following operations:
Create (insert)
Delete
Modify (update)
Global search (searches via the search object)
Scheduling
CSV export
The object cannot be managed on Cloud Platform members.
Fields¶
These fields are actual members of the object; thus, they can be requested by using _return_fields, if the fields are readable.
The basic version of the object contains the field(s): comment, timestamp.
comment¶
- comment¶
The descriptive comment.
Type
String.
Search
The field is not available for search.
Notes
The comment is part of the base object.
The comment cannot be updated.
comment cannot be written.
timestamp¶
- timestamp¶
The time when the latest OneDB snapshot was taken in Epoch seconds format.
Type
Timestamp.
Search
The field is not available for search.
Notes
The timestamp is part of the base object.
The timestamp cannot be updated.
timestamp cannot be written.
Function Calls¶
rollback_db_snapshot¶
This method rollback OneDB snapshot if one exists.
This function does not support multiple object matches when called as part of an atomic insertion operation.
Input fields
None
Output fields
None
save_db_snapshot¶
This method takes OneDB snapshot
This function does not support multiple object matches when called as part of an atomic insertion operation.
Input fields
comment ( String. ). This parameter is mandatory. The descriptive comment.
Output fields
_ref ( String. ) The ref to created dbsnapshot object.
Fields List¶
Field |
Type |
Req |
R/O |
Base |
Search |
---|---|---|---|---|---|
comment |
String |
Y |
Y |
Y |
N/A |
timestamp |
Timestamp |
N |
Y |
Y |
N/A |