Home

Represents a home space in Dremio. All home spaces returned by the REST API have an entityType of home.

Home Parameters

The JSON representation of a home space looks like this:

{
  "entityType": "home" [immutable, generated by Dremio],
  "id": String [immutable, generated by Dremio],
  "name": String [immutable, generated by Dremio],
  "tag": String [immutable, generated by Dremio],
  "children": [CatalogEntitySummary] [optional] [immutable, generated by Dremio]
}
Name Type Description
id String Home space ID. Generated by Dremio, immutable.
name String Name of the home space. Generated by Dremio, immutable.
tag String Identifies the instance of the home space, changed each time it is modified. Generated by Dremio, immutable.
children [CatalogEntitySummary] The children of the home space. Optional, immutable.

Children Parameter

A summary representation of a catalog entity, used when entities are listed as children.

{
  "id": String [immutable, generated by Dremio],
  "path": [String] [immutable, generated by Dremio],
  "tag": String [immutable, generated by Dremio],
  "type": String [DATASET, CONTAINER, FILE],
  "datasetType": [VIRTUAL, PROMOTED, DIRECT] [immutable, optional],
  "containerType": [SPACE, SOURCE, FOLDER, HOME] [immutable, optional]
}
Name Type Description
id String Catalog Entity ID. Generated by Dremio, immutable.
path [String] Catalog Entity path. Immutable.
tag String Identifies the instance of the entity, changed each time it is modified. Generated by Dremio, immutable.
type String The entity type, must be either DATASET, CONTAINER or FILE. Generated by Dremio, immutable.
datasetType String The dataset type, must be either VIRTUAL, PROMOTED or DIRECT. Only present if type is dataset. Generated by Dremio, immutable.
containerType String The container type, must be either SPACE, SOURCE, FOLDER or HOME. Only present if type is containerType. Generated by Dremio, immutable.

results matching ""

    No results matching ""