com.amazonaws.services.logs.model

Class FilterLogEventsRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.logs.model.FilterLogEventsRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class FilterLogEventsRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
FilterLogEventsRequest()

Method Summary

Modifier and Type	Method and Description
FilterLogEventsRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
Long	getEndTime() The end of the time range, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC.
String	getFilterPattern() The filter pattern to use.
Boolean	getInterleaved() Deprecated.
Integer	getLimit() The maximum number of events to return.
String	getLogGroupIdentifier() Specify either the name or ARN of the log group to view log events from.
String	getLogGroupName() The name of the log group to search.
String	getLogStreamNamePrefix() Filters the results to include only events from log streams that have names starting with this prefix.
List<String>	getLogStreamNames() Filters the results to only logs from the log streams in this list.
String	getNextToken() The token for the next set of events to return.
Long	getStartTime() The start of the time range, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC.
Boolean	getUnmask() Specify true to display the log event fields with all sensitive data unmasked and visible.
int	hashCode()
Boolean	isInterleaved() Deprecated.
Boolean	isUnmask() Specify true to display the log event fields with all sensitive data unmasked and visible.
void	setEndTime(Long endTime) The end of the time range, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC.
void	setFilterPattern(String filterPattern) The filter pattern to use.
void	setInterleaved(Boolean interleaved) Deprecated.
void	setLimit(Integer limit) The maximum number of events to return.
void	setLogGroupIdentifier(String logGroupIdentifier) Specify either the name or ARN of the log group to view log events from.
void	setLogGroupName(String logGroupName) The name of the log group to search.
void	setLogStreamNamePrefix(String logStreamNamePrefix) Filters the results to include only events from log streams that have names starting with this prefix.
void	setLogStreamNames(Collection<String> logStreamNames) Filters the results to only logs from the log streams in this list.
void	setNextToken(String nextToken) The token for the next set of events to return.
void	setStartTime(Long startTime) The start of the time range, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC.
void	setUnmask(Boolean unmask) Specify true to display the log event fields with all sensitive data unmasked and visible.
String	toString() Returns a string representation of this object.
FilterLogEventsRequest	withEndTime(Long endTime) The end of the time range, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC.
FilterLogEventsRequest	withFilterPattern(String filterPattern) The filter pattern to use.
FilterLogEventsRequest	withInterleaved(Boolean interleaved) Deprecated.
FilterLogEventsRequest	withLimit(Integer limit) The maximum number of events to return.
FilterLogEventsRequest	withLogGroupIdentifier(String logGroupIdentifier) Specify either the name or ARN of the log group to view log events from.
FilterLogEventsRequest	withLogGroupName(String logGroupName) The name of the log group to search.
FilterLogEventsRequest	withLogStreamNamePrefix(String logStreamNamePrefix) Filters the results to include only events from log streams that have names starting with this prefix.
FilterLogEventsRequest	withLogStreamNames(Collection<String> logStreamNames) Filters the results to only logs from the log streams in this list.
FilterLogEventsRequest	withLogStreamNames(String... logStreamNames) Filters the results to only logs from the log streams in this list.
FilterLogEventsRequest	withNextToken(String nextToken) The token for the next set of events to return.
FilterLogEventsRequest	withStartTime(Long startTime) The start of the time range, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC.
FilterLogEventsRequest	withUnmask(Boolean unmask) Specify true to display the log event fields with all sensitive data unmasked and visible.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

FilterLogEventsRequest

public FilterLogEventsRequest()

Method Detail

setLogGroupName

public void setLogGroupName(String logGroupName)

The name of the log group to search.

You must include either logGroupIdentifier or logGroupName, but not both.

Parameters:

logGroupName - The name of the log group to search.

You must include either logGroupIdentifier or logGroupName, but not both.

getLogGroupName

public String getLogGroupName()

The name of the log group to search.

You must include either logGroupIdentifier or logGroupName, but not both.

Returns:

The name of the log group to search.

You must include either logGroupIdentifier or logGroupName, but not both.

withLogGroupName

public FilterLogEventsRequest withLogGroupName(String logGroupName)

The name of the log group to search.

You must include either logGroupIdentifier or logGroupName, but not both.

Parameters:

logGroupName - The name of the log group to search.

You must include either logGroupIdentifier or logGroupName, but not both.

Returns:

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

setLogGroupIdentifier

public void setLogGroupIdentifier(String logGroupIdentifier)

Specify either the name or ARN of the log group to view log 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.

Parameters:

logGroupIdentifier - Specify either the name or ARN of the log group to view log 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.

getLogGroupIdentifier

public String getLogGroupIdentifier()

Specify either the name or ARN of the log group to view log 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.

Returns:

Specify either the name or ARN of the log group to view log 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.

withLogGroupIdentifier

public FilterLogEventsRequest withLogGroupIdentifier(String logGroupIdentifier)

Specify either the name or ARN of the log group to view log 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.

Parameters:

logGroupIdentifier - Specify either the name or ARN of the log group to view log 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.

Returns:

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

getLogStreamNames

public List<String> getLogStreamNames()

Filters the results to only logs from the log streams in this list.

If you specify a value for both logStreamNamePrefix and logStreamNames, the action returns an InvalidParameterException error.

Returns:

Filters the results to only logs from the log streams in this list.

If you specify a value for both logStreamNamePrefix and logStreamNames, the action returns an InvalidParameterException error.

setLogStreamNames

public void setLogStreamNames(Collection<String> logStreamNames)

Filters the results to only logs from the log streams in this list.

If you specify a value for both logStreamNamePrefix and logStreamNames, the action returns an InvalidParameterException error.

Parameters:

logStreamNames - Filters the results to only logs from the log streams in this list.

If you specify a value for both logStreamNamePrefix and logStreamNames, the action returns an InvalidParameterException error.

withLogStreamNames

public FilterLogEventsRequest withLogStreamNames(String... logStreamNames)

Filters the results to only logs from the log streams in this list.

If you specify a value for both logStreamNamePrefix and logStreamNames, the action returns an InvalidParameterException error.

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 - Filters the results to only logs from the log streams in this list.

If you specify a value for both logStreamNamePrefix and logStreamNames, the action returns an InvalidParameterException error.

Returns:

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

withLogStreamNames

public FilterLogEventsRequest withLogStreamNames(Collection<String> logStreamNames)

Filters the results to only logs from the log streams in this list.

If you specify a value for both logStreamNamePrefix and logStreamNames, the action returns an InvalidParameterException error.

Parameters:

logStreamNames - Filters the results to only logs from the log streams in this list.

If you specify a value for both logStreamNamePrefix and logStreamNames, the action returns an InvalidParameterException error.

Returns:

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

setLogStreamNamePrefix

public void setLogStreamNamePrefix(String logStreamNamePrefix)

Filters the results to include only events from log streams that have names starting with this prefix.

If you specify a value for both logStreamNamePrefix and logStreamNames, but the value for logStreamNamePrefix does not match any log stream names specified in logStreamNames , the action returns an InvalidParameterException error.

Parameters:

logStreamNamePrefix - Filters the results to include only events from log streams that have names starting with this prefix.

If you specify a value for both logStreamNamePrefix and logStreamNames, but the value for logStreamNamePrefix does not match any log stream names specified in logStreamNames, the action returns an InvalidParameterException error.

getLogStreamNamePrefix

public String getLogStreamNamePrefix()

Filters the results to include only events from log streams that have names starting with this prefix.

If you specify a value for both logStreamNamePrefix and logStreamNames, but the value for logStreamNamePrefix does not match any log stream names specified in logStreamNames , the action returns an InvalidParameterException error.

Returns:

Filters the results to include only events from log streams that have names starting with this prefix.

If you specify a value for both logStreamNamePrefix and logStreamNames, but the value for logStreamNamePrefix does not match any log stream names specified in logStreamNames, the action returns an InvalidParameterException error.

withLogStreamNamePrefix

public FilterLogEventsRequest withLogStreamNamePrefix(String logStreamNamePrefix)

Filters the results to include only events from log streams that have names starting with this prefix.

If you specify a value for both logStreamNamePrefix and logStreamNames, but the value for logStreamNamePrefix does not match any log stream names specified in logStreamNames , the action returns an InvalidParameterException error.

Parameters:

logStreamNamePrefix - Filters the results to include only events from log streams that have names starting with this prefix.

If you specify a value for both logStreamNamePrefix and logStreamNames, but the value for logStreamNamePrefix does not match any log stream names specified in logStreamNames, the action returns an InvalidParameterException error.

Returns:

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

setStartTime

public void setStartTime(Long 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 before this time are not returned.

Parameters:

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 before this time are not returned.

getStartTime

public Long getStartTime()

The start of the time range, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC. Events with a timestamp before this time are not returned.

Returns:

The start of the time range, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC. Events with a timestamp before this time are not returned.

withStartTime

public FilterLogEventsRequest withStartTime(Long 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 before this time are not returned.

Parameters:

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 before 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)

The end of the time range, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC. Events with a timestamp later than this time are not returned.

Parameters:

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 later than this time are not returned.

getEndTime

public Long getEndTime()

The end of the time range, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC. Events with a timestamp later than this time are not returned.

Returns:

The end of the time range, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC. Events with a timestamp later than this time are not returned.

withEndTime

public FilterLogEventsRequest withEndTime(Long 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 later than this time are not returned.

Parameters:

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 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)

The filter pattern to use. For more information, see Filter and Pattern Syntax.

If not provided, all the events are matched.

Parameters:

filterPattern - The filter pattern to use. For more information, see Filter and Pattern Syntax.

If not provided, all the events are matched.

getFilterPattern

public String getFilterPattern()

The filter pattern to use. For more information, see Filter and Pattern Syntax.

If not provided, all the events are matched.

Returns:

The filter pattern to use. For more information, see Filter and Pattern Syntax.

If not provided, all the events are matched.

withFilterPattern

public FilterLogEventsRequest withFilterPattern(String filterPattern)

The filter pattern to use. For more information, see Filter and Pattern Syntax.

If not provided, all the events are matched.

Parameters:

filterPattern - The filter pattern to use. For more information, see Filter and Pattern Syntax.

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)

