Package software.amazon.awssdk.services.gamelift.model

Class LocationState

java.lang.Object

software.amazon.awssdk.services.gamelift.model.LocationState

All Implemented Interfaces:

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

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

A fleet location and its life-cycle state. A location state object might be used to describe a fleet's remote location or home Region. Life-cycle state tracks the progress of launching the first instance in a new location and preparing it for game hosting, and then removing all instances and deleting the location from the fleet.

• NEW -- A new fleet location has been defined and desired instances is set to 1.

• DOWNLOADING/VALIDATING/BUILDING/ACTIVATING -- Amazon GameLift is setting up the new fleet location, creating new instances with the game build or Realtime script and starting server processes.

• ACTIVE -- Hosts can now accept game sessions.

• ERROR -- An error occurred when downloading, validating, building, or activating the fleet location.

• DELETING -- Hosts are responding to a delete fleet location request.

• TERMINATED -- The fleet location no longer exists.

• NOT_FOUND -- The fleet location was not found. This could be because the custom location was removed or not created.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	LocationState.Builder

Method Summary

Modifier and Type	Method	Description
static LocationState.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	location()	The fleet location, expressed as an Amazon Web Services Region code such as us-west-2.
List<SdkField<?>>	sdkFields()
static Class<? extends LocationState.Builder>	serializableBuilderClass()
FleetStatus	status()	The life-cycle status of a fleet location.
String	statusAsString()	The life-cycle status of a fleet location.
LocationState.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

location

public final String location()

The fleet location, expressed as an Amazon Web Services Region code such as us-west-2.

Returns:

The fleet location, expressed as an Amazon Web Services Region code such as us-west-2.

status

public final FleetStatus status()

The life-cycle status of a fleet location.

If the service returns an enum value that is not available in the current SDK version, status will return FleetStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

Returns:

The life-cycle status of a fleet location.

See Also:

FleetStatus

statusAsString

public final String statusAsString()

The life-cycle status of a fleet location.

If the service returns an enum value that is not available in the current SDK version, status will return FleetStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

Returns:

The life-cycle status of a fleet location.

See Also:

FleetStatus

toBuilder

public LocationState.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<LocationState.Builder,LocationState>

builder

public static LocationState.Builder builder()

serializableBuilderClass

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