Package software.amazon.awssdk.services.ecs.model

Class PlacementStrategy

java.lang.Object

software.amazon.awssdk.services.ecs.model.PlacementStrategy

All Implemented Interfaces:

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

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

The task placement strategy for a task or service. For more information, see Task placement strategies in the Amazon Elastic Container Service Developer Guide.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	PlacementStrategy.Builder

Method Summary

Modifier and Type	Method	Description
static PlacementStrategy.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	field()	The field to apply the placement strategy against.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
List<SdkField<?>>	sdkFields()
static Class<? extends PlacementStrategy.Builder>	serializableBuilderClass()
PlacementStrategy.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
PlacementStrategyType	type()	The type of placement strategy.
String	typeAsString()	The type of placement strategy.

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

type

public final PlacementStrategyType type()

The type of placement strategy. The random placement strategy randomly places tasks on available candidates. The spread placement strategy spreads placement across available candidates evenly based on the field parameter. The binpack strategy places tasks on available candidates that have the least available amount of the resource that's specified with the field parameter. For example, if you binpack on memory, a task is placed on the instance with the least amount of remaining memory but still enough to run the task.

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

Returns:

The type of placement strategy. The random placement strategy randomly places tasks on available candidates. The spread placement strategy spreads placement across available candidates evenly based on the field parameter. The binpack strategy places tasks on available candidates that have the least available amount of the resource that's specified with the field parameter. For example, if you binpack on memory, a task is placed on the instance with the least amount of remaining memory but still enough to run the task.

See Also:

PlacementStrategyType

typeAsString

public final String typeAsString()

The type of placement strategy. The random placement strategy randomly places tasks on available candidates. The spread placement strategy spreads placement across available candidates evenly based on the field parameter. The binpack strategy places tasks on available candidates that have the least available amount of the resource that's specified with the field parameter. For example, if you binpack on memory, a task is placed on the instance with the least amount of remaining memory but still enough to run the task.

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

Returns:

The type of placement strategy. The random placement strategy randomly places tasks on available candidates. The spread placement strategy spreads placement across available candidates evenly based on the field parameter. The binpack strategy places tasks on available candidates that have the least available amount of the resource that's specified with the field parameter. For example, if you binpack on memory, a task is placed on the instance with the least amount of remaining memory but still enough to run the task.

See Also:

PlacementStrategyType

field

public final String field()

The field to apply the placement strategy against. For the spread placement strategy, valid values are instanceId (or host, which has the same effect), or any platform or custom attribute that's applied to a container instance, such as attribute:ecs.availability-zone. For the binpack placement strategy, valid values are cpu and memory. For the random placement strategy, this field is not used.

Returns:

The field to apply the placement strategy against. For the spread placement strategy, valid values are instanceId (or host, which has the same effect), or any platform or custom attribute that's applied to a container instance, such as attribute:ecs.availability-zone. For the binpack placement strategy, valid values are cpu and memory. For the random placement strategy, this field is not used.

toBuilder

public PlacementStrategy.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<PlacementStrategy.Builder,PlacementStrategy>

builder

public static PlacementStrategy.Builder builder()

serializableBuilderClass

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