com.amazonaws.services.kendra.model

Class GetSnapshotsRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.kendra.model.GetSnapshotsRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class GetSnapshotsRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
GetSnapshotsRequest()

Method Summary

Modifier and Type	Method and Description
GetSnapshotsRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
String	getIndexId() The identifier of the index to get search metrics data.
String	getInterval() The time interval or time window to get search metrics data.
Integer	getMaxResults() The maximum number of returned data for the metric.
String	getMetricType() The metric you want to retrieve.
String	getNextToken() If the previous response was incomplete (because there is more data to retrieve), Amazon Kendra returns a pagination token in the response.
int	hashCode()
void	setIndexId(String indexId) The identifier of the index to get search metrics data.
void	setInterval(String interval) The time interval or time window to get search metrics data.
void	setMaxResults(Integer maxResults) The maximum number of returned data for the metric.
void	setMetricType(String metricType) The metric you want to retrieve.
void	setNextToken(String nextToken) If the previous response was incomplete (because there is more data to retrieve), Amazon Kendra returns a pagination token in the response.
String	toString() Returns a string representation of this object.
GetSnapshotsRequest	withIndexId(String indexId) The identifier of the index to get search metrics data.
GetSnapshotsRequest	withInterval(Interval interval) The time interval or time window to get search metrics data.
GetSnapshotsRequest	withInterval(String interval) The time interval or time window to get search metrics data.
GetSnapshotsRequest	withMaxResults(Integer maxResults) The maximum number of returned data for the metric.
GetSnapshotsRequest	withMetricType(MetricType metricType) The metric you want to retrieve.
GetSnapshotsRequest	withMetricType(String metricType) The metric you want to retrieve.
GetSnapshotsRequest	withNextToken(String nextToken) If the previous response was incomplete (because there is more data to retrieve), Amazon Kendra returns a pagination token in the response.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

GetSnapshotsRequest

public GetSnapshotsRequest()

Method Detail

setIndexId

public void setIndexId(String indexId)

The identifier of the index to get search metrics data.

Parameters:

indexId - The identifier of the index to get search metrics data.

getIndexId

public String getIndexId()

The identifier of the index to get search metrics data.

Returns:

The identifier of the index to get search metrics data.

withIndexId

public GetSnapshotsRequest withIndexId(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.

setInterval

public void setInterval(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.

See Also:

Interval

getInterval

public String getInterval()

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:

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:

Interval

withInterval

public GetSnapshotsRequest withInterval(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

withInterval

public GetSnapshotsRequest withInterval(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:

Interval

setMetricType

public void setMetricType(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.

See Also:

MetricType

getMetricType

public String getMetricType()

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:

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:

MetricType

withMetricType

public GetSnapshotsRequest withMetricType(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

withMetricType

public GetSnapshotsRequest withMetricType(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:

MetricType

setNextToken

public void setNextToken(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.

getNextToken

public String getNextToken()

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.

withNextToken

public GetSnapshotsRequest withNextToken(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.

setMaxResults

public void setMaxResults(Integer maxResults)

The maximum number of returned data for the metric.

Parameters:

maxResults - The maximum number of returned data for the metric.

getMaxResults

public Integer getMaxResults()

The maximum number of returned data for the metric.

Returns:

The maximum number of returned data for the metric.

withMaxResults

public GetSnapshotsRequest withMaxResults(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.

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 GetSnapshotsRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()