Record Class DescribeLogStreamsOptions

java.lang.Object
java.lang.Record
codes.grow.packages.cloudwatchlogs.DescribeLogStreamsOptions
Record Components:
prefix - name prefix (not allowed with orderBy LAST_EVENT_TIME)
orderBy - sort key (default LOG_STREAM_NAME)
descending - descending order (default false)
pageSize - streams per request, 1–50 (default 50)
limit - stop after this many streams

public record DescribeLogStreamsOptions(String prefix, LogStreamOrder orderBy, Boolean descending, Integer pageSize, Integer limit) extends Record
Options of describeLogStreams.

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

  • Constructor Details

    • DescribeLogStreamsOptions

      public DescribeLogStreamsOptions(String prefix, LogStreamOrder orderBy, Boolean descending, Integer pageSize, Integer limit)
      Creates an instance of a DescribeLogStreamsOptions record class.
      Parameters:
      prefix - the value for the prefix record component
      orderBy - the value for the orderBy record component
      descending - the value for the descending record component
      pageSize - the value for the pageSize record component
      limit - the value for the limit record component
  • Method Details

    • defaults

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

      public static DescribeLogStreamsOptions.Builder builder()
      Starts a builder.
      Returns:
      a new 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.
    • prefix

      public String prefix()
      Returns the value of the prefix record component.
      Returns:
      the value of the prefix record component
    • orderBy

      public LogStreamOrder orderBy()
      Returns the value of the orderBy record component.
      Returns:
      the value of the orderBy record component
    • descending

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