LogsGroupBy (datadog-api-client 2.27.0 API)

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

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

A group by rule

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`JSON_PROPERTY_FACET`
`static String`	`JSON_PROPERTY_HISTOGRAM`
`static String`	`JSON_PROPERTY_LIMIT`
`static String`	`JSON_PROPERTY_MISSING`
`static String`	`JSON_PROPERTY_SORT`
`static String`	`JSON_PROPERTY_TOTAL`
`boolean`	`unparsed`

Constructor Summary

Constructors
Constructor and Description

LogsGroupBy()

LogsGroupBy(String facet)

Constructors
Constructor and Description
`LogsGroupBy()`
`LogsGroupBy(String facet)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object o)` Return true if this LogsGroupBy object is equal to o.
`LogsGroupBy`	`facet(String facet)`
`Map<String,Object>`	`getAdditionalProperties()` Return the additional (undeclared) property.
`Object`	`getAdditionalProperty(String key)` Return the additional (undeclared) property with the specified name.
`String`	`getFacet()` The name of the facet to use (required)
`LogsGroupByHistogram`	`getHistogram()` Used to perform a histogram computation (only for measure facets).
`Long`	`getLimit()` The maximum buckets to return for this group by.
`LogsGroupByMissing`	`getMissing()` The value to use for logs that don't have the facet used to group by
`LogsAggregateSort`	`getSort()` A sort rule
`LogsGroupByTotal`	`getTotal()` A resulting object to put the given computes in over all the matching records.
`int`	`hashCode()`
`LogsGroupBy`	`histogram(LogsGroupByHistogram histogram)`
`LogsGroupBy`	`limit(Long limit)`
`LogsGroupBy`	`missing(LogsGroupByMissing missing)`
`LogsGroupBy`	`putAdditionalProperty(String key, Object value)` Set the additional (undeclared) property with the specified name and value.
`void`	`setFacet(String facet)`
`void`	`setHistogram(LogsGroupByHistogram histogram)`
`void`	`setLimit(Long limit)`
`void`	`setMissing(LogsGroupByMissing missing)`
`void`	`setSort(LogsAggregateSort sort)`
`void`	`setTotal(LogsGroupByTotal total)`
`LogsGroupBy`	`sort(LogsAggregateSort sort)`
`String`	`toString()`
`LogsGroupBy`	`total(LogsGroupByTotal total)`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - unparsed
```
public boolean unparsed
```
  - JSON_PROPERTY_FACET
```
public static final String JSON_PROPERTY_FACET
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_HISTOGRAM
```
public static final String JSON_PROPERTY_HISTOGRAM
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_LIMIT
```
public static final String JSON_PROPERTY_LIMIT
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_MISSING
```
public static final String JSON_PROPERTY_MISSING
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_SORT
```
public static final String JSON_PROPERTY_SORT
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_TOTAL
```
public static final String JSON_PROPERTY_TOTAL
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - LogsGroupBy
```
public LogsGroupBy()
```
  - LogsGroupBy
```
public LogsGroupBy(String facet)
```
- Method Detail
  - facet
```
public LogsGroupBy facet(String facet)
```
  - getFacet
```
public String getFacet()
```
    The name of the facet to use (required)
    
    Returns:
    
    facet
  - setFacet
```
public void setFacet(String facet)
```
  - histogram
```
public LogsGroupBy histogram(LogsGroupByHistogram histogram)
```
  - getHistogram
```
@Nullable
public LogsGroupByHistogram getHistogram()
```
    Used to perform a histogram computation (only for measure facets). Note: at most 100 buckets are allowed, the number of buckets is (max - min)/interval.
    
    Returns:
    
    histogram
  - setHistogram
```
public void setHistogram(LogsGroupByHistogram histogram)
```
  - limit
```
public LogsGroupBy limit(Long limit)
```
  - getLimit
```
@Nullable
public Long getLimit()
```
    The maximum buckets to return for this group by. Note: at most 10000 buckets are allowed. If grouping by multiple facets, the product of limits must not exceed 10000.
    
    Returns:
    
    limit
  - setLimit
```
public void setLimit(Long limit)
```
  - missing
```
public LogsGroupBy missing(LogsGroupByMissing missing)
```
  - getMissing
```
@Nullable
public LogsGroupByMissing getMissing()
```
    The value to use for logs that don't have the facet used to group by
    
    Returns:
    
    missing
  - setMissing
```
public void setMissing(LogsGroupByMissing missing)
```
  - sort
```
public LogsGroupBy sort(LogsAggregateSort sort)
```
  - getSort
```
@Nullable
public LogsAggregateSort getSort()
```
    A sort rule
    
    Returns:
    
    sort
  - setSort
```
public void setSort(LogsAggregateSort sort)
```
  - total
```
public LogsGroupBy total(LogsGroupByTotal total)
```
  - getTotal
```
@Nullable
public LogsGroupByTotal getTotal()
```
    A resulting object to put the given computes in over all the matching records.
    
    Returns:
    
    total
  - setTotal
```
public void setTotal(LogsGroupByTotal total)
```
  - putAdditionalProperty
```
public LogsGroupBy 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:
    
    LogsGroupBy
  - 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 LogsGroupBy 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 LogsGroupBy

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

unparsed

JSON_PROPERTY_FACET

JSON_PROPERTY_HISTOGRAM

JSON_PROPERTY_LIMIT

JSON_PROPERTY_MISSING

JSON_PROPERTY_SORT

JSON_PROPERTY_TOTAL

Constructor Detail

LogsGroupBy

LogsGroupBy

Method Detail

facet

getFacet

setFacet

histogram

getHistogram

setHistogram

limit

getLimit

setLimit

missing

getMissing

setMissing

sort

getSort

setSort

total

getTotal

setTotal

putAdditionalProperty

getAdditionalProperties

getAdditionalProperty

equals

hashCode

toString