GraphSearchJob type | Wartiva GraphQL API

Represents the state of a submitted search job.

Fields

Field Name	Description
`id` - `GraphSearchJobId!`	This job's unique identifier.
`orgId` - `OrganizationId!`	Unique identifier that corresponds to your deployment of this product or a specific customer account.
`requestedInput` - `GraphSearchInputPayload!`	The search input exactly as submitted by the caller, before any server-side default substitution (columns, sort). Compare against effectiveInput to see which defaults the server substituted. Its timeRange is null when the caller supplied none.
`effectiveInput` - `GraphSearchInputPayload!`	The search input actually executed, after default substitution (columns, sort). This is what the hash, results, and result columns are derived from. Its timeRange stays null when the caller supplied none: a null range applies no seen-within filter to the searched objects (all objects are eligible). Any default window a null range implies for time-series relationship traversal is applied inside the search planner, not substituted here.
`hash` - `String!`	A 128-bit hash representing the unique query criteria.
`user` - `User`	The user that submitted the search.
`state` - `GraphSearchState!`	The state of the search job.
`errors` - `[String!]`	Error messages.
`resultsCount` - `Int!`	Number of results found. A final count when SearchState is DONE.
`hasResults` - `Boolean!`	True if the search has matched one or more objects to return as results.
`startedAt` - `Time!`	The time the search job was started.
`endedAt` - `Time`	The time the search job ended.
`running` - `Boolean!`	True if the search job is still running.
`duration` - `DurationMs!`	How long the search job ran or has been running.
`updatedAt` - `Time!`	The last time a running job updated its status.
`accessedAt` - `Time!`	The last time search results where retrieved for this job.
`winningTrace` - `SearchTraceStage`	Vendor Debugging: trace of the winning search plan.
`unselectedTraces` - `[SearchTraceStage!]`	Vendor Debugging: traces for search plans that were not selected by the engine.

Returned by

graphSearchJob query: Retrieves a graph search job started by graphSearch: its state (RUNNING, DONE, FAILED, USER_CANCEL, SYSTEM_INTERRUPT, or EXPIRED), result count,…

Used by

GraphSearchFastPayload type: The payload returned from graphSearchFast: the completed search job and its first page of results, in one response.
GraphSearchJobCancelPayload type: Payload returned from the graphSearchJobCancel mutation, containing the updated search job after the cancel request.
GraphSearchJobPayload type: Payload wrapper for a loading a graph search job.
GraphSearchPayload type: The payload returned from a graph search.
GraphSearchResultsPayload type: The payload returned from a graph search results query.

Example

{
  "id": GraphSearchJobId,
  "orgId": "615f3b3b28284380e28a7342",
  "requestedInput": GraphSearchInputPayload,
  "effectiveInput": GraphSearchInputPayload,
  "hash": "xyz789",
  "user": User,
  "state": "RUNNING",
  "errors": ["xyz789"],
  "resultsCount": 987,
  "hasResults": false,
  "startedAt": "2021-10-07T18:23:25.829Z",
  "endedAt": "2021-10-07T18:23:25.829Z",
  "running": false,
  "duration": "600",
  "updatedAt": "2021-10-07T18:23:25.829Z",
  "accessedAt": "2021-10-07T18:23:25.829Z",
  "winningTrace": SearchTraceStage,
  "unselectedTraces": [SearchTraceStage]
}