Class LookupEventsRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<LookupEventsRequest.Builder,
LookupEventsRequest>
Contains a request for LookupEvents.
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic LookupEventsRequest.Builder
builder()
final Instant
endTime()
Specifies that only events that occur before or at the specified time are returned.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final EventCategory
Specifies the event category.final String
Specifies the event category.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest
.final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the LookupAttributes property.final List
<LookupAttribute> Contains a list of lookup attributes.final Integer
The number of events to return.final String
The token to use to get the next page of results after a previous API call.static Class
<? extends LookupEventsRequest.Builder> final Instant
Specifies that only events that occur after or at the specified time are returned.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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 theisEmpty()
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
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
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
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
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 ofEventCategory
, no Insights events are returned.If the service returns an enum value that is not available in the current SDK version,
eventCategory
will returnEventCategory.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromeventCategoryAsString()
.- 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 ofEventCategory
, no Insights events are returned. - See Also:
-
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 ofEventCategory
, no Insights events are returned.If the service returns an enum value that is not available in the current SDK version,
eventCategory
will returnEventCategory.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromeventCategoryAsString()
.- 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 ofEventCategory
, no Insights events are returned. - See Also:
-
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
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
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<LookupEventsRequest.Builder,
LookupEventsRequest> - Specified by:
toBuilder
in classCloudTrailRequest
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsRequest
-
equals
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
Description copied from class:SdkRequest
Used to retrieve the value of a field from any class that extendsSdkRequest
. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, theSdkRequest.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkRequest
- Parameters:
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.- Returns:
- Optional containing the casted return value
-
sdkFields
-