com.datadog.api.client.v2.model

Class ThreatHuntingJobQuery

java.lang.Object

com.datadog.api.client.v2.model.ThreatHuntingJobQuery

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

Query for selecting logs analyzed by the threat hunting job.

Field Summary

Fields

Modifier and Type	Field and Description
static String	JSON_PROPERTY_AGGREGATION
static String	JSON_PROPERTY_DATA_SOURCE
static String	JSON_PROPERTY_DISTINCT_FIELDS
static String	JSON_PROPERTY_GROUP_BY_FIELDS
static String	JSON_PROPERTY_HAS_OPTIONAL_GROUP_BY_FIELDS
static String	JSON_PROPERTY_METRICS
static String	JSON_PROPERTY_NAME
static String	JSON_PROPERTY_QUERY
boolean	unparsed

Constructor Summary

Constructors

Constructor and Description
ThreatHuntingJobQuery()

Method Summary

Modifier and Type	Method and Description
ThreatHuntingJobQuery	addDistinctFieldsItem(String distinctFieldsItem)
ThreatHuntingJobQuery	addGroupByFieldsItem(String groupByFieldsItem)
ThreatHuntingJobQuery	addMetricsItem(String metricsItem)
ThreatHuntingJobQuery	aggregation(SecurityMonitoringRuleQueryAggregation aggregation)
ThreatHuntingJobQuery	dataSource(SecurityMonitoringStandardDataSource dataSource)
ThreatHuntingJobQuery	distinctFields(List<String> distinctFields)
boolean	equals(Object o) Return true if this ThreatHuntingJobQuery object is equal to o.
Map<String,Object>	getAdditionalProperties() Return the additional (undeclared) property.
Object	getAdditionalProperty(String key) Return the additional (undeclared) property with the specified name.
SecurityMonitoringRuleQueryAggregation	getAggregation() The aggregation type.
SecurityMonitoringStandardDataSource	getDataSource() Source of events, either logs, audit trail, or Datadog events.
List<String>	getDistinctFields() Field for which the cardinality is measured.
List<String>	getGroupByFields() Fields to group by.
Boolean	getHasOptionalGroupByFields() When false, events without a group-by value are ignored by the query.
List<String>	getMetrics() Group of target fields to aggregate over when using the sum, max, geo data, or new value aggregations.
String	getName() Name of the query.
String	getQuery() Query to run on logs.
ThreatHuntingJobQuery	groupByFields(List<String> groupByFields)
int	hashCode()
ThreatHuntingJobQuery	hasOptionalGroupByFields(Boolean hasOptionalGroupByFields)
ThreatHuntingJobQuery	metrics(List<String> metrics)
ThreatHuntingJobQuery	name(String name)
ThreatHuntingJobQuery	putAdditionalProperty(String key, Object value) Set the additional (undeclared) property with the specified name and value.
ThreatHuntingJobQuery	query(String query)
void	setAggregation(SecurityMonitoringRuleQueryAggregation aggregation)
void	setDataSource(SecurityMonitoringStandardDataSource dataSource)
void	setDistinctFields(List<String> distinctFields)
void	setGroupByFields(List<String> groupByFields)
void	setHasOptionalGroupByFields(Boolean hasOptionalGroupByFields)
void	setMetrics(List<String> metrics)
void	setName(String name)
void	setQuery(String query)
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

unparsed

public boolean unparsed

JSON_PROPERTY_AGGREGATION

public static final String JSON_PROPERTY_AGGREGATION

See Also:

Constant Field Values

JSON_PROPERTY_DATA_SOURCE

public static final String JSON_PROPERTY_DATA_SOURCE

See Also:

Constant Field Values

JSON_PROPERTY_DISTINCT_FIELDS

public static final String JSON_PROPERTY_DISTINCT_FIELDS

See Also:

Constant Field Values

JSON_PROPERTY_GROUP_BY_FIELDS

public static final String JSON_PROPERTY_GROUP_BY_FIELDS

See Also:

Constant Field Values

JSON_PROPERTY_HAS_OPTIONAL_GROUP_BY_FIELDS

public static final String JSON_PROPERTY_HAS_OPTIONAL_GROUP_BY_FIELDS

See Also:

Constant Field Values

JSON_PROPERTY_METRICS

public static final String JSON_PROPERTY_METRICS

See Also:

Constant Field Values

JSON_PROPERTY_NAME

public static final String JSON_PROPERTY_NAME

See Also:

Constant Field Values

JSON_PROPERTY_QUERY

public static final String JSON_PROPERTY_QUERY

See Also:

Constant Field Values

Constructor Detail

ThreatHuntingJobQuery

public ThreatHuntingJobQuery()

Method Detail

aggregation

public ThreatHuntingJobQuery aggregation(SecurityMonitoringRuleQueryAggregation aggregation)

getAggregation

@Nullable
public SecurityMonitoringRuleQueryAggregation getAggregation()

The aggregation type.

Returns:

aggregation

setAggregation

public void setAggregation(SecurityMonitoringRuleQueryAggregation aggregation)

dataSource

public ThreatHuntingJobQuery dataSource(SecurityMonitoringStandardDataSource dataSource)

getDataSource

@Nullable
public SecurityMonitoringStandardDataSource getDataSource()

Source of events, either logs, audit trail, or Datadog events.

Returns:

dataSource

setDataSource

public void setDataSource(SecurityMonitoringStandardDataSource dataSource)

distinctFields

public ThreatHuntingJobQuery distinctFields(List<String> distinctFields)

addDistinctFieldsItem

public ThreatHuntingJobQuery addDistinctFieldsItem(String distinctFieldsItem)

getDistinctFields

@Nullable
public List<String> getDistinctFields()

Field for which the cardinality is measured. Sent as an array.

Returns:

distinctFields

setDistinctFields

public void setDistinctFields(List<String> distinctFields)

groupByFields

public ThreatHuntingJobQuery groupByFields(List<String> groupByFields)

addGroupByFieldsItem

public ThreatHuntingJobQuery addGroupByFieldsItem(String groupByFieldsItem)

getGroupByFields

@Nullable
public List<String> getGroupByFields()

Fields to group by.

Returns:

groupByFields

setGroupByFields

public void setGroupByFields(List<String> groupByFields)

hasOptionalGroupByFields

public ThreatHuntingJobQuery hasOptionalGroupByFields(Boolean hasOptionalGroupByFields)

getHasOptionalGroupByFields

@Nullable
public Boolean getHasOptionalGroupByFields()

When false, events without a group-by value are ignored by the query. When true, events with missing group-by fields are processed with N/A, replacing the missing values.

Returns:

hasOptionalGroupByFields

setHasOptionalGroupByFields

public void setHasOptionalGroupByFields(Boolean hasOptionalGroupByFields)

metrics

public ThreatHuntingJobQuery metrics(List<String> metrics)

addMetricsItem

public ThreatHuntingJobQuery addMetricsItem(String metricsItem)

getMetrics

@Nullable
public List<String> getMetrics()

Group of target fields to aggregate over when using the sum, max, geo data, or new value aggregations. The sum, max, and geo data aggregations only accept one value in this list, whereas the new value aggregation accepts up to five values.

Returns:

metrics

setMetrics

public void setMetrics(List<String> metrics)

name

public ThreatHuntingJobQuery name(String name)

getName

@Nullable
public String getName()

Name of the query.

Returns:

name

setName

public void setName(String name)

query

public ThreatHuntingJobQuery query(String query)

getQuery

@Nullable
public String getQuery()

Query to run on logs.

Returns:

query

setQuery

public void setQuery(String query)

putAdditionalProperty

public ThreatHuntingJobQuery 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:

ThreatHuntingJobQuery

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 ThreatHuntingJobQuery 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