DatabaseInfo
Description
An object containing descriptional and state information of the database. (Note: The field level constraints listed here might not cover all the constraints on the field. Additional constraints might exist.)
Model Properties
Property | Required | Type | Description | ||
---|---|---|---|---|---|
version | False | string | A unique string version assigned by the system when the object is created or modified. No assumption can be made on the format or content of this identifier. The identifier must be provided whenever attempting to modify/delete an existing object. As the version will change every time the object is modified, the value provided in this identifier must match exactly what is present in the system or the request will be rejected. | ||
softwareVersion | True | string | A String object containing the value of the software version that the database is being used by. Field level constraints: cannot be null, must match pattern ^((?!;).)*$. (Note: Additional constraints might exist) |
||
buildVersion | True | string | A String object containing the build version of the software version that the database is being used by. Field level constraints: cannot be null, must match pattern ^((?!;).)*$. (Note: Additional constraints might exist) |
||
restoredFromBackup | False | string | A BackupStateType object which holds the status of the database with respect to a backup. Possible values are:BACKUP_NEW BACKUP_RESTORED BACKUP_RESTORED_NEW NONE | ||
schemaVersion | True | string | A String object containing the schema version in use by the database. Field level constraints: cannot be null, must match pattern ^((?!;).)*$. (Note: Additional constraints might exist) |
||
configDBVersion | False | string | This value mimic the semantic of the version attribute common to ConfigEntities and ManagementEntities but it is applied to the entire DB. The value is updated whenever the database is restarted, a ConfigEntity or ManagementEntity is created/deleted/modified. Note that a change in the value does not imply that the database changes are visible to the user; however, if a user visible object is modified this globalVersion will be updated. | ||
firewallConfigChecksum | False | string | A string which specifies the current deployed configuration checksum, updated on each successful deployment | ||
isBootstrapSuccessFul | False | boolean | A Boolean object which holds the status whether Bootstrap was successfully run on the database or not. | ||
id | False | string | A unique string identifier assigned by the system when the object is created. No assumption can be made on the format or content of this identifier. The identifier must be provided whenever attempting to modify/delete (or reference) an existing object. Field level constraints: must match pattern ^((?!;).)*$. (Note: Additional constraints might exist) |
||
type | True | string | A UTF8 string, all letters lower-case, that represents the class-type. This corresponds to the class name. |