Package software.amazon.awssdk.services.evidently.model

Class CreateLaunchRequest

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.CreateLaunchRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<CreateLaunchRequest.Builder,CreateLaunchRequest>
@Generated("software.amazon.awssdk:codegen") public final class CreateLaunchRequest extends EvidentlyRequest implements ToCopyableBuilder<CreateLaunchRequest.Builder,CreateLaunchRequest>

  • Method Details

    • description

      public final String description()

      An optional description for the launch.

      Returns:
      An optional description for the launch.

    • hasGroups

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

    • groups

      public final List<LaunchGroupConfig> groups()

      An array of structures that contains the feature and variations that are to be used for the launch.

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

      Returns:
      An array of structures that contains the feature and variations that are to be used for the launch.

    • hasMetricMonitors

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

    • metricMonitors

      public final List<MetricMonitorConfig> metricMonitors()

      An array of structures that define the metrics that will be used to monitor the launch performance.

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

      Returns:
      An array of structures that define the metrics that will be used to monitor the launch performance.

    • name

      public final String name()

      The name for the new launch.

      Returns:
      The name for the new launch.

    • project

      public final String project()

      The name or ARN of the project that you want to create the launch in.

      Returns:
      The name or ARN of the project that you want to create the launch in.

    • randomizationSalt

      public final String randomizationSalt()

      When Evidently assigns a particular user session to a launch, it must use a randomization ID to determine which variation the user session is served. This randomization ID is a combination of the entity ID and randomizationSalt. If you omit randomizationSalt, Evidently uses the launch name as the randomizationSalt.

      Returns:
      When Evidently assigns a particular user session to a launch, it must use a randomization ID to determine which variation the user session is served. This randomization ID is a combination of the entity ID and randomizationSalt. If you omit randomizationSalt, Evidently uses the launch name as the randomizationSalt.

    • scheduledSplitsConfig

      public final ScheduledSplitsLaunchConfig scheduledSplitsConfig()

      An array of structures that define the traffic allocation percentages among the feature variations during each step of the launch.

      Returns:
      An array of structures that define the traffic allocation percentages among the feature variations during each step of the launch.

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

      Assigns one or more tags (key-value pairs) to the launch.

      Tags can help you organize and categorize your resources. You can also use them to scope user permissions by granting a user permission to access or change only resources with certain tag values.

      Tags don't have any semantic meaning to Amazon Web Services and are interpreted strictly as strings of characters.

      You can associate as many as 50 tags with a launch.

      For more information, see Tagging Amazon Web Services 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:
      Assigns one or more tags (key-value pairs) to the launch.

      Tags can help you organize and categorize your resources. You can also use them to scope user permissions by granting a user permission to access or change only resources with certain tag values.

      Tags don't have any semantic meaning to Amazon Web Services and are interpreted strictly as strings of characters.

      You can associate as many as 50 tags with a launch.

      For more information, see Tagging Amazon Web Services resources.

    • toBuilder

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

    • builder

      public static CreateLaunchRequest.Builder builder()

    • serializableBuilderClass

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