GetSnapshotsResult (AWS SDK for Java

java.lang.Object
- com.amazonaws.AmazonWebServiceResult<ResponseMetadata>
- - com.amazonaws.services.kendra.model.GetSnapshotsResult

All Implemented Interfaces:: Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class GetSnapshotsResult
extends AmazonWebServiceResult<ResponseMetadata>
implements Serializable, Cloneable

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

GetSnapshotsResult()

Constructors
Constructor and Description
`GetSnapshotsResult()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`GetSnapshotsResult`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getNextToken()` 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<List<String>>`	`getSnapshotsData()` The search metrics data.
`List<String>`	`getSnapshotsDataHeader()` The column headers for the search metrics data.
`TimeRange`	`getSnapShotTimeFilter()` The Unix timestamp for the beginning and end of the time window for the search metrics data.
`int`	`hashCode()`
`void`	`setNextToken(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.
`void`	`setSnapshotsData(Collection<List<String>> snapshotsData)` The search metrics data.
`void`	`setSnapshotsDataHeader(Collection<String> snapshotsDataHeader)` The column headers for the search metrics data.
`void`	`setSnapShotTimeFilter(TimeRange snapShotTimeFilter)` The Unix timestamp for the beginning and end of the time window for the search metrics data.
`String`	`toString()` Returns a string representation of this object.
`GetSnapshotsResult`	`withNextToken(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.
`GetSnapshotsResult`	`withSnapshotsData(Collection<List<String>> snapshotsData)` The search metrics data.
`GetSnapshotsResult`	`withSnapshotsData(List<String>... snapshotsData)` The search metrics data.
`GetSnapshotsResult`	`withSnapshotsDataHeader(Collection<String> snapshotsDataHeader)` The column headers for the search metrics data.
`GetSnapshotsResult`	`withSnapshotsDataHeader(String... snapshotsDataHeader)` The column headers for the search metrics data.
`GetSnapshotsResult`	`withSnapShotTimeFilter(TimeRange snapShotTimeFilter)` The Unix timestamp for the beginning and end of the time window for the search metrics data.

Methods inherited from class com.amazonaws.AmazonWebServiceResult
getSdkHttpMetadata, getSdkResponseMetadata, setSdkHttpMetadata, setSdkResponseMetadata

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - GetSnapshotsResult
```
public GetSnapshotsResult()
```
- Method Detail
  - setSnapShotTimeFilter
```
public void setSnapShotTimeFilter(TimeRange snapShotTimeFilter)
```
    The Unix timestamp for the beginning and end of the time window for the search metrics data.
    
    Parameters:
    
    snapShotTimeFilter - The Unix timestamp for the beginning and end of the time window for the search metrics data.
  - getSnapShotTimeFilter
```
public TimeRange getSnapShotTimeFilter()
```
    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.
  - withSnapShotTimeFilter
```
public GetSnapshotsResult withSnapShotTimeFilter(TimeRange snapShotTimeFilter)
```
    The Unix timestamp for the beginning and end of the time window for the search metrics data.
    
    Parameters:
    
    snapShotTimeFilter - The Unix timestamp for the beginning and end of the time window for the search metrics data.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getSnapshotsDataHeader
```
public List<String> getSnapshotsDataHeader()
```
    The column headers for the search metrics data.
    
    Returns:
    
    The column headers for the search metrics data.
  - setSnapshotsDataHeader
```
public void setSnapshotsDataHeader(Collection<String> snapshotsDataHeader)
```
    The column headers for the search metrics data.
    
    Parameters:
    
    snapshotsDataHeader - The column headers for the search metrics data.
  - withSnapshotsDataHeader
```
public GetSnapshotsResult withSnapshotsDataHeader(String... snapshotsDataHeader)
```
    The column headers for the search metrics data.
    
    NOTE: This method appends the values to the existing list (if any). Use setSnapshotsDataHeader(java.util.Collection) or withSnapshotsDataHeader(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    snapshotsDataHeader - The column headers for the search metrics data.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withSnapshotsDataHeader
```
public GetSnapshotsResult withSnapshotsDataHeader(Collection<String> snapshotsDataHeader)
```
    The column headers for the search metrics data.
    
    Parameters:
    
    snapshotsDataHeader - The column headers for the search metrics data.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getSnapshotsData
```
public List<List<String>> getSnapshotsData()
```
    The search metrics data. The data returned depends on the metric type you requested.
    
    Returns:
    
    The search metrics data. The data returned depends on the metric type you requested.
  - setSnapshotsData
```
public void setSnapshotsData(Collection<List<String>> snapshotsData)
```
    The search metrics data. The data returned depends on the metric type you requested.
    
    Parameters:
    
    snapshotsData - The search metrics data. The data returned depends on the metric type you requested.
  - withSnapshotsData
```
public GetSnapshotsResult withSnapshotsData(List<String>... snapshotsData)
```
    The search metrics data. The data returned depends on the metric type you requested.
    
    NOTE: This method appends the values to the existing list (if any). Use setSnapshotsData(java.util.Collection) or withSnapshotsData(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    snapshotsData - The search metrics data. The data returned depends on the metric type you requested.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withSnapshotsData
```
public GetSnapshotsResult withSnapshotsData(Collection<List<String>> snapshotsData)
```
    The search metrics data. The data returned depends on the metric type you requested.
    
    Parameters:
    
    snapshotsData - The search metrics data. The data returned depends on the metric type you requested.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setNextToken
```
public void setNextToken(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.
    
    Parameters:
    
    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.
  - getNextToken
```
public String getNextToken()
```
    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.
  - withNextToken
```
public GetSnapshotsResult withNextToken(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public GetSnapshotsResult clone()
```
    Overrides:
    
    clone in class Object

AWS SDK for Java 1.x API Reference - 1.12.773

Class GetSnapshotsResult

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceResult

Methods inherited from class java.lang.Object

Constructor Detail

GetSnapshotsResult

Method Detail

setSnapShotTimeFilter

getSnapShotTimeFilter

withSnapShotTimeFilter

getSnapshotsDataHeader

setSnapshotsDataHeader

withSnapshotsDataHeader

withSnapshotsDataHeader

getSnapshotsData

setSnapshotsData

withSnapshotsData

withSnapshotsData

setNextToken

getNextToken

withNextToken

toString

equals

hashCode

clone