java.lang.Object
- software.amazon.awssdk.core.SdkRequest
- - software.amazon.awssdk.awscore.AwsRequest
  - - software.amazon.awssdk.services.workspacesthinclient.model.WorkSpacesThinClientRequest
    - - software.amazon.awssdk.services.workspacesthinclient.model.UpdateEnvironmentRequest

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<UpdateEnvironmentRequest.Builder,UpdateEnvironmentRequest>

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

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface UpdateEnvironmentRequest.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static UpdateEnvironmentRequest.Builder`	`builder()`
`String`	`desiredSoftwareSetId()`	The ID of the software set to apply.
`String`	`desktopArn()`	The Amazon Resource Name (ARN) of the desktop to stream from Amazon WorkSpaces, WorkSpaces Web, or AppStream 2.0.
`String`	`desktopEndpoint()`	The URL for the identity provider login (only for environments that use AppStream 2.0).
`Map<String,String>`	`deviceCreationTags()`	A map of the key-value pairs of the tag or tags to assign to the newly created devices for this environment.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasDeviceCreationTags()`	For responses, this returns true if the service returned a value for the DeviceCreationTags property.
`int`	`hashCode()`
`String`	`id()`	The ID of the environment to update.
`MaintenanceWindow`	`maintenanceWindow()`	A specification for a time window to apply software updates.
`String`	`name()`	The name of the environment to update.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends UpdateEnvironmentRequest.Builder>`	`serializableBuilderClass()`
`SoftwareSetUpdateMode`	`softwareSetUpdateMode()`	An option to define which software updates to apply.
`String`	`softwareSetUpdateModeAsString()`	An option to define which software updates to apply.
`SoftwareSetUpdateSchedule`	`softwareSetUpdateSchedule()`	An option to define if software updates should be applied within a maintenance window.
`String`	`softwareSetUpdateScheduleAsString()`	An option to define if software updates should be applied within a maintenance window.
`UpdateEnvironmentRequest.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
  - id
```
public final String id()
```
    The ID of the environment to update.
    
    Returns:
    
    The ID of the environment to update.
  - name
```
public final String name()
```
    The name of the environment to update.
    
    Returns:
    
    The name of the environment to update.
  - desktopArn
```
public final String desktopArn()
```
    The Amazon Resource Name (ARN) of the desktop to stream from Amazon WorkSpaces, WorkSpaces Web, or AppStream 2.0.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the desktop to stream from Amazon WorkSpaces, WorkSpaces Web, or AppStream 2.0.
  - desktopEndpoint
```
public final String desktopEndpoint()
```
    The URL for the identity provider login (only for environments that use AppStream 2.0).
    
    Returns:
    
    The URL for the identity provider login (only for environments that use AppStream 2.0).
  - softwareSetUpdateSchedule
```
public final SoftwareSetUpdateSchedule softwareSetUpdateSchedule()
```
    An option to define if software updates should be applied within a maintenance window.
    
    If the service returns an enum value that is not available in the current SDK version, softwareSetUpdateSchedule will return SoftwareSetUpdateSchedule.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from softwareSetUpdateScheduleAsString().
    
    Returns:
    
    An option to define if software updates should be applied within a maintenance window.
    
    See Also:
    
    SoftwareSetUpdateSchedule
  - softwareSetUpdateScheduleAsString
```
public final String softwareSetUpdateScheduleAsString()
```
    An option to define if software updates should be applied within a maintenance window.
    
    If the service returns an enum value that is not available in the current SDK version, softwareSetUpdateSchedule will return SoftwareSetUpdateSchedule.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from softwareSetUpdateScheduleAsString().
    
    Returns:
    
    An option to define if software updates should be applied within a maintenance window.
    
    See Also:
    
    SoftwareSetUpdateSchedule
  - maintenanceWindow
```
public final MaintenanceWindow maintenanceWindow()
```
    A specification for a time window to apply software updates.
    
    Returns:
    
    A specification for a time window to apply software updates.
  - softwareSetUpdateMode
```
public final SoftwareSetUpdateMode softwareSetUpdateMode()
```
    An option to define which software updates to apply.
    
    If the service returns an enum value that is not available in the current SDK version, softwareSetUpdateMode will return SoftwareSetUpdateMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from softwareSetUpdateModeAsString().
    
    Returns:
    
    An option to define which software updates to apply.
    
    See Also:
    
    SoftwareSetUpdateMode
  - softwareSetUpdateModeAsString
```
public final String softwareSetUpdateModeAsString()
```
    An option to define which software updates to apply.
    
    If the service returns an enum value that is not available in the current SDK version, softwareSetUpdateMode will return SoftwareSetUpdateMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from softwareSetUpdateModeAsString().
    
    Returns:
    
    An option to define which software updates to apply.
    
    See Also:
    
    SoftwareSetUpdateMode
  - desiredSoftwareSetId
```
public final String desiredSoftwareSetId()
```
    The ID of the software set to apply.
    
    Returns:
    
    The ID of the software set to apply.
  - hasDeviceCreationTags
```
public final boolean hasDeviceCreationTags()
```
    For responses, this returns true if the service returned a value for the DeviceCreationTags 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.
  - deviceCreationTags
```
public final Map<String,String> deviceCreationTags()
```
    A map of the key-value pairs of the tag or tags to assign to the newly created devices for 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 hasDeviceCreationTags() method.
    
    Returns:
    
    A map of the key-value pairs of the tag or tags to assign to the newly created devices for this environment.
  - toBuilder
```
public UpdateEnvironmentRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<UpdateEnvironmentRequest.Builder,UpdateEnvironmentRequest>
    
    Specified by:
    
    toBuilder in class WorkSpacesThinClientRequest
  - builder
```
public static UpdateEnvironmentRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends UpdateEnvironmentRequest.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

Class UpdateEnvironmentRequest

Nested Class Summary

Method Summary

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

Methods inherited from class java.lang.Object

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

Method Detail

id

name

desktopArn

desktopEndpoint

softwareSetUpdateSchedule

softwareSetUpdateScheduleAsString

maintenanceWindow

softwareSetUpdateMode

softwareSetUpdateModeAsString

desiredSoftwareSetId

hasDeviceCreationTags

deviceCreationTags

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields