All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<GetSnapshotsRequest.Builder,GetSnapshotsRequest>, KendraRequest.Builder, SdkBuilder<GetSnapshotsRequest.Builder,GetSnapshotsRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

GetSnapshotsRequest
```
public static interface GetSnapshotsRequest.Builder
extends KendraRequest.Builder, SdkPojo, CopyableBuilder<GetSnapshotsRequest.Builder,GetSnapshotsRequest>
```

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`GetSnapshotsRequest.Builder`	`indexId(String indexId)`	The identifier of the index to get search metrics data.
`GetSnapshotsRequest.Builder`	`interval(String interval)`	The time interval or time window to get search metrics data.
`GetSnapshotsRequest.Builder`	`interval(Interval interval)`	The time interval or time window to get search metrics data.
`GetSnapshotsRequest.Builder`	`maxResults(Integer maxResults)`	The maximum number of returned data for the metric.
`GetSnapshotsRequest.Builder`	`metricType(String metricType)`	The metric you want to retrieve.
`GetSnapshotsRequest.Builder`	`metricType(MetricType metricType)`	The metric you want to retrieve.
`GetSnapshotsRequest.Builder`	`nextToken(String nextToken)`	If the previous response was incomplete (because there is more data to retrieve), Amazon Kendra returns a pagination token in the response.
`GetSnapshotsRequest.Builder`	`overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)`
`GetSnapshotsRequest.Builder`	`overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)`

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.services.kendra.model.KendraRequest.Builder
build

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields

- Method Detail
  - indexId
```
GetSnapshotsRequest.Builder indexId(String indexId)
```
    The identifier of the index to get search metrics data.
    
    Parameters:
    
    indexId - The identifier of the index to get search metrics data.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - interval
```
GetSnapshotsRequest.Builder interval(String interval)
```
    The time interval or time window to get search metrics data. The time interval uses the time zone of your index. You can view data in the following time windows:
    
    THIS_WEEK: The current week, starting on the Sunday and ending on the day before the current date.
    
    ONE_WEEK_AGO: The previous week, starting on the Sunday and ending on the following Saturday.
    
    TWO_WEEKS_AGO: The week before the previous week, starting on the Sunday and ending on the following Saturday.
    
    THIS_MONTH: The current month, starting on the first day of the month and ending on the day before the current date.
    
    ONE_MONTH_AGO: The previous month, starting on the first day of the month and ending on the last day of the month.
    
    TWO_MONTHS_AGO: The month before the previous month, starting on the first day of the month and ending on last day of the month.
    Parameters:
    
    interval - The time interval or time window to get search metrics data. The time interval uses the time zone of your index. You can view data in the following time windows:
    
    THIS_WEEK: The current week, starting on the Sunday and ending on the day before the current date.
    
    ONE_WEEK_AGO: The previous week, starting on the Sunday and ending on the following Saturday.
    
    TWO_WEEKS_AGO: The week before the previous week, starting on the Sunday and ending on the following Saturday.
    
    THIS_MONTH: The current month, starting on the first day of the month and ending on the day before the current date.
    
    ONE_MONTH_AGO: The previous month, starting on the first day of the month and ending on the last day of the month.
    
    TWO_MONTHS_AGO: The month before the previous month, starting on the first day of the month and ending on last day of the month.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    Interval, Interval
  - interval
```
GetSnapshotsRequest.Builder interval(Interval interval)
```
    The time interval or time window to get search metrics data. The time interval uses the time zone of your index. You can view data in the following time windows:
    
    THIS_WEEK: The current week, starting on the Sunday and ending on the day before the current date.
    
    ONE_WEEK_AGO: The previous week, starting on the Sunday and ending on the following Saturday.
    
    TWO_WEEKS_AGO: The week before the previous week, starting on the Sunday and ending on the following Saturday.
    
    THIS_MONTH: The current month, starting on the first day of the month and ending on the day before the current date.
    
    ONE_MONTH_AGO: The previous month, starting on the first day of the month and ending on the last day of the month.
    
    TWO_MONTHS_AGO: The month before the previous month, starting on the first day of the month and ending on last day of the month.
    Parameters:
    
    interval - The time interval or time window to get search metrics data. The time interval uses the time zone of your index. You can view data in the following time windows:
    
    THIS_WEEK: The current week, starting on the Sunday and ending on the day before the current date.
    
    ONE_WEEK_AGO: The previous week, starting on the Sunday and ending on the following Saturday.
    
    TWO_WEEKS_AGO: The week before the previous week, starting on the Sunday and ending on the following Saturday.
    
    THIS_MONTH: The current month, starting on the first day of the month and ending on the day before the current date.
    
    ONE_MONTH_AGO: The previous month, starting on the first day of the month and ending on the last day of the month.
    
    TWO_MONTHS_AGO: The month before the previous month, starting on the first day of the month and ending on last day of the month.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    Interval, Interval
  - metricType
```
GetSnapshotsRequest.Builder metricType(String metricType)
```
    The metric you want to retrieve. You can specify only one metric per call.
    
    For more information about the metrics you can view, see Gaining insights with search analytics.
    
    Parameters:
    
    metricType - The metric you want to retrieve. You can specify only one metric per call.
    
    For more information about the metrics you can view, see Gaining insights with search analytics.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    MetricType, MetricType
  - metricType
```
GetSnapshotsRequest.Builder metricType(MetricType metricType)
```
    The metric you want to retrieve. You can specify only one metric per call.
    
    For more information about the metrics you can view, see Gaining insights with search analytics.
    
    Parameters:
    
    metricType - The metric you want to retrieve. You can specify only one metric per call.
    
    For more information about the metrics you can view, see Gaining insights with search analytics.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    MetricType, MetricType
  - nextToken
```
GetSnapshotsRequest.Builder nextToken(String nextToken)
```
    If the previous response was incomplete (because there is more data to retrieve), Amazon Kendra returns a pagination token in the response. You can use this pagination token to retrieve the next set of search metrics data.
    
    Parameters:
    
    nextToken - If the previous response was incomplete (because there is more data to retrieve), Amazon Kendra returns a pagination token in the response. You can use this pagination token to retrieve the next set of search metrics data.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - maxResults
```
GetSnapshotsRequest.Builder maxResults(Integer maxResults)
```
    The maximum number of returned data for the metric.
    
    Parameters:
    
    maxResults - The maximum number of returned data for the metric.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - overrideConfiguration
```
GetSnapshotsRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
```
    Specified by:
    
    overrideConfiguration in interface AwsRequest.Builder
  - overrideConfiguration
```
GetSnapshotsRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
```
    Specified by:
    
    overrideConfiguration in interface AwsRequest.Builder

Interface GetSnapshotsRequest.Builder

Method Summary

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

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

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

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

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

Method Detail

indexId

interval

interval

metricType

metricType

nextToken

maxResults

overrideConfiguration

overrideConfiguration