java.lang.Object
- software.amazon.awssdk.services.workspaces.model.WorkspaceProperties

All Implemented Interfaces:: Serializable, SdkPojo, ToCopyableBuilder<WorkspaceProperties.Builder,WorkspaceProperties>

@Generated("software.amazon.awssdk:codegen")
public final class WorkspaceProperties
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<WorkspaceProperties.Builder,WorkspaceProperties>

Describes a WorkSpace.

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface WorkspaceProperties.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static WorkspaceProperties.Builder`	`builder()`
`Compute`	`computeTypeName()`	The compute type.
`String`	`computeTypeNameAsString()`	The compute type.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`GlobalAcceleratorForWorkSpace`	`globalAccelerator()`	Indicates the Global Accelerator properties.
`int`	`hashCode()`
`boolean`	`hasProtocols()`	For responses, this returns true if the service returned a value for the Protocols property.
`OperatingSystemName`	`operatingSystemName()`	The name of the operating system.
`String`	`operatingSystemNameAsString()`	The name of the operating system.
`List<Protocol>`	`protocols()`	The protocol.
`List<String>`	`protocolsAsStrings()`	The protocol.
`Integer`	`rootVolumeSizeGib()`	The size of the root volume.
`RunningMode`	`runningMode()`	The running mode.
`String`	`runningModeAsString()`	The running mode.
`Integer`	`runningModeAutoStopTimeoutInMinutes()`	The time after a user logs off when WorkSpaces are automatically stopped.
`Map<String,SdkField<?>>`	`sdkFieldNameToField()`
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends WorkspaceProperties.Builder>`	`serializableBuilderClass()`
`WorkspaceProperties.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.
`Integer`	`userVolumeSizeGib()`	The size of the user storage.

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
  - runningMode
```
public final RunningMode runningMode()
```
    The running mode. For more information, see Manage the WorkSpace Running Mode.
    
    The MANUAL value is only supported by Amazon WorkSpaces Core. Contact your account team to be allow-listed to use this value. For more information, see Amazon WorkSpaces Core.
    
    Review your running mode to ensure you are using one that is optimal for your needs and budget. For more information on switching running modes, see Can I switch between hourly and monthly billing?
    
    If the service returns an enum value that is not available in the current SDK version, runningMode will return RunningMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from runningModeAsString().
    
    Returns:
    
    The running mode. For more information, see Manage the WorkSpace Running Mode.
    
    The MANUAL value is only supported by Amazon WorkSpaces Core. Contact your account team to be allow-listed to use this value. For more information, see Amazon WorkSpaces Core.
    
    Review your running mode to ensure you are using one that is optimal for your needs and budget. For more information on switching running modes, see Can I switch between hourly and monthly billing?
    
    See Also:
    
    RunningMode
  - runningModeAsString
```
public final String runningModeAsString()
```
    The running mode. For more information, see Manage the WorkSpace Running Mode.
    
    The MANUAL value is only supported by Amazon WorkSpaces Core. Contact your account team to be allow-listed to use this value. For more information, see Amazon WorkSpaces Core.
    
    Review your running mode to ensure you are using one that is optimal for your needs and budget. For more information on switching running modes, see Can I switch between hourly and monthly billing?
    
    If the service returns an enum value that is not available in the current SDK version, runningMode will return RunningMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from runningModeAsString().
    
    Returns:
    
    The running mode. For more information, see Manage the WorkSpace Running Mode.
    
    The MANUAL value is only supported by Amazon WorkSpaces Core. Contact your account team to be allow-listed to use this value. For more information, see Amazon WorkSpaces Core.
    
    Review your running mode to ensure you are using one that is optimal for your needs and budget. For more information on switching running modes, see Can I switch between hourly and monthly billing?
    
    See Also:
    
    RunningMode
  - runningModeAutoStopTimeoutInMinutes
```
public final Integer runningModeAutoStopTimeoutInMinutes()
```
    The time after a user logs off when WorkSpaces are automatically stopped. Configured in 60-minute intervals.
    
    Returns:
    
    The time after a user logs off when WorkSpaces are automatically stopped. Configured in 60-minute intervals.
  - rootVolumeSizeGib
```
public final Integer rootVolumeSizeGib()
```
    The size of the root volume. For important information about how to modify the size of the root and user volumes, see Modify a WorkSpace.
    
    Returns:
    
    The size of the root volume. For important information about how to modify the size of the root and user volumes, see Modify a WorkSpace.
  - userVolumeSizeGib
```
public final Integer userVolumeSizeGib()
```
    The size of the user storage. For important information about how to modify the size of the root and user volumes, see Modify a WorkSpace.
    
    Returns:
    
    The size of the user storage. For important information about how to modify the size of the root and user volumes, see Modify a WorkSpace.
  - computeTypeName
```
public final Compute computeTypeName()
```
    The compute type. For more information, see Amazon WorkSpaces Bundles.
    
    If the service returns an enum value that is not available in the current SDK version, computeTypeName will return Compute.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from computeTypeNameAsString().
    
    Returns:
    
    The compute type. For more information, see Amazon WorkSpaces Bundles.
    
    See Also:
    
    Compute
  - computeTypeNameAsString
```
public final String computeTypeNameAsString()
```
    The compute type. For more information, see Amazon WorkSpaces Bundles.
    
    If the service returns an enum value that is not available in the current SDK version, computeTypeName will return Compute.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from computeTypeNameAsString().
    
    Returns:
    
    The compute type. For more information, see Amazon WorkSpaces Bundles.
    
    See Also:
    
    Compute
  - protocols
```
public final List<Protocol> protocols()
```
    The protocol. For more information, see Protocols for Amazon WorkSpaces.
    
    Only available for WorkSpaces created with PCoIP bundles.
    
    The Protocols property is case sensitive. Ensure you use PCOIP or DCV (formerly WSP).
    
    Unavailable for Windows 7 WorkSpaces and WorkSpaces using GPU-based bundles (Graphics, GraphicsPro, Graphics.g4dn, and GraphicsPro.g4dn).
    
    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 hasProtocols() method.
    Returns:
    
    The protocol. For more information, see Protocols for Amazon WorkSpaces.
    
    Only available for WorkSpaces created with PCoIP bundles.
    
    The Protocols property is case sensitive. Ensure you use PCOIP or DCV (formerly WSP).
    
    Unavailable for Windows 7 WorkSpaces and WorkSpaces using GPU-based bundles (Graphics, GraphicsPro, Graphics.g4dn, and GraphicsPro.g4dn).
  - hasProtocols
```
public final boolean hasProtocols()
```
    For responses, this returns true if the service returned a value for the Protocols 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.
  - protocolsAsStrings
```
public final List<String> protocolsAsStrings()
```
    The protocol. For more information, see Protocols for Amazon WorkSpaces.
    
    Only available for WorkSpaces created with PCoIP bundles.
    
    The Protocols property is case sensitive. Ensure you use PCOIP or DCV (formerly WSP).
    
    Unavailable for Windows 7 WorkSpaces and WorkSpaces using GPU-based bundles (Graphics, GraphicsPro, Graphics.g4dn, and GraphicsPro.g4dn).
    
    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 hasProtocols() method.
    Returns:
    
    The protocol. For more information, see Protocols for Amazon WorkSpaces.
    
    Only available for WorkSpaces created with PCoIP bundles.
    
    The Protocols property is case sensitive. Ensure you use PCOIP or DCV (formerly WSP).
    
    Unavailable for Windows 7 WorkSpaces and WorkSpaces using GPU-based bundles (Graphics, GraphicsPro, Graphics.g4dn, and GraphicsPro.g4dn).
  - operatingSystemName
```
public final OperatingSystemName operatingSystemName()
```
    The name of the operating system.
    
    If the service returns an enum value that is not available in the current SDK version, operatingSystemName will return OperatingSystemName.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from operatingSystemNameAsString().
    
    Returns:
    
    The name of the operating system.
    
    See Also:
    
    OperatingSystemName
  - operatingSystemNameAsString
```
public final String operatingSystemNameAsString()
```
    The name of the operating system.
    
    If the service returns an enum value that is not available in the current SDK version, operatingSystemName will return OperatingSystemName.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from operatingSystemNameAsString().
    
    Returns:
    
    The name of the operating system.
    
    See Also:
    
    OperatingSystemName
  - globalAccelerator
```
public final GlobalAcceleratorForWorkSpace globalAccelerator()
```
    Indicates the Global Accelerator properties.
    
    Returns:
    
    Indicates the Global Accelerator properties.
  - toBuilder
```
public WorkspaceProperties.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<WorkspaceProperties.Builder,WorkspaceProperties>
  - builder
```
public static WorkspaceProperties.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends WorkspaceProperties.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - 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)
```
  - 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

Class WorkspaceProperties

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

runningMode

runningModeAsString

runningModeAutoStopTimeoutInMinutes

rootVolumeSizeGib

userVolumeSizeGib

computeTypeName

computeTypeNameAsString

protocols

hasProtocols

protocolsAsStrings

operatingSystemName

operatingSystemNameAsString

globalAccelerator

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields

sdkFieldNameToField