LogsIndex (datadog-api-client 2.27.0 API)

java.lang.Object
- com.datadog.api.client.v1.model.LogsIndex

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

Object describing a Datadog Log index.

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`JSON_PROPERTY_DAILY_LIMIT`
`static String`	`JSON_PROPERTY_DAILY_LIMIT_RESET`
`static String`	`JSON_PROPERTY_DAILY_LIMIT_WARNING_THRESHOLD_PERCENTAGE`
`static String`	`JSON_PROPERTY_EXCLUSION_FILTERS`
`static String`	`JSON_PROPERTY_FILTER`
`static String`	`JSON_PROPERTY_IS_RATE_LIMITED`
`static String`	`JSON_PROPERTY_NAME`
`static String`	`JSON_PROPERTY_NUM_RETENTION_DAYS`
`boolean`	`unparsed`

Constructor Summary

Constructors
Constructor and Description

LogsIndex()

LogsIndex(LogsFilter filter, String name)

Constructors
Constructor and Description
`LogsIndex()`
`LogsIndex(LogsFilter filter, String name)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`LogsIndex`	`addExclusionFiltersItem(LogsExclusion exclusionFiltersItem)`
`LogsIndex`	`dailyLimit(Long dailyLimit)`
`LogsIndex`	`dailyLimitReset(LogsDailyLimitReset dailyLimitReset)`
`LogsIndex`	`dailyLimitWarningThresholdPercentage(Double dailyLimitWarningThresholdPercentage)`
`boolean`	`equals(Object o)` Return true if this LogsIndex object is equal to o.
`LogsIndex`	`exclusionFilters(List<LogsExclusion> exclusionFilters)`
`LogsIndex`	`filter(LogsFilter filter)`
`Map<String,Object>`	`getAdditionalProperties()` Return the additional (undeclared) property.
`Object`	`getAdditionalProperty(String key)` Return the additional (undeclared) property with the specified name.
`Long`	`getDailyLimit()` The number of log events you can send in this index per day before you are rate-limited.
`LogsDailyLimitReset`	`getDailyLimitReset()` Object containing options to override the default daily limit reset time.
`Double`	`getDailyLimitWarningThresholdPercentage()` A percentage threshold of the daily quota at which a Datadog warning event is generated.
`List<LogsExclusion>`	`getExclusionFilters()` An array of exclusion objects.
`LogsFilter`	`getFilter()` Filter for logs.
`Boolean`	`getIsRateLimited()` A boolean stating if the index is rate limited, meaning more logs than the daily limit have been sent.
`String`	`getName()` The name of the index.
`Long`	`getNumRetentionDays()` The number of days before logs are deleted from this index.
`int`	`hashCode()`
`LogsIndex`	`name(String name)`
`LogsIndex`	`numRetentionDays(Long numRetentionDays)`
`LogsIndex`	`putAdditionalProperty(String key, Object value)` Set the additional (undeclared) property with the specified name and value.
`void`	`setDailyLimit(Long dailyLimit)`
`void`	`setDailyLimitReset(LogsDailyLimitReset dailyLimitReset)`
`void`	`setDailyLimitWarningThresholdPercentage(Double dailyLimitWarningThresholdPercentage)`
`void`	`setExclusionFilters(List<LogsExclusion> exclusionFilters)`
`void`	`setFilter(LogsFilter filter)`
`void`	`setName(String name)`
`void`	`setNumRetentionDays(Long numRetentionDays)`
`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_DAILY_LIMIT
```
public static final String JSON_PROPERTY_DAILY_LIMIT
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_DAILY_LIMIT_RESET
```
public static final String JSON_PROPERTY_DAILY_LIMIT_RESET
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_DAILY_LIMIT_WARNING_THRESHOLD_PERCENTAGE
```
public static final String JSON_PROPERTY_DAILY_LIMIT_WARNING_THRESHOLD_PERCENTAGE
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_EXCLUSION_FILTERS
```
public static final String JSON_PROPERTY_EXCLUSION_FILTERS
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_FILTER
```
public static final String JSON_PROPERTY_FILTER
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_IS_RATE_LIMITED
```
public static final String JSON_PROPERTY_IS_RATE_LIMITED
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_NAME
```
public static final String JSON_PROPERTY_NAME
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_NUM_RETENTION_DAYS
```
public static final String JSON_PROPERTY_NUM_RETENTION_DAYS
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - LogsIndex
```
public LogsIndex()
```
  - LogsIndex
```
public LogsIndex(LogsFilter filter,
                 String name)
```
- Method Detail
  - dailyLimit
