com.amazonaws.services.cloudwatchevidently.model

Class GetExperimentResultsRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.cloudwatchevidently.model.GetExperimentResultsRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

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

Method Summary

Modifier and Type	Method and Description
GetExperimentResultsRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
String	getBaseStat() The statistic used to calculate experiment results.
Date	getEndTime() The date and time that the experiment ended, if it is completed.
String	getExperiment() The name of the experiment to retrieve the results of.
List<String>	getMetricNames() The names of the experiment metrics that you want to see the results of.
Long	getPeriod() In seconds, the amount of time to aggregate results together.
String	getProject() The name or ARN of the project that contains the experiment that you want to see the results of.
List<String>	getReportNames() The names of the report types that you want to see.
List<String>	getResultStats() The statistics that you want to see in the returned results.
Date	getStartTime() The date and time that the experiment started.
List<String>	getTreatmentNames() The names of the experiment treatments that you want to see the results for.
int	hashCode()
void	setBaseStat(String baseStat) The statistic used to calculate experiment results.
void	setEndTime(Date endTime) The date and time that the experiment ended, if it is completed.
void	setExperiment(String experiment) The name of the experiment to retrieve the results of.
void	setMetricNames(Collection<String> metricNames) The names of the experiment metrics that you want to see the results of.
void	setPeriod(Long period) In seconds, the amount of time to aggregate results together.
void	setProject(String project) The name or ARN of the project that contains the experiment that you want to see the results of.
void	setReportNames(Collection<String> reportNames) The names of the report types that you want to see.
void	setResultStats(Collection<String> resultStats) The statistics that you want to see in the returned results.
void	setStartTime(Date startTime) The date and time that the experiment started.
void	setTreatmentNames(Collection<String> treatmentNames) The names of the experiment treatments that you want to see the results for.
String	toString() Returns a string representation of this object.
GetExperimentResultsRequest	withBaseStat(ExperimentBaseStat baseStat) The statistic used to calculate experiment results.
GetExperimentResultsRequest	withBaseStat(String baseStat) The statistic used to calculate experiment results.
GetExperimentResultsRequest	withEndTime(Date endTime) The date and time that the experiment ended, if it is completed.
GetExperimentResultsRequest	withExperiment(String experiment) The name of the experiment to retrieve the results of.
GetExperimentResultsRequest	withMetricNames(Collection<String> metricNames) The names of the experiment metrics that you want to see the results of.
GetExperimentResultsRequest	withMetricNames(String... metricNames) The names of the experiment metrics that you want to see the results of.
GetExperimentResultsRequest	withPeriod(Long period) In seconds, the amount of time to aggregate results together.
GetExperimentResultsRequest	withProject(String project) The name or ARN of the project that contains the experiment that you want to see the results of.
GetExperimentResultsRequest	withReportNames(Collection<String> reportNames) The names of the report types that you want to see.
GetExperimentResultsRequest	withReportNames(ExperimentReportName... reportNames) The names of the report types that you want to see.
GetExperimentResultsRequest	withReportNames(String... reportNames) The names of the report types that you want to see.
GetExperimentResultsRequest	withResultStats(Collection<String> resultStats) The statistics that you want to see in the returned results.
GetExperimentResultsRequest	withResultStats(ExperimentResultRequestType... resultStats) The statistics that you want to see in the returned results.
GetExperimentResultsRequest	withResultStats(String... resultStats) The statistics that you want to see in the returned results.
GetExperimentResultsRequest	withStartTime(Date startTime) The date and time that the experiment started.
GetExperimentResultsRequest	withTreatmentNames(Collection<String> treatmentNames) The names of the experiment treatments that you want to see the results for.
GetExperimentResultsRequest	withTreatmentNames(String... treatmentNames) The names of the experiment treatments that you want to see the results for.

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

GetExperimentResultsRequest

public GetExperimentResultsRequest()

Method Detail

setBaseStat

public void setBaseStat(String baseStat)

The statistic used to calculate experiment results. Currently the only valid value is mean, which uses the mean of the collected values as the statistic.

Parameters:

baseStat - The statistic used to calculate experiment results. Currently the only valid value is mean, which uses the mean of the collected values as the statistic.

See Also:

ExperimentBaseStat

getBaseStat

public String getBaseStat()

The statistic used to calculate experiment results. Currently the only valid value is mean, which uses the mean of the collected values as the statistic.

Returns:

The statistic used to calculate experiment results. Currently the only valid value is mean, which uses the mean of the collected values as the statistic.

See Also:

ExperimentBaseStat

withBaseStat

public GetExperimentResultsRequest withBaseStat(String baseStat)

The statistic used to calculate experiment results. Currently the only valid value is mean, which uses the mean of the collected values as the statistic.

Parameters:

baseStat - The statistic used to calculate experiment results. Currently the only valid value is mean, which uses the mean of the collected values as the statistic.

Returns:

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

See Also:

ExperimentBaseStat

withBaseStat

public GetExperimentResultsRequest withBaseStat(ExperimentBaseStat baseStat)

The statistic used to calculate experiment results. Currently the only valid value is mean, which uses the mean of the collected values as the statistic.

Parameters:

baseStat - The statistic used to calculate experiment results. Currently the only valid value is mean, which uses the mean of the collected values as the statistic.

Returns:

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

See Also:

ExperimentBaseStat

setEndTime

public void setEndTime(Date endTime)

The date and time that the experiment ended, if it is completed. This must be no longer than 30 days after the experiment start time.

Parameters:

endTime - The date and time that the experiment ended, if it is completed. This must be no longer than 30 days after the experiment start time.

getEndTime

public Date getEndTime()

The date and time that the experiment ended, if it is completed. This must be no longer than 30 days after the experiment start time.

Returns:

The date and time that the experiment ended, if it is completed. This must be no longer than 30 days after the experiment start time.

withEndTime

public GetExperimentResultsRequest withEndTime(Date endTime)

The date and time that the experiment ended, if it is completed. This must be no longer than 30 days after the experiment start time.

Parameters:

endTime - The date and time that the experiment ended, if it is completed. This must be no longer than 30 days after the experiment start time.

Returns:

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

setExperiment

public void setExperiment(String experiment)

The name of the experiment to retrieve the results of.

Parameters:

experiment - The name of the experiment to retrieve the results of.

getExperiment

public String getExperiment()

The name of the experiment to retrieve the results of.

Returns:

The name of the experiment to retrieve the results of.

withExperiment

public GetExperimentResultsRequest withExperiment(String experiment)

The name of the experiment to retrieve the results of.

Parameters:

experiment - The name of the experiment to retrieve the results of.

Returns:

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

getMetricNames

public List<String> getMetricNames()

The names of the experiment metrics that you want to see the results of.

Returns:

The names of the experiment metrics that you want to see the results of.

setMetricNames

public void setMetricNames(Collection<String> metricNames)

The names of the experiment metrics that you want to see the results of.

Parameters:

metricNames - The names of the experiment metrics that you want to see the results of.

withMetricNames

public GetExperimentResultsRequest withMetricNames(String... metricNames)

The names of the experiment metrics that you want to see the results of.

NOTE: This method appends the values to the existing list (if any). Use setMetricNames(java.util.Collection) or withMetricNames(java.util.Collection) if you want to override the existing values.

Parameters:

metricNames - The names of the experiment metrics that you want to see the results of.

Returns:

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

withMetricNames

public GetExperimentResultsRequest withMetricNames(Collection<String> metricNames)

The names of the experiment metrics that you want to see the results of.

Parameters:

metricNames - The names of the experiment metrics that you want to see the results of.

Returns:

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

setPeriod

public void setPeriod(Long period)

In seconds, the amount of time to aggregate results together.

Parameters:

period - In seconds, the amount of time to aggregate results together.

getPeriod

public Long getPeriod()

In seconds, the amount of time to aggregate results together.

Returns:

In seconds, the amount of time to aggregate results together.

withPeriod

public GetExperimentResultsRequest withPeriod(Long period)

In seconds, the amount of time to aggregate results together.

Parameters:

period - In seconds, the amount of time to aggregate results together.

Returns:

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

setProject

public void setProject(String project)

The name or ARN of the project that contains the experiment that you want to see the results of.

Parameters:

project - The name or ARN of the project that contains the experiment that you want to see the results of.

getProject

public String getProject()

The name or ARN of the project that contains the experiment that you want to see the results of.

Returns:

The name or ARN of the project that contains the experiment that you want to see the results of.

withProject

public GetExperimentResultsRequest withProject(String project)

The name or ARN of the project that contains the experiment that you want to see the results of.

Parameters:

project - The name or ARN of the project that contains the experiment that you want to see the results of.

Returns:

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

getReportNames

public List<String> getReportNames()

The names of the report types that you want to see. Currently, BayesianInference is the only valid value.

Returns:

The names of the report types that you want to see. Currently, BayesianInference is the only valid value.

See Also:

ExperimentReportName

setReportNames

public void setReportNames(Collection<String> reportNames)

The names of the report types that you want to see. Currently, BayesianInference is the only valid value.

Parameters:

reportNames - The names of the report types that you want to see. Currently, BayesianInference is the only valid value.

See Also:

ExperimentReportName

withReportNames

public GetExperimentResultsRequest withReportNames(String... reportNames)

The names of the report types that you want to see. Currently, BayesianInference is the only valid value.

NOTE: This method appends the values to the existing list (if any). Use setReportNames(java.util.Collection) or withReportNames(java.util.Collection) if you want to override the existing values.

Parameters:

reportNames - The names of the report types that you want to see. Currently, BayesianInference is the only valid value.

Returns:

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

See Also:

ExperimentReportName

withReportNames

public GetExperimentResultsRequest withReportNames(Collection<String> reportNames)

The names of the report types that you want to see. Currently, BayesianInference is the only valid value.

Parameters:

reportNames - The names of the report types that you want to see. Currently, BayesianInference is the only valid value.

Returns:

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

See Also:

ExperimentReportName

withReportNames

public GetExperimentResultsRequest withReportNames(ExperimentReportName... reportNames)

The names of the report types that you want to see. Currently, BayesianInference is the only valid value.

Parameters:

reportNames - The names of the report types that you want to see. Currently, BayesianInference is the only valid value.

Returns:

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

See Also:

ExperimentReportName

getResultStats

public List<String> getResultStats()

The statistics that you want to see in the returned results.

• PValue specifies to use p-values for the results. A p-value is used in hypothesis testing to measure how often you are willing to make a mistake in rejecting the null hypothesis. A general practice is to reject the null hypothesis and declare that the results are statistically significant when the p-value is less than 0.05.

• ConfidenceInterval specifies a confidence interval for the results. The confidence interval represents the range of values for the chosen metric that is likely to contain the true difference between the baseStat of a variation and the baseline. Evidently returns the 95% confidence interval.

• TreatmentEffect is the difference in the statistic specified by the baseStat parameter between each variation and the default variation.

• BaseStat returns the statistical values collected for the metric for each variation. The statistic uses the same statistic specified in the baseStat parameter. Therefore, if baseStat is mean, this returns the mean of the values collected for each variation.

Returns:

The statistics that you want to see in the returned results.

• PValue specifies to use p-values for the results. A p-value is used in hypothesis testing to measure how often you are willing to make a mistake in rejecting the null hypothesis. A general practice is to reject the null hypothesis and declare that the results are statistically significant when the p-value is less than 0.05.

• ConfidenceInterval specifies a confidence interval for the results. The confidence interval represents the range of values for the chosen metric that is likely to contain the true difference between the baseStat of a variation and the baseline. Evidently returns the 95% confidence interval.

• TreatmentEffect is the difference in the statistic specified by the baseStat parameter between each variation and the default variation.

• BaseStat returns the statistical values collected for the metric for each variation. The statistic uses the same statistic specified in the baseStat parameter. Therefore, if baseStat is mean, this returns the mean of the values collected for each variation.

See Also:

ExperimentResultRequestType

setResultStats

public void setResultStats(Collection<String> resultStats)

The statistics that you want to see in the returned results.

• PValue specifies to use p-values for the results. A p-value is used in hypothesis testing to measure how often you are willing to make a mistake in rejecting the null hypothesis. A general practice is to reject the null hypothesis and declare that the results are statistically significant when the p-value is less than 0.05.

• ConfidenceInterval specifies a confidence interval for the results. The confidence interval represents the range of values for the chosen metric that is likely to contain the true difference between the baseStat of a variation and the baseline. Evidently returns the 95% confidence interval.

• TreatmentEffect is the difference in the statistic specified by the baseStat parameter between each variation and the default variation.

• BaseStat returns the statistical values collected for the metric for each variation. The statistic uses the same statistic specified in the baseStat parameter. Therefore, if baseStat is mean, this returns the mean of the values collected for each variation.

Parameters:

resultStats - The statistics that you want to see in the returned results.

• PValue specifies to use p-values for the results. A p-value is used in hypothesis testing to measure how often you are willing to make a mistake in rejecting the null hypothesis. A general practice is to reject the null hypothesis and declare that the results are statistically significant when the p-value is less than 0.05.

• ConfidenceInterval specifies a confidence interval for the results. The confidence interval represents the range of values for the chosen metric that is likely to contain the true difference between the baseStat of a variation and the baseline. Evidently returns the 95% confidence interval.

• TreatmentEffect is the difference in the statistic specified by the baseStat parameter between each variation and the default variation.

• BaseStat returns the statistical values collected for the metric for each variation. The statistic uses the same statistic specified in the baseStat parameter. Therefore, if baseStat is mean, this returns the mean of the values collected for each variation.

See Also:

ExperimentResultRequestType

withResultStats

public GetExperimentResultsRequest withResultStats(String... resultStats)

The statistics that you want to see in the returned results.

• PValue specifies to use p-values for the results. A p-value is used in hypothesis testing to measure how often you are willing to make a mistake in rejecting the null hypothesis. A general practice is to reject the null hypothesis and declare that the results are statistically significant when the p-value is less than 0.05.

• ConfidenceInterval specifies a confidence interval for the results. The confidence interval represents the range of values for the chosen metric that is likely to contain the true difference between the baseStat of a variation and the baseline. Evidently returns the 95% confidence interval.

• TreatmentEffect is the difference in the statistic specified by the baseStat parameter between each variation and the default variation.

• BaseStat returns the statistical values collected for the metric for each variation. The statistic uses the same statistic specified in the baseStat parameter. Therefore, if baseStat is mean, this returns the mean of the values collected for each variation.

NOTE: This method appends the values to the existing list (if any). Use setResultStats(java.util.Collection) or withResultStats(java.util.Collection) if you want to override the existing values.

Parameters:

resultStats - The statistics that you want to see in the returned results.

• PValue specifies to use p-values for the results. A p-value is used in hypothesis testing to measure how often you are willing to make a mistake in rejecting the null hypothesis. A general practice is to reject the null hypothesis and declare that the results are statistically significant when the p-value is less than 0.05.

• ConfidenceInterval specifies a confidence interval for the results. The confidence interval represents the range of values for the chosen metric that is likely to contain the true difference between the baseStat of a variation and the baseline. Evidently returns the 95% confidence interval.

• TreatmentEffect is the difference in the statistic specified by the baseStat parameter between each variation and the default variation.

• BaseStat returns the statistical values collected for the metric for each variation. The statistic uses the same statistic specified in the baseStat parameter. Therefore, if baseStat is mean, this returns the mean of the values collected for each variation.

Returns:

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

See Also:

ExperimentResultRequestType

withResultStats

public GetExperimentResultsRequest withResultStats(Collection<String> resultStats)

The statistics that you want to see in the returned results.

• PValue specifies to use p-values for the results. A p-value is used in hypothesis testing to measure how often you are willing to make a mistake in rejecting the null hypothesis. A general practice is to reject the null hypothesis and declare that the results are statistically significant when the p-value is less than 0.05.

• ConfidenceInterval specifies a confidence interval for the results. The confidence interval represents the range of values for the chosen metric that is likely to contain the true difference between the baseStat of a variation and the baseline. Evidently returns the 95% confidence interval.

• TreatmentEffect is the difference in the statistic specified by the baseStat parameter between each variation and the default variation.

• BaseStat returns the statistical values collected for the metric for each variation. The statistic uses the same statistic specified in the baseStat parameter. Therefore, if baseStat is mean, this returns the mean of the values collected for each variation.

Parameters:

resultStats - The statistics that you want to see in the returned results.

• PValue specifies to use p-values for the results. A p-value is used in hypothesis testing to measure how often you are willing to make a mistake in rejecting the null hypothesis. A general practice is to reject the null hypothesis and declare that the results are statistically significant when the p-value is less than 0.05.

• ConfidenceInterval specifies a confidence interval for the results. The confidence interval represents the range of values for the chosen metric that is likely to contain the true difference between the baseStat of a variation and the baseline. Evidently returns the 95% confidence interval.

• TreatmentEffect is the difference in the statistic specified by the baseStat parameter between each variation and the default variation.

• BaseStat returns the statistical values collected for the metric for each variation. The statistic uses the same statistic specified in the baseStat parameter. Therefore, if baseStat is mean, this returns the mean of the values collected for each variation.

Returns:

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

See Also:

ExperimentResultRequestType

withResultStats

public GetExperimentResultsRequest withResultStats(ExperimentResultRequestType... resultStats)

The statistics that you want to see in the returned results.

• PValue specifies to use p-values for the results. A p-value is used in hypothesis testing to measure how often you are willing to make a mistake in rejecting the null hypothesis. A general practice is to reject the null hypothesis and declare that the results are statistically significant when the p-value is less than 0.05.

• ConfidenceInterval specifies a confidence interval for the results. The confidence interval represents the range of values for the chosen metric that is likely to contain the true difference between the baseStat of a variation and the baseline. Evidently returns the 95% confidence interval.

• TreatmentEffect is the difference in the statistic specified by the baseStat parameter between each variation and the default variation.

• BaseStat returns the statistical values collected for the metric for each variation. The statistic uses the same statistic specified in the baseStat parameter. Therefore, if baseStat is mean, this returns the mean of the values collected for each variation.

Parameters:

resultStats - The statistics that you want to see in the returned results.

• PValue specifies to use p-values for the results. A p-value is used in hypothesis testing to measure how often you are willing to make a mistake in rejecting the null hypothesis. A general practice is to reject the null hypothesis and declare that the results are statistically significant when the p-value is less than 0.05.

• ConfidenceInterval specifies a confidence interval for the results. The confidence interval represents the range of values for the chosen metric that is likely to contain the true difference between the baseStat of a variation and the baseline. Evidently returns the 95% confidence interval.

• TreatmentEffect is the difference in the statistic specified by the baseStat parameter between each variation and the default variation.

• BaseStat returns the statistical values collected for the metric for each variation. The statistic uses the same statistic specified in the baseStat parameter. Therefore, if baseStat is mean, this returns the mean of the values collected for each variation.

Returns:

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

See Also:

ExperimentResultRequestType

setStartTime

public void setStartTime(Date startTime)

The date and time that the experiment started.

Parameters:

startTime - The date and time that the experiment started.

getStartTime

public Date getStartTime()

The date and time that the experiment started.

Returns:

The date and time that the experiment started.

withStartTime

public GetExperimentResultsRequest withStartTime(Date startTime)

The date and time that the experiment started.

Parameters:

startTime - The date and time that the experiment started.

Returns:

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

getTreatmentNames

public List<String> getTreatmentNames()

The names of the experiment treatments that you want to see the results for.

Returns:

The names of the experiment treatments that you want to see the results for.

setTreatmentNames

public void setTreatmentNames(Collection<String> treatmentNames)

The names of the experiment treatments that you want to see the results for.

Parameters:

treatmentNames - The names of the experiment treatments that you want to see the results for.

withTreatmentNames

public GetExperimentResultsRequest withTreatmentNames(String... treatmentNames)

The names of the experiment treatments that you want to see the results for.

NOTE: This method appends the values to the existing list (if any). Use setTreatmentNames(java.util.Collection) or withTreatmentNames(java.util.Collection) if you want to override the existing values.

Parameters:

treatmentNames - The names of the experiment treatments that you want to see the results for.

Returns:

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

withTreatmentNames

public GetExperimentResultsRequest withTreatmentNames(Collection<String> treatmentNames)

The names of the experiment treatments that you want to see the results for.

Parameters:

treatmentNames - The names of the experiment treatments that you want to see the results for.

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