com.amazonaws.services.elasticmapreduce.model

Class InstanceGroup

java.lang.Object

com.amazonaws.services.elasticmapreduce.model.InstanceGroup

All Implemented Interfaces:

Serializable, Cloneable

public class InstanceGroup
extends Object
implements Serializable, Cloneable

This entity represents an instance group, which is a group of instances that have common purpose. For example, CORE instance group is used for HDFS.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
InstanceGroup()

Method Summary

Methods

Modifier and Type	Method and Description
InstanceGroup	clone()
boolean	equals(Object obj)
String	getBidPrice() The bid price for each EC2 instance in the instance group when launching nodes as Spot Instances, expressed in USD.
List<Configuration>	getConfigurations()
String	getId() The identifier of the instance group.
String	getInstanceGroupType() The type of the instance group.
String	getInstanceType() The EC2 instance type for all instances in the instance group.
String	getMarket() The marketplace to provision instances for this group.
String	getName() The name of the instance group.
Integer	getRequestedInstanceCount() The target number of instances for the instance group.
Integer	getRunningInstanceCount() The number of instances currently running in this instance group.
InstanceGroupStatus	getStatus() The current status of the instance group.
int	hashCode()
void	setBidPrice(String bidPrice) The bid price for each EC2 instance in the instance group when launching nodes as Spot Instances, expressed in USD.
void	setConfigurations(Collection<Configuration> configurations)
void	setId(String id) The identifier of the instance group.
void	setInstanceGroupType(InstanceGroupType instanceGroupType) The type of the instance group.
void	setInstanceGroupType(String instanceGroupType) The type of the instance group.
void	setInstanceType(String instanceType) The EC2 instance type for all instances in the instance group.
void	setMarket(MarketType market) The marketplace to provision instances for this group.
void	setMarket(String market) The marketplace to provision instances for this group.
void	setName(String name) The name of the instance group.
void	setRequestedInstanceCount(Integer requestedInstanceCount) The target number of instances for the instance group.
void	setRunningInstanceCount(Integer runningInstanceCount) The number of instances currently running in this instance group.
void	setStatus(InstanceGroupStatus status) The current status of the instance group.
String	toString() Returns a string representation of this object; useful for testing and debugging.
InstanceGroup	withBidPrice(String bidPrice) The bid price for each EC2 instance in the instance group when launching nodes as Spot Instances, expressed in USD.
InstanceGroup	withConfigurations(Collection<Configuration> configurations)
InstanceGroup	withConfigurations(Configuration... configurations)
InstanceGroup	withId(String id) The identifier of the instance group.
InstanceGroup	withInstanceGroupType(InstanceGroupType instanceGroupType) The type of the instance group.
InstanceGroup	withInstanceGroupType(String instanceGroupType) The type of the instance group.
InstanceGroup	withInstanceType(String instanceType) The EC2 instance type for all instances in the instance group.
InstanceGroup	withMarket(MarketType market) The marketplace to provision instances for this group.
InstanceGroup	withMarket(String market) The marketplace to provision instances for this group.
InstanceGroup	withName(String name) The name of the instance group.
InstanceGroup	withRequestedInstanceCount(Integer requestedInstanceCount) The target number of instances for the instance group.
InstanceGroup	withRunningInstanceCount(Integer runningInstanceCount) The number of instances currently running in this instance group.
InstanceGroup	withStatus(InstanceGroupStatus status) The current status of the instance group.

Methods inherited from class java.lang.Object

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

Constructor Detail

InstanceGroup

public InstanceGroup()

Method Detail

getId

public String getId()

The identifier of the instance group.

Returns:

The identifier of the instance group.

setId

public void setId(String id)

The identifier of the instance group.

Parameters:

id - The identifier of the instance group.

withId

public InstanceGroup withId(String id)

The identifier of the instance group.

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

Parameters:

id - The identifier of the instance group.

Returns:

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

getName

public String getName()

The name of the instance group.

Returns:

The name of the instance group.

setName

public void setName(String name)

The name of the instance group.

Parameters:

name - The name of the instance group.

withName

public InstanceGroup withName(String name)

The name of the instance group.

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

Parameters:

name - The name of the instance group.

Returns:

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

getMarket

public String getMarket()

The marketplace to provision instances for this group. Valid values are ON_DEMAND or SPOT.

Constraints:
Allowed Values: ON_DEMAND, SPOT

Returns:

The marketplace to provision instances for this group. Valid values are ON_DEMAND or SPOT.

See Also:

MarketType

setMarket

public void setMarket(String market)

The marketplace to provision instances for this group. Valid values are ON_DEMAND or SPOT.

Constraints:
Allowed Values: ON_DEMAND, SPOT

Parameters:

market - The marketplace to provision instances for this group. Valid values are ON_DEMAND or SPOT.

See Also:

MarketType

withMarket

public InstanceGroup withMarket(String market)

The marketplace to provision instances for this group. Valid values are ON_DEMAND or SPOT.

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

Constraints:
Allowed Values: ON_DEMAND, SPOT

Parameters:

market - The marketplace to provision instances for this group. Valid values are ON_DEMAND or SPOT.

Returns:

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

See Also:

MarketType

setMarket

public void setMarket(MarketType market)

The marketplace to provision instances for this group. Valid values are ON_DEMAND or SPOT.

Constraints:
Allowed Values: ON_DEMAND, SPOT

Parameters:

market - The marketplace to provision instances for this group. Valid values are ON_DEMAND or SPOT.

See Also:

MarketType

withMarket

public InstanceGroup withMarket(MarketType market)

The marketplace to provision instances for this group. Valid values are ON_DEMAND or SPOT.

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

Constraints:
Allowed Values: ON_DEMAND, SPOT

Parameters:

market - The marketplace to provision instances for this group. Valid values are ON_DEMAND or SPOT.

Returns:

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

See Also:

MarketType

getInstanceGroupType

public String getInstanceGroupType()

The type of the instance group. Valid values are MASTER, CORE or TASK.

Constraints:
Allowed Values: MASTER, CORE, TASK

Returns:

The type of the instance group. Valid values are MASTER, CORE or TASK.

See Also:

InstanceGroupType

setInstanceGroupType

public void setInstanceGroupType(String instanceGroupType)

The type of the instance group. Valid values are MASTER, CORE or TASK.

Constraints:
Allowed Values: MASTER, CORE, TASK

Parameters:

instanceGroupType - The type of the instance group. Valid values are MASTER, CORE or TASK.

See Also:

InstanceGroupType

withInstanceGroupType

public InstanceGroup withInstanceGroupType(String instanceGroupType)

The type of the instance group. Valid values are MASTER, CORE or TASK.

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

Constraints:
Allowed Values: MASTER, CORE, TASK

Parameters:

instanceGroupType - The type of the instance group. Valid values are MASTER, CORE or TASK.

Returns:

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

See Also:

InstanceGroupType

setInstanceGroupType

public void setInstanceGroupType(InstanceGroupType instanceGroupType)

The type of the instance group. Valid values are MASTER, CORE or TASK.

Constraints:
Allowed Values: MASTER, CORE, TASK

Parameters:

instanceGroupType - The type of the instance group. Valid values are MASTER, CORE or TASK.

See Also:

InstanceGroupType

withInstanceGroupType

public InstanceGroup withInstanceGroupType(InstanceGroupType instanceGroupType)

The type of the instance group. Valid values are MASTER, CORE or TASK.

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

Constraints:
Allowed Values: MASTER, CORE, TASK

Parameters:

instanceGroupType - The type of the instance group. Valid values are MASTER, CORE or TASK.

Returns:

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

See Also:

InstanceGroupType

getBidPrice

public String getBidPrice()

The bid price for each EC2 instance in the instance group when launching nodes as Spot Instances, expressed in USD.

Returns:

The bid price for each EC2 instance in the instance group when launching nodes as Spot Instances, expressed in USD.

setBidPrice

public void setBidPrice(String bidPrice)

The bid price for each EC2 instance in the instance group when launching nodes as Spot Instances, expressed in USD.

Parameters:

bidPrice - The bid price for each EC2 instance in the instance group when launching nodes as Spot Instances, expressed in USD.

withBidPrice

public InstanceGroup withBidPrice(String bidPrice)

The bid price for each EC2 instance in the instance group when launching nodes as Spot Instances, expressed in USD.

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

