Class JobDefinition

Definition of a historical job.

Hierarchy

  • JobDefinition

Constructors

constructor

Properties

additionalProperties? calculatedFields? cases from groupSignalsBy? index message name options? queries referenceTables? tags? thirdPartyCases? to type?

Constructors

constructor

Properties

Optional additionalProperties

additionalProperties?: {
    [key: string]: any;
}

A container for additional, undeclared properties. This is a holder for any undeclared properties as specified with the 'additionalProperties' keyword in the OAS document.

Type declaration

  • [key: string]: any

Optional calculatedFields

calculatedFields?: CalculatedField[]

Calculated fields.

cases

cases: SecurityMonitoringRuleCaseCreate[]

Cases used for generating job results.

from

from: number

Starting time of data analyzed by the job.

Optional groupSignalsBy

groupSignalsBy?: string[]

Additional grouping to perform on top of the existing groups in the query section. Must be a subset of the existing groups.

index

index: string

Index used to load the data.

message

message: string

Message for generated results.

name

name: string

Job name.

Optional options

options?: HistoricalJobOptions

Job options.

queries

queries: HistoricalJobQuery[]

Queries for selecting logs analyzed by the job.

Optional referenceTables

referenceTables?: SecurityMonitoringReferenceTable[]

Reference tables used in the queries.

Optional tags

tags?: string[]

Tags for generated signals.

Optional thirdPartyCases

thirdPartyCases?: SecurityMonitoringThirdPartyRuleCaseCreate[]

Cases for generating results from third-party detection method. Only available for third-party detection method.

to

to: number

Ending time of data analyzed by the job.

Optional type

type?: string

Job type.

Settings

Member Visibility

Theme

Generated using TypeDoc