json.schema.api.data.createContainer.json Maven / Gradle / Ivy
{
"$id": "https://open-metadata.org/schema/api/data/createContainer.json",
"$schema": "http://json-schema.org/draft-07/schema#",
"title": "CreateContainerRequest",
"description": "Create Container Model entity request",
"type": "object",
"javaType": "org.openmetadata.schema.api.data.CreateContainer",
"javaInterfaces": ["org.openmetadata.schema.CreateEntity"],
"properties": {
"name": {
"description": "Name that identifies this Container model.",
"$ref": "../../type/basic.json#/definitions/entityName"
},
"displayName": {
"description": "Display Name that identifies this Container model.",
"type": "string"
},
"description": {
"description": "Description of the Container instance.",
"$ref": "../../type/basic.json#/definitions/markdown"
},
"service": {
"description": "Link to the storage service where this container is hosted in.",
"$ref": "../../type/basic.json#/definitions/fullyQualifiedEntityName"
},
"parent": {
"description": "Link to the parent container under which this entity sits.",
"$ref": "../../type/entityReference.json"
},
"dataModel": {
"description": "References to the container's data model, if data is structured, or null otherwise",
"$ref": "../../entity/data/container.json#/definitions/containerDataModel",
"default": null
},
"prefix": {
"description": "Optional prefix path defined for this container",
"type": "string",
"default": null
},
"numberOfObjects": {
"description": "The number of objects/files this container has.",
"type": "number",
"default": null
},
"size": {
"description": "The total size in KB this container has.",
"type": "number",
"default": null
},
"fileFormats": {
"description": "File & data formats identified for the container: e.g. dataFormats=[csv, json]. These can be present both when the container has a dataModel or not",
"type": "array",
"items": {
"$ref": "../../entity/data/container.json#/definitions/fileFormat"
},
"default": null
},
"owners": {
"description": "Owner of this database",
"$ref": "../../type/entityReferenceList.json",
"default": null
},
"tags": {
"description": "Tags for this Container Model",
"type": "array",
"items": {
"$ref": "../../type/tagLabel.json"
},
"default": null
},
"extension": {
"description": "Entity extension data with custom attributes added to the entity.",
"$ref": "../../type/basic.json#/definitions/entityExtension"
},
"sourceUrl": {
"description": "Source URL of container.",
"$ref": "../../type/basic.json#/definitions/sourceUrl"
},
"fullPath": {
"description": "Full path of the container/file.",
"type": "string"
},
"domain" : {
"description": "Fully qualified name of the domain the Container belongs to.",
"type": "string"
},
"dataProducts" : {
"description": "List of fully qualified names of data products this entity is part of.",
"type": "array",
"items" : {
"$ref" : "../../type/basic.json#/definitions/fullyQualifiedEntityName"
}
},
"lifeCycle": {
"description": "Life Cycle of the entity",
"$ref": "../../type/lifeCycle.json"
},
"sourceHash": {
"description": "Source hash of the entity",
"type": "string",
"minLength": 1,
"maxLength": 32
}
},
"required": ["name", "service"],
"additionalProperties": false
}
© 2015 - 2024 Weber Informatics LLC | Privacy Policy