com.amazonaws.services.ec2.model.DeleteIpamPoolRequest Maven / Gradle / Ivy
Show all versions of aws-java-sdk-ec2 Show documentation
/*
* Copyright 2019-2024 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.ec2.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.AmazonWebServiceRequest;
import com.amazonaws.Request;
import com.amazonaws.services.ec2.model.transform.DeleteIpamPoolRequestMarshaller;
/**
*
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class DeleteIpamPoolRequest extends AmazonWebServiceRequest implements Serializable, Cloneable, DryRunSupportedRequest {
/**
*
* The ID of the pool to delete.
*
*/
private String ipamPoolId;
/**
*
* Enables you to quickly delete an IPAM pool and all resources within that pool, including provisioned CIDRs,
* allocations, and other pools.
*
*
*
* You can only use this option to delete pools in the private scope or pools in the public scope with a source
* resource. A source resource is a resource used to provision CIDRs to a resource planning pool.
*
*
*/
private Boolean cascade;
/**
*
* The ID of the pool to delete.
*
*
* @param ipamPoolId
* The ID of the pool to delete.
*/
public void setIpamPoolId(String ipamPoolId) {
this.ipamPoolId = ipamPoolId;
}
/**
*
* The ID of the pool to delete.
*
*
* @return The ID of the pool to delete.
*/
public String getIpamPoolId() {
return this.ipamPoolId;
}
/**
*
* The ID of the pool to delete.
*
*
* @param ipamPoolId
* The ID of the pool to delete.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DeleteIpamPoolRequest withIpamPoolId(String ipamPoolId) {
setIpamPoolId(ipamPoolId);
return this;
}
/**
*
* Enables you to quickly delete an IPAM pool and all resources within that pool, including provisioned CIDRs,
* allocations, and other pools.
*
*
*
* You can only use this option to delete pools in the private scope or pools in the public scope with a source
* resource. A source resource is a resource used to provision CIDRs to a resource planning pool.
*
*
*
* @param cascade
* Enables you to quickly delete an IPAM pool and all resources within that pool, including provisioned
* CIDRs, allocations, and other pools.
*
* You can only use this option to delete pools in the private scope or pools in the public scope with a
* source resource. A source resource is a resource used to provision CIDRs to a resource planning pool.
*
*/
public void setCascade(Boolean cascade) {
this.cascade = cascade;
}
/**
*
* Enables you to quickly delete an IPAM pool and all resources within that pool, including provisioned CIDRs,
* allocations, and other pools.
*
*
*
* You can only use this option to delete pools in the private scope or pools in the public scope with a source
* resource. A source resource is a resource used to provision CIDRs to a resource planning pool.
*
*
*
* @return Enables you to quickly delete an IPAM pool and all resources within that pool, including provisioned
* CIDRs, allocations, and other pools.
*
* You can only use this option to delete pools in the private scope or pools in the public scope with a
* source resource. A source resource is a resource used to provision CIDRs to a resource planning pool.
*
*/
public Boolean getCascade() {
return this.cascade;
}
/**
*
* Enables you to quickly delete an IPAM pool and all resources within that pool, including provisioned CIDRs,
* allocations, and other pools.
*
*
*
* You can only use this option to delete pools in the private scope or pools in the public scope with a source
* resource. A source resource is a resource used to provision CIDRs to a resource planning pool.
*
*
*
* @param cascade
* Enables you to quickly delete an IPAM pool and all resources within that pool, including provisioned
* CIDRs, allocations, and other pools.
*
* You can only use this option to delete pools in the private scope or pools in the public scope with a
* source resource. A source resource is a resource used to provision CIDRs to a resource planning pool.
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DeleteIpamPoolRequest withCascade(Boolean cascade) {
setCascade(cascade);
return this;
}
/**
*
* Enables you to quickly delete an IPAM pool and all resources within that pool, including provisioned CIDRs,
* allocations, and other pools.
*
*
*
* You can only use this option to delete pools in the private scope or pools in the public scope with a source
* resource. A source resource is a resource used to provision CIDRs to a resource planning pool.
*
*
*
* @return Enables you to quickly delete an IPAM pool and all resources within that pool, including provisioned
* CIDRs, allocations, and other pools.
*
* You can only use this option to delete pools in the private scope or pools in the public scope with a
* source resource. A source resource is a resource used to provision CIDRs to a resource planning pool.
*
*/
public Boolean isCascade() {
return this.cascade;
}
/**
* This method is intended for internal use only. Returns the marshaled request configured with additional
* parameters to enable operation dry-run.
*/
@Override
public Request getDryRunRequest() {
Request request = new DeleteIpamPoolRequestMarshaller().marshall(this);
request.addParameter("DryRun", Boolean.toString(true));
return request;
}
/**
* 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 (getIpamPoolId() != null)
sb.append("IpamPoolId: ").append(getIpamPoolId()).append(",");
if (getCascade() != null)
sb.append("Cascade: ").append(getCascade());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof DeleteIpamPoolRequest == false)
return false;
DeleteIpamPoolRequest other = (DeleteIpamPoolRequest) obj;
if (other.getIpamPoolId() == null ^ this.getIpamPoolId() == null)
return false;
if (other.getIpamPoolId() != null && other.getIpamPoolId().equals(this.getIpamPoolId()) == false)
return false;
if (other.getCascade() == null ^ this.getCascade() == null)
return false;
if (other.getCascade() != null && other.getCascade().equals(this.getCascade()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getIpamPoolId() == null) ? 0 : getIpamPoolId().hashCode());
hashCode = prime * hashCode + ((getCascade() == null) ? 0 : getCascade().hashCode());
return hashCode;
}
@Override
public DeleteIpamPoolRequest clone() {
return (DeleteIpamPoolRequest) super.clone();
}
}