software.amazon.awssdk.services.batch.model

Class CreateComputeEnvironmentRequest

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.CreateComputeEnvironmentRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateComputeEnvironmentRequest.Builder,CreateComputeEnvironmentRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CreateComputeEnvironmentRequest.Builder

Method Summary

Modifier and Type	Method and Description
static CreateComputeEnvironmentRequest.Builder	builder()
String	computeEnvironmentName() The name for your compute environment.
ComputeResource	computeResources() Details of the compute resources managed by the compute environment.
boolean	equals(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extends SdkRequest.
int	hashCode()
List<SdkField<?>>	sdkFields()
static Class<? extends CreateComputeEnvironmentRequest.Builder>	serializableBuilderClass()
String	serviceRole() The full Amazon Resource Name (ARN) of the IAM role that allows AWS Batch to make calls to other AWS services on your behalf.
CEState	state() The state of the compute environment.
String	stateAsString() The state of the compute environment.
CreateComputeEnvironmentRequest.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.

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

overrideConfiguration

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 String computeEnvironmentName()

The name for your compute environment. Up to 128 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed.

Returns:

The name for your compute environment. Up to 128 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed.

type

public CEType type()

The type of the compute environment. For more information, see Compute Environments in the AWS 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. For more information, see Compute Environments in the AWS Batch User Guide.

See Also:

CEType

typeAsString

public String typeAsString()

The type of the compute environment. For more information, see Compute Environments in the AWS 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. For more information, see Compute Environments in the AWS Batch User Guide.

See Also:

CEType

state

public CEState state()

The state of the compute environment. If the state is ENABLED, then the compute environment accepts jobs from a queue and can scale out automatically based on queues.

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. If the state is ENABLED, then the compute environment accepts jobs from a queue and can scale out automatically based on queues.

See Also:

CEState

stateAsString

public String stateAsString()

The state of the compute environment. If the state is ENABLED, then the compute environment accepts jobs from a queue and can scale out automatically based on queues.

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. If the state is ENABLED, then the compute environment accepts jobs from a queue and can scale out automatically based on queues.

See Also:

CEState

computeResources

public ComputeResource computeResources()

Details of the compute resources managed by the compute environment. This parameter is required for managed compute environments.

Returns:

Details of the compute resources managed by the compute environment. This parameter is required for managed compute environments.

serviceRole

public String serviceRole()

The full Amazon Resource Name (ARN) of the IAM role that allows AWS Batch to make calls to other AWS services on your behalf.

If your specified role has a path other than /, then you must either specify the full role ARN (this is recommended) or prefix the role name with the path.

Depending on how you created your AWS Batch service role, its ARN may contain the service-role path prefix. When you only specify the name of the service role, AWS Batch assumes that your ARN does not use the service-role path prefix. Because of this, we recommend that you specify the full ARN of your service role when you create compute environments.

Returns:

The full Amazon Resource Name (ARN) of the IAM role that allows AWS Batch to make calls to other AWS services on your behalf.

If your specified role has a path other than /, then you must either specify the full role ARN (this is recommended) or prefix the role name with the path.

Depending on how you created your AWS Batch service role, its ARN may contain the service-role path prefix. When you only specify the name of the service role, AWS Batch assumes that your ARN does not use the service-role path prefix. Because of this, we recommend that you specify the full ARN of your service role when you create compute environments.

toBuilder

public CreateComputeEnvironmentRequest.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<CreateComputeEnvironmentRequest.Builder,CreateComputeEnvironmentRequest>

Specified by:

toBuilder in class BatchRequest

Returns:

a builder for type T

builder

public static CreateComputeEnvironmentRequest.Builder builder()

serializableBuilderClass

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

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

Description copied from class: SdkRequest

Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.

Overrides:

getValueForField in class SdkRequest

Parameters:

fieldName - The name of the member to be retrieved.

clazz - The class to cast the returned object to.

Returns:

Optional containing the casted return value

sdkFields

public 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.