Package software.amazon.awssdk.services.evidently.model

Class StopExperimentRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.evidently.model.EvidentlyRequest

software.amazon.awssdk.services.evidently.model.StopExperimentRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<StopExperimentRequest.Builder,StopExperimentRequest>

@Generated("software.amazon.awssdk:codegen")
public final class StopExperimentRequest
extends EvidentlyRequest
implements ToCopyableBuilder<StopExperimentRequest.Builder,StopExperimentRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	StopExperimentRequest.Builder

Method Summary

Modifier and Type	Method	Description
static StopExperimentRequest.Builder	builder()
ExperimentStopDesiredState	desiredState()	Specify whether the experiment is to be considered COMPLETED or CANCELLED after it stops.
String	desiredStateAsString()	Specify whether the experiment is to be considered COMPLETED or CANCELLED after it stops.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	experiment()	The name of the experiment to stop.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	project()	The name or ARN of the project that contains the experiment to stop.
String	reason()	A string that describes why you are stopping the experiment.
List<SdkField<?>>	sdkFields()
static Class<? extends StopExperimentRequest.Builder>	serializableBuilderClass()
StopExperimentRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

desiredState

public final ExperimentStopDesiredState desiredState()

Specify whether the experiment is to be considered COMPLETED or CANCELLED after it stops.

If the service returns an enum value that is not available in the current SDK version, desiredState will return ExperimentStopDesiredState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from desiredStateAsString().

Returns:

Specify whether the experiment is to be considered COMPLETED or CANCELLED after it stops.

See Also:

ExperimentStopDesiredState

desiredStateAsString

public final String desiredStateAsString()

Specify whether the experiment is to be considered COMPLETED or CANCELLED after it stops.

If the service returns an enum value that is not available in the current SDK version, desiredState will return ExperimentStopDesiredState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from desiredStateAsString().

Returns:

Specify whether the experiment is to be considered COMPLETED or CANCELLED after it stops.

See Also:

ExperimentStopDesiredState

experiment

public final String experiment()

The name of the experiment to stop.

Returns:

The name of the experiment to stop.

project

public final String project()

The name or ARN of the project that contains the experiment to stop.

Returns:

The name or ARN of the project that contains the experiment to stop.

reason

public final String reason()

A string that describes why you are stopping the experiment.

Returns:

A string that describes why you are stopping the experiment.

toBuilder

public StopExperimentRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<StopExperimentRequest.Builder,StopExperimentRequest>

Specified by:

toBuilder in class EvidentlyRequest

builder

public static StopExperimentRequest.Builder builder()

serializableBuilderClass

public static Class<? extends StopExperimentRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final 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

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo