Class CreateExperimentDefinitionRequest

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

  • Method Details

    • applicationIdentifier

      public final String applicationIdentifier()

      The application ID or name.

      Returns:
      The application ID or name.

    • name

      public final String name()

      A name for the experiment definition.

      Returns:
      A name for the experiment definition.

    • configurationProfileIdentifier

      public final String configurationProfileIdentifier()

      The configuration profile ID or name that stores the feature flag.

      Returns:
      The configuration profile ID or name that stores the feature flag.

    • environmentIdentifier

      public final String environmentIdentifier()

      The environment ID or name where the experiment will run.

      Returns:
      The environment ID or name where the experiment will run.

    • flagKey

      public final String flagKey()

      The key of the existing feature flag to use with the experiment.

      Returns:
      The key of the existing feature flag to use with the experiment.

    • 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<TreatmentInput> treatments()

      A list of treatments to evaluate during the experiment. Each treatment defines a distinct variation compared to the control.

      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:
      A list of treatments to evaluate during the experiment. Each treatment defines a distinct variation compared to the control.

    • control

      public final TreatmentInput control()

      The control treatment that represents the baseline experience for comparison.

      Returns:
      The control treatment that represents the baseline experience for comparison.

    • audienceRule

      public final String audienceRule()

      A rule that defines which users are eligible to be assigned to treatments during the experiment.

      Returns:
      A rule that defines which users are eligible to be assigned to treatments during the experiment.

    • hypothesis

      public final String hypothesis()

      A description of the goal or hypothesis the experiment is designed to validate.

      Returns:
      A description of the goal or hypothesis the experiment is designed to validate.

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

      Information about the conditions under which you would launch the winning treatment.

      Returns:
      Information about the conditions under which you would launch the winning treatment.

    • hasTags

      public final boolean hasTags()
      For responses, this returns true if the service returned a value for the Tags 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.

    • tags

      public final Map<String,String> tags()

      The tags to assign to the experiment definition. Tags help organize and categorize your AppConfig resources.

      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 hasTags() method.

      Returns:
      The tags to assign to the experiment definition. Tags help organize and categorize your AppConfig resources.

    • toBuilder

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

    • builder

      public static CreateExperimentDefinitionRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends CreateExperimentDefinitionRequest.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.

    • sdkFieldNameToField

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