Package software.amazon.awssdk.services.wafv2.model

Interface ListSettlementRecordsRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<ListSettlementRecordsRequest.Builder,ListSettlementRecordsRequest>, SdkBuilder<ListSettlementRecordsRequest.Builder,ListSettlementRecordsRequest>, SdkPojo, SdkRequest.Builder, Wafv2Request.Builder

Enclosing class:

ListSettlementRecordsRequest

@Mutable
@NotThreadSafe
public static interface ListSettlementRecordsRequest.Builder
extends Wafv2Request.Builder, SdkPojo, CopyableBuilder<ListSettlementRecordsRequest.Builder,ListSettlementRecordsRequest>

Method Summary

Modifier and Type	Method	Description
ListSettlementRecordsRequest.Builder	currency(String currency)	The currency for the amounts in the response.
ListSettlementRecordsRequest.Builder	currency(Currency currency)	The currency for the amounts in the response.
ListSettlementRecordsRequest.Builder	filters(Collection<MonetizationFilter> filters)	Optional filters to narrow the results.
ListSettlementRecordsRequest.Builder	filters(Consumer<MonetizationFilter.Builder>... filters)	Optional filters to narrow the results.
ListSettlementRecordsRequest.Builder	filters(MonetizationFilter... filters)	Optional filters to narrow the results.
ListSettlementRecordsRequest.Builder	limit(Integer limit)	The maximum number of settlement records to return.
ListSettlementRecordsRequest.Builder	nextMarker(String nextMarker)	When you get a paginated response, this marker indicates that additional results are available.
ListSettlementRecordsRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
ListSettlementRecordsRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
ListSettlementRecordsRequest.Builder	scope(String scope)	Specifies whether this is for a Amazon CloudFront distribution (CLOUDFRONT) or for a regional application (REGIONAL).
ListSettlementRecordsRequest.Builder	scope(Scope scope)	Specifies whether this is for a Amazon CloudFront distribution (CLOUDFRONT) or for a regional application (REGIONAL).
ListSettlementRecordsRequest.Builder	sortBy(String sortBy)	The field to sort settlement records by: TIMESTAMP, AMOUNT, NAME, or STATUS.
ListSettlementRecordsRequest.Builder	sortBy(SettlementSortBy sortBy)	The field to sort settlement records by: TIMESTAMP, AMOUNT, NAME, or STATUS.
ListSettlementRecordsRequest.Builder	sortOrder(String sortOrder)	The sort order: ASC for ascending or DESC for descending.
ListSettlementRecordsRequest.Builder	sortOrder(SortOrder sortOrder)	The sort order: ASC for ascending or DESC for descending.
default ListSettlementRecordsRequest.Builder	timeWindow(Consumer<TimeWindow.Builder> timeWindow)	The time range for the query.
ListSettlementRecordsRequest.Builder	timeWindow(TimeWindow timeWindow)	The time range for the query.

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFieldNameToField, sdkFields

Methods inherited from interface software.amazon.awssdk.services.wafv2.model.Wafv2Request.Builder

build

Method Details

timeWindow

ListSettlementRecordsRequest.Builder timeWindow(TimeWindow timeWindow)

The time range for the query. Specify start and end timestamps.

Parameters:

timeWindow - The time range for the query. Specify start and end timestamps.

Returns:

Returns a reference to this object so that method calls can be chained together.

timeWindow

default ListSettlementRecordsRequest.Builder timeWindow(Consumer<TimeWindow.Builder> timeWindow)

The time range for the query. Specify start and end timestamps.

This is a convenience method that creates an instance of the TimeWindow.Builder avoiding the need to create one manually via TimeWindow.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to timeWindow(TimeWindow).

Parameters:

timeWindow - a consumer that will call methods on TimeWindow.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• timeWindow(TimeWindow)

scope

ListSettlementRecordsRequest.Builder scope(String scope)

Specifies whether this is for a Amazon CloudFront distribution (CLOUDFRONT) or for a regional application (REGIONAL).

Parameters:

scope - Specifies whether this is for a Amazon CloudFront distribution (CLOUDFRONT) or for a regional application (REGIONAL).

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• Scope
• Scope

scope

ListSettlementRecordsRequest.Builder scope(Scope scope)

Specifies whether this is for a Amazon CloudFront distribution (CLOUDFRONT) or for a regional application (REGIONAL).

Parameters:

scope - Specifies whether this is for a Amazon CloudFront distribution (CLOUDFRONT) or for a regional application (REGIONAL).

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• Scope
• Scope

currency

ListSettlementRecordsRequest.Builder currency(String currency)

The currency for the amounts in the response.

Parameters:

currency - The currency for the amounts in the response.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• Currency
• Currency

currency

ListSettlementRecordsRequest.Builder currency(Currency currency)

The currency for the amounts in the response.

Parameters:

currency - The currency for the amounts in the response.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• Currency
• Currency

filters

ListSettlementRecordsRequest.Builder filters(Collection<MonetizationFilter> filters)

Optional filters to narrow the results. You can filter by payer address, status, source name, network, or other settlement fields.

Parameters:

filters - Optional filters to narrow the results. You can filter by payer address, status, source name, network, or other settlement fields.

Returns:

Returns a reference to this object so that method calls can be chained together.

filters

ListSettlementRecordsRequest.Builder filters(MonetizationFilter... filters)

Optional filters to narrow the results. You can filter by payer address, status, source name, network, or other settlement fields.

Parameters:

filters - Optional filters to narrow the results. You can filter by payer address, status, source name, network, or other settlement fields.

Returns:

Returns a reference to this object so that method calls can be chained together.

filters

ListSettlementRecordsRequest.Builder filters(Consumer<MonetizationFilter.Builder>... filters)

Optional filters to narrow the results. You can filter by payer address, status, source name, network, or other settlement fields.

This is a convenience method that creates an instance of the MonetizationFilter.Builder avoiding the need to create one manually via MonetizationFilter.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to filters(List<MonetizationFilter>).

Parameters:

filters - a consumer that will call methods on MonetizationFilter.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• filters(java.util.Collection<MonetizationFilter>)

sortBy

ListSettlementRecordsRequest.Builder sortBy(String sortBy)

The field to sort settlement records by: TIMESTAMP, AMOUNT, NAME, or STATUS.

Parameters:

sortBy - The field to sort settlement records by: TIMESTAMP, AMOUNT, NAME, or STATUS.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• SettlementSortBy
• SettlementSortBy

sortBy

ListSettlementRecordsRequest.Builder sortBy(SettlementSortBy sortBy)

The field to sort settlement records by: TIMESTAMP, AMOUNT, NAME, or STATUS.

Parameters:

sortBy - The field to sort settlement records by: TIMESTAMP, AMOUNT, NAME, or STATUS.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• SettlementSortBy
• SettlementSortBy

sortOrder

ListSettlementRecordsRequest.Builder sortOrder(String sortOrder)

The sort order: ASC for ascending or DESC for descending.

Parameters:

sortOrder - The sort order: ASC for ascending or DESC for descending.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• SortOrder
• SortOrder

sortOrder

ListSettlementRecordsRequest.Builder sortOrder(SortOrder sortOrder)

The sort order: ASC for ascending or DESC for descending.

Parameters:

sortOrder - The sort order: ASC for ascending or DESC for descending.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• SortOrder
• SortOrder

limit

ListSettlementRecordsRequest.Builder limit(Integer limit)

The maximum number of settlement records to return. Minimum: 1. Maximum: 100.

Parameters:

limit - The maximum number of settlement records to return. Minimum: 1. Maximum: 100.

Returns:

Returns a reference to this object so that method calls can be chained together.

nextMarker

ListSettlementRecordsRequest.Builder nextMarker(String nextMarker)

When you get a paginated response, this marker indicates that additional results are available.

Parameters:

nextMarker - When you get a paginated response, this marker indicates that additional results are available.

Returns:

Returns a reference to this object so that method calls can be chained together.

overrideConfiguration

ListSettlementRecordsRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

ListSettlementRecordsRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Specified by:

overrideConfiguration in interface AwsRequest.Builder