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

Class GetSnapshotsResponse

    • Method Detail

      • snapShotTimeFilter

        public final TimeRange snapShotTimeFilter()

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

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

      • hasSnapshotsDataHeader

        public final boolean hasSnapshotsDataHeader()
        For responses, this returns true if the service returned a value for the SnapshotsDataHeader property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

      • snapshotsDataHeader

        public final List<String> snapshotsDataHeader()

        The column headers for the search metrics data.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasSnapshotsDataHeader() method.

        Returns:
        The column headers for the search metrics data.

      • hasSnapshotsData

        public final boolean hasSnapshotsData()
        For responses, this returns true if the service returned a value for the SnapshotsData property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

      • snapshotsData

        public final List<List<String>> snapshotsData()

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

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasSnapshotsData() method.

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

      • nextToken

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

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

      • 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