java.lang.Object
- software.amazon.awssdk.services.gamelift.model.PriorityConfigurationOverride

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<PriorityConfigurationOverride.Builder,PriorityConfigurationOverride>
```
@Generated("software.amazon.awssdk:codegen")
public final class PriorityConfigurationOverride
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<PriorityConfigurationOverride.Builder,PriorityConfigurationOverride>
```
An alternate list of prioritized locations for use with a game session queue. When this property is included in a StartGameSessionPlacement request, this list overrides the queue's default location prioritization, as defined in the queue's PriorityConfiguration setting (LocationOrder). This property overrides the queue's default priority list for individual placement requests only. Use this property only with queues that have a PriorityConfiguration setting that prioritizes first.

A priority configuration override list does not override a queue's FilterConfiguration setting, if the queue has one. Filter configurations are used to limit placements to a subset of the locations in a queue's destinations. If the override list includes a location that's not included in the FilterConfiguration allowed list, Amazon GameLift won't attempt to place a game session there.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface PriorityConfigurationOverride.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static PriorityConfigurationOverride.Builder`	`builder()`
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`boolean`	`hasLocationOrder()`	For responses, this returns true if the service returned a value for the LocationOrder property.
`List<String>`	`locationOrder()`	A prioritized list of hosting locations.
`PlacementFallbackStrategy`	`placementFallbackStrategy()`	Instructions for how to use the override list if the first round of placement attempts fails.
`String`	`placementFallbackStrategyAsString()`	Instructions for how to use the override list if the first round of placement attempts fails.
`Map<String,SdkField<?>>`	`sdkFieldNameToField()`
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends PriorityConfigurationOverride.Builder>`	`serializableBuilderClass()`
`PriorityConfigurationOverride.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
  - placementFallbackStrategy
```
public final PlacementFallbackStrategy placementFallbackStrategy()
```
    Instructions for how to use the override list if the first round of placement attempts fails. The first round is a failure if Amazon GameLift searches all listed locations, in all of the queue's destinations, without finding an available hosting resource for a new game session. Valid strategies include:
    
    DEFAULT_AFTER_SINGLE_PASS -- After the first round of placement attempts, discard the override list and use the queue's default location priority list. Continue to use the queue's default list until the placement request times out.
    
    NONE -- Continue to use the override list for all rounds of placement attempts until the placement request times out.
    
    If the service returns an enum value that is not available in the current SDK version, placementFallbackStrategy will return PlacementFallbackStrategy.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from placementFallbackStrategyAsString().
    Returns:
    
    Instructions for how to use the override list if the first round of placement attempts fails. The first round is a failure if Amazon GameLift searches all listed locations, in all of the queue's destinations, without finding an available hosting resource for a new game session. Valid strategies include:
    
    DEFAULT_AFTER_SINGLE_PASS -- After the first round of placement attempts, discard the override list and use the queue's default location priority list. Continue to use the queue's default list until the placement request times out.
    
    NONE -- Continue to use the override list for all rounds of placement attempts until the placement request times out.
    
    See Also:
    
    PlacementFallbackStrategy
  - placementFallbackStrategyAsString
```
public final String placementFallbackStrategyAsString()
```
    Instructions for how to use the override list if the first round of placement attempts fails. The first round is a failure if Amazon GameLift searches all listed locations, in all of the queue's destinations, without finding an available hosting resource for a new game session. Valid strategies include:
    
    DEFAULT_AFTER_SINGLE_PASS -- After the first round of placement attempts, discard the override list and use the queue's default location priority list. Continue to use the queue's default list until the placement request times out.
    
    NONE -- Continue to use the override list for all rounds of placement attempts until the placement request times out.
    
    If the service returns an enum value that is not available in the current SDK version, placementFallbackStrategy will return PlacementFallbackStrategy.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from placementFallbackStrategyAsString().
    Returns:
    
    Instructions for how to use the override list if the first round of placement attempts fails. The first round is a failure if Amazon GameLift searches all listed locations, in all of the queue's destinations, without finding an available hosting resource for a new game session. Valid strategies include:
    
    DEFAULT_AFTER_SINGLE_PASS -- After the first round of placement attempts, discard the override list and use the queue's default location priority list. Continue to use the queue's default list until the placement request times out.
    
    NONE -- Continue to use the override list for all rounds of placement attempts until the placement request times out.
    
    See Also:
    
    PlacementFallbackStrategy
  - hasLocationOrder
```
public final boolean hasLocationOrder()
```
    For responses, this returns true if the service returned a value for the LocationOrder 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.
  - locationOrder
```
public final List<String> locationOrder()
```
    A prioritized list of hosting locations. The list can include Amazon Web Services Regions (such as us-west-2), local zones, and custom locations (for Anywhere fleets). Each location must be listed only once. For details, see Amazon GameLift service locations.
    
    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 hasLocationOrder() method.
    
    Returns:
    
    A prioritized list of hosting locations. The list can include Amazon Web Services Regions (such as us-west-2), local zones, and custom locations (for Anywhere fleets). Each location must be listed only once. For details, see Amazon GameLift service locations.
  - toBuilder
```
public PriorityConfigurationOverride.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<PriorityConfigurationOverride.Builder,PriorityConfigurationOverride>
  - builder
```
public static PriorityConfigurationOverride.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends PriorityConfigurationOverride.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
  - sdkFieldNameToField
```
public final Map<String,SdkField<?>> sdkFieldNameToField()
```
    Specified by:
    
    sdkFieldNameToField in interface SdkPojo

Class PriorityConfigurationOverride

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

placementFallbackStrategy

placementFallbackStrategyAsString

hasLocationOrder

locationOrder

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields

sdkFieldNameToField