{ "vdb-name" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The Virtual Database Name", "required" : true }, "connection-type" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "Allowable Connections: 1) NONE - disallow new connections 2) BY VERSION - allow connections only if the version is specified or if this is the earliest 'BY VERSION' vdb and there are no vdbs marked as 'ANY' 3) ANY - allow connections with or without a version specified. If multiple versions of same VDB are deployed, connect to one specified with ANY, or if there are multiple VDBs with ANY then connect to the latest version with ANY ", "required" : false, "allowed" : [ "NONE", "ANY", "BY_VERSION" ] }, "status" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The Virtual Database Status", "required" : true, "allowed" : [ "ACTIVE", "LOADING", "FAILED", "REMOVED" ] }, "vdb-version" : { "type" : { "TYPE_MODEL_VALUE" : "INT" }, "description" : "The Virtual Database Version", "required" : true }, "vdb-description" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "Description of the Virtual Database", "required" : false }, "xml-deployment" : { "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "If the deployment is only the vdb.xml file.", "required" : false }, "properties" : { "type" : { "TYPE_MODEL_VALUE" : "LIST" }, "description" : "properties", "value-type" : { "property-name" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "Name", "required" : true }, "property-value" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "Property value", "required" : true } } }, "import-vdbs" : { "type" : { "TYPE_MODEL_VALUE" : "LIST" }, "value-type" : { "import-vdb-name" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "Name of the Virtual Database to import", "required" : true }, "import-vdb-version" : { "type" : { "TYPE_MODEL_VALUE" : "INT" }, "description" : "Version of the Virtual Database to import", "required" : true }, "import-policies" : { "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "Whether to import associated data policies", "required" : false } }, "description" : "Imported vdbs" }, "models" : { "type" : { "TYPE_MODEL_VALUE" : "LIST" }, "value-type" : { "model-name" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "Name of the model", "required" : true }, "description" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "Description", "required" : false }, "visible" : { "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "Visibility of the model", "required" : false }, "model-type" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "Type of the Model(PHYSICAL, VIRTUAL, FUNCTION, OTHER)", "required" : true, "allowed" : [ "PHYSICAL", "VIRTUAL", "FUNCTION", "OTHER" ] }, "model-path" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "Path to model file inside the archive", "required" : false }, "properties" : { "type" : { "TYPE_MODEL_VALUE" : "LIST" }, "description" : "properties", "value-type" : { "property-name" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "Name", "required" : true }, "property-value" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "Property value", "required" : true } } }, "source-mappings" : { "type" : { "TYPE_MODEL_VALUE" : "LIST" }, "description" : "Model to source mapping", "value-type" : { "source-name" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "Source name for this model", "required" : true }, "jndi-name" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "Connection JNDI Name", "required" : true }, "translator-name" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "Name of the translator", "required" : true } } }, "validity-errors" : { "type" : { "TYPE_MODEL_VALUE" : "LIST" }, "description" : "Model validation errors", "value-type" : { "error-path" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "Path to the error in the Virtual Database", "required" : false }, "severity" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "Severity", "required" : true }, "message" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "Error message", "required" : true } } }, "metadata-status" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "Model metadata loading status", "required" : true, "allowed" : [ "LOADING", "LOADED", "FAILED", "RETRYING" ] } }, "description" : "Models inside a virtual database" }, "override-translators" : { "type" : { "TYPE_MODEL_VALUE" : "LIST" }, "description" : "Overridden translators for the Virtual Database", "value-type" : { "translator-name" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "Name of the translator", "required" : true }, "base-type" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "Translator Base Type", "required" : true }, "translator-description" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "Translator description", "required" : false }, "module-name" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "Translator's Module name", "required" : false }, "properties" : { "type" : { "TYPE_MODEL_VALUE" : "LIST" }, "description" : "properties", "value-type" : { "property-name" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "Name", "required" : true }, "property-value" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "Property value", "required" : true } } } } }, "data-policies" : { "type" : { "TYPE_MODEL_VALUE" : "LIST" }, "description" : "Data access policies defined for the Virtual Database", "value-type" : { "policy-name" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "Name of the policy", "required" : true }, "policy-description" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "Description of the policy", "required" : false }, "allow-create-temp-tables" : { "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "Allows create of temporary table", "required" : false }, "any-authenticated" : { "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "Indicates if the role is mapped to any authenticated user", "required" : false }, "grant-all" : { "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "Indicates if the role grants all permissions", "required" : false }, "data-permissions" : { "type" : { "TYPE_MODEL_VALUE" : "LIST" }, "description" : "Permissions defined for data access", "value-type" : { "resource-name" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "Resource path name for this permission", "required" : true }, "allow-create" : { "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "create allowed", "required" : false }, "allow-delete" : { "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "delete allowed", "required" : false }, "allow-update" : { "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "update allowed", "required" : false }, "allow-read" : { "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "read allowed", "required" : false }, "allow-execute" : { "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "execute allowed", "required" : false }, "allow-alter" : { "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "alter allowed", "required" : false }, "allow-language" : { "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "language allowed", "required" : false } } }, "mapped-role-names" : { "type" : { "TYPE_MODEL_VALUE" : "LIST" }, "description" : "Policy name to role name mapping", "value-type" : { "TYPE_MODEL_VALUE" : "STRING" } } } } }