software.amazon.awssdk.services.gamelift.model

Class CreateBuildRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.gamelift.model.GameLiftRequest

software.amazon.awssdk.services.gamelift.model.CreateBuildRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateBuildRequest.Builder,CreateBuildRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class CreateBuildRequest
extends GameLiftRequest
implements ToCopyableBuilder<CreateBuildRequest.Builder,CreateBuildRequest>

Represents the input for a request operation.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CreateBuildRequest.Builder

Method Summary

Modifier and Type	Method and Description
static CreateBuildRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasTags() Returns true if the Tags property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
String	name() A descriptive label that is associated with a build.
OperatingSystem	operatingSystem() The operating system that the game server binaries are built to run on.
String	operatingSystemAsString() The operating system that the game server binaries are built to run on.
List<SdkField<?>>	sdkFields()
static Class<? extends CreateBuildRequest.Builder>	serializableBuilderClass()
S3Location	storageLocation() The location where your game build files are stored.
List<Tag>	tags() A list of labels to assign to the new build resource.
CreateBuildRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.
String	version() Version information that is associated with a build or script.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

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

name

public final String name()

A descriptive label that is associated with a build. Build names do not need to be unique. You can use UpdateBuild to change this value later.

Returns:

A descriptive label that is associated with a build. Build names do not need to be unique. You can use UpdateBuild to change this value later.

version

public final String version()

Version information that is associated with a build or script. Version strings do not need to be unique. You can use UpdateBuild to change this value later.

Returns:

Version information that is associated with a build or script. Version strings do not need to be unique. You can use UpdateBuild to change this value later.

storageLocation

public final S3Location storageLocation()

The location where your game build files are stored. Use this parameter only when creating a build using files that are stored in an S3 bucket that you own. Identify an S3 bucket name and key, which must in the same Region where you're creating a build. This parameter must also specify the ARN for an IAM role that you've set up to give Amazon GameLift access your S3 bucket. To call this operation with a storage location, you must have IAM PassRole permission. For more details on IAM roles and PassRole permissions, see Set up a role for GameLift access.

Returns:

The location where your game build files are stored. Use this parameter only when creating a build using files that are stored in an S3 bucket that you own. Identify an S3 bucket name and key, which must in the same Region where you're creating a build. This parameter must also specify the ARN for an IAM role that you've set up to give Amazon GameLift access your S3 bucket. To call this operation with a storage location, you must have IAM PassRole permission. For more details on IAM roles and PassRole permissions, see Set up a role for GameLift access.

operatingSystem

public final OperatingSystem operatingSystem()

The 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 your game build contains multiple executables, they all must run on the same operating system. If an operating system is not specified when creating a build, Amazon GameLift uses the default value (WINDOWS_2012). This value cannot be changed later.

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:

The 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 your game build contains multiple executables, they all must run on the same operating system. If an operating system is not specified when creating a build, Amazon GameLift uses the default value (WINDOWS_2012). This value cannot be changed later.

See Also:

OperatingSystem

operatingSystemAsString

public final String operatingSystemAsString()

The 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 your game build contains multiple executables, they all must run on the same operating system. If an operating system is not specified when creating a build, Amazon GameLift uses the default value (WINDOWS_2012). This value cannot be changed later.

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:

The 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 your game build contains multiple executables, they all must run on the same operating system. If an operating system is not specified when creating a build, Amazon GameLift uses the default value (WINDOWS_2012). This value cannot be changed later.

See Also:

OperatingSystem

hasTags

public final boolean hasTags()

Returns true if the Tags property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

tags

public final List<Tag> tags()

A list of labels to assign to the new build resource. Tags are developer-defined key-value pairs. Tagging AWS resources are useful for resource management, access management and cost allocation. For more information, see Tagging AWS Resources in the AWS General Reference. Once the resource is created, you can use TagResource, UntagResource, and ListTagsForResource to add, remove, and view tags. The maximum tag limit may be lower than stated. See the AWS General Reference for actual tagging limits.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

You can use hasTags() to see if a value was sent in this field.

Returns:

A list of labels to assign to the new build resource. Tags are developer-defined key-value pairs. Tagging AWS resources are useful for resource management, access management and cost allocation. For more information, see Tagging AWS Resources in the AWS General Reference. Once the resource is created, you can use TagResource, UntagResource, and ListTagsForResource to add, remove, and view tags. The maximum tag limit may be lower than stated. See the AWS General Reference for actual tagging limits.

toBuilder

public CreateBuildRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateBuildRequest.Builder,CreateBuildRequest>

Specified by:

toBuilder in class GameLiftRequest

builder

public static CreateBuildRequest.Builder builder()

serializableBuilderClass

public static Class<? extends CreateBuildRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

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)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo