com.amazonaws.services.elasticmapreduce.model

Class JobFlowInstancesDetail

java.lang.Object

com.amazonaws.services.elasticmapreduce.model.JobFlowInstancesDetail

All Implemented Interfaces:

Serializable, Cloneable

public class JobFlowInstancesDetail
extends Object
implements Serializable, Cloneable

Specify the type of Amazon EC2 instances to run the job flow on.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
JobFlowInstancesDetail() Default constructor for a new JobFlowInstancesDetail object.
JobFlowInstancesDetail(String masterInstanceType, String slaveInstanceType, Integer instanceCount) Constructs a new JobFlowInstancesDetail object.

Method Summary

Methods

Modifier and Type	Method and Description
JobFlowInstancesDetail	clone()
boolean	equals(Object obj)
String	getEc2KeyName() The name of an Amazon EC2 key pair that can be used to ssh to the master node of job flow.
String	getEc2SubnetId() For job flows launched within Amazon Virtual Private Cloud, this value specifies the identifier of the subnet where the job flow was launched.
String	getHadoopVersion() The Hadoop version for the job flow.
Integer	getInstanceCount() The number of Amazon EC2 instances in the cluster.
List<InstanceGroupDetail>	getInstanceGroups() Details about the job flow's instance groups.
Boolean	getKeepJobFlowAliveWhenNoSteps() Specifies whether the job flow should terminate after completing all steps.
String	getMasterInstanceId() The Amazon EC2 instance identifier of the master node.
String	getMasterInstanceType() The Amazon EC2 master node instance type.
String	getMasterPublicDnsName() The DNS name of the master node.
Integer	getNormalizedInstanceHours() An approximation of the cost of the job flow, represented in m1.small/hours.
PlacementType	getPlacement() The Amazon EC2 Availability Zone for the job flow.
String	getSlaveInstanceType() The Amazon EC2 slave node instance type.
Boolean	getTerminationProtected() Specifies whether the Amazon EC2 instances in the cluster are protected from termination by API calls, user intervention, or in the event of a job flow error.
int	hashCode()
Boolean	isKeepJobFlowAliveWhenNoSteps() Specifies whether the job flow should terminate after completing all steps.
Boolean	isTerminationProtected() Specifies whether the Amazon EC2 instances in the cluster are protected from termination by API calls, user intervention, or in the event of a job flow error.
void	setEc2KeyName(String ec2KeyName) The name of an Amazon EC2 key pair that can be used to ssh to the master node of job flow.
void	setEc2SubnetId(String ec2SubnetId) For job flows launched within Amazon Virtual Private Cloud, this value specifies the identifier of the subnet where the job flow was launched.
void	setHadoopVersion(String hadoopVersion) The Hadoop version for the job flow.
void	setInstanceCount(Integer instanceCount) The number of Amazon EC2 instances in the cluster.
void	setInstanceGroups(Collection<InstanceGroupDetail> instanceGroups) Details about the job flow's instance groups.
void	setKeepJobFlowAliveWhenNoSteps(Boolean keepJobFlowAliveWhenNoSteps) Specifies whether the job flow should terminate after completing all steps.
void	setMasterInstanceId(String masterInstanceId) The Amazon EC2 instance identifier of the master node.
void	setMasterInstanceType(String masterInstanceType) The Amazon EC2 master node instance type.
void	setMasterPublicDnsName(String masterPublicDnsName) The DNS name of the master node.
void	setNormalizedInstanceHours(Integer normalizedInstanceHours) An approximation of the cost of the job flow, represented in m1.small/hours.
void	setPlacement(PlacementType placement) The Amazon EC2 Availability Zone for the job flow.
void	setSlaveInstanceType(String slaveInstanceType) The Amazon EC2 slave node instance type.
void	setTerminationProtected(Boolean terminationProtected) Specifies whether the Amazon EC2 instances in the cluster are protected from termination by API calls, user intervention, or in the event of a job flow error.
String	toString() Returns a string representation of this object; useful for testing and debugging.
JobFlowInstancesDetail	withEc2KeyName(String ec2KeyName) The name of an Amazon EC2 key pair that can be used to ssh to the master node of job flow.
JobFlowInstancesDetail	withEc2SubnetId(String ec2SubnetId) For job flows launched within Amazon Virtual Private Cloud, this value specifies the identifier of the subnet where the job flow was launched.
JobFlowInstancesDetail	withHadoopVersion(String hadoopVersion) The Hadoop version for the job flow.
JobFlowInstancesDetail	withInstanceCount(Integer instanceCount) The number of Amazon EC2 instances in the cluster.
JobFlowInstancesDetail	withInstanceGroups(Collection<InstanceGroupDetail> instanceGroups) Details about the job flow's instance groups.
JobFlowInstancesDetail	withInstanceGroups(InstanceGroupDetail... instanceGroups) Details about the job flow's instance groups.
JobFlowInstancesDetail	withKeepJobFlowAliveWhenNoSteps(Boolean keepJobFlowAliveWhenNoSteps) Specifies whether the job flow should terminate after completing all steps.
JobFlowInstancesDetail	withMasterInstanceId(String masterInstanceId) The Amazon EC2 instance identifier of the master node.
JobFlowInstancesDetail	withMasterInstanceType(String masterInstanceType) The Amazon EC2 master node instance type.
JobFlowInstancesDetail	withMasterPublicDnsName(String masterPublicDnsName) The DNS name of the master node.
JobFlowInstancesDetail	withNormalizedInstanceHours(Integer normalizedInstanceHours) An approximation of the cost of the job flow, represented in m1.small/hours.
JobFlowInstancesDetail	withPlacement(PlacementType placement) The Amazon EC2 Availability Zone for the job flow.
JobFlowInstancesDetail	withSlaveInstanceType(String slaveInstanceType) The Amazon EC2 slave node instance type.
JobFlowInstancesDetail	withTerminationProtected(Boolean terminationProtected) Specifies whether the Amazon EC2 instances in the cluster are protected from termination by API calls, user intervention, or in the event of a job flow error.

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

JobFlowInstancesDetail

public JobFlowInstancesDetail()

Default constructor for a new JobFlowInstancesDetail object. Callers should use the setter or fluent setter (with...) methods to initialize this object after creating it.

JobFlowInstancesDetail

public JobFlowInstancesDetail(String masterInstanceType,
                      String slaveInstanceType,
                      Integer instanceCount)

Constructs a new JobFlowInstancesDetail object. Callers should use the setter or fluent setter (with...) methods to initialize any additional object members.

Parameters:

masterInstanceType - The Amazon EC2 master node instance type.

slaveInstanceType - The Amazon EC2 slave node instance type.

instanceCount - The number of Amazon EC2 instances in the cluster. If the value is 1, the same instance serves as both the master and slave node. If the value is greater than 1, one instance is the master node and all others are slave nodes.

Method Detail

getMasterInstanceType

public String getMasterInstanceType()

The Amazon EC2 master node instance type.

Constraints:
Length: 1 - 256
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Returns:

The Amazon EC2 master node instance type.

setMasterInstanceType

public void setMasterInstanceType(String masterInstanceType)

The Amazon EC2 master node instance type.

Constraints:
Length: 1 - 256
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Parameters:

masterInstanceType - The Amazon EC2 master node instance type.

withMasterInstanceType

public JobFlowInstancesDetail withMasterInstanceType(String masterInstanceType)

The Amazon EC2 master node instance type.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Length: 1 - 256
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Parameters:

masterInstanceType - The Amazon EC2 master node instance type.

Returns:

A reference to this updated object so that method calls can be chained together.

getMasterPublicDnsName

public String getMasterPublicDnsName()

The DNS name of the master node.

Constraints:
Length: 0 - 10280
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Returns:

The DNS name of the master node.

setMasterPublicDnsName

public void setMasterPublicDnsName(String masterPublicDnsName)

The DNS name of the master node.

Constraints:
Length: 0 - 10280
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Parameters:

masterPublicDnsName - The DNS name of the master node.

withMasterPublicDnsName

public JobFlowInstancesDetail withMasterPublicDnsName(String masterPublicDnsName)

The DNS name of the master node.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Length: 0 - 10280
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Parameters:

masterPublicDnsName - The DNS name of the master node.

Returns:

A reference to this updated object so that method calls can be chained together.

getMasterInstanceId

public String getMasterInstanceId()

The Amazon EC2 instance identifier of the master node.

Constraints:
Length: 0 - 10280
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Returns:

The Amazon EC2 instance identifier of the master node.

setMasterInstanceId

public void setMasterInstanceId(String masterInstanceId)

The Amazon EC2 instance identifier of the master node.

Constraints:
Length: 0 - 10280
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Parameters:

masterInstanceId - The Amazon EC2 instance identifier of the master node.

withMasterInstanceId

public JobFlowInstancesDetail withMasterInstanceId(String masterInstanceId)

The Amazon EC2 instance identifier of the master node.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Length: 0 - 10280
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Parameters:

masterInstanceId - The Amazon EC2 instance identifier of the master node.

Returns:

A reference to this updated object so that method calls can be chained together.

getSlaveInstanceType

public String getSlaveInstanceType()

The Amazon EC2 slave node instance type.

Constraints:
Length: 1 - 256
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Returns:

The Amazon EC2 slave node instance type.

setSlaveInstanceType

public void setSlaveInstanceType(String slaveInstanceType)

The Amazon EC2 slave node instance type.

Constraints:
Length: 1 - 256
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Parameters:

slaveInstanceType - The Amazon EC2 slave node instance type.

withSlaveInstanceType

public JobFlowInstancesDetail withSlaveInstanceType(String slaveInstanceType)

The Amazon EC2 slave node instance type.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Length: 1 - 256
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Parameters:

slaveInstanceType - The Amazon EC2 slave node instance type.

Returns:

A reference to this updated object so that method calls can be chained together.

getInstanceCount

public Integer getInstanceCount()

The number of Amazon EC2 instances in the cluster. If the value is 1, the same instance serves as both the master and slave node. If the value is greater than 1, one instance is the master node and all others are slave nodes.

Returns:

The number of Amazon EC2 instances in the cluster. If the value is 1, the same instance serves as both the master and slave node. If the value is greater than 1, one instance is the master node and all others are slave nodes.

setInstanceCount

public void setInstanceCount(Integer instanceCount)

The number of Amazon EC2 instances in the cluster. If the value is 1, the same instance serves as both the master and slave node. If the value is greater than 1, one instance is the master node and all others are slave nodes.

Parameters:

instanceCount - The number of Amazon EC2 instances in the cluster. If the value is 1, the same instance serves as both the master and slave node. If the value is greater than 1, one instance is the master node and all others are slave nodes.

withInstanceCount

public JobFlowInstancesDetail withInstanceCount(Integer instanceCount)

The number of Amazon EC2 instances in the cluster. If the value is 1, the same instance serves as both the master and slave node. If the value is greater than 1, one instance is the master node and all others are slave nodes.

Returns a reference to this object so that method calls can be chained together.

Parameters:

instanceCount - The number of Amazon EC2 instances in the cluster. If the value is 1, the same instance serves as both the master and slave node. If the value is greater than 1, one instance is the master node and all others are slave nodes.

Returns:

A reference to this updated object so that method calls can be chained together.

getInstanceGroups

public List<InstanceGroupDetail> getInstanceGroups()

Details about the job flow's instance groups.

Returns:

Details about the job flow's instance groups.

setInstanceGroups

public void setInstanceGroups(Collection<InstanceGroupDetail> instanceGroups)

Details about the job flow's instance groups.

Parameters:

instanceGroups - Details about the job flow's instance groups.

withInstanceGroups

public JobFlowInstancesDetail withInstanceGroups(InstanceGroupDetail... instanceGroups)

Details about the job flow's instance groups.

NOTE: This method appends the values to the existing list (if any). Use setInstanceGroups(java.util.Collection) or withInstanceGroups(java.util.Collection) if you want to override the existing values.

Returns a reference to this object so that method calls can be chained together.

Parameters:

instanceGroups - Details about the job flow's instance groups.

Returns:

A reference to this updated object so that method calls can be chained together.

withInstanceGroups

public JobFlowInstancesDetail withInstanceGroups(Collection<InstanceGroupDetail> instanceGroups)

Details about the job flow's instance groups.

Returns a reference to this object so that method calls can be chained together.

Parameters:

instanceGroups - Details about the job flow's instance groups.

Returns:

A reference to this updated object so that method calls can be chained together.

getNormalizedInstanceHours

public Integer getNormalizedInstanceHours()

An approximation of the cost of the job flow, represented in m1.small/hours. This value is incremented once for every hour an m1.small runs. Larger instances are weighted more, so an Amazon EC2 instance that is roughly four times more expensive would result in the normalized instance hours being incremented by four. This result is only an approximation and does not reflect the actual billing rate.

Returns:

An approximation of the cost of the job flow, represented in m1.small/hours. This value is incremented once for every hour an m1.small runs. Larger instances are weighted more, so an Amazon EC2 instance that is roughly four times more expensive would result in the normalized instance hours being incremented by four. This result is only an approximation and does not reflect the actual billing rate.

setNormalizedInstanceHours

public void setNormalizedInstanceHours(Integer normalizedInstanceHours)

An approximation of the cost of the job flow, represented in m1.small/hours. This value is incremented once for every hour an m1.small runs. Larger instances are weighted more, so an Amazon EC2 instance that is roughly four times more expensive would result in the normalized instance hours being incremented by four. This result is only an approximation and does not reflect the actual billing rate.

Parameters:

normalizedInstanceHours - An approximation of the cost of the job flow, represented in m1.small/hours. This value is incremented once for every hour an m1.small runs. Larger instances are weighted more, so an Amazon EC2 instance that is roughly four times more expensive would result in the normalized instance hours being incremented by four. This result is only an approximation and does not reflect the actual billing rate.

withNormalizedInstanceHours

public JobFlowInstancesDetail withNormalizedInstanceHours(Integer normalizedInstanceHours)

An approximation of the cost of the job flow, represented in m1.small/hours. This value is incremented once for every hour an m1.small runs. Larger instances are weighted more, so an Amazon EC2 instance that is roughly four times more expensive would result in the normalized instance hours being incremented by four. This result is only an approximation and does not reflect the actual billing rate.

Returns a reference to this object so that method calls can be chained together.

Parameters:

normalizedInstanceHours - An approximation of the cost of the job flow, represented in m1.small/hours. This value is incremented once for every hour an m1.small runs. Larger instances are weighted more, so an Amazon EC2 instance that is roughly four times more expensive would result in the normalized instance hours being incremented by four. This result is only an approximation and does not reflect the actual billing rate.

Returns:

A reference to this updated object so that method calls can be chained together.

getEc2KeyName

public String getEc2KeyName()

The name of an Amazon EC2 key pair that can be used to ssh to the master node of job flow.

Constraints:
Length: 0 - 256
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Returns:

The name of an Amazon EC2 key pair that can be used to ssh to the master node of job flow.

setEc2KeyName

public void setEc2KeyName(String ec2KeyName)

The name of an Amazon EC2 key pair that can be used to ssh to the master node of job flow.

Constraints:
Length: 0 - 256
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Parameters:

ec2KeyName - The name of an Amazon EC2 key pair that can be used to ssh to the master node of job flow.

withEc2KeyName

public JobFlowInstancesDetail withEc2KeyName(String ec2KeyName)

The name of an Amazon EC2 key pair that can be used to ssh to the master node of job flow.

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]*

Parameters:

ec2KeyName - The name of an Amazon EC2 key pair that can be used to ssh to the master node of job flow.

Returns:

A reference to this updated object so that method calls can be chained together.

getEc2SubnetId

public String getEc2SubnetId()

For job flows launched within Amazon Virtual Private Cloud, this value specifies the identifier of the subnet where the job flow was launched.

Constraints:
Length: 0 - 256
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Returns:

For job flows launched within Amazon Virtual Private Cloud, this value specifies the identifier of the subnet where the job flow was launched.

setEc2SubnetId

public void setEc2SubnetId(String ec2SubnetId)

For job flows launched within Amazon Virtual Private Cloud, this value specifies the identifier of the subnet where the job flow was launched.

Constraints:
Length: 0 - 256
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Parameters:

ec2SubnetId - For job flows launched within Amazon Virtual Private Cloud, this value specifies the identifier of the subnet where the job flow was launched.

withEc2SubnetId

public JobFlowInstancesDetail withEc2SubnetId(String ec2SubnetId)

For job flows launched within Amazon Virtual Private Cloud, this value specifies the identifier of the subnet where the job flow was launched.

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]*

Parameters:

ec2SubnetId - For job flows launched within Amazon Virtual Private Cloud, this value specifies the identifier of the subnet where the job flow was launched.

Returns:

A reference to this updated object so that method calls can be chained together.

getPlacement

