Class Launch

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

This structure contains the configuration details of one Evidently launch.

See Also:

  • Method Details

    • arn

      public final String arn()

      The ARN of the launch.

      Returns:
      The ARN of the launch.

    • createdTime

      public final Instant createdTime()

      The date and time that the launch is created.

      Returns:
      The date and time that the launch is created.

    • description

      public final String description()

      The description of the launch.

      Returns:
      The description of the launch.

    • execution

      public final LaunchExecution execution()

      A structure that contains information about the start and end times of the launch.

      Returns:
      A structure that contains information about the start and end times of 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<LaunchGroup> groups()

      An array of structures that define the feature variations that are being used in 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 define the feature variations that are being used in the launch.

    • lastUpdatedTime

      public final Instant lastUpdatedTime()

      The date and time that the launch was most recently updated.

      Returns:
      The date and time that the launch was most recently updated.

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

      An array of structures that define the metrics that are being 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 are being used to monitor the launch performance.

    • name

      public final String name()

      The name of the launch.

      Returns:
      The name of the launch.

    • project

      public final String project()

      The name or ARN of the project that contains the launch.

      Returns:
      The name or ARN of the project that contains the launch.

    • randomizationSalt

      public final String randomizationSalt()

      This value is used when Evidently assigns a particular user session to the launch, to help create a randomization ID to determine which variation the user session is served. This randomization ID is a combination of the entity ID and randomizationSalt.

      Returns:
      This value is used when Evidently assigns a particular user session to the launch, to help create a randomization ID to determine which variation the user session is served. This randomization ID is a combination of the entity ID and randomizationSalt.

    • scheduledSplitsDefinition

      public final ScheduledSplitsLaunchDefinition scheduledSplitsDefinition()

      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.

    • status

      public final LaunchStatus status()

      The current state of the launch.

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

      Returns:
      The current state of the launch.
      See Also:

    • statusAsString

      public final String statusAsString()

      The current state of the launch.

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

      Returns:
      The current state of the launch.
      See Also:

    • statusReason

      public final String statusReason()

      If the launch was stopped, this is the string that was entered by the person who stopped the launch, to explain why it was stopped.

      Returns:
      If the launch was stopped, this is the string that was entered by the person who stopped the launch, to explain why it was stopped.

    • 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 list of tag keys and values associated with this 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 hasTags() method.

      Returns:
      The list of tag keys and values associated with this launch.

    • type

      public final LaunchType type()

      The type of launch.

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

      Returns:
      The type of launch.
      See Also:

    • typeAsString

      public final String typeAsString()

      The type of launch.

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

      Returns:
      The type of launch.
      See Also:

    • toBuilder

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

    • builder

      public static Launch.Builder builder()

    • serializableBuilderClass

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