software.amazon.awssdk.services.codecatalyst.model

Class CreateDevEnvironmentRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.codecatalyst.model.CodeCatalystRequest

software.amazon.awssdk.services.codecatalyst.model.CreateDevEnvironmentRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateDevEnvironmentRequest.Builder,CreateDevEnvironmentRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CreateDevEnvironmentRequest.Builder

Method Summary

Modifier and Type	Method and Description
String	alias() The user-defined alias for a Dev Environment.
static CreateDevEnvironmentRequest.Builder	builder()
String	clientToken() A user-specified idempotency token.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasIdes() For responses, this returns true if the service returned a value for the Ides property.
boolean	hasRepositories() For responses, this returns true if the service returned a value for the Repositories property.
List<IdeConfiguration>	ides() Information about the integrated development environment (IDE) configured for a Dev Environment.
Integer	inactivityTimeoutMinutes() The amount of time the Dev Environment will run without any activity detected before stopping, in minutes.
InstanceType	instanceType() The Amazon EC2 instace type to use for the Dev Environment.
String	instanceTypeAsString() The Amazon EC2 instace type to use for the Dev Environment.
PersistentStorageConfiguration	persistentStorage() Information about the amount of storage allocated to the Dev Environment.
String	projectName() The name of the project in the space.
List<RepositoryInput>	repositories() The source repository that contains the branch to clone into the Dev Environment.
List<SdkField<?>>	sdkFields()
static Class<? extends CreateDevEnvironmentRequest.Builder>	serializableBuilderClass()
String	spaceName() The name of the space.
CreateDevEnvironmentRequest.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

spaceName

public final String spaceName()

The name of the space.

Returns:

The name of the space.

projectName

public final String projectName()

The name of the project in the space.

Returns:

The name of the project in the space.

hasRepositories

public final boolean hasRepositories()

For responses, this returns true if the service returned a value for the Repositories 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.

repositories

public final List<RepositoryInput> repositories()

The source repository that contains the branch to clone into the Dev 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 hasRepositories() method.

Returns:

The source repository that contains the branch to clone into the Dev Environment.

clientToken

public final String clientToken()

A user-specified idempotency token. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully, the subsequent retries return the result from the original successful request and have no additional effect.

Returns:

A user-specified idempotency token. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully, the subsequent retries return the result from the original successful request and have no additional effect.

alias

public final String alias()

The user-defined alias for a Dev Environment.

Returns:

The user-defined alias for a Dev Environment.

hasIdes

public final boolean hasIdes()

For responses, this returns true if the service returned a value for the Ides 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.

ides

public final List<IdeConfiguration> ides()

Information about the integrated development environment (IDE) configured for a Dev Environment.

An IDE is required to create a Dev Environment. For Dev Environment creation, this field contains configuration information and must be provided.

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 hasIdes() method.

Returns:

Information about the integrated development environment (IDE) configured for a Dev Environment.

An IDE is required to create a Dev Environment. For Dev Environment creation, this field contains configuration information and must be provided.

instanceType

public final InstanceType instanceType()

The Amazon EC2 instace type to use for the Dev Environment.

If the service returns an enum value that is not available in the current SDK version, instanceType will return InstanceType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from instanceTypeAsString().

Returns:

The Amazon EC2 instace type to use for the Dev Environment.

See Also:

InstanceType

instanceTypeAsString

public final String instanceTypeAsString()

The Amazon EC2 instace type to use for the Dev Environment.

If the service returns an enum value that is not available in the current SDK version, instanceType will return InstanceType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from instanceTypeAsString().

Returns:

The Amazon EC2 instace type to use for the Dev Environment.

See Also:

InstanceType

inactivityTimeoutMinutes

public final Integer inactivityTimeoutMinutes()

The amount of time the Dev Environment will run without any activity detected before stopping, in minutes. Only whole integers are allowed. Dev Environments consume compute minutes when running.

Returns:

The amount of time the Dev Environment will run without any activity detected before stopping, in minutes. Only whole integers are allowed. Dev Environments consume compute minutes when running.

persistentStorage

public final PersistentStorageConfiguration persistentStorage()

Information about the amount of storage allocated to the Dev Environment.

By default, a Dev Environment is configured to have 16GB of persistent storage when created from the Amazon CodeCatalyst console, but there is no default when programmatically creating a Dev Environment. Valid values for persistent storage are based on memory sizes in 16GB increments. Valid values are 16, 32, and 64.

Returns:

Information about the amount of storage allocated to the Dev Environment.

By default, a Dev Environment is configured to have 16GB of persistent storage when created from the Amazon CodeCatalyst console, but there is no default when programmatically creating a Dev Environment. Valid values for persistent storage are based on memory sizes in 16GB increments. Valid values are 16, 32, and 64.

toBuilder

public CreateDevEnvironmentRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateDevEnvironmentRequest.Builder,CreateDevEnvironmentRequest>

Specified by:

toBuilder in class CodeCatalystRequest

builder

public static CreateDevEnvironmentRequest.Builder builder()

serializableBuilderClass

public static Class<? extends CreateDevEnvironmentRequest.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