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

Class LocationAttributes

java.lang.Object

software.amazon.awssdk.services.gamelift.model.LocationAttributes

All Implemented Interfaces:

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

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

Details about a location in a multi-location fleet.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	LocationAttributes.Builder

Method Summary

Modifier and Type	Method	Description
static LocationAttributes.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasStoppedActions()	For responses, this returns true if the service returned a value for the StoppedActions property.
LocationState	locationState()	A fleet location and its current life-cycle state.
List<SdkField<?>>	sdkFields()
static Class<? extends LocationAttributes.Builder>	serializableBuilderClass()
List<FleetAction>	stoppedActions()	A list of fleet actions that have been suspended in the fleet location.
List<String>	stoppedActionsAsStrings()	A list of fleet actions that have been suspended in the fleet location.
LocationAttributes.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
LocationUpdateStatus	updateStatus()	The status of fleet activity updates to the location.
String	updateStatusAsString()	The status of fleet activity updates to the location.

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

locationState

public final LocationState locationState()

A fleet location and its current life-cycle state.

Returns:

A fleet location and its current life-cycle state.

stoppedActions

public final List<FleetAction> stoppedActions()

A list of fleet actions that have been suspended in the fleet location.

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

Returns:

A list of fleet actions that have been suspended in the fleet location.

hasStoppedActions

public final boolean hasStoppedActions()

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

stoppedActionsAsStrings

public final List<String> stoppedActionsAsStrings()

A list of fleet actions that have been suspended in the fleet location.

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

Returns:

A list of fleet actions that have been suspended in the fleet location.

updateStatus

public final LocationUpdateStatus updateStatus()

The status of fleet activity updates to the location. The status PENDING_UPDATE indicates that StopFleetActions or StartFleetActions has been requested but the update has not yet been completed for the location.

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

Returns:

The status of fleet activity updates to the location. The status PENDING_UPDATE indicates that StopFleetActions or StartFleetActions has been requested but the update has not yet been completed for the location.

See Also:

LocationUpdateStatus

updateStatusAsString

public final String updateStatusAsString()

The status of fleet activity updates to the location. The status PENDING_UPDATE indicates that StopFleetActions or StartFleetActions has been requested but the update has not yet been completed for the location.

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

Returns:

The status of fleet activity updates to the location. The status PENDING_UPDATE indicates that StopFleetActions or StartFleetActions has been requested but the update has not yet been completed for the location.

See Also:

LocationUpdateStatus

toBuilder

public LocationAttributes.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<LocationAttributes.Builder,LocationAttributes>

builder

public static LocationAttributes.Builder builder()

serializableBuilderClass

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