DocumentMetadata.md

DocumentMetadata

Fields

Field	Type	Required	Description	Example
datasource	Optional<String>	➖	N/A
datasourceInstance	Optional<String>	➖	The datasource instance from which the document was extracted.
objectType	Optional<String>	➖	The type of the result. Interpretation is specific to each datasource. (e.g. for Jira issues, this is the issue type such as Bug or Feature Request).
container	Optional<String>	➖	The name of the container (higher level parent, not direct parent) of the result. Interpretation is specific to each datasource (e.g. Channels for Slack, Project for Jira). cf. parentId
containerId	Optional<String>	➖	The Glean Document ID of the container. Uniquely identifies the container.
superContainerId	Optional<String>	➖	The Glean Document ID of the super container. Super container represents a broader abstraction that contains many containers. For example, whereas container might refer to a folder, super container would refer to a drive.
parentId	Optional<String>	➖	The id of the direct parent of the result. Interpretation is specific to each datasource (e.g. parent issue for Jira). cf. container
mimeType	Optional<String>	➖	N/A
documentId	Optional<String>	➖	The index-wide unique identifier.
loggingId	Optional<String>	➖	A unique identifier used to represent the document in any logging or feedback requests in place of documentId.
documentIdHash	Optional<String>	➖	Hash of the Glean Document ID.
createTime	OffsetDateTime	➖	N/A
updateTime	OffsetDateTime	➖	N/A
author	Optional<Person>	➖	N/A	{ "name": "George Clooney", "obfuscatedId": "abc123" }
owner	Optional<Person>	➖	N/A	{ "name": "George Clooney", "obfuscatedId": "abc123" }
mentionedPeople	List<Person>	➖	A list of people mentioned in the document.
visibility	Optional<DocumentVisibility>	➖	The level of visibility of the document as understood by our system.
components	List<String>	➖	A list of components this result is associated with. Interpretation is specific to each datasource. (e.g. for Jira issues, these are components.)
status	Optional<String>	➖	The status or disposition of the result. Interpretation is specific to each datasource. (e.g. for Jira issues, this is the issue status such as Done, In Progress or Will Not Fix).
statusCategory	Optional<String>	➖	The status category of the result. Meant to be more general than status. Interpretation is specific to each datasource.
pins	List<PinDocument>	➖	A list of stars associated with this result. "Pin" is an older name.
priority	Optional<String>	➖	The document priority. Interpretation is datasource specific.
assignedTo	Optional<Person>	➖	N/A	{ "name": "George Clooney", "obfuscatedId": "abc123" }
updatedBy	Optional<Person>	➖	N/A	{ "name": "George Clooney", "obfuscatedId": "abc123" }
labels	List<String>	➖	A list of tags for the document. Interpretation is datasource specific.
collections	List<Collection>	➖	A list of collections that the document belongs to.
datasourceId	Optional<String>	➖	The user-visible datasource specific id (e.g. Salesforce case number for example, GitHub PR number).
interactions	Optional<DocumentInteractions>	➖	N/A
verification	Optional<Verification>	➖	N/A
viewerInfo	Optional<ViewerInfo>	➖	N/A
permissions	Optional<ObjectPermissions>	➖	N/A
visitCount	Optional<CountInfo>	➖	N/A
shortcuts	List<Shortcut>	➖	A list of shortcuts of which destination URL is for the document.
path	Optional<String>	➖	For file datasources like onedrive/github etc this has the path to the file
customData	Map<String, CustomDataValue>	➖	Custom fields specific to individual datasources
documentCategory	Optional<String>	➖	The document's document_category(.proto).
contactPerson	Optional<Person>	➖	N/A	{ "name": "George Clooney", "obfuscatedId": "abc123" }
thumbnail	Optional<Thumbnail>	➖	N/A
indexStatus	Optional<IndexStatus>	➖	N/A
ancestors	List<Document>	➖	A list of documents that are ancestors of this document in the hierarchy of the document's datasource, for example parent folders or containers. Ancestors can be of different types and some may not be indexed. Higher level ancestors appear earlier in the list.