com.amazonaws.services.cloudtrail.model

Class ListInsightsMetricDataRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.cloudtrail.model.ListInsightsMetricDataRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class ListInsightsMetricDataRequest
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
ListInsightsMetricDataRequest()

Method Summary

Modifier and Type	Method and Description
ListInsightsMetricDataRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
String	getDataType() Type of datapoints to return.
Date	getEndTime() Specifies, in UTC, the end time for time-series data.
String	getErrorCode() Conditionally required if the InsightType parameter is set to ApiErrorRateInsight.
String	getEventName() The name of the event, typically the Amazon Web Services API on which unusual levels of activity were recorded.
String	getEventSource() The Amazon Web Services service to which the request was made, such as iam.amazonaws.com or s3.amazonaws.com.
String	getInsightType() The type of CloudTrail Insights event, which is either ApiCallRateInsight or ApiErrorRateInsight.
Integer	getMaxResults() The maximum number of datapoints to return.
String	getNextToken() Returned if all datapoints can't be returned in a single call.
Integer	getPeriod() Granularity of data to retrieve, in seconds.
Date	getStartTime() Specifies, in UTC, the start time for time-series data.
int	hashCode()
void	setDataType(String dataType) Type of datapoints to return.
void	setEndTime(Date endTime) Specifies, in UTC, the end time for time-series data.
void	setErrorCode(String errorCode) Conditionally required if the InsightType parameter is set to ApiErrorRateInsight.
void	setEventName(String eventName) The name of the event, typically the Amazon Web Services API on which unusual levels of activity were recorded.
void	setEventSource(String eventSource) The Amazon Web Services service to which the request was made, such as iam.amazonaws.com or s3.amazonaws.com.
void	setInsightType(String insightType) The type of CloudTrail Insights event, which is either ApiCallRateInsight or ApiErrorRateInsight.
void	setMaxResults(Integer maxResults) The maximum number of datapoints to return.
void	setNextToken(String nextToken) Returned if all datapoints can't be returned in a single call.
void	setPeriod(Integer period) Granularity of data to retrieve, in seconds.
void	setStartTime(Date startTime) Specifies, in UTC, the start time for time-series data.
String	toString() Returns a string representation of this object.
ListInsightsMetricDataRequest	withDataType(InsightsMetricDataType dataType) Type of datapoints to return.
ListInsightsMetricDataRequest	withDataType(String dataType) Type of datapoints to return.
ListInsightsMetricDataRequest	withEndTime(Date endTime) Specifies, in UTC, the end time for time-series data.
ListInsightsMetricDataRequest	withErrorCode(String errorCode) Conditionally required if the InsightType parameter is set to ApiErrorRateInsight.
ListInsightsMetricDataRequest	withEventName(String eventName) The name of the event, typically the Amazon Web Services API on which unusual levels of activity were recorded.
ListInsightsMetricDataRequest	withEventSource(String eventSource) The Amazon Web Services service to which the request was made, such as iam.amazonaws.com or s3.amazonaws.com.
ListInsightsMetricDataRequest	withInsightType(InsightType insightType) The type of CloudTrail Insights event, which is either ApiCallRateInsight or ApiErrorRateInsight.
ListInsightsMetricDataRequest	withInsightType(String insightType) The type of CloudTrail Insights event, which is either ApiCallRateInsight or ApiErrorRateInsight.
ListInsightsMetricDataRequest	withMaxResults(Integer maxResults) The maximum number of datapoints to return.
ListInsightsMetricDataRequest	withNextToken(String nextToken) Returned if all datapoints can't be returned in a single call.
ListInsightsMetricDataRequest	withPeriod(Integer period) Granularity of data to retrieve, in seconds.
ListInsightsMetricDataRequest	withStartTime(Date startTime) Specifies, in UTC, the start time for time-series data.

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

ListInsightsMetricDataRequest

public ListInsightsMetricDataRequest()

Method Detail

setEventSource

public void setEventSource(String eventSource)

The Amazon Web Services service to which the request was made, such as iam.amazonaws.com or s3.amazonaws.com.

Parameters:

eventSource - The Amazon Web Services service to which the request was made, such as iam.amazonaws.com or s3.amazonaws.com.

getEventSource

