@Generated(value="software.amazon.awssdk:codegen") public final class DescribeLogStreamsRequest extends CloudWatchLogsRequest implements ToCopyableBuilder<DescribeLogStreamsRequest.Builder,DescribeLogStreamsRequest>
Modifier and Type | Class and Description |
---|---|
static interface |
DescribeLogStreamsRequest.Builder |
Modifier and Type | Method and Description |
---|---|
static DescribeLogStreamsRequest.Builder |
builder() |
Boolean |
descending()
If the value is true, results are returned in descending order.
|
boolean |
equals(Object obj) |
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz)
Used to retrieve the value of a field from any class that extends
SdkRequest . |
int |
hashCode() |
Integer |
limit()
The maximum number of items returned.
|
String |
logGroupName()
The name of the log group.
|
String |
logStreamNamePrefix()
The prefix to match.
|
String |
nextToken()
The token for the next set of items to return.
|
OrderBy |
orderBy()
If the value is
LogStreamName , the results are ordered by log stream name. |
String |
orderByAsString()
If the value is
LogStreamName , the results are ordered by log stream name. |
static Class<? extends DescribeLogStreamsRequest.Builder> |
serializableBuilderClass() |
DescribeLogStreamsRequest.Builder |
toBuilder()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString() |
overrideConfiguration
copy
public String logGroupName()
The name of the log group.
public String logStreamNamePrefix()
The prefix to match.
iIf orderBy
is LastEventTime
,you cannot specify this parameter.
iIf orderBy
is LastEventTime
,you cannot specify this parameter.
public 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 may take longer in some rare situations.
If the service returns an enum value that is not available in the current SDK version, orderBy
will
return OrderBy.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
orderByAsString()
.
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 may take longer in some rare situations.
OrderBy
public String orderByAsString()
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 may take longer in some rare situations.
If the service returns an enum value that is not available in the current SDK version, orderBy
will
return OrderBy.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
orderByAsString()
.
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 may take longer in some rare situations.
OrderBy
public 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.
public String nextToken()
The token for the next set of items to return. (You received this token from a previous call.)
public Integer limit()
The maximum number of items returned. If you don't specify a value, the default is up to 50 items.
public DescribeLogStreamsRequest.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<DescribeLogStreamsRequest.Builder,DescribeLogStreamsRequest>
toBuilder
in class CloudWatchLogsRequest
public static DescribeLogStreamsRequest.Builder builder()
public static Class<? extends DescribeLogStreamsRequest.Builder> serializableBuilderClass()
public <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
SdkRequest
SdkRequest
. The field name
specified should match the member name from the corresponding service-2.json model specified in the
codegen-resources folder for a given service. The class specifies what class to cast the returned value to.
If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class)
method will
again be available.getValueForField
in class SdkRequest
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.