com.amazonaws.services.codedeploy.model

Class ListDeploymentsRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.codedeploy.model.ListDeploymentsRequest

All Implemented Interfaces:

Serializable

public class ListDeploymentsRequest
extends AmazonWebServiceRequest
implements Serializable

Container for the parameters to the ListDeployments operation.

Lists the deployments under a deployment group for an application registered within the AWS user account.

See Also:

AmazonCodeDeploy.listDeployments(ListDeploymentsRequest), Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
ListDeploymentsRequest()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getApplicationName() The name of an existing AWS CodeDeploy application within the AWS user account.
TimeRange	getCreateTimeRange() A deployment creation start- and end-time range for returning a subset of the list of deployments.
String	getDeploymentGroupName() The name of an existing deployment group for the specified application.
List<String>	getIncludeOnlyStatuses() A subset of deployments to list, by status: Created: Include in the resulting list created deployments. Queued: Include in the resulting list queued deployments. In Progress: Include in the resulting list in-progress deployments. Succeeded: Include in the resulting list succeeded deployments. Failed: Include in the resulting list failed deployments. Aborted: Include in the resulting list aborted deployments.
String	getNextToken() An identifier that was returned from the previous list deployments call, which can be used to return the next set of deployments in the list.
int	hashCode()
void	setApplicationName(String applicationName) The name of an existing AWS CodeDeploy application within the AWS user account.
void	setCreateTimeRange(TimeRange createTimeRange) A deployment creation start- and end-time range for returning a subset of the list of deployments.
void	setDeploymentGroupName(String deploymentGroupName) The name of an existing deployment group for the specified application.
void	setIncludeOnlyStatuses(Collection<String> includeOnlyStatuses) A subset of deployments to list, by status: Created: Include in the resulting list created deployments. Queued: Include in the resulting list queued deployments. In Progress: Include in the resulting list in-progress deployments. Succeeded: Include in the resulting list succeeded deployments. Failed: Include in the resulting list failed deployments. Aborted: Include in the resulting list aborted deployments.
void	setNextToken(String nextToken) An identifier that was returned from the previous list deployments call, which can be used to return the next set of deployments in the list.
String	toString() Returns a string representation of this object; useful for testing and debugging.
ListDeploymentsRequest	withApplicationName(String applicationName) The name of an existing AWS CodeDeploy application within the AWS user account.
ListDeploymentsRequest	withCreateTimeRange(TimeRange createTimeRange) A deployment creation start- and end-time range for returning a subset of the list of deployments.
ListDeploymentsRequest	withDeploymentGroupName(String deploymentGroupName) The name of an existing deployment group for the specified application.
ListDeploymentsRequest	withIncludeOnlyStatuses(Collection<String> includeOnlyStatuses) A subset of deployments to list, by status: Created: Include in the resulting list created deployments. Queued: Include in the resulting list queued deployments. In Progress: Include in the resulting list in-progress deployments. Succeeded: Include in the resulting list succeeded deployments. Failed: Include in the resulting list failed deployments. Aborted: Include in the resulting list aborted deployments.
ListDeploymentsRequest	withIncludeOnlyStatuses(DeploymentStatus... includeOnlyStatuses) A subset of deployments to list, by status: Created: Include in the resulting list created deployments. Queued: Include in the resulting list queued deployments. In Progress: Include in the resulting list in-progress deployments. Succeeded: Include in the resulting list succeeded deployments. Failed: Include in the resulting list failed deployments. Aborted: Include in the resulting list aborted deployments.
ListDeploymentsRequest	withIncludeOnlyStatuses(String... includeOnlyStatuses) A subset of deployments to list, by status: Created: Include in the resulting list created deployments. Queued: Include in the resulting list queued deployments. In Progress: Include in the resulting list in-progress deployments. Succeeded: Include in the resulting list succeeded deployments. Failed: Include in the resulting list failed deployments. Aborted: Include in the resulting list aborted deployments.
ListDeploymentsRequest	withNextToken(String nextToken) An identifier that was returned from the previous list deployments call, which can be used to return the next set of deployments in the list.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

copyBaseTo, copyPrivateRequestParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object

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

Constructor Detail

ListDeploymentsRequest

public ListDeploymentsRequest()

Method Detail

getApplicationName

public String getApplicationName()

The name of an existing AWS CodeDeploy application within the AWS user account.

Constraints:
Length: 1 - 100

Returns:

The name of an existing AWS CodeDeploy application within the AWS user account.

setApplicationName

public void setApplicationName(String applicationName)

The name of an existing AWS CodeDeploy application within the AWS user account.

Constraints:
Length: 1 - 100

Parameters:

applicationName - The name of an existing AWS CodeDeploy application within the AWS user account.

withApplicationName

public ListDeploymentsRequest withApplicationName(String applicationName)

The name of an existing AWS CodeDeploy application within the AWS user account.

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

Constraints:
Length: 1 - 100

Parameters:

applicationName - The name of an existing AWS CodeDeploy application within the AWS user account.

Returns:

A reference to this updated object so that method calls can be chained together.

getDeploymentGroupName

public String getDeploymentGroupName()

The name of an existing deployment group for the specified application.

Constraints:
Length: 1 - 100

Returns:

The name of an existing deployment group for the specified application.

setDeploymentGroupName

public void setDeploymentGroupName(String deploymentGroupName)

The name of an existing deployment group for the specified application.

Constraints:
Length: 1 - 100

Parameters:

deploymentGroupName - The name of an existing deployment group for the specified application.

withDeploymentGroupName

public ListDeploymentsRequest withDeploymentGroupName(String deploymentGroupName)

The name of an existing deployment group for the specified application.

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

Constraints:
Length: 1 - 100

Parameters:

deploymentGroupName - The name of an existing deployment group for the specified application.

Returns:

A reference to this updated object so that method calls can be chained together.

getIncludeOnlyStatuses

public List<String> getIncludeOnlyStatuses()

A subset of deployments to list, by status:

• Created: Include in the resulting list created deployments.
• Queued: Include in the resulting list queued deployments.
• In Progress: Include in the resulting list in-progress deployments.
• Succeeded: Include in the resulting list succeeded deployments.
• Failed: Include in the resulting list failed deployments.
• Aborted: Include in the resulting list aborted deployments.

Returns:

A subset of deployments to list, by status:

• Created: Include in the resulting list created deployments.
• Queued: Include in the resulting list queued deployments.
• In Progress: Include in the resulting list in-progress deployments.
• Succeeded: Include in the resulting list succeeded deployments.
• Failed: Include in the resulting list failed deployments.
• Aborted: Include in the resulting list aborted deployments.

setIncludeOnlyStatuses

public void setIncludeOnlyStatuses(Collection<String> includeOnlyStatuses)

A subset of deployments to list, by status:

• Created: Include in the resulting list created deployments.
• Queued: Include in the resulting list queued deployments.
• In Progress: Include in the resulting list in-progress deployments.
• Succeeded: Include in the resulting list succeeded deployments.
• Failed: Include in the resulting list failed deployments.
• Aborted: Include in the resulting list aborted deployments.

Parameters:

includeOnlyStatuses - A subset of deployments to list, by status:

• Created: Include in the resulting list created deployments.
• Queued: Include in the resulting list queued deployments.
• In Progress: Include in the resulting list in-progress deployments.
• Succeeded: Include in the resulting list succeeded deployments.
• Failed: Include in the resulting list failed deployments.
• Aborted: Include in the resulting list aborted deployments.

withIncludeOnlyStatuses

public ListDeploymentsRequest withIncludeOnlyStatuses(String... includeOnlyStatuses)

A subset of deployments to list, by status:

• Created: Include in the resulting list created deployments.
• Queued: Include in the resulting list queued deployments.
• In Progress: Include in the resulting list in-progress deployments.
• Succeeded: Include in the resulting list succeeded deployments.
• Failed: Include in the resulting list failed deployments.
• Aborted: Include in the resulting list aborted deployments.

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

Parameters:

includeOnlyStatuses - A subset of deployments to list, by status:

• Created: Include in the resulting list created deployments.
• Queued: Include in the resulting list queued deployments.
• In Progress: Include in the resulting list in-progress deployments.
• Succeeded: Include in the resulting list succeeded deployments.
• Failed: Include in the resulting list failed deployments.
• Aborted: Include in the resulting list aborted deployments.

Returns:

A reference to this updated object so that method calls can be chained together.

withIncludeOnlyStatuses

public ListDeploymentsRequest withIncludeOnlyStatuses(Collection<String> includeOnlyStatuses)

A subset of deployments to list, by status:

• Created: Include in the resulting list created deployments.
• Queued: Include in the resulting list queued deployments.
• In Progress: Include in the resulting list in-progress deployments.
• Succeeded: Include in the resulting list succeeded deployments.
• Failed: Include in the resulting list failed deployments.
• Aborted: Include in the resulting list aborted deployments.

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

Parameters:

includeOnlyStatuses - A subset of deployments to list, by status:

• Created: Include in the resulting list created deployments.
• Queued: Include in the resulting list queued deployments.
• In Progress: Include in the resulting list in-progress deployments.
• Succeeded: Include in the resulting list succeeded deployments.
• Failed: Include in the resulting list failed deployments.
• Aborted: Include in the resulting list aborted deployments.

Returns:

A reference to this updated object so that method calls can be chained together.

withIncludeOnlyStatuses

public ListDeploymentsRequest withIncludeOnlyStatuses(DeploymentStatus... includeOnlyStatuses)

A subset of deployments to list, by status:

• Created: Include in the resulting list created deployments.
• Queued: Include in the resulting list queued deployments.
• In Progress: Include in the resulting list in-progress deployments.
• Succeeded: Include in the resulting list succeeded deployments.
• Failed: Include in the resulting list failed deployments.
• Aborted: Include in the resulting list aborted deployments.

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

Parameters:

includeOnlyStatuses - A subset of deployments to list, by status:

• Created: Include in the resulting list created deployments.
• Queued: Include in the resulting list queued deployments.
• In Progress: Include in the resulting list in-progress deployments.
• Succeeded: Include in the resulting list succeeded deployments.
• Failed: Include in the resulting list failed deployments.
• Aborted: Include in the resulting list aborted deployments.

Returns:

A reference to this updated object so that method calls can be chained together.

getCreateTimeRange

public TimeRange getCreateTimeRange()

A deployment creation start- and end-time range for returning a subset of the list of deployments.

Returns:

A deployment creation start- and end-time range for returning a subset of the list of deployments.

setCreateTimeRange

public void setCreateTimeRange(TimeRange createTimeRange)

A deployment creation start- and end-time range for returning a subset of the list of deployments.

Parameters:

createTimeRange - A deployment creation start- and end-time range for returning a subset of the list of deployments.

withCreateTimeRange

public ListDeploymentsRequest withCreateTimeRange(TimeRange createTimeRange)

A deployment creation start- and end-time range for returning a subset of the list of deployments.

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

Parameters:

createTimeRange - A deployment creation start- and end-time range for returning a subset of the list of deployments.

Returns:

A reference to this updated object so that method calls can be chained together.

getNextToken

public String getNextToken()

An identifier that was returned from the previous list deployments call, which can be used to return the next set of deployments in the list.

Returns:

An identifier that was returned from the previous list deployments call, which can be used to return the next set of deployments in the list.

setNextToken

public void setNextToken(String nextToken)

An identifier that was returned from the previous list deployments call, which can be used to return the next set of deployments in the list.

Parameters:

nextToken - An identifier that was returned from the previous list deployments call, which can be used to return the next set of deployments in the list.

withNextToken

public ListDeploymentsRequest withNextToken(String nextToken)

An identifier that was returned from the previous list deployments call, which can be used to return the next set of deployments in the list.

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

Parameters:

nextToken - An identifier that was returned from the previous list deployments call, which can be used to return the next set of deployments in the list.

Returns:

A reference to this updated 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()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object