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

Class ContainerDependency

java.lang.Object

software.amazon.awssdk.services.gamelift.model.ContainerDependency

All Implemented Interfaces:

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

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

This data type is used with the Amazon GameLift containers feature, which is currently in public preview.

A container's dependency on another container in the same container group. The dependency impacts how the dependent container is able to start or shut down based the status of the other container.

For example, ContainerA is configured with the following dependency: a START dependency on ContainerB. This means that ContainerA can't start until ContainerB has started. It also means that ContainerA must shut down before ContainerB.

Part of: ContainerDefinition

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ContainerDependency.Builder

Method Summary

Modifier and Type	Method	Description
static ContainerDependency.Builder	builder()
ContainerDependencyCondition	condition()	The condition that the dependency container must reach before the dependent container can start.
String	conditionAsString()	The condition that the dependency container must reach before the dependent container can start.
String	containerName()	A descriptive label for the container definition that this container depends on.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
List<SdkField<?>>	sdkFields()
static Class<? extends ContainerDependency.Builder>	serializableBuilderClass()
ContainerDependency.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

containerName

public final String containerName()

A descriptive label for the container definition that this container depends on.

Returns:

A descriptive label for the container definition that this container depends on.

condition

public final ContainerDependencyCondition condition()

The condition that the dependency container must reach before the dependent container can start. Valid conditions include:

• START - The dependency container must have started.

• COMPLETE - The dependency container has run to completion (exits). Use this condition with nonessential containers, such as those that run a script and then exit. The dependency container can't be an essential container.

• SUCCESS - The dependency container has run to completion and exited with a zero status. The dependency container can't be an essential container.

• HEALTHY - The dependency container has passed its Docker health check. Use this condition with dependency containers that have health checks configured. This condition is confirmed at container group startup only.

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

Returns:

The condition that the dependency container must reach before the dependent container can start. Valid conditions include:

• START - The dependency container must have started.

• COMPLETE - The dependency container has run to completion (exits). Use this condition with nonessential containers, such as those that run a script and then exit. The dependency container can't be an essential container.

• SUCCESS - The dependency container has run to completion and exited with a zero status. The dependency container can't be an essential container.

• HEALTHY - The dependency container has passed its Docker health check. Use this condition with dependency containers that have health checks configured. This condition is confirmed at container group startup only.

See Also:

ContainerDependencyCondition

conditionAsString

public final String conditionAsString()

The condition that the dependency container must reach before the dependent container can start. Valid conditions include:

• START - The dependency container must have started.

• COMPLETE - The dependency container has run to completion (exits). Use this condition with nonessential containers, such as those that run a script and then exit. The dependency container can't be an essential container.

• SUCCESS - The dependency container has run to completion and exited with a zero status. The dependency container can't be an essential container.

• HEALTHY - The dependency container has passed its Docker health check. Use this condition with dependency containers that have health checks configured. This condition is confirmed at container group startup only.

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

Returns:

The condition that the dependency container must reach before the dependent container can start. Valid conditions include:

• START - The dependency container must have started.

• COMPLETE - The dependency container has run to completion (exits). Use this condition with nonessential containers, such as those that run a script and then exit. The dependency container can't be an essential container.

• SUCCESS - The dependency container has run to completion and exited with a zero status. The dependency container can't be an essential container.

• HEALTHY - The dependency container has passed its Docker health check. Use this condition with dependency containers that have health checks configured. This condition is confirmed at container group startup only.

See Also:

ContainerDependencyCondition

toBuilder

public ContainerDependency.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ContainerDependency.Builder,ContainerDependency>

builder

public static ContainerDependency.Builder builder()

serializableBuilderClass

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