com.amazonaws.services.elasticmapreduce.model.SetTerminationProtectionRequest Maven / Gradle / Ivy
Show all versions of aws-java-sdk Show documentation
/*
* Copyright 2010-2014 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.elasticmapreduce.model;
import java.io.Serializable;
import com.amazonaws.AmazonWebServiceRequest;
/**
* Container for the parameters to the {@link com.amazonaws.services.elasticmapreduce.AmazonElasticMapReduce#setTerminationProtection(SetTerminationProtectionRequest) SetTerminationProtection operation}.
*
* SetTerminationProtection locks a job flow so the Amazon EC2 instances
* in the cluster cannot be terminated by user intervention, an API call,
* or in the event of a job-flow error. The cluster still terminates upon
* successful completion of the job flow. Calling
* SetTerminationProtection on a job flow is analogous to calling the
* Amazon EC2 DisableAPITermination API on all of the EC2 instances in a
* cluster.
*
*
* SetTerminationProtection is used to prevent accidental termination of
* a job flow and to ensure that in the event of an error, the instances
* will persist so you can recover any data stored in their ephemeral
* instance storage.
*
*
* To terminate a job flow that has been locked by setting
* SetTerminationProtection to true ,
* you must first unlock the job flow by a subsequent call to
* SetTerminationProtection in which you set the value to
* false .
*
*
* For more information, go to
* Protecting a Job Flow from Termination
* in the Amazon Elastic MapReduce Developer's Guide.
*
*
* @see com.amazonaws.services.elasticmapreduce.AmazonElasticMapReduce#setTerminationProtection(SetTerminationProtectionRequest)
*/
public class SetTerminationProtectionRequest extends AmazonWebServiceRequest implements Serializable {
/**
* A list of strings that uniquely identify the job flows to protect.
* This identifier is returned by RunJobFlow and can also be
* obtained from DescribeJobFlows .
*/
private com.amazonaws.internal.ListWithAutoConstructFlag jobFlowIds;
/**
* A Boolean that indicates whether to protect the job flow and prevent
* the Amazon EC2 instances in the cluster from shutting down due to API
* calls, user intervention, or job-flow error.
*/
private Boolean terminationProtected;
/**
* A list of strings that uniquely identify the job flows to protect.
* This identifier is returned by RunJobFlow and can also be
* obtained from DescribeJobFlows .
*
* @return A list of strings that uniquely identify the job flows to protect.
* This identifier is returned by RunJobFlow and can also be
* obtained from DescribeJobFlows .
*/
public java.util.List getJobFlowIds() {
if (jobFlowIds == null) {
jobFlowIds = new com.amazonaws.internal.ListWithAutoConstructFlag();
jobFlowIds.setAutoConstruct(true);
}
return jobFlowIds;
}
/**
* A list of strings that uniquely identify the job flows to protect.
* This identifier is returned by RunJobFlow and can also be
* obtained from DescribeJobFlows .
*
* @param jobFlowIds A list of strings that uniquely identify the job flows to protect.
* This identifier is returned by RunJobFlow and can also be
* obtained from DescribeJobFlows .
*/
public void setJobFlowIds(java.util.Collection jobFlowIds) {
if (jobFlowIds == null) {
this.jobFlowIds = null;
return;
}
com.amazonaws.internal.ListWithAutoConstructFlag jobFlowIdsCopy = new com.amazonaws.internal.ListWithAutoConstructFlag(jobFlowIds.size());
jobFlowIdsCopy.addAll(jobFlowIds);
this.jobFlowIds = jobFlowIdsCopy;
}
/**
* A list of strings that uniquely identify the job flows to protect.
* This identifier is returned by RunJobFlow and can also be
* obtained from DescribeJobFlows .
*
* Returns a reference to this object so that method calls can be chained together.
*
* @param jobFlowIds A list of strings that uniquely identify the job flows to protect.
* This identifier is returned by RunJobFlow and can also be
* obtained from DescribeJobFlows .
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public SetTerminationProtectionRequest withJobFlowIds(String... jobFlowIds) {
if (getJobFlowIds() == null) setJobFlowIds(new java.util.ArrayList(jobFlowIds.length));
for (String value : jobFlowIds) {
getJobFlowIds().add(value);
}
return this;
}
/**
* A list of strings that uniquely identify the job flows to protect.
* This identifier is returned by RunJobFlow and can also be
* obtained from DescribeJobFlows .
*
* Returns a reference to this object so that method calls can be chained together.
*
* @param jobFlowIds A list of strings that uniquely identify the job flows to protect.
* This identifier is returned by RunJobFlow and can also be
* obtained from DescribeJobFlows .
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public SetTerminationProtectionRequest withJobFlowIds(java.util.Collection jobFlowIds) {
if (jobFlowIds == null) {
this.jobFlowIds = null;
} else {
com.amazonaws.internal.ListWithAutoConstructFlag jobFlowIdsCopy = new com.amazonaws.internal.ListWithAutoConstructFlag(jobFlowIds.size());
jobFlowIdsCopy.addAll(jobFlowIds);
this.jobFlowIds = jobFlowIdsCopy;
}
return this;
}
/**
* A Boolean that indicates whether to protect the job flow and prevent
* the Amazon EC2 instances in the cluster from shutting down due to API
* calls, user intervention, or job-flow error.
*
* @return A Boolean that indicates whether to protect the job flow and prevent
* the Amazon EC2 instances in the cluster from shutting down due to API
* calls, user intervention, or job-flow error.
*/
public Boolean isTerminationProtected() {
return terminationProtected;
}
/**
* A Boolean that indicates whether to protect the job flow and prevent
* the Amazon EC2 instances in the cluster from shutting down due to API
* calls, user intervention, or job-flow error.
*
* @param terminationProtected A Boolean that indicates whether to protect the job flow and prevent
* the Amazon EC2 instances in the cluster from shutting down due to API
* calls, user intervention, or job-flow error.
*/
public void setTerminationProtected(Boolean terminationProtected) {
this.terminationProtected = terminationProtected;
}
/**
* A Boolean that indicates whether to protect the job flow and prevent
* the Amazon EC2 instances in the cluster from shutting down due to API
* calls, user intervention, or job-flow error.
*
* Returns a reference to this object so that method calls can be chained together.
*
* @param terminationProtected A Boolean that indicates whether to protect the job flow and prevent
* the Amazon EC2 instances in the cluster from shutting down due to API
* calls, user intervention, or job-flow error.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public SetTerminationProtectionRequest withTerminationProtected(Boolean terminationProtected) {
this.terminationProtected = terminationProtected;
return this;
}
/**
* A Boolean that indicates whether to protect the job flow and prevent
* the Amazon EC2 instances in the cluster from shutting down due to API
* calls, user intervention, or job-flow error.
*
* @return A Boolean that indicates whether to protect the job flow and prevent
* the Amazon EC2 instances in the cluster from shutting down due to API
* calls, user intervention, or job-flow error.
*/
public Boolean getTerminationProtected() {
return terminationProtected;
}
/**
* Returns a string representation of this object; useful for testing and
* debugging.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getJobFlowIds() != null) sb.append("JobFlowIds: " + getJobFlowIds() + ",");
if (isTerminationProtected() != null) sb.append("TerminationProtected: " + isTerminationProtected() );
sb.append("}");
return sb.toString();
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getJobFlowIds() == null) ? 0 : getJobFlowIds().hashCode());
hashCode = prime * hashCode + ((isTerminationProtected() == null) ? 0 : isTerminationProtected().hashCode());
return hashCode;
}
@Override
public boolean equals(Object obj) {
if (this == obj) return true;
if (obj == null) return false;
if (obj instanceof SetTerminationProtectionRequest == false) return false;
SetTerminationProtectionRequest other = (SetTerminationProtectionRequest)obj;
if (other.getJobFlowIds() == null ^ this.getJobFlowIds() == null) return false;
if (other.getJobFlowIds() != null && other.getJobFlowIds().equals(this.getJobFlowIds()) == false) return false;
if (other.isTerminationProtected() == null ^ this.isTerminationProtected() == null) return false;
if (other.isTerminationProtected() != null && other.isTerminationProtected().equals(this.isTerminationProtected()) == false) return false;
return true;
}
}