software.amazon.awssdk.services.ecr.model.DescribeImagesRequest Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of ecr Show documentation
Show all versions of ecr Show documentation
The AWS Java SDK for the Amazon EC2 Container Registry holds the client classes that are used for
communicating with the
Amazon EC2 Container Registry Service
/*
* Copyright 2014-2019 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package software.amazon.awssdk.services.ecr.model;
import java.util.Arrays;
import java.util.Collection;
import java.util.Collections;
import java.util.List;
import java.util.Objects;
import java.util.Optional;
import java.util.function.BiConsumer;
import java.util.function.Consumer;
import java.util.function.Function;
import java.util.stream.Collectors;
import java.util.stream.Stream;
import software.amazon.awssdk.annotations.Generated;
import software.amazon.awssdk.awscore.AwsRequestOverrideConfiguration;
import software.amazon.awssdk.core.SdkField;
import software.amazon.awssdk.core.SdkPojo;
import software.amazon.awssdk.core.protocol.MarshallLocation;
import software.amazon.awssdk.core.protocol.MarshallingType;
import software.amazon.awssdk.core.traits.ListTrait;
import software.amazon.awssdk.core.traits.LocationTrait;
import software.amazon.awssdk.core.util.DefaultSdkAutoConstructList;
import software.amazon.awssdk.utils.ToString;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;
/**
*/
@Generated("software.amazon.awssdk:codegen")
public final class DescribeImagesRequest extends EcrRequest implements
ToCopyableBuilder {
private static final SdkField REGISTRY_ID_FIELD = SdkField. builder(MarshallingType.STRING)
.getter(getter(DescribeImagesRequest::registryId)).setter(setter(Builder::registryId))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("registryId").build()).build();
private static final SdkField REPOSITORY_NAME_FIELD = SdkField. builder(MarshallingType.STRING)
.getter(getter(DescribeImagesRequest::repositoryName)).setter(setter(Builder::repositoryName))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("repositoryName").build()).build();
private static final SdkField> IMAGE_IDS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.getter(getter(DescribeImagesRequest::imageIds))
.setter(setter(Builder::imageIds))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("imageIds").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(ImageIdentifier::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final SdkField NEXT_TOKEN_FIELD = SdkField. builder(MarshallingType.STRING)
.getter(getter(DescribeImagesRequest::nextToken)).setter(setter(Builder::nextToken))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("nextToken").build()).build();
private static final SdkField MAX_RESULTS_FIELD = SdkField. builder(MarshallingType.INTEGER)
.getter(getter(DescribeImagesRequest::maxResults)).setter(setter(Builder::maxResults))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("maxResults").build()).build();
private static final SdkField FILTER_FIELD = SdkField
. builder(MarshallingType.SDK_POJO).getter(getter(DescribeImagesRequest::filter))
.setter(setter(Builder::filter)).constructor(DescribeImagesFilter::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("filter").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(REGISTRY_ID_FIELD,
REPOSITORY_NAME_FIELD, IMAGE_IDS_FIELD, NEXT_TOKEN_FIELD, MAX_RESULTS_FIELD, FILTER_FIELD));
private final String registryId;
private final String repositoryName;
private final List imageIds;
private final String nextToken;
private final Integer maxResults;
private final DescribeImagesFilter filter;
private DescribeImagesRequest(BuilderImpl builder) {
super(builder);
this.registryId = builder.registryId;
this.repositoryName = builder.repositoryName;
this.imageIds = builder.imageIds;
this.nextToken = builder.nextToken;
this.maxResults = builder.maxResults;
this.filter = builder.filter;
}
/**
*
* The AWS 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.
*
*
* @return The AWS 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.
*/
public String registryId() {
return registryId;
}
/**
*
* The repository that contains the images to describe.
*
*
* @return The repository that contains the images to describe.
*/
public String repositoryName() {
return repositoryName;
}
/**
*
* The list of image IDs for the requested repository.
*
*
* Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
*
*
* @return The list of image IDs for the requested repository.
*/
public List imageIds() {
return imageIds;
}
/**
*
* 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.
*
*
* @return 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.
*/
public String nextToken() {
return nextToken;
}
/**
*
* 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.
*
*
* @return 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.
*/
public Integer maxResults() {
return maxResults;
}
/**
*
* The filter key and value with which to filter your DescribeImages results.
*
*
* @return The filter key and value with which to filter your DescribeImages results.
*/
public DescribeImagesFilter filter() {
return filter;
}
@Override
public Builder toBuilder() {
return new BuilderImpl(this);
}
public static Builder builder() {
return new BuilderImpl();
}
public static Class serializableBuilderClass() {
return BuilderImpl.class;
}
@Override
public int hashCode() {
int hashCode = 1;
hashCode = 31 * hashCode + super.hashCode();
hashCode = 31 * hashCode + Objects.hashCode(registryId());
hashCode = 31 * hashCode + Objects.hashCode(repositoryName());
hashCode = 31 * hashCode + Objects.hashCode(imageIds());
hashCode = 31 * hashCode + Objects.hashCode(nextToken());
hashCode = 31 * hashCode + Objects.hashCode(maxResults());
hashCode = 31 * hashCode + Objects.hashCode(filter());
return hashCode;
}
@Override
public boolean equals(Object obj) {
return super.equals(obj) && equalsBySdkFields(obj);
}
@Override
public boolean equalsBySdkFields(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof DescribeImagesRequest)) {
return false;
}
DescribeImagesRequest other = (DescribeImagesRequest) obj;
return Objects.equals(registryId(), other.registryId()) && Objects.equals(repositoryName(), other.repositoryName())
&& Objects.equals(imageIds(), other.imageIds()) && Objects.equals(nextToken(), other.nextToken())
&& Objects.equals(maxResults(), other.maxResults()) && Objects.equals(filter(), other.filter());
}
/**
* Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be
* redacted from this string using a placeholder value.
*/
@Override
public String toString() {
return ToString.builder("DescribeImagesRequest").add("RegistryId", registryId()).add("RepositoryName", repositoryName())
.add("ImageIds", imageIds()).add("NextToken", nextToken()).add("MaxResults", maxResults())
.add("Filter", filter()).build();
}
public Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "registryId":
return Optional.ofNullable(clazz.cast(registryId()));
case "repositoryName":
return Optional.ofNullable(clazz.cast(repositoryName()));
case "imageIds":
return Optional.ofNullable(clazz.cast(imageIds()));
case "nextToken":
return Optional.ofNullable(clazz.cast(nextToken()));
case "maxResults":
return Optional.ofNullable(clazz.cast(maxResults()));
case "filter":
return Optional.ofNullable(clazz.cast(filter()));
default:
return Optional.empty();
}
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((DescribeImagesRequest) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends EcrRequest.Builder, SdkPojo, CopyableBuilder {
/**
*
* The AWS 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.
*
*
* @param registryId
* The AWS 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder registryId(String registryId);
/**
*
* The repository that contains the images to describe.
*
*
* @param repositoryName
* The repository that contains the images to describe.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder repositoryName(String repositoryName);
/**
*
* The list of image IDs for the requested repository.
*
*
* @param imageIds
* The list of image IDs for the requested repository.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder imageIds(Collection imageIds);
/**
*
* The list of image IDs for the requested repository.
*
*
* @param imageIds
* The list of image IDs for the requested repository.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder imageIds(ImageIdentifier... imageIds);
/**
*
* The list of image IDs for the requested repository.
*
* This is a convenience that creates an instance of the {@link List.Builder} avoiding the need
* to create one manually via {@link List#builder()}.
*
* When the {@link Consumer} completes, {@link List.Builder#build()} is called immediately and
* its result is passed to {@link #imageIds(List)}.
*
* @param imageIds
* a consumer that will call methods on {@link List.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #imageIds(List)
*/
Builder imageIds(Consumer... imageIds);
/**
*
* 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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder nextToken(String nextToken);
/**
*
* 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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder maxResults(Integer maxResults);
/**
*
* The filter key and value with which to filter your DescribeImages results.
*
*
* @param filter
* The filter key and value with which to filter your DescribeImages results.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder filter(DescribeImagesFilter filter);
/**
*
* The filter key and value with which to filter your DescribeImages results.
*
* This is a convenience that creates an instance of the {@link DescribeImagesFilter.Builder} avoiding the need
* to create one manually via {@link DescribeImagesFilter#builder()}.
*
* When the {@link Consumer} completes, {@link DescribeImagesFilter.Builder#build()} is called immediately and
* its result is passed to {@link #filter(DescribeImagesFilter)}.
*
* @param filter
* a consumer that will call methods on {@link DescribeImagesFilter.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #filter(DescribeImagesFilter)
*/
default Builder filter(Consumer filter) {
return filter(DescribeImagesFilter.builder().applyMutation(filter).build());
}
@Override
Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration);
@Override
Builder overrideConfiguration(Consumer builderConsumer);
}
static final class BuilderImpl extends EcrRequest.BuilderImpl implements Builder {
private String registryId;
private String repositoryName;
private List imageIds = DefaultSdkAutoConstructList.getInstance();
private String nextToken;
private Integer maxResults;
private DescribeImagesFilter filter;
private BuilderImpl() {
}
private BuilderImpl(DescribeImagesRequest model) {
super(model);
registryId(model.registryId);
repositoryName(model.repositoryName);
imageIds(model.imageIds);
nextToken(model.nextToken);
maxResults(model.maxResults);
filter(model.filter);
}
public final String getRegistryId() {
return registryId;
}
@Override
public final Builder registryId(String registryId) {
this.registryId = registryId;
return this;
}
public final void setRegistryId(String registryId) {
this.registryId = registryId;
}
public final String getRepositoryName() {
return repositoryName;
}
@Override
public final Builder repositoryName(String repositoryName) {
this.repositoryName = repositoryName;
return this;
}
public final void setRepositoryName(String repositoryName) {
this.repositoryName = repositoryName;
}
public final Collection getImageIds() {
return imageIds != null ? imageIds.stream().map(ImageIdentifier::toBuilder).collect(Collectors.toList()) : null;
}
@Override
public final Builder imageIds(Collection imageIds) {
this.imageIds = ImageIdentifierListCopier.copy(imageIds);
return this;
}
@Override
@SafeVarargs
public final Builder imageIds(ImageIdentifier... imageIds) {
imageIds(Arrays.asList(imageIds));
return this;
}
@Override
@SafeVarargs
public final Builder imageIds(Consumer... imageIds) {
imageIds(Stream.of(imageIds).map(c -> ImageIdentifier.builder().applyMutation(c).build())
.collect(Collectors.toList()));
return this;
}
public final void setImageIds(Collection imageIds) {
this.imageIds = ImageIdentifierListCopier.copyFromBuilder(imageIds);
}
public final String getNextToken() {
return nextToken;
}
@Override
public final Builder nextToken(String nextToken) {
this.nextToken = nextToken;
return this;
}
public final void setNextToken(String nextToken) {
this.nextToken = nextToken;
}
public final Integer getMaxResults() {
return maxResults;
}
@Override
public final Builder maxResults(Integer maxResults) {
this.maxResults = maxResults;
return this;
}
public final void setMaxResults(Integer maxResults) {
this.maxResults = maxResults;
}
public final DescribeImagesFilter.Builder getFilter() {
return filter != null ? filter.toBuilder() : null;
}
@Override
public final Builder filter(DescribeImagesFilter filter) {
this.filter = filter;
return this;
}
public final void setFilter(DescribeImagesFilter.BuilderImpl filter) {
this.filter = filter != null ? filter.build() : null;
}
@Override
public Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) {
super.overrideConfiguration(overrideConfiguration);
return this;
}
@Override
public Builder overrideConfiguration(Consumer builderConsumer) {
super.overrideConfiguration(builderConsumer);
return this;
}
@Override
public DescribeImagesRequest build() {
return new DescribeImagesRequest(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy