Class UpdateFeatureRequest
- 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.UpdateFeatureRequest
-
- All Implemented Interfaces:
SdkPojo,ToCopyableBuilder<UpdateFeatureRequest.Builder,UpdateFeatureRequest>
@Generated("software.amazon.awssdk:codegen") public final class UpdateFeatureRequest extends EvidentlyRequest implements ToCopyableBuilder<UpdateFeatureRequest.Builder,UpdateFeatureRequest>
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceUpdateFeatureRequest.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description List<VariationConfig>addOrUpdateVariations()To update variation configurations for this feature, or add new ones, specify this structure.static UpdateFeatureRequest.Builderbuilder()StringdefaultVariation()The name of the variation to use as the default variation.Stringdescription()An optional description of the feature.Map<String,String>entityOverrides()Specified 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.Stringfeature()The name of the feature to be updated.<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)booleanhasAddOrUpdateVariations()For responses, this returns true if the service returned a value for the AddOrUpdateVariations property.booleanhasEntityOverrides()For responses, this returns true if the service returned a value for the EntityOverrides property.inthashCode()booleanhasRemoveVariations()For responses, this returns true if the service returned a value for the RemoveVariations property.Stringproject()The name or ARN of the project that contains the feature to be updated.List<String>removeVariations()Removes a variation from the feature.List<SdkField<?>>sdkFields()static Class<? extends UpdateFeatureRequest.Builder>serializableBuilderClass()UpdateFeatureRequest.BuildertoBuilder()StringtoString()Returns a string representation of this object.-
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
-
hasAddOrUpdateVariations
public final boolean hasAddOrUpdateVariations()
For responses, this returns true if the service returned a value for the AddOrUpdateVariations 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.
-
addOrUpdateVariations
public final List<VariationConfig> addOrUpdateVariations()
To update variation configurations for this feature, or add new ones, specify this structure. In this array, include any variations that you want to add or update. If the array includes a variation name that already exists for this feature, it is updated. If it includes a new variation name, it is added as a new variation.
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
hasAddOrUpdateVariations()method.- Returns:
- To update variation configurations for this feature, or add new ones, specify this structure. In this array, include any variations that you want to add or update. If the array includes a variation name that already exists for this feature, it is updated. If it includes a new variation name, it is added as a new variation.
-
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.
- 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.
-
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()
Specified 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:
- Specified 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
-
feature
public final String feature()
The name of the feature to be updated.
- Returns:
- The name of the feature to be updated.
-
project
public final String project()
The name or ARN of the project that contains the feature to be updated.
- Returns:
- The name or ARN of the project that contains the feature to be updated.
-
hasRemoveVariations
public final boolean hasRemoveVariations()
For responses, this returns true if the service returned a value for the RemoveVariations 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.
-
removeVariations
public final List<String> removeVariations()
Removes a variation from the feature. If the variation you specify doesn't exist, then this makes no change and does not report an error.
This operation fails if you try to remove a variation that is part of an ongoing launch or experiment.
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
hasRemoveVariations()method.- Returns:
- Removes a variation from the feature. If the variation you specify doesn't exist, then this makes no
change and does not report an error.
This operation fails if you try to remove a variation that is part of an ongoing launch or experiment.
-
toBuilder
public UpdateFeatureRequest.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<UpdateFeatureRequest.Builder,UpdateFeatureRequest>- Specified by:
toBuilderin classEvidentlyRequest
-
builder
public static UpdateFeatureRequest.Builder builder()
-
serializableBuilderClass
public static Class<? extends UpdateFeatureRequest.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
-
-