Package software.amazon.awssdk.services.kendra.model

Interface GetSnapshotsResponse.Builder

All Superinterfaces:

AwsResponse.Builder, Buildable, CopyableBuilder<GetSnapshotsResponse.Builder,GetSnapshotsResponse>, KendraResponse.Builder, SdkBuilder<GetSnapshotsResponse.Builder,GetSnapshotsResponse>, SdkPojo, SdkResponse.Builder

Enclosing class:

GetSnapshotsResponse

public static interface GetSnapshotsResponse.Builder
extends KendraResponse.Builder, SdkPojo, CopyableBuilder<GetSnapshotsResponse.Builder,GetSnapshotsResponse>

Method Summary

Modifier and Type	Method	Description
GetSnapshotsResponse.Builder	nextToken(String nextToken)	If the response is truncated, Amazon Kendra returns this token, which you can use in a later request to retrieve the next set of search metrics data.
GetSnapshotsResponse.Builder	snapshotsData(Collection<? extends Collection<String>> snapshotsData)	The search metrics data.
GetSnapshotsResponse.Builder	snapshotsData(Collection<String>... snapshotsData)	The search metrics data.
GetSnapshotsResponse.Builder	snapshotsDataHeader(String... snapshotsDataHeader)	The column headers for the search metrics data.
GetSnapshotsResponse.Builder	snapshotsDataHeader(Collection<String> snapshotsDataHeader)	The column headers for the search metrics data.
default GetSnapshotsResponse.Builder	snapShotTimeFilter(Consumer<TimeRange.Builder> snapShotTimeFilter)	The Unix timestamp for the beginning and end of the time window for the search metrics data.
GetSnapshotsResponse.Builder	snapShotTimeFilter(TimeRange snapShotTimeFilter)	The Unix timestamp for the beginning and end of the time window for the search metrics data.

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

copy

Methods inherited from interface software.amazon.awssdk.services.kendra.model.KendraResponse.Builder

build, responseMetadata, responseMetadata

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

applyMutation, build

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

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.core.SdkResponse.Builder

sdkHttpResponse, sdkHttpResponse

Method Detail

snapShotTimeFilter

GetSnapshotsResponse.Builder snapShotTimeFilter(TimeRange snapShotTimeFilter)

The Unix timestamp for the beginning and end of the time window for the search metrics data.

Parameters:

snapShotTimeFilter - The Unix timestamp for the beginning and end of the time window for the search metrics data.

Returns:

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

snapShotTimeFilter

default GetSnapshotsResponse.Builder snapShotTimeFilter(Consumer<TimeRange.Builder> snapShotTimeFilter)

The Unix timestamp for the beginning and end of the time window for the search metrics data.

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

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

Parameters:

snapShotTimeFilter - a consumer that will call methods on TimeRange.Builder

Returns:

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

See Also:

snapShotTimeFilter(TimeRange)

snapshotsDataHeader

GetSnapshotsResponse.Builder snapshotsDataHeader(Collection<String> snapshotsDataHeader)

The column headers for the search metrics data.

Parameters:

snapshotsDataHeader - The column headers for the search metrics data.

Returns:

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

snapshotsDataHeader

GetSnapshotsResponse.Builder snapshotsDataHeader(String... snapshotsDataHeader)

The column headers for the search metrics data.

Parameters:

snapshotsDataHeader - The column headers for the search metrics data.

Returns:

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

snapshotsData

GetSnapshotsResponse.Builder snapshotsData(Collection<? extends Collection<String>> snapshotsData)

The search metrics data. The data returned depends on the metric type you requested.

Parameters:

snapshotsData - The search metrics data. The data returned depends on the metric type you requested.

Returns:

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

snapshotsData

GetSnapshotsResponse.Builder snapshotsData(Collection<String>... snapshotsData)

The search metrics data. The data returned depends on the metric type you requested.

Parameters:

snapshotsData - The search metrics data. The data returned depends on the metric type you requested.

Returns:

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

nextToken

GetSnapshotsResponse.Builder nextToken(String nextToken)

If the response is truncated, Amazon Kendra returns this token, which you can use in a later request to retrieve the next set of search metrics data.

Parameters:

nextToken - If the response is truncated, Amazon Kendra returns this token, which you can use in a later request to retrieve the next set of search metrics data.

Returns:

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