Interface DescribeImagesRequest.Builder
-
- All Superinterfaces:
AwsRequest.Builder,Buildable,CopyableBuilder<DescribeImagesRequest.Builder,DescribeImagesRequest>,EcrPublicRequest.Builder,SdkBuilder<DescribeImagesRequest.Builder,DescribeImagesRequest>,SdkPojo,SdkRequest.Builder
- Enclosing class:
- DescribeImagesRequest
public static interface DescribeImagesRequest.Builder extends EcrPublicRequest.Builder, SdkPojo, CopyableBuilder<DescribeImagesRequest.Builder,DescribeImagesRequest>
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description DescribeImagesRequest.BuilderimageIds(Collection<ImageIdentifier> imageIds)The list of image IDs for the requested repository.DescribeImagesRequest.BuilderimageIds(Consumer<ImageIdentifier.Builder>... imageIds)The list of image IDs for the requested repository.DescribeImagesRequest.BuilderimageIds(ImageIdentifier... imageIds)The list of image IDs for the requested repository.DescribeImagesRequest.BuildermaxResults(Integer maxResults)The maximum number of repository results that's returned byDescribeImagesin paginated output.DescribeImagesRequest.BuildernextToken(String nextToken)ThenextTokenvalue that's returned from a previous paginatedDescribeImagesrequest wheremaxResultswas used and the results exceeded the value of that parameter.DescribeImagesRequest.BuilderoverrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)DescribeImagesRequest.BuilderoverrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)DescribeImagesRequest.BuilderregistryId(String registryId)The Amazon Web Services account ID that's associated with the public registry that contains the repository where images are described.DescribeImagesRequest.BuilderrepositoryName(String repositoryName)The repository that contains the images to describe.-
Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfiguration
-
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
-
Methods inherited from interface software.amazon.awssdk.services.ecrpublic.model.EcrPublicRequest.Builder
build
-
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
-
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
-
-
-
Method Detail
-
registryId
DescribeImagesRequest.Builder registryId(String registryId)
The Amazon Web Services account ID that's associated with the public registry that contains the repository where images are described. If you do not specify a registry, the default public registry is assumed.
- Parameters:
registryId- The Amazon Web Services account ID that's associated with the public registry that contains the repository where images are described. If you do not specify a registry, the default public 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 theImageIdentifier.Builderavoiding the need to create one manually viaImageIdentifier.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed to#imageIds(List.) - Parameters:
imageIds- a consumer that will call methods onImageIdentifier.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
#imageIds(java.util.Collection)
-
nextToken
DescribeImagesRequest.Builder nextToken(String nextToken)
The
nextTokenvalue that's returned from a previous paginatedDescribeImagesrequest wheremaxResultswas used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned thenextTokenvalue. If there are no more results to return, this value isnull. If you specify images withimageIds, you can't use this option.- Parameters:
nextToken- ThenextTokenvalue that's returned from a previous paginatedDescribeImagesrequest wheremaxResultswas used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned thenextTokenvalue. If there are no more results to return, this value isnull. If you specify images withimageIds, you can't use this option.- 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 that's returned by
DescribeImagesin paginated output. When this parameter is used,DescribeImagesonly returnsmaxResultsresults in a single page along with anextTokenresponse element. You can see the remaining results of the initial request by sending anotherDescribeImagesrequest with the returnednextTokenvalue. This value can be between 1 and 1000. If this parameter isn't used, thenDescribeImagesreturns up to 100 results and anextTokenvalue, if applicable. If you specify images withimageIds, you can't use this option.- Parameters:
maxResults- The maximum number of repository results that's returned byDescribeImagesin paginated output. When this parameter is used,DescribeImagesonly returnsmaxResultsresults in a single page along with anextTokenresponse element. You can see the remaining results of the initial request by sending anotherDescribeImagesrequest with the returnednextTokenvalue. This value can be between 1 and 1000. If this parameter isn't used, thenDescribeImagesreturns up to 100 results and anextTokenvalue, if applicable. If you specify images withimageIds, you can't use this option.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
overrideConfiguration
DescribeImagesRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
- Specified by:
overrideConfigurationin interfaceAwsRequest.Builder
-
overrideConfiguration
DescribeImagesRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
- Specified by:
overrideConfigurationin interfaceAwsRequest.Builder
-
-