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) Indicates whether some other object is "equal to" this one by SDK fields.
String	externalId() The unique ID of an external resource for returning deployments linked to the external resource.
<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()
boolean	hasIncludeOnlyStatuses() For responses, this returns true if the service returned a value for the IncludeOnlyStatuses property.
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() Take this object and create a builder that contains all of the current property values of this object.
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

getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

applicationName

public final 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 final 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.

externalId

public final String externalId()

The unique ID of an external resource for returning deployments linked to the external resource.

Returns:

The unique ID of an external resource for returning deployments linked to the external resource.

includeOnlyStatuses

public final 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.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasIncludeOnlyStatuses() method.

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.

hasIncludeOnlyStatuses

public final boolean hasIncludeOnlyStatuses()

For responses, this returns true if the service returned a value for the IncludeOnlyStatuses property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

includeOnlyStatusesAsStrings

public final 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.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasIncludeOnlyStatuses() method.

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 final 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 final 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 final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Description copied from interface: SdkPojo

Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

Specified by:

equalsBySdkFields in interface SdkPojo

Parameters:

obj - the object to be compared with

Returns:

true if the other object equals to this object by sdk fields, false otherwise.

toString

public final 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 final <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

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

Returns:

List of SdkField in this POJO. May be empty list but should never be null.