com.amazonaws.services.logs.model

Class DescribeLogStreamsRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.logs.model.DescribeLogStreamsRequest

All Implemented Interfaces:

ReadLimitInfo, Serializable, Cloneable

public class DescribeLogStreamsRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

Container for the parameters to the DescribeLogStreams operation.

Returns all the log streams that are associated with the specified log group. The list returned in the response is ASCII-sorted by log stream name.

By default, this operation returns up to 50 log streams. If there are more log streams to list, the response would contain a nextToken value in the response body. You can also limit the number of log streams returned in the response by specifying the limit parameter in the request. This operation has a limit of five transactions per second, after which transactions are throttled.

See Also:

AWSLogs.describeLogStreams(DescribeLogStreamsRequest), Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
DescribeLogStreamsRequest	clone()
boolean	equals(Object obj)
Boolean	getDescending() If set to true, results are returned in descending order.
Integer	getLimit() The maximum number of items returned in the response.
String	getLogGroupName() Returns the value of the LogGroupName property for this object.
String	getLogStreamNamePrefix() Will only return log streams that match the provided logStreamNamePrefix.
String	getNextToken() A string token used for pagination that points to the next page of results.
String	getOrderBy() Specifies what to order the returned log streams by.
int	hashCode()
Boolean	isDescending() If set to true, results are returned in descending order.
void	setDescending(Boolean descending) If set to true, results are returned in descending order.
void	setLimit(Integer limit) The maximum number of items returned in the response.
void	setLogGroupName(String logGroupName) Sets the value of the LogGroupName property for this object.
void	setLogStreamNamePrefix(String logStreamNamePrefix) Will only return log streams that match the provided logStreamNamePrefix.
void	setNextToken(String nextToken) A string token used for pagination that points to the next page of results.
void	setOrderBy(OrderBy orderBy) Specifies what to order the returned log streams by.
void	setOrderBy(String orderBy) Specifies what to order the returned log streams by.
String	toString() Returns a string representation of this object; useful for testing and debugging.
DescribeLogStreamsRequest	withDescending(Boolean descending) If set to true, results are returned in descending order.
DescribeLogStreamsRequest	withLimit(Integer limit) The maximum number of items returned in the response.
DescribeLogStreamsRequest	withLogGroupName(String logGroupName) Sets the value of the LogGroupName property for this object.
DescribeLogStreamsRequest	withLogStreamNamePrefix(String logStreamNamePrefix) Will only return log streams that match the provided logStreamNamePrefix.
DescribeLogStreamsRequest	withNextToken(String nextToken) A string token used for pagination that points to the next page of results.
DescribeLogStreamsRequest	withOrderBy(OrderBy orderBy) Specifies what to order the returned log streams by.
DescribeLogStreamsRequest	withOrderBy(String orderBy) Specifies what to order the returned log streams by.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

copyBaseTo, copyPrivateRequestParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

DescribeLogStreamsRequest

public DescribeLogStreamsRequest()

Default constructor for a new DescribeLogStreamsRequest object. Callers should use the setter or fluent setter (with...) methods to initialize this object after creating it.

DescribeLogStreamsRequest

public DescribeLogStreamsRequest(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 -

Method Detail

getLogGroupName

public String getLogGroupName()

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.

setLogGroupName

public void setLogGroupName(String logGroupName)

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.

withLogGroupName

public DescribeLogStreamsRequest withLogGroupName(String 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.

getLogStreamNamePrefix

public String getLogStreamNamePrefix()

Will only return log streams that match the provided logStreamNamePrefix. If you don't specify a value, no prefix filter is applied.

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

Returns:

Will only return log streams that match the provided logStreamNamePrefix. If you don't specify a value, no prefix filter is applied.

setLogStreamNamePrefix

public void setLogStreamNamePrefix(String logStreamNamePrefix)

Will only return log streams that match the provided logStreamNamePrefix. If you don't specify a value, no prefix filter is applied.

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

Parameters:

logStreamNamePrefix - Will only return log streams that match the provided logStreamNamePrefix. If you don't specify a value, no prefix filter is applied.

withLogStreamNamePrefix

public DescribeLogStreamsRequest withLogStreamNamePrefix(String logStreamNamePrefix)

Will only return log streams that match the provided logStreamNamePrefix. If you don't specify a value, no prefix filter is applied.

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

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

Parameters:

logStreamNamePrefix - Will only return log streams that match the provided logStreamNamePrefix. If you don't specify a value, no prefix filter is applied.

Returns:

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

getOrderBy

public String getOrderBy()

Specifies what to order the returned log streams by. Valid arguments are 'LogStreamName' or 'LastEventTime'. If you don't specify a value, results are ordered by LogStreamName. If 'LastEventTime' is chosen, the request cannot also contain a logStreamNamePrefix.

Constraints:
Allowed Values: LogStreamName, LastEventTime

Returns:

Specifies what to order the returned log streams by. Valid arguments are 'LogStreamName' or 'LastEventTime'. If you don't specify a value, results are ordered by LogStreamName. If 'LastEventTime' is chosen, the request cannot also contain a logStreamNamePrefix.

See Also:

OrderBy

setOrderBy

public void setOrderBy(String orderBy)

Specifies what to order the returned log streams by. Valid arguments are 'LogStreamName' or 'LastEventTime'. If you don't specify a value, results are ordered by LogStreamName. If 'LastEventTime' is chosen, the request cannot also contain a logStreamNamePrefix.

Constraints:
Allowed Values: LogStreamName, LastEventTime

Parameters:

orderBy - Specifies what to order the returned log streams by. Valid arguments are 'LogStreamName' or 'LastEventTime'. If you don't specify a value, results are ordered by LogStreamName. If 'LastEventTime' is chosen, the request cannot also contain a logStreamNamePrefix.

See Also:

OrderBy

withOrderBy

public DescribeLogStreamsRequest withOrderBy(String orderBy)

Specifies what to order the returned log streams by. Valid arguments are 'LogStreamName' or 'LastEventTime'. If you don't specify a value, results are ordered by LogStreamName. If 'LastEventTime' is chosen, the request cannot also contain a logStreamNamePrefix.

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

Constraints:
Allowed Values: LogStreamName, LastEventTime

Parameters:

orderBy - Specifies what to order the returned log streams by. Valid arguments are 'LogStreamName' or 'LastEventTime'. If you don't specify a value, results are ordered by LogStreamName. If 'LastEventTime' is chosen, the request cannot also contain a logStreamNamePrefix.

Returns:

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

See Also:

OrderBy

setOrderBy

public void setOrderBy(OrderBy orderBy)

Specifies what to order the returned log streams by. Valid arguments are 'LogStreamName' or 'LastEventTime'. If you don't specify a value, results are ordered by LogStreamName. If 'LastEventTime' is chosen, the request cannot also contain a logStreamNamePrefix.

Constraints:
Allowed Values: LogStreamName, LastEventTime

Parameters:

orderBy - Specifies what to order the returned log streams by. Valid arguments are 'LogStreamName' or 'LastEventTime'. If you don't specify a value, results are ordered by LogStreamName. If 'LastEventTime' is chosen, the request cannot also contain a logStreamNamePrefix.

See Also:

OrderBy

withOrderBy

public DescribeLogStreamsRequest withOrderBy(OrderBy orderBy)

Specifies what to order the returned log streams by. Valid arguments are 'LogStreamName' or 'LastEventTime'. If you don't specify a value, results are ordered by LogStreamName. If 'LastEventTime' is chosen, the request cannot also contain a logStreamNamePrefix.

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

Constraints:
Allowed Values: LogStreamName, LastEventTime

Parameters:

orderBy - Specifies what to order the returned log streams by. Valid arguments are 'LogStreamName' or 'LastEventTime'. If you don't specify a value, results are ordered by LogStreamName. If 'LastEventTime' is chosen, the request cannot also contain a logStreamNamePrefix.

Returns:

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

See Also:

OrderBy

isDescending

public Boolean isDescending()

If set to true, results are returned in descending order. If you don't specify a value or set it to false, results are returned in ascending order.

Returns:

If set to true, results are returned in descending order. If you don't specify a value or set it to false, results are returned in ascending order.

setDescending

public void setDescending(Boolean descending)

If set to true, results are returned in descending order. If you don't specify a value or set it to false, results are returned in ascending order.

Parameters:

descending - If set to true, results are returned in descending order. If you don't specify a value or set it to false, results are returned in ascending order.

withDescending

public DescribeLogStreamsRequest withDescending(Boolean descending)

If set to true, results are returned in descending order. If you don't specify a value or set it to false, results are returned in ascending order.

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

Parameters:

descending - If set to true, results are returned in descending order. If you don't specify a value or set it to false, results are returned in ascending order.

Returns:

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

getDescending

public Boolean getDescending()

If set to true, results are returned in descending order. If you don't specify a value or set it to false, results are returned in ascending order.

Returns:

If set to true, results are returned in descending order. If you don't specify a value or set it to false, results are returned in ascending order.

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 response of the previous DescribeLogStreams 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 response of the previous DescribeLogStreams request.

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 response of the previous DescribeLogStreams 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 response of the previous DescribeLogStreams request.

withNextToken

public DescribeLogStreamsRequest 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 response of the previous DescribeLogStreams 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 response of the previous DescribeLogStreams request.

Returns:

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

getLimit

public Integer getLimit()

The maximum number of items returned in the response. If you don't specify a value, the request would return up to 50 items.

Constraints:
Range: 1 - 50

Returns:

The maximum number of items returned in the response. If you don't specify a value, the request would return up to 50 items.

setLimit

public void setLimit(Integer limit)

The maximum number of items returned in the response. If you don't specify a value, the request would return up to 50 items.

Constraints:
Range: 1 - 50

Parameters:

limit - The maximum number of items returned in the response. If you don't specify a value, the request would return up to 50 items.

withLimit

public DescribeLogStreamsRequest withLimit(Integer limit)

The maximum number of items returned in the response. If you don't specify a value, the request would return 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 in the response. If you don't specify a value, the request would return up to 50 items.

Returns:

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

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:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

clone

public DescribeLogStreamsRequest clone()

Overrides:

clone in class AmazonWebServiceRequest