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

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<ServiceEnvironmentDetail.Builder,ServiceEnvironmentDetail>
```
@Generated("software.amazon.awssdk:codegen")
public final class ServiceEnvironmentDetail
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<ServiceEnvironmentDetail.Builder,ServiceEnvironmentDetail>
```
Detailed information about a service environment, including its configuration, state, and capacity limits.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface ServiceEnvironmentDetail.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static ServiceEnvironmentDetail.Builder`	`builder()`
`List<CapacityLimit>`	`capacityLimits()`	The capacity limits for the service environment.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasCapacityLimits()`	For responses, this returns true if the service returned a value for the CapacityLimits property.
`int`	`hashCode()`
`boolean`	`hasTags()`	For responses, this returns true if the service returned a value for the Tags property.
`Map<String,SdkField<?>>`	`sdkFieldNameToField()`
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends ServiceEnvironmentDetail.Builder>`	`serializableBuilderClass()`
`String`	`serviceEnvironmentArn()`	The Amazon Resource Name (ARN) of the service environment.
`String`	`serviceEnvironmentName()`	The name of the service environment.
`ServiceEnvironmentType`	`serviceEnvironmentType()`	The type of service environment.
`String`	`serviceEnvironmentTypeAsString()`	The type of service environment.
`ServiceEnvironmentState`	`state()`	The state of the service environment.
`String`	`stateAsString()`	The state of the service environment.
`ServiceEnvironmentStatus`	`status()`	The current status of the service environment.
`String`	`statusAsString()`	The current status of the service environment.
`Map<String,String>`	`tags()`	The tags associated with the service environment.
`ServiceEnvironmentDetail.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.

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

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

- Method Detail
  - serviceEnvironmentName
```
public final String serviceEnvironmentName()
```
    The name of the service environment.
    
    Returns:
    
    The name of the service environment.
  - serviceEnvironmentArn
```
public final String serviceEnvironmentArn()
```
    The Amazon Resource Name (ARN) of the service environment.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the service environment.
  - serviceEnvironmentType
```
public final ServiceEnvironmentType serviceEnvironmentType()
```
    The type of service environment. For SageMaker Training jobs, this value is SAGEMAKER_TRAINING.
    
    If the service returns an enum value that is not available in the current SDK version, serviceEnvironmentType will return ServiceEnvironmentType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from serviceEnvironmentTypeAsString().
    
    Returns:
    
    The type of service environment. For SageMaker Training jobs, this value is SAGEMAKER_TRAINING.
    
    See Also:
    
    ServiceEnvironmentType
  - serviceEnvironmentTypeAsString
```
public final String serviceEnvironmentTypeAsString()
```
    The type of service environment. For SageMaker Training jobs, this value is SAGEMAKER_TRAINING.
    
    If the service returns an enum value that is not available in the current SDK version, serviceEnvironmentType will return ServiceEnvironmentType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from serviceEnvironmentTypeAsString().
    
    Returns:
    
    The type of service environment. For SageMaker Training jobs, this value is SAGEMAKER_TRAINING.
    
    See Also:
    
    ServiceEnvironmentType
  - state
```
public final ServiceEnvironmentState state()
```
    The state of the service environment. Valid values are ENABLED and DISABLED.
    
    If the service returns an enum value that is not available in the current SDK version, state will return ServiceEnvironmentState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from stateAsString().
    
    Returns:
    
    The state of the service environment. Valid values are ENABLED and DISABLED.
    
    See Also:
    
    ServiceEnvironmentState
  - stateAsString
```
public final String stateAsString()
```
    The state of the service environment. Valid values are ENABLED and DISABLED.
    
    If the service returns an enum value that is not available in the current SDK version, state will return ServiceEnvironmentState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from stateAsString().
    
    Returns:
    
    The state of the service environment. Valid values are ENABLED and DISABLED.
    
    See Also:
    
    ServiceEnvironmentState
  - status
```
public final ServiceEnvironmentStatus status()
```
    The current status of the service environment.
    
    If the service returns an enum value that is not available in the current SDK version, status will return ServiceEnvironmentStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().
    
    Returns:
    
    The current status of the service environment.
    
    See Also:
    
    ServiceEnvironmentStatus
  - statusAsString
```
public final String statusAsString()
```
    The current status of the service environment.
    
    If the service returns an enum value that is not available in the current SDK version, status will return ServiceEnvironmentStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().
    
    Returns:
    
    The current status of the service environment.
    
    See Also:
    
    ServiceEnvironmentStatus
  - hasCapacityLimits
```
public final boolean hasCapacityLimits()
```
    For responses, this returns true if the service returned a value for the CapacityLimits 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.
  - capacityLimits
```
public final List<CapacityLimit> capacityLimits()
```
    The capacity limits for the service environment. This defines the maximum resources that can be used by service jobs in this 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 hasCapacityLimits() method.
    
    Returns:
    
    The capacity limits for the service environment. This defines the maximum resources that can be used by service jobs in this 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 associated with the service environment. Each tag consists of a key and an optional value. For more information, see Tagging your Batch resources.
    
    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 associated with the service environment. Each tag consists of a key and an optional value. For more information, see Tagging your Batch resources.
  - toBuilder
```
public ServiceEnvironmentDetail.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<ServiceEnvironmentDetail.Builder,ServiceEnvironmentDetail>
  - builder
```
public static ServiceEnvironmentDetail.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends ServiceEnvironmentDetail.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)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - 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
  - sdkFieldNameToField
```
public final Map<String,SdkField<?>> sdkFieldNameToField()
```
    Specified by:
    
    sdkFieldNameToField in interface SdkPojo

Class ServiceEnvironmentDetail

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

serviceEnvironmentName

serviceEnvironmentArn

serviceEnvironmentType

serviceEnvironmentTypeAsString

state

stateAsString

status

statusAsString

hasCapacityLimits

capacityLimits

hasTags

tags

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields

sdkFieldNameToField