Package com.datadog.api.client.v2.model

Class JobDefinition

java.lang.Object

com.datadog.api.client.v2.model.JobDefinition

@Generated("https://github.com/DataDog/datadog-api-client-java/blob/master/.generator")
public class JobDefinition
extends Object

Definition of a historical job.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	JSON_PROPERTY_CALCULATED_FIELDS
static final String	JSON_PROPERTY_CASES
static final String	JSON_PROPERTY_FROM
static final String	JSON_PROPERTY_GROUP_SIGNALS_BY
static final String	JSON_PROPERTY_INDEX
static final String	JSON_PROPERTY_MESSAGE
static final String	JSON_PROPERTY_NAME
static final String	JSON_PROPERTY_OPTIONS
static final String	JSON_PROPERTY_QUERIES
static final String	JSON_PROPERTY_REFERENCE_TABLES
static final String	JSON_PROPERTY_TAGS
static final String	JSON_PROPERTY_THIRD_PARTY_CASES
static final String	JSON_PROPERTY_TO
static final String	JSON_PROPERTY_TYPE
boolean	unparsed

Constructor Summary

Constructors

Constructor	Description
JobDefinition()
JobDefinition(List<SecurityMonitoringRuleCaseCreate> cases, Long from, String index, String message, String name, List<HistoricalJobQuery> queries, Long to)

Method Summary

Modifier and Type	Method	Description
JobDefinition	addCalculatedFieldsItem(CalculatedField calculatedFieldsItem)
JobDefinition	addCasesItem(SecurityMonitoringRuleCaseCreate casesItem)
JobDefinition	addGroupSignalsByItem(String groupSignalsByItem)
JobDefinition	addQueriesItem(HistoricalJobQuery queriesItem)
JobDefinition	addReferenceTablesItem(SecurityMonitoringReferenceTable referenceTablesItem)
JobDefinition	addTagsItem(String tagsItem)
JobDefinition	addThirdPartyCasesItem(SecurityMonitoringThirdPartyRuleCaseCreate thirdPartyCasesItem)
JobDefinition	calculatedFields(List<CalculatedField> calculatedFields)
JobDefinition	cases(List<SecurityMonitoringRuleCaseCreate> cases)
boolean	equals(Object o)	Return true if this JobDefinition object is equal to o.
JobDefinition	from(Long from)
Map<String,Object>	getAdditionalProperties()	Return the additional (undeclared) property.
Object	getAdditionalProperty(String key)	Return the additional (undeclared) property with the specified name.
List<CalculatedField>	getCalculatedFields()	Calculated fields.
List<SecurityMonitoringRuleCaseCreate>	getCases()	Cases used for generating job results.
Long	getFrom()	Starting time of data analyzed by the job.
List<String>	getGroupSignalsBy()	Additional grouping to perform on top of the existing groups in the query section.
String	getIndex()	Index used to load the data.
String	getMessage()	Message for generated results.
String	getName()	Job name.
HistoricalJobOptions	getOptions()	Job options.
List<HistoricalJobQuery>	getQueries()	Queries for selecting logs analyzed by the job.
List<SecurityMonitoringReferenceTable>	getReferenceTables()	Reference tables used in the queries.
List<String>	getTags()	Tags for generated signals.
List<SecurityMonitoringThirdPartyRuleCaseCreate>	getThirdPartyCases()	Cases for generating results from third-party detection method.
Long	getTo()	Ending time of data analyzed by the job.
String	getType()	Job type.
JobDefinition	groupSignalsBy(List<String> groupSignalsBy)
int	hashCode()
JobDefinition	index(String index)
JobDefinition	message(String message)
JobDefinition	name(String name)
JobDefinition	options(HistoricalJobOptions options)
JobDefinition	putAdditionalProperty(String key, Object value)	Set the additional (undeclared) property with the specified name and value.
JobDefinition	queries(List<HistoricalJobQuery> queries)
JobDefinition	referenceTables(List<SecurityMonitoringReferenceTable> referenceTables)
void	setCalculatedFields(List<CalculatedField> calculatedFields)
void	setCases(List<SecurityMonitoringRuleCaseCreate> cases)
void	setFrom(Long from)
void	setGroupSignalsBy(List<String> groupSignalsBy)
void	setIndex(String index)
void	setMessage(String message)
void	setName(String name)
void	setOptions(HistoricalJobOptions options)
void	setQueries(List<HistoricalJobQuery> queries)
void	setReferenceTables(List<SecurityMonitoringReferenceTable> referenceTables)
void	setTags(List<String> tags)
void	setThirdPartyCases(List<SecurityMonitoringThirdPartyRuleCaseCreate> thirdPartyCases)
void	setTo(Long to)
void	setType(String type)
JobDefinition	tags(List<String> tags)
JobDefinition	thirdPartyCases(List<SecurityMonitoringThirdPartyRuleCaseCreate> thirdPartyCases)
JobDefinition	to(Long to)
String	toString()
JobDefinition	type(String type)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

unparsed

public boolean unparsed

JSON_PROPERTY_CALCULATED_FIELDS

public static final String JSON_PROPERTY_CALCULATED_FIELDS

See Also:

• Constant Field Values

JSON_PROPERTY_CASES

public static final String JSON_PROPERTY_CASES

See Also:

• Constant Field Values

JSON_PROPERTY_FROM

public static final String JSON_PROPERTY_FROM

See Also:

• Constant Field Values

JSON_PROPERTY_GROUP_SIGNALS_BY

public static final String JSON_PROPERTY_GROUP_SIGNALS_BY

See Also:

• Constant Field Values

JSON_PROPERTY_INDEX

public static final String JSON_PROPERTY_INDEX

See Also:

• Constant Field Values

JSON_PROPERTY_MESSAGE

public static final String JSON_PROPERTY_MESSAGE

See Also:

• Constant Field Values

JSON_PROPERTY_NAME

public static final String JSON_PROPERTY_NAME

See Also:

• Constant Field Values

JSON_PROPERTY_OPTIONS

public static final String JSON_PROPERTY_OPTIONS

See Also:

• Constant Field Values

JSON_PROPERTY_QUERIES

public static final String JSON_PROPERTY_QUERIES

See Also:

• Constant Field Values

JSON_PROPERTY_REFERENCE_TABLES

public static final String JSON_PROPERTY_REFERENCE_TABLES

See Also:

• Constant Field Values

JSON_PROPERTY_TAGS

public static final String JSON_PROPERTY_TAGS

See Also:

• Constant Field Values

JSON_PROPERTY_THIRD_PARTY_CASES

public static final String JSON_PROPERTY_THIRD_PARTY_CASES

See Also:

• Constant Field Values

JSON_PROPERTY_TO

public static final String JSON_PROPERTY_TO

See Also:

• Constant Field Values

JSON_PROPERTY_TYPE

public static final String JSON_PROPERTY_TYPE

See Also:

• Constant Field Values

Constructor Details

JobDefinition

public JobDefinition()

JobDefinition

public JobDefinition(List<SecurityMonitoringRuleCaseCreate> cases,
 Long from,
 String index,
 String message,
 String name,
 List<HistoricalJobQuery> queries,
 Long to)

Method Details

calculatedFields

public JobDefinition calculatedFields(List<CalculatedField> calculatedFields)

addCalculatedFieldsItem

public JobDefinition addCalculatedFieldsItem(CalculatedField calculatedFieldsItem)

getCalculatedFields

@Nullable
public List<CalculatedField> getCalculatedFields()

Calculated fields.

Returns:

calculatedFields

setCalculatedFields

public void setCalculatedFields(List<CalculatedField> calculatedFields)

cases

public JobDefinition cases(List<SecurityMonitoringRuleCaseCreate> cases)

addCasesItem

public JobDefinition addCasesItem(SecurityMonitoringRuleCaseCreate casesItem)

getCases

public List<SecurityMonitoringRuleCaseCreate> getCases()

Cases used for generating job results. Up to 10 cases are allowed.

Returns:

cases

setCases

public void setCases(List<SecurityMonitoringRuleCaseCreate> cases)

from

public JobDefinition from(Long from)

getFrom

public Long getFrom()

Starting time of data analyzed by the job.

Returns:

from

setFrom

public void setFrom(Long from)

groupSignalsBy

public JobDefinition groupSignalsBy(List<String> groupSignalsBy)

addGroupSignalsByItem

public JobDefinition addGroupSignalsByItem(String groupSignalsByItem)

getGroupSignalsBy

@Nullable
public List<String> getGroupSignalsBy()

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

Returns:

groupSignalsBy

setGroupSignalsBy

public void setGroupSignalsBy(List<String> groupSignalsBy)

index

public JobDefinition index(String index)

getIndex

public String getIndex()

Index used to load the data.

Returns:

index

setIndex

public void setIndex(String index)

message

public JobDefinition message(String message)

getMessage

public String getMessage()

Message for generated results.

Returns:

message

setMessage

public void setMessage(String message)

name

public JobDefinition name(String name)

getName

public String getName()

Job name.

Returns:

name

setName

public void setName(String name)

options

public JobDefinition options(HistoricalJobOptions options)

getOptions

@Nullable
public HistoricalJobOptions getOptions()

Job options.

Returns:

options

setOptions

public void setOptions(HistoricalJobOptions options)

queries

public JobDefinition queries(List<HistoricalJobQuery> queries)

addQueriesItem

public JobDefinition addQueriesItem(HistoricalJobQuery queriesItem)

getQueries

public List<HistoricalJobQuery> getQueries()

Queries for selecting logs analyzed by the job. Up to 10 queries are allowed.

Returns:

queries

setQueries

public void setQueries(List<HistoricalJobQuery> queries)

referenceTables

public JobDefinition referenceTables(List<SecurityMonitoringReferenceTable> referenceTables)

addReferenceTablesItem

public JobDefinition addReferenceTablesItem(SecurityMonitoringReferenceTable referenceTablesItem)

getReferenceTables

@Nullable
public List<SecurityMonitoringReferenceTable> getReferenceTables()

Reference tables used in the queries.

Returns:

referenceTables

setReferenceTables

public void setReferenceTables(List<SecurityMonitoringReferenceTable> referenceTables)

tags

public JobDefinition tags(List<String> tags)

addTagsItem

public JobDefinition addTagsItem(String tagsItem)

getTags

@Nullable
public List<String> getTags()

Tags for generated signals.

Returns:

tags

setTags

public void setTags(List<String> tags)

thirdPartyCases

public JobDefinition thirdPartyCases(List<SecurityMonitoringThirdPartyRuleCaseCreate> thirdPartyCases)

addThirdPartyCasesItem

public JobDefinition addThirdPartyCasesItem(SecurityMonitoringThirdPartyRuleCaseCreate thirdPartyCasesItem)

getThirdPartyCases

@Nullable
public List<SecurityMonitoringThirdPartyRuleCaseCreate> getThirdPartyCases()

Cases for generating results from third-party detection method. Only available for third-party detection method. Up to 10 cases are allowed.

Returns:

thirdPartyCases

setThirdPartyCases

public void setThirdPartyCases(List<SecurityMonitoringThirdPartyRuleCaseCreate> thirdPartyCases)

to

public JobDefinition to(Long to)

getTo

public Long getTo()

Ending time of data analyzed by the job.

Returns:

to

setTo

public void setTo(Long to)

type

public JobDefinition type(String type)

getType

@Nullable
public String getType()

Job type.

Returns:

type

setType

public void setType(String type)

putAdditionalProperty

public JobDefinition putAdditionalProperty(String key,
 Object value)

Set the additional (undeclared) property with the specified name and value. If the property does not already exist, create it otherwise replace it.

Parameters:

key - The arbitrary key to set

value - The associated value

Returns:

JobDefinition

getAdditionalProperties

public Map<String,Object> getAdditionalProperties()

Return the additional (undeclared) property.

Returns:

The additional properties

getAdditionalProperty

public Object getAdditionalProperty(String key)

Return the additional (undeclared) property with the specified name.

Parameters:

key - The arbitrary key to get

Returns:

The specific additional property for the given key

equals

public boolean equals(Object o)

Return true if this JobDefinition object is equal to o.

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object