Class ExperimentDefinitionSnapshot

java.lang.Object
software.amazon.awssdk.services.appconfig.model.ExperimentDefinitionSnapshot
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<ExperimentDefinitionSnapshot.Builder,ExperimentDefinitionSnapshot>
@Generated("software.amazon.awssdk:codegen") public final class ExperimentDefinitionSnapshot extends Object implements SdkPojo, Serializable, ToCopyableBuilder<ExperimentDefinitionSnapshot.Builder,ExperimentDefinitionSnapshot>

A snapshot of the experiment definition captured at the time an experiment run was started. This preserves the configuration that was active during the run.

See Also:

  • Method Details

    • applicationId

      public final String applicationId()

      The application ID at the time the run was started.

      Returns:
      The application ID at the time the run was started.

    • id

      public final String id()

      The experiment definition ID.

      Returns:
      The experiment definition ID.

    • name

      public final String name()

      The name of the experiment definition at the time the run was started.

      Returns:
      The name of the experiment definition at the time the run was started.

    • hypothesis

      public final String hypothesis()

      The hypothesis at the time the run was started.

      Returns:
      The hypothesis at the time the run was started.

    • configurationProfileId

      public final String configurationProfileId()

      The configuration profile ID at the time the run was started.

      Returns:
      The configuration profile ID at the time the run was started.

    • environmentId

      public final String environmentId()

      The environment ID at the time the run was started.

      Returns:
      The environment ID at the time the run was started.

    • flagKey

      public final String flagKey()

      The feature flag key at the time the run was started.

      Returns:
      The feature flag key at the time the run was started.

    • audienceRule

      public final String audienceRule()

      The audience rule at the time the run was started.

      Returns:
      The audience rule at the time the run was started.

    • audienceDescription

      public final String audienceDescription()

      The audience description at the time the run was started.

      Returns:
      The audience description at the time the run was started.

    • launchCriteria

      public final String launchCriteria()

      The launch criteria at the time the run was started.

      Returns:
      The launch criteria at the time the run was started.

    • hasTreatments

      public final boolean hasTreatments()
      For responses, this returns true if the service returned a value for the Treatments property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • treatments

      public final List<Treatment> treatments()

      The treatments at the time the run was started.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTreatments() method.

      Returns:
      The treatments at the time the run was started.

    • control

      public final Treatment control()

      The control treatment at the time the run was started.

      Returns:
      The control treatment at the time the run was started.

    • toBuilder

      public ExperimentDefinitionSnapshot.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<ExperimentDefinitionSnapshot.Builder,ExperimentDefinitionSnapshot>
      Returns:
      a builder for type T

    • builder

      public static ExperimentDefinitionSnapshot.Builder builder()

    • serializableBuilderClass

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

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

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

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

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.