Class Segment

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

This structure contains information about one audience segment. You can use segments in your experiments and launches to narrow the user sessions used for experiment or launch to only the user sessions that match one or more criteria.

See Also:

  • Method Details

    • arn

      public final String arn()

      The ARN of the segment.

      Returns:
      The ARN of the segment.

    • createdTime

      public final Instant createdTime()

      The date and time that this segment was created.

      Returns:
      The date and time that this segment was created.

    • description

      public final String description()

      The customer-created description for this segment.

      Returns:
      The customer-created description for this segment.

    • experimentCount

      public final Long experimentCount()

      The number of experiments that this segment is used in. This count includes all current experiments, not just those that are currently running.

      Returns:
      The number of experiments that this segment is used in. This count includes all current experiments, not just those that are currently running.

    • lastUpdatedTime

      public final Instant lastUpdatedTime()

      The date and time that this segment was most recently updated.

      Returns:
      The date and time that this segment was most recently updated.

    • launchCount

      public final Long launchCount()

      The number of launches that this segment is used in. This count includes all current launches, not just those that are currently running.

      Returns:
      The number of launches that this segment is used in. This count includes all current launches, not just those that are currently running.

    • name

      public final String name()

      The name of the segment.

      Returns:
      The name of the segment.

    • pattern

      public final String pattern()

      The pattern that defines the attributes to use to evalute whether a user session will be in the segment. For more information about the pattern syntax, see Segment rule pattern syntax.

      Returns:
      The pattern that defines the attributes to use to evalute whether a user session will be in the segment. For more information about the pattern syntax, see Segment rule pattern syntax.

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

    • toBuilder

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

    • builder

      public static Segment.Builder builder()

    • serializableBuilderClass

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