Build (AWS Java SDK :: Services :: AWS GameLift 2.19.15 API)

java.lang.Object
- software.amazon.awssdk.services.gamelift.model.Build

All Implemented Interfaces:: Serializable, SdkPojo, ToCopyableBuilder<Build.Builder,Build>

@Generated(value="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:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface Build.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`Build.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`buildArn()` The Amazon Resource Name (ARN) assigned to a GameLift build resource and uniquely identifies it.
`static Build.Builder`	`builder()`
`String`	`buildId()` A unique identifier for the build.
`Instant`	`creationTime()` A time stamp indicating when this data object was created.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`String`	`name()` A descriptive label associated with a build.
`OperatingSystem`	`operatingSystem()` Operating system that the game server binaries are built to run on.
`String`	`operatingSystemAsString()` Operating system that the game server binaries are built to run on.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends Build.Builder>`	`serializableBuilderClass()`
`String`	`serverSdkVersion()` The GameLift Server SDK version used to develop your game server.
`Long`	`sizeOnDisk()` File size of the uploaded game build, expressed in bytes.
`BuildStatus`	`status()` Current status of the build.
`String`	`statusAsString()` Current status of the build.
`Build.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.
`String`	`version()` 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 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 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 do not need to be unique. It can be set using CreateBuild or UpdateBuild.
    
    Returns:
    
    A descriptive label associated with a build. Build names do not 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 do not need to be unique.
    
    Returns:
    
    Version information associated with a build or script. Version strings do not 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:
    
    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, 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:
    
    BuildStatus
  - 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:
    
    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.
    
    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:
    
    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 GameLift Server SDK version used to develop your game server.
    
    Returns:
    
    The GameLift Server SDK version used to develop your game server.
  - toBuilder
```
public Build.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<Build.Builder,Build>
  - 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)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - 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

Class Build

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

buildId

buildArn

name

version

status

statusAsString

sizeOnDisk

operatingSystem

operatingSystemAsString

creationTime

serverSdkVersion

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields