Class ListBuildsRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.gamelift.model.ListBuildsRequest

All Implemented Interfaces:

ReadLimitInfo, Serializable, Cloneable

public class ListBuildsRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

Represents the input for a request action.

See Also:

• Serialized Form

Field Summary

Fields inherited from class AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor	Description
ListBuildsRequest()

Method Summary

Modifier and Type	Method	Description
ListBuildsRequest	clone()	Creates a shallow clone of this request.
boolean	equals(Object obj)
Integer	getLimit()	Maximum number of results to return.
String	getNextToken()	Token indicating the start of the next sequential page of results.
String	getStatus()	Build state to filter results on.
int	hashCode()
void	setLimit(Integer limit)	Maximum number of results to return.
void	setNextToken(String nextToken)	Token indicating the start of the next sequential page of results.
void	setStatus(BuildStatus status)	Build state to filter results on.
void	setStatus(String status)	Build state to filter results on.
String	toString()	Returns a string representation of this object; useful for testing and debugging.
ListBuildsRequest	withLimit(Integer limit)	Maximum number of results to return.
ListBuildsRequest	withNextToken(String nextToken)	Token indicating the start of the next sequential page of results.
ListBuildsRequest	withStatus(BuildStatus status)	Build state to filter results on.
ListBuildsRequest	withStatus(String status)	Build state to filter results on.

Methods inherited from class AmazonWebServiceRequest

copyBaseTo, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

ListBuildsRequest

public ListBuildsRequest()

Method Details

setStatus

public void setStatus(String status)

Build state to filter results on. Use this parameter to retrieve builds in a certain state. To retrieve all builds, leave this parameter empty. Possible build states include:

• INITIALIZED: A new build has been defined, but no files have been uploaded. You cannot create fleets for builds that are in this state. When a build is successfully created, the build state 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.

Parameters:

status - Build state to filter results on. Use this parameter to retrieve builds in a certain state. To retrieve all builds, leave this parameter empty. Possible build states include:

• INITIALIZED: A new build has been defined, but no files have been uploaded. You cannot create fleets for builds that are in this state. When a build is successfully created, the build state 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

getStatus

public String getStatus()

Build state to filter results on. Use this parameter to retrieve builds in a certain state. To retrieve all builds, leave this parameter empty. Possible build states include:

• INITIALIZED: A new build has been defined, but no files have been uploaded. You cannot create fleets for builds that are in this state. When a build is successfully created, the build state 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.

Returns:

Build state to filter results on. Use this parameter to retrieve builds in a certain state. To retrieve all builds, leave this parameter empty. Possible build states include:

• INITIALIZED: A new build has been defined, but no files have been uploaded. You cannot create fleets for builds that are in this state. When a build is successfully created, the build state 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

withStatus

public ListBuildsRequest withStatus(String status)

Build state to filter results on. Use this parameter to retrieve builds in a certain state. To retrieve all builds, leave this parameter empty. Possible build states include:

• INITIALIZED: A new build has been defined, but no files have been uploaded. You cannot create fleets for builds that are in this state. When a build is successfully created, the build state 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.

Parameters:

status - Build state to filter results on. Use this parameter to retrieve builds in a certain state. To retrieve all builds, leave this parameter empty. Possible build states include:

• INITIALIZED: A new build has been defined, but no files have been uploaded. You cannot create fleets for builds that are in this state. When a build is successfully created, the build state 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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• BuildStatus

setStatus

public void setStatus(BuildStatus status)

Build state to filter results on. Use this parameter to retrieve builds in a certain state. To retrieve all builds, leave this parameter empty. Possible build states include:

• INITIALIZED: A new build has been defined, but no files have been uploaded. You cannot create fleets for builds that are in this state. When a build is successfully created, the build state 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.

Parameters:

status - Build state to filter results on. Use this parameter to retrieve builds in a certain state. To retrieve all builds, leave this parameter empty. Possible build states include:

• INITIALIZED: A new build has been defined, but no files have been uploaded. You cannot create fleets for builds that are in this state. When a build is successfully created, the build state 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

withStatus

public ListBuildsRequest withStatus(BuildStatus status)

Build state to filter results on. Use this parameter to retrieve builds in a certain state. To retrieve all builds, leave this parameter empty. Possible build states include:

• INITIALIZED: A new build has been defined, but no files have been uploaded. You cannot create fleets for builds that are in this state. When a build is successfully created, the build state 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.

Parameters:

status - Build state to filter results on. Use this parameter to retrieve builds in a certain state. To retrieve all builds, leave this parameter empty. Possible build states include:

• INITIALIZED: A new build has been defined, but no files have been uploaded. You cannot create fleets for builds that are in this state. When a build is successfully created, the build state 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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• BuildStatus

setLimit

public void setLimit(Integer limit)

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

Parameters:

limit - Maximum number of results to return. You can use this parameter with NextToken to get results as a set of sequential pages.

getLimit

public Integer getLimit()

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

Returns:

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

withLimit

public ListBuildsRequest withLimit(Integer limit)

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

Parameters:

limit - Maximum number of results to return. You can use this parameter with NextToken to get results as a set of sequential pages.

Returns:

Returns a reference to this object so that method calls can be chained together.

setNextToken

public void setNextToken(String nextToken)

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

Parameters:

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

getNextToken

public String getNextToken()

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

Returns:

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

withNextToken

public ListBuildsRequest withNextToken(String nextToken)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

toString

public String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

• Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public ListBuildsRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this request. Explicitly does not clone the deep structure of the request object.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

• Object.clone()