@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class DescribeLogStreamsRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
NOOP
Constructor and Description |
---|
DescribeLogStreamsRequest()
Default constructor for DescribeLogStreamsRequest object.
|
DescribeLogStreamsRequest(String logGroupName)
Constructs a new DescribeLogStreamsRequest object.
|
Modifier and Type | Method and Description |
---|---|
DescribeLogStreamsRequest |
clone()
Creates a shallow clone of this object for all fields except the handler context.
|
boolean |
equals(Object obj) |
Boolean |
getDescending()
If the value is true, results are returned in descending order.
|
Integer |
getLimit()
The maximum number of items returned.
|
String |
getLogGroupIdentifier()
Specify either the name or ARN of the log group to view.
|
String |
getLogGroupName()
The name of the log group.
|
String |
getLogStreamNamePrefix()
The prefix to match.
|
String |
getNextToken()
The token for the next set of items to return.
|
String |
getOrderBy()
If the value is
LogStreamName , the results are ordered by log stream name. |
int |
hashCode() |
Boolean |
isDescending()
If the value is true, results are returned in descending order.
|
void |
setDescending(Boolean descending)
If the value is true, results are returned in descending order.
|
void |
setLimit(Integer limit)
The maximum number of items returned.
|
void |
setLogGroupIdentifier(String logGroupIdentifier)
Specify either the name or ARN of the log group to view.
|
void |
setLogGroupName(String logGroupName)
The name of the log group.
|
void |
setLogStreamNamePrefix(String logStreamNamePrefix)
The prefix to match.
|
void |
setNextToken(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(String orderBy)
If the value is
LogStreamName , the results are ordered by log stream name. |
String |
toString()
Returns a string representation of this object.
|
DescribeLogStreamsRequest |
withDescending(Boolean descending)
If the value is true, results are returned in descending order.
|
DescribeLogStreamsRequest |
withLimit(Integer limit)
The maximum number of items returned.
|
DescribeLogStreamsRequest |
withLogGroupIdentifier(String logGroupIdentifier)
Specify either the name or ARN of the log group to view.
|
DescribeLogStreamsRequest |
withLogGroupName(String logGroupName)
The name of the log group.
|
DescribeLogStreamsRequest |
withLogStreamNamePrefix(String logStreamNamePrefix)
The prefix to match.
|
DescribeLogStreamsRequest |
withNextToken(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(String orderBy)
If the value is
LogStreamName , the results are ordered by log stream name. |
addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout
public DescribeLogStreamsRequest()
public DescribeLogStreamsRequest(String logGroupName)
logGroupName
- The name of the log group.
You must include either logGroupIdentifier
or logGroupName
, but not both.
public void setLogGroupName(String logGroupName)
The name of the log group.
You must include either logGroupIdentifier
or logGroupName
, but not both.
logGroupName
- The name of the log group.
You must include either logGroupIdentifier
or logGroupName
, but not both.
public String getLogGroupName()
The name of the log group.
You must include either logGroupIdentifier
or logGroupName
, but not both.
You must include either logGroupIdentifier
or logGroupName
, but not both.
public DescribeLogStreamsRequest withLogGroupName(String logGroupName)
The name of the log group.
You must include either logGroupIdentifier
or logGroupName
, but not both.
logGroupName
- The name of the log group.
You must include either logGroupIdentifier
or logGroupName
, but not both.
public void setLogGroupIdentifier(String logGroupIdentifier)
Specify either the name or ARN of the log group to view. If the log group is in a source account and you are using a monitoring account, you must use the log group ARN.
You must include either logGroupIdentifier
or logGroupName
, but not both.
logGroupIdentifier
- Specify either the name or ARN of the log group to view. If the log group is in a source account and you
are using a monitoring account, you must use the log group ARN.
You must include either logGroupIdentifier
or logGroupName
, but not both.
public String getLogGroupIdentifier()
Specify either the name or ARN of the log group to view. If the log group is in a source account and you are using a monitoring account, you must use the log group ARN.
You must include either logGroupIdentifier
or logGroupName
, but not both.
You must include either logGroupIdentifier
or logGroupName
, but not both.
public DescribeLogStreamsRequest withLogGroupIdentifier(String logGroupIdentifier)
Specify either the name or ARN of the log group to view. If the log group is in a source account and you are using a monitoring account, you must use the log group ARN.
You must include either logGroupIdentifier
or logGroupName
, but not both.
logGroupIdentifier
- Specify either the name or ARN of the log group to view. If the log group is in a source account and you
are using a monitoring account, you must use the log group ARN.
You must include either logGroupIdentifier
or logGroupName
, but not both.
public void setLogStreamNamePrefix(String logStreamNamePrefix)
The prefix to match.
If orderBy
is LastEventTime
, you cannot specify this parameter.
logStreamNamePrefix
- The prefix to match.
If orderBy
is LastEventTime
, you cannot specify this parameter.
public String getLogStreamNamePrefix()
The prefix to match.
If orderBy
is LastEventTime
, you cannot specify this parameter.
If orderBy
is LastEventTime
, you cannot specify this parameter.
public DescribeLogStreamsRequest withLogStreamNamePrefix(String logStreamNamePrefix)
The prefix to match.
If orderBy
is LastEventTime
, you cannot specify this parameter.
logStreamNamePrefix
- The prefix to match.
If orderBy
is LastEventTime
, you cannot specify this parameter.
public void setOrderBy(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 in rare situations might take longer.
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 in rare situations might take longer.
OrderBy
public 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 in rare situations might take longer.
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 in rare situations might take
longer.
OrderBy
public DescribeLogStreamsRequest withOrderBy(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 in rare situations might take longer.
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 in rare situations might take longer.
OrderBy
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 in rare situations might take longer.
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 in rare situations might take longer.
OrderBy
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 in rare situations might take longer.
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 in rare situations might take longer.
OrderBy
public void setDescending(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.
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.public 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.
public DescribeLogStreamsRequest withDescending(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.
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.public 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.
public void setNextToken(String nextToken)
The token for the next set of items to return. (You received this token from a previous call.)
nextToken
- The token for the next set of items to return. (You received this token from a previous call.)public String getNextToken()
The token for the next set of items to return. (You received this token from a previous call.)
public DescribeLogStreamsRequest withNextToken(String nextToken)
The token for the next set of items to return. (You received this token from a previous call.)
nextToken
- The token for the next set of items to return. (You received this token from a previous call.)public void setLimit(Integer limit)
The maximum number of items returned. If you don't specify a value, the default is up to 50 items.
limit
- The maximum number of items returned. If you don't specify a value, the default is up to 50 items.public Integer getLimit()
The maximum number of items returned. If you don't specify a value, the default is up to 50 items.
public DescribeLogStreamsRequest withLimit(Integer limit)
The maximum number of items returned. If you don't specify a value, the default is up to 50 items.
limit
- The maximum number of items returned. If you don't specify a value, the default is up to 50 items.public String toString()
toString
in class Object
Object.toString()
public DescribeLogStreamsRequest clone()
AmazonWebServiceRequest
clone
in class AmazonWebServiceRequest
Object.clone()