Interface ListDeploymentsRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<ListDeploymentsRequest.Builder,ListDeploymentsRequest>, LaunchWizardRequest.Builder, SdkBuilder<ListDeploymentsRequest.Builder,ListDeploymentsRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
ListDeploymentsRequest
@Mutable @NotThreadSafe public static interface ListDeploymentsRequest.Builder extends LaunchWizardRequest.Builder, SdkPojo, CopyableBuilder<ListDeploymentsRequest.Builder,ListDeploymentsRequest>

  • Method Details

    • filters

      ListDeploymentsRequest.Builder filters(Collection<DeploymentFilter> filters)

      Filters to scope the results. The following filters are supported:

      • WORKLOAD_NAME - The name used in deployments.

      • DEPLOYMENT_STATUS - COMPLETED | CREATING | DELETE_IN_PROGRESS | DELETE_INITIATING | DELETE_FAILED | DELETED | FAILED | IN_PROGRESS | VALIDATING

      Parameters:
      filters - Filters to scope the results. The following filters are supported:

      • WORKLOAD_NAME - The name used in deployments.

      • DEPLOYMENT_STATUS - COMPLETED | CREATING | DELETE_IN_PROGRESS | DELETE_INITIATING | DELETE_FAILED | DELETED | FAILED | IN_PROGRESS | VALIDATING

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

    • filters

      ListDeploymentsRequest.Builder filters(DeploymentFilter... filters)

      Filters to scope the results. The following filters are supported:

      • WORKLOAD_NAME - The name used in deployments.

      • DEPLOYMENT_STATUS - COMPLETED | CREATING | DELETE_IN_PROGRESS | DELETE_INITIATING | DELETE_FAILED | DELETED | FAILED | IN_PROGRESS | VALIDATING

      Parameters:
      filters - Filters to scope the results. The following filters are supported:

      • WORKLOAD_NAME - The name used in deployments.

      • DEPLOYMENT_STATUS - COMPLETED | CREATING | DELETE_IN_PROGRESS | DELETE_INITIATING | DELETE_FAILED | DELETED | FAILED | IN_PROGRESS | VALIDATING

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

    • filters

      ListDeploymentsRequest.Builder filters(Consumer<DeploymentFilter.Builder>... filters)

      Filters to scope the results. The following filters are supported:

      • WORKLOAD_NAME - The name used in deployments.

      • DEPLOYMENT_STATUS - COMPLETED | CREATING | DELETE_IN_PROGRESS | DELETE_INITIATING | DELETE_FAILED | DELETED | FAILED | IN_PROGRESS | VALIDATING

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

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to filters(List<DeploymentFilter>).

      Parameters:
      filters - a consumer that will call methods on DeploymentFilter.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • maxResults

      ListDeploymentsRequest.Builder maxResults(Integer maxResults)

      The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output.

      Parameters:
      maxResults - The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • nextToken

      ListDeploymentsRequest.Builder nextToken(String nextToken)

      The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

      Parameters:
      nextToken - The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

      ListDeploymentsRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      ListDeploymentsRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.