Class FilterLogEventsRequest

java.lang.Object
com.amazonaws.AmazonWebServiceRequest
com.amazonaws.services.logs.model.FilterLogEventsRequest
All Implemented Interfaces:
ReadLimitInfo, Serializable, Cloneable
public class FilterLogEventsRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
See Also:

  • Constructor Details

    • FilterLogEventsRequest

      public FilterLogEventsRequest()

  • Method Details

    • setLogGroupName

      public void setLogGroupName(String logGroupName)

      The name of the log group to query.

      Parameters:
      logGroupName - The name of the log group to query.

    • getLogGroupName

      public String getLogGroupName()

      The name of the log group to query.

      Returns:
      The name of the log group to query.

    • withLogGroupName

      public FilterLogEventsRequest withLogGroupName(String logGroupName)

      The name of the log group to query.

      Parameters:
      logGroupName - The name of the log group to query.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • getLogStreamNames

      public List<String> getLogStreamNames()

      Optional list of log stream names within the specified log group to search. Defaults to all the log streams in the log group.

      Returns:
      Optional list of log stream names within the specified log group to search. Defaults to all the log streams in the log group.

    • setLogStreamNames

      public void setLogStreamNames(Collection<String> logStreamNames)

      Optional list of log stream names within the specified log group to search. Defaults to all the log streams in the log group.

      Parameters:
      logStreamNames - Optional list of log stream names within the specified log group to search. Defaults to all the log streams in the log group.

    • withLogStreamNames

      public FilterLogEventsRequest withLogStreamNames(String... logStreamNames)

      Optional list of log stream names within the specified log group to search. Defaults to all the log streams in the log group.

      NOTE: This method appends the values to the existing list (if any). Use setLogStreamNames(java.util.Collection) or withLogStreamNames(java.util.Collection) if you want to override the existing values.

      Parameters:
      logStreamNames - Optional list of log stream names within the specified log group to search. Defaults to all the log streams in the log group.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • withLogStreamNames

      public FilterLogEventsRequest withLogStreamNames(Collection<String> logStreamNames)

      Optional list of log stream names within the specified log group to search. Defaults to all the log streams in the log group.

      Parameters:
      logStreamNames - Optional list of log stream names within the specified log group to search. Defaults to all the log streams in the log group.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • setStartTime

      public void setStartTime(Long startTime)

      A point in time expressed as the number of milliseconds since Jan 1, 1970 00:00:00 UTC. If provided, events with a timestamp prior to this time are not returned.

      Parameters:
      startTime - A point in time expressed as the number of milliseconds since Jan 1, 1970 00:00:00 UTC. If provided, events with a timestamp prior to this time are not returned.

    • getStartTime

      public Long getStartTime()

      A point in time expressed as the number of milliseconds since Jan 1, 1970 00:00:00 UTC. If provided, events with a timestamp prior to this time are not returned.

      Returns:
      A point in time expressed as the number of milliseconds since Jan 1, 1970 00:00:00 UTC. If provided, events with a timestamp prior to this time are not returned.

    • withStartTime

      public FilterLogEventsRequest withStartTime(Long startTime)

      A point in time expressed as the number of milliseconds since Jan 1, 1970 00:00:00 UTC. If provided, events with a timestamp prior to this time are not returned.

      Parameters:
      startTime - A point in time expressed as the number of milliseconds since Jan 1, 1970 00:00:00 UTC. If provided, events with a timestamp prior to this time are not returned.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • setEndTime

      public void setEndTime(Long endTime)

      A point in time expressed as the number of milliseconds since Jan 1, 1970 00:00:00 UTC. If provided, events with a timestamp later than this time are not returned.

      Parameters:
      endTime - A point in time expressed as the number of milliseconds since Jan 1, 1970 00:00:00 UTC. If provided, events with a timestamp later than this time are not returned.

    • getEndTime

      public Long getEndTime()

      A point in time expressed as the number of milliseconds since Jan 1, 1970 00:00:00 UTC. If provided, events with a timestamp later than this time are not returned.

      Returns:
      A point in time expressed as the number of milliseconds since Jan 1, 1970 00:00:00 UTC. If provided, events with a timestamp later than this time are not returned.

    • withEndTime

      public FilterLogEventsRequest withEndTime(Long endTime)

      A point in time expressed as the number of milliseconds since Jan 1, 1970 00:00:00 UTC. If provided, events with a timestamp later than this time are not returned.

      Parameters:
      endTime - A point in time expressed as the number of milliseconds since Jan 1, 1970 00:00:00 UTC. If provided, events with a timestamp later than this time are not returned.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • setFilterPattern

      public void setFilterPattern(String filterPattern)

      A valid CloudWatch Logs filter pattern to use for filtering the response. If not provided, all the events are matched.

      Parameters:
      filterPattern - A valid CloudWatch Logs filter pattern to use for filtering the response. If not provided, all the events are matched.

    • getFilterPattern

      public String getFilterPattern()

      A valid CloudWatch Logs filter pattern to use for filtering the response. If not provided, all the events are matched.

      Returns:
      A valid CloudWatch Logs filter pattern to use for filtering the response. If not provided, all the events are matched.

    • withFilterPattern

      public FilterLogEventsRequest withFilterPattern(String filterPattern)

      A valid CloudWatch Logs filter pattern to use for filtering the response. If not provided, all the events are matched.

      Parameters:
      filterPattern - A valid CloudWatch Logs filter pattern to use for filtering the response. If not provided, all the events are matched.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • setNextToken

      public void setNextToken(String nextToken)

      A pagination token obtained from a FilterLogEvents response to continue paginating the FilterLogEvents results. This token is omitted from the response when there are no other events to display.

      Parameters:
      nextToken - A pagination token obtained from a FilterLogEvents response to continue paginating the FilterLogEvents results. This token is omitted from the response when there are no other events to display.

    • getNextToken

      public String getNextToken()

      A pagination token obtained from a FilterLogEvents response to continue paginating the FilterLogEvents results. This token is omitted from the response when there are no other events to display.

      Returns:
      A pagination token obtained from a FilterLogEvents response to continue paginating the FilterLogEvents results. This token is omitted from the response when there are no other events to display.

    • withNextToken

      public FilterLogEventsRequest withNextToken(String nextToken)

      A pagination token obtained from a FilterLogEvents response to continue paginating the FilterLogEvents results. This token is omitted from the response when there are no other events to display.

      Parameters:
      nextToken - A pagination token obtained from a FilterLogEvents response to continue paginating the FilterLogEvents results. This token is omitted from the response when there are no other events to display.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • setLimit

      public void setLimit(Integer limit)

      The maximum number of events to return in a page of results. Default is 10,000 events.

      Parameters:
      limit - The maximum number of events to return in a page of results. Default is 10,000 events.

    • getLimit

      public Integer getLimit()

      The maximum number of events to return in a page of results. Default is 10,000 events.

      Returns:
      The maximum number of events to return in a page of results. Default is 10,000 events.

    • withLimit

      public FilterLogEventsRequest withLimit(Integer limit)

      The maximum number of events to return in a page of results. Default is 10,000 events.

      Parameters:
      limit - The maximum number of events to return in a page of results. Default is 10,000 events.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • setInterleaved

      public void setInterleaved(Boolean interleaved)

      If provided, the API will make a best effort to provide responses that contain events from multiple log streams within the log group interleaved in a single response. If not provided, all the matched log events in the first log stream will be searched first, then those in the next log stream, etc.

      Parameters:
      interleaved - If provided, the API will make a best effort to provide responses that contain events from multiple log streams within the log group interleaved in a single response. If not provided, all the matched log events in the first log stream will be searched first, then those in the next log stream, etc.

    • getInterleaved

      public Boolean getInterleaved()

      If provided, the API will make a best effort to provide responses that contain events from multiple log streams within the log group interleaved in a single response. If not provided, all the matched log events in the first log stream will be searched first, then those in the next log stream, etc.

      Returns:
      If provided, the API will make a best effort to provide responses that contain events from multiple log streams within the log group interleaved in a single response. If not provided, all the matched log events in the first log stream will be searched first, then those in the next log stream, etc.

    • withInterleaved

      public FilterLogEventsRequest withInterleaved(Boolean interleaved)

      If provided, the API will make a best effort to provide responses that contain events from multiple log streams within the log group interleaved in a single response. If not provided, all the matched log events in the first log stream will be searched first, then those in the next log stream, etc.

      Parameters:
      interleaved - If provided, the API will make a best effort to provide responses that contain events from multiple log streams within the log group interleaved in a single response. If not provided, all the matched log events in the first log stream will be searched first, then those in the next log stream, etc.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • isInterleaved

      public Boolean isInterleaved()

      If provided, the API will make a best effort to provide responses that contain events from multiple log streams within the log group interleaved in a single response. If not provided, all the matched log events in the first log stream will be searched first, then those in the next log stream, etc.

      Returns:
      If provided, the API will make a best effort to provide responses that contain events from multiple log streams within the log group interleaved in a single response. If not provided, all the matched log events in the first log stream will be searched first, then those in the next log stream, etc.

    • toString

      public String toString()
      Returns a string representation of this object; useful for testing and debugging.
      Overrides:
      toString in class Object
      Returns:
      A string representation of this object.
      See Also:

    • equals

      public boolean equals(Object obj)
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • clone

      public FilterLogEventsRequest clone()
      Description copied from class: AmazonWebServiceRequest
      Creates a shallow clone of this request. Explicitly does not clone the deep structure of the request object.
      Overrides:
      clone in class AmazonWebServiceRequest
      See Also: