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 Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
QueryStringProps	build()	Builds the configured instance.
QueryStringProps.Builder	display(String display)	Sets the value of QueryStringProps.getDisplay()
QueryStringProps.Builder	fields(List<String> fields)	Sets the value of QueryStringProps.getFields()
QueryStringProps.Builder	filter(String filter)	Deprecated. Use `filterStatements` instead
QueryStringProps.Builder	filterStatements(List<String> filterStatements)	Sets the value of QueryStringProps.getFilterStatements()
QueryStringProps.Builder	limit(Number limit)	Sets the value of QueryStringProps.getLimit()
QueryStringProps.Builder	parse(String parse)	Deprecated. Use `parseStatements` instead
QueryStringProps.Builder	parseStatements(List<String> parseStatements)	Sets the value of QueryStringProps.getParseStatements()
QueryStringProps.Builder	sort(String sort)	Sets the value of QueryStringProps.getSort()
QueryStringProps.Builder	stats(String stats)	Sets the value of QueryStringProps.getStats()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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(Stable)
public QueryStringProps.Builder stats(String stats)

Sets the value of QueryStringProps.getStats()

Parameters:

stats - Uses log field values to calculate aggregate statistics.

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