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.
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceBuild.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description StringbuildArn()The Amazon Resource Name (ARN) assigned to a Amazon GameLift build resource and uniquely identifies it.static Build.Builderbuilder()StringbuildId()A unique identifier for the build.InstantcreationTime()A time stamp indicating when this data object was created.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)inthashCode()Stringname()A descriptive label associated with a build.OperatingSystemoperatingSystem()Operating system that the game server binaries are built to run on.StringoperatingSystemAsString()Operating system that the game server binaries are built to run on.List<SdkField<?>>sdkFields()static Class<? extends Build.Builder>serializableBuilderClass()StringserverSdkVersion()The Amazon GameLift Server SDK version used to develop your game server.LongsizeOnDisk()File size of the uploaded game build, expressed in bytes.BuildStatusstatus()Current status of the build.StringstatusAsString()Current status of the build.Build.BuildertoBuilder()StringtoString()Returns a string representation of this object.Stringversion()Version information associated with a build or script.-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
-
-
-
Method Detail
-
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,
statuswill returnBuildStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromstatusAsString().- 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:
BuildStatus
-
-
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,
statuswill returnBuildStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromstatusAsString().- 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:
BuildStatus
-
-
sizeOnDisk
public final Long sizeOnDisk()
File size of the uploaded game build, expressed in bytes. When the build status is
INITIALIZEDor 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
INITIALIZEDor 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.
Amazon Linux 2 (AL2) will reach end of support on 6/30/2025. See more details in the Amazon Linux 2 FAQs. For game servers that are hosted on AL2 and use Amazon GameLift server SDK 4.x., first update the game server build to server SDK 5.x, and then deploy to AL2023 instances. See Migrate to Amazon GameLift server SDK version 5.
If the service returns an enum value that is not available in the current SDK version,
operatingSystemwill returnOperatingSystem.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromoperatingSystemAsString().- 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.
Amazon Linux 2 (AL2) will reach end of support on 6/30/2025. See more details in the Amazon Linux 2 FAQs. For game servers that are hosted on AL2 and use Amazon GameLift server SDK 4.x., first update the game server build to server SDK 5.x, and then deploy to AL2023 instances. See Migrate to Amazon GameLift server SDK version 5.
- See Also:
OperatingSystem
-
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.
Amazon Linux 2 (AL2) will reach end of support on 6/30/2025. See more details in the Amazon Linux 2 FAQs. For game servers that are hosted on AL2 and use Amazon GameLift server SDK 4.x., first update the game server build to server SDK 5.x, and then deploy to AL2023 instances. See Migrate to Amazon GameLift server SDK version 5.
If the service returns an enum value that is not available in the current SDK version,
operatingSystemwill returnOperatingSystem.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromoperatingSystemAsString().- 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.
Amazon Linux 2 (AL2) will reach end of support on 6/30/2025. See more details in the Amazon Linux 2 FAQs. For game servers that are hosted on AL2 and use Amazon GameLift server SDK 4.x., first update the game server build to server SDK 5.x, and then deploy to AL2023 instances. See Migrate to Amazon GameLift server SDK version 5.
- See Also:
OperatingSystem
-
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()
- Specified by:
toBuilderin interfaceToCopyableBuilder<Build.Builder,Build>
-
builder
public static Build.Builder builder()
-
serializableBuilderClass
public static Class<? extends Build.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
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.
-
-