software.amazon.awssdk.services.codecatalyst.model

Class UpdateDevEnvironmentRequest

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<UpdateDevEnvironmentRequest.Builder,UpdateDevEnvironmentRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	UpdateDevEnvironmentRequest.Builder

Method Summary

Modifier and Type	Method and Description
String	alias() The user-specified alias for the Dev Environment.
static UpdateDevEnvironmentRequest.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.
String	id() The system-generated unique ID of the Dev Environment.
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.
String	projectName() The name of the project in the space.
List<SdkField<?>>	sdkFields()
static Class<? extends UpdateDevEnvironmentRequest.Builder>	serializableBuilderClass()
String	spaceName() The name of the space.
UpdateDevEnvironmentRequest.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.

id

public final String id()

The system-generated unique ID of the Dev Environment.

Returns:

The system-generated unique ID of the Dev Environment.

alias

public final String alias()

The user-specified alias for the Dev Environment. Changing this value will not cause a restart.

Returns:

The user-specified alias for the Dev Environment. Changing this value will not cause a restart.

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.

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.

instanceType

public final InstanceType instanceType()

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

Changing this value will cause a restart of the Dev Environment if it is running.

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.

Changing this value will cause a restart of the Dev Environment if it is running.

See Also:

InstanceType

instanceTypeAsString

public final String instanceTypeAsString()

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

Changing this value will cause a restart of the Dev Environment if it is running.

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.

Changing this value will cause a restart of the Dev Environment if it is running.

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.

Changing this value will cause a restart of the Dev Environment if it is 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.

Changing this value will cause a restart of the Dev Environment if it is running.

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.

toBuilder

public UpdateDevEnvironmentRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<UpdateDevEnvironmentRequest.Builder,UpdateDevEnvironmentRequest>

Specified by:

toBuilder in class CodeCatalystRequest

builder

public static UpdateDevEnvironmentRequest.Builder builder()

serializableBuilderClass

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