software.amazon.awssdk.services.evidently.model

Class Segment

java.lang.Object

software.amazon.awssdk.services.evidently.model.Segment

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<Segment.Builder,Segment>

@Generated(value="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:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Segment.Builder

Method Summary

Modifier and Type	Method and Description
String	arn() The ARN of the segment.
static Segment.Builder	builder()
Instant	createdTime() The date and time that this segment was created.
String	description() The customer-created description for this segment.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
Long	experimentCount() The number of experiments that this segment is used in.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasTags() For responses, this returns true if the service returned a value for the Tags property.
Instant	lastUpdatedTime() The date and time that this segment was most recently updated.
Long	launchCount() The number of launches that this segment is used in.
String	name() The name of the segment.
String	pattern() The pattern that defines the attributes to use to evalute whether a user session will be in the segment.
List<SdkField<?>>	sdkFields()
static Class<? extends Segment.Builder>	serializableBuilderClass()
Map<String,String>	tags() The list of tag keys and values associated with this launch.
Segment.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

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

Specified by:

toBuilder in interface ToCopyableBuilder<Segment.Builder,Segment>

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)

Specified by:

equalsBySdkFields in interface SdkPojo

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