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

Class Launch

    • Method Detail

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

      • 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:
        LaunchStatus

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

      • 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:
        LaunchType

      • 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

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