Interface CreateExperimentDefinitionRequest.Builder

All Superinterfaces:
AppConfigRequest.Builder, AwsRequest.Builder, Buildable, CopyableBuilder<CreateExperimentDefinitionRequest.Builder,CreateExperimentDefinitionRequest>, SdkBuilder<CreateExperimentDefinitionRequest.Builder,CreateExperimentDefinitionRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
CreateExperimentDefinitionRequest
@Mutable @NotThreadSafe public static interface CreateExperimentDefinitionRequest.Builder extends AppConfigRequest.Builder, SdkPojo, CopyableBuilder<CreateExperimentDefinitionRequest.Builder,CreateExperimentDefinitionRequest>

  • Method Details

    • applicationIdentifier

      CreateExperimentDefinitionRequest.Builder applicationIdentifier(String applicationIdentifier)

      The application ID or name.

      Parameters:
      applicationIdentifier - The application ID or name.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • name

      CreateExperimentDefinitionRequest.Builder name(String name)

      A name for the experiment definition.

      Parameters:
      name - A name for the experiment definition.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • configurationProfileIdentifier

      CreateExperimentDefinitionRequest.Builder configurationProfileIdentifier(String configurationProfileIdentifier)

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

      Parameters:
      configurationProfileIdentifier - The configuration profile ID or name that stores the feature flag.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • environmentIdentifier

      CreateExperimentDefinitionRequest.Builder environmentIdentifier(String environmentIdentifier)

      The environment ID or name where the experiment will run.

      Parameters:
      environmentIdentifier - The environment ID or name where the experiment will run.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • flagKey

      CreateExperimentDefinitionRequest.Builder flagKey(String flagKey)

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

      Parameters:
      flagKey - The key of the existing feature flag to use with the experiment.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • treatments

      CreateExperimentDefinitionRequest.Builder treatments(Collection<TreatmentInput> treatments)

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

      Parameters:
      treatments - A list of treatments to evaluate during the experiment. Each treatment defines a distinct variation compared to the control.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • treatments

      CreateExperimentDefinitionRequest.Builder treatments(TreatmentInput... treatments)

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

      Parameters:
      treatments - A list of treatments to evaluate during the experiment. Each treatment defines a distinct variation compared to the control.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • treatments

      CreateExperimentDefinitionRequest.Builder treatments(Consumer<TreatmentInput.Builder>... treatments)

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

      This is a convenience method that creates an instance of the TreatmentInput.Builder avoiding the need to create one manually via TreatmentInput.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to treatments(List<TreatmentInput>).

      Parameters:
      treatments - a consumer that will call methods on TreatmentInput.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • control

      CreateExperimentDefinitionRequest.Builder control(TreatmentInput control)

      The control treatment that represents the baseline experience for comparison.

      Parameters:
      control - The control treatment that represents the baseline experience for comparison.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • control

      default CreateExperimentDefinitionRequest.Builder control(Consumer<TreatmentInput.Builder> control)

      The control treatment that represents the baseline experience for comparison.

      This is a convenience method that creates an instance of the TreatmentInput.Builder avoiding the need to create one manually via TreatmentInput.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to control(TreatmentInput).

      Parameters:
      control - a consumer that will call methods on TreatmentInput.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • audienceRule

      CreateExperimentDefinitionRequest.Builder audienceRule(String audienceRule)

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

      Parameters:
      audienceRule - A rule that defines which users are eligible to be assigned to treatments during the experiment.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • hypothesis

      CreateExperimentDefinitionRequest.Builder hypothesis(String hypothesis)

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

      Parameters:
      hypothesis - A description of the goal or hypothesis the experiment is designed to validate.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • audienceDescription

      CreateExperimentDefinitionRequest.Builder audienceDescription(String audienceDescription)

      A description of the intended audience for the experiment.

      Parameters:
      audienceDescription - A description of the intended audience for the experiment.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • launchCriteria

      CreateExperimentDefinitionRequest.Builder launchCriteria(String launchCriteria)

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

      Parameters:
      launchCriteria - Information about the conditions under which you would launch the winning treatment.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tags

      CreateExperimentDefinitionRequest.Builder tags(Map<String,String> tags)

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

      Parameters:
      tags - The tags to assign to the experiment definition. Tags help organize and categorize your AppConfig resources.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

      CreateExperimentDefinitionRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      CreateExperimentDefinitionRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.