software.amazon.awscdk.services.logs

Class QueryString.Builder

java.lang.Object

software.amazon.awscdk.services.logs.QueryString.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<QueryString>

Enclosing class:

QueryString

@Stability(value=Stable)
public static final class QueryString.Builder
extends Object
implements software.amazon.jsii.Builder<QueryString>

A fluent builder for QueryString.

Method Summary

Modifier and Type	Method and Description
QueryString	build()
static QueryString.Builder	create()
QueryString.Builder	display(String display) Specifies which fields to display in the query results.
QueryString.Builder	fields(List<String> fields) Retrieves the specified fields from log events for display.
QueryString.Builder	filter(String filter) Filters the results of a query that's based on one or more conditions.
QueryString.Builder	limit(Number limit) Specifies the number of log events returned by the query.
QueryString.Builder	parse(String parse) Extracts data from a log field and creates one or more ephemeral fields that you can process further in the query.
QueryString.Builder	sort(String sort) Sorts the retrieved log events.
QueryString.Builder	stats(String stats) Uses log field values to calculate aggregate statistics.

Methods inherited from class java.lang.Object

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

Method Detail

create

@Stability(value=Stable)
public static QueryString.Builder create()

Returns:

a new instance of QueryString.Builder.

display

@Stability(value=Stable)
public QueryString.Builder display(String display)

Specifies which fields to display in the query results.

Default: - no display in QueryString

Parameters:

display - Specifies which fields to display in the query results. This parameter is required.

Returns:

this

fields

@Stability(value=Stable)
public QueryString.Builder fields(List<String> fields)

Retrieves the specified fields from log events for display.

Default: - no fields in QueryString

Parameters:

fields - Retrieves the specified fields from log events for display. This parameter is required.

Returns:

this

filter

@Stability(value=Stable)
public QueryString.Builder filter(String filter)

Filters the results of a query that's based on one or more conditions.

Default: - no filter in QueryString

Parameters:

filter - Filters the results of a query that's based on one or more conditions. This parameter is required.

Returns:

this

limit

@Stability(value=Stable)
public QueryString.Builder limit(Number limit)

Specifies the number of log events returned by the query.

Default: - no limit in QueryString

Parameters:

limit - Specifies the number of log events returned by the query. This parameter is required.

Returns:

this

parse

@Stability(value=Stable)
public QueryString.Builder parse(String parse)

Extracts data from a log field and creates one or more ephemeral fields that you can process further in the query.

Default: - no parse in QueryString

Parameters:

parse - Extracts data from a log field and creates one or more ephemeral fields that you can process further in the query. This parameter is required.

Returns:

this

sort

@Stability(value=Stable)
public QueryString.Builder sort(String sort)

Sorts the retrieved log events.

Default: - no sort in QueryString

Parameters:

sort - Sorts the retrieved log events. This parameter is required.

Returns:

this

stats

@Stability(value=Stable)
public QueryString.Builder stats(String stats)

Uses log field values to calculate aggregate statistics.

Default: - no stats in QueryString

Parameters:

stats - Uses log field values to calculate aggregate statistics. This parameter is required.

Returns:

this

build

@Stability(value=Stable)
public QueryString build()

Specified by:

build in interface software.amazon.jsii.Builder<QueryString>