public String getEventSource()

The Amazon Web Services service to which the request was made, such as iam.amazonaws.com or s3.amazonaws.com.

Returns:

The Amazon Web Services service to which the request was made, such as iam.amazonaws.com or s3.amazonaws.com.

withEventSource

public ListInsightsMetricDataRequest withEventSource(String eventSource)

The Amazon Web Services service to which the request was made, such as iam.amazonaws.com or s3.amazonaws.com.

Parameters:

eventSource - The Amazon Web Services service to which the request was made, such as iam.amazonaws.com or s3.amazonaws.com.

Returns:

Returns a reference to this object so that method calls can be chained together.

setEventName

public void setEventName(String eventName)

The name of the event, typically the Amazon Web Services API on which unusual levels of activity were recorded.

Parameters:

eventName - The name of the event, typically the Amazon Web Services API on which unusual levels of activity were recorded.

getEventName

public String getEventName()

The name of the event, typically the Amazon Web Services API on which unusual levels of activity were recorded.

Returns:

The name of the event, typically the Amazon Web Services API on which unusual levels of activity were recorded.

withEventName

public ListInsightsMetricDataRequest withEventName(String eventName)

The name of the event, typically the Amazon Web Services API on which unusual levels of activity were recorded.

Parameters:

eventName - The name of the event, typically the Amazon Web Services API on which unusual levels of activity were recorded.

Returns:

Returns a reference to this object so that method calls can be chained together.

setInsightType

public void setInsightType(String insightType)

The type of CloudTrail Insights event, which is either ApiCallRateInsight or ApiErrorRateInsight. The ApiCallRateInsight Insights type analyzes write-only management API calls that are aggregated per minute against a baseline API call volume. The ApiErrorRateInsight Insights type analyzes management API calls that result in error codes.

Parameters:

insightType - The type of CloudTrail Insights event, which is either ApiCallRateInsight or ApiErrorRateInsight. The ApiCallRateInsight Insights type analyzes write-only management API calls that are aggregated per minute against a baseline API call volume. The ApiErrorRateInsight Insights type analyzes management API calls that result in error codes.

See Also:

InsightType

getInsightType

public String getInsightType()

The type of CloudTrail Insights event, which is either ApiCallRateInsight or ApiErrorRateInsight. The ApiCallRateInsight Insights type analyzes write-only management API calls that are aggregated per minute against a baseline API call volume. The ApiErrorRateInsight Insights type analyzes management API calls that result in error codes.

Returns:

The type of CloudTrail Insights event, which is either ApiCallRateInsight or ApiErrorRateInsight. The ApiCallRateInsight Insights type analyzes write-only management API calls that are aggregated per minute against a baseline API call volume. The ApiErrorRateInsight Insights type analyzes management API calls that result in error codes.

See Also:

InsightType

withInsightType

public ListInsightsMetricDataRequest withInsightType(String insightType)

The type of CloudTrail Insights event, which is either ApiCallRateInsight or ApiErrorRateInsight. The ApiCallRateInsight Insights type analyzes write-only management API calls that are aggregated per minute against a baseline API call volume. The ApiErrorRateInsight Insights type analyzes management API calls that result in error codes.

Parameters:

insightType - The type of CloudTrail Insights event, which is either ApiCallRateInsight or ApiErrorRateInsight. The ApiCallRateInsight Insights type analyzes write-only management API calls that are aggregated per minute against a baseline API call volume. The ApiErrorRateInsight Insights type analyzes management API calls that result in error codes.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

InsightType

withInsightType

public ListInsightsMetricDataRequest withInsightType(InsightType insightType)

The type of CloudTrail Insights event, which is either ApiCallRateInsight or ApiErrorRateInsight. The ApiCallRateInsight Insights type analyzes write-only management API calls that are aggregated per minute against a baseline API call volume. The ApiErrorRateInsight Insights type analyzes management API calls that result in error codes.

Parameters:

insightType - The type of CloudTrail Insights event, which is either ApiCallRateInsight or ApiErrorRateInsight. The ApiCallRateInsight Insights type analyzes write-only management API calls that are aggregated per minute against a baseline API call volume. The ApiErrorRateInsight Insights type analyzes management API calls that result in error codes.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

InsightType

