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

Class GetLogEventsRequest

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<GetLogEventsRequest.Builder,GetLogEventsRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	GetLogEventsRequest.Builder

Method Summary

Modifier and Type	Method	Description
static GetLogEventsRequest.Builder	builder()
Long	endTime()	The end of the time range, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC.
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 log events returned.
String	logGroupIdentifier()	Specify either the name or ARN of the log group to view events from.
String	logGroupName()	The name of the log group.
String	logStreamName()	The name of the log stream.
String	nextToken()	The token for the next set of items to return.
List<SdkField<?>>	sdkFields()
static Class<? extends GetLogEventsRequest.Builder>	serializableBuilderClass()
Boolean	startFromHead()	If the value is true, the earliest log events are returned first.
Long	startTime()	The start of the time range, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC.
GetLogEventsRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
Boolean	unmask()	Specify true to display the log event fields with all sensitive data unmasked and visible.

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

logStreamName

public final String logStreamName()

The name of the log stream.

Returns:

The name of the log stream.

startTime

public final Long startTime()

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.

Returns:

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.

endTime

public final Long endTime()

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.

Returns:

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.

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 log events returned. If you don't specify a limit, the default is as many log events as can fit in a response size of 1 MB (up to 10,000 log events).

Returns:

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

startFromHead

public final Boolean startFromHead()

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.

Returns:

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.

unmask

public final Boolean unmask()

Specify true to display the log event fields with all sensitive data unmasked and visible. The default is false.

To use this operation with this parameter, you must be signed into an account with the logs:Unmask permission.

Returns:

Specify true to display the log event fields with all sensitive data unmasked and visible. The default is false.

To use this operation with this parameter, you must be signed into an account with the logs:Unmask permission.

toBuilder

public GetLogEventsRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<GetLogEventsRequest.Builder,GetLogEventsRequest>

Specified by:

toBuilder in class CloudWatchLogsRequest

builder

public static GetLogEventsRequest.Builder builder()

serializableBuilderClass

public static Class<? extends GetLogEventsRequest.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