com.amazonaws.services.logs.model

Class DescribeLogStreamsRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.logs.model.DescribeLogStreamsRequest

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class DescribeLogStreamsRequest
extends AmazonWebServiceRequest
implements java.io.Serializable

Lists the log streams for the specified log group. You can list all the log streams or filter the results by prefix. You can also control how the results are ordered.

This operation has a limit of five transactions per second, after which transactions are throttled.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
DescribeLogStreamsRequest() Default constructor for DescribeLogStreamsRequest object.
DescribeLogStreamsRequest(java.lang.String logGroupName) Constructs a new DescribeLogStreamsRequest object.

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
java.lang.Boolean	getDescending() If the value is true, results are returned in descending order.
java.lang.Integer	getLimit() The maximum number of items returned.
java.lang.String	getLogGroupName() The name of the log group.
java.lang.String	getLogStreamNamePrefix() The prefix to match.
java.lang.String	getNextToken() The token for the next set of items to return.
java.lang.String	getOrderBy() If the value is LogStreamName, the results are ordered by log stream name.
int	hashCode()
java.lang.Boolean	isDescending() If the value is true, results are returned in descending order.
void	setDescending(java.lang.Boolean descending) If the value is true, results are returned in descending order.
void	setLimit(java.lang.Integer limit) The maximum number of items returned.
void	setLogGroupName(java.lang.String logGroupName) The name of the log group.
void	setLogStreamNamePrefix(java.lang.String logStreamNamePrefix) The prefix to match.
void	setNextToken(java.lang.String nextToken) The token for the next set of items to return.
void	setOrderBy(OrderBy orderBy) If the value is LogStreamName, the results are ordered by log stream name.
void	setOrderBy(java.lang.String orderBy) If the value is LogStreamName, the results are ordered by log stream name.
java.lang.String	toString() Returns a string representation of this object; useful for testing and debugging.
DescribeLogStreamsRequest	withDescending(java.lang.Boolean descending) If the value is true, results are returned in descending order.
DescribeLogStreamsRequest	withLimit(java.lang.Integer limit) The maximum number of items returned.
DescribeLogStreamsRequest	withLogGroupName(java.lang.String logGroupName) The name of the log group.
DescribeLogStreamsRequest	withLogStreamNamePrefix(java.lang.String logStreamNamePrefix) The prefix to match.
DescribeLogStreamsRequest	withNextToken(java.lang.String nextToken) The token for the next set of items to return.
DescribeLogStreamsRequest	withOrderBy(OrderBy orderBy) If the value is LogStreamName, the results are ordered by log stream name.
DescribeLogStreamsRequest	withOrderBy(java.lang.String orderBy) If the value is LogStreamName, the results are ordered by log stream name.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

clone, getCloneRoot, getCloneSource, getGeneralProgressListener, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

DescribeLogStreamsRequest

public DescribeLogStreamsRequest()

Default constructor for DescribeLogStreamsRequest object. Callers should use the setter or fluent setter (with...) methods to initialize any additional object members.

DescribeLogStreamsRequest

public DescribeLogStreamsRequest(java.lang.String logGroupName)

Constructs a new DescribeLogStreamsRequest 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.

Method Detail

getLogGroupName

public java.lang.String getLogGroupName()

The name of the log group.

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

Returns:

The name of the log group.

setLogGroupName

public void setLogGroupName(java.lang.String logGroupName)

The name of the log group.

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

Parameters:

logGroupName -

The name of the log group.

withLogGroupName

public DescribeLogStreamsRequest withLogGroupName(java.lang.String logGroupName)

The name of the log group.

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 name of the log group.

Returns:

A reference to this updated object so that method calls can be chained together.

getLogStreamNamePrefix

public java.lang.String getLogStreamNamePrefix()

The prefix to match.

If orderBy is LastEventTime,you cannot specify this parameter.

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

Returns:

The prefix to match.

If orderBy is LastEventTime,you cannot specify this parameter.

setLogStreamNamePrefix

public void setLogStreamNamePrefix(java.lang.String logStreamNamePrefix)

The prefix to match.

If orderBy is LastEventTime,you cannot specify this parameter.

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

Parameters:

logStreamNamePrefix -

The prefix to match.

If orderBy is LastEventTime,you cannot specify this parameter.

withLogStreamNamePrefix

public DescribeLogStreamsRequest withLogStreamNamePrefix(java.lang.String logStreamNamePrefix)

The prefix to match.

If orderBy is LastEventTime,you cannot specify this parameter.

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

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

Parameters:

logStreamNamePrefix -

The prefix to match.

If orderBy is LastEventTime,you cannot specify this parameter.

Returns:

A reference to this updated object so that method calls can be chained together.

getOrderBy

public java.lang.String getOrderBy()

If the value is LogStreamName, the results are ordered by log stream name. If the value is LastEventTime, the results are ordered by the event time. The default value is LogStreamName.

If you order the results by event time, you cannot specify the logStreamNamePrefix parameter.

lastEventTimestamp represents the time of the most recent log event in the log stream in CloudWatch Logs. This number is expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC. lastEventTimeStamp updates on an eventual consistency basis. It typically updates in less than an hour from ingestion, but may take longer in some rare situations.

Constraints:
Allowed Values: LogStreamName, LastEventTime

Returns:

If the value is LogStreamName, the results are ordered by log stream name. If the value is LastEventTime, the results are ordered by the event time. The default value is LogStreamName.

If you order the results by event time, you cannot specify the logStreamNamePrefix parameter.

lastEventTimestamp represents the time of the most recent log event in the log stream in CloudWatch Logs. This number is expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC. lastEventTimeStamp updates on an eventual consistency basis. It typically updates in less than an hour from ingestion, but may take longer in some rare situations.

See Also:

OrderBy

setOrderBy

public void setOrderBy(java.lang.String orderBy)

If the value is LogStreamName, the results are ordered by log stream name. If the value is LastEventTime, the results are ordered by the event time. The default value is LogStreamName.

If you order the results by event time, you cannot specify the logStreamNamePrefix parameter.

lastEventTimestamp represents the time of the most recent log event in the log stream in CloudWatch Logs. This number is expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC. lastEventTimeStamp updates on an eventual consistency basis. It typically updates in less than an hour from ingestion, but may take longer in some rare situations.

Constraints:
Allowed Values: LogStreamName, LastEventTime

Parameters:

orderBy -

If the value is LogStreamName, the results are ordered by log stream name. If the value is LastEventTime, the results are ordered by the event time. The default value is LogStreamName.

If you order the results by event time, you cannot specify the logStreamNamePrefix parameter.

lastEventTimestamp represents the time of the most recent log event in the log stream in CloudWatch Logs. This number is expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC. lastEventTimeStamp updates on an eventual consistency basis. It typically updates in less than an hour from ingestion, but may take longer in some rare situations.

See Also:

OrderBy

withOrderBy

public DescribeLogStreamsRequest withOrderBy(java.lang.String orderBy)

If the value is LogStreamName, the results are ordered by log stream name. If the value is LastEventTime, the results are ordered by the event time. The default value is LogStreamName.

If you order the results by event time, you cannot specify the logStreamNamePrefix parameter.

lastEventTimestamp represents the time of the most recent log event in the log stream in CloudWatch Logs. This number is expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC. lastEventTimeStamp updates on an eventual consistency basis. It typically updates in less than an hour from ingestion, but may take longer in some rare situations.

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

Constraints:
Allowed Values: LogStreamName, LastEventTime

Parameters:

orderBy -

If the value is LogStreamName, the results are ordered by log stream name. If the value is LastEventTime, the results are ordered by the event time. The default value is LogStreamName.

If you order the results by event time, you cannot specify the logStreamNamePrefix parameter.

lastEventTimestamp represents the time of the most recent log event in the log stream in CloudWatch Logs. This number is expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC. lastEventTimeStamp updates on an eventual consistency basis. It typically updates in less than an hour from ingestion, but may take longer in some rare situations.

Returns:

A reference to this updated object so that method calls can be chained together.

See Also:

OrderBy

setOrderBy

public void setOrderBy(OrderBy orderBy)

If the value is LogStreamName, the results are ordered by log stream name. If the value is LastEventTime, the results are ordered by the event time. The default value is LogStreamName.

If you order the results by event time, you cannot specify the logStreamNamePrefix parameter.

lastEventTimestamp represents the time of the most recent log event in the log stream in CloudWatch Logs. This number is expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC. lastEventTimeStamp updates on an eventual consistency basis. It typically updates in less than an hour from ingestion, but may take longer in some rare situations.

Constraints:
Allowed Values: LogStreamName, LastEventTime

Parameters:

orderBy -