Parameters:

bidPrice - The bid price for each EC2 instance in the instance group when launching nodes as Spot Instances, expressed in USD.

Returns:

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

getInstanceType

public String getInstanceType()

The EC2 instance type for all instances in the instance group.

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

Returns:

The EC2 instance type for all instances in the instance group.

setInstanceType

public void setInstanceType(String instanceType)

The EC2 instance type for all instances in the instance group.

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

Parameters:

instanceType - The EC2 instance type for all instances in the instance group.

withInstanceType

public InstanceGroup withInstanceType(String instanceType)

The EC2 instance type for all instances in the instance group.

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:

instanceType - The EC2 instance type for all instances in the instance group.

Returns:

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

getRequestedInstanceCount

public Integer getRequestedInstanceCount()

The target number of instances for the instance group.

Returns:

The target number of instances for the instance group.

setRequestedInstanceCount

public void setRequestedInstanceCount(Integer requestedInstanceCount)

The target number of instances for the instance group.

Parameters:

requestedInstanceCount - The target number of instances for the instance group.

withRequestedInstanceCount

public InstanceGroup withRequestedInstanceCount(Integer requestedInstanceCount)

The target number of instances for the instance group.

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

Parameters:

requestedInstanceCount - The target number of instances for the instance group.

Returns:

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

getRunningInstanceCount

public Integer getRunningInstanceCount()

The number of instances currently running in this instance group.

Returns:

The number of instances currently running in this instance group.

setRunningInstanceCount

public void setRunningInstanceCount(Integer runningInstanceCount)

The number of instances currently running in this instance group.

Parameters:

runningInstanceCount - The number of instances currently running in this instance group.

withRunningInstanceCount

public InstanceGroup withRunningInstanceCount(Integer runningInstanceCount)

The number of instances currently running in this instance group.

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

Parameters:

runningInstanceCount - The number of instances currently running in this instance group.

Returns:

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

getStatus

public InstanceGroupStatus getStatus()

The current status of the instance group.

Returns:

The current status of the instance group.

setStatus

public void setStatus(InstanceGroupStatus status)

The current status of the instance group.

Parameters:

status - The current status of the instance group.

withStatus

public InstanceGroup withStatus(InstanceGroupStatus status)

The current status of the instance group.

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

Parameters:

status - The current status of the instance group.

Returns:

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

getConfigurations

public List<Configuration> getConfigurations()

Amazon EMR releases 4.x or later.

The list of configurations supplied for an EMR cluster instance group. You can specify a separate configuration for each instance group (master, core, and task).

Returns:

Amazon EMR releases 4.x or later.

The list of configurations supplied for an EMR cluster instance group. You can specify a separate configuration for each instance group (master, core, and task).

setConfigurations

public void setConfigurations(Collection<Configuration> configurations)

Amazon EMR releases 4.x or later.

The list of configurations supplied for an EMR cluster instance group. You can specify a separate configuration for each instance group (master, core, and task).

Parameters:

configurations -

Amazon EMR releases 4.x or later.

The list of configurations supplied for an EMR cluster instance group. You can specify a separate configuration for each instance group (master, core, and task).

withConfigurations

public InstanceGroup withConfigurations(Configuration... configurations)

Amazon EMR releases 4.x or later.

The list of configurations supplied for an EMR cluster instance group. You can specify a separate configuration for each instance group (master, core, and task).

NOTE: This method appends the values to the existing list (if any). Use setConfigurations(java.util.Collection) or withConfigurations(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:

configurations -

Amazon EMR releases 4.x or later.

The list of configurations supplied for an EMR cluster instance group. You can specify a separate configuration for each instance group (master, core, and task).

Returns:

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

withConfigurations

public InstanceGroup withConfigurations(Collection<Configuration> configurations)

Amazon EMR releases 4.x or later.

The list of configurations supplied for an EMR cluster instance group. You can specify a separate configuration for each instance group (master, core, and task).

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

Parameters:

configurations -

Amazon EMR releases 4.x or later.

The list of configurations supplied for an EMR cluster instance group. You can specify a separate configuration for each instance group (master, core, and task).

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 InstanceGroup clone()

Overrides:

clone in class Object