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

Interface BatchGetImageRequest.Builder

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

  • Method Details

    • registryId

      BatchGetImageRequest.Builder registryId(String registryId)

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

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

      BatchGetImageRequest.Builder imageIds(Collection<ImageIdentifier> imageIds)

      A list of image ID references that correspond to images to describe. The format of the imageIds reference is imageTag=tag or imageDigest=digest.

      Parameters:
      imageIds - A list of image ID references that correspond to images to describe. The format of the imageIds reference is imageTag=tag or imageDigest=digest.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • imageIds

      BatchGetImageRequest.Builder imageIds(ImageIdentifier... imageIds)

      A list of image ID references that correspond to images to describe. The format of the imageIds reference is imageTag=tag or imageDigest=digest.

      Parameters:
      imageIds - A list of image ID references that correspond to images to describe. The format of the imageIds reference is imageTag=tag or imageDigest=digest.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • imageIds

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

      A list of image ID references that correspond to images to describe. The format of the imageIds reference is imageTag=tag or imageDigest=digest.

      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:

    • acceptedMediaTypes

      BatchGetImageRequest.Builder acceptedMediaTypes(Collection<String> acceptedMediaTypes)

      The accepted media types for the request.

      Valid values: application/vnd.docker.distribution.manifest.v1+json | application/vnd.docker.distribution.manifest.v2+json | application/vnd.oci.image.manifest.v1+json

      Parameters:
      acceptedMediaTypes - The accepted media types for the request.

      Valid values: application/vnd.docker.distribution.manifest.v1+json | application/vnd.docker.distribution.manifest.v2+json | application/vnd.oci.image.manifest.v1+json

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

    • acceptedMediaTypes

      BatchGetImageRequest.Builder acceptedMediaTypes(String... acceptedMediaTypes)

      The accepted media types for the request.

      Valid values: application/vnd.docker.distribution.manifest.v1+json | application/vnd.docker.distribution.manifest.v2+json | application/vnd.oci.image.manifest.v1+json

      Parameters:
      acceptedMediaTypes - The accepted media types for the request.

      Valid values: application/vnd.docker.distribution.manifest.v1+json | application/vnd.docker.distribution.manifest.v2+json | application/vnd.oci.image.manifest.v1+json

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

    • overrideConfiguration

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

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