public class DescribeLogStreamsRequest extends AmazonWebServiceRequest implements java.io.Serializable, java.lang.Cloneable
Modifier and Type | Field and Description |
---|---|
private java.lang.Boolean |
descending
If set to true, results are returned in descending order.
|
private java.lang.Integer |
limit
The maximum number of items returned in the response.
|
private java.lang.String |
logGroupName
The log group name for which log streams are to be listed.
|
private java.lang.String |
logStreamNamePrefix
Will only return log streams that match the provided logStreamNamePrefix.
|
private java.lang.String |
nextToken
A string token used for pagination that points to the next page of
results.
|
private java.lang.String |
orderBy
Specifies what to order the returned log streams by.
|
NOOP
Constructor and Description |
---|
DescribeLogStreamsRequest()
Default constructor for DescribeLogStreamsRequest object.
|
DescribeLogStreamsRequest(java.lang.String logGroupName)
Constructs a new DescribeLogStreamsRequest object.
|
Modifier and Type | Method and Description |
---|---|
DescribeLogStreamsRequest |
clone()
Creates a shallow clone of this request.
|
boolean |
equals(java.lang.Object obj) |
java.lang.Boolean |
getDescending()
If set to true, results are returned in descending order.
|
java.lang.Integer |
getLimit()
The maximum number of items returned in the response.
|
java.lang.String |
getLogGroupName()
The log group name for which log streams are to be listed.
|
java.lang.String |
getLogStreamNamePrefix()
Will only return log streams that match the provided logStreamNamePrefix.
|
java.lang.String |
getNextToken()
A string token used for pagination that points to the next page of
results.
|
java.lang.String |
getOrderBy()
Specifies what to order the returned log streams by.
|
int |
hashCode() |
java.lang.Boolean |
isDescending()
If set to true, results are returned in descending order.
|
void |
setDescending(java.lang.Boolean descending)
If set to true, results are returned in descending order.
|
void |
setLimit(java.lang.Integer limit)
The maximum number of items returned in the response.
|
void |
setLogGroupName(java.lang.String logGroupName)
The log group name for which log streams are to be listed.
|
void |
setLogStreamNamePrefix(java.lang.String logStreamNamePrefix)
Will only return log streams that match the provided logStreamNamePrefix.
|
void |
setNextToken(java.lang.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(java.lang.String orderBy)
Specifies what to order the returned log streams by.
|
java.lang.String |
toString()
Returns a string representation of this object; useful for testing and
debugging.
|
DescribeLogStreamsRequest |
withDescending(java.lang.Boolean descending)
If set to true, results are returned in descending order.
|
DescribeLogStreamsRequest |
withLimit(java.lang.Integer limit)
The maximum number of items returned in the response.
|
DescribeLogStreamsRequest |
withLogGroupName(java.lang.String logGroupName)
The log group name for which log streams are to be listed.
|
DescribeLogStreamsRequest |
withLogStreamNamePrefix(java.lang.String logStreamNamePrefix)
Will only return log streams that match the provided logStreamNamePrefix.
|
DescribeLogStreamsRequest |
withNextToken(java.lang.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(java.lang.String orderBy)
Specifies what to order the returned log streams by.
|
copyBaseTo, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout
private java.lang.String logGroupName
The log group name for which log streams are to be listed.
private java.lang.String logStreamNamePrefix
Will only return log streams that match the provided logStreamNamePrefix. If you don't specify a value, no prefix filter is applied.
private java.lang.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.
private java.lang.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.
private java.lang.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.
private java.lang.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.
public DescribeLogStreamsRequest()
public DescribeLogStreamsRequest(java.lang.String logGroupName)
logGroupName
- The log group name for which log streams are to be listed.public void setLogGroupName(java.lang.String logGroupName)
The log group name for which log streams are to be listed.
logGroupName
- The log group name for which log streams are to be listed.public java.lang.String getLogGroupName()
The log group name for which log streams are to be listed.
public DescribeLogStreamsRequest withLogGroupName(java.lang.String logGroupName)
The log group name for which log streams are to be listed.
logGroupName
- The log group name for which log streams are to be listed.public void setLogStreamNamePrefix(java.lang.String logStreamNamePrefix)
Will only return log streams that match the provided logStreamNamePrefix. If you don't specify a value, no prefix filter is applied.
logStreamNamePrefix
- Will only return log streams that match the provided
logStreamNamePrefix. If you don't specify a value, no prefix
filter is applied.public java.lang.String getLogStreamNamePrefix()
Will only return log streams that match the provided logStreamNamePrefix. If you don't specify a value, no prefix filter is applied.
public DescribeLogStreamsRequest withLogStreamNamePrefix(java.lang.String logStreamNamePrefix)
Will only return log streams that match the provided logStreamNamePrefix. If you don't specify a value, no prefix filter is applied.
logStreamNamePrefix
- Will only return log streams that match the provided
logStreamNamePrefix. If you don't specify a value, no prefix
filter is applied.public void setOrderBy(java.lang.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.
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.OrderBy
public java.lang.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.
OrderBy
public DescribeLogStreamsRequest withOrderBy(java.lang.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.
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.OrderBy
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.
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.OrderBy
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.
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.OrderBy
public void setDescending(java.lang.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.
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.public java.lang.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.
public DescribeLogStreamsRequest withDescending(java.lang.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.
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.public java.lang.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.
public void setNextToken(java.lang.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.
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.public java.lang.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.
DescribeLogStreams
request.public DescribeLogStreamsRequest withNextToken(java.lang.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.
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.public void setLimit(java.lang.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.
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.public java.lang.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.
public DescribeLogStreamsRequest withLimit(java.lang.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.
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.public java.lang.String toString()
toString
in class java.lang.Object
Object.toString()
public boolean equals(java.lang.Object obj)
equals
in class java.lang.Object
public int hashCode()
hashCode
in class java.lang.Object
public DescribeLogStreamsRequest clone()
AmazonWebServiceRequest
clone
in class AmazonWebServiceRequest
Object.clone()