software.amazon.awssdk.services.gamelift.model

Class ListBuildsRequest

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.ListBuildsRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<ListBuildsRequest.Builder,ListBuildsRequest>

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

Represents the input for a request action.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ListBuildsRequest.Builder

Method Summary

Modifier and Type	Method and Description
static ListBuildsRequest.Builder	builder()
boolean	equals(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extends SdkRequest.
int	hashCode()
Integer	limit() Maximum number of results to return.
String	nextToken() Token that indicates the start of the next sequential page of results.
List<SdkField<?>>	sdkFields()
static Class<? extends ListBuildsRequest.Builder>	serializableBuilderClass()
BuildStatus	status() Build status to filter results by.
String	statusAsString() Build status to filter results by.
ListBuildsRequest.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()

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

overrideConfiguration

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

status

public BuildStatus status()

Build status to filter results by. To retrieve all builds, leave this parameter empty.

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:

Build status to filter results by. To retrieve all builds, leave this parameter empty.

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 String statusAsString()

Build status to filter results by. To retrieve all builds, leave this parameter empty.

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:

Build status to filter results by. To retrieve all builds, leave this parameter empty.

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

limit

public Integer limit()

Maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.

Returns:

Maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.

nextToken

public String nextToken()

Token that indicates the start of the next sequential page of results. Use the token that is returned with a previous call to this action. To start at the beginning of the result set, do not specify a value.

Returns:

Token that indicates the start of the next sequential page of results. Use the token that is returned with a previous call to this action. To start at the beginning of the result set, do not specify a value.

toBuilder

public ListBuildsRequest.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<ListBuildsRequest.Builder,ListBuildsRequest>

Specified by:

toBuilder in class GameLiftRequest

Returns:

a builder for type T

builder

public static ListBuildsRequest.Builder builder()

serializableBuilderClass

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

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

Description copied from class: SdkRequest

Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.

Overrides:

getValueForField in class SdkRequest

Parameters:

fieldName - The name of the member to be retrieved.

clazz - The class to cast the returned object to.

Returns:

Optional containing the casted return value

sdkFields

public 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.