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 start
end - exclusive end
pageSize - events per request, 1–10 000
limit - 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.

  • Constructor Details

    • GetLogEventsOptions

      public GetLogEventsOptions(Boolean startFromHead, Instant start, Instant end, Integer pageSize, Integer limit)
      Creates an instance of a GetLogEventsOptions record class.
      Parameters:
      startFromHead - the value for the startFromHead record component
      start - the value for the start record component
      end - the value for the end record component
      pageSize - the value for the pageSize record component
      limit - the value for the limit record component
  • Method Details

    • defaults

      public static GetLogEventsOptions defaults()
      Options with every default.
      Returns:
      the options
    • builder

      public static GetLogEventsOptions.Builder builder()
      Starts a builder.
      Returns:
      a new builder
    • toBuilder

      public GetLogEventsOptions.Builder toBuilder()
      Returns a builder holding these values.
      Returns:
      a new builder
    • toString

      public final String 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.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object
    • 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.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object
    • equals

      public final boolean equals(Object o)
      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 with Objects::equals(Object,Object).
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.
    • startFromHead

      public Boolean startFromHead()
      Returns the value of the startFromHead record component.
      Returns:
      the value of the startFromHead record component
    • start

      public Instant start()
      Returns the value of the start record component.
      Returns:
      the value of the start record component
    • end

      public Instant end()
      Returns the value of the end record component.
      Returns:
      the value of the end record component
    • pageSize

      public Integer pageSize()
      Returns the value of the pageSize record component.
      Returns:
      the value of the pageSize record component
    • limit

      public Integer limit()
      Returns the value of the limit record component.
      Returns:
      the value of the limit record component