com.amazonaws.services.elasticmapreduce.model

Class JobFlowDetail

java.lang.Object

com.amazonaws.services.elasticmapreduce.model.JobFlowDetail

All Implemented Interfaces:

Serializable, Cloneable

public class JobFlowDetail
extends Object
implements Serializable, Cloneable

A description of a job flow.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
JobFlowDetail() Default constructor for a new JobFlowDetail object.
JobFlowDetail(String jobFlowId, String name, JobFlowExecutionStatusDetail executionStatusDetail, JobFlowInstancesDetail instances) Constructs a new JobFlowDetail object.

Method Summary

Methods

Modifier and Type	Method and Description
JobFlowDetail	clone()
boolean	equals(Object obj)
String	getAmiVersion() The version of the AMI used to initialize Amazon EC2 instances in the job flow.
List<BootstrapActionDetail>	getBootstrapActions() A list of the bootstrap actions run by the job flow.
JobFlowExecutionStatusDetail	getExecutionStatusDetail() Describes the execution status of the job flow.
JobFlowInstancesDetail	getInstances() Describes the Amazon EC2 instances of the job flow.
String	getJobFlowId() The job flow identifier.
String	getJobFlowRole() The IAM role that was specified when the job flow was launched.
String	getLogUri() The location in Amazon S3 where log files for the job are stored.
String	getName() The name of the job flow.
String	getServiceRole() The IAM role that will be assumed by the Amazon EMR service to access AWS resources on your behalf.
List<StepDetail>	getSteps() A list of steps run by the job flow.
List<String>	getSupportedProducts() A list of strings set by third party software when the job flow is launched.
Boolean	getVisibleToAllUsers() Specifies whether the job flow is visible to all IAM users of the AWS account associated with the job flow.
int	hashCode()
Boolean	isVisibleToAllUsers() Specifies whether the job flow is visible to all IAM users of the AWS account associated with the job flow.
void	setAmiVersion(String amiVersion) The version of the AMI used to initialize Amazon EC2 instances in the job flow.
void	setBootstrapActions(Collection<BootstrapActionDetail> bootstrapActions) A list of the bootstrap actions run by the job flow.
void	setExecutionStatusDetail(JobFlowExecutionStatusDetail executionStatusDetail) Describes the execution status of the job flow.
void	setInstances(JobFlowInstancesDetail instances) Describes the Amazon EC2 instances of the job flow.
void	setJobFlowId(String jobFlowId) The job flow identifier.
void	setJobFlowRole(String jobFlowRole) The IAM role that was specified when the job flow was launched.
void	setLogUri(String logUri) The location in Amazon S3 where log files for the job are stored.
void	setName(String name) The name of the job flow.
void	setServiceRole(String serviceRole) The IAM role that will be assumed by the Amazon EMR service to access AWS resources on your behalf.
void	setSteps(Collection<StepDetail> steps) A list of steps run by the job flow.
void	setSupportedProducts(Collection<String> supportedProducts) A list of strings set by third party software when the job flow is launched.
void	setVisibleToAllUsers(Boolean visibleToAllUsers) Specifies whether the job flow is visible to all IAM users of the AWS account associated with the job flow.
String	toString() Returns a string representation of this object; useful for testing and debugging.
JobFlowDetail	withAmiVersion(String amiVersion) The version of the AMI used to initialize Amazon EC2 instances in the job flow.
JobFlowDetail	withBootstrapActions(BootstrapActionDetail... bootstrapActions) A list of the bootstrap actions run by the job flow.
JobFlowDetail	withBootstrapActions(Collection<BootstrapActionDetail> bootstrapActions) A list of the bootstrap actions run by the job flow.
JobFlowDetail	withExecutionStatusDetail(JobFlowExecutionStatusDetail executionStatusDetail) Describes the execution status of the job flow.
JobFlowDetail	withInstances(JobFlowInstancesDetail instances) Describes the Amazon EC2 instances of the job flow.
JobFlowDetail	withJobFlowId(String jobFlowId) The job flow identifier.
JobFlowDetail	withJobFlowRole(String jobFlowRole) The IAM role that was specified when the job flow was launched.
JobFlowDetail	withLogUri(String logUri) The location in Amazon S3 where log files for the job are stored.
JobFlowDetail	withName(String name) The name of the job flow.
JobFlowDetail	withServiceRole(String serviceRole) The IAM role that will be assumed by the Amazon EMR service to access AWS resources on your behalf.
JobFlowDetail	withSteps(Collection<StepDetail> steps) A list of steps run by the job flow.
JobFlowDetail	withSteps(StepDetail... steps) A list of steps run by the job flow.
JobFlowDetail	withSupportedProducts(Collection<String> supportedProducts) A list of strings set by third party software when the job flow is launched.
JobFlowDetail	withSupportedProducts(String... supportedProducts) A list of strings set by third party software when the job flow is launched.
JobFlowDetail	withVisibleToAllUsers(Boolean visibleToAllUsers) Specifies whether the job flow is visible to all IAM users of the AWS account associated with the job flow.

Methods inherited from class java.lang.Object

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

Constructor Detail

JobFlowDetail

public JobFlowDetail()

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

JobFlowDetail

public JobFlowDetail(String jobFlowId,
             String name,
             JobFlowExecutionStatusDetail executionStatusDetail,
             JobFlowInstancesDetail instances)

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

Parameters:

jobFlowId - The job flow identifier.

name - The name of the job flow.

executionStatusDetail - Describes the execution status of the job flow.

instances - Describes the Amazon EC2 instances of the job flow.

Method Detail

getJobFlowId

public String getJobFlowId()

The job flow identifier.

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

Returns:

The job flow identifier.

setJobFlowId

public void setJobFlowId(String jobFlowId)

The job flow identifier.

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

Parameters:

jobFlowId - The job flow identifier.

withJobFlowId

public JobFlowDetail withJobFlowId(String jobFlowId)

The job flow identifier.

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:

jobFlowId - The job flow identifier.

Returns:

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

getName

public String getName()

The name of the job flow.

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

Returns:

The name of the job flow.

setName

public void setName(String name)

The name of the job flow.

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

Parameters:

name - The name of the job flow.

withName

public JobFlowDetail withName(String name)

The name of 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:

name - The name of the job flow.

Returns:

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

getLogUri

public String getLogUri()

The location in Amazon S3 where log files for the job are stored.

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

Returns:

The location in Amazon S3 where log files for the job are stored.

setLogUri

public void setLogUri(String logUri)

The location in Amazon S3 where log files for the job are stored.

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

Parameters:

logUri - The location in Amazon S3 where log files for the job are stored.

withLogUri

public JobFlowDetail withLogUri(String logUri)

The location in Amazon S3 where log files for the job are stored.

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:

logUri - The location in Amazon S3 where log files for the job are stored.

Returns:

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

getAmiVersion

public String getAmiVersion()

The version of the AMI used to initialize Amazon EC2 instances in the job flow. For a list of AMI versions currently supported by Amazon ElasticMapReduce, go to AMI Versions Supported in Elastic MapReduce in the Amazon Elastic MapReduce Developer Guide.

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

Returns:

The version of the AMI used to initialize Amazon EC2 instances in the job flow. For a list of AMI versions currently supported by Amazon ElasticMapReduce, go to AMI Versions Supported in Elastic MapReduce in the Amazon Elastic MapReduce Developer Guide.

setAmiVersion

public void setAmiVersion(String amiVersion)

The version of the AMI used to initialize Amazon EC2 instances in the job flow. For a list of AMI versions currently supported by Amazon ElasticMapReduce, go to AMI Versions Supported in Elastic MapReduce in the Amazon Elastic MapReduce Developer Guide.

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

Parameters:

amiVersion - The version of the AMI used to initialize Amazon EC2 instances in the job flow. For a list of AMI versions currently supported by Amazon ElasticMapReduce, go to AMI Versions Supported in Elastic MapReduce in the Amazon Elastic MapReduce Developer Guide.

withAmiVersion

public JobFlowDetail withAmiVersion(String amiVersion)

The version of the AMI used to initialize Amazon EC2 instances in the job flow. For a list of AMI versions currently supported by Amazon ElasticMapReduce, go to AMI Versions Supported in Elastic MapReduce in the Amazon Elastic MapReduce Developer Guide.

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:

amiVersion - The version of the AMI used to initialize Amazon EC2 instances in the job flow. For a list of AMI versions currently supported by Amazon ElasticMapReduce, go to AMI Versions Supported in Elastic MapReduce in the Amazon Elastic MapReduce Developer Guide.

Returns:

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

getExecutionStatusDetail

public JobFlowExecutionStatusDetail getExecutionStatusDetail()

Describes the execution status of the job flow.

