/* * Copyright 2018-2023 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; import java.io.Serializable; import javax.annotation.Generated; import com.amazonaws.AmazonWebServiceRequest; /** * * @see AWS API * Documentation */ @Generated("com.amazonaws:aws-java-sdk-code-generator") public class GetLogEventsRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable { /** *
* The name of the log group. *
*
* You must include either logGroupIdentifier
or logGroupName
, but not both.
*
* Specify either the name or ARN of the log group to view events from. If the log group is in a source account and * you are using a monitoring account, you must use the log group ARN. *
*
* You must include either logGroupIdentifier
or logGroupName
, but not both.
*
* The name of the log stream. *
*/ private String logStreamName; /** *
* The start of the time range, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC
.
* Events with a timestamp equal to this time or later than this time are included. Events with a timestamp earlier
* than this time are not included.
*
* The end of the time range, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC
.
* Events with a timestamp equal to or later than this time are not included.
*
* The token for the next set of items to return. (You received this token from a previous call.) *
*/ private String nextToken; /** ** The maximum number of log events returned. If you don't specify a limit, the default is as many log events as can * fit in a response size of 1 MB (up to 10,000 log events). *
*/ private Integer limit; /** ** If the value is true, the earliest log events are returned first. If the value is false, the latest log events * are returned first. The default value is false. *
*
* If you are using a previous nextForwardToken
value as the nextToken
in this operation,
* you must specify true
for startFromHead
.
*
* Specify true
to display the log event fields with all sensitive data unmasked and visible. The
* default is false
.
*
* To use this operation with this parameter, you must be signed into an account with the logs:Unmask
* permission.
*
* You must include either logGroupIdentifier
or logGroupName
, but not both.
*
* The name of the log group. *
*
* You must include either logGroupIdentifier
or logGroupName
, but not both.
*
* You must include either logGroupIdentifier
or logGroupName
, but not both.
*
* The name of the log group. *
*
* You must include either logGroupIdentifier
or logGroupName
, but not both.
*
* You must include either logGroupIdentifier
or logGroupName
, but not both.
*
* The name of the log group. *
*
* You must include either logGroupIdentifier
or logGroupName
, but not both.
*
* You must include either logGroupIdentifier
or logGroupName
, but not both.
*
* Specify either the name or ARN of the log group to view events from. If the log group is in a source account and * you are using a monitoring account, you must use the log group ARN. *
*
* You must include either logGroupIdentifier
or logGroupName
, but not both.
*
* You must include either logGroupIdentifier
or logGroupName
, but not both.
*
* Specify either the name or ARN of the log group to view events from. If the log group is in a source account and * you are using a monitoring account, you must use the log group ARN. *
*
* You must include either logGroupIdentifier
or logGroupName
, but not both.
*
* You must include either logGroupIdentifier
or logGroupName
, but not both.
*
* Specify either the name or ARN of the log group to view events from. If the log group is in a source account and * you are using a monitoring account, you must use the log group ARN. *
*
* You must include either logGroupIdentifier
or logGroupName
, but not both.
*
* You must include either logGroupIdentifier
or logGroupName
, but not both.
*
* The name of the log stream. *
* * @param logStreamName * The name of the log stream. */ public void setLogStreamName(String logStreamName) { this.logStreamName = logStreamName; } /** ** The name of the log stream. *
* * @return The name of the log stream. */ public String getLogStreamName() { return this.logStreamName; } /** ** The name of the log stream. *
* * @param logStreamName * The name of the log stream. * @return Returns a reference to this object so that method calls can be chained together. */ public GetLogEventsRequest withLogStreamName(String logStreamName) { setLogStreamName(logStreamName); return this; } /** *
* The start of the time range, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC
.
* Events with a timestamp equal to this time or later than this time are included. Events with a timestamp earlier
* than this time are not included.
*
Jan 1, 1970 00:00:00 UTC
. Events with a timestamp equal to this time or later than this time
* are included. Events with a timestamp earlier than this time are not included.
*/
public void setStartTime(Long startTime) {
this.startTime = startTime;
}
/**
*
* The start of the time range, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC
.
* Events with a timestamp equal to this time or later than this time are included. Events with a timestamp earlier
* than this time are not included.
*
Jan 1, 1970 00:00:00 UTC
. Events with a timestamp equal to this time or later than this time
* are included. Events with a timestamp earlier than this time are not included.
*/
public Long getStartTime() {
return this.startTime;
}
/**
*
* The start of the time range, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC
.
* Events with a timestamp equal to this time or later than this time are included. Events with a timestamp earlier
* than this time are not included.
*
Jan 1, 1970 00:00:00 UTC
. Events with a timestamp equal to this time or later than this time
* are included. Events with a timestamp earlier than this time are not included.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public GetLogEventsRequest withStartTime(Long startTime) {
setStartTime(startTime);
return this;
}
/**
*
* The end of the time range, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC
.
* Events with a timestamp equal to or later than this time are not included.
*
Jan 1, 1970 00:00:00 UTC
. Events with a timestamp equal to or later than this time are not
* included.
*/
public void setEndTime(Long endTime) {
this.endTime = endTime;
}
/**
*
* The end of the time range, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC
.
* Events with a timestamp equal to or later than this time are not included.
*
Jan 1, 1970 00:00:00 UTC
. Events with a timestamp equal to or later than this time are not
* included.
*/
public Long getEndTime() {
return this.endTime;
}
/**
*
* The end of the time range, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC
.
* Events with a timestamp equal to or later than this time are not included.
*
Jan 1, 1970 00:00:00 UTC
. Events with a timestamp equal to or later than this time are not
* included.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public GetLogEventsRequest withEndTime(Long endTime) {
setEndTime(endTime);
return this;
}
/**
* * The token for the next set of items to return. (You received this token from a previous call.) *
* * @param nextToken * The token for the next set of items to return. (You received this token from a previous call.) */ public void setNextToken(String nextToken) { this.nextToken = nextToken; } /** ** The token for the next set of items to return. (You received this token from a previous call.) *
* * @return The token for the next set of items to return. (You received this token from a previous call.) */ public String getNextToken() { return this.nextToken; } /** ** The token for the next set of items to return. (You received this token from a previous call.) *
* * @param nextToken * The token for the next set of items to return. (You received this token from a previous call.) * @return Returns a reference to this object so that method calls can be chained together. */ public GetLogEventsRequest withNextToken(String nextToken) { setNextToken(nextToken); return this; } /** ** The maximum number of log events returned. If you don't specify a limit, the default is as many log events as can * fit in a response size of 1 MB (up to 10,000 log events). *
* * @param limit * The maximum number of log events returned. If you don't specify a limit, the default is as many log events * as can fit in a response size of 1 MB (up to 10,000 log events). */ public void setLimit(Integer limit) { this.limit = limit; } /** ** The maximum number of log events returned. If you don't specify a limit, the default is as many log events as can * fit in a response size of 1 MB (up to 10,000 log events). *
* * @return The maximum number of log events returned. If you don't specify a limit, the default is as many log * events as can fit in a response size of 1 MB (up to 10,000 log events). */ public Integer getLimit() { return this.limit; } /** ** The maximum number of log events returned. If you don't specify a limit, the default is as many log events as can * fit in a response size of 1 MB (up to 10,000 log events). *
* * @param limit * The maximum number of log events returned. If you don't specify a limit, the default is as many log events * as can fit in a response size of 1 MB (up to 10,000 log events). * @return Returns a reference to this object so that method calls can be chained together. */ public GetLogEventsRequest withLimit(Integer limit) { setLimit(limit); return this; } /** ** If the value is true, the earliest log events are returned first. If the value is false, the latest log events * are returned first. The default value is false. *
*
* If you are using a previous nextForwardToken
value as the nextToken
in this operation,
* you must specify true
for startFromHead
.
*
* If you are using a previous nextForwardToken
value as the nextToken
in this
* operation, you must specify true
for startFromHead
.
*/
public void setStartFromHead(Boolean startFromHead) {
this.startFromHead = startFromHead;
}
/**
*
* If the value is true, the earliest log events are returned first. If the value is false, the latest log events * are returned first. The default value is false. *
*
* If you are using a previous nextForwardToken
value as the nextToken
in this operation,
* you must specify true
for startFromHead
.
*
* If you are using a previous nextForwardToken
value as the nextToken
in this
* operation, you must specify true
for startFromHead
.
*/
public Boolean getStartFromHead() {
return this.startFromHead;
}
/**
*
* If the value is true, the earliest log events are returned first. If the value is false, the latest log events * are returned first. The default value is false. *
*
* If you are using a previous nextForwardToken
value as the nextToken
in this operation,
* you must specify true
for startFromHead
.
*
* If you are using a previous nextForwardToken
value as the nextToken
in this
* operation, you must specify true
for startFromHead
.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public GetLogEventsRequest withStartFromHead(Boolean startFromHead) {
setStartFromHead(startFromHead);
return this;
}
/**
*
* If the value is true, the earliest log events are returned first. If the value is false, the latest log events * are returned first. The default value is false. *
*
* If you are using a previous nextForwardToken
value as the nextToken
in this operation,
* you must specify true
for startFromHead
.
*
* If you are using a previous nextForwardToken
value as the nextToken
in this
* operation, you must specify true
for startFromHead
.
*/
public Boolean isStartFromHead() {
return this.startFromHead;
}
/**
*
* Specify true
to display the log event fields with all sensitive data unmasked and visible. The
* default is false
.
*
* To use this operation with this parameter, you must be signed into an account with the logs:Unmask
* permission.
*
true
to display the log event fields with all sensitive data unmasked and visible.
* The default is false
.
*
* To use this operation with this parameter, you must be signed into an account with the
* logs:Unmask
permission.
*/
public void setUnmask(Boolean unmask) {
this.unmask = unmask;
}
/**
*
* Specify true
to display the log event fields with all sensitive data unmasked and visible. The
* default is false
.
*
* To use this operation with this parameter, you must be signed into an account with the logs:Unmask
* permission.
*
true
to display the log event fields with all sensitive data unmasked and visible.
* The default is false
.
*
* To use this operation with this parameter, you must be signed into an account with the
* logs:Unmask
permission.
*/
public Boolean getUnmask() {
return this.unmask;
}
/**
*
* Specify true
to display the log event fields with all sensitive data unmasked and visible. The
* default is false
.
*
* To use this operation with this parameter, you must be signed into an account with the logs:Unmask
* permission.
*
true
to display the log event fields with all sensitive data unmasked and visible.
* The default is false
.
*
* To use this operation with this parameter, you must be signed into an account with the
* logs:Unmask
permission.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public GetLogEventsRequest withUnmask(Boolean unmask) {
setUnmask(unmask);
return this;
}
/**
*
* Specify true
to display the log event fields with all sensitive data unmasked and visible. The
* default is false
.
*
* To use this operation with this parameter, you must be signed into an account with the logs:Unmask
* permission.
*
true
to display the log event fields with all sensitive data unmasked and visible.
* The default is false
.
*
* To use this operation with this parameter, you must be signed into an account with the
* logs:Unmask
permission.
*/
public Boolean isUnmask() {
return this.unmask;
}
/**
* Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be
* redacted from this string using a placeholder value.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getLogGroupName() != null)
sb.append("LogGroupName: ").append(getLogGroupName()).append(",");
if (getLogGroupIdentifier() != null)
sb.append("LogGroupIdentifier: ").append(getLogGroupIdentifier()).append(",");
if (getLogStreamName() != null)
sb.append("LogStreamName: ").append(getLogStreamName()).append(",");
if (getStartTime() != null)
sb.append("StartTime: ").append(getStartTime()).append(",");
if (getEndTime() != null)
sb.append("EndTime: ").append(getEndTime()).append(",");
if (getNextToken() != null)
sb.append("NextToken: ").append(getNextToken()).append(",");
if (getLimit() != null)
sb.append("Limit: ").append(getLimit()).append(",");
if (getStartFromHead() != null)
sb.append("StartFromHead: ").append(getStartFromHead()).append(",");
if (getUnmask() != null)
sb.append("Unmask: ").append(getUnmask());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof GetLogEventsRequest == false)
return false;
GetLogEventsRequest other = (GetLogEventsRequest) obj;
if (other.getLogGroupName() == null ^ this.getLogGroupName() == null)
return false;
if (other.getLogGroupName() != null && other.getLogGroupName().equals(this.getLogGroupName()) == false)
return false;
if (other.getLogGroupIdentifier() == null ^ this.getLogGroupIdentifier() == null)
return false;
if (other.getLogGroupIdentifier() != null && other.getLogGroupIdentifier().equals(this.getLogGroupIdentifier()) == false)
return false;
if (other.getLogStreamName() == null ^ this.getLogStreamName() == null)
return false;
if (other.getLogStreamName() != null && other.getLogStreamName().equals(this.getLogStreamName()) == false)
return false;
if (other.getStartTime() == null ^ this.getStartTime() == null)
return false;
if (other.getStartTime() != null && other.getStartTime().equals(this.getStartTime()) == false)
return false;
if (other.getEndTime() == null ^ this.getEndTime() == null)
return false;
if (other.getEndTime() != null && other.getEndTime().equals(this.getEndTime()) == false)
return false;
if (other.getNextToken() == null ^ this.getNextToken() == null)
return false;
if (other.getNextToken() != null && other.getNextToken().equals(this.getNextToken()) == false)
return false;
if (other.getLimit() == null ^ this.getLimit() == null)
return false;
if (other.getLimit() != null && other.getLimit().equals(this.getLimit()) == false)
return false;
if (other.getStartFromHead() == null ^ this.getStartFromHead() == null)
return false;
if (other.getStartFromHead() != null && other.getStartFromHead().equals(this.getStartFromHead()) == false)
return false;
if (other.getUnmask() == null ^ this.getUnmask() == null)
return false;
if (other.getUnmask() != null && other.getUnmask().equals(this.getUnmask()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getLogGroupName() == null) ? 0 : getLogGroupName().hashCode());
hashCode = prime * hashCode + ((getLogGroupIdentifier() == null) ? 0 : getLogGroupIdentifier().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 + ((getStartFromHead() == null) ? 0 : getStartFromHead().hashCode());
hashCode = prime * hashCode + ((getUnmask() == null) ? 0 : getUnmask().hashCode());
return hashCode;
}
@Override
public GetLogEventsRequest clone() {
return (GetLogEventsRequest) super.clone();
}
}