If the value is LogStreamName, the results are ordered by log stream name. If the value is LastEventTime, the results are ordered by the event time. The default value is LogStreamName.

If you order the results by event time, you cannot specify the logStreamNamePrefix parameter.

lastEventTimestamp represents the time of the most recent log event in the log stream in CloudWatch Logs. This number is expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC. lastEventTimeStamp updates on an eventual consistency basis. It typically updates in less than an hour from ingestion, but may take longer in some rare situations.

See Also:

OrderBy

withOrderBy

public DescribeLogStreamsRequest withOrderBy(OrderBy orderBy)

If the value is LogStreamName, the results are ordered by log stream name. If the value is LastEventTime, the results are ordered by the event time. The default value is LogStreamName.

If you order the results by event time, you cannot specify the logStreamNamePrefix parameter.

lastEventTimestamp represents the time of the most recent log event in the log stream in CloudWatch Logs. This number is expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC. lastEventTimeStamp updates on an eventual consistency basis. It typically updates in less than an hour from ingestion, but may take longer in some rare situations.

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

Constraints:
Allowed Values: LogStreamName, LastEventTime

Parameters:

orderBy -

If the value is LogStreamName, the results are ordered by log stream name. If the value is LastEventTime, the results are ordered by the event time. The default value is LogStreamName.

If you order the results by event time, you cannot specify the logStreamNamePrefix parameter.

lastEventTimestamp represents the time of the most recent log event in the log stream in CloudWatch Logs. This number is expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC. lastEventTimeStamp updates on an eventual consistency basis. It typically updates in less than an hour from ingestion, but may take longer in some rare situations.

Returns:

A reference to this updated object so that method calls can be chained together.

See Also:

OrderBy

isDescending

public java.lang.Boolean isDescending()

If the value is true, results are returned in descending order. If the value is to false, results are returned in ascending order. The default value is false.

Returns:

If the value is true, results are returned in descending order. If the value is to false, results are returned in ascending order. The default value is false.

getDescending

public java.lang.Boolean getDescending()

If the value is true, results are returned in descending order. If the value is to false, results are returned in ascending order. The default value is false.

Returns:

If the value is true, results are returned in descending order. If the value is to false, results are returned in ascending order. The default value is false.

setDescending

public void setDescending(java.lang.Boolean descending)

If the value is true, results are returned in descending order. If the value is to false, results are returned in ascending order. The default value is false.

Parameters:

descending -

If the value is true, results are returned in descending order. If the value is to false, results are returned in ascending order. The default value is false.

withDescending

public DescribeLogStreamsRequest withDescending(java.lang.Boolean descending)

If the value is true, results are returned in descending order. If the value is to false, results are returned in ascending order. The default value is false.

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

Parameters:

descending -

If the value is true, results are returned in descending order. If the value is to false, results are returned in ascending order. The default value is false.

Returns:

A reference to this updated object so that method calls can be chained together.

getNextToken

public java.lang.String getNextToken()

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

Constraints:
Length: 1 -

Returns:

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

setNextToken

public void setNextToken(java.lang.String nextToken)

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

Constraints:
Length: 1 -

Parameters:

nextToken -

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

withNextToken

public DescribeLogStreamsRequest withNextToken(java.lang.String nextToken)

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

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

Constraints:
Length: 1 -

Parameters:

nextToken -

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

Returns:

A reference to this updated object so that method calls can be chained together.

getLimit

public java.lang.Integer getLimit()

The maximum number of items returned. If you don't specify a value, the default is up to 50 items.

Constraints:
Range: 1 - 50

Returns:

The maximum number of items returned. If you don't specify a value, the default is up to 50 items.

setLimit

public void setLimit(java.lang.Integer limit)

The maximum number of items returned. If you don't specify a value, the default is up to 50 items.

Constraints:
Range: 1 - 50

Parameters:

limit -

The maximum number of items returned. If you don't specify a value, the default is up to 50 items.

withLimit

public DescribeLogStreamsRequest withLimit(java.lang.Integer limit)

The maximum number of items returned. If you don't specify a value, the default is up to 50 items.

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

Constraints:
Range: 1 - 50

Parameters:

limit -

The maximum number of items returned. If you don't specify a value, the default is up to 50 items.

Returns:

A reference to this updated object so that method calls can be chained together.

toString

public java.lang.String toString()

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

Overrides:

toString in class java.lang.Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object