Package software.amazon.awssdk.services.codedeploy.model

Interface ListDeploymentsRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CodeDeployRequest.Builder, CopyableBuilder<ListDeploymentsRequest.Builder,ListDeploymentsRequest>, SdkBuilder<ListDeploymentsRequest.Builder,ListDeploymentsRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

ListDeploymentsRequest

public static interface ListDeploymentsRequest.Builder
extends CodeDeployRequest.Builder, SdkPojo, CopyableBuilder<ListDeploymentsRequest.Builder,ListDeploymentsRequest>

Method Summary

Modifier and Type	Method	Description
ListDeploymentsRequest.Builder	applicationName(String applicationName)	The name of an CodeDeploy application associated with the user or Amazon Web Services account.
default ListDeploymentsRequest.Builder	createTimeRange(Consumer<TimeRange.Builder> createTimeRange)	A time range (start and end) for returning a subset of the list of deployments.
ListDeploymentsRequest.Builder	createTimeRange(TimeRange createTimeRange)	A time range (start and end) for returning a subset of the list of deployments.
ListDeploymentsRequest.Builder	deploymentGroupName(String deploymentGroupName)	The name of a deployment group for the specified application.
ListDeploymentsRequest.Builder	externalId(String externalId)	The unique ID of an external resource for returning deployments linked to the external resource.
ListDeploymentsRequest.Builder	includeOnlyStatuses(Collection<DeploymentStatus> includeOnlyStatuses)	A subset of deployments to list by status:
ListDeploymentsRequest.Builder	includeOnlyStatuses(DeploymentStatus... includeOnlyStatuses)	A subset of deployments to list by status:
ListDeploymentsRequest.Builder	includeOnlyStatusesWithStrings(String... includeOnlyStatuses)	A subset of deployments to list by status:
ListDeploymentsRequest.Builder	includeOnlyStatusesWithStrings(Collection<String> includeOnlyStatuses)	A subset of deployments to list by status:
ListDeploymentsRequest.Builder	nextToken(String nextToken)	An identifier returned from the previous list deployments call.
ListDeploymentsRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
ListDeploymentsRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.services.codedeploy.model.CodeDeployRequest.Builder

build

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

copy

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

applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFieldNameToField, sdkFields

Method Detail

applicationName

ListDeploymentsRequest.Builder applicationName(String applicationName)

The name of an CodeDeploy application associated with the user or Amazon Web Services account.

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

Parameters:

applicationName - The name of an CodeDeploy application associated with the user or Amazon Web Services account.

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

Returns:

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

deploymentGroupName

ListDeploymentsRequest.Builder deploymentGroupName(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.

Parameters:

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:

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

externalId

ListDeploymentsRequest.Builder externalId(String externalId)

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

Parameters:

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

Returns:

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

includeOnlyStatusesWithStrings

ListDeploymentsRequest.Builder includeOnlyStatusesWithStrings(Collection<String> 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.

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.

includeOnlyStatusesWithStrings

ListDeploymentsRequest.Builder includeOnlyStatusesWithStrings(String... 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.

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.

includeOnlyStatuses

ListDeploymentsRequest.Builder includeOnlyStatuses(Collection<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.

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.

includeOnlyStatuses

ListDeploymentsRequest.Builder includeOnlyStatuses(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.

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.

createTimeRange

ListDeploymentsRequest.Builder createTimeRange(TimeRange createTimeRange)

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.

createTimeRange

default ListDeploymentsRequest.Builder createTimeRange(Consumer<TimeRange.Builder> createTimeRange)

A time range (start and end) for returning a subset of the list of deployments.

This is a convenience method that creates an instance of the TimeRange.Builder avoiding the need to create one manually via TimeRange.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to createTimeRange(TimeRange).

Parameters:

createTimeRange - a consumer that will call methods on TimeRange.Builder

Returns:

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

See Also:

createTimeRange(TimeRange)

nextToken

ListDeploymentsRequest.Builder nextToken(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.

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.

overrideConfiguration

ListDeploymentsRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

ListDeploymentsRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Specified by:

overrideConfiguration in interface AwsRequest.Builder