@Generated(value="software.amazon.awssdk:codegen") public final class ComputeEnvironmentDetail extends Object implements StructuredPojo, ToCopyableBuilder<ComputeEnvironmentDetail.Builder,ComputeEnvironmentDetail>
An object representing an AWS Batch compute environment.
Modifier and Type | Class and Description |
---|---|
static interface |
ComputeEnvironmentDetail.Builder |
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) |
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
int |
hashCode() |
void |
marshall(ProtocolMarshaller protocolMarshaller)
Marshalls this structured data using the given
ProtocolMarshaller . |
static Class<? extends ComputeEnvironmentDetail.Builder> |
serializableBuilderClass() |
String |
serviceRole()
The service role associated with the compute environment that allows AWS Batch to make calls to AWS 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.
|
ComputeEnvironmentDetail.Builder |
toBuilder()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString() |
CEType |
type()
The type of the compute environment.
|
String |
typeAsString()
The type of the compute environment.
|
copy
public String computeEnvironmentName()
The name of the compute environment.
public String computeEnvironmentArn()
The Amazon Resource Name (ARN) of the compute environment.
public String ecsClusterArn()
The Amazon Resource Name (ARN) of the underlying Amazon ECS cluster used by the compute environment.
public CEType type()
The type of the compute environment.
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()
.
CEType
public String typeAsString()
The type of the compute environment.
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()
.
CEType
public CEState state()
The state of the compute environment. The valid values are ENABLED
or DISABLED
. An
ENABLED
state indicates that you can register instances with the compute environment and that the
associated instances can accept jobs.
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()
.
ENABLED
or DISABLED
.
An ENABLED
state indicates that you can register instances with the compute environment and
that the associated instances can accept jobs.CEState
public String stateAsString()
The state of the compute environment. The valid values are ENABLED
or DISABLED
. An
ENABLED
state indicates that you can register instances with the compute environment and that the
associated instances can accept jobs.
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()
.
ENABLED
or DISABLED
.
An ENABLED
state indicates that you can register instances with the compute environment and
that the associated instances can accept jobs.CEState
public 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()
.
CREATING
or VALID
).CEStatus
public 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()
.
CREATING
or VALID
).CEStatus
public String statusReason()
A short, human-readable string to provide additional details about the current status of the compute environment.
public ComputeResource computeResources()
The compute resources defined for the compute environment.
public String serviceRole()
The service role associated with the compute environment that allows AWS Batch to make calls to AWS API operations on your behalf.
public ComputeEnvironmentDetail.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<ComputeEnvironmentDetail.Builder,ComputeEnvironmentDetail>
public static ComputeEnvironmentDetail.Builder builder()
public static Class<? extends ComputeEnvironmentDetail.Builder> serializableBuilderClass()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
- Implementation of ProtocolMarshaller
used to marshall this object's data.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.