software.amazon.awssdk.services.ecr.model.BatchDeleteImageRequest 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;
/**
*
* Deletes specified images within a specified repository. Images are specified with either the imageTag or
* imageDigest.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class BatchDeleteImageRequest extends EcrRequest implements
ToCopyableBuilder {
private static final SdkField REGISTRY_ID_FIELD = SdkField. builder(MarshallingType.STRING)
.getter(getter(BatchDeleteImageRequest::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(BatchDeleteImageRequest::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(BatchDeleteImageRequest::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 List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(REGISTRY_ID_FIELD,
REPOSITORY_NAME_FIELD, IMAGE_IDS_FIELD));
private final String registryId;
private final String repositoryName;
private final List imageIds;
private BatchDeleteImageRequest(BuilderImpl builder) {
super(builder);
this.registryId = builder.registryId;
this.repositoryName = builder.repositoryName;
this.imageIds = builder.imageIds;
}
/**
*
* The AWS account ID associated with the registry that contains the image to delete. If you do not specify a
* registry, the default registry is assumed.
*
*
* @return The AWS account ID associated with the registry that contains the image to delete. If you do not specify
* a registry, the default registry is assumed.
*/
public String registryId() {
return registryId;
}
/**
*
* The repository that contains the image to delete.
*
*
* @return The repository that contains the image to delete.
*/
public String repositoryName() {
return repositoryName;
}
/**
*
* A list of image ID references that correspond to images to delete. The format of the imageIds
* reference is imageTag=tag or imageDigest=digest.
*
*
* Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
*
*
* @return A list of image ID references that correspond to images to delete. The format of the
* imageIds reference is imageTag=tag or imageDigest=digest.
*/
public List imageIds() {
return imageIds;
}
@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 + Objects.hashCode(registryId());
hashCode = 31 * hashCode + Objects.hashCode(repositoryName());
hashCode = 31 * hashCode + Objects.hashCode(imageIds());
return hashCode;
}
@Override
public boolean equals(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof BatchDeleteImageRequest)) {
return false;
}
BatchDeleteImageRequest other = (BatchDeleteImageRequest) obj;
return Objects.equals(registryId(), other.registryId()) && Objects.equals(repositoryName(), other.repositoryName())
&& Objects.equals(imageIds(), other.imageIds());
}
/**
* 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("BatchDeleteImageRequest").add("RegistryId", registryId())
.add("RepositoryName", repositoryName()).add("ImageIds", imageIds()).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()));
default:
return Optional.empty();
}
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((BatchDeleteImageRequest) 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 image to delete. 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 image to delete. 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 image to delete.
*
*
* @param repositoryName
* The repository that contains the image to delete.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder repositoryName(String repositoryName);
/**
*
* A list of image ID references that correspond to images to delete. The format of the imageIds
* reference is imageTag=tag or imageDigest=digest.
*
*
* @param imageIds
* A list of image ID references that correspond to images to delete. The format of the
* imageIds reference is imageTag=tag or imageDigest=digest.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder imageIds(Collection imageIds);
/**
*
* A list of image ID references that correspond to images to delete. The format of the imageIds
* reference is imageTag=tag or imageDigest=digest.
*
*
* @param imageIds
* A list of image ID references that correspond to images to delete. The format of the
* imageIds reference is imageTag=tag or imageDigest=digest.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder imageIds(ImageIdentifier... imageIds);
/**
*
* A list of image ID references that correspond to images to delete. The format of the imageIds
* reference is imageTag=tag or imageDigest=digest.
*
* 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);
@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 BuilderImpl() {
}
private BuilderImpl(BatchDeleteImageRequest model) {
super(model);
registryId(model.registryId);
repositoryName(model.repositoryName);
imageIds(model.imageIds);
}
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);
}
@Override
public Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) {
super.overrideConfiguration(overrideConfiguration);
return this;
}
@Override
public Builder overrideConfiguration(Consumer builderConsumer) {
super.overrideConfiguration(builderConsumer);
return this;
}
@Override
public BatchDeleteImageRequest build() {
return new BatchDeleteImageRequest(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy