Class LocationAttributes
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<LocationAttributes.Builder,
LocationAttributes>
Details about a location in a multi-location fleet.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic LocationAttributes.Builder
builder()
final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the StoppedActions property.final LocationState
A fleet location and its current life-cycle state.static Class
<? extends LocationAttributes.Builder> final List
<FleetAction> A list of fleet actions that have been suspended in the fleet location.A list of fleet actions that have been suspended in the fleet location.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final LocationUpdateStatus
The status of fleet activity updates to the location.final String
The status of fleet activity updates to the location.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
locationState
A fleet location and its current life-cycle state.
- Returns:
- A fleet location and its current life-cycle state.
-
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 theisEmpty()
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
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
The status of fleet activity updates to the location. The status
PENDING_UPDATE
indicates thatStopFleetActions
orStartFleetActions
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 returnLocationUpdateStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromupdateStatusAsString()
.- Returns:
- The status of fleet activity updates to the location. The status
PENDING_UPDATE
indicates thatStopFleetActions
orStartFleetActions
has been requested but the update has not yet been completed for the location. - See Also:
-
updateStatusAsString
The status of fleet activity updates to the location. The status
PENDING_UPDATE
indicates thatStopFleetActions
orStartFleetActions
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 returnLocationUpdateStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromupdateStatusAsString()
.- Returns:
- The status of fleet activity updates to the location. The status
PENDING_UPDATE
indicates thatStopFleetActions
orStartFleetActions
has been requested but the update has not yet been completed for the location. - See Also:
-
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 interfaceToCopyableBuilder<LocationAttributes.Builder,
LocationAttributes> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-