LogsListRequest (datadog-api-client 2.27.0 API)

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

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

Object to send with the request to retrieve a list of logs from your Organization.

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`JSON_PROPERTY_INDEX`
`static String`	`JSON_PROPERTY_LIMIT`
`static String`	`JSON_PROPERTY_QUERY`
`static String`	`JSON_PROPERTY_SORT`
`static String`	`JSON_PROPERTY_START_AT`
`static String`	`JSON_PROPERTY_TIME`
`boolean`	`unparsed`

Constructor Summary

Constructors
Constructor and Description

LogsListRequest()

LogsListRequest(LogsListRequestTime time)

Constructors
Constructor and Description
`LogsListRequest()`
`LogsListRequest(LogsListRequestTime time)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object o)` Return true if this LogsListRequest 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.
`String`	`getIndex()` The log index on which the request is performed.
`Integer`	`getLimit()` Number of logs return in the response.
`String`	`getQuery()` The search query - following the log search syntax.
`LogsSort`	`getSort()` Time-ascending `asc` or time-descending `desc` results.
`String`	`getStartAt()` Hash identifier of the first log to return in the list, available in a log `id` attribute.
`LogsListRequestTime`	`getTime()` Timeframe to retrieve the log from.
`int`	`hashCode()`
`LogsListRequest`	`index(String index)`
`LogsListRequest`	`limit(Integer limit)`
`LogsListRequest`	`putAdditionalProperty(String key, Object value)` Set the additional (undeclared) property with the specified name and value.
`LogsListRequest`	`query(String query)`
`void`	`setIndex(String index)`
`void`	`setLimit(Integer limit)`
`void`	`setQuery(String query)`
`void`	`setSort(LogsSort sort)`
`void`	`setStartAt(String startAt)`
`void`	`setTime(LogsListRequestTime time)`
`LogsListRequest`	`sort(LogsSort sort)`
`LogsListRequest`	`startAt(String startAt)`
`LogsListRequest`	`time(LogsListRequestTime time)`
`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_INDEX
```
public static final String JSON_PROPERTY_INDEX
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_LIMIT
```
public static final String JSON_PROPERTY_LIMIT
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_QUERY
```
public static final String JSON_PROPERTY_QUERY
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_SORT
```
public static final String JSON_PROPERTY_SORT
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_START_AT
```
public static final String JSON_PROPERTY_START_AT
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_TIME
```
public static final String JSON_PROPERTY_TIME
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - LogsListRequest
```
public LogsListRequest()
```
  - LogsListRequest
```
public LogsListRequest(LogsListRequestTime time)
```
- Method Detail
  - index
```
public LogsListRequest index(String index)
```
  - getIndex
```
@Nullable
public String getIndex()
```
    The log index on which the request is performed. For multi-index organizations, the default is all live indexes. Historical indexes of rehydrated logs must be specified.
    
    Returns:
    
    index
  - setIndex
```
public void setIndex(String index)
```
  - limit
```
public LogsListRequest limit(Integer limit)
```
  - getLimit
```
@Nullable
public Integer getLimit()
```
    Number of logs return in the response. maximum: 1000
    
    Returns:
    
    limit
  - setLimit
```
public void setLimit(Integer limit)
```
  - query
```
public LogsListRequest query(String query)
```
  - getQuery
```
@Nullable
public String getQuery()
```
    The search query - following the log search syntax.
    
    Returns:
    
    query
  - setQuery
```
public void setQuery(String query)
```
  - sort
```
public LogsListRequest sort(LogsSort sort)
```
  - getSort
```
@Nullable
public LogsSort getSort()
```
    Time-ascending asc or time-descending desc results.
    
    Returns:
    
    sort
  - setSort
```
public void setSort(LogsSort sort)
```
  - startAt
```
public LogsListRequest startAt(String startAt)
```
  - getStartAt
```
@Nullable
public String getStartAt()
```
    Hash identifier of the first log to return in the list, available in a log id attribute. This parameter is used for the pagination feature.
    Note: This parameter is ignored if the corresponding log is out of the scope of the specified time window.
    
    Returns:
    
    startAt
  - setStartAt
```
public void setStartAt(String startAt)
```
  - time
```
public LogsListRequest time(LogsListRequestTime time)
```
  - getTime
```
public LogsListRequestTime getTime()
```
    Timeframe to retrieve the log from.
    
    Returns:
    
    time
  - setTime
```
public void setTime(LogsListRequestTime time)
```
  - putAdditionalProperty
```
public LogsListRequest 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:
    
    LogsListRequest
  - 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 LogsListRequest 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 LogsListRequest

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

unparsed

JSON_PROPERTY_INDEX

JSON_PROPERTY_LIMIT

JSON_PROPERTY_QUERY

JSON_PROPERTY_SORT

JSON_PROPERTY_START_AT

JSON_PROPERTY_TIME

Constructor Detail

LogsListRequest

LogsListRequest

Method Detail

index

getIndex

setIndex

limit

getLimit

setLimit

query

getQuery

setQuery

sort

getSort

setSort

startAt

getStartAt

setStartAt

time

getTime

setTime

putAdditionalProperty

getAdditionalProperties

getAdditionalProperty

equals

hashCode

toString