com.amazonaws.services.codedeploy.model

Class ListApplicationRevisionsRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.codedeploy.model.ListApplicationRevisionsRequest

All Implemented Interfaces:

Serializable

public class ListApplicationRevisionsRequest
extends AmazonWebServiceRequest
implements Serializable

Container for the parameters to the ListApplicationRevisions operation.

Lists information about revisions for an application.

See Also:

AmazonCodeDeploy.listApplicationRevisions(ListApplicationRevisionsRequest), Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
ListApplicationRevisionsRequest()

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.
String	getDeployed() Whether to list revisions based on whether the revision is the target revision of an deployment group: include: List revisions that are target revisions of a deployment group. exclude: Do not list revisions that are target revisions of a deployment group. ignore: List all revisions, regardless of whether they are target revisions of a deployment group.
String	getNextToken() An identifier that was returned from the previous list application revisions call, which can be used to return the next set of applications in the list.
String	getS3Bucket() A specific Amazon S3 bucket name to limit the search for revisions.
String	getS3KeyPrefix() A specific key prefix for the set of Amazon S3 objects to limit the search for revisions.
String	getSortBy() The column name to sort the list results by: registerTime: Sort the list results by when the revisions were registered with AWS CodeDeploy. firstUsedTime: Sort the list results by when the revisions were first used by in a deployment. lastUsedTime: Sort the list results by when the revisions were last used in a deployment.
String	getSortOrder() The order to sort the list results by: ascending: Sort the list results in ascending order. descending: Sort the list results in descending order.
int	hashCode()
void	setApplicationName(String applicationName) The name of an existing AWS CodeDeploy application within the AWS user account.
void	setDeployed(ListStateFilterAction deployed) Whether to list revisions based on whether the revision is the target revision of an deployment group: include: List revisions that are target revisions of a deployment group. exclude: Do not list revisions that are target revisions of a deployment group. ignore: List all revisions, regardless of whether they are target revisions of a deployment group.
void	setDeployed(String deployed) Whether to list revisions based on whether the revision is the target revision of an deployment group: include: List revisions that are target revisions of a deployment group. exclude: Do not list revisions that are target revisions of a deployment group. ignore: List all revisions, regardless of whether they are target revisions of a deployment group.
void	setNextToken(String nextToken) An identifier that was returned from the previous list application revisions call, which can be used to return the next set of applications in the list.
void	setS3Bucket(String s3Bucket) A specific Amazon S3 bucket name to limit the search for revisions.
void	setS3KeyPrefix(String s3KeyPrefix) A specific key prefix for the set of Amazon S3 objects to limit the search for revisions.
void	setSortBy(ApplicationRevisionSortBy sortBy) The column name to sort the list results by: registerTime: Sort the list results by when the revisions were registered with AWS CodeDeploy. firstUsedTime: Sort the list results by when the revisions were first used by in a deployment. lastUsedTime: Sort the list results by when the revisions were last used in a deployment.
void	setSortBy(String sortBy) The column name to sort the list results by: registerTime: Sort the list results by when the revisions were registered with AWS CodeDeploy. firstUsedTime: Sort the list results by when the revisions were first used by in a deployment. lastUsedTime: Sort the list results by when the revisions were last used in a deployment.
void	setSortOrder(SortOrder sortOrder) The order to sort the list results by: ascending: Sort the list results in ascending order. descending: Sort the list results in descending order.
void	setSortOrder(String sortOrder) The order to sort the list results by: ascending: Sort the list results in ascending order. descending: Sort the list results in descending order.
String	toString() Returns a string representation of this object; useful for testing and debugging.
ListApplicationRevisionsRequest	withApplicationName(String applicationName) The name of an existing AWS CodeDeploy application within the AWS user account.
ListApplicationRevisionsRequest	withDeployed(ListStateFilterAction deployed) Whether to list revisions based on whether the revision is the target revision of an deployment group: include: List revisions that are target revisions of a deployment group. exclude: Do not list revisions that are target revisions of a deployment group. ignore: List all revisions, regardless of whether they are target revisions of a deployment group.
ListApplicationRevisionsRequest	withDeployed(String deployed) Whether to list revisions based on whether the revision is the target revision of an deployment group: include: List revisions that are target revisions of a deployment group. exclude: Do not list revisions that are target revisions of a deployment group. ignore: List all revisions, regardless of whether they are target revisions of a deployment group.
ListApplicationRevisionsRequest	withNextToken(String nextToken) An identifier that was returned from the previous list application revisions call, which can be used to return the next set of applications in the list.
ListApplicationRevisionsRequest	withS3Bucket(String s3Bucket) A specific Amazon S3 bucket name to limit the search for revisions.
ListApplicationRevisionsRequest	withS3KeyPrefix(String s3KeyPrefix) A specific key prefix for the set of Amazon S3 objects to limit the search for revisions.
ListApplicationRevisionsRequest	withSortBy(ApplicationRevisionSortBy sortBy) The column name to sort the list results by: registerTime: Sort the list results by when the revisions were registered with AWS CodeDeploy. firstUsedTime: Sort the list results by when the revisions were first used by in a deployment. lastUsedTime: Sort the list results by when the revisions were last used in a deployment.
ListApplicationRevisionsRequest	withSortBy(String sortBy) The column name to sort the list results by: registerTime: Sort the list results by when the revisions were registered with AWS CodeDeploy. firstUsedTime: Sort the list results by when the revisions were first used by in a deployment. lastUsedTime: Sort the list results by when the revisions were last used in a deployment.
ListApplicationRevisionsRequest	withSortOrder(SortOrder sortOrder) The order to sort the list results by: ascending: Sort the list results in ascending order. descending: Sort the list results in descending order.
ListApplicationRevisionsRequest	withSortOrder(String sortOrder) The order to sort the list results by: ascending: Sort the list results in ascending order. descending: Sort the list results in descending order.

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

ListApplicationRevisionsRequest

public ListApplicationRevisionsRequest()

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

getSortBy

public String getSortBy()

The column name to sort the list results by:

• registerTime: Sort the list results by when the revisions were registered with AWS CodeDeploy.
• firstUsedTime: Sort the list results by when the revisions were first used by in a deployment.
• lastUsedTime: Sort the list results by when the revisions were last used in a deployment.

If not specified or set to null, the results will be returned in an arbitrary order.

Constraints:
Allowed Values: registerTime, firstUsedTime, lastUsedTime

Returns:

The column name to sort the list results by:

• registerTime: Sort the list results by when the revisions were registered with AWS CodeDeploy.
• firstUsedTime: Sort the list results by when the revisions were first used by in a deployment.
• lastUsedTime: Sort the list results by when the revisions were last used in a deployment.

If not specified or set to null, the results will be returned in an arbitrary order.

See Also:

ApplicationRevisionSortBy

setSortBy

public void setSortBy(String sortBy)

The column name to sort the list results by:

• registerTime: Sort the list results by when the revisions were registered with AWS CodeDeploy.
• firstUsedTime: Sort the list results by when the revisions were first used by in a deployment.
• lastUsedTime: Sort the list results by when the revisions were last used in a deployment.

If not specified or set to null, the results will be returned in an arbitrary order.

Constraints:
Allowed Values: registerTime, firstUsedTime, lastUsedTime

Parameters:

sortBy - The column name to sort the list results by:

• registerTime: Sort the list results by when the revisions were registered with AWS CodeDeploy.
• firstUsedTime: Sort the list results by when the revisions were first used by in a deployment.
• lastUsedTime: Sort the list results by when the revisions were last used in a deployment.

If not specified or set to null, the results will be returned in an arbitrary order.

See Also:

ApplicationRevisionSortBy

withSortBy

public ListApplicationRevisionsRequest withSortBy(String sortBy)

The column name to sort the list results by:

• registerTime: Sort the list results by when the revisions were registered with AWS CodeDeploy.
• firstUsedTime: Sort the list results by when the revisions were first used by in a deployment.
• lastUsedTime: Sort the list results by when the revisions were last used in a deployment.

If not specified or set to null, the results will be returned in an arbitrary order.

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

Constraints:
Allowed Values: registerTime, firstUsedTime, lastUsedTime

Parameters:

sortBy - The column name to sort the list results by:

• registerTime: Sort the list results by when the revisions were registered with AWS CodeDeploy.
• firstUsedTime: Sort the list results by when the revisions were first used by in a deployment.
• lastUsedTime: Sort the list results by when the revisions were last used in a deployment.

If not specified or set to null, the results will be returned in an arbitrary order.

Returns:

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

See Also:

ApplicationRevisionSortBy

setSortBy

public void setSortBy(ApplicationRevisionSortBy sortBy)

The column name to sort the list results by:

• registerTime: Sort the list results by when the revisions were registered with AWS CodeDeploy.
• firstUsedTime: Sort the list results by when the revisions were first used by in a deployment.
• lastUsedTime: Sort the list results by when the revisions were last used in a deployment.

If not specified or set to null, the results will be returned in an arbitrary order.

Constraints:
Allowed Values: registerTime, firstUsedTime, lastUsedTime

Parameters:

sortBy - The column name to sort the list results by:

• registerTime: Sort the list results by when the revisions were registered with AWS CodeDeploy.
• firstUsedTime: Sort the list results by when the revisions were first used by in a deployment.
• lastUsedTime: Sort the list results by when the revisions were last used in a deployment.

If not specified or set to null, the results will be returned in an arbitrary order.

See Also:

ApplicationRevisionSortBy

withSortBy

public ListApplicationRevisionsRequest withSortBy(ApplicationRevisionSortBy sortBy)

The column name to sort the list results by:

• registerTime: Sort the list results by when the revisions were registered with AWS CodeDeploy.
• firstUsedTime: Sort the list results by when the revisions were first used by in a deployment.
• lastUsedTime: Sort the list results by when the revisions were last used in a deployment.

If not specified or set to null, the results will be returned in an arbitrary order.

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

Constraints:
Allowed Values: registerTime, firstUsedTime, lastUsedTime

Parameters:

sortBy - The column name to sort the list results by:

• registerTime: Sort the list results by when the revisions were registered with AWS CodeDeploy.
• firstUsedTime: Sort the list results by when the revisions were first used by in a deployment.
• lastUsedTime: Sort the list results by when the revisions were last used in a deployment.

If not specified or set to null, the results will be returned in an arbitrary order.

Returns:

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

See Also:

ApplicationRevisionSortBy

getSortOrder

public String getSortOrder()

The order to sort the list results by:

• ascending: Sort the list results in ascending order.
• descending: Sort the list results in descending order.

If not specified, the results will be sorted in ascending order.

If set to null, the results will be sorted in an arbitrary order.

Constraints:
Allowed Values: ascending, descending

Returns:

The order to sort the list results by:

• ascending: Sort the list results in ascending order.
• descending: Sort the list results in descending order.

If not specified, the results will be sorted in ascending order.

If set to null, the results will be sorted in an arbitrary order.

See Also:

SortOrder

setSortOrder

public void setSortOrder(String sortOrder)

The order to sort the list results by:

• ascending: Sort the list results in ascending order.
• descending: Sort the list results in descending order.

If not specified, the results will be sorted in ascending order.

If set to null, the results will be sorted in an arbitrary order.

Constraints:
Allowed Values: ascending, descending

Parameters:

sortOrder - The order to sort the list results by:

• ascending: Sort the list results in ascending order.
• descending: Sort the list results in descending order.

If not specified, the results will be sorted in ascending order.

If set to null, the results will be sorted in an arbitrary order.

See Also:

SortOrder

withSortOrder

public ListApplicationRevisionsRequest withSortOrder(String sortOrder)

The order to sort the list results by:

• ascending: Sort the list results in ascending order.
• descending: Sort the list results in descending order.

If not specified, the results will be sorted in ascending order.

If set to null, the results will be sorted in an arbitrary order.

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

Constraints:
Allowed Values: ascending, descending

Parameters:

sortOrder - The order to sort the list results by:

• ascending: Sort the list results in ascending order.
• descending: Sort the list results in descending order.

If not specified, the results will be sorted in ascending order.

If set to null, the results will be sorted in an arbitrary order.

Returns:

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

See Also:

SortOrder

setSortOrder

public void setSortOrder(SortOrder sortOrder)

The order to sort the list results by:

• ascending: Sort the list results in ascending order.
• descending: Sort the list results in descending order.

If not specified, the results will be sorted in ascending order.

If set to null, the results will be sorted in an arbitrary order.

Constraints:
Allowed Values: ascending, descending

Parameters:

sortOrder - The order to sort the list results by:

• ascending: Sort the list results in ascending order.
• descending: Sort the list results in descending order.

If not specified, the results will be sorted in ascending order.

If set to null, the results will be sorted in an arbitrary order.

See Also:

SortOrder

withSortOrder

public ListApplicationRevisionsRequest withSortOrder(SortOrder sortOrder)

The order to sort the list results by:

• ascending: Sort the list results in ascending order.
• descending: Sort the list results in descending order.

If not specified, the results will be sorted in ascending order.

If set to null, the results will be sorted in an arbitrary order.

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

Constraints:
Allowed Values: ascending, descending

Parameters:

sortOrder - The order to sort the list results by:

• ascending: Sort the list results in ascending order.
• descending: Sort the list results in descending order.

If not specified, the results will be sorted in ascending order.

If set to null, the results will be sorted in an arbitrary order.

Returns:

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

See Also:

SortOrder

getS3Bucket

public String getS3Bucket()

A specific Amazon S3 bucket name to limit the search for revisions.

If set to null, then all of the user's buckets will be searched.

Returns:

A specific Amazon S3 bucket name to limit the search for revisions.

If set to null, then all of the user's buckets will be searched.

setS3Bucket

public void setS3Bucket(String s3Bucket)

A specific Amazon S3 bucket name to limit the search for revisions.

If set to null, then all of the user's buckets will be searched.

Parameters:

s3Bucket - A specific Amazon S3 bucket name to limit the search for revisions.

If set to null, then all of the user's buckets will be searched.

withS3Bucket

public ListApplicationRevisionsRequest withS3Bucket(String s3Bucket)

A specific Amazon S3 bucket name to limit the search for revisions.

If set to null, then all of the user's buckets will be searched.

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

Parameters:

s3Bucket - A specific Amazon S3 bucket name to limit the search for revisions.

If set to null, then all of the user's buckets will be searched.

Returns:

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

getS3KeyPrefix

public String getS3KeyPrefix()

A specific key prefix for the set of Amazon S3 objects to limit the search for revisions.

Returns:

A specific key prefix for the set of Amazon S3 objects to limit the search for revisions.

setS3KeyPrefix

public void setS3KeyPrefix(String s3KeyPrefix)

A specific key prefix for the set of Amazon S3 objects to limit the search for revisions.

Parameters:

s3KeyPrefix - A specific key prefix for the set of Amazon S3 objects to limit the search for revisions.

withS3KeyPrefix

public ListApplicationRevisionsRequest withS3KeyPrefix(String s3KeyPrefix)

A specific key prefix for the set of Amazon S3 objects to limit the search for revisions.

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

Parameters:

s3KeyPrefix - A specific key prefix for the set of Amazon S3 objects to limit the search for revisions.

Returns:

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

getDeployed

public String getDeployed()

Whether to list revisions based on whether the revision is the target revision of an deployment group:

• include: List revisions that are target revisions of a deployment group.
• exclude: Do not list revisions that are target revisions of a deployment group.
• ignore: List all revisions, regardless of whether they are target revisions of a deployment group.

Constraints:
Allowed Values: include, exclude, ignore

Returns:

Whether to list revisions based on whether the revision is the target revision of an deployment group:

• include: List revisions that are target revisions of a deployment group.
• exclude: Do not list revisions that are target revisions of a deployment group.
• ignore: List all revisions, regardless of whether they are target revisions of a deployment group.

See Also:

ListStateFilterAction

setDeployed

public void setDeployed(String deployed)

Whether to list revisions based on whether the revision is the target revision of an deployment group:

• include: List revisions that are target revisions of a deployment group.
• exclude: Do not list revisions that are target revisions of a deployment group.
• ignore: List all revisions, regardless of whether they are target revisions of a deployment group.

Constraints:
Allowed Values: include, exclude, ignore

Parameters:

deployed - Whether to list revisions based on whether the revision is the target revision of an deployment group:

• include: List revisions that are target revisions of a deployment group.
• exclude: Do not list revisions that are target revisions of a deployment group.
• ignore: List all revisions, regardless of whether they are target revisions of a deployment group.

See Also:

ListStateFilterAction

withDeployed

public ListApplicationRevisionsRequest withDeployed(String deployed)

Whether to list revisions based on whether the revision is the target revision of an deployment group:

• include: List revisions that are target revisions of a deployment group.
• exclude: Do not list revisions that are target revisions of a deployment group.
• ignore: List all revisions, regardless of whether they are target revisions of a deployment group.

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

Constraints:
Allowed Values: include, exclude, ignore

Parameters:

deployed - Whether to list revisions based on whether the revision is the target revision of an deployment group:

• include: List revisions that are target revisions of a deployment group.
• exclude: Do not list revisions that are target revisions of a deployment group.
• ignore: List all revisions, regardless of whether they are target revisions of a deployment group.

Returns:

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

See Also:

ListStateFilterAction

setDeployed

public void setDeployed(ListStateFilterAction deployed)

Whether to list revisions based on whether the revision is the target revision of an deployment group:

• include: List revisions that are target revisions of a deployment group.
• exclude: Do not list revisions that are target revisions of a deployment group.
• ignore: List all revisions, regardless of whether they are target revisions of a deployment group.

Constraints:
Allowed Values: include, exclude, ignore

Parameters:

deployed - Whether to list revisions based on whether the revision is the target revision of an deployment group:

• include: List revisions that are target revisions of a deployment group.
• exclude: Do not list revisions that are target revisions of a deployment group.
• ignore: List all revisions, regardless of whether they are target revisions of a deployment group.

See Also:

ListStateFilterAction

withDeployed

public ListApplicationRevisionsRequest withDeployed(ListStateFilterAction deployed)

Whether to list revisions based on whether the revision is the target revision of an deployment group:

• include: List revisions that are target revisions of a deployment group.
• exclude: Do not list revisions that are target revisions of a deployment group.
• ignore: List all revisions, regardless of whether they are target revisions of a deployment group.

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

Constraints:
Allowed Values: include, exclude, ignore

Parameters:

deployed - Whether to list revisions based on whether the revision is the target revision of an deployment group:

• include: List revisions that are target revisions of a deployment group.
• exclude: Do not list revisions that are target revisions of a deployment group.
• ignore: List all revisions, regardless of whether they are target revisions of a deployment group.

Returns:

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

See Also:

ListStateFilterAction

getNextToken

public String getNextToken()

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

Returns:

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

setNextToken

public void setNextToken(String nextToken)

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

Parameters:

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

withNextToken

public ListApplicationRevisionsRequest withNextToken(String nextToken)

An identifier that was returned from the previous list application revisions call, which can be used to return the next set of applications 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 application revisions call, which can be used to return the next set of applications 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