```
public LogsIndex dailyLimit(Long dailyLimit)
```
  - getDailyLimit
```
@Nullable
public Long getDailyLimit()
```
    The number of log events you can send in this index per day before you are rate-limited.
    
    Returns:
    
    dailyLimit
  - setDailyLimit
```
public void setDailyLimit(Long dailyLimit)
```
  - dailyLimitReset
```
public LogsIndex dailyLimitReset(LogsDailyLimitReset dailyLimitReset)
```
  - getDailyLimitReset
```
@Nullable
public LogsDailyLimitReset getDailyLimitReset()
```
    Object containing options to override the default daily limit reset time.
    
    Returns:
    
    dailyLimitReset
  - setDailyLimitReset
```
public void setDailyLimitReset(LogsDailyLimitReset dailyLimitReset)
```
  - dailyLimitWarningThresholdPercentage
```
public LogsIndex dailyLimitWarningThresholdPercentage(Double dailyLimitWarningThresholdPercentage)
```
  - getDailyLimitWarningThresholdPercentage
```
@Nullable
public Double getDailyLimitWarningThresholdPercentage()
```
    A percentage threshold of the daily quota at which a Datadog warning event is generated. minimum: 50 maximum: 99.99
    
    Returns:
    
    dailyLimitWarningThresholdPercentage
  - setDailyLimitWarningThresholdPercentage
```
public void setDailyLimitWarningThresholdPercentage(Double dailyLimitWarningThresholdPercentage)
```
  - exclusionFilters
```
public LogsIndex exclusionFilters(List<LogsExclusion> exclusionFilters)
```
  - addExclusionFiltersItem
```
public LogsIndex addExclusionFiltersItem(LogsExclusion exclusionFiltersItem)
```
  - getExclusionFilters
```
@Nullable
public List<LogsExclusion> getExclusionFilters()
```
    An array of exclusion objects. The logs are tested against the query of each filter, following the order of the array. Only the first matching active exclusion matters, others (if any) are ignored.
    
    Returns:
    
    exclusionFilters
  - setExclusionFilters
```
public void setExclusionFilters(List<LogsExclusion> exclusionFilters)
```
  - filter
```
public LogsIndex filter(LogsFilter filter)
```
  - getFilter
```
public LogsFilter getFilter()
```
    Filter for logs.
    
    Returns:
    
    filter
  - setFilter
```
public void setFilter(LogsFilter filter)
```
  - getIsRateLimited
```
@Nullable
public Boolean getIsRateLimited()
```
    A boolean stating if the index is rate limited, meaning more logs than the daily limit have been sent. Rate limit is reset every-day at 2pm UTC.
    
    Returns:
    
    isRateLimited
  - name
```
public LogsIndex name(String name)
```
  - getName
```
public String getName()
```
    The name of the index.
    
    Returns:
    
    name
  - setName
```
public void setName(String name)
```
  - numRetentionDays
```
public LogsIndex numRetentionDays(Long numRetentionDays)
```
  - getNumRetentionDays
```
@Nullable
public Long getNumRetentionDays()
```
    The number of days before logs are deleted from this index. Available values depend on retention plans specified in your organization's contract/subscriptions.
    
    Returns:
    
    numRetentionDays
  - setNumRetentionDays
```
public void setNumRetentionDays(Long numRetentionDays)
```
  - putAdditionalProperty
```
public LogsIndex 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:
    
    LogsIndex
  - 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 LogsIndex 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 LogsIndex

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

unparsed

JSON_PROPERTY_DAILY_LIMIT

JSON_PROPERTY_DAILY_LIMIT_RESET

JSON_PROPERTY_DAILY_LIMIT_WARNING_THRESHOLD_PERCENTAGE

JSON_PROPERTY_EXCLUSION_FILTERS

JSON_PROPERTY_FILTER

JSON_PROPERTY_IS_RATE_LIMITED

JSON_PROPERTY_NAME

JSON_PROPERTY_NUM_RETENTION_DAYS

Constructor Detail

LogsIndex

LogsIndex

Method Detail

dailyLimit

getDailyLimit

setDailyLimit

dailyLimitReset

getDailyLimitReset

setDailyLimitReset

dailyLimitWarningThresholdPercentage

getDailyLimitWarningThresholdPercentage

setDailyLimitWarningThresholdPercentage

exclusionFilters

addExclusionFiltersItem

getExclusionFilters

setExclusionFilters

filter

getFilter

setFilter

getIsRateLimited

name

getName

setName

numRetentionDays

getNumRetentionDays

setNumRetentionDays

putAdditionalProperty

getAdditionalProperties

getAdditionalProperty

equals

hashCode

toString