SecurityMonitoringStandardRuleQuery (datadog-api-client 2.42.0 API)

java.lang.Object
- com.datadog.api.client.v2.model.SecurityMonitoringStandardRuleQuery

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

Query for matching rule.

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`JSON_PROPERTY_AGGREGATION`
`static String`	`JSON_PROPERTY_CUSTOM_QUERY_EXTENSION`
`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_INDEX`
`static String`	`JSON_PROPERTY_METRIC`
`static String`	`JSON_PROPERTY_METRICS`
`static String`	`JSON_PROPERTY_NAME`
`static String`	`JSON_PROPERTY_QUERY`
`boolean`	`unparsed`

Constructor Summary

Constructors
Constructor and Description

SecurityMonitoringStandardRuleQuery()

Constructors
Constructor and Description
`SecurityMonitoringStandardRuleQuery()`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`SecurityMonitoringStandardRuleQuery`	`addDistinctFieldsItem(String distinctFieldsItem)`
`SecurityMonitoringStandardRuleQuery`	`addGroupByFieldsItem(String groupByFieldsItem)`
`SecurityMonitoringStandardRuleQuery`	`addMetricsItem(String metricsItem)`
`SecurityMonitoringStandardRuleQuery`	`aggregation(SecurityMonitoringRuleQueryAggregation aggregation)`
`SecurityMonitoringStandardRuleQuery`	`customQueryExtension(String customQueryExtension)`
`SecurityMonitoringStandardRuleQuery`	`dataSource(SecurityMonitoringStandardDataSource dataSource)`
`SecurityMonitoringStandardRuleQuery`	`distinctFields(List<String> distinctFields)`
`boolean`	`equals(Object o)` Return true if this SecurityMonitoringStandardRuleQuery 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.
`String`	`getCustomQueryExtension()` Query extension to append to the logs query.
`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 rule.
`String`	`getIndex()` This field is currently unstable and might be removed in a minor version upgrade. The index to run the query on, if the `dataSource` is `logs`.
`String`	`getMetric()` Deprecated.
`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.
`SecurityMonitoringStandardRuleQuery`	`groupByFields(List<String> groupByFields)`
`int`	`hashCode()`
`SecurityMonitoringStandardRuleQuery`	`index(String index)`
`SecurityMonitoringStandardRuleQuery`	`metric(String metric)`
`SecurityMonitoringStandardRuleQuery`	`metrics(List<String> metrics)`
`SecurityMonitoringStandardRuleQuery`	`name(String name)`
`SecurityMonitoringStandardRuleQuery`	`putAdditionalProperty(String key, Object value)` Set the additional (undeclared) property with the specified name and value.
`SecurityMonitoringStandardRuleQuery`	`query(String query)`
`void`	`setAggregation(SecurityMonitoringRuleQueryAggregation aggregation)`
`void`	`setCustomQueryExtension(String customQueryExtension)`
`void`	`setDataSource(SecurityMonitoringStandardDataSource dataSource)`
`void`	`setDistinctFields(List<String> distinctFields)`
`void`	`setGroupByFields(List<String> groupByFields)`
`void`	`setIndex(String index)`
`void`	`setMetric(String metric)` Deprecated.
`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_CUSTOM_QUERY_EXTENSION

public static final String JSON_PROPERTY_CUSTOM_QUERY_EXTENSION

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_INDEX

public static final String JSON_PROPERTY_INDEX

See Also:: Constant Field Values

JSON_PROPERTY_METRIC

public static final String JSON_PROPERTY_METRIC

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
- SecurityMonitoringStandardRuleQuery
```
public SecurityMonitoringStandardRuleQuery()
```

Method Detail

aggregation

public SecurityMonitoringStandardRuleQuery aggregation(SecurityMonitoringRuleQueryAggregation aggregation)

getAggregation

@Nullable
public SecurityMonitoringRuleQueryAggregation getAggregation()

The aggregation type.

Returns:: aggregation

setAggregation

public void setAggregation(SecurityMonitoringRuleQueryAggregation aggregation)

customQueryExtension

public SecurityMonitoringStandardRuleQuery customQueryExtension(String customQueryExtension)

getCustomQueryExtension
```
@Nullable
public String getCustomQueryExtension()
```
Query extension to append to the logs query.

Returns:

customQueryExtension

setCustomQueryExtension

public void setCustomQueryExtension(String customQueryExtension)

dataSource

public SecurityMonitoringStandardRuleQuery 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 SecurityMonitoringStandardRuleQuery distinctFields(List<String> distinctFields)

addDistinctFieldsItem

public SecurityMonitoringStandardRuleQuery 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 SecurityMonitoringStandardRuleQuery groupByFields(List<String> groupByFields)

addGroupByFieldsItem

public SecurityMonitoringStandardRuleQuery addGroupByFieldsItem(String groupByFieldsItem)

getGroupByFields
```
@Nullable
public List<String> getGroupByFields()
```
Fields to group by.

Returns:

groupByFields

setGroupByFields

public void setGroupByFields(List<String> groupByFields)

getHasOptionalGroupByFields
```
@Nullable
public Boolean getHasOptionalGroupByFields()
```
When false, events without a group-by value are ignored by the rule. When true, events with missing group-by fields are processed with N/A, replacing the missing values.

Returns:

hasOptionalGroupByFields

index

public SecurityMonitoringStandardRuleQuery index(String index)

getIndex
```
@Nullable
public String getIndex()
```
This field is currently unstable and might be removed in a minor version upgrade. The index to run the query on, if the dataSource is logs. Only used for scheduled rules - in other words, when the schedulingOptions field is present in the rule payload.

Returns:

index

setIndex
```
public void setIndex(String index)
```

metric

public SecurityMonitoringStandardRuleQuery metric(String metric)

getMetric
```
@Deprecated
 @Nullable
public String getMetric()
```
Deprecated.

(Deprecated) The target field to aggregate over when using the sum or max aggregations. metrics field should be used instead.

Returns:

metric

setMetric

@Deprecated
public void setMetric(String metric)

Deprecated.

metrics

public SecurityMonitoringStandardRuleQuery metrics(List<String> metrics)

addMetricsItem

public SecurityMonitoringStandardRuleQuery 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 SecurityMonitoringStandardRuleQuery name(String name)

getName
```
@Nullable
public String getName()
```
Name of the query.

Returns:

name

setName
```
public void setName(String name)
```

query

public SecurityMonitoringStandardRuleQuery query(String query)

getQuery
```
@Nullable
public String getQuery()
```
Query to run on logs.

Returns:

query

setQuery
```
public void setQuery(String query)
```

putAdditionalProperty
```
public SecurityMonitoringStandardRuleQuery 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:

SecurityMonitoringStandardRuleQuery

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

Class SecurityMonitoringStandardRuleQuery

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

unparsed

JSON_PROPERTY_AGGREGATION

JSON_PROPERTY_CUSTOM_QUERY_EXTENSION

JSON_PROPERTY_DATA_SOURCE

JSON_PROPERTY_DISTINCT_FIELDS

JSON_PROPERTY_GROUP_BY_FIELDS

JSON_PROPERTY_HAS_OPTIONAL_GROUP_BY_FIELDS

JSON_PROPERTY_INDEX

JSON_PROPERTY_METRIC

JSON_PROPERTY_METRICS

JSON_PROPERTY_NAME

JSON_PROPERTY_QUERY

Constructor Detail

SecurityMonitoringStandardRuleQuery

Method Detail

aggregation

getAggregation

setAggregation

customQueryExtension

getCustomQueryExtension

setCustomQueryExtension

dataSource

getDataSource

setDataSource

distinctFields

addDistinctFieldsItem

getDistinctFields

setDistinctFields

groupByFields

addGroupByFieldsItem

getGroupByFields

setGroupByFields

getHasOptionalGroupByFields

index

getIndex

setIndex

metric

getMetric

setMetric

metrics

addMetricsItem

getMetrics

setMetrics

name

getName

setName

query

getQuery

setQuery

putAdditionalProperty

getAdditionalProperties

getAdditionalProperty

equals

hashCode

toString