Package com.datadog.api.client.v1.model

Class LogsListRequest

java.lang.Object
com.datadog.api.client.v1.model.LogsListRequest
@Generated("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 Details

  • Constructor Details

    • LogsListRequest

      public LogsListRequest()

    • LogsListRequest

      public LogsListRequest(LogsListRequestTime time)

  • Method Details

    • 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