ComputeEnvironmentDetail (AWS SDK for Java

java.lang.Object
- software.amazon.awssdk.services.batch.model.ComputeEnvironmentDetail

All Implemented Interfaces:: Serializable, SdkPojo, ToCopyableBuilder<ComputeEnvironmentDetail.Builder,ComputeEnvironmentDetail>

@Generated(value="software.amazon.awssdk:codegen")
public final class ComputeEnvironmentDetail
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<ComputeEnvironmentDetail.Builder,ComputeEnvironmentDetail>

An object representing an Batch compute environment.

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface ComputeEnvironmentDetail.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`ComputeEnvironmentDetail.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static ComputeEnvironmentDetail.Builder`	`builder()`
`String`	`computeEnvironmentArn()` The Amazon Resource Name (ARN) of the compute environment.
`String`	`computeEnvironmentName()` The name of the compute environment.
`ComputeResource`	`computeResources()` The compute resources defined for the compute environment.
`String`	`ecsClusterArn()` The Amazon Resource Name (ARN) of the underlying Amazon ECS cluster used by the compute environment.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)` Indicates whether some other object is "equal to" this one by SDK fields.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`boolean`	`hasTags()` For responses, this returns true if the service returned a value for the Tags property.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends ComputeEnvironmentDetail.Builder>`	`serializableBuilderClass()`
`String`	`serviceRole()` The service role associated with the compute environment that allows Batch to make calls to Amazon Web Services API operations on your behalf.
`CEState`	`state()` The state of the compute environment.
`String`	`stateAsString()` The state of the compute environment.
`CEStatus`	`status()` The current status of the compute environment (for example, `CREATING` or `VALID`).
`String`	`statusAsString()` The current status of the compute environment (for example, `CREATING` or `VALID`).
`String`	`statusReason()` A short, human-readable string to provide additional details about the current status of the compute environment.
`Map<String,String>`	`tags()` The tags applied to the compute environment.
`ComputeEnvironmentDetail.Builder`	`toBuilder()` Take this object and create a builder that contains all of the current property values of this object.
`String`	`toString()` Returns a string representation of this object.
`CEType`	`type()` The type of the compute environment: `MANAGED` or `UNMANAGED`.
`String`	`typeAsString()` The type of the compute environment: `MANAGED` or `UNMANAGED`.

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

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - computeEnvironmentName
```
public final String computeEnvironmentName()
```
    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.
  - computeEnvironmentArn
```
public final String computeEnvironmentArn()
```
    The Amazon Resource Name (ARN) of the compute environment.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the compute environment.
  - ecsClusterArn
```
public final String ecsClusterArn()
```
    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.
  - hasTags
```
public final boolean hasTags()
```
    For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - tags
```
public final Map<String,String> tags()
```
    The tags applied to the compute environment.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTags() method.
    
    Returns:
    
    The tags applied to the compute environment.
  - type
```
public final CEType type()
```
    The type of the compute environment: MANAGED or UNMANAGED. For more information, see Compute Environments in the Batch User Guide.
    
    If the service returns an enum value that is not available in the current SDK version, type will return CEType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().
    
    Returns:
    
    The type of the compute environment: MANAGED or UNMANAGED. For more information, see Compute Environments in the Batch User Guide.
    
    See Also:
    
    CEType
  - typeAsString
```
public final String typeAsString()
```
    The type of the compute environment: MANAGED or UNMANAGED. For more information, see Compute Environments in the Batch User Guide.
    
    If the service returns an enum value that is not available in the current SDK version, type will return CEType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().
    
    Returns:
    
    The type of the compute environment: MANAGED or UNMANAGED. For more information, see Compute Environments in the Batch User Guide.
    
    See Also:
    
    CEType
  - state
```
public final CEState state()
```
    The state of the compute environment. The valid values are ENABLED or DISABLED.
    
    If the state is ENABLED, then the 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 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.
    
    If the service returns an enum value that is not available in the current SDK version, state will return CEState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from stateAsString().
    
    Returns:
    
    The state of the compute environment. The valid values are ENABLED or DISABLED .
    
    If the state is ENABLED, then the 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 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
  - stateAsString
```
public final String stateAsString()
```
    The state of the compute environment. The valid values are ENABLED or DISABLED.
    
    If the state is ENABLED, then the 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 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.
    
    If the service returns an enum value that is not available in the current SDK version, state will return CEState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from stateAsString().
    
    Returns:
    
    The state of the compute environment. The valid values are ENABLED or DISABLED .
    
    If the state is ENABLED, then the 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 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
  - status
```
public final CEStatus status()
```
    The current status of the compute environment (for example, CREATING or VALID).
    
    If the service returns an enum value that is not available in the current SDK version, status will return CEStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().
    
    Returns:
    
    The current status of the compute environment (for example, CREATING or VALID).
    
    See Also:
    
    CEStatus
  - statusAsString
```
public final String statusAsString()
```
    The current status of the compute environment (for example, CREATING or VALID).
    
    If the service returns an enum value that is not available in the current SDK version, status will return CEStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().
    
    Returns:
    
    The current status of the compute environment (for example, CREATING or VALID).
    
    See Also:
    
    CEStatus
  - statusReason
```
public final String statusReason()
```
    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.
  - computeResources
```
public final ComputeResource computeResources()
```
    The compute resources defined for the compute environment. For more information, see Compute Environments in the Batch User Guide.
    
    Returns:
    
    The compute resources defined for the compute environment. For more information, see Compute Environments in the Batch User Guide.
  - serviceRole
```
public final String serviceRole()
```
    The service role associated with the compute environment that allows Batch to make calls to Amazon Web Services API operations on your behalf. For more information, see Batch service IAM role in the Batch User Guide.
    
    Returns:
    
    The service role associated with the compute environment that allows Batch to make calls to Amazon Web Services API operations on your behalf. For more information, see Batch service IAM role in the Batch User Guide.
  - toBuilder
```
public ComputeEnvironmentDetail.Builder toBuilder()
```
    Description copied from interface: ToCopyableBuilder
    
    Take this object and create a builder that contains all of the current property values of this object.
    
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<ComputeEnvironmentDetail.Builder,ComputeEnvironmentDetail>
    
    Returns:
    
    a builder for type T
  - builder
```
public static ComputeEnvironmentDetail.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends ComputeEnvironmentDetail.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Description copied from interface: SdkPojo
    
    Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.
    If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.
    
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
    
    Parameters:
    
    obj - the object to be compared with
    
    Returns:
    
    true if the other object equals to this object by sdk fields, false otherwise.
  - toString
```
public final 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
  - getValueForField
```
public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo
    
    Returns:
    
    List of SdkField in this POJO. May be empty list but should never be null.

AWS SDK for Java API Reference - 2.17.43

Class ComputeEnvironmentDetail

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

computeEnvironmentName

computeEnvironmentArn

ecsClusterArn

hasTags

tags

type

typeAsString

state

stateAsString

status

statusAsString

statusReason

computeResources

serviceRole

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields