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

Interface DescribeImagesRequest.Builder

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

  • Method Details

    • registryId

      DescribeImagesRequest.Builder registryId(String registryId)

      The Amazon Web Services account ID associated with the registry that contains the repository in which to describe 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 describe 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

      DescribeImagesRequest.Builder repositoryName(String repositoryName)

      The repository that contains the images to describe.

      Parameters:
      repositoryName - The repository that contains the images to describe.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • imageIds

      DescribeImagesRequest.Builder imageIds(Collection<ImageIdentifier> imageIds)

      The list of image IDs for the requested repository.

      Parameters:
      imageIds - The list of image IDs for the requested repository.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • imageIds

      DescribeImagesRequest.Builder imageIds(ImageIdentifier... imageIds)

      The list of image IDs for the requested repository.

      Parameters:
      imageIds - The list of image IDs for the requested repository.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • imageIds

      DescribeImagesRequest.Builder imageIds(Consumer<ImageIdentifier.Builder>... imageIds)

      The list of image IDs for the requested repository.

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

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

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

    • nextToken

      DescribeImagesRequest.Builder nextToken(String nextToken)

      The nextToken value returned from a previous paginated DescribeImages 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 option cannot be used when you specify images with imageIds.

      Parameters:
      nextToken - The nextToken value returned from a previous paginated DescribeImages 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 option cannot be used when you specify images with imageIds.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • maxResults

      DescribeImagesRequest.Builder maxResults(Integer maxResults)

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

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

    • filter

      DescribeImagesRequest.Builder filter(DescribeImagesFilter filter)

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

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

    • filter

      default DescribeImagesRequest.Builder filter(Consumer<DescribeImagesFilter.Builder> filter)

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

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

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

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

    • overrideConfiguration

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

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