The token for the next set of events to return. (You received this token from a previous call.)

Parameters:

nextToken - The token for the next set of events to return. (You received this token from a previous call.)

getNextToken

public String getNextToken()

The token for the next set of events to return. (You received this token from a previous call.)

Returns:

The token for the next set of events to return. (You received this token from a previous call.)

withNextToken

public FilterLogEventsRequest withNextToken(String nextToken)

The token for the next set of events to return. (You received this token from a previous call.)

Parameters:

nextToken - The token for the next set of events to return. (You received this token from a previous call.)

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. The default is 10,000 events.

Parameters:

limit - The maximum number of events to return. The default is 10,000 events.

getLimit

public Integer getLimit()

The maximum number of events to return. The default is 10,000 events.

Returns:

The maximum number of events to return. The default is 10,000 events.

withLimit

public FilterLogEventsRequest withLimit(Integer limit)

The maximum number of events to return. The default is 10,000 events.

Parameters:

limit - The maximum number of events to return. The default is 10,000 events.

Returns:

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

setInterleaved

@Deprecated
public void setInterleaved(Boolean interleaved)

Deprecated.

If the value is true, the operation attempts to provide responses that contain events from multiple log streams within the log group, interleaved in a single response. If the value is false, all the matched log events in the first log stream are searched first, then those in the next log stream, and so on.

Important As of June 17, 2019, this parameter is ignored and the value is assumed to be true. The response from this operation always interleaves events from multiple log streams within a log group.

Parameters:

interleaved - If the value is true, the operation attempts to provide responses that contain events from multiple log streams within the log group, interleaved in a single response. If the value is false, all the matched log events in the first log stream are searched first, then those in the next log stream, and so on.

Important As of June 17, 2019, this parameter is ignored and the value is assumed to be true. The response from this operation always interleaves events from multiple log streams within a log group.

getInterleaved

@Deprecated
public Boolean getInterleaved()

Deprecated.

If the value is true, the operation attempts to provide responses that contain events from multiple log streams within the log group, interleaved in a single response. If the value is false, all the matched log events in the first log stream are searched first, then those in the next log stream, and so on.

Important As of June 17, 2019, this parameter is ignored and the value is assumed to be true. The response from this operation always interleaves events from multiple log streams within a log group.

Returns:

If the value is true, the operation attempts to provide responses that contain events from multiple log streams within the log group, interleaved in a single response. If the value is false, all the matched log events in the first log stream are searched first, then those in the next log stream, and so on.

Important As of June 17, 2019, this parameter is ignored and the value is assumed to be true. The response from this operation always interleaves events from multiple log streams within a log group.

withInterleaved

@Deprecated
public FilterLogEventsRequest withInterleaved(Boolean interleaved)

Deprecated.

If the value is true, the operation attempts to provide responses that contain events from multiple log streams within the log group, interleaved in a single response. If the value is false, all the matched log events in the first log stream are searched first, then those in the next log stream, and so on.

Important As of June 17, 2019, this parameter is ignored and the value is assumed to be true. The response from this operation always interleaves events from multiple log streams within a log group.

Parameters:

interleaved - If the value is true, the operation attempts to provide responses that contain events from multiple log streams within the log group, interleaved in a single response. If the value is false, all the matched log events in the first log stream are searched first, then those in the next log stream, and so on.

Important As of June 17, 2019, this parameter is ignored and the value is assumed to be true. The response from this operation always interleaves events from multiple log streams within a log group.

Returns:

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

isInterleaved

@Deprecated
public Boolean isInterleaved()

Deprecated.

If the value is true, the operation attempts to provide responses that contain events from multiple log streams within the log group, interleaved in a single response. If the value is false, all the matched log events in the first log stream are searched first, then those in the next log stream, and so on.

Important As of June 17, 2019, this parameter is ignored and the value is assumed to be true. The response from this operation always interleaves events from multiple log streams within a log group.

Returns:

If the value is true, the operation attempts to provide responses that contain events from multiple log streams within the log group, interleaved in a single response. If the value is false, all the matched log events in the first log stream are searched first, then those in the next log stream, and so on.

Important As of June 17, 2019, this parameter is ignored and the value is assumed to be true. The response from this operation always interleaves events from multiple log streams within a log group.

setUnmask

public void setUnmask(Boolean 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.

Parameters:

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.

getUnmask

public Boolean getUnmask()

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.

Returns:

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.

withUnmask

public FilterLogEventsRequest withUnmask(Boolean 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.

Parameters:

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.

Returns:

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

isUnmask

public Boolean isUnmask()

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.

Returns:

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.

toString

public String toString()

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.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

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 object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()