Start line:  
End line:  

Snippet Preview

Snippet HTML Code

Stack Overflow Questions
  /*
   * Copyright 2010-2015 Amazon.com, Inc. or its affiliates. All Rights Reserved.
   * 
   * Licensed under the Apache License, Version 2.0 (the "License").
   * You may not use this file except in compliance with the License.
   * A copy of the License is located at
   * 
   *  http://aws.amazon.com/apache2.0
   * 
  * or in the "license" file accompanying this file. This file is distributed
  * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
  * express or implied. See the License for the specific language governing
  * permissions and limitations under the License.
  */
 package com.amazonaws.services.logs.model;
 
 
Container for the parameters to the GetLogEvents operation.

Retrieves log events from the specified log stream. You can provide an optional time range to filter the results on the event timestamp .

By default, this operation returns as much log events as can fit in a response size of 1MB, up to 10,000 log events. The response will always include a nextForwardToken and a nextBackwardToken in the response body. You can use any of these tokens in subsequent GetLogEvents requests to paginate through events in either forward or backward direction. You can also limit the number of log events returned in the response by specifying the limit parameter in the request.

 
 public class GetLogEventsRequest extends AmazonWebServiceRequest implements SerializableCloneable {
 
     private String logGroupName;
 
     private String logStreamName;

    
A point in time expressed as the number milliseconds since Jan 1, 1970 00:00:00 UTC.

Constraints:
Range: 0 -

 
     private Long startTime;

    
A point in time expressed as the number milliseconds since Jan 1, 1970 00:00:00 UTC.

Constraints:
Range: 0 -

 
     private Long endTime;

    
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.

Constraints:
Length: 1 -

 
     private String nextToken;

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

Constraints:
Range: 1 - 10000

 
     private Integer limit;

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

    
Default constructor for a new GetLogEventsRequest object. Callers should use the setter or fluent setter (with...) methods to initialize this object after creating it.
 
     public GetLogEventsRequest() {}
    
    
Constructs a new GetLogEventsRequest object. Callers should use the setter or fluent setter (with...) methods to initialize any additional object members.

Parameters:
logGroupName
logStreamName
    public GetLogEventsRequest(String logGroupNameString logStreamName) {
        setLogGroupName(logGroupName);
        setLogStreamName(logStreamName);
    }

    
Returns the value of the LogGroupName property for this object.

Constraints:
Length: 1 - 512
Pattern: [\.\-_/#A-Za-z0-9]+

Returns:
The value of the LogGroupName property for this object.
    public String getLogGroupName() {
        return ;
    }
    
    
Sets the value of the LogGroupName property for this object.

Constraints:
Length: 1 - 512
Pattern: [\.\-_/#A-Za-z0-9]+

Parameters:
logGroupName The new value for the LogGroupName property for this object.
    public void setLogGroupName(String logGroupName) {
        this. = logGroupName;
    }
    
    
Sets the value of the LogGroupName property for this object.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Length: 1 - 512
Pattern: [\.\-_/#A-Za-z0-9]+

Parameters:
logGroupName The new value for the LogGroupName property for this object.
Returns:
A reference to this updated object so that method calls can be chained together.
    public GetLogEventsRequest withLogGroupName(String logGroupName) {
        this. = logGroupName;
        return this;
    }

    
Returns the value of the LogStreamName property for this object.

Constraints:
Length: 1 - 512
Pattern: [^:*]*

Returns:
The value of the LogStreamName property for this object.
    public String getLogStreamName() {
        return ;
    }
    
    
Sets the value of the LogStreamName property for this object.

Constraints:
Length: 1 - 512
Pattern: [^:*]*

Parameters:
logStreamName The new value for the LogStreamName property for this object.
    public void setLogStreamName(String logStreamName) {
        this. = logStreamName;
    }
    
    
Sets the value of the LogStreamName property for this object.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Length: 1 - 512
Pattern: [^:*]*

Parameters:
logStreamName The new value for the LogStreamName property for this object.
Returns:
A reference to this updated object so that method calls can be chained together.
    public GetLogEventsRequest withLogStreamName(String logStreamName) {
        this. = logStreamName;
        return this;
    }

    
A point in time expressed as the number milliseconds since Jan 1, 1970 00:00:00 UTC.

Constraints:
Range: 0 -

Returns:
A point in time expressed as the number milliseconds since Jan 1, 1970 00:00:00 UTC.
    public Long getStartTime() {
        return ;
    }
    
    
A point in time expressed as the number milliseconds since Jan 1, 1970 00:00:00 UTC.

Constraints:
Range: 0 -

Parameters:
startTime A point in time expressed as the number milliseconds since Jan 1, 1970 00:00:00 UTC.
    public void setStartTime(Long startTime) {
        this. = startTime;
    }
    
    
A point in time expressed as the number milliseconds since Jan 1, 1970 00:00:00 UTC.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Range: 0 -

Parameters:
startTime A point in time expressed as the number milliseconds since Jan 1, 1970 00:00:00 UTC.
Returns:
A reference to this updated object so that method calls can be chained together.
    public GetLogEventsRequest withStartTime(Long startTime) {
        this. = startTime;
        return this;
    }

    
A point in time expressed as the number milliseconds since Jan 1, 1970 00:00:00 UTC.

Constraints:
Range: 0 -

Returns:
A point in time expressed as the number milliseconds since Jan 1, 1970 00:00:00 UTC.
    public Long getEndTime() {
        return ;
    }
    
    
A point in time expressed as the number milliseconds since Jan 1, 1970 00:00:00 UTC.

Constraints:
Range: 0 -

Parameters:
endTime A point in time expressed as the number milliseconds since Jan 1, 1970 00:00:00 UTC.
    public void setEndTime(Long endTime) {
        this. = endTime;
    }
    
    
A point in time expressed as the number milliseconds since Jan 1, 1970 00:00:00 UTC.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Range: 0 -

Parameters:
endTime A point in time expressed as the number milliseconds since Jan 1, 1970 00:00:00 UTC.
Returns:
A reference to this updated object so that method calls can be chained together.
    public GetLogEventsRequest withEndTime(Long endTime) {
        this. = endTime;
        return this;
    }

    
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.

Constraints:
Length: 1 -

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.
    public String getNextToken() {
        return ;
    }
    
    
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.

Constraints:
Length: 1 -

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.
    public void setNextToken(String nextToken) {
        this. = 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 a reference to this object so that method calls can be chained together.

Constraints:
Length: 1 -

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:
A reference to this updated object so that method calls can be chained together.
    public GetLogEventsRequest withNextToken(String nextToken) {
        this. = nextToken;
        return this;
    }

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

Constraints:
Range: 1 - 10000

Returns:
The maximum number of log events returned in the response. If you don't specify a value, the request would return as much log events as can fit in a response size of 1MB, up to 10,000 log events.
    public Integer getLimit() {
        return ;
    }
    
    
The maximum number of log events returned in the response. If you don't specify a value, the request would return as much log events as can fit in a response size of 1MB, up to 10,000 log events.

Constraints:
Range: 1 - 10000

Parameters:
limit The maximum number of log events returned in the response. If you don't specify a value, the request would return as much log events as can fit in a response size of 1MB, up to 10,000 log events.
    public void setLimit(Integer limit) {
        this. = limit;
    }
    
    
The maximum number of log events returned in the response. If you don't specify a value, the request would return as much log events as can fit in a response size of 1MB, up to 10,000 log events.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Range: 1 - 10000

Parameters:
limit The maximum number of log events returned in the response. If you don't specify a value, the request would return as much log events as can fit in a response size of 1MB, up to 10,000 log events.
Returns:
A reference to this updated object so that method calls can be chained together.
    public GetLogEventsRequest withLimit(Integer limit) {
        this. = limit;
        return this;
    }

    
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).
    public Boolean isStartFromHead() {
        return ;
    }
    
    
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).
    public void setStartFromHead(Boolean startFromHead) {
        this. = 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 a reference to this object so that method calls can be chained together.

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:
A reference to this updated object so that method calls can be chained together.
    public GetLogEventsRequest withStartFromHead(Boolean startFromHead) {
        this. = startFromHead;
        return this;
    }

    
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).
    public Boolean getStartFromHead() {
        return ;
    }

    
Returns a string representation of this object; useful for testing and debugging.

Returns:
A string representation of this object.
See also:
java.lang.Object.toString()
    @Override
    public String toString() {
        StringBuilder sb = new StringBuilder();
        sb.append("{");
        if (getLogGroupName() != nullsb.append("LogGroupName: " + getLogGroupName() + ",");
        if (getLogStreamName() != nullsb.append("LogStreamName: " + getLogStreamName() + ",");
        if (getStartTime() != nullsb.append("StartTime: " + getStartTime() + ",");
        if (getEndTime() != nullsb.append("EndTime: " + getEndTime() + ",");
        if (getNextToken() != nullsb.append("NextToken: " + getNextToken() + ",");
        if (getLimit() != nullsb.append("Limit: " + getLimit() + ",");
        if (isStartFromHead() != nullsb.append("StartFromHead: " + isStartFromHead() );
        sb.append("}");
        return sb.toString();
    }
    
    @Override
    public int hashCode() {
        final int prime = 31;
        int hashCode = 1;
        
        hashCode = prime * hashCode + ((getLogGroupName() == null) ? 0 : getLogGroupName().hashCode()); 
        hashCode = prime * hashCode + ((getLogStreamName() == null) ? 0 : getLogStreamName().hashCode()); 
        hashCode = prime * hashCode + ((getStartTime() == null) ? 0 : getStartTime().hashCode()); 
        hashCode = prime * hashCode + ((getEndTime() == null) ? 0 : getEndTime().hashCode()); 
        hashCode = prime * hashCode + ((getNextToken() == null) ? 0 : getNextToken().hashCode()); 
        hashCode = prime * hashCode + ((getLimit() == null) ? 0 : getLimit().hashCode()); 
        hashCode = prime * hashCode + ((isStartFromHead() == null) ? 0 : isStartFromHead().hashCode()); 
        return hashCode;
    }
    
    @Override
    public boolean equals(Object obj) {
        if (this == objreturn true;
        if (obj == nullreturn false;
        if (obj instanceof GetLogEventsRequest == falsereturn false;
        GetLogEventsRequest other = (GetLogEventsRequest)obj;
        
        if (other.getLogGroupName() == null ^ this.getLogGroupName() == nullreturn false;
        if (other.getLogGroupName() != null && other.getLogGroupName().equals(this.getLogGroupName()) == falsereturn false
        if (other.getLogStreamName() == null ^ this.getLogStreamName() == nullreturn false;
        if (other.getLogStreamName() != null && other.getLogStreamName().equals(this.getLogStreamName()) == falsereturn false
        if (other.getStartTime() == null ^ this.getStartTime() == nullreturn false;
        if (other.getStartTime() != null && other.getStartTime().equals(this.getStartTime()) == falsereturn false
        if (other.getEndTime() == null ^ this.getEndTime() == nullreturn false;
        if (other.getEndTime() != null && other.getEndTime().equals(this.getEndTime()) == falsereturn false
        if (other.getNextToken() == null ^ this.getNextToken() == nullreturn false;
        if (other.getNextToken() != null && other.getNextToken().equals(this.getNextToken()) == falsereturn false
        if (other.getLimit() == null ^ this.getLimit() == nullreturn false;
        if (other.getLimit() != null && other.getLimit().equals(this.getLimit()) == falsereturn false
        if (other.isStartFromHead() == null ^ this.isStartFromHead() == nullreturn false;
        if (other.isStartFromHead() != null && other.isStartFromHead().equals(this.isStartFromHead()) == falsereturn false
        return true;
    }
    
    @Override
    public GetLogEventsRequest clone() {
        
            return (GetLogEventsRequestsuper.clone();
    }
}
    
New to GrepCode? Check out our FAQ X