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

Class Build

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

Properties describing a custom game build.

All APIs by task

See Also:

  • Method Details

    • buildId

      public final String buildId()

      A unique identifier for the build.

      Returns:
      A unique identifier for the build.

    • buildArn

      public final String buildArn()

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

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

    • name

      public final String name()

      A descriptive label associated with a build. Build names don't need to be unique. It can be set using CreateBuild or UpdateBuild.

      Returns:
      A descriptive label associated with a build. Build names don't need to be unique. It can be set using CreateBuild or UpdateBuild.

    • version

      public final String version()

      Version information associated with a build or script. Version strings don't need to be unique.

      Returns:
      Version information associated with a build or script. Version strings don't need to be unique.

    • status

      public final BuildStatus status()

      Current status of the build.

      Possible build statuses include the following:

      • INITIALIZED -- A new build has been defined, but no files have been uploaded. You cannot create fleets for builds that are in this status. When a build is successfully created, the build status is set to this value.

      • READY -- The game build has been successfully uploaded. You can now create new fleets for this build.

      • FAILED -- The game build upload failed. You cannot create new fleets for this build.

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

      Returns:
      Current status of the build.

      Possible build statuses include the following:

      • INITIALIZED -- A new build has been defined, but no files have been uploaded. You cannot create fleets for builds that are in this status. When a build is successfully created, the build status is set to this value.

      • READY -- The game build has been successfully uploaded. You can now create new fleets for this build.

      • FAILED -- The game build upload failed. You cannot create new fleets for this build.

      See Also:

    • statusAsString

      public final String statusAsString()

      Current status of the build.

      Possible build statuses include the following:

      • INITIALIZED -- A new build has been defined, but no files have been uploaded. You cannot create fleets for builds that are in this status. When a build is successfully created, the build status is set to this value.

      • READY -- The game build has been successfully uploaded. You can now create new fleets for this build.

      • FAILED -- The game build upload failed. You cannot create new fleets for this build.

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

      Returns:
      Current status of the build.

      Possible build statuses include the following:

      • INITIALIZED -- A new build has been defined, but no files have been uploaded. You cannot create fleets for builds that are in this status. When a build is successfully created, the build status is set to this value.

      • READY -- The game build has been successfully uploaded. You can now create new fleets for this build.

      • FAILED -- The game build upload failed. You cannot create new fleets for this build.

      See Also:

    • sizeOnDisk

      public final Long sizeOnDisk()

      File size of the uploaded game build, expressed in bytes. When the build status is INITIALIZED or when using a custom Amazon S3 storage location, this value is 0.

      Returns:
      File size of the uploaded game build, expressed in bytes. When the build status is INITIALIZED or when using a custom Amazon S3 storage location, this value is 0.

    • operatingSystem

      public final OperatingSystem operatingSystem()

      Operating system that the game server binaries are built to run on. This value determines the type of fleet resources that you can use for this build.

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

      Returns:
      Operating system that the game server binaries are built to run on. This value determines the type of fleet resources that you can use for this build.
      See Also:

    • operatingSystemAsString

      public final String operatingSystemAsString()

      Operating system that the game server binaries are built to run on. This value determines the type of fleet resources that you can use for this build.

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

      Returns:
      Operating system that the game server binaries are built to run on. This value determines the type of fleet resources that you can use for this build.
      See Also:

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

    • serverSdkVersion

      public final String serverSdkVersion()

      The Amazon GameLift Server SDK version used to develop your game server.

      Returns:
      The Amazon GameLift Server SDK version used to develop your game server.

    • toBuilder

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

    • builder

      public static Build.Builder builder()

    • serializableBuilderClass

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