setErrorCode

public void setErrorCode(String errorCode)

Conditionally required if the InsightType parameter is set to ApiErrorRateInsight.

If returning metrics for the ApiErrorRateInsight Insights type, this is the error to retrieve data for. For example, AccessDenied.

Parameters:

errorCode - Conditionally required if the InsightType parameter is set to ApiErrorRateInsight.

If returning metrics for the ApiErrorRateInsight Insights type, this is the error to retrieve data for. For example, AccessDenied.

getErrorCode

public String getErrorCode()

Conditionally required if the InsightType parameter is set to ApiErrorRateInsight.

If returning metrics for the ApiErrorRateInsight Insights type, this is the error to retrieve data for. For example, AccessDenied.

Returns:

Conditionally required if the InsightType parameter is set to ApiErrorRateInsight.

If returning metrics for the ApiErrorRateInsight Insights type, this is the error to retrieve data for. For example, AccessDenied.

withErrorCode

public ListInsightsMetricDataRequest withErrorCode(String errorCode)

Conditionally required if the InsightType parameter is set to ApiErrorRateInsight.

If returning metrics for the ApiErrorRateInsight Insights type, this is the error to retrieve data for. For example, AccessDenied.

Parameters:

errorCode - Conditionally required if the InsightType parameter is set to ApiErrorRateInsight.

If returning metrics for the ApiErrorRateInsight Insights type, this is the error to retrieve data for. For example, AccessDenied.

Returns:

Returns a reference to this object so that method calls can be chained together.

setStartTime

public void setStartTime(Date startTime)

Specifies, in UTC, the start time for time-series data. The value specified is inclusive; results include data points with the specified time stamp.

The default is 90 days before the time of request.

Parameters:

startTime - Specifies, in UTC, the start time for time-series data. The value specified is inclusive; results include data points with the specified time stamp.

The default is 90 days before the time of request.

getStartTime

public Date getStartTime()

Specifies, in UTC, the start time for time-series data. The value specified is inclusive; results include data points with the specified time stamp.

The default is 90 days before the time of request.

Returns:

Specifies, in UTC, the start time for time-series data. The value specified is inclusive; results include data points with the specified time stamp.

The default is 90 days before the time of request.

withStartTime

public ListInsightsMetricDataRequest withStartTime(Date startTime)

Specifies, in UTC, the start time for time-series data. The value specified is inclusive; results include data points with the specified time stamp.

The default is 90 days before the time of request.

Parameters:

startTime - Specifies, in UTC, the start time for time-series data. The value specified is inclusive; results include data points with the specified time stamp.

The default is 90 days before the time of request.

Returns:

Returns a reference to this object so that method calls can be chained together.

setEndTime

public void setEndTime(Date endTime)

Specifies, in UTC, the end time for time-series data. The value specified is exclusive; results include data points up to the specified time stamp.

The default is the time of request.

Parameters:

endTime - Specifies, in UTC, the end time for time-series data. The value specified is exclusive; results include data points up to the specified time stamp.

The default is the time of request.

getEndTime

public Date getEndTime()

Specifies, in UTC, the end time for time-series data. The value specified is exclusive; results include data points up to the specified time stamp.

The default is the time of request.

Returns:

Specifies, in UTC, the end time for time-series data. The value specified is exclusive; results include data points up to the specified time stamp.

The default is the time of request.

withEndTime

public ListInsightsMetricDataRequest withEndTime(Date endTime)

Specifies, in UTC, the end time for time-series data. The value specified is exclusive; results include data points up to the specified time stamp.

The default is the time of request.

Parameters:

endTime - Specifies, in UTC, the end time for time-series data. The value specified is exclusive; results include data points up to the specified time stamp.

The default is the time of request.

Returns:

Returns a reference to this object so that method calls can be chained together.

setPeriod

public void setPeriod(Integer period)

Granularity of data to retrieve, in seconds. Valid values are 60, 300, and 3600. If you specify any other value, you will get an error. The default is 3600 seconds.

Parameters:

period - Granularity of data to retrieve, in seconds. Valid values are 60, 300, and 3600. If you specify any other value, you will get an error. The default is 3600 seconds.

getPeriod

public Integer getPeriod()

