software.amazon.awssdk.services.cloudwatchlogs.model

Interface DescribeLogStreamsRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CloudWatchLogsRequest.Builder, CopyableBuilder<DescribeLogStreamsRequest.Builder,DescribeLogStreamsRequest>, SdkBuilder<DescribeLogStreamsRequest.Builder,DescribeLogStreamsRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

DescribeLogStreamsRequest

public static interface DescribeLogStreamsRequest.Builder
extends CloudWatchLogsRequest.Builder, SdkPojo, CopyableBuilder<DescribeLogStreamsRequest.Builder,DescribeLogStreamsRequest>

Method Summary

Modifier and Type	Method and Description
DescribeLogStreamsRequest.Builder	descending(Boolean descending) If the value is true, results are returned in descending order.
DescribeLogStreamsRequest.Builder	limit(Integer limit) The maximum number of items returned.
DescribeLogStreamsRequest.Builder	logGroupIdentifier(String logGroupIdentifier) Specify either the name or ARN of the log group to view.
DescribeLogStreamsRequest.Builder	logGroupName(String logGroupName) The name of the log group.
DescribeLogStreamsRequest.Builder	logStreamNamePrefix(String logStreamNamePrefix) The prefix to match.
DescribeLogStreamsRequest.Builder	nextToken(String nextToken) The token for the next set of items to return.
DescribeLogStreamsRequest.Builder	orderBy(OrderBy orderBy) If the value is LogStreamName, the results are ordered by log stream name.
DescribeLogStreamsRequest.Builder	orderBy(String orderBy) If the value is LogStreamName, the results are ordered by log stream name.
DescribeLogStreamsRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
DescribeLogStreamsRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Methods inherited from interface software.amazon.awssdk.services.cloudwatchlogs.model.CloudWatchLogsRequest.Builder

build

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

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

copy

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

applyMutation, build

Method Detail

logGroupName

DescribeLogStreamsRequest.Builder logGroupName(String logGroupName)

The name of the log group.

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

Parameters:

logGroupName - The name of the log group.

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

Returns:

Returns a reference to this object so that method calls can be chained together.

logGroupIdentifier

DescribeLogStreamsRequest.Builder logGroupIdentifier(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

logStreamNamePrefix

DescribeLogStreamsRequest.Builder logStreamNamePrefix(String logStreamNamePrefix)

The prefix to match.

If orderBy is LastEventTime, you cannot specify this parameter.

Parameters:

logStreamNamePrefix - The prefix to match.

If orderBy is LastEventTime, you cannot specify this parameter.

Returns:

Returns a reference to this object so that method calls can be chained together.

orderBy

DescribeLogStreamsRequest.Builder orderBy(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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

OrderBy, OrderBy

orderBy

DescribeLogStreamsRequest.Builder orderBy(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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

OrderBy, OrderBy

descending

DescribeLogStreamsRequest.Builder descending(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

nextToken

DescribeLogStreamsRequest.Builder nextToken(String nextToken)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

limit

DescribeLogStreamsRequest.Builder limit(Integer limit)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

overrideConfiguration

DescribeLogStreamsRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

DescribeLogStreamsRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Specified by:

overrideConfiguration in interface AwsRequest.Builder