Package software.amazon.awssdk.services.cloudtrail.model

Class LookupEventsRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.cloudtrail.model.CloudTrailRequest

software.amazon.awssdk.services.cloudtrail.model.LookupEventsRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<LookupEventsRequest.Builder,LookupEventsRequest>

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

Contains a request for LookupEvents.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	LookupEventsRequest.Builder

Method Summary

Modifier and Type	Method	Description
static LookupEventsRequest.Builder	builder()
Instant	endTime()	Specifies that only events that occur before or at the specified time are returned.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
EventCategory	eventCategory()	Specifies the event category.
String	eventCategoryAsString()	Specifies the event category.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasLookupAttributes()	For responses, this returns true if the service returned a value for the LookupAttributes property.
List<LookupAttribute>	lookupAttributes()	Contains a list of lookup attributes.
Integer	maxResults()	The number of events to return.
String	nextToken()	The token to use to get the next page of results after a previous API call.
List<SdkField<?>>	sdkFields()
static Class<? extends LookupEventsRequest.Builder>	serializableBuilderClass()
Instant	startTime()	Specifies that only events that occur after or at the specified time are returned.
LookupEventsRequest.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

hasLookupAttributes

public final boolean hasLookupAttributes()

For responses, this returns true if the service returned a value for the LookupAttributes property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

lookupAttributes

public final List<LookupAttribute> lookupAttributes()

Contains a list of lookup attributes. Currently the list can contain only one item.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasLookupAttributes() method.

Returns:

Contains a list of lookup attributes. Currently the list can contain only one item.

startTime

public final Instant startTime()

Specifies that only events that occur after or at the specified time are returned. If the specified start time is after the specified end time, an error is returned.

Returns:

Specifies that only events that occur after or at the specified time are returned. If the specified start time is after the specified end time, an error is returned.

endTime

public final Instant endTime()

Specifies that only events that occur before or at the specified time are returned. If the specified end time is before the specified start time, an error is returned.

Returns:

Specifies that only events that occur before or at the specified time are returned. If the specified end time is before the specified start time, an error is returned.

eventCategory

public final EventCategory eventCategory()

Specifies the event category. If you do not specify an event category, events of the category are not returned in the response. For example, if you do not specify insight as the value of EventCategory, no Insights events are returned.

If the service returns an enum value that is not available in the current SDK version, eventCategory will return EventCategory.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from eventCategoryAsString().

Returns:

Specifies the event category. If you do not specify an event category, events of the category are not returned in the response. For example, if you do not specify insight as the value of EventCategory, no Insights events are returned.

See Also:

EventCategory

eventCategoryAsString

public final String eventCategoryAsString()

Specifies the event category. If you do not specify an event category, events of the category are not returned in the response. For example, if you do not specify insight as the value of EventCategory, no Insights events are returned.

If the service returns an enum value that is not available in the current SDK version, eventCategory will return EventCategory.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from eventCategoryAsString().

Returns:

Specifies the event category. If you do not specify an event category, events of the category are not returned in the response. For example, if you do not specify insight as the value of EventCategory, no Insights events are returned.

See Also:

EventCategory

maxResults

public final Integer maxResults()

The number of events to return. Possible values are 1 through 50. The default is 50.

Returns:

The number of events to return. Possible values are 1 through 50. The default is 50.

nextToken

public final String nextToken()

The token to use to get the next page of results after a previous API call. This token must be passed in with the same parameters that were specified in the original call. For example, if the original call specified an AttributeKey of 'Username' with a value of 'root', the call with NextToken should include those same parameters.

Returns:

The token to use to get the next page of results after a previous API call. This token must be passed in with the same parameters that were specified in the original call. For example, if the original call specified an AttributeKey of 'Username' with a value of 'root', the call with NextToken should include those same parameters.

toBuilder

public LookupEventsRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<LookupEventsRequest.Builder,LookupEventsRequest>

Specified by:

toBuilder in class CloudTrailRequest

builder

public static LookupEventsRequest.Builder builder()

serializableBuilderClass

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