Class DescribeLogStreamsRequest
- All Implemented Interfaces:
ReadLimitInfo
,Serializable
,Cloneable
- See Also:
-
Field Summary
Fields inherited from class com.amazonaws.AmazonWebServiceRequest
NOOP
-
Constructor Summary
ConstructorsConstructorDescriptionDefault constructor for DescribeLogStreamsRequest object.DescribeLogStreamsRequest
(String logGroupName) Constructs a new DescribeLogStreamsRequest object. -
Method Summary
Modifier and TypeMethodDescriptionclone()
Creates a shallow clone of this request.boolean
If set to true, results are returned in descending order.getLimit()
The maximum number of items returned in the response.The log group name for which log streams are to be listed.Will only return log streams that match the provided logStreamNamePrefix.A string token used for pagination that points to the next page of results.Specifies what to order the returned log streams by.int
hashCode()
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
The maximum number of items returned in the response.void
setLogGroupName
(String logGroupName) The log group name for which log streams are to be listed.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.toString()
Returns a string representation of this object; useful for testing and debugging.withDescending
(Boolean descending) If set to true, results are returned in descending order.The maximum number of items returned in the response.withLogGroupName
(String logGroupName) The log group name for which log streams are to be listed.withLogStreamNamePrefix
(String logStreamNamePrefix) Will only return log streams that match the provided logStreamNamePrefix.withNextToken
(String nextToken) A string token used for pagination that points to the next page of results.withOrderBy
(OrderBy orderBy) Specifies what to order the returned log streams by.withOrderBy
(String orderBy) Specifies what to order the returned log streams by.Methods inherited from class com.amazonaws.AmazonWebServiceRequest
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
-
Constructor Details
-
DescribeLogStreamsRequest
public DescribeLogStreamsRequest()Default constructor for DescribeLogStreamsRequest object. Callers should use the setter or fluent setter (with...) methods to initialize the object after creating it. -
DescribeLogStreamsRequest
Constructs a new DescribeLogStreamsRequest object. Callers should use the setter or fluent setter (with...) methods to initialize any additional object members.- Parameters:
logGroupName
- The log group name for which log streams are to be listed.
-
-
Method Details
-
setLogGroupName
The log group name for which log streams are to be listed.
- Parameters:
logGroupName
- The log group name for which log streams are to be listed.
-
getLogGroupName
The log group name for which log streams are to be listed.
- Returns:
- The log group name for which log streams are to be listed.
-
withLogGroupName
The log group name for which log streams are to be listed.
- Parameters:
logGroupName
- The log group name for which log streams are to be listed.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setLogStreamNamePrefix
Will only return log streams that match the provided logStreamNamePrefix. If you don't specify a value, no prefix filter is applied.
- Parameters:
logStreamNamePrefix
- Will only return log streams that match the provided logStreamNamePrefix. If you don't specify a value, no prefix filter is applied.
-
getLogStreamNamePrefix
Will only return log streams that match the provided logStreamNamePrefix. If you don't specify a value, no prefix filter is applied.
- Returns:
- Will only return log streams that match the provided logStreamNamePrefix. If you don't specify a value, no prefix filter is applied.
-
withLogStreamNamePrefix
Will only return log streams that match the provided logStreamNamePrefix. If you don't specify a value, no prefix filter is applied.
- 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:
- Returns a reference to this object so that method calls can be chained together.
-
setOrderBy
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.
- 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:
-
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.
- 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:
-
withOrderBy
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.
- 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:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
setOrderBy
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.
- 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:
-
withOrderBy
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.
- 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:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
setDescending
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.
-
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.
-
withDescending
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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.
-
setNextToken
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.- 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 previousDescribeLogStreams
request.
-
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.- 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.
-
withNextToken
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.- 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 previousDescribeLogStreams
request.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setLimit
The maximum number of items returned in the response. If you don't specify a value, the request would return up to 50 items.
- 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.
-
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.
- 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.
-
withLimit
The maximum number of items returned in the response. If you don't specify a value, the request would return up to 50 items.
- 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:
- Returns a reference to this object so that method calls can be chained together.
-
toString
Returns a string representation of this object; useful for testing and debugging. -
equals
-
hashCode
public int hashCode() -
clone
Description copied from class:AmazonWebServiceRequest
Creates a shallow clone of this request. Explicitly does not clone the deep structure of the request object.- Overrides:
clone
in classAmazonWebServiceRequest
- See Also:
-