software.amazon.awssdk.services.evidently.model

Class CreateFeatureRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.evidently.model.EvidentlyRequest

software.amazon.awssdk.services.evidently.model.CreateFeatureRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateFeatureRequest.Builder,CreateFeatureRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class CreateFeatureRequest
extends EvidentlyRequest
implements ToCopyableBuilder<CreateFeatureRequest.Builder,CreateFeatureRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CreateFeatureRequest.Builder

Method Summary

Modifier and Type	Method and Description
static CreateFeatureRequest.Builder	builder()
String	defaultVariation() The name of the variation to use as the default variation.
String	description() An optional description of the feature.
Map<String,String>	entityOverrides() Specify users that should always be served a specific variation of a feature.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
FeatureEvaluationStrategy	evaluationStrategy() Specify ALL_RULES to activate the traffic allocation specified by any ongoing launches or experiments.
String	evaluationStrategyAsString() Specify ALL_RULES to activate the traffic allocation specified by any ongoing launches or experiments.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasEntityOverrides() For responses, this returns true if the service returned a value for the EntityOverrides property.
int	hashCode()
boolean	hasTags() For responses, this returns true if the service returned a value for the Tags property.
boolean	hasVariations() For responses, this returns true if the service returned a value for the Variations property.
String	name() The name for the new feature.
String	project() The name or ARN of the project that is to contain the new feature.
List<SdkField<?>>	sdkFields()
static Class<? extends CreateFeatureRequest.Builder>	serializableBuilderClass()
Map<String,String>	tags() Assigns one or more tags (key-value pairs) to the feature.
CreateFeatureRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.
List<VariationConfig>	variations() An array of structures that contain the configuration of the feature's different variations.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

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

defaultVariation

public final String defaultVariation()

The name of the variation to use as the default variation. The default variation is served to users who are not allocated to any ongoing launches or experiments of this feature.

This variation must also be listed in the variations structure.

If you omit defaultVariation, the first variation listed in the variations structure is used as the default variation.

Returns:

The name of the variation to use as the default variation. The default variation is served to users who are not allocated to any ongoing launches or experiments of this feature.

This variation must also be listed in the variations structure.

If you omit defaultVariation, the first variation listed in the variations structure is used as the default variation.

description

public final String description()

An optional description of the feature.

Returns:

An optional description of the feature.

hasEntityOverrides

public final boolean hasEntityOverrides()

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

entityOverrides

public final Map<String,String> entityOverrides()

Specify users that should always be served a specific variation of a feature. Each user is specified by a key-value pair . For each key, specify a user by entering their user ID, account ID, or some other identifier. For the value, specify the name of the variation that they are to be served.

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

Returns:

Specify users that should always be served a specific variation of a feature. Each user is specified by a key-value pair . For each key, specify a user by entering their user ID, account ID, or some other identifier. For the value, specify the name of the variation that they are to be served.

evaluationStrategy

public final FeatureEvaluationStrategy evaluationStrategy()

Specify ALL_RULES to activate the traffic allocation specified by any ongoing launches or experiments. Specify DEFAULT_VARIATION to serve the default variation to all users instead.

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

Returns:

Specify ALL_RULES to activate the traffic allocation specified by any ongoing launches or experiments. Specify DEFAULT_VARIATION to serve the default variation to all users instead.

See Also:

FeatureEvaluationStrategy

evaluationStrategyAsString

public final String evaluationStrategyAsString()

Specify ALL_RULES to activate the traffic allocation specified by any ongoing launches or experiments. Specify DEFAULT_VARIATION to serve the default variation to all users instead.

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

Returns:

Specify ALL_RULES to activate the traffic allocation specified by any ongoing launches or experiments. Specify DEFAULT_VARIATION to serve the default variation to all users instead.

See Also:

FeatureEvaluationStrategy

name

public final String name()

The name for the new feature.

Returns:

The name for the new feature.

project

public final String project()

The name or ARN of the project that is to contain the new feature.

Returns:

The name or ARN of the project that is to contain the new feature.

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

Assigns one or more tags (key-value pairs) to the feature.

Tags can help you organize and categorize your resources. You can also use them to scope user permissions by granting a user permission to access or change only resources with certain tag values.

Tags don't have any semantic meaning to Amazon Web Services and are interpreted strictly as strings of characters.

  <p>You can associate as many as 50 tags with a feature.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging Amazon Web Services resources</a>.</p> 
 

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:

Assigns one or more tags (key-value pairs) to the feature.

Tags can help you organize and categorize your resources. You can also use them to scope user permissions by granting a user permission to access or change only resources with certain tag values.

Tags don't have any semantic meaning to Amazon Web Services and are interpreted strictly as strings of characters.

 <p>You can associate as many as 50 tags with a feature.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging Amazon Web Services resources</a>.</p> 

hasVariations

public final boolean hasVariations()

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

variations

public final List<VariationConfig> variations()

An array of structures that contain the configuration of the feature's different variations.

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

Returns:

An array of structures that contain the configuration of the feature's different variations.

toBuilder

public CreateFeatureRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateFeatureRequest.Builder,CreateFeatureRequest>

Specified by:

toBuilder in class EvidentlyRequest

builder

public static CreateFeatureRequest.Builder builder()

serializableBuilderClass

public static Class<? extends CreateFeatureRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

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)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo