software.amazon.awssdk.services.codedeploy.model

Class ListDeploymentsRequest

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:

SdkPojo, ToCopyableBuilder<ListDeploymentsRequest.Builder,ListDeploymentsRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final 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

Method Summary

Modifier and Type	Method and Description
String	applicationName() The name of an AWS CodeDeploy application associated with the 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 a deployment group for the specified application.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
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.
List<SdkField<?>>	sdkFields()
static Class<? extends ListDeploymentsRequest.Builder>	serializableBuilderClass()
ListDeploymentsRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.

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

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, 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 IAM user or AWS account.

If applicationName is specified, then deploymentGroupName must be specified. If it is not specified, then deploymentGroupName must not be specified.

Returns:

The name of an AWS CodeDeploy application associated with the IAM user or AWS account.

If applicationName is specified, then deploymentGroupName must be specified. If it is not specified, then deploymentGroupName must not be specified.

deploymentGroupName

public String deploymentGroupName()

The name of a deployment group for the specified application.

If deploymentGroupName is specified, then applicationName must be specified. If it is not specified, then applicationName must not be specified.

Returns:

The name of a deployment group for the specified application.

If deploymentGroupName is specified, then applicationName must be specified. If it is not specified, then applicationName must not be specified.

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()

Specified by:

toBuilder in interface ToCopyableBuilder<ListDeploymentsRequest.Builder,ListDeploymentsRequest>

Specified by:

toBuilder in class CodeDeployRequest

builder

public static ListDeploymentsRequest.Builder builder()

serializableBuilderClass

public static Class<? extends ListDeploymentsRequest.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo