Class Alias

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

Properties that describe an alias resource.

Related actions

All APIs by task

See Also:

  • Method Details

    • aliasId

      public final String aliasId()

      A unique identifier for the alias. Alias IDs are unique within a Region.

      Returns:
      A unique identifier for the alias. Alias IDs are unique within a Region.

    • name

      public final String name()

      A descriptive label that is associated with an alias. Alias names do not need to be unique.

      Returns:
      A descriptive label that is associated with an alias. Alias names do not need to be unique.

    • aliasArn

      public final String aliasArn()

      The Amazon Resource Name (ARN) that is assigned to a Amazon GameLift Servers alias resource and uniquely identifies it. ARNs are unique across all Regions. Format is arn:aws:gamelift:<region>::alias/alias-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912. In a GameLift alias ARN, the resource ID matches the alias ID value.

      Returns:
      The Amazon Resource Name (ARN) that is assigned to a Amazon GameLift Servers alias resource and uniquely identifies it. ARNs are unique across all Regions. Format is arn:aws:gamelift:<region>::alias/alias-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912. In a GameLift alias ARN, the resource ID matches the alias ID value.

    • description

      public final String description()

      A human-readable description of an alias.

      Returns:
      A human-readable description of an alias.

    • routingStrategy

      public final RoutingStrategy routingStrategy()

      The routing configuration, including routing type and fleet target, for the alias.

      Returns:
      The routing configuration, including routing type and fleet target, for the alias.

    • 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").

    • lastUpdatedTime

      public final Instant lastUpdatedTime()

      The time that this data object was last modified. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").

      Returns:
      The time that this data object was last modified. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").

    • toBuilder

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

    • builder

      public static Alias.Builder builder()

    • serializableBuilderClass

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