Interface ListDeploymentJobsRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<ListDeploymentJobsRequest.Builder,ListDeploymentJobsRequest>, RoboMakerRequest.Builder, SdkBuilder<ListDeploymentJobsRequest.Builder,ListDeploymentJobsRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
ListDeploymentJobsRequest
public static interface ListDeploymentJobsRequest.Builder extends RoboMakerRequest.Builder, SdkPojo, CopyableBuilder<ListDeploymentJobsRequest.Builder,ListDeploymentJobsRequest>

  • Method Details

    • filters

      ListDeploymentJobsRequest.Builder filters(Collection<Filter> filters)

      Optional filters to limit results.

      The filter names status and fleetName are supported. When filtering, you must use the complete value of the filtered item. You can use up to three filters, but they must be for the same named item. For example, if you are looking for items with the status InProgress or the status Pending.

      Parameters:
      filters - Optional filters to limit results.

      The filter names status and fleetName are supported. When filtering, you must use the complete value of the filtered item. You can use up to three filters, but they must be for the same named item. For example, if you are looking for items with the status InProgress or the status Pending.

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

    • filters

      ListDeploymentJobsRequest.Builder filters(Filter... filters)

      Optional filters to limit results.

      The filter names status and fleetName are supported. When filtering, you must use the complete value of the filtered item. You can use up to three filters, but they must be for the same named item. For example, if you are looking for items with the status InProgress or the status Pending.

      Parameters:
      filters - Optional filters to limit results.

      The filter names status and fleetName are supported. When filtering, you must use the complete value of the filtered item. You can use up to three filters, but they must be for the same named item. For example, if you are looking for items with the status InProgress or the status Pending.

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

    • filters

      ListDeploymentJobsRequest.Builder filters(Consumer<Filter.Builder>... filters)

      Optional filters to limit results.

      The filter names status and fleetName are supported. When filtering, you must use the complete value of the filtered item. You can use up to three filters, but they must be for the same named item. For example, if you are looking for items with the status InProgress or the status Pending.

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

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

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

    • nextToken

      ListDeploymentJobsRequest.Builder nextToken(String nextToken)

      If the previous paginated request did not return all of the remaining results, the response object's nextToken parameter value is set to a token. To retrieve the next set of results, call ListDeploymentJobs again and assign that token to the request object's nextToken parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null.

      Parameters:
      nextToken - If the previous paginated request did not return all of the remaining results, the response object's nextToken parameter value is set to a token. To retrieve the next set of results, call ListDeploymentJobs again and assign that token to the request object's nextToken parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • maxResults

      ListDeploymentJobsRequest.Builder maxResults(Integer maxResults)

      When this parameter is used, ListDeploymentJobs only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListDeploymentJobs request with the returned nextToken value. This value can be between 1 and 200. If this parameter is not used, then ListDeploymentJobs returns up to 200 results and a nextToken value if applicable.

      Parameters:
      maxResults - When this parameter is used, ListDeploymentJobs only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListDeploymentJobs request with the returned nextToken value. This value can be between 1 and 200. If this parameter is not used, then ListDeploymentJobs returns up to 200 results and a nextToken value if applicable.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

      ListDeploymentJobsRequest.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

      ListDeploymentJobsRequest.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.