Returns:

Describes the execution status of the job flow.

setExecutionStatusDetail

public void setExecutionStatusDetail(JobFlowExecutionStatusDetail executionStatusDetail)

Describes the execution status of the job flow.

Parameters:

executionStatusDetail - Describes the execution status of the job flow.

withExecutionStatusDetail

public JobFlowDetail withExecutionStatusDetail(JobFlowExecutionStatusDetail executionStatusDetail)

Describes the execution status of the job flow.

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

Parameters:

executionStatusDetail - Describes the execution status of the job flow.

Returns:

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

getInstances

public JobFlowInstancesDetail getInstances()

Describes the Amazon EC2 instances of the job flow.

Returns:

Describes the Amazon EC2 instances of the job flow.

setInstances

public void setInstances(JobFlowInstancesDetail instances)

Describes the Amazon EC2 instances of the job flow.

Parameters:

instances - Describes the Amazon EC2 instances of the job flow.

withInstances

public JobFlowDetail withInstances(JobFlowInstancesDetail instances)

Describes the Amazon EC2 instances of the job flow.

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

Parameters:

instances - Describes the Amazon EC2 instances of the job flow.

Returns:

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

getSteps

public List<StepDetail> getSteps()

A list of steps run by the job flow.

Returns:

A list of steps run by the job flow.

setSteps

public void setSteps(Collection<StepDetail> steps)

A list of steps run by the job flow.

Parameters:

steps - A list of steps run by the job flow.

withSteps

public JobFlowDetail withSteps(StepDetail... steps)

A list of steps run by the job flow.

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

steps - A list of steps run by the job flow.

Returns:

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

withSteps

public JobFlowDetail withSteps(Collection<StepDetail> steps)

A list of steps run by the job flow.

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

Parameters:

steps - A list of steps run by the job flow.

Returns:

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

getBootstrapActions

public List<BootstrapActionDetail> getBootstrapActions()

A list of the bootstrap actions run by the job flow.

Returns:

A list of the bootstrap actions run by the job flow.

setBootstrapActions

public void setBootstrapActions(Collection<BootstrapActionDetail> bootstrapActions)

A list of the bootstrap actions run by the job flow.

Parameters:

bootstrapActions - A list of the bootstrap actions run by the job flow.

withBootstrapActions

public JobFlowDetail withBootstrapActions(BootstrapActionDetail... bootstrapActions)

A list of the bootstrap actions run by the job flow.

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

bootstrapActions - A list of the bootstrap actions run by the job flow.

Returns:

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

withBootstrapActions

public JobFlowDetail withBootstrapActions(Collection<BootstrapActionDetail> bootstrapActions)

A list of the bootstrap actions run by the job flow.

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

Parameters:

bootstrapActions - A list of the bootstrap actions run by the job flow.

Returns:

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

getSupportedProducts

public List<String> getSupportedProducts()

A list of strings set by third party software when the job flow is launched. If you are not using third party software to manage the job flow this value is empty.

Returns:

A list of strings set by third party software when the job flow is launched. If you are not using third party software to manage the job flow this value is empty.

setSupportedProducts

public void setSupportedProducts(Collection<String> supportedProducts)

A list of strings set by third party software when the job flow is launched. If you are not using third party software to manage the job flow this value is empty.

Parameters:

supportedProducts - A list of strings set by third party software when the job flow is launched. If you are not using third party software to manage the job flow this value is empty.

withSupportedProducts

public JobFlowDetail withSupportedProducts(String... supportedProducts)

A list of strings set by third party software when the job flow is launched. If you are not using third party software to manage the job flow this value is empty.

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

supportedProducts - A list of strings set by third party software when the job flow is launched. If you are not using third party software to manage the job flow this value is empty.

Returns:

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

withSupportedProducts

public JobFlowDetail withSupportedProducts(Collection<String> supportedProducts)

A list of strings set by third party software when the job flow is launched. If you are not using third party software to manage the job flow this value is empty.

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

Parameters:

supportedProducts - A list of strings set by third party software when the job flow is launched. If you are not using third party software to manage the job flow this value is empty.

Returns:

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

isVisibleToAllUsers

public Boolean isVisibleToAllUsers()

Specifies whether the job flow is visible to all IAM users of the AWS account associated with the job flow. If this value is set to true, all IAM users of that AWS account can view and (if they have the proper policy permissions set) manage the job flow. If it is set to false, only the IAM user that created the job flow can view and manage it. This value can be changed using the SetVisibleToAllUsers action.

