Record Class GetLogEventsOptions
java.lang.Object
java.lang.Record
codes.grow.packages.cloudwatchlogs.GetLogEventsOptions
- Record Components:
startFromHead- true: oldest first; false (default): newest page first (ascending inside a page)start- inclusive startend- exclusive endpageSize- events per request, 1–10 000limit- stop after this many events
public record GetLogEventsOptions(Boolean startFromHead, Instant start, Instant end, Integer pageSize, Integer limit)
extends Record
Options of
getLogEvents.
Build with builder(); unset values are null and take the documented default.
-
Nested Class Summary
Nested Classes -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionstatic GetLogEventsOptions.Builderbuilder()Starts a builder.static GetLogEventsOptionsdefaults()Options with every default.end()Returns the value of theendrecord component.final booleanIndicates whether some other object is "equal to" this one.final inthashCode()Returns a hash code value for this object.limit()Returns the value of thelimitrecord component.pageSize()Returns the value of thepageSizerecord component.start()Returns the value of thestartrecord component.Returns the value of thestartFromHeadrecord component.Returns a builder holding these values.final StringtoString()Returns a string representation of this record class.
-
Constructor Details
-
GetLogEventsOptions
public GetLogEventsOptions(Boolean startFromHead, Instant start, Instant end, Integer pageSize, Integer limit) Creates an instance of aGetLogEventsOptionsrecord class.- Parameters:
startFromHead- the value for thestartFromHeadrecord componentstart- the value for thestartrecord componentend- the value for theendrecord componentpageSize- the value for thepageSizerecord componentlimit- the value for thelimitrecord component
-
-
Method Details
-
defaults
Options with every default.- Returns:
- the options
-
builder
Starts a builder.- Returns:
- a new builder
-
toBuilder
Returns a builder holding these values.- Returns:
- a new builder
-
toString
Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components. -
hashCode
public final int hashCode()Returns a hash code value for this object. The value is derived from the hash code of each of the record components. -
equals
Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared withObjects::equals(Object,Object). -
startFromHead
Returns the value of thestartFromHeadrecord component.- Returns:
- the value of the
startFromHeadrecord component
-
start
Returns the value of thestartrecord component.- Returns:
- the value of the
startrecord component
-
end
Returns the value of theendrecord component.- Returns:
- the value of the
endrecord component
-
pageSize
Returns the value of thepageSizerecord component.- Returns:
- the value of the
pageSizerecord component
-
limit
Returns the value of thelimitrecord component.- Returns:
- the value of the
limitrecord component
-