Granularity of data to retrieve, in seconds. Valid values are 60, 300, and 3600. If you specify any other value, you will get an error. The default is 3600 seconds.

Returns:

Granularity of data to retrieve, in seconds. Valid values are 60, 300, and 3600. If you specify any other value, you will get an error. The default is 3600 seconds.

withPeriod

public ListInsightsMetricDataRequest withPeriod(Integer period)

Granularity of data to retrieve, in seconds. Valid values are 60, 300, and 3600. If you specify any other value, you will get an error. The default is 3600 seconds.

Parameters:

period - Granularity of data to retrieve, in seconds. Valid values are 60, 300, and 3600. If you specify any other value, you will get an error. The default is 3600 seconds.

Returns:

Returns a reference to this object so that method calls can be chained together.

setDataType

public void setDataType(String dataType)

Type of datapoints to return. Valid values are NonZeroData and FillWithZeros. The default is NonZeroData.

Parameters:

dataType - Type of datapoints to return. Valid values are NonZeroData and FillWithZeros. The default is NonZeroData.

See Also:

InsightsMetricDataType

getDataType

public String getDataType()

Type of datapoints to return. Valid values are NonZeroData and FillWithZeros. The default is NonZeroData.

Returns:

Type of datapoints to return. Valid values are NonZeroData and FillWithZeros. The default is NonZeroData.

See Also:

InsightsMetricDataType

withDataType

public ListInsightsMetricDataRequest withDataType(String dataType)

Type of datapoints to return. Valid values are NonZeroData and FillWithZeros. The default is NonZeroData.

Parameters:

dataType - Type of datapoints to return. Valid values are NonZeroData and FillWithZeros. The default is NonZeroData.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

InsightsMetricDataType

withDataType

public ListInsightsMetricDataRequest withDataType(InsightsMetricDataType dataType)

Type of datapoints to return. Valid values are NonZeroData and FillWithZeros. The default is NonZeroData.

Parameters:

dataType - Type of datapoints to return. Valid values are NonZeroData and FillWithZeros. The default is NonZeroData.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

InsightsMetricDataType

setMaxResults

public void setMaxResults(Integer maxResults)

The maximum number of datapoints to return. Valid values are integers from 1 to 21600. The default value is 21600.

Parameters:

maxResults - The maximum number of datapoints to return. Valid values are integers from 1 to 21600. The default value is 21600.

getMaxResults

public Integer getMaxResults()

The maximum number of datapoints to return. Valid values are integers from 1 to 21600. The default value is 21600.

Returns:

The maximum number of datapoints to return. Valid values are integers from 1 to 21600. The default value is 21600.

withMaxResults

public ListInsightsMetricDataRequest withMaxResults(Integer maxResults)

The maximum number of datapoints to return. Valid values are integers from 1 to 21600. The default value is 21600.

Parameters:

maxResults - The maximum number of datapoints to return. Valid values are integers from 1 to 21600. The default value is 21600.

Returns:

Returns a reference to this object so that method calls can be chained together.

setNextToken

public void setNextToken(String nextToken)

Returned if all datapoints can't be returned in a single call. For example, due to reaching MaxResults.

Add this parameter to the request to continue retrieving results starting from the last evaluated point.

Parameters:

nextToken - Returned if all datapoints can't be returned in a single call. For example, due to reaching MaxResults.

Add this parameter to the request to continue retrieving results starting from the last evaluated point.

getNextToken

public String getNextToken()

Returned if all datapoints can't be returned in a single call. For example, due to reaching MaxResults.

Add this parameter to the request to continue retrieving results starting from the last evaluated point.

Returns:

Returned if all datapoints can't be returned in a single call. For example, due to reaching MaxResults.

Add this parameter to the request to continue retrieving results starting from the last evaluated point.

withNextToken

public ListInsightsMetricDataRequest withNextToken(String nextToken)

Returned if all datapoints can't be returned in a single call. For example, due to reaching MaxResults.

Add this parameter to the request to continue retrieving results starting from the last evaluated point.

Parameters:

nextToken - Returned if all datapoints can't be returned in a single call. For example, due to reaching MaxResults.

Add this parameter to the request to continue retrieving results starting from the last evaluated point.

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 ListInsightsMetricDataRequest 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()