ListDeploymentsRequest (AWS SDK for Java

java.lang.Object
- software.amazon.awssdk.core.SdkRequest
- - software.amazon.awssdk.awscore.AwsRequest
  - - software.amazon.awssdk.services.codedeploy.model.CodeDeployRequest
    - - software.amazon.awssdk.services.codedeploy.model.ListDeploymentsRequest

All Implemented Interfaces:: ToCopyableBuilder<ListDeploymentsRequest.Builder,ListDeploymentsRequest>

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

Represents the input of a ListDeployments operation.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface ListDeploymentsRequest.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`ListDeploymentsRequest.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`applicationName()` The name of an AWS CodeDeploy application associated with the applicable IAM user or AWS account.
`static ListDeploymentsRequest.Builder`	`builder()`
`TimeRange`	`createTimeRange()` A time range (start and end) for returning a subset of the list of deployments.
`String`	`deploymentGroupName()` The name of an existing deployment group for the specified application.
`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()`
`List<DeploymentStatus>`	`includeOnlyStatuses()` A subset of deployments to list by status:
`List<String>`	`includeOnlyStatusesAsStrings()` A subset of deployments to list by status:
`String`	`nextToken()` An identifier returned from the previous list deployments call.
`static Class<? extends ListDeploymentsRequest.Builder>`	`serializableBuilderClass()`
`ListDeploymentsRequest.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
requestOverrideConfig

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
  - applicationName
```
public String applicationName()
```
    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.
  - deploymentGroupName
```
public String deploymentGroupName()
```
    The name of an existing deployment group for the specified application.
    
    Returns:
    
    The name of an existing deployment group for the specified application.
  - includeOnlyStatuses
```
public List<DeploymentStatus> 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.
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    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.
  - includeOnlyStatusesAsStrings
```
public List<String> includeOnlyStatusesAsStrings()
```
    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.
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    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.
  - createTimeRange
```
public TimeRange createTimeRange()
```
    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.
  - nextToken
```
public String 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:
    
    An identifier returned from the previous list deployments call. It can be used to return the next set of deployments in the list.
  - toBuilder
```
public ListDeploymentsRequest.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<ListDeploymentsRequest.Builder,ListDeploymentsRequest>
    
    Specified by:
    
    toBuilder in class CodeDeployRequest
    
    Returns:
    
    a builder for type T
  - builder
```
public static ListDeploymentsRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends ListDeploymentsRequest.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

Class ListDeploymentsRequest

Nested Class Summary

Method Summary

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

Methods inherited from class java.lang.Object

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

Method Detail

applicationName

deploymentGroupName

includeOnlyStatuses

includeOnlyStatusesAsStrings

createTimeRange

nextToken

toBuilder

builder

serializableBuilderClass

hashCode

equals

toString

getValueForField