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>

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: GameServerContainerDefinition, GameServerContainerDefinitionInput, SupportContainerDefinition, SupportContainerDefinitionInput

See Also:

  • Method Details

    • 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:

    • 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:

    • toBuilder

      public ContainerDependency.Builder 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 interface ToCopyableBuilder<ContainerDependency.Builder,ContainerDependency>
      Returns:
      a builder for type T

    • 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)
      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 an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.