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

Interface GetSnapshotsRequest.Builder

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 Details

    • 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

      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:

    • 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

      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:

    • 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)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      GetSnapshotsRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.