@Generated(value="software.amazon.awssdk:codegen") public final class GetSnapshotsResponse extends KendraResponse implements ToCopyableBuilder<GetSnapshotsResponse.Builder,GetSnapshotsResponse>
| Modifier and Type | Class and Description |
|---|---|
static interface |
GetSnapshotsResponse.Builder |
| Modifier and Type | Method and Description |
|---|---|
static GetSnapshotsResponse.Builder |
builder() |
boolean |
equals(Object obj) |
boolean |
equalsBySdkFields(Object obj) |
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
int |
hashCode() |
boolean |
hasSnapshotsData()
For responses, this returns true if the service returned a value for the SnapshotsData property.
|
boolean |
hasSnapshotsDataHeader()
For responses, this returns true if the service returned a value for the SnapshotsDataHeader property.
|
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.
|
List<SdkField<?>> |
sdkFields() |
static Class<? extends GetSnapshotsResponse.Builder> |
serializableBuilderClass() |
List<List<String>> |
snapshotsData()
The search metrics data.
|
List<String> |
snapshotsDataHeader()
The column headers for the search metrics data.
|
TimeRange |
snapShotTimeFilter()
The Unix timestamp for the beginning and end of the time window for the search metrics data.
|
GetSnapshotsResponse.Builder |
toBuilder() |
String |
toString()
Returns a string representation of this object.
|
responseMetadatasdkHttpResponseclone, finalize, getClass, notify, notifyAll, wait, wait, waitcopypublic final TimeRange snapShotTimeFilter()
The Unix timestamp for the beginning and end of the time window for the search metrics data.
public final boolean hasSnapshotsDataHeader()
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.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.
public final boolean hasSnapshotsData()
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.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.
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.
public GetSnapshotsResponse.Builder toBuilder()
toBuilder in interface ToCopyableBuilder<GetSnapshotsResponse.Builder,GetSnapshotsResponse>toBuilder in class AwsResponsepublic static GetSnapshotsResponse.Builder builder()
public static Class<? extends GetSnapshotsResponse.Builder> serializableBuilderClass()
public final int hashCode()
hashCode in class AwsResponsepublic final boolean equals(Object obj)
equals in class AwsResponsepublic final boolean equalsBySdkFields(Object obj)
equalsBySdkFields in interface SdkPojopublic final String toString()
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
getValueForField in class SdkResponseCopyright © 2023. All rights reserved.