com.amazonaws.services.location.model.DeleteKeyRequest Maven / Gradle / Ivy
Show all versions of aws-java-sdk-location 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.location.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.AmazonWebServiceRequest;
/**
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class DeleteKeyRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable {
/**
*
* The name of the API key to delete.
*
*/
private String keyName;
/**
*
* ForceDelete bypasses an API key's expiry conditions and deletes the key. Set the parameter true to
* delete the key or to false to not preemptively delete the API key.
*
*
* Valid values: true, or false.
*
*
* Required: No
*
*
*
* This action is irreversible. Only use ForceDelete if you are certain the key is no longer in use.
*
*
*/
private Boolean forceDelete;
/**
*
* The name of the API key to delete.
*
*
* @param keyName
* The name of the API key to delete.
*/
public void setKeyName(String keyName) {
this.keyName = keyName;
}
/**
*
* The name of the API key to delete.
*
*
* @return The name of the API key to delete.
*/
public String getKeyName() {
return this.keyName;
}
/**
*
* The name of the API key to delete.
*
*
* @param keyName
* The name of the API key to delete.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DeleteKeyRequest withKeyName(String keyName) {
setKeyName(keyName);
return this;
}
/**
*
* ForceDelete bypasses an API key's expiry conditions and deletes the key. Set the parameter true to
* delete the key or to false to not preemptively delete the API key.
*
*
* Valid values: true, or false.
*
*
* Required: No
*
*
*
* This action is irreversible. Only use ForceDelete if you are certain the key is no longer in use.
*
*
*
* @param forceDelete
* ForceDelete bypasses an API key's expiry conditions and deletes the key. Set the parameter
* true to delete the key or to false to not preemptively delete the API key.
*
* Valid values: true, or false.
*
*
* Required: No
*
*
*
* This action is irreversible. Only use ForceDelete if you are certain the key is no longer in use.
*
*/
public void setForceDelete(Boolean forceDelete) {
this.forceDelete = forceDelete;
}
/**
*
* ForceDelete bypasses an API key's expiry conditions and deletes the key. Set the parameter true to
* delete the key or to false to not preemptively delete the API key.
*
*
* Valid values: true, or false.
*
*
* Required: No
*
*
*
* This action is irreversible. Only use ForceDelete if you are certain the key is no longer in use.
*
*
*
* @return ForceDelete bypasses an API key's expiry conditions and deletes the key. Set the parameter
* true to delete the key or to false to not preemptively delete the API key.
*
* Valid values: true, or false.
*
*
* Required: No
*
*
*
* This action is irreversible. Only use ForceDelete if you are certain the key is no longer in use.
*
*/
public Boolean getForceDelete() {
return this.forceDelete;
}
/**
*
* ForceDelete bypasses an API key's expiry conditions and deletes the key. Set the parameter true to
* delete the key or to false to not preemptively delete the API key.
*
*
* Valid values: true, or false.
*
*
* Required: No
*
*
*
* This action is irreversible. Only use ForceDelete if you are certain the key is no longer in use.
*
*
*
* @param forceDelete
* ForceDelete bypasses an API key's expiry conditions and deletes the key. Set the parameter
* true to delete the key or to false to not preemptively delete the API key.
*
* Valid values: true, or false.
*
*
* Required: No
*
*
*
* This action is irreversible. Only use ForceDelete if you are certain the key is no longer in use.
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DeleteKeyRequest withForceDelete(Boolean forceDelete) {
setForceDelete(forceDelete);
return this;
}
/**
*
* ForceDelete bypasses an API key's expiry conditions and deletes the key. Set the parameter true to
* delete the key or to false to not preemptively delete the API key.
*
*
* Valid values: true, or false.
*
*
* Required: No
*
*
*
* This action is irreversible. Only use ForceDelete if you are certain the key is no longer in use.
*
*
*
* @return ForceDelete bypasses an API key's expiry conditions and deletes the key. Set the parameter
* true to delete the key or to false to not preemptively delete the API key.
*
* Valid values: true, or false.
*
*
* Required: No
*
*
*
* This action is irreversible. Only use ForceDelete if you are certain the key is no longer in use.
*
*/
public Boolean isForceDelete() {
return this.forceDelete;
}
/**
* 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 (getKeyName() != null)
sb.append("KeyName: ").append(getKeyName()).append(",");
if (getForceDelete() != null)
sb.append("ForceDelete: ").append(getForceDelete());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof DeleteKeyRequest == false)
return false;
DeleteKeyRequest other = (DeleteKeyRequest) obj;
if (other.getKeyName() == null ^ this.getKeyName() == null)
return false;
if (other.getKeyName() != null && other.getKeyName().equals(this.getKeyName()) == false)
return false;
if (other.getForceDelete() == null ^ this.getForceDelete() == null)
return false;
if (other.getForceDelete() != null && other.getForceDelete().equals(this.getForceDelete()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getKeyName() == null) ? 0 : getKeyName().hashCode());
hashCode = prime * hashCode + ((getForceDelete() == null) ? 0 : getForceDelete().hashCode());
return hashCode;
}
@Override
public DeleteKeyRequest clone() {
return (DeleteKeyRequest) super.clone();
}
}