Package software.amazon.awssdk.services.cloudwatchlogs.model

Class DescribeLogStreamsRequest

java.lang.Object

software.amazon.awssdk.AmazonWebServiceRequest

software.amazon.awssdk.services.cloudwatchlogs.model.DescribeLogStreamsRequest

All Implemented Interfaces:

Cloneable, ReadLimitInfo, ToCopyableBuilder<DescribeLogStreamsRequest.Builder,DescribeLogStreamsRequest>

@Generated("software.amazon.awssdk:codegen")
public class DescribeLogStreamsRequest
extends AmazonWebServiceRequest
implements ToCopyableBuilder<DescribeLogStreamsRequest.Builder,DescribeLogStreamsRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	DescribeLogStreamsRequest.Builder

Field Summary

Fields inherited from class software.amazon.awssdk.AmazonWebServiceRequest

NOOP

Method Summary

Modifier and Type	Method	Description
static DescribeLogStreamsRequest.Builder	builder()
Boolean	descending()	If the value is true, results are returned in descending order.
boolean	equals(Object obj)
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.
String	orderBy()	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()

Methods inherited from class software.amazon.awssdk.AmazonWebServiceRequest

clone, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

logGroupName

public String logGroupName()

The name of the log group.

Returns:

The name of the log group.

logStreamNamePrefix

public String logStreamNamePrefix()

The prefix to match.

You cannot specify this parameter if orderBy is LastEventTime.

Returns:

The prefix to match.

You cannot specify this parameter if orderBy is LastEventTime.

orderBy

public 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 since 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.

Returns:

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 since 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.

See Also:

OrderBy

descending

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.

Returns:

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.

nextToken

public String nextToken()

The token for the next set of items to return. (You received this token from a previous call.)

Returns:

The token for the next set of items to return. (You received this token from a previous call.)

limit

public Integer limit()

The maximum number of items returned. If you don't specify a value, the default is up to 50 items.

Returns:

The maximum number of items returned. If you don't specify a value, the default is up to 50 items.

toBuilder

public DescribeLogStreamsRequest.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<DescribeLogStreamsRequest.Builder,DescribeLogStreamsRequest>

Returns:

a builder for type T

builder

public static DescribeLogStreamsRequest.Builder builder()

serializableBuilderClass

public static Class<? extends DescribeLogStreamsRequest.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object