software.amazon.awssdk.services.cloudwatchlogs.model

Class DescribeLogStreamsRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.cloudwatchlogs.model.CloudWatchLogsRequest

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<DescribeLogStreamsRequest.Builder,DescribeLogStreamsRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	DescribeLogStreamsRequest.Builder

Method Summary

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)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Integer	limit() The maximum number of items returned.
String	logGroupIdentifier() Specify either the name or ARN of the log group to view.
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.
List<SdkField<?>>	sdkFields()
static Class<? extends DescribeLogStreamsRequest.Builder>	serializableBuilderClass()
DescribeLogStreamsRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

logGroupName

public final String logGroupName()

The name of the log group.

You must include either logGroupIdentifier or logGroupName, but not both.

Returns:

The name of the log group.

You must include either logGroupIdentifier or logGroupName, but not both.

logGroupIdentifier

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

Returns:

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.

logStreamNamePrefix

public final String logStreamNamePrefix()

The prefix to match.

If orderBy is LastEventTime, you cannot specify this parameter.

Returns:

The prefix to match.

If orderBy is LastEventTime, you cannot specify this parameter.

orderBy

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

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().

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

See Also:

OrderBy

orderByAsString

public final 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 in rare situations might take longer.

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().

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

See Also:

OrderBy

descending

public final 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 final 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 final 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()

Specified by:

toBuilder in interface ToCopyableBuilder<DescribeLogStreamsRequest.Builder,DescribeLogStreamsRequest>

Specified by:

toBuilder in class CloudWatchLogsRequest

builder

public static DescribeLogStreamsRequest.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo