Class ListDeploymentsRequest
- All Implemented Interfaces:
ReadLimitInfo
,Serializable
,Cloneable
Represents the input of a list deployments operation.
- See Also:
-
Field Summary
Fields inherited from class com.amazonaws.AmazonWebServiceRequest
NOOP
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionclone()
Creates a shallow clone of this request.boolean
The name of an AWS CodeDeploy application associated with the applicable IAM user or AWS account.A time range (start and end) for returning a subset of the list of deployments.The name of an existing deployment group for the specified application.A subset of deployments to list by status:An identifier returned from the previous list deployments call.int
hashCode()
void
setApplicationName
(String applicationName) The name of an AWS CodeDeploy application associated with the applicable IAM user or AWS account.void
setCreateTimeRange
(TimeRange createTimeRange) A time range (start and end) 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:void
setNextToken
(String nextToken) An identifier returned from the previous list deployments call.toString()
Returns a string representation of this object; useful for testing and debugging.withApplicationName
(String applicationName) The name of an AWS CodeDeploy application associated with the applicable IAM user or AWS account.withCreateTimeRange
(TimeRange createTimeRange) A time range (start and end) for returning a subset of the list of deployments.withDeploymentGroupName
(String deploymentGroupName) The name of an existing deployment group for the specified application.withIncludeOnlyStatuses
(DeploymentStatus... includeOnlyStatuses) A subset of deployments to list by status:withIncludeOnlyStatuses
(String... includeOnlyStatuses) A subset of deployments to list by status:withIncludeOnlyStatuses
(Collection<String> includeOnlyStatuses) A subset of deployments to list by status:withNextToken
(String nextToken) An identifier returned from the previous list deployments call.Methods inherited from class com.amazonaws.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
-
Constructor Details
-
ListDeploymentsRequest
public ListDeploymentsRequest()
-
-
Method Details
-
setApplicationName
The name of an AWS CodeDeploy application associated with the applicable IAM user or AWS account.
- Parameters:
applicationName
- The name of an AWS CodeDeploy application associated with the applicable IAM user or AWS account.
-
getApplicationName
The name of an AWS CodeDeploy application associated with the applicable IAM user or AWS account.
- Returns:
- The name of an AWS CodeDeploy application associated with the applicable IAM user or AWS account.
-
withApplicationName
The name of an AWS CodeDeploy application associated with the applicable IAM user or AWS account.
- Parameters:
applicationName
- The name of an AWS CodeDeploy application associated with the applicable IAM user or AWS account.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setDeploymentGroupName
The name of an existing deployment group for the specified application.
- Parameters:
deploymentGroupName
- The name of an existing deployment group for the specified application.
-
getDeploymentGroupName
The name of an existing deployment group for the specified application.
- Returns:
- The name of an existing deployment group for the specified application.
-
withDeploymentGroupName
The name of an existing deployment group for the specified application.
- Parameters:
deploymentGroupName
- The name of an existing deployment group for the specified application.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
getIncludeOnlyStatuses
A subset of deployments to list by status:
- Created: Include created deployments in the resulting list.
- Queued: Include queued deployments in the resulting list.
- In Progress: Include in-progress deployments in the resulting list.
- Succeeded: Include successful deployments in the resulting list.
- Failed: Include failed deployments in the resulting list.
- Stopped: Include stopped deployments in the resulting list.
- Returns:
- A subset of deployments to list by status:
- Created: Include created deployments in the resulting list.
- Queued: Include queued deployments in the resulting list.
- In Progress: Include in-progress deployments in the resulting list.
- Succeeded: Include successful deployments in the resulting list.
- Failed: Include failed deployments in the resulting list.
- Stopped: Include stopped deployments in the resulting list.
- See Also:
-
setIncludeOnlyStatuses
A subset of deployments to list by status:
- Created: Include created deployments in the resulting list.
- Queued: Include queued deployments in the resulting list.
- In Progress: Include in-progress deployments in the resulting list.
- Succeeded: Include successful deployments in the resulting list.
- Failed: Include failed deployments in the resulting list.
- Stopped: Include stopped deployments in the resulting list.
- Parameters:
includeOnlyStatuses
- A subset of deployments to list by status:- Created: Include created deployments in the resulting list.
- Queued: Include queued deployments in the resulting list.
- In Progress: Include in-progress deployments in the resulting list.
- Succeeded: Include successful deployments in the resulting list.
- Failed: Include failed deployments in the resulting list.
- Stopped: Include stopped deployments in the resulting list.
- See Also:
-
withIncludeOnlyStatuses
A subset of deployments to list by status:
- Created: Include created deployments in the resulting list.
- Queued: Include queued deployments in the resulting list.
- In Progress: Include in-progress deployments in the resulting list.
- Succeeded: Include successful deployments in the resulting list.
- Failed: Include failed deployments in the resulting list.
- Stopped: Include stopped deployments in the resulting list.
NOTE: This method appends the values to the existing list (if any). Use
setIncludeOnlyStatuses(java.util.Collection)
orwithIncludeOnlyStatuses(java.util.Collection)
if you want to override the existing values.- Parameters:
includeOnlyStatuses
- A subset of deployments to list by status:- Created: Include created deployments in the resulting list.
- Queued: Include queued deployments in the resulting list.
- In Progress: Include in-progress deployments in the resulting list.
- Succeeded: Include successful deployments in the resulting list.
- Failed: Include failed deployments in the resulting list.
- Stopped: Include stopped deployments in the resulting list.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
withIncludeOnlyStatuses
A subset of deployments to list by status:
- Created: Include created deployments in the resulting list.
- Queued: Include queued deployments in the resulting list.
- In Progress: Include in-progress deployments in the resulting list.
- Succeeded: Include successful deployments in the resulting list.
- Failed: Include failed deployments in the resulting list.
- Stopped: Include stopped deployments in the resulting list.
- Parameters:
includeOnlyStatuses
- A subset of deployments to list by status:- Created: Include created deployments in the resulting list.
- Queued: Include queued deployments in the resulting list.
- In Progress: Include in-progress deployments in the resulting list.
- Succeeded: Include successful deployments in the resulting list.
- Failed: Include failed deployments in the resulting list.
- Stopped: Include stopped deployments in the resulting list.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
withIncludeOnlyStatuses
A subset of deployments to list by status:
- Created: Include created deployments in the resulting list.
- Queued: Include queued deployments in the resulting list.
- In Progress: Include in-progress deployments in the resulting list.
- Succeeded: Include successful deployments in the resulting list.
- Failed: Include failed deployments in the resulting list.
- Stopped: Include stopped deployments in the resulting list.
- Parameters:
includeOnlyStatuses
- A subset of deployments to list by status:- Created: Include created deployments in the resulting list.
- Queued: Include queued deployments in the resulting list.
- In Progress: Include in-progress deployments in the resulting list.
- Succeeded: Include successful deployments in the resulting list.
- Failed: Include failed deployments in the resulting list.
- Stopped: Include stopped deployments in the resulting list.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
setCreateTimeRange
A time range (start and end) for returning a subset of the list of deployments.
- Parameters:
createTimeRange
- A time range (start and end) for returning a subset of the list of deployments.
-
getCreateTimeRange
A time range (start and end) for returning a subset of the list of deployments.
- Returns:
- A time range (start and end) for returning a subset of the list of deployments.
-
withCreateTimeRange
A time range (start and end) for returning a subset of the list of deployments.
- Parameters:
createTimeRange
- A time range (start and end) for returning a subset of the list of deployments.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setNextToken
An identifier returned from the previous list deployments call. It can be used to return the next set of deployments in the list.
- Parameters:
nextToken
- An identifier returned from the previous list deployments call. It can be used to return the next set of deployments in the list.
-
getNextToken
An identifier returned from the previous list deployments call. It can be used to return the next set of deployments in the list.
- Returns:
- An identifier returned from the previous list deployments call. It can be used to return the next set of deployments in the list.
-
withNextToken
An identifier returned from the previous list deployments call. It can be used to return the next set of deployments in the list.
- Parameters:
nextToken
- An identifier returned from the previous list deployments call. It can be used to return the next set of deployments in the list.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
toString
Returns a string representation of this object; useful for testing and debugging. -
equals
-
hashCode
public int hashCode() -
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 classAmazonWebServiceRequest
- See Also:
-