Class Build
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<Build.Builder,
Build>
Properties describing a custom game build.
- See Also:
-
Nested Class Summary
Nested Classes -
Method Summary
Modifier and TypeMethodDescriptionfinal String
buildArn()
The Amazon Resource Name (ARN) assigned to a Amazon GameLift build resource and uniquely identifies it.static Build.Builder
builder()
final String
buildId()
A unique identifier for the build.final Instant
A time stamp indicating when this data object was created.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final String
name()
A descriptive label associated with a build.final OperatingSystem
Operating system that the game server binaries are built to run on.final String
Operating system that the game server binaries are built to run on.static Class
<? extends Build.Builder> final String
The Amazon GameLift Server SDK version used to develop your game server.final Long
File size of the uploaded game build, expressed in bytes.final BuildStatus
status()
Current status of the build.final String
Current status of the build.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final String
version()
Version information associated with a build or script.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
buildId
A unique identifier for the build.
- Returns:
- A unique identifier for the build.
-
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
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
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
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 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:
-
-
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 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:
-
-
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
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 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.
- See Also:
-
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 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.
- See Also:
-
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
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
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 interfaceToCopyableBuilder<Build.Builder,
Build> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-