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

Class HistoricalJobQuery

java.lang.Object
com.datadog.api.client.v2.model.HistoricalJobQuery
@Generated("https://github.com/DataDog/datadog-api-client-java/blob/master/.generator") public class HistoricalJobQuery extends Object
Query for selecting logs analyzed by the historical job.

  • Field Details

  • Constructor Details

    • HistoricalJobQuery

      public HistoricalJobQuery()

  • Method Details

    • additionalFilters

      public HistoricalJobQuery additionalFilters(String additionalFilters)

    • getAdditionalFilters

      @Nullable public String getAdditionalFilters()
      Additional filters appended to the query at evaluation time.
      Returns:
      additionalFilters

    • setAdditionalFilters

      public void setAdditionalFilters(String additionalFilters)

    • aggregation

      public HistoricalJobQuery aggregation(SecurityMonitoringRuleQueryAggregation aggregation)

    • getAggregation

      @Nullable public SecurityMonitoringRuleQueryAggregation getAggregation()
      The aggregation type.
      Returns:
      aggregation

    • setAggregation

      public void setAggregation(SecurityMonitoringRuleQueryAggregation aggregation)

    • correlatedByFields

      public HistoricalJobQuery correlatedByFields(List<String> correlatedByFields)

    • addCorrelatedByFieldsItem

      public HistoricalJobQuery addCorrelatedByFieldsItem(String correlatedByFieldsItem)

    • getCorrelatedByFields

      @Nullable public List<String> getCorrelatedByFields()
      Fields used to correlate results across queries in sequence detection rules.
      Returns:
      correlatedByFields

    • setCorrelatedByFields

      public void setCorrelatedByFields(List<String> correlatedByFields)

    • correlatedQueryIndex

      public HistoricalJobQuery correlatedQueryIndex(Long correlatedQueryIndex)

    • getCorrelatedQueryIndex

      @Nullable public Long getCorrelatedQueryIndex()
      Zero-based index of the query to correlate with in sequence detection rules. Up to 10 queries are supported, so valid values are 0 to 9. minimum: 0 maximum: 9
      Returns:
      correlatedQueryIndex

    • setCorrelatedQueryIndex

      public void setCorrelatedQueryIndex(Long correlatedQueryIndex)

    • customQueryExtension

      public HistoricalJobQuery customQueryExtension(String customQueryExtension)

    • getCustomQueryExtension

      @Nullable public String getCustomQueryExtension()
      Custom query extension used to refine the base query.
      Returns:
      customQueryExtension

    • setCustomQueryExtension

      public void setCustomQueryExtension(String customQueryExtension)

    • dataSource

      public HistoricalJobQuery dataSource(SecurityMonitoringStandardDataSource dataSource)

    • getDataSource

      @Nullable public SecurityMonitoringStandardDataSource getDataSource()
      Source of events, either logs, audit trail, security signals, or Datadog events. app_sec_spans is deprecated in favor of spans.
      Returns:
      dataSource

    • setDataSource

      public void setDataSource(SecurityMonitoringStandardDataSource dataSource)

    • datasetIds

      public HistoricalJobQuery datasetIds(List<String> datasetIds)

    • addDatasetIdsItem

      public HistoricalJobQuery addDatasetIdsItem(String datasetIdsItem)

    • getDatasetIds

      @Nullable public List<String> getDatasetIds()
      IDs of reference datasets used by this query.
      Returns:
      datasetIds

    • setDatasetIds

      public void setDatasetIds(List<String> datasetIds)

    • distinctFields

      public HistoricalJobQuery distinctFields(List<String> distinctFields)

    • addDistinctFieldsItem

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

    • addGroupByFieldsItem

      public HistoricalJobQuery addGroupByFieldsItem(String groupByFieldsItem)

    • getGroupByFields

      @Nullable public List<String> getGroupByFields()
      Fields to group by.
      Returns:
      groupByFields

    • setGroupByFields

      public void setGroupByFields(List<String> groupByFields)

    • hasOptionalGroupByFields

      public HistoricalJobQuery 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)

    • index

      public HistoricalJobQuery index(String index)

    • getIndex

      @Nullable public String getIndex()
      Index used to load the data for this query.
      Returns:
      index

    • setIndex

      public void setIndex(String index)

    • indexes

      public HistoricalJobQuery indexes(List<String> indexes)

    • addIndexesItem

      public HistoricalJobQuery addIndexesItem(String indexesItem)

    • getIndexes

      @Nullable public List<String> getIndexes()
      Indexes used to load the data for this query. Mutually exclusive with index.
      Returns:
      indexes

    • setIndexes

      public void setIndexes(List<String> indexes)

    • metrics

      public HistoricalJobQuery metrics(List<String> metrics)

    • addMetricsItem

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

    • getName

      @Nullable public String getName()
      Name of the query.
      Returns:
      name

    • setName

      public void setName(String name)

    • query

      public HistoricalJobQuery query(String query)

    • getQuery

      @Nullable public String getQuery()
      Query to run on logs.
      Returns:
      query

    • setQuery

      public void setQuery(String query)

    • queryLanguage

      public HistoricalJobQuery queryLanguage(String queryLanguage)

    • getQueryLanguage

      @Nullable public String getQueryLanguage()
      Language used to parse the query string.
      Returns:
      queryLanguage

    • setQueryLanguage

      public void setQueryLanguage(String queryLanguage)

    • putAdditionalProperty

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

    • 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 HistoricalJobQuery 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