Package software.amazon.awssdk.services.batch.model

Class UpdateServiceEnvironmentRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.batch.model.BatchRequest

software.amazon.awssdk.services.batch.model.UpdateServiceEnvironmentRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<UpdateServiceEnvironmentRequest.Builder,UpdateServiceEnvironmentRequest>

@Generated("software.amazon.awssdk:codegen")
public final class UpdateServiceEnvironmentRequest
extends BatchRequest
implements ToCopyableBuilder<UpdateServiceEnvironmentRequest.Builder,UpdateServiceEnvironmentRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	UpdateServiceEnvironmentRequest.Builder

Method Summary

Modifier and Type	Method	Description
static UpdateServiceEnvironmentRequest.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()
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends UpdateServiceEnvironmentRequest.Builder>	serializableBuilderClass()
String	serviceEnvironment()	The name or ARN of the service environment to update.
ServiceEnvironmentState	state()	The state of the service environment.
String	stateAsString()	The state of the service environment.
UpdateServiceEnvironmentRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

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

serviceEnvironment

public final String serviceEnvironment()

The name or ARN of the service environment to update.

Returns:

The name or ARN of the service environment to update.

state

public final ServiceEnvironmentState state()

The state of the service environment.

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.

See Also:

ServiceEnvironmentState

stateAsString

public final String stateAsString()

The state of the service environment.

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.

See Also:

ServiceEnvironmentState

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.

toBuilder

public UpdateServiceEnvironmentRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<UpdateServiceEnvironmentRequest.Builder,UpdateServiceEnvironmentRequest>

Specified by:

toBuilder in class BatchRequest

builder

public static UpdateServiceEnvironmentRequest.Builder builder()

serializableBuilderClass

public static Class<? extends UpdateServiceEnvironmentRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

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)

Overrides:

getValueForField in class SdkRequest

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