com.amazonaws.services.ecr.model.BatchDeleteImageRequest Maven / Gradle / Ivy
Show all versions of aws-java-sdk-ecr Show documentation
/*
* Copyright 2018-2023 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 com.amazonaws.services.ecr.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.AmazonWebServiceRequest;
/**
*
* Deletes specified images within a specified repository. Images are specified with either the imageTag or
* imageDigest.
*
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class BatchDeleteImageRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable {
/**
*
* The Amazon Web Services account ID associated with the registry that contains the image to delete. If you do not
* specify a registry, the default registry is assumed.
*
*/
private String registryId;
/**
*
* The repository that contains the image to delete.
*
*/
private 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.
*
*/
private java.util.List imageIds;
/**
*
* The Amazon Web Services 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 Amazon Web Services 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 void setRegistryId(String registryId) {
this.registryId = registryId;
}
/**
*
* The Amazon Web Services 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 Amazon Web Services 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 getRegistryId() {
return this.registryId;
}
/**
*
* The Amazon Web Services 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 Amazon Web Services 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.
*/
public BatchDeleteImageRequest withRegistryId(String registryId) {
setRegistryId(registryId);
return this;
}
/**
*
* The repository that contains the image to delete.
*
*
* @param repositoryName
* The repository that contains the image to delete.
*/
public void setRepositoryName(String repositoryName) {
this.repositoryName = repositoryName;
}
/**
*
* The repository that contains the image to delete.
*
*
* @return The repository that contains the image to delete.
*/
public String getRepositoryName() {
return this.repositoryName;
}
/**
*
* 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.
*/
public BatchDeleteImageRequest withRepositoryName(String repositoryName) {
setRepositoryName(repositoryName);
return this;
}
/**
*
* 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 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 java.util.List getImageIds() {
return 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.
*/
public void setImageIds(java.util.Collection imageIds) {
if (imageIds == null) {
this.imageIds = null;
return;
}
this.imageIds = new java.util.ArrayList(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.
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setImageIds(java.util.Collection)} or {@link #withImageIds(java.util.Collection)} if you want to override
* the existing values.
*
*
* @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.
*/
public BatchDeleteImageRequest withImageIds(ImageIdentifier... imageIds) {
if (this.imageIds == null) {
setImageIds(new java.util.ArrayList(imageIds.length));
}
for (ImageIdentifier ele : imageIds) {
this.imageIds.add(ele);
}
return this;
}
/**
*
* 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.
*/
public BatchDeleteImageRequest withImageIds(java.util.Collection imageIds) {
setImageIds(imageIds);
return this;
}
/**
* 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.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getRegistryId() != null)
sb.append("RegistryId: ").append(getRegistryId()).append(",");
if (getRepositoryName() != null)
sb.append("RepositoryName: ").append(getRepositoryName()).append(",");
if (getImageIds() != null)
sb.append("ImageIds: ").append(getImageIds());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof BatchDeleteImageRequest == false)
return false;
BatchDeleteImageRequest other = (BatchDeleteImageRequest) obj;
if (other.getRegistryId() == null ^ this.getRegistryId() == null)
return false;
if (other.getRegistryId() != null && other.getRegistryId().equals(this.getRegistryId()) == false)
return false;
if (other.getRepositoryName() == null ^ this.getRepositoryName() == null)
return false;
if (other.getRepositoryName() != null && other.getRepositoryName().equals(this.getRepositoryName()) == false)
return false;
if (other.getImageIds() == null ^ this.getImageIds() == null)
return false;
if (other.getImageIds() != null && other.getImageIds().equals(this.getImageIds()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getRegistryId() == null) ? 0 : getRegistryId().hashCode());
hashCode = prime * hashCode + ((getRepositoryName() == null) ? 0 : getRepositoryName().hashCode());
hashCode = prime * hashCode + ((getImageIds() == null) ? 0 : getImageIds().hashCode());
return hashCode;
}
@Override
public BatchDeleteImageRequest clone() {
return (BatchDeleteImageRequest) super.clone();
}
}