software.amazon.awssdk.services.gamelift.model

Class ClaimFilterOption

java.lang.Object

software.amazon.awssdk.services.gamelift.model.ClaimFilterOption

All Implemented Interfaces:

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

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

This data type is used with the Amazon GameLift FleetIQ and game server groups.

Filters which game servers may be claimed when calling ClaimGameServer.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ClaimFilterOption.Builder

Method Summary

Modifier and Type	Method and Description
static ClaimFilterOption.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasInstanceStatuses() For responses, this returns true if the service returned a value for the InstanceStatuses property.
List<FilterInstanceStatus>	instanceStatuses() List of instance statuses that game servers may be claimed on.
List<String>	instanceStatusesAsStrings() List of instance statuses that game servers may be claimed on.
List<SdkField<?>>	sdkFields()
static Class<? extends ClaimFilterOption.Builder>	serializableBuilderClass()
ClaimFilterOption.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

instanceStatuses

public final List<FilterInstanceStatus> instanceStatuses()

List of instance statuses that game servers may be claimed on. If provided, the list must contain the ACTIVE status.

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 hasInstanceStatuses() method.

Returns:

List of instance statuses that game servers may be claimed on. If provided, the list must contain the ACTIVE status.

hasInstanceStatuses

public final boolean hasInstanceStatuses()

For responses, this returns true if the service returned a value for the InstanceStatuses 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.

instanceStatusesAsStrings

public final List<String> instanceStatusesAsStrings()

List of instance statuses that game servers may be claimed on. If provided, the list must contain the ACTIVE status.

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 hasInstanceStatuses() method.

Returns:

List of instance statuses that game servers may be claimed on. If provided, the list must contain the ACTIVE status.

toBuilder

public ClaimFilterOption.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ClaimFilterOption.Builder,ClaimFilterOption>

builder

public static ClaimFilterOption.Builder builder()

serializableBuilderClass

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