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("software.amazon.awssdk:codegen") public final class CreateFeatureRequest extends EvidentlyRequest implements ToCopyableBuilder<CreateFeatureRequest.Builder,CreateFeatureRequest>
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceCreateFeatureRequest.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static CreateFeatureRequest.Builderbuilder()StringdefaultVariation()The name of the variation to use as the default variation.Stringdescription()An optional description of the feature.Map<String,String>entityOverrides()Specify users that should always be served a specific variation of a feature.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)FeatureEvaluationStrategyevaluationStrategy()SpecifyALL_RULESto activate the traffic allocation specified by any ongoing launches or experiments.StringevaluationStrategyAsString()SpecifyALL_RULESto activate the traffic allocation specified by any ongoing launches or experiments.<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)booleanhasEntityOverrides()For responses, this returns true if the service returned a value for the EntityOverrides property.inthashCode()booleanhasTags()For responses, this returns true if the service returned a value for the Tags property.booleanhasVariations()For responses, this returns true if the service returned a value for the Variations property.Stringname()The name for the new feature.Stringproject()The name or ARN of the project that is to contain the new feature.Map<String,SdkField<?>>sdkFieldNameToField()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.BuildertoBuilder()StringtoString()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
variationsstructure.If you omit
defaultVariation, the first variation listed in thevariationsstructure 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
variationsstructure.If you omit
defaultVariation, the first variation listed in thevariationsstructure 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 theisEmpty()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.
This parameter is limited to 2500 overrides or a total of 40KB. The 40KB limit includes an overhead of 6 bytes per override.
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.
This parameter is limited to 2500 overrides or a total of 40KB. The 40KB limit includes an overhead of 6 bytes per override.
-
evaluationStrategy
public final FeatureEvaluationStrategy evaluationStrategy()
Specify
ALL_RULESto activate the traffic allocation specified by any ongoing launches or experiments. SpecifyDEFAULT_VARIATIONto serve the default variation to all users instead.If the service returns an enum value that is not available in the current SDK version,
evaluationStrategywill returnFeatureEvaluationStrategy.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromevaluationStrategyAsString().- Returns:
- Specify
ALL_RULESto activate the traffic allocation specified by any ongoing launches or experiments. SpecifyDEFAULT_VARIATIONto serve the default variation to all users instead. - See Also:
FeatureEvaluationStrategy
-
evaluationStrategyAsString
public final String evaluationStrategyAsString()
Specify
ALL_RULESto activate the traffic allocation specified by any ongoing launches or experiments. SpecifyDEFAULT_VARIATIONto serve the default variation to all users instead.If the service returns an enum value that is not available in the current SDK version,
evaluationStrategywill returnFeatureEvaluationStrategy.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromevaluationStrategyAsString().- Returns:
- Specify
ALL_RULESto activate the traffic allocation specified by any ongoing launches or experiments. SpecifyDEFAULT_VARIATIONto 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 theisEmpty()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.
You can associate as many as 50 tags with a feature.
For more information, see Tagging Amazon Web Services resources.
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.
You can associate as many as 50 tags with a feature.
For more information, see Tagging Amazon Web Services resources.
-
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 theisEmpty()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:
toBuilderin interfaceToCopyableBuilder<CreateFeatureRequest.Builder,CreateFeatureRequest>- Specified by:
toBuilderin classEvidentlyRequest
-
builder
public static CreateFeatureRequest.Builder builder()
-
serializableBuilderClass
public static Class<? extends CreateFeatureRequest.Builder> serializableBuilderClass()
-
hashCode
public final int hashCode()
- Overrides:
hashCodein classAwsRequest
-
equals
public final boolean equals(Object obj)
- Overrides:
equalsin classAwsRequest
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
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.
-
getValueForField
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
- Overrides:
getValueForFieldin classSdkRequest
-
sdkFieldNameToField
public final Map<String,SdkField<?>> sdkFieldNameToField()
- Specified by:
sdkFieldNameToFieldin interfaceSdkPojo
-
-