Returns:

Specifies whether the job flow is visible to all IAM users of the AWS account associated with the job flow. If this value is set to true, all IAM users of that AWS account can view and (if they have the proper policy permissions set) manage the job flow. If it is set to false, only the IAM user that created the job flow can view and manage it. This value can be changed using the SetVisibleToAllUsers action.

setVisibleToAllUsers

public void setVisibleToAllUsers(Boolean visibleToAllUsers)

Specifies whether the job flow is visible to all IAM users of the AWS account associated with the job flow. If this value is set to true, all IAM users of that AWS account can view and (if they have the proper policy permissions set) manage the job flow. If it is set to false, only the IAM user that created the job flow can view and manage it. This value can be changed using the SetVisibleToAllUsers action.

Parameters:

visibleToAllUsers - Specifies whether the job flow is visible to all IAM users of the AWS account associated with the job flow. If this value is set to true, all IAM users of that AWS account can view and (if they have the proper policy permissions set) manage the job flow. If it is set to false, only the IAM user that created the job flow can view and manage it. This value can be changed using the SetVisibleToAllUsers action.

withVisibleToAllUsers

public JobFlowDetail withVisibleToAllUsers(Boolean visibleToAllUsers)

Specifies whether the job flow is visible to all IAM users of the AWS account associated with the job flow. If this value is set to true, all IAM users of that AWS account can view and (if they have the proper policy permissions set) manage the job flow. If it is set to false, only the IAM user that created the job flow can view and manage it. This value can be changed using the SetVisibleToAllUsers action.

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

Parameters:

visibleToAllUsers - Specifies whether the job flow is visible to all IAM users of the AWS account associated with the job flow. If this value is set to true, all IAM users of that AWS account can view and (if they have the proper policy permissions set) manage the job flow. If it is set to false, only the IAM user that created the job flow can view and manage it. This value can be changed using the SetVisibleToAllUsers action.

Returns:

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

getVisibleToAllUsers

public Boolean getVisibleToAllUsers()

Specifies whether the job flow is visible to all IAM users of the AWS account associated with the job flow. If this value is set to true, all IAM users of that AWS account can view and (if they have the proper policy permissions set) manage the job flow. If it is set to false, only the IAM user that created the job flow can view and manage it. This value can be changed using the SetVisibleToAllUsers action.

Returns:

Specifies whether the job flow is visible to all IAM users of the AWS account associated with the job flow. If this value is set to true, all IAM users of that AWS account can view and (if they have the proper policy permissions set) manage the job flow. If it is set to false, only the IAM user that created the job flow can view and manage it. This value can be changed using the SetVisibleToAllUsers action.

getJobFlowRole

public String getJobFlowRole()

The IAM role that was specified when the job flow was launched. The EC2 instances of the job flow assume this role.

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

Returns:

The IAM role that was specified when the job flow was launched. The EC2 instances of the job flow assume this role.

setJobFlowRole

public void setJobFlowRole(String jobFlowRole)

The IAM role that was specified when the job flow was launched. The EC2 instances of the job flow assume this role.

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

Parameters:

jobFlowRole - The IAM role that was specified when the job flow was launched. The EC2 instances of the job flow assume this role.

withJobFlowRole

public JobFlowDetail withJobFlowRole(String jobFlowRole)

The IAM role that was specified when the job flow was launched. The EC2 instances of the job flow assume this role.

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:

jobFlowRole - The IAM role that was specified when the job flow was launched. The EC2 instances of the job flow assume this role.

Returns:

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

getServiceRole

public String getServiceRole()

The IAM role that will be assumed by the Amazon EMR service to access AWS resources on your behalf.

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

Returns:

The IAM role that will be assumed by the Amazon EMR service to access AWS resources on your behalf.

setServiceRole

public void setServiceRole(String serviceRole)

The IAM role that will be assumed by the Amazon EMR service to access AWS resources on your behalf.

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

Parameters:

serviceRole - The IAM role that will be assumed by the Amazon EMR service to access AWS resources on your behalf.

withServiceRole

public JobFlowDetail withServiceRole(String serviceRole)

The IAM role that will be assumed by the Amazon EMR service to access AWS resources on your behalf.

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:

serviceRole - The IAM role that will be assumed by the Amazon EMR service to access AWS resources on your behalf.

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

Overrides:

clone in class Object