Struct aws_sdk_cloudwatchlogs::client::fluent_builders::GetLogEvents

pub struct GetLogEvents<C = DynConnector, M = AwsMiddleware, R = Standard> { /* fields omitted */ }

Fluent builder constructing a request to GetLogEvents.

Lists log events from the specified log stream. You can list all of the log events or filter using a time range.

By default, this operation returns as many log events as can fit in a response size of 1MB (up to 10,000 log events). You can get additional log events by specifying one of the tokens in a subsequent call. This operation can return empty results while there are more log events available through the token.

Implementations

impl<C, M, R> GetLogEvents<C, M, R> where
    C: SmithyConnector,
    M: SmithyMiddleware<C>,
    R: NewRequestPolicy, 

pub async fn send(
    self
) -> Result<GetLogEventsOutput, SdkError<GetLogEventsError>> where
    R::Policy: SmithyRetryPolicy<GetLogEventsInputOperationOutputAlias, GetLogEventsOutput, GetLogEventsError, GetLogEventsInputOperationRetryAlias>, 

Sends the request and returns the response.

If an error occurs, an SdkError will be returned with additional details that can be matched against.

By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.

pub fn log_group_name(self, inp: impl Into<String>) -> Self

The name of the log group.

pub fn set_log_group_name(self, input: Option<String>) -> Self

The name of the log group.

pub fn log_stream_name(self, inp: impl Into<String>) -> Self

The name of the log stream.

pub fn set_log_stream_name(self, input: Option<String>) -> Self

The name of the log stream.

pub fn start_time(self, inp: i64) -> Self

The start of the time range, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC. Events with a timestamp equal to this time or later than this time are included. Events with a timestamp earlier than this time are not included.

pub fn set_start_time(self, input: Option<i64>) -> Self

The start of the time range, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC. Events with a timestamp equal to this time or later than this time are included. Events with a timestamp earlier than this time are not included.

pub fn end_time(self, inp: i64) -> Self

The end of the time range, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC. Events with a timestamp equal to or later than this time are not included.

pub fn set_end_time(self, input: Option<i64>) -> Self

The end of the time range, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC. Events with a timestamp equal to or later than this time are not included.

pub fn next_token(self, inp: impl Into<String>) -> Self

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

pub fn set_next_token(self, input: Option<String>) -> Self

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

pub fn limit(self, inp: i32) -> Self

The maximum number of log events returned. If you don't specify a value, the maximum is as many log events as can fit in a response size of 1 MB, up to 10,000 log events.

pub fn set_limit(self, input: Option<i32>) -> Self

The maximum number of log events returned. If you don't specify a value, the maximum is as many log events as can fit in a response size of 1 MB, up to 10,000 log events.

pub fn start_from_head(self, inp: bool) -> Self

If the value is true, the earliest log events are returned first. If the value is false, the latest log events are returned first. The default value is false.

If you are using a previous nextForwardToken value as the nextToken in this operation, you must specify true for startFromHead.

pub fn set_start_from_head(self, input: Option<bool>) -> Self

If the value is true, the earliest log events are returned first. If the value is false, the latest log events are returned first. The default value is false.

If you are using a previous nextForwardToken value as the nextToken in this operation, you must specify true for startFromHead.

Trait Implementations

impl<C: Debug, M: Debug, R: Debug> Debug for GetLogEvents<C, M, R>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.