Class FleetDeployment

java.lang.Object
software.amazon.awssdk.services.gamelift.model.FleetDeployment
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<FleetDeployment.Builder,FleetDeployment>
@Generated("software.amazon.awssdk:codegen") public final class FleetDeployment extends Object implements SdkPojo, Serializable, ToCopyableBuilder<FleetDeployment.Builder,FleetDeployment>

Describes a container fleet deployment with updates to the fleet.

See Also:

  • Method Details

    • deploymentId

      public final String deploymentId()

      A unique identifier for the deployment.

      Returns:
      A unique identifier for the deployment.

    • fleetId

      public final String fleetId()

      A unique identifier for the container fleet.

      Returns:
      A unique identifier for the container fleet.

    • gameServerBinaryArn

      public final String gameServerBinaryArn()

      The unique identifier for the version of the game server container group definition that is being deployed.

      Returns:
      The unique identifier for the version of the game server container group definition that is being deployed.

    • rollbackGameServerBinaryArn

      public final String rollbackGameServerBinaryArn()

      The unique identifier for the version of the game server container group definition to roll back to if deployment fails.

      Returns:
      The unique identifier for the version of the game server container group definition to roll back to if deployment fails.

    • perInstanceBinaryArn

      public final String perInstanceBinaryArn()

      The unique identifier for the version of the per-instance container group definition that is being deployed.

      Returns:
      The unique identifier for the version of the per-instance container group definition that is being deployed.

    • rollbackPerInstanceBinaryArn

      public final String rollbackPerInstanceBinaryArn()

      The unique identifier for the version of the per-instance container group definition to roll back to if deployment fails.

      Returns:
      The unique identifier for the version of the per-instance container group definition to roll back to if deployment fails.

    • deploymentStatus

      public final DeploymentStatus deploymentStatus()

      The status of fleet deployment activity in the location.

      • IN_PROGRESS -- The deployment is in progress.

      • IMPAIRED -- The deployment failed and the fleet has some impaired containers.

      • COMPLETE -- The deployment has completed successfully.

      • ROLLBACK_IN_PROGRESS -- The deployment failed and rollback has been initiated.

      • ROLLBACK_IN_COMPLETE -- The deployment failed and rollback has been completed.

      • CANCELLED -- The deployment was cancelled.

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

      Returns:
      The status of fleet deployment activity in the location.

      • IN_PROGRESS -- The deployment is in progress.

      • IMPAIRED -- The deployment failed and the fleet has some impaired containers.

      • COMPLETE -- The deployment has completed successfully.

      • ROLLBACK_IN_PROGRESS -- The deployment failed and rollback has been initiated.

      • ROLLBACK_IN_COMPLETE -- The deployment failed and rollback has been completed.

      • CANCELLED -- The deployment was cancelled.

      See Also:

    • deploymentStatusAsString

      public final String deploymentStatusAsString()

      The status of fleet deployment activity in the location.

      • IN_PROGRESS -- The deployment is in progress.

      • IMPAIRED -- The deployment failed and the fleet has some impaired containers.

      • COMPLETE -- The deployment has completed successfully.

      • ROLLBACK_IN_PROGRESS -- The deployment failed and rollback has been initiated.

      • ROLLBACK_IN_COMPLETE -- The deployment failed and rollback has been completed.

      • CANCELLED -- The deployment was cancelled.

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

      Returns:
      The status of fleet deployment activity in the location.

      • IN_PROGRESS -- The deployment is in progress.

      • IMPAIRED -- The deployment failed and the fleet has some impaired containers.

      • COMPLETE -- The deployment has completed successfully.

      • ROLLBACK_IN_PROGRESS -- The deployment failed and rollback has been initiated.

      • ROLLBACK_IN_COMPLETE -- The deployment failed and rollback has been completed.

      • CANCELLED -- The deployment was cancelled.

      See Also:

    • deploymentConfiguration

      public final DeploymentConfiguration deploymentConfiguration()

      Instructions for how to deploy updates to a container fleet and what actions to take if the deployment fails.

      Returns:
      Instructions for how to deploy updates to a container fleet and what actions to take if the deployment fails.

    • creationTime

      public final Instant creationTime()

      A time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").

      Returns:
      A time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").

    • toBuilder

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

    • builder

      public static FleetDeployment.Builder builder()

    • serializableBuilderClass

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