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

Class GetSnapshotsRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.kendra.model.KendraRequest
software.amazon.awssdk.services.kendra.model.GetSnapshotsRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<GetSnapshotsRequest.Builder,GetSnapshotsRequest>
@Generated("software.amazon.awssdk:codegen") public final class GetSnapshotsRequest extends KendraRequest implements ToCopyableBuilder<GetSnapshotsRequest.Builder,GetSnapshotsRequest>

  • Method Details

    • indexId

      public final String indexId()

      The identifier of the index to get search metrics data.

      Returns:
      The identifier of the index to get search metrics data.

    • interval

      public final 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.

      If the service returns an enum value that is not available in the current SDK version, interval will return Interval.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from intervalAsString().

      Returns:
      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.

      See Also:

    • intervalAsString

      public final String intervalAsString()

      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.

      If the service returns an enum value that is not available in the current SDK version, interval will return Interval.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from intervalAsString().

      Returns:
      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.

      See Also:

    • metricType

      public final 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.

      If the service returns an enum value that is not available in the current SDK version, metricType will return MetricType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from metricTypeAsString().

      Returns:
      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.

      See Also:

    • metricTypeAsString

      public final String metricTypeAsString()

      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.

      If the service returns an enum value that is not available in the current SDK version, metricType will return MetricType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from metricTypeAsString().

      Returns:
      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.

      See Also:

    • nextToken

      public final 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.

      Returns:
      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.

    • maxResults

      public final Integer maxResults()

      The maximum number of returned data for the metric.

      Returns:
      The maximum number of returned data for the metric.

    • toBuilder

      public GetSnapshotsRequest.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<GetSnapshotsRequest.Builder,GetSnapshotsRequest>
      Specified by:
      toBuilder in class KendraRequest
      Returns:
      a builder for type T

    • builder

      public static GetSnapshotsRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends GetSnapshotsRequest.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsRequest

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsRequest

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final String toString()
      Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.