documents

Creates, updates, deletes, gets or lists a documents resource.

Overview

Name	documents
Type	Resource
Id	google.threatintelligence.documents

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
name	string	Identifier. Server generated name for the alert document. format is projects/{project}/alerts/{alert}/documents/{document}
aiSummary	string	Output only. AI summary of the document.
author	string	Output only. The author of the document.
collectionTime	string (google-datetime)	Output only. Time when the origin source collected the intel.
content	string	Output only. The content of the document.
createTime	string (google-datetime)	Output only. The timestamp of the original external publication of the document.
ingestTime	string (google-datetime)	Output only. Time when GTI received the intel.
languageCode	string	Output only. The language code of the document.
source	string	Output only. Source of the intel item, e.g. DarkMarket.
sourceUpdateTime	string (google-datetime)	Output only. Time when the intel was last updated by the source.
sourceUri	string	Output only. URI of the intel item from the source.
title	string	Output only. The title of the document, if available.
translation	object	Output only. The translation of the document, if available. (id: AlertDocumentTranslation)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	projectsId, alertsId, documentsId		Gets a specific document associated with an alert.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
alertsId	string
documentsId	string
projectsId	string

SELECT examples

get

Gets a specific document associated with an alert.

SELECT
name,
aiSummary,
author,
collectionTime,
content,
createTime,
ingestTime,
languageCode,
source,
sourceUpdateTime,
sourceUri,
title,
translation
FROM google.threatintelligence.documents
WHERE projectsId = '{{ projectsId }}' -- required
AND alertsId = '{{ alertsId }}' -- required
AND documentsId = '{{ documentsId }}' -- required
;