software.amazon.awssdk.services.gamelift.model

Class FilterConfiguration

java.lang.Object

software.amazon.awssdk.services.gamelift.model.FilterConfiguration

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<FilterConfiguration.Builder,FilterConfiguration>

@Generated(value="software.amazon.awssdk:codegen")
public final class FilterConfiguration
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<FilterConfiguration.Builder,FilterConfiguration>

A list of fleet locations where a game session queue can place new game sessions. You can use a filter to temporarily turn off placements for specific locations. For queues that have multi-location fleets, you can use a filter configuration allow placement with some, but not all of these locations.

Filter configurations are part of a GameSessionQueue.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	FilterConfiguration.Builder

Method Summary

Modifier and Type	Method and Description
List<String>	allowedLocations() A list of locations to allow game session placement in, in the form of AWS Region codes such as us-west-2.
static FilterConfiguration.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasAllowedLocations() Returns true if the AllowedLocations property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
int	hashCode()
List<SdkField<?>>	sdkFields()
static Class<? extends FilterConfiguration.Builder>	serializableBuilderClass()
FilterConfiguration.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

hasAllowedLocations

public final boolean hasAllowedLocations()

Returns true if the AllowedLocations property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

allowedLocations

public final List<String> allowedLocations()

A list of locations to allow game session placement in, in the form of AWS Region codes such as us-west-2.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

You can use hasAllowedLocations() to see if a value was sent in this field.

Returns:

A list of locations to allow game session placement in, in the form of AWS Region codes such as us-west-2.

toBuilder

public FilterConfiguration.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<FilterConfiguration.Builder,FilterConfiguration>

builder

public static FilterConfiguration.Builder builder()

serializableBuilderClass

public static Class<? extends FilterConfiguration.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