Class GetExperimentDefinitionResponse

java.lang.Object
software.amazon.awssdk.core.SdkResponse
software.amazon.awssdk.awscore.AwsResponse
software.amazon.awssdk.services.appconfig.model.AppConfigResponse
software.amazon.awssdk.services.appconfig.model.GetExperimentDefinitionResponse
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<GetExperimentDefinitionResponse.Builder,GetExperimentDefinitionResponse>
@Generated("software.amazon.awssdk:codegen") public final class GetExperimentDefinitionResponse extends AppConfigResponse implements ToCopyableBuilder<GetExperimentDefinitionResponse.Builder,GetExperimentDefinitionResponse>

Describes an experiment definition, including the target audience, feature flag, treatments, and current status.

  • Method Details

    • applicationId

      public final String applicationId()

      The application ID.

      Returns:
      The application ID.

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

      Returns:
      The name of the experiment definition.

    • hypothesis

      public final String hypothesis()

      The hypothesis that the experiment is designed to validate.

      Returns:
      The hypothesis that the experiment is designed to validate.

    • status

      public final ExperimentDefinitionStatus status()

      The current status of the experiment definition. Valid values: ACTIVE, IDLE, ARCHIVED.

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

      Returns:
      The current status of the experiment definition. Valid values: ACTIVE, IDLE, ARCHIVED.
      See Also:

    • statusAsString

      public final String statusAsString()

      The current status of the experiment definition. Valid values: ACTIVE, IDLE, ARCHIVED.

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

      Returns:
      The current status of the experiment definition. Valid values: ACTIVE, IDLE, ARCHIVED.
      See Also:

    • configurationProfileId

      public final String configurationProfileId()

      The configuration profile ID associated with the experiment.

      Returns:
      The configuration profile ID associated with the experiment.

    • environmentId

      public final String environmentId()

      The environment ID where the experiment runs.

      Returns:
      The environment ID where the experiment runs.

    • flagKey

      public final String flagKey()

      The key of the feature flag used by the experiment.

      Returns:
      The key of the feature flag used by the experiment.

    • audienceRule

      public final String audienceRule()

      The rule that defines which users are eligible to be assigned to treatments.

      Returns:
      The rule that defines which users are eligible to be assigned to treatments.

    • audienceDescription

      public final String audienceDescription()

      A description of the intended audience for the experiment.

      Returns:
      A description of the intended audience for the experiment.

    • launchCriteria

      public final String launchCriteria()

      The conditions under which the winning treatment should be launched.

      Returns:
      The conditions under which the winning treatment should be launched.

    • 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 list of treatments defined for the experiment.

      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 list of treatments defined for the experiment.

    • control

      public final Treatment control()

      The control treatment used as the baseline for comparison.

      Returns:
      The control treatment used as the baseline for comparison.

    • createdAt

      public final Instant createdAt()

      The date and time the experiment definition was created, in ISO 8601 format.

      Returns:
      The date and time the experiment definition was created, in ISO 8601 format.

    • updatedAt

      public final Instant updatedAt()

      The date and time the experiment definition was last updated, in ISO 8601 format.

      Returns:
      The date and time the experiment definition was last updated, in ISO 8601 format.

    • kmsKeyIdentifier

      public final String kmsKeyIdentifier()

      The Amazon Resource Name (ARN) of the KMS key used to encrypt experiment data.

      Returns:
      The Amazon Resource Name (ARN) of the KMS key used to encrypt experiment data.

    • toBuilder

      public GetExperimentDefinitionResponse.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<GetExperimentDefinitionResponse.Builder,GetExperimentDefinitionResponse>
      Specified by:
      toBuilder in class AwsResponse
      Returns:
      a builder for type T

    • builder

      public static GetExperimentDefinitionResponse.Builder builder()

    • serializableBuilderClass

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

    • hashCode

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

    • equals

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

    • 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: SdkResponse
      Used to retrieve the value of a field from any class that extends SdkResponse. 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 SdkResponse.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkResponse
      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.

    • sdkFieldNameToField

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