Class GetLogEventsRequest

java.lang.Object
com.amazonaws.AmazonWebServiceRequest
com.amazonaws.services.logs.model.GetLogEventsRequest
All Implemented Interfaces:
ReadLimitInfo, Serializable, Cloneable

public class GetLogEventsRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
See Also:
  • Constructor Details

    • GetLogEventsRequest

      public GetLogEventsRequest()
      Default constructor for GetLogEventsRequest object. Callers should use the setter or fluent setter (with...) methods to initialize the object after creating it.
    • GetLogEventsRequest

      public GetLogEventsRequest(String logGroupName, String logStreamName)
      Constructs a new GetLogEventsRequest object. Callers should use the setter or fluent setter (with...) methods to initialize any additional object members.
      Parameters:
      logGroupName - The name of the log group to query.
      logStreamName - The name of the log stream to query.
  • 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 GetLogEventsRequest 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.
    • setLogStreamName

      public void setLogStreamName(String logStreamName)

      The name of the log stream to query.

      Parameters:
      logStreamName - The name of the log stream to query.
    • getLogStreamName

      public String getLogStreamName()

      The name of the log stream to query.

      Returns:
      The name of the log stream to query.
    • withLogStreamName

      public GetLogEventsRequest withLogStreamName(String logStreamName)

      The name of the log stream to query.

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

      public void setStartTime(Long startTime)
      Parameters:
      startTime -
    • getStartTime

      public Long getStartTime()
      Returns:
    • withStartTime

      public GetLogEventsRequest withStartTime(Long startTime)
      Parameters:
      startTime -
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • setEndTime

      public void setEndTime(Long endTime)
      Parameters:
      endTime -
    • getEndTime

      public Long getEndTime()
      Returns:
    • withEndTime

      public GetLogEventsRequest withEndTime(Long endTime)
      Parameters:
      endTime -
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • setNextToken

      public void setNextToken(String nextToken)

      A string token used for pagination that points to the next page of results. It must be a value obtained from the nextForwardToken or nextBackwardToken fields in the response of the previous GetLogEvents request.

      Parameters:
      nextToken - A string token used for pagination that points to the next page of results. It must be a value obtained from the nextForwardToken or nextBackwardToken fields in the response of the previous GetLogEvents request.
    • getNextToken

      public String getNextToken()

      A string token used for pagination that points to the next page of results. It must be a value obtained from the nextForwardToken or nextBackwardToken fields in the response of the previous GetLogEvents request.

      Returns:
      A string token used for pagination that points to the next page of results. It must be a value obtained from the nextForwardToken or nextBackwardToken fields in the response of the previous GetLogEvents request.
    • withNextToken

      public GetLogEventsRequest withNextToken(String nextToken)

      A string token used for pagination that points to the next page of results. It must be a value obtained from the nextForwardToken or nextBackwardToken fields in the response of the previous GetLogEvents request.

      Parameters:
      nextToken - A string token used for pagination that points to the next page of results. It must be a value obtained from the nextForwardToken or nextBackwardToken fields in the response of the previous GetLogEvents request.
      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 log events returned in the response. If you don't specify a value, the request would return as many log events as can fit in a response size of 1MB, up to 10,000 log events.

      Parameters:
      limit - The maximum number of log events returned in the response. If you don't specify a value, the request would return as many log events as can fit in a response size of 1MB, up to 10,000 log events.
    • getLimit

      public Integer getLimit()

      The maximum number of log events returned in the response. If you don't specify a value, the request would return as many log events as can fit in a response size of 1MB, up to 10,000 log events.

      Returns:
      The maximum number of log events returned in the response. If you don't specify a value, the request would return as many log events as can fit in a response size of 1MB, up to 10,000 log events.
    • withLimit

      public GetLogEventsRequest withLimit(Integer limit)

      The maximum number of log events returned in the response. If you don't specify a value, the request would return as many log events as can fit in a response size of 1MB, up to 10,000 log events.

      Parameters:
      limit - The maximum number of log events returned in the response. If you don't specify a value, the request would return as many log events as can fit in a response size of 1MB, up to 10,000 log events.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • setStartFromHead

      public void setStartFromHead(Boolean startFromHead)

      If set to true, the earliest log events would be returned first. The default is false (the latest log events are returned first).

      Parameters:
      startFromHead - If set to true, the earliest log events would be returned first. The default is false (the latest log events are returned first).
    • getStartFromHead

      public Boolean getStartFromHead()

      If set to true, the earliest log events would be returned first. The default is false (the latest log events are returned first).

      Returns:
      If set to true, the earliest log events would be returned first. The default is false (the latest log events are returned first).
    • withStartFromHead

      public GetLogEventsRequest withStartFromHead(Boolean startFromHead)

      If set to true, the earliest log events would be returned first. The default is false (the latest log events are returned first).

      Parameters:
      startFromHead - If set to true, the earliest log events would be returned first. The default is false (the latest log events are returned first).
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • isStartFromHead

      public Boolean isStartFromHead()

      If set to true, the earliest log events would be returned first. The default is false (the latest log events are returned first).

      Returns:
      If set to true, the earliest log events would be returned first. The default is false (the latest log events are returned first).
    • 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 GetLogEventsRequest 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: