com.amazonaws.services.elasticmapreduce.model.AddJobFlowStepsRequest Maven / Gradle / Ivy
/*
* 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#addJobFlowSteps(AddJobFlowStepsRequest) AddJobFlowSteps operation}.
*
* AddJobFlowSteps adds new steps to a running job flow. A maximum of
* 256 steps are allowed in each job flow.
*
*
* If your job flow is long-running (such as a Hive data warehouse) or
* complex, you may require more than 256 steps to process your data. You
* can bypass the 256-step limitation in various ways, including using
* the SSH shell to connect to the master node and submitting queries
* directly to the software running on the master node, such as Hive and
* Hadoop. For more information on how to do this, go to
* Add More than 256 Steps to a Job Flow
* in the Amazon Elastic MapReduce Developer's Guide .
*
*
* A step specifies the location of a JAR file stored either on the
* master node of the job flow or in Amazon S3. Each step is performed by
* the main function of the main class of the JAR file. The main class
* can be specified either in the manifest of the JAR or by using the
* MainFunction parameter of the step.
*
*
* Elastic MapReduce executes each step in the order listed. For a step
* to be considered complete, the main function must exit with a zero
* exit code and all Hadoop jobs started while the step was running must
* have completed and run successfully.
*
*
* You can only add steps to a job flow that is in one of the following
* states: STARTING, BOOTSTRAPPING, RUNNING, or WAITING.
*
*
* @see com.amazonaws.services.elasticmapreduce.AmazonElasticMapReduce#addJobFlowSteps(AddJobFlowStepsRequest)
*/
public class AddJobFlowStepsRequest extends AmazonWebServiceRequest implements Serializable {
/**
* A string that uniquely identifies the job flow. This identifier is
* returned by RunJobFlow and can also be obtained from
* ListClusters.
*
* Constraints:
* Length: 0 - 256
* Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
*/
private String jobFlowId;
/**
* A list of StepConfig to be executed by the job flow.
*/
private com.amazonaws.internal.ListWithAutoConstructFlag steps;
/**
* Default constructor for a new AddJobFlowStepsRequest object. Callers should use the
* setter or fluent setter (with...) methods to initialize this object after creating it.
*/
public AddJobFlowStepsRequest() {}
/**
* Constructs a new AddJobFlowStepsRequest object.
* Callers should use the setter or fluent setter (with...) methods to
* initialize any additional object members.
*
* @param jobFlowId A string that uniquely identifies the job flow. This
* identifier is returned by RunJobFlow and can also be obtained
* from ListClusters.
*/
public AddJobFlowStepsRequest(String jobFlowId) {
setJobFlowId(jobFlowId);
}
/**
* Constructs a new AddJobFlowStepsRequest object.
* Callers should use the setter or fluent setter (with...) methods to
* initialize any additional object members.
*
* @param jobFlowId A string that uniquely identifies the job flow. This
* identifier is returned by RunJobFlow and can also be obtained
* from ListClusters.
* @param steps A list of StepConfig to be executed by the job
* flow.
*/
public AddJobFlowStepsRequest(String jobFlowId, java.util.List steps) {
setJobFlowId(jobFlowId);
setSteps(steps);
}
/**
* A string that uniquely identifies the job flow. This identifier is
* returned by RunJobFlow and can also be obtained from
* ListClusters.
*
* Constraints:
* Length: 0 - 256
* Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
*
* @return A string that uniquely identifies the job flow. This identifier is
* returned by RunJobFlow and can also be obtained from
* ListClusters.
*/
public String getJobFlowId() {
return jobFlowId;
}
/**
* A string that uniquely identifies the job flow. This identifier is
* returned by RunJobFlow and can also be obtained from
* ListClusters.
*
* Constraints:
* Length: 0 - 256
* Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
*
* @param jobFlowId A string that uniquely identifies the job flow. This identifier is
* returned by RunJobFlow and can also be obtained from
* ListClusters.
*/
public void setJobFlowId(String jobFlowId) {
this.jobFlowId = jobFlowId;
}
/**
* A string that uniquely identifies the job flow. This identifier is
* returned by RunJobFlow and can also be obtained from
* ListClusters.
*
* Returns a reference to this object so that method calls can be chained together.
*
* Constraints:
* Length: 0 - 256
* Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
*
* @param jobFlowId A string that uniquely identifies the job flow. This identifier is
* returned by RunJobFlow and can also be obtained from
* ListClusters.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public AddJobFlowStepsRequest withJobFlowId(String jobFlowId) {
this.jobFlowId = jobFlowId;
return this;
}
/**
* A list of StepConfig to be executed by the job flow.
*
* @return A list of StepConfig to be executed by the job flow.
*/
public java.util.List getSteps() {
if (steps == null) {
steps = new com.amazonaws.internal.ListWithAutoConstructFlag();
steps.setAutoConstruct(true);
}
return steps;
}
/**
* A list of StepConfig to be executed by the job flow.
*
* @param steps A list of StepConfig to be executed by the job flow.
*/
public void setSteps(java.util.Collection steps) {
if (steps == null) {
this.steps = null;
return;
}
com.amazonaws.internal.ListWithAutoConstructFlag stepsCopy = new com.amazonaws.internal.ListWithAutoConstructFlag(steps.size());
stepsCopy.addAll(steps);
this.steps = stepsCopy;
}
/**
* A list of StepConfig to be executed by the job flow.
*
* Returns a reference to this object so that method calls can be chained together.
*
* @param steps A list of StepConfig to be executed by the job flow.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public AddJobFlowStepsRequest withSteps(StepConfig... steps) {
if (getSteps() == null) setSteps(new java.util.ArrayList(steps.length));
for (StepConfig value : steps) {
getSteps().add(value);
}
return this;
}
/**
* A list of StepConfig to be executed by the job flow.
*
* Returns a reference to this object so that method calls can be chained together.
*
* @param steps A list of StepConfig to be executed by the job flow.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public AddJobFlowStepsRequest withSteps(java.util.Collection steps) {
if (steps == null) {
this.steps = null;
} else {
com.amazonaws.internal.ListWithAutoConstructFlag stepsCopy = new com.amazonaws.internal.ListWithAutoConstructFlag(steps.size());
stepsCopy.addAll(steps);
this.steps = stepsCopy;
}
return this;
}
/**
* 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 (getJobFlowId() != null) sb.append("JobFlowId: " + getJobFlowId() + ",");
if (getSteps() != null) sb.append("Steps: " + getSteps() );
sb.append("}");
return sb.toString();
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getJobFlowId() == null) ? 0 : getJobFlowId().hashCode());
hashCode = prime * hashCode + ((getSteps() == null) ? 0 : getSteps().hashCode());
return hashCode;
}
@Override
public boolean equals(Object obj) {
if (this == obj) return true;
if (obj == null) return false;
if (obj instanceof AddJobFlowStepsRequest == false) return false;
AddJobFlowStepsRequest other = (AddJobFlowStepsRequest)obj;
if (other.getJobFlowId() == null ^ this.getJobFlowId() == null) return false;
if (other.getJobFlowId() != null && other.getJobFlowId().equals(this.getJobFlowId()) == false) return false;
if (other.getSteps() == null ^ this.getSteps() == null) return false;
if (other.getSteps() != null && other.getSteps().equals(this.getSteps()) == false) return false;
return true;
}
}