Class PriorityConfigurationOverride

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, the alternate list overrides the queue's default location priorities, as defined in the queue's PriorityConfiguration setting (LocationOrder). The override is valid for an individual placement request only. Use this property only with queues that have a PriorityConfiguration setting that prioritizes LOCATION 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 on in the FilterConfiguration allowed list, Amazon GameLift Servers won't attempt to place a game session there.

See Also:

  • Method Details

    • placementFallbackStrategy

      public final PlacementFallbackStrategy placementFallbackStrategy()

      Instructions for how to proceed if placement fails in every location on the priority override list. Valid strategies include:

      • DEFAULT_AFTER_SINGLE_PASS -- After attempting to place a new game session in every location on the priority override list, try to place a game session in queue's other locations. This is the default behavior.

      • NONE -- Limit placements to locations on the priority override list only.

      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 proceed if placement fails in every location on the priority override list. Valid strategies include:

      • DEFAULT_AFTER_SINGLE_PASS -- After attempting to place a new game session in every location on the priority override list, try to place a game session in queue's other locations. This is the default behavior.

      • NONE -- Limit placements to locations on the priority override list only.

      See Also:

    • placementFallbackStrategyAsString

      public final String placementFallbackStrategyAsString()

      Instructions for how to proceed if placement fails in every location on the priority override list. Valid strategies include:

      • DEFAULT_AFTER_SINGLE_PASS -- After attempting to place a new game session in every location on the priority override list, try to place a game session in queue's other locations. This is the default behavior.

      • NONE -- Limit placements to locations on the priority override list only.

      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 proceed if placement fails in every location on the priority override list. Valid strategies include:

      • DEFAULT_AFTER_SINGLE_PASS -- After attempting to place a new game session in every location on the priority override list, try to place a game session in queue's other locations. This is the default behavior.

      • NONE -- Limit placements to locations on the priority override list only.

      See Also:

    • 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 Servers 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 Servers service locations.

    • toBuilder

      public PriorityConfigurationOverride.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<PriorityConfigurationOverride.Builder,PriorityConfigurationOverride>
      Returns:
      a builder for type T

    • 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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.