Class ContainerFleetLocationAttributes

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

Details about a location in a multi-location container fleet.

See Also:

  • Method Details

    • location

      public final String location()

      A location identifier.

      Returns:
      A location identifier.

    • status

      public final ContainerFleetLocationStatus status()

      The status of fleet activity in the location.

      • PENDING -- A new container fleet has been requested.

      • CREATING -- A new container fleet resource is being created.

      • CREATED -- A new container fleet resource has been created. No fleet instances have been deployed.

      • ACTIVATING -- New container fleet instances are being deployed.

      • ACTIVE -- The container fleet has been deployed and is ready to host game sessions.

      • UPDATING -- Updates to the container fleet is being updated. A deployment is in progress.

      • EXPIRED -- The container fleet has been expired. The fleet is scaled down to zero instances and cannot host new game sessions.

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

      Returns:
      The status of fleet activity in the location.

      • PENDING -- A new container fleet has been requested.

      • CREATING -- A new container fleet resource is being created.

      • CREATED -- A new container fleet resource has been created. No fleet instances have been deployed.

      • ACTIVATING -- New container fleet instances are being deployed.

      • ACTIVE -- The container fleet has been deployed and is ready to host game sessions.

      • UPDATING -- Updates to the container fleet is being updated. A deployment is in progress.

      • EXPIRED -- The container fleet has been expired. The fleet is scaled down to zero instances and cannot host new game sessions.

      See Also:

    • statusAsString

      public final String statusAsString()

      The status of fleet activity in the location.

      • PENDING -- A new container fleet has been requested.

      • CREATING -- A new container fleet resource is being created.

      • CREATED -- A new container fleet resource has been created. No fleet instances have been deployed.

      • ACTIVATING -- New container fleet instances are being deployed.

      • ACTIVE -- The container fleet has been deployed and is ready to host game sessions.

      • UPDATING -- Updates to the container fleet is being updated. A deployment is in progress.

      • EXPIRED -- The container fleet has been expired. The fleet is scaled down to zero instances and cannot host new game sessions.

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

      Returns:
      The status of fleet activity in the location.

      • PENDING -- A new container fleet has been requested.

      • CREATING -- A new container fleet resource is being created.

      • CREATED -- A new container fleet resource has been created. No fleet instances have been deployed.

      • ACTIVATING -- New container fleet instances are being deployed.

      • ACTIVE -- The container fleet has been deployed and is ready to host game sessions.

      • UPDATING -- Updates to the container fleet is being updated. A deployment is in progress.

      • EXPIRED -- The container fleet has been expired. The fleet is scaled down to zero instances and cannot host new game sessions.

      See Also:

    • playerGatewayStatus

      public final PlayerGatewayStatus playerGatewayStatus()

      The current status of player gateway in this location for this container fleet. Note, even if a container fleet has PlayerGatewayMode configured as ENABLED, player gateway might not be available in a specific location. For more information about locations where player gateway is supported, see Amazon GameLift Servers service locations.

      Possible values include:

      • ENABLED -- Player gateway is available for this container fleet location.

      • DISABLED -- Player gateway is not available for this container fleet location.

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

      Returns:
      The current status of player gateway in this location for this container fleet. Note, even if a container fleet has PlayerGatewayMode configured as ENABLED, player gateway might not be available in a specific location. For more information about locations where player gateway is supported, see Amazon GameLift Servers service locations.

      Possible values include:

      • ENABLED -- Player gateway is available for this container fleet location.

      • DISABLED -- Player gateway is not available for this container fleet location.

      See Also:

    • playerGatewayStatusAsString

      public final String playerGatewayStatusAsString()

      The current status of player gateway in this location for this container fleet. Note, even if a container fleet has PlayerGatewayMode configured as ENABLED, player gateway might not be available in a specific location. For more information about locations where player gateway is supported, see Amazon GameLift Servers service locations.

      Possible values include:

      • ENABLED -- Player gateway is available for this container fleet location.

      • DISABLED -- Player gateway is not available for this container fleet location.

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

      Returns:
      The current status of player gateway in this location for this container fleet. Note, even if a container fleet has PlayerGatewayMode configured as ENABLED, player gateway might not be available in a specific location. For more information about locations where player gateway is supported, see Amazon GameLift Servers service locations.

      Possible values include:

      • ENABLED -- Player gateway is available for this container fleet location.

      • DISABLED -- Player gateway is not available for this container fleet location.

      See Also:

    • toBuilder

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

    • builder

      public static ContainerFleetLocationAttributes.Builder builder()

    • serializableBuilderClass

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