public PlacementType getPlacement()

The Amazon EC2 Availability Zone for the job flow.

Returns:

The Amazon EC2 Availability Zone for the job flow.

setPlacement

public void setPlacement(PlacementType placement)

The Amazon EC2 Availability Zone for the job flow.

Parameters:

placement - The Amazon EC2 Availability Zone for the job flow.

withPlacement

public JobFlowInstancesDetail withPlacement(PlacementType placement)

The Amazon EC2 Availability Zone for the job flow.

Returns a reference to this object so that method calls can be chained together.

Parameters:

placement - The Amazon EC2 Availability Zone for the job flow.

Returns:

A reference to this updated object so that method calls can be chained together.

isKeepJobFlowAliveWhenNoSteps

public Boolean isKeepJobFlowAliveWhenNoSteps()

Specifies whether the job flow should terminate after completing all steps.

Returns:

Specifies whether the job flow should terminate after completing all steps.

setKeepJobFlowAliveWhenNoSteps

public void setKeepJobFlowAliveWhenNoSteps(Boolean keepJobFlowAliveWhenNoSteps)

Specifies whether the job flow should terminate after completing all steps.

Parameters:

keepJobFlowAliveWhenNoSteps - Specifies whether the job flow should terminate after completing all steps.

withKeepJobFlowAliveWhenNoSteps

public JobFlowInstancesDetail withKeepJobFlowAliveWhenNoSteps(Boolean keepJobFlowAliveWhenNoSteps)

Specifies whether the job flow should terminate after completing all steps.

Returns a reference to this object so that method calls can be chained together.

Parameters:

keepJobFlowAliveWhenNoSteps - Specifies whether the job flow should terminate after completing all steps.

Returns:

A reference to this updated object so that method calls can be chained together.

getKeepJobFlowAliveWhenNoSteps

public Boolean getKeepJobFlowAliveWhenNoSteps()

Specifies whether the job flow should terminate after completing all steps.

Returns:

Specifies whether the job flow should terminate after completing all steps.

isTerminationProtected

public Boolean isTerminationProtected()

Specifies whether the Amazon EC2 instances in the cluster are protected from termination by API calls, user intervention, or in the event of a job flow error.

Returns:

Specifies whether the Amazon EC2 instances in the cluster are protected from termination by API calls, user intervention, or in the event of a job flow error.

setTerminationProtected

public void setTerminationProtected(Boolean terminationProtected)

Specifies whether the Amazon EC2 instances in the cluster are protected from termination by API calls, user intervention, or in the event of a job flow error.

Parameters:

terminationProtected - Specifies whether the Amazon EC2 instances in the cluster are protected from termination by API calls, user intervention, or in the event of a job flow error.

withTerminationProtected

public JobFlowInstancesDetail withTerminationProtected(Boolean terminationProtected)

Specifies whether the Amazon EC2 instances in the cluster are protected from termination by API calls, user intervention, or in the event of a job flow error.

Returns a reference to this object so that method calls can be chained together.

Parameters:

terminationProtected - Specifies whether the Amazon EC2 instances in the cluster are protected from termination by API calls, user intervention, or in the event of a job flow error.

Returns:

A reference to this updated object so that method calls can be chained together.

getTerminationProtected

public Boolean getTerminationProtected()

Specifies whether the Amazon EC2 instances in the cluster are protected from termination by API calls, user intervention, or in the event of a job flow error.

Returns:

Specifies whether the Amazon EC2 instances in the cluster are protected from termination by API calls, user intervention, or in the event of a job flow error.

getHadoopVersion

public String getHadoopVersion()

The Hadoop version for the job flow.

Constraints:
Length: 0 - 256
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Returns:

The Hadoop version for the job flow.

setHadoopVersion

public void setHadoopVersion(String hadoopVersion)

The Hadoop version for the job flow.

Constraints:
Length: 0 - 256
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Parameters:

hadoopVersion - The Hadoop version for the job flow.

withHadoopVersion

public JobFlowInstancesDetail withHadoopVersion(String hadoopVersion)

The Hadoop version for the job flow.

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]*

Parameters:

hadoopVersion - The Hadoop version for the job flow.

Returns:

A reference to this updated object so that method calls can be chained together.

toString

public String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

clone

public JobFlowInstancesDetail clone()

Overrides:

clone in class Object