LogsIndexUpdateRequest (datadog-api-client 2.31.0 API)

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

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

Object for updating 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_DISABLE_DAILY_LIMIT`
`static String`	`JSON_PROPERTY_EXCLUSION_FILTERS`
`static String`	`JSON_PROPERTY_FILTER`
`static String`	`JSON_PROPERTY_NUM_FLEX_LOGS_RETENTION_DAYS`
`static String`	`JSON_PROPERTY_NUM_RETENTION_DAYS`
`boolean`	`unparsed`

Constructor Summary

Constructors
Constructor and Description

LogsIndexUpdateRequest()

LogsIndexUpdateRequest(LogsFilter filter)

Constructors
Constructor and Description
`LogsIndexUpdateRequest()`
`LogsIndexUpdateRequest(LogsFilter filter)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`LogsIndexUpdateRequest`	`addExclusionFiltersItem(LogsExclusion exclusionFiltersItem)`
`LogsIndexUpdateRequest`	`dailyLimit(Long dailyLimit)`
`LogsIndexUpdateRequest`	`dailyLimitReset(LogsDailyLimitReset dailyLimitReset)`
`LogsIndexUpdateRequest`	`dailyLimitWarningThresholdPercentage(Double dailyLimitWarningThresholdPercentage)`
`LogsIndexUpdateRequest`	`disableDailyLimit(Boolean disableDailyLimit)`
`boolean`	`equals(Object o)` Return true if this LogsIndexUpdateRequest object is equal to o.
`LogsIndexUpdateRequest`	`exclusionFilters(List<LogsExclusion> exclusionFilters)`
`LogsIndexUpdateRequest`	`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.
`Boolean`	`getDisableDailyLimit()` If true, sets the `daily_limit` value to null and the index is not limited on a daily basis (any specified `daily_limit` value in the request is ignored).
`List<LogsExclusion>`	`getExclusionFilters()` An array of exclusion objects.
`LogsFilter`	`getFilter()` Filter for logs.
`Long`	`getNumFlexLogsRetentionDays()` The total number of days logs are stored in Standard and Flex Tier before being deleted from the index.
`Long`	`getNumRetentionDays()` The number of days logs are stored in Standard Tier before aging into the Flex Tier or being deleted from the index.
`int`	`hashCode()`
`LogsIndexUpdateRequest`	`numFlexLogsRetentionDays(Long numFlexLogsRetentionDays)`
`LogsIndexUpdateRequest`	`numRetentionDays(Long numRetentionDays)`
`LogsIndexUpdateRequest`	`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`	`setDisableDailyLimit(Boolean disableDailyLimit)`
`void`	`setExclusionFilters(List<LogsExclusion> exclusionFilters)`
`void`	`setFilter(LogsFilter filter)`
`void`	`setNumFlexLogsRetentionDays(Long numFlexLogsRetentionDays)`
`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_DISABLE_DAILY_LIMIT
```
public static final String JSON_PROPERTY_DISABLE_DAILY_LIMIT
```
    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_NUM_FLEX_LOGS_RETENTION_DAYS
```
public static final String JSON_PROPERTY_NUM_FLEX_LOGS_RETENTION_DAYS
```
    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
  - LogsIndexUpdateRequest
```
public LogsIndexUpdateRequest()
```
  - LogsIndexUpdateRequest
```
public LogsIndexUpdateRequest(LogsFilter filter)
```
- Method Detail
  - dailyLimit
```
public LogsIndexUpdateRequest 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 LogsIndexUpdateRequest 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 LogsIndexUpdateRequest 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)
```
  - disableDailyLimit
```
public LogsIndexUpdateRequest disableDailyLimit(Boolean disableDailyLimit)
```
  - getDisableDailyLimit
```
@Nullable
public Boolean getDisableDailyLimit()
```
    If true, sets the daily_limit value to null and the index is not limited on a daily basis (any specified daily_limit value in the request is ignored). If false or omitted, the index's current daily_limit is maintained.
    
    Returns:
    
    disableDailyLimit
  - setDisableDailyLimit
```
public void setDisableDailyLimit(Boolean disableDailyLimit)
```
  - exclusionFilters
```
public LogsIndexUpdateRequest exclusionFilters(List<LogsExclusion> exclusionFilters)
```
  - addExclusionFiltersItem
```
public LogsIndexUpdateRequest 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 LogsIndexUpdateRequest filter(LogsFilter filter)
```
  - getFilter
```
public LogsFilter getFilter()
```
    Filter for logs.
    
    Returns:
    
    filter
  - setFilter
```
public void setFilter(LogsFilter filter)
```
  - numFlexLogsRetentionDays
```
public LogsIndexUpdateRequest numFlexLogsRetentionDays(Long numFlexLogsRetentionDays)
```
  - getNumFlexLogsRetentionDays
```
@Nullable
public Long getNumFlexLogsRetentionDays()
```
    The total number of days logs are stored in Standard and Flex Tier before being deleted from the index. If Standard Tier is enabled on this index, logs are first retained in Standard Tier for the number of days specified through num_retention_days, and then stored in Flex Tier until the number of days specified in num_flex_logs_retention_days is reached. The available values depend on retention plans specified in your organization's contract/subscriptions.
    Note: Changing this value affects all logs already in this index. It may also affect billing.
    
    Returns:
    
    numFlexLogsRetentionDays
  - setNumFlexLogsRetentionDays
```
public void setNumFlexLogsRetentionDays(Long numFlexLogsRetentionDays)
```
  - numRetentionDays
```
public LogsIndexUpdateRequest numRetentionDays(Long numRetentionDays)
```
  - getNumRetentionDays
```
@Nullable
public Long getNumRetentionDays()
```
    The number of days logs are stored in Standard Tier before aging into the Flex Tier or being deleted from the index. The available values depend on retention plans specified in your organization's contract/subscriptions.
    Note: Changing this value affects all logs already in this index. It may also affect billing.
    
    Returns:
    
    numRetentionDays
  - setNumRetentionDays
```
public void setNumRetentionDays(Long numRetentionDays)
```
  - putAdditionalProperty
```
public LogsIndexUpdateRequest 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:
    
    LogsIndexUpdateRequest
  - 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 LogsIndexUpdateRequest 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 LogsIndexUpdateRequest

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_DISABLE_DAILY_LIMIT

JSON_PROPERTY_EXCLUSION_FILTERS

JSON_PROPERTY_FILTER

JSON_PROPERTY_NUM_FLEX_LOGS_RETENTION_DAYS

JSON_PROPERTY_NUM_RETENTION_DAYS

Constructor Detail

LogsIndexUpdateRequest

LogsIndexUpdateRequest

Method Detail

dailyLimit

getDailyLimit

setDailyLimit

dailyLimitReset

getDailyLimitReset

setDailyLimitReset

dailyLimitWarningThresholdPercentage

getDailyLimitWarningThresholdPercentage

setDailyLimitWarningThresholdPercentage

disableDailyLimit

getDisableDailyLimit

setDisableDailyLimit

exclusionFilters

addExclusionFiltersItem

getExclusionFilters

setExclusionFilters

filter

getFilter

setFilter

numFlexLogsRetentionDays

getNumFlexLogsRetentionDays

setNumFlexLogsRetentionDays

numRetentionDays

getNumRetentionDays

setNumRetentionDays

putAdditionalProperty

getAdditionalProperties

getAdditionalProperty

equals

hashCode

toString