ComputeEnvironmentDetail (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.batch.model.ComputeEnvironmentDetail

All Implemented Interfaces:: StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class ComputeEnvironmentDetail
extends Object
implements Serializable, Cloneable, StructuredPojo

An object representing an AWS Batch compute environment.

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

ComputeEnvironmentDetail()

Constructors
Constructor and Description
`ComputeEnvironmentDetail()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ComputeEnvironmentDetail`	`addTagsEntry(String key, String value)` Add a single Tags entry
`ComputeEnvironmentDetail`	`clearTagsEntries()` Removes all the entries added into Tags.
`ComputeEnvironmentDetail`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getComputeEnvironmentArn()` The Amazon Resource Name (ARN) of the compute environment.
`String`	`getComputeEnvironmentName()` The name of the compute environment.
`ComputeResource`	`getComputeResources()` The compute resources defined for the compute environment.
`String`	`getEcsClusterArn()` The Amazon Resource Name (ARN) of the underlying Amazon ECS cluster used by the compute environment.
`String`	`getServiceRole()` The service role associated with the compute environment that allows AWS Batch to make calls to AWS API operations on your behalf.
`String`	`getState()` The state of the compute environment.
`String`	`getStatus()` The current status of the compute environment (for example, `CREATING` or `VALID`).
`String`	`getStatusReason()` A short, human-readable string to provide additional details about the current status of the compute environment.
`Map<String,String>`	`getTags()` The tags applied to the compute environment.
`String`	`getType()` The type of the compute environment: `MANAGED` or `UNMANAGED`.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setComputeEnvironmentArn(String computeEnvironmentArn)` The Amazon Resource Name (ARN) of the compute environment.
`void`	`setComputeEnvironmentName(String computeEnvironmentName)` The name of the compute environment.
`void`	`setComputeResources(ComputeResource computeResources)` The compute resources defined for the compute environment.
`void`	`setEcsClusterArn(String ecsClusterArn)` The Amazon Resource Name (ARN) of the underlying Amazon ECS cluster used by the compute environment.
`void`	`setServiceRole(String serviceRole)` The service role associated with the compute environment that allows AWS Batch to make calls to AWS API operations on your behalf.
`void`	`setState(CEState state)` The state of the compute environment.
`void`	`setState(String state)` The state of the compute environment.
`void`	`setStatus(CEStatus status)` The current status of the compute environment (for example, `CREATING` or `VALID`).
`void`	`setStatus(String status)` The current status of the compute environment (for example, `CREATING` or `VALID`).
`void`	`setStatusReason(String statusReason)` A short, human-readable string to provide additional details about the current status of the compute environment.
`void`	`setTags(Map<String,String> tags)` The tags applied to the compute environment.
`void`	`setType(CEType type)` The type of the compute environment: `MANAGED` or `UNMANAGED`.
`void`	`setType(String type)` The type of the compute environment: `MANAGED` or `UNMANAGED`.
`String`	`toString()` Returns a string representation of this object.
`ComputeEnvironmentDetail`	`withComputeEnvironmentArn(String computeEnvironmentArn)` The Amazon Resource Name (ARN) of the compute environment.
`ComputeEnvironmentDetail`	`withComputeEnvironmentName(String computeEnvironmentName)` The name of the compute environment.
`ComputeEnvironmentDetail`	`withComputeResources(ComputeResource computeResources)` The compute resources defined for the compute environment.
`ComputeEnvironmentDetail`	`withEcsClusterArn(String ecsClusterArn)` The Amazon Resource Name (ARN) of the underlying Amazon ECS cluster used by the compute environment.
`ComputeEnvironmentDetail`	`withServiceRole(String serviceRole)` The service role associated with the compute environment that allows AWS Batch to make calls to AWS API operations on your behalf.
`ComputeEnvironmentDetail`	`withState(CEState state)` The state of the compute environment.
`ComputeEnvironmentDetail`	`withState(String state)` The state of the compute environment.
`ComputeEnvironmentDetail`	`withStatus(CEStatus status)` The current status of the compute environment (for example, `CREATING` or `VALID`).
`ComputeEnvironmentDetail`	`withStatus(String status)` The current status of the compute environment (for example, `CREATING` or `VALID`).
`ComputeEnvironmentDetail`	`withStatusReason(String statusReason)` A short, human-readable string to provide additional details about the current status of the compute environment.
`ComputeEnvironmentDetail`	`withTags(Map<String,String> tags)` The tags applied to the compute environment.
`ComputeEnvironmentDetail`	`withType(CEType type)` The type of the compute environment: `MANAGED` or `UNMANAGED`.
`ComputeEnvironmentDetail`	`withType(String type)` The type of the compute environment: `MANAGED` or `UNMANAGED`.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - ComputeEnvironmentDetail
```
public ComputeEnvironmentDetail()
```
- Method Detail
  - setComputeEnvironmentName
```
public void setComputeEnvironmentName(String computeEnvironmentName)
```
    The name of the compute environment. Up to 128 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed.
    
    Parameters:
    
    computeEnvironmentName - The name of the compute environment. Up to 128 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed.
  - getComputeEnvironmentName
```
public String getComputeEnvironmentName()
```
    The name of the compute environment. Up to 128 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed.
    
    Returns:
    
    The name of the compute environment. Up to 128 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed.
  - withComputeEnvironmentName
```
public ComputeEnvironmentDetail withComputeEnvironmentName(String computeEnvironmentName)
```
    The name of the compute environment. Up to 128 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed.
    
    Parameters:
    
    computeEnvironmentName - The name of the compute environment. Up to 128 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setComputeEnvironmentArn
```
public void setComputeEnvironmentArn(String computeEnvironmentArn)
```
    The Amazon Resource Name (ARN) of the compute environment.
    
    Parameters:
    
    computeEnvironmentArn - The Amazon Resource Name (ARN) of the compute environment.
  - getComputeEnvironmentArn
```
public String getComputeEnvironmentArn()
```
    The Amazon Resource Name (ARN) of the compute environment.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the compute environment.
  - withComputeEnvironmentArn
```
public ComputeEnvironmentDetail withComputeEnvironmentArn(String computeEnvironmentArn)
```
    The Amazon Resource Name (ARN) of the compute environment.
    
    Parameters:
    
    computeEnvironmentArn - The Amazon Resource Name (ARN) of the compute environment.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setEcsClusterArn
```
public void setEcsClusterArn(String ecsClusterArn)
```
    The Amazon Resource Name (ARN) of the underlying Amazon ECS cluster used by the compute environment.
    
    Parameters:
    
    ecsClusterArn - The Amazon Resource Name (ARN) of the underlying Amazon ECS cluster used by the compute environment.
  - getEcsClusterArn
```
public String getEcsClusterArn()
```
    The Amazon Resource Name (ARN) of the underlying Amazon ECS cluster used by the compute environment.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the underlying Amazon ECS cluster used by the compute environment.
  - withEcsClusterArn
```
public ComputeEnvironmentDetail withEcsClusterArn(String ecsClusterArn)
```
    The Amazon Resource Name (ARN) of the underlying Amazon ECS cluster used by the compute environment.
    
    Parameters:
    
    ecsClusterArn - The Amazon Resource Name (ARN) of the underlying Amazon ECS cluster used by the compute environment.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getTags
```
public Map<String,String> getTags()
```
    The tags applied to the compute environment.
    
    Returns:
    
    The tags applied to the compute environment.
  - setTags
```
public void setTags(Map<String,String> tags)
```
    The tags applied to the compute environment.
    
    Parameters:
    
    tags - The tags applied to the compute environment.
  - withTags
```
public ComputeEnvironmentDetail withTags(Map<String,String> tags)
```
    The tags applied to the compute environment.
    
    Parameters:
    
    tags - The tags applied to the compute environment.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - addTagsEntry
```
public ComputeEnvironmentDetail addTagsEntry(String key,
                                             String value)
```
    Add a single Tags entry
    
    See Also:
    
    withTags(java.util.Map<java.lang.String, java.lang.String>)
  - clearTagsEntries
```
public ComputeEnvironmentDetail clearTagsEntries()
```
    Removes all the entries added into Tags.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setType
```
public void setType(String type)
```
    The type of the compute environment: MANAGED or UNMANAGED. For more information, see Compute Environments in the AWS Batch User Guide.
    
    Parameters:
    
    type - The type of the compute environment: MANAGED or UNMANAGED. For more information, see Compute Environments in the AWS Batch User Guide.
    
    See Also:
    
    CEType
  - getType
```
public String getType()
```
    The type of the compute environment: MANAGED or UNMANAGED. For more information, see Compute Environments in the AWS Batch User Guide.
    
    Returns:
    
    The type of the compute environment: MANAGED or UNMANAGED. For more information, see Compute Environments in the AWS Batch User Guide.
    
    See Also:
    
    CEType
  - withType
```
public ComputeEnvironmentDetail withType(String type)
```
    The type of the compute environment: MANAGED or UNMANAGED. For more information, see Compute Environments in the AWS Batch User Guide.
    
    Parameters:
    
    type - The type of the compute environment: MANAGED or UNMANAGED. For more information, see Compute Environments in the AWS Batch User Guide.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    CEType
  - setType
```
public void setType(CEType type)
```
    The type of the compute environment: MANAGED or UNMANAGED. For more information, see Compute Environments in the AWS Batch User Guide.
    
    Parameters:
    
    type - The type of the compute environment: MANAGED or UNMANAGED. For more information, see Compute Environments in the AWS Batch User Guide.
    
    See Also:
    
    CEType
  - withType
```
public ComputeEnvironmentDetail withType(CEType type)
```
    The type of the compute environment: MANAGED or UNMANAGED. For more information, see Compute Environments in the AWS Batch User Guide.
    
    Parameters:
    
    type - The type of the compute environment: MANAGED or UNMANAGED. For more information, see Compute Environments in the AWS Batch User Guide.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    CEType
  - setState
```
public void setState(String state)
```
    The state of the compute environment. The valid values are ENABLED or DISABLED.
    
    If the state is ENABLED, then the AWS Batch scheduler can attempt to place jobs from an associated job queue on the compute resources within the environment. If the compute environment is managed, then it can scale its instances out or in automatically, based on the job queue demand.
    
    If the state is DISABLED, then the AWS Batch scheduler doesn't attempt to place jobs within the environment. Jobs in a STARTING or RUNNING state continue to progress normally. Managed compute environments in the DISABLED state don't scale out. However, they scale in to minvCpus value after instances become idle.
    
    Parameters:
    
    state - The state of the compute environment. The valid values are ENABLED or DISABLED .
    
    If the state is ENABLED, then the AWS Batch scheduler can attempt to place jobs from an associated job queue on the compute resources within the environment. If the compute environment is managed, then it can scale its instances out or in automatically, based on the job queue demand.
    
    If the state is DISABLED, then the AWS Batch scheduler doesn't attempt to place jobs within the environment. Jobs in a STARTING or RUNNING state continue to progress normally. Managed compute environments in the DISABLED state don't scale out. However, they scale in to minvCpus value after instances become idle.
    
    See Also:
    
    CEState
  - getState
```
public String getState()
```
    The state of the compute environment. The valid values are ENABLED or DISABLED.
    
    If the state is ENABLED, then the AWS Batch scheduler can attempt to place jobs from an associated job queue on the compute resources within the environment. If the compute environment is managed, then it can scale its instances out or in automatically, based on the job queue demand.
    
    If the state is DISABLED, then the AWS Batch scheduler doesn't attempt to place jobs within the environment. Jobs in a STARTING or RUNNING state continue to progress normally. Managed compute environments in the DISABLED state don't scale out. However, they scale in to minvCpus value after instances become idle.
    
    Returns:
    
    The state of the compute environment. The valid values are ENABLED or DISABLED .
    
    If the state is ENABLED, then the AWS Batch scheduler can attempt to place jobs from an associated job queue on the compute resources within the environment. If the compute environment is managed, then it can scale its instances out or in automatically, based on the job queue demand.
    
    If the state is DISABLED, then the AWS Batch scheduler doesn't attempt to place jobs within the environment. Jobs in a STARTING or RUNNING state continue to progress normally. Managed compute environments in the DISABLED state don't scale out. However, they scale in to minvCpus value after instances become idle.
    
    See Also:
    
    CEState
  - withState
```
public ComputeEnvironmentDetail withState(String state)
```
    The state of the compute environment. The valid values are ENABLED or DISABLED.
    
    If the state is ENABLED, then the AWS Batch scheduler can attempt to place jobs from an associated job queue on the compute resources within the environment. If the compute environment is managed, then it can scale its instances out or in automatically, based on the job queue demand.
    
    If the state is DISABLED, then the AWS Batch scheduler doesn't attempt to place jobs within the environment. Jobs in a STARTING or RUNNING state continue to progress normally. Managed compute environments in the DISABLED state don't scale out. However, they scale in to minvCpus value after instances become idle.
    
    Parameters:
    
    state - The state of the compute environment. The valid values are ENABLED or DISABLED .
    
    If the state is ENABLED, then the AWS Batch scheduler can attempt to place jobs from an associated job queue on the compute resources within the environment. If the compute environment is managed, then it can scale its instances out or in automatically, based on the job queue demand.
    
    If the state is DISABLED, then the AWS Batch scheduler doesn't attempt to place jobs within the environment. Jobs in a STARTING or RUNNING state continue to progress normally. Managed compute environments in the DISABLED state don't scale out. However, they scale in to minvCpus value after instances become idle.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    CEState
  - setState
```
public void setState(CEState state)
```
    The state of the compute environment. The valid values are ENABLED or DISABLED.
    
    If the state is ENABLED, then the AWS Batch scheduler can attempt to place jobs from an associated job queue on the compute resources within the environment. If the compute environment is managed, then it can scale its instances out or in automatically, based on the job queue demand.
    
    If the state is DISABLED, then the AWS Batch scheduler doesn't attempt to place jobs within the environment. Jobs in a STARTING or RUNNING state continue to progress normally. Managed compute environments in the DISABLED state don't scale out. However, they scale in to minvCpus value after instances become idle.
    
    Parameters:
    
    state - The state of the compute environment. The valid values are ENABLED or DISABLED .
    
    If the state is ENABLED, then the AWS Batch scheduler can attempt to place jobs from an associated job queue on the compute resources within the environment. If the compute environment is managed, then it can scale its instances out or in automatically, based on the job queue demand.
    
    If the state is DISABLED, then the AWS Batch scheduler doesn't attempt to place jobs within the environment. Jobs in a STARTING or RUNNING state continue to progress normally. Managed compute environments in the DISABLED state don't scale out. However, they scale in to minvCpus value after instances become idle.
    
    See Also:
    
    CEState
  - withState
```
public ComputeEnvironmentDetail withState(CEState state)
```
    The state of the compute environment. The valid values are ENABLED or DISABLED.
    
    If the state is ENABLED, then the AWS Batch scheduler can attempt to place jobs from an associated job queue on the compute resources within the environment. If the compute environment is managed, then it can scale its instances out or in automatically, based on the job queue demand.
    
    If the state is DISABLED, then the AWS Batch scheduler doesn't attempt to place jobs within the environment. Jobs in a STARTING or RUNNING state continue to progress normally. Managed compute environments in the DISABLED state don't scale out. However, they scale in to minvCpus value after instances become idle.
    
    Parameters:
    
    state - The state of the compute environment. The valid values are ENABLED or DISABLED .
    
    If the state is ENABLED, then the AWS Batch scheduler can attempt to place jobs from an associated job queue on the compute resources within the environment. If the compute environment is managed, then it can scale its instances out or in automatically, based on the job queue demand.
    
    If the state is DISABLED, then the AWS Batch scheduler doesn't attempt to place jobs within the environment. Jobs in a STARTING or RUNNING state continue to progress normally. Managed compute environments in the DISABLED state don't scale out. However, they scale in to minvCpus value after instances become idle.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    CEState
  - setStatus
```
public void setStatus(String status)
```
    The current status of the compute environment (for example, CREATING or VALID).
    
    Parameters:
    
    status - The current status of the compute environment (for example, CREATING or VALID).
    
    See Also:
    
    CEStatus
  - getStatus
```
public String getStatus()
```
    The current status of the compute environment (for example, CREATING or VALID).
    
    Returns:
    
    The current status of the compute environment (for example, CREATING or VALID).
    
    See Also:
    
    CEStatus
  - withStatus
```
public ComputeEnvironmentDetail withStatus(String status)
```
    The current status of the compute environment (for example, CREATING or VALID).
    
    Parameters:
    
    status - The current status of the compute environment (for example, CREATING or VALID).
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    CEStatus
  - setStatus
```
public void setStatus(CEStatus status)
```
    The current status of the compute environment (for example, CREATING or VALID).
    
    Parameters:
    
    status - The current status of the compute environment (for example, CREATING or VALID).
    
    See Also:
    
    CEStatus
  - withStatus
```
public ComputeEnvironmentDetail withStatus(CEStatus status)
```
    The current status of the compute environment (for example, CREATING or VALID).
    
    Parameters:
    
    status - The current status of the compute environment (for example, CREATING or VALID).
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    CEStatus
  - setStatusReason
```
public void setStatusReason(String statusReason)
```
    A short, human-readable string to provide additional details about the current status of the compute environment.
    
    Parameters:
    
    statusReason - A short, human-readable string to provide additional details about the current status of the compute environment.
  - getStatusReason
```
public String getStatusReason()
```
    A short, human-readable string to provide additional details about the current status of the compute environment.
    
    Returns:
    
    A short, human-readable string to provide additional details about the current status of the compute environment.
  - withStatusReason
```
public ComputeEnvironmentDetail withStatusReason(String statusReason)
```
    A short, human-readable string to provide additional details about the current status of the compute environment.
    
    Parameters:
    
    statusReason - A short, human-readable string to provide additional details about the current status of the compute environment.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setComputeResources
```
public void setComputeResources(ComputeResource computeResources)
```
    The compute resources defined for the compute environment. For more information, see Compute Environments in the AWS Batch User Guide.
    
    Parameters:
    
    computeResources - The compute resources defined for the compute environment. For more information, see Compute Environments in the AWS Batch User Guide.
  - getComputeResources
```
public ComputeResource getComputeResources()
```
    The compute resources defined for the compute environment. For more information, see Compute Environments in the AWS Batch User Guide.
    
    Returns:
    
    The compute resources defined for the compute environment. For more information, see Compute Environments in the AWS Batch User Guide.
  - withComputeResources
```
public ComputeEnvironmentDetail withComputeResources(ComputeResource computeResources)
```
    The compute resources defined for the compute environment. For more information, see Compute Environments in the AWS Batch User Guide.
    
    Parameters:
    
    computeResources - The compute resources defined for the compute environment. For more information, see Compute Environments in the AWS Batch User Guide.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setServiceRole
```
public void setServiceRole(String serviceRole)
```
    The service role associated with the compute environment that allows AWS Batch to make calls to AWS API operations on your behalf. For more information, see AWS Batch service IAM role in the AWS Batch User Guide.
    
    Parameters:
    
    serviceRole - The service role associated with the compute environment that allows AWS Batch to make calls to AWS API operations on your behalf. For more information, see AWS Batch service IAM role in the AWS Batch User Guide.
  - getServiceRole
```
public String getServiceRole()
```
    The service role associated with the compute environment that allows AWS Batch to make calls to AWS API operations on your behalf. For more information, see AWS Batch service IAM role in the AWS Batch User Guide.
    
    Returns:
    
    The service role associated with the compute environment that allows AWS Batch to make calls to AWS API operations on your behalf. For more information, see AWS Batch service IAM role in the AWS Batch User Guide.
  - withServiceRole
```
public ComputeEnvironmentDetail withServiceRole(String serviceRole)
```
    The service role associated with the compute environment that allows AWS Batch to make calls to AWS API operations on your behalf. For more information, see AWS Batch service IAM role in the AWS Batch User Guide.
    
    Parameters:
    
    serviceRole - The service role associated with the compute environment that allows AWS Batch to make calls to AWS API operations on your behalf. For more information, see AWS Batch service IAM role in the AWS Batch User Guide.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public ComputeEnvironmentDetail clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Did this page help you?

Class ComputeEnvironmentDetail

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ComputeEnvironmentDetail

Method Detail

setComputeEnvironmentName

getComputeEnvironmentName

withComputeEnvironmentName

setComputeEnvironmentArn

getComputeEnvironmentArn

withComputeEnvironmentArn

setEcsClusterArn

getEcsClusterArn

withEcsClusterArn

getTags

setTags

withTags

addTagsEntry

clearTagsEntries

setType

getType

withType

setType

withType

setState

getState

withState

setState

withState

setStatus

getStatus

withStatus

setStatus

withStatus

setStatusReason

getStatusReason

withStatusReason

setComputeResources

getComputeResources

withComputeResources

setServiceRole

getServiceRole

withServiceRole

toString

equals

hashCode

clone

marshall