software.amazon.awssdk.services.evidently.model

Class ScheduledSplit

java.lang.Object

software.amazon.awssdk.services.evidently.model.ScheduledSplit

All Implemented Interfaces:

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

@Generated(value="software.amazon.awssdk:codegen")
public final class ScheduledSplit
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<ScheduledSplit.Builder,ScheduledSplit>

This structure defines the traffic allocation percentages among the feature variations during one step of a launch, and the start time of that step.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ScheduledSplit.Builder

Method Summary

Modifier and Type	Method and Description
static ScheduledSplit.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
Map<String,Long>	groupWeights() The traffic allocation percentages among the feature variations during one step of a launch.
boolean	hasGroupWeights() For responses, this returns true if the service returned a value for the GroupWeights property.
int	hashCode()
boolean	hasSegmentOverrides() For responses, this returns true if the service returned a value for the SegmentOverrides property.
List<SdkField<?>>	sdkFields()
List<SegmentOverride>	segmentOverrides() Use this parameter to specify different traffic splits for one or more audience segments.
static Class<? extends ScheduledSplit.Builder>	serializableBuilderClass()
Instant	startTime() The date and time that this step of the launch starts.
ScheduledSplit.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

hasGroupWeights

public final boolean hasGroupWeights()

For responses, this returns true if the service returned a value for the GroupWeights 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.

groupWeights

public final Map<String,Long> groupWeights()

The traffic allocation percentages among the feature variations during one step of a launch. This is a set of key-value pairs. The keys are variation names. The values represent the percentage of traffic to allocate to that variation during this step.

The values is expressed in thousandths of a percent, so assigning a weight of 50000 assigns 50% of traffic to that variation.

If the sum of the weights for all the variations in a segment override does not add up to 100,000, then the remaining traffic that matches this segment is not assigned by this segment override, and instead moves on to the next segment override or the default traffic split.

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

Returns:

The traffic allocation percentages among the feature variations during one step of a launch. This is a set of key-value pairs. The keys are variation names. The values represent the percentage of traffic to allocate to that variation during this step.

The values is expressed in thousandths of a percent, so assigning a weight of 50000 assigns 50% of traffic to that variation.

If the sum of the weights for all the variations in a segment override does not add up to 100,000, then the remaining traffic that matches this segment is not assigned by this segment override, and instead moves on to the next segment override or the default traffic split.

hasSegmentOverrides

public final boolean hasSegmentOverrides()

For responses, this returns true if the service returned a value for the SegmentOverrides 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.

segmentOverrides

public final List<SegmentOverride> segmentOverrides()

Use this parameter to specify different traffic splits for one or more audience segments. A segment is a portion of your audience that share one or more characteristics. Examples could be Chrome browser users, users in Europe, or Firefox browser users in Europe who also fit other criteria that your application collects, such as age.

This parameter is an array of up to six segment override objects. Each of these objects specifies a segment that you have already created, and defines the traffic split for that segment.

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

Returns:

Use this parameter to specify different traffic splits for one or more audience segments. A segment is a portion of your audience that share one or more characteristics. Examples could be Chrome browser users, users in Europe, or Firefox browser users in Europe who also fit other criteria that your application collects, such as age.

This parameter is an array of up to six segment override objects. Each of these objects specifies a segment that you have already created, and defines the traffic split for that segment.

startTime

public final Instant startTime()

The date and time that this step of the launch starts.

Returns:

The date and time that this step of the launch starts.

toBuilder

public ScheduledSplit.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ScheduledSplit.Builder,ScheduledSplit>

builder

public static ScheduledSplit.Builder builder()

serializableBuilderClass

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