Package software.amazon.awssdk.services.ecr.model

Interface ListImagesRequest.Builder

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

  • Method Details

    • registryId

      ListImagesRequest.Builder registryId(String registryId)

      The Amazon Web Services account ID associated with the registry that contains the repository in which to list images. If you do not specify a registry, the default registry is assumed.

      Parameters:
      registryId - The Amazon Web Services account ID associated with the registry that contains the repository in which to list images. If you do not specify a registry, the default registry is assumed.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • repositoryName

      ListImagesRequest.Builder repositoryName(String repositoryName)

      The repository with image IDs to be listed.

      Parameters:
      repositoryName - The repository with image IDs to be listed.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • nextToken

      ListImagesRequest.Builder nextToken(String nextToken)

      The nextToken value returned from a previous paginated ListImages request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value. This value is null when there are no more results to return.

      This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.

      Parameters:
      nextToken - The nextToken value returned from a previous paginated ListImages request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value. This value is null when there are no more results to return.

      This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.

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

    • maxResults

      ListImagesRequest.Builder maxResults(Integer maxResults)

      The maximum number of image results returned by ListImages in paginated output. When this parameter is used, ListImages 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 ListImages request with the returned nextToken value. This value can be between 1 and 1000. If this parameter is not used, then ListImages returns up to 100 results and a nextToken value, if applicable.

      Parameters:
      maxResults - The maximum number of image results returned by ListImages in paginated output. When this parameter is used, ListImages 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 ListImages request with the returned nextToken value. This value can be between 1 and 1000. If this parameter is not used, then ListImages returns up to 100 results and a nextToken value, if applicable.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • filter

      ListImagesRequest.Builder filter(ListImagesFilter filter)

      The filter key and value with which to filter your ListImages results.

      Parameters:
      filter - The filter key and value with which to filter your ListImages results.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • filter

      default ListImagesRequest.Builder filter(Consumer<ListImagesFilter.Builder> filter)

      The filter key and value with which to filter your ListImages results.

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

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

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

    • overrideConfiguration

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

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