Package software.amazon.awscdk.services.logs

Class QueryStringProps.Builder

java.lang.Object
software.amazon.awscdk.services.logs.QueryStringProps.Builder
All Implemented Interfaces:
software.amazon.jsii.Builder<QueryStringProps>
Enclosing interface:
QueryStringProps
@Stability(Stable) public static final class QueryStringProps.Builder extends Object implements software.amazon.jsii.Builder<QueryStringProps>
A builder for QueryStringProps

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • display

      @Stability(Stable) public QueryStringProps.Builder display(String display)
      Sets the value of QueryStringProps.getDisplay()
      Parameters:
      display - Specifies which fields to display in the query results.
      Returns:
      this

    • fields

      @Stability(Stable) public QueryStringProps.Builder fields(List<String> fields)
      Sets the value of QueryStringProps.getFields()
      Parameters:
      fields - Retrieves the specified fields from log events for display.
      Returns:
      this

    • filter

      @Stability(Deprecated) @Deprecated public QueryStringProps.Builder filter(String filter)
      Deprecated.
      Use `filterStatements` instead
      Sets the value of QueryStringProps.getFilter()
      Parameters:
      filter - A single statement for filtering the results of a query based on a boolean expression.
      Returns:
      this

    • filterStatements

      @Stability(Stable) public QueryStringProps.Builder filterStatements(List<String> filterStatements)
      Sets the value of QueryStringProps.getFilterStatements()
      Parameters:
      filterStatements - An array of one or more statements for filtering the results of a query based on a boolean expression. Each provided statement generates a separate filter line in the query string.

      Note: If provided, this property overrides any value provided for the filter property.

      Returns:
      this

    • limit

      @Stability(Stable) public QueryStringProps.Builder limit(Number limit)
      Sets the value of QueryStringProps.getLimit()
      Parameters:
      limit - Specifies the number of log events returned by the query.
      Returns:
      this

    • parse

      @Stability(Deprecated) @Deprecated public QueryStringProps.Builder parse(String parse)
      Deprecated.
      Use `parseStatements` instead
      Sets the value of QueryStringProps.getParse()
      Parameters:
      parse - A single statement for parsing data from a log field and creating ephemeral fields that can be processed further in the query.
      Returns:
      this

    • parseStatements

      @Stability(Stable) public QueryStringProps.Builder parseStatements(List<String> parseStatements)
      Sets the value of QueryStringProps.getParseStatements()
      Parameters:
      parseStatements - An array of one or more statements for parsing data from a log field and creating ephemeral fields that can be processed further in the query. Each provided statement generates a separate parse line in the query string.

      Note: If provided, this property overrides any value provided for the parse property.

      Returns:
      this

    • sort

      @Stability(Stable) public QueryStringProps.Builder sort(String sort)
      Sets the value of QueryStringProps.getSort()
      Parameters:
      sort - Sorts the retrieved log events.
      Returns:
      this

    • stats

      @Stability(Deprecated) @Deprecated public QueryStringProps.Builder stats(String stats)
      Deprecated.
      Use `statsStatements` instead
      Sets the value of QueryStringProps.getStats()
      Parameters:
      stats - A single statement for using log field values to calculate aggregate statistics.
      Returns:
      this

    • statsStatements

      @Stability(Stable) public QueryStringProps.Builder statsStatements(List<String> statsStatements)
      Sets the value of QueryStringProps.getStatsStatements()
      Parameters:
      statsStatements - An array of one or more statements for calculating aggregate statistics. CloudWatch Logs Insights supports up to two stats commands in a single query. Each provided statement generates a separate stats line in the query string.

      Note: If provided, this property overrides any value provided for the stats property.

      Returns:
      this

    • build

      @Stability(Stable) public QueryStringProps build()
      Builds the configured instance.
      Specified by:
      build in interface software.amazon.jsii.Builder<QueryStringProps>
      Returns:
      a new instance of QueryStringProps
      Throws:
      NullPointerException - if any required attribute was not provided