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>

  • Method Details

    • 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:

    • 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:

    • 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()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<StopExperimentRequest.Builder,StopExperimentRequest>
      Specified by:
      toBuilder in class EvidentlyRequest
      Returns:
      a builder for type T

    • 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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.