DescribeLogStreamsRequest (AWS Java SDK for Amazon CloudWatch Logs 1.9.16 API)

java.lang.Object
- com.amazonaws.AmazonWebServiceRequest
- - com.amazonaws.services.logs.model.DescribeLogStreamsRequest

All Implemented Interfaces:

Serializable
```
public class DescribeLogStreamsRequest
extends AmazonWebServiceRequest
implements Serializable
```
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.

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
`boolean`	`equals(Object obj)`
`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()` Returns the value of the LogStreamNamePrefix property for this object.
`String`	`getNextToken()` A string token used for pagination that points to the next page of results.
`int`	`hashCode()`
`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)` Sets the value of the LogStreamNamePrefix property for this object.
`void`	`setNextToken(String nextToken)` A string token used for pagination that points to the next page of results.
`String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`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)` Sets the value of the LogStreamNamePrefix property for this object.
`DescribeLogStreamsRequest`	`withNextToken(String nextToken)` A string token used for pagination that points to the next page of results.

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
clone, 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()
```
    Returns the value of the LogStreamNamePrefix property for this object.
    Constraints:
    Length: 1 - 512
    Pattern: [^:*]*
    
    Returns:
    The value of the LogStreamNamePrefix property for this object.
  - setLogStreamNamePrefix
```
public void setLogStreamNamePrefix(String logStreamNamePrefix)
```
    Sets the value of the LogStreamNamePrefix property for this object.
    Constraints:
    Length: 1 - 512
    Pattern: [^:*]*
    
    Parameters:
    logStreamNamePrefix - The new value for the LogStreamNamePrefix property for this object.
  - withLogStreamNamePrefix
```
public DescribeLogStreamsRequest withLogStreamNamePrefix(String logStreamNamePrefix)
```
    Sets the value of the LogStreamNamePrefix property for this object.
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Length: 1 - 512
    Pattern: [^:*]*
    
    Parameters:
    logStreamNamePrefix - The new value for the LogStreamNamePrefix property for this object.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - 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.
    
    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.
    
    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.
    
    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

Class DescribeLogStreamsRequest

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

Methods inherited from class java.lang.Object

Constructor Detail

DescribeLogStreamsRequest

DescribeLogStreamsRequest

Method Detail

getLogGroupName

setLogGroupName

withLogGroupName

getLogStreamNamePrefix

setLogStreamNamePrefix

withLogStreamNamePrefix

getNextToken

setNextToken

withNextToken

getLimit

setLimit

withLimit

toString

hashCode

equals