com.amazonaws.services.cloudfront.model.DeleteDistributionRequest Maven / Gradle / Ivy
Show all versions of aws-java-sdk-cloudfront Show documentation
/*
* Copyright 2017-2022 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.cloudfront.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.AmazonWebServiceRequest;
/**
*
* This action deletes a web distribution. To delete a web distribution using the CloudFront API, perform the following
* steps.
*
*
* To delete a web distribution using the CloudFront API:
*
*
* -
*
* Disable the web distribution
*
*
* -
*
* Submit a GET Distribution Config request to get the current configuration and the Etag
* header for the distribution.
*
*
* -
*
* Update the XML document that was returned in the response to your GET Distribution Config request to
* change the value of Enabled to false.
*
*
* -
*
* Submit a PUT Distribution Config request to update the configuration for your distribution. In the
* request body, include the XML document that you updated in Step 3. Set the value of the HTTP If-Match
* header to the value of the ETag header that CloudFront returned when you submitted the
* GET Distribution Config request in Step 2.
*
*
* -
*
* Review the response to the PUT Distribution Config request to confirm that the distribution was
* successfully disabled.
*
*
* -
*
* Submit a GET Distribution request to confirm that your changes have propagated. When propagation is
* complete, the value of Status is Deployed.
*
*
* -
*
* Submit a DELETE Distribution request. Set the value of the HTTP If-Match header to the
* value of the ETag header that CloudFront returned when you submitted the
* GET Distribution Config request in Step 6.
*
*
* -
*
* Review the response to your DELETE Distribution request to confirm that the distribution was
* successfully deleted.
*
*
*
*
* For information about deleting a distribution using the CloudFront console, see Deleting a
* Distribution in the Amazon CloudFront Developer Guide.
*
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class DeleteDistributionRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable {
/**
*
* The distribution ID.
*
*/
private String id;
/**
*
* The value of the ETag header that you received when you disabled the distribution. For example:
* E2QWRUHAPOMQZL.
*
*/
private String ifMatch;
/**
* Default constructor for DeleteDistributionRequest object. Callers should use the setter or fluent setter
* (with...) methods to initialize the object after creating it.
*/
public DeleteDistributionRequest() {
}
/**
* Constructs a new DeleteDistributionRequest object. Callers should use the setter or fluent setter (with...)
* methods to initialize any additional object members.
*
* @param id
* The distribution ID.
* @param ifMatch
* The value of the ETag header that you received when you disabled the distribution. For
* example: E2QWRUHAPOMQZL.
*/
public DeleteDistributionRequest(String id, String ifMatch) {
setId(id);
setIfMatch(ifMatch);
}
/**
*
* The distribution ID.
*
*
* @param id
* The distribution ID.
*/
public void setId(String id) {
this.id = id;
}
/**
*
* The distribution ID.
*
*
* @return The distribution ID.
*/
public String getId() {
return this.id;
}
/**
*
* The distribution ID.
*
*
* @param id
* The distribution ID.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DeleteDistributionRequest withId(String id) {
setId(id);
return this;
}
/**
*
* The value of the ETag header that you received when you disabled the distribution. For example:
* E2QWRUHAPOMQZL.
*
*
* @param ifMatch
* The value of the ETag header that you received when you disabled the distribution. For
* example: E2QWRUHAPOMQZL.
*/
public void setIfMatch(String ifMatch) {
this.ifMatch = ifMatch;
}
/**
*
* The value of the ETag header that you received when you disabled the distribution. For example:
* E2QWRUHAPOMQZL.
*
*
* @return The value of the ETag header that you received when you disabled the distribution. For
* example: E2QWRUHAPOMQZL.
*/
public String getIfMatch() {
return this.ifMatch;
}
/**
*
* The value of the ETag header that you received when you disabled the distribution. For example:
* E2QWRUHAPOMQZL.
*
*
* @param ifMatch
* The value of the ETag header that you received when you disabled the distribution. For
* example: E2QWRUHAPOMQZL.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DeleteDistributionRequest withIfMatch(String ifMatch) {
setIfMatch(ifMatch);
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 (getId() != null)
sb.append("Id: ").append(getId()).append(",");
if (getIfMatch() != null)
sb.append("IfMatch: ").append(getIfMatch());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof DeleteDistributionRequest == false)
return false;
DeleteDistributionRequest other = (DeleteDistributionRequest) obj;
if (other.getId() == null ^ this.getId() == null)
return false;
if (other.getId() != null && other.getId().equals(this.getId()) == false)
return false;
if (other.getIfMatch() == null ^ this.getIfMatch() == null)
return false;
if (other.getIfMatch() != null && other.getIfMatch().equals(this.getIfMatch()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getId() == null) ? 0 : getId().hashCode());
hashCode = prime * hashCode + ((getIfMatch() == null) ? 0 : getIfMatch().hashCode());
return hashCode;
}
@Override
public DeleteDistributionRequest clone() {
return (DeleteDistributionRequest) super.clone();
}
}