Record Class FilterLogEventsOptions

java.lang.Object
java.lang.Record
codes.grow.packages.cloudwatchlogs.FilterLogEventsOptions
Record Components:
group - log group name or ARN (default config.logGroup)
streams - only these streams (1–100; not with streamPrefix)
streamPrefix - only streams with this prefix (not with streams)
pattern - CloudWatch filter pattern
start - inclusive start
end - inclusive end
pageSize - events per request, 1–10 000
limit - stop after this many events

public record FilterLogEventsOptions(String group, List<String> streams, String streamPrefix, String pattern, Instant start, Instant end, Integer pageSize, Integer limit) extends Record
Options of filterLogEvents.

Build with builder(); unset values are null and take the documented default.

  • Constructor Details

    • FilterLogEventsOptions

      public FilterLogEventsOptions(String group, List<String> streams, String streamPrefix, String pattern, Instant start, Instant end, Integer pageSize, Integer limit)
      Applies defaults.
      Parameters:
      group - log group name or ARN (default config.logGroup)
      streams - only these streams (1–100; not with streamPrefix)
      streamPrefix - only streams with this prefix (not with streams)
      pattern - CloudWatch filter pattern
      start - inclusive start
      end - inclusive end
      pageSize - events per request, 1–10 000
      limit - stop after this many events
  • Method Details

    • defaults

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

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

      public FilterLogEventsOptions.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.
    • group

      public String group()
      Returns the value of the group record component.
      Returns:
      the value of the group record component
    • streams

      public List<String> streams()
      Returns the value of the streams record component.
      Returns:
      the value of the streams record component
    • streamPrefix

      public String streamPrefix()
      Returns the value of the streamPrefix record component.
      Returns:
      the value of the streamPrefix record component
    • pattern

      public String pattern()
      Returns the value of the pattern record component.
      Returns:
      